1. Connect

NPM Version NPM Downloads Build Status Test Coverage

Connect 是一个适用于 node 的可扩展 HTTP 服务器框架,使用的是称为 中间件 的“插件”。

var connect = require('connect');
var http = require('http');

var app = connect();

// gzip/deflate 发出响应(outgoing responses)
var compression = require('compression');
app.use(compression());

// 在浏览器 cookie 存储会话状态
var cookieSession = require('cookie-session');
app.use(cookieSession({
    keys: ['secret1', 'secret2']
}));

// 将经过编码的请求体解析到 req.body中
var bodyParser = require('body-parser');
app.use(bodyParser.urlencoded({extended: false}));

// 对所有请求作出应答。
app.use(function(req, res){
  res.end('Hello from Connect!\n');
});

// 创建node.js http 服务器,并监听端口
http.createServer(app).listen(3000);

1.1. 开始

Connect 是一个简单的框架,可以将各种“中间件”粘合在一起处理请求。

1.1.1. 安装

$ npm install connect

1.1.2. 创建一个 app

主要的组件是 Connect "app"。它将存储所有被添加的中间件,它本身是一个函数。

var app = connect();

1.1.3. 使用中间件

Connect 的核心是 "using" 中间件。中间件被作为“堆栈”添加,其中传入的请求将逐个地执行每个中间件,直到一个中间件在它内部不再调用 next()

app.use(function middleware1(req, res, next) {
  // 中间件 1
  next();
});
app.use(function middleware2(req, res, next) {
  // 中间件 2
  next();
});

1.1.4. Mount middleware

.use() 方法还使用一个可选的路径字符串,该字符串与传入请求 URL 的开头相匹配。这允许进行基路由。

app.use('/foo', function fooMiddleware(req, res, next) {
  // req.url 以 "/foo" 开头
  next();
});
app.use('/bar', function barMiddleware(req, res, next) {
  // req.url 以 "/bar" 开头
  next();
});

1.1.5. 错误中间件

有一些特殊的“错误处理”中间件。 这里有一些中间件,其中的函数恰好有4个参数。 当中间件将一个错误传递给 next时,该应用程序将继续寻找在该中间件之后声明的错误中间件并调用它, 这会跳过出错的中间件之上的任何错误中间件和它下面的任何非错误中间件。

[info] 「译者注」:

在出现错误时,查找错误处理的中间件这个操作是从当前发生错误的中间件开始的。在它之前的错误中间件以及之后的非错误中间件都会被忽略。

// 常规的中间件
app.use(function (req, res, next) {
  // 出现错误
  next(new Error('boom!'));
});

// 用于处理发生的错误的错误中间件
// 这个错误发生在错误中间件之前声明的中间件中
app.use(function onerror(err, req, res, next) {
  // an error occurred!
});

1.1.6. 从 app 创建服务器

最后一步是在服务器中实际使用 Connect app。 .listen() 方法是启动 HTTP 服务器的一种便捷方式(与 Node.js 中运行 http.Serverlisten 方法相同)。

var server = app.listen(port);

这个 app 本身就是一个有三个参数的函数, 所以在 Node.js 中它可以被传递给 .createServer()

var server = http.createServer(app);

1.2. 中间件

这些中间件和库得到了 Connect/Express 团队的正式支持:

它们中的大多数都是 Connect 2.x 内置中间件的确切端口(也就是这些内置中间件使用了这些库)。主要的例外是 cookie-session

以前包含的一些中间件不再被 Connect/express 团队支持,取而代之的是一个替代模块,或者应该被一个更好的模块所取代。使用其中一个替代方案:

查看 http-framework获取其他兼容的中间件!

1.3. API

Connect API 信奉极简主义,足以创建一个 app 并添加一个中间件链。

connect 被加载时,返回一个函数,这个函数将在被调用时构造一个新的 app。

// 加载模块
var connect = require('connect')

// 创建 app
var app = connect()

1.3.1. app(req, res[, next])

app 本身是一个函数。这只不过是 app.handle 的别名。

1.3.2. app.handle(req, res[, out])

调用该函数将针对给定的 Node.js http 请求(req)和响应(res)对象运行中间件堆栈。 如果请求(或错误)没有由中间件堆栈处理,则可以提供一个可选的 out 函数。

1.3.3. app.listen([...])

启动 app 监听请求。该方法将在内部创建一个 Node.js HTTP 服务器并调用 .listen()

在 Node.js 运行的版本中,这是 server.listen() 方法的一个别名,所以可以参考 Node.js 文档来获取所有不同的变种。 最常见的签名是 app.listen(port).

1.3.4. app.use(fn)

在 app 中使用一个函数,该函数表示一个中间件。该函数将根据调用 app.use 的顺序为每个请求调用。这个函数有三个参数:

app.use(function (req, res, next) {
  // req 是 Node.js http 请求对象
  // res 是 Node.js http 响应对象
  // next 是一个函数,用来调用下一个中间件
})

除了计划函数之外,fn 参数也可以是一个 Node.js HTTP 服务器实例或另一个 Connect app 实例。

1.3.5. app.use(route, fn)

在 app 中使用一个函数,该函数表示一个中间件。 该函数将为以给定 route 字符串开头的 URL (req.url 属性) 的请求调用,按照调用 app.use 的顺序。 这个函数有三个参数:

app.use('/foo', function (req, res, next) {
  // req 是 Node.js http 请求对象
  // res 是 Node.js http 响应对象
  // next 是一个函数,用来调用下一个中间件
})

除了计划函数之外,fn 参数也可以是一个 Node.js HTTP 服务器实例或另一个 Connect app 实例。

route 总是在路径分隔符(/)或点(.)字符终止。 这意味着给定的路由 /foo//foo是相同的,它们都将匹配 URL /foo/foo//foo/bar/foo.bar 的请求。但不匹配 URL /foobar 的请求。

route 与不区分大小写的 manor 相匹配。

为了使中间件更容易编写,以不确定 route 的方式,当 fn 被调用时,req.url 将被修改,以删除 route 部分(原始的内容将作为 req.originalUrl )。例如,如果在路由 /foo 使用 fn,则对 /foo/bar 的请求将使用 req.url === '/bar'req.originalUrl === '/foo/bar' 调用 fn

1.4. 运行测试

npm install
npm test

1.5. People

如果没有所有的人参与,Connect 项目就不一样了。

Connect 的原始作者是 TJ Holowaychuk TJ's Gratipay

当前的主要维护人员是 Douglas Christopher Wilson Doug's Gratipay

所有贡献者的列表

1.6. Node 兼容性

  • Connect < 1.x - node 0.2
  • Connect 1.x - node 0.4
  • Connect < 2.8 - node 0.6
  • Connect >= 2.8 < 3 - node 0.8
  • Connect >= 3 - node 0.10, 0.12, 4.x, 5.x, 6.x, 7.x, 8.x; io.js 1.x, 2.x, 3.x

1.7. 许可

MIT

Copyright © tuzhu008 2017 all right reserved,powered by Gitbook该文件修订时间: 2017-12-15 11:23:28

results matching ""

    No results matching ""