docs: basics/middleware #194

dead-horse · 2017-01-08T07:04:11Z

No description provided.

leoner · 2017-01-08T07:06:10Z

docs/source/zh-cn/basics/middleware.md

+
+```js
+const isJSON = require('koa-is-json');
+var zlib = require('zlib');


这个为啥不用 const

这句 copy 的，我改一下

popomore · 2017-01-08T07:10:20Z

docs/source/zh-cn/basics/middleware.md

+
+在框架中，我们可以完全通过配置来引入自定义的中间件，并配置它们的顺序。
+
+如果我们需要引入上面的 gzip 中间件，在 `app/config.default.js` 中，我们加入下面的配置就完成了中间件的开启和配置：


config/config.default.js

popomore · 2017-01-08T07:14:07Z

docs/source/zh-cn/basics/middleware.md

+
+### 配置
+
+一般来说中间件也会有自己的配置。在框架中，一个完整的中间件是包含了配置处理的。我们约定一个中间件是一个放置在 app/middleware 目录下的单独文件，它需要 exports 一个普通的 function，接受两个参数


可以提一下中间件都挂载到 app.middlewares 上，以及为何不用 app.middleware 的原因，顺带说一下 router 中如何直接使用 middleware？

fengmk2 · 2017-01-08T07:22:59Z

docs/source/zh-cn/basics/middleware.md

@@ -0,0 +1,158 @@
+title 中间件


少了冒号

fengmk2 · 2017-01-08T07:29:36Z

docs/source/zh-cn/basics/middleware.md

+var zlib = require('zlib');
+
+function* gzip(next) {
+  if (this.method === 'HEAD') return; // HEAD 请求不响应 body，不需要进行 gzip


判断 accept-encoding 要支持 gzip 才行

这些逻辑我都去掉了，尽量简单

fengmk2 · 2017-01-08T07:32:15Z

docs/source/zh-cn/basics/middleware.md

+
+### 配置
+
+一般来说中间件也会有自己的配置。在框架中，一个完整的中间件是包含了配置处理的。我们约定一个中间件是一个放置在 app/middleware 目录下的单独文件，它需要 exports 一个普通的 function，接受两个参数


app/middleware

fengmk2 · 2017-01-08T07:35:42Z

docs/source/zh-cn/basics/middleware.md

+};
+```
+
+## 在框架中引入中间件


框架引入的中间件是放 coreMiddleware 吧，应用中才是 middleware

改成应用中了

fengmk2 · 2017-01-08T07:36:35Z

docs/source/zh-cn/basics/middleware.md

+
+## 框架默认中间件
+
+除了应用层引入中间件之外，框架自身和其他的插件也会引入许多中间件。所有的这些自带中间件的配置项都通过在配置中修改中间件同名配置项进行修改，例如 [egg 自带的中间件](https://github.com/eggjs/egg/tree/master/app/middleware)中有一个 bodyParser 中间件（框架的加载器会将文件名中的各种分隔符都修改成驼峰形式的变量名），我们想要修改 bodyParser 的配置，只需要在 `app/config.default.js` 中编写


config/config.default.js

fengmk2 · 2017-01-08T07:37:42Z

docs/source/zh-cn/basics/middleware.md

+};
+```
+
+**注意：框架和插件引入的中间件会在应用层配置的中间件之前，框架默认中间件不能被应用层中间件覆盖，如果应用层有定义同名中间件，在启动时会报错。**


如果应用层有定义同名中间件，在启动时会报错。

如果应用层有自定义同名中间件，在启动时会报错。

codecov-io · 2017-01-08T07:47:25Z

Current coverage is 97.65% (diff: 100%)

Merging #194 into master will not change coverage

@@             master       #194   diff @@
==========================================
  Files            33         33          
  Lines           853        853          
  Methods           0          0          
  Messages          0          0          
  Branches          0          0          
==========================================
  Hits            833        833          
  Misses           20         20          
  Partials          0          0

Powered by Codecov. Last update 359e9e9...1442637

fengmk2

LGTM

leoner · 2017-01-09T08:55:45Z

docs/source/zh-cn/basics/middleware.md

+
+  // 设置 gzip body，修正响应头
+  this.body = zlib.createGzip().end(body);
+  this.set('Content-Encoding', encoding);


encoding 这个参数在例子没有定义

docs: basics/middleware

1442637

dead-horse added the type: document label Jan 8, 2017

dead-horse requested review from fengmk2, popomore and shaoshuai0102 January 8, 2017 07:04

leoner reviewed Jan 8, 2017

View reviewed changes

popomore reviewed Jan 8, 2017

View reviewed changes

fengmk2 reviewed Jan 8, 2017

View reviewed changes

docs/source/zh-cn/basics/middleware.md

@@ -0,0 +1,158 @@

title 中间件

Copy link

Member

fengmk2 Jan 8, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

少了冒号

fengmk2 reviewed Jan 8, 2017

View reviewed changes

docs: update

e313ed4

fengmk2 approved these changes Jan 8, 2017

View reviewed changes

popomore mentioned this pull request Jan 8, 2017

中文文档 #34

Closed

31 tasks

popomore approved these changes Jan 8, 2017

View reviewed changes

popomore merged commit 69f7868 into master Jan 8, 2017

popomore deleted the docs-middleware branch January 8, 2017 08:16

leoner reviewed Jan 9, 2017

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: basics/middleware #194

docs: basics/middleware #194

dead-horse commented Jan 8, 2017

leoner Jan 8, 2017

dead-horse Jan 8, 2017

popomore Jan 8, 2017

popomore Jan 8, 2017

fengmk2 Jan 8, 2017

fengmk2 Jan 8, 2017

dead-horse Jan 8, 2017

fengmk2 Jan 8, 2017

fengmk2 Jan 8, 2017

dead-horse Jan 8, 2017

fengmk2 Jan 8, 2017

fengmk2 Jan 8, 2017

codecov-io commented Jan 8, 2017 •

edited

Loading

fengmk2 left a comment

leoner Jan 9, 2017


		在框架中，我们可以完全通过配置来引入自定义的中间件，并配置它们的顺序。

		如果我们需要引入上面的 gzip 中间件，在 `app/config.default.js` 中，我们加入下面的配置就完成了中间件的开启和配置：


		### 配置

		一般来说中间件也会有自己的配置。在框架中，一个完整的中间件是包含了配置处理的。我们约定一个中间件是一个放置在 app/middleware 目录下的单独文件，它需要 exports 一个普通的 function，接受两个参数


		## 框架默认中间件

		除了应用层引入中间件之外，框架自身和其他的插件也会引入许多中间件。所有的这些自带中间件的配置项都通过在配置中修改中间件同名配置项进行修改，例如 [egg 自带的中间件](https://github.com/eggjs/egg/tree/master/app/middleware)中有一个 bodyParser 中间件（框架的加载器会将文件名中的各种分隔符都修改成驼峰形式的变量名），我们想要修改 bodyParser 的配置，只需要在 `app/config.default.js` 中编写

docs: basics/middleware #194

docs: basics/middleware #194

Conversation

dead-horse commented Jan 8, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

codecov-io commented Jan 8, 2017 • edited Loading

Current coverage is 97.65% (diff: 100%)

fengmk2 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

codecov-io commented Jan 8, 2017 •

edited

Loading