Skip to content

Commit

Permalink
fix: add warning
Browse files Browse the repository at this point in the history
  • Loading branch information
GiveMe-A-Name committed May 22, 2024
1 parent 4331bf4 commit 55f8bf0
Show file tree
Hide file tree
Showing 4 changed files with 26 additions and 1 deletion.
Original file line number Diff line number Diff line change
@@ -1,10 +1,17 @@
---
title: Middleware
---

# Middleware

Used to extend the built-in Web Server of Modern.js, unlike [Hook](/apis/app/runtime/web-server/hook), Middleware can directly operate Node's origin request and response, and can be extended using the framework plugin.

:::warning
In the next major release, Modern.js will use new middleware to replace this approach.

It is recommended to use [UnstableMiddleware](/apis/app/runtime/web-server/unstable_middleware) to handle page requests.
:::

:::note
For more detail, see [Extend Web Server](/guides/advanced-features/web-server).

Expand Down Expand Up @@ -125,7 +132,6 @@ export const middleware: SomeType = (ctx, next) => {
By default, the framework extension capability of Web Server is turned off after installing the framework extension plugin. If you want to use the framework extension, you can turn it on through ['server.enableFrameworkExt'](/configure/app/server/enable-framework-ext.html).
:::info
The type name exported by the framework extension may not 'Middleware', but is named by the framework extension plugin.
:::
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,12 @@ For more detail, see [Hook](/apis/app/runtime/web-server/hook).
For some projects, there may be more requirements at the server level, Modern.js provides Middleware to add pre-middleware for Web Server. It can only run in a Node environment, so if the project is deployed to another environment, such as a Worker environment, Middleware cannot be used.
:::warning
In the next major release, Modern.js will use new middleware to replace this approach.
It is recommended to use [UnstableMiddleware](/guides/advanced-features/web-server.html#unstablemiddleware) to handle page requests.
:::
Modern.js provides a set of APIs by default for projects to use:
```ts
Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,17 @@
---
title: Middleware
---

# Middleware

用于拓展 Modern.js 内置的 Web Server,与 [Hook](/apis/app/runtime/web-server/hook) 不同的是,Middleware 可以直接操作 Node 原生的请求、响应对象,并且可以使用框架拓展。

:::warning
在下一个大版本,Modern.js 将会使用新 Middleware 来替代该写法。

推荐使用 [UnstableMiddleware](/apis/app/runtime/web-server/unstable_middleware) 处理页面请求。
:::

:::note
更多内容可以查看[自定义 Web Server](/guides/advanced-features/web-server)
:::
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,12 @@ export const afterRender: AfterRenderHook = (ctx, next) => {

对于某些项目,可能在服务端有更多的需求,Modern.js 提供了 Middleware 为 Web Server 添加前置中间件。它只能运行在 Node 环境下,因此如果项目被部署到其他环境中,如 Worker 环境,则不可以使用 Middleware。

:::warning
下一个大版本,Modern.js 将会使用新 Middleware 来替代该写法。

推荐使用 [UnstableMiddleware](/guides/advanced-features/web-server.html#unstablemiddleware) 处理页面请求。
:::

Modern.js 默认提供了一套 API 供项目使用:

```ts
Expand Down

0 comments on commit 55f8bf0

Please sign in to comment.