Response

res.status(code)

支持链式调用的 node's res.statusCode=.

  1. res.status(404).sendfile('path/to/404.png');

res.set(field, [value])

设置响应头字段field 值为 value, 也可以一次传入一个对象设置多个值。

  1. res.set('Content-Type', 'text/plain');
  3. res.set({
  4.   'Content-Type': 'text/plain',
  5.   'Content-Length': '123',
  6.   'ETag': '12345'
  7. })

res.header(field, [value])的别名。

res.get(field)

返回一个大小写不敏感的响应头里的 field的值

  1. res.get('Content-Type');
  2. // => "text/plain"

res.cookie(name, value, [options])

设置cookie name 值为value, 接受字符串参数或者JSON对象。 path 属性默认为 "/".

  1. res.cookie('name', 'tobi', { domain: '.example.com', path: '/admin', secure: true });
  2. res.cookie('rememberme', '1', { expires: new Date(Date.now() + 900000), httpOnly: true });

maxAge 属性是一个便利的设置"expires",它是一个从当前时间算起的毫秒。 下面的代码和上一个例子中的第二行是同样的作用。

  1. res.cookie('rememberme', '1', { maxAge: 900000, httpOnly: true })

可以传一个序列化的JSON对象作为参数， 它会自动被bodyParser() 中间件解析。

  1. res.cookie('cart', { items: [1,2,3] });
  2. res.cookie('cart', { items: [1,2,3] }, { maxAge: 900000 });

这个方法也支持签名的cookies。 只需要简单的传递signed 参数。 res.cookie() 会使用通过 express.cookieParser(secret) 传 入的secret来签名这个值

  1. res.cookie('name', 'tobi', { signed: true });

稍后你就可以通过req.signedCookie 对象访问到这个值。

res.clearCookie(name, [options])

把name的cookie清除. path参数默认为 "/".

  1. res.cookie('name', 'tobi', { path: '/admin' });
  2. res.clearCookie('name', { path: '/admin' });

res.redirect([status], url)

使用可选的状态码跳转到url 状态码status默认为302 "Found".

  1. res.redirect('/foo/bar');
  2. res.redirect('http://example.com');
  3. res.redirect(301, 'http://example.com');
  4. res.redirect('../login');

Express支持几种跳转，第一种便是使用一个完整的URI跳转到一个完全不同的网站。

  1. res.redirect('http://google.com');

第二种是相对根域路径跳转，比如你现在在 http://example.com/admin/post/new, 下面的的代码跳转到 /admin 将会把你带到http://example.com/admin:

  1. res.redirect('/admin');

这是一种相对于应用程序挂载点的跳转。 比如把一个blog程序挂在 /blog, 事实上它无法知道它被挂载，所以当你使用跳转 /admin/post/new 时，将到跳到http://example.com/admin/post/new, 下面的相对于挂载点的跳转会把你带到 http://example.com/blog/admin/post/new:

  1. res.redirect('admin/post/new');

路径名.跳转同样也是支持的。 比如你在http://example.com/admin/post/new, 下面的跳转会把你带到 http//example.com/admin/post:

  1. res.redirect('..');

最后也是最特别的跳转是 back 跳转, 它会把你带回Referer（也有可能是Referrer）的地址 当Referer丢失的时候默认为 /

  1. res.redirect('back');

res.location

设置location 请求头.

  1. res.location('/foo/bar');
  2. res.location('foo/bar');
  3. res.location('http://example.com');
  4. res.location('../login');
  5. res.location('back');

可以使用与 res.redirect()里相同的urls。

举个例子，如果你的程序根地址是/blog, 下面的代码会把 location 请求头设置为/blog/admin:

  1. res.location('admin')

res.charset

设置字符集。默认为"utf-8"。

  1. res.charset = 'value';
  2. res.send('some html');
  3. // => Content-Type: text/html; charset=value

res.send([body|status], [body])

发送一个响应。

  1. res.send(new Buffer('whoop'));
  2. res.send({ some: 'json' });
  3. res.send('some html');
  4. res.send(404, 'Sorry, we cannot find that!');
  5. res.send(500, { error: 'something blew up' });
  6. res.send(200);

这个方法在输出non-streaming响应的时候自动完成了大量有用的任务 比如如果在它前面没有定义Content-Length, 它会自动设置; 比如加一些自动的 HEAD; 比如对HTTP缓存的支持 .

当参数为一个 Buffer时 Content-Type 会被设置为 "application/octet-stream" 除非它之前有像下面的代码：

  1. res.set('Content-Type', 'text/html');
  2. res.send(new Buffer('some html'));

当参数为一个String时 Content-Type 默认设置为"text/html":

  1. res.send('some html');

当参数为 Array 或者 Object 时 Express 会返回一个 JSON :

  1. res.send({ user: 'tobi' })
  2. res.send([1,2,3])

最后一条当一个Number 作为参数， 并且没有上面提到的任何一条在响应体里， Express会帮你设置一个响应体 比如200 会返回字符"OK", 404会返回"Not Found"等等.

  1. res.send(200)
  2. res.send(204)
  3. res.send(500)

res.json([status|body], [body])

返回一个 JSON 响应。 当res.send() 的参数是一个对象或者数组的时候， 会调用这个方法。 当然它也在复杂的空值(null, undefined, etc)JSON转换的时候很有用， 因为规范上这些对象不是合法的JSON。

  1. res.json(null)
  2. res.json({ user: 'tobi' })
  3. res.json(500, { error: 'message' })

res.jsonp([status|body], [body])

返回一个支持JSONP的JSON响应。 Send a JSON response with JSONP support. 这个方法同样使用了res.json(), 只是加了一个可以自定义的 JSONP 回调支持。

  1. res.jsonp(null)
  2. // => null
  4. res.jsonp({ user: 'tobi' })
  5. // => { "user": "tobi" }
  7. res.jsonp(500, { error: 'message' })
  8. // => { "error": "message" }

默认情况下JSONP 回调的函数名就是callback。 你可以通过jsonp callback name来修改这个值。 下面是一些使用JSONP的例子。

  1. // ?callback=foo
  2. res.jsonp({ user: 'tobi' })
  3. // => foo({ "user": "tobi" })
  5. app.set('jsonp callback name', 'cb');
  7. // ?cb=foo
  8. res.jsonp(500, { error: 'message' })
  9. // => foo({ "error": "message" })

res.type(type)

设置 Sets the Content-Type to the mime lookup of type, or when "/" is present the Content-Type is simply set to this literal value.

  1. res.type('.html');
  2. res.type('html');
  3. res.type('json');
  4. res.type('application/json');
  5. res.type('png');

res.contentType(type)方法的别名。

res.format(object)

设置特定请求头的响应。 这个方法使用 req.accepted， 这是一个通过质量值作为优先级顺序的数组， 第一个回调会被执行。 当没有匹配时，服务器返回一个 406 "Not Acceptable", 或者执行default 回调

Content-Type 在callback 被选中执行的时候会被设置好, 如果你想改变它，可以在callback内使用res.set()或者 res.type() 等

下面的例子展示了在请求头设置为"application/json" 或者 "/json"的时候 会返回{ "message": "hey" } 如果设置的是"/*" 那么所有的返回都将是"hey"

  1. res.format({
  2.   'text/plain': function(){
  3.     res.send('hey');
  4.   },
  6.   'text/html': function(){
  7.     res.send('hey');
  8.   },
  10.   'application/json': function(){
  11.     res.send({ message: 'hey' });
  12.   }
  13. });

除了使用标准的MIME 类型，你也可以使用扩展名来映射这些类型 下面是一个不太完整的实现：

  1. res.format({
  2.   text: function(){
  3.     res.send('hey');
  4.   },
  6.   html: function(){
  7.     res.send('hey');
  8.   },
  10.   json: function(){
  11.     res.send({ message: 'hey' });
  12.   }
  13. });

res.attachment([filename])

设置响应头的Content-Disposition 字段值为 "attachment". 如果有filename 参数，Content-Type 将会依据文件扩展名通过res.type()自动设置, 并且Content-Disposition的"filename="参数将会被设置

  1. res.attachment();
  2. // Content-Disposition: attachment
  4. res.attachment('path/to/logo.png');
  5. // Content-Disposition: attachment; filename="logo.png"
  6. // Content-Type: image/png

res.sendfile(path, [options], [fn]])

path所传输附件的路径。

它会根据文件的扩展名自动设置响应头里的Content-Type字段。 回调函数fn(err)在传输完成或者发生错误时会被调用执行。

Options:

  • maxAge 毫秒，默认为0
  • root 文件相对的路径
    这个方法可以非常良好的支持有缩略图的文件服务。
  1. app.get('/user/:uid/photos/:file', function(req, res){
  2.   var uid = req.params.uid
  3.     , file = req.params.file;
  5.   req.user.mayViewFilesFrom(uid, function(yes){
  6.     if (yes) {
  7.       res.sendfile('/uploads/' + uid + '/' + file);
  8.     } else {
  9.       res.send(403, 'Sorry! you cant see that.');
  10.     }
  11.   });
  12. });

res.download(path, [filename], [fn])

path所需传输附件的路径， 通常情况下浏览器会弹出一个下载文件的窗口。 浏览器弹出框里的文件名和响应头里的Disposition "filename=" 参数是一致的, 你也可以通过传入filename来自由设置。

当在传输的过程中发生一个错误时，可选的回调函数fn会被调用执行。 这个方法使用res.sendfile()传输文件。

  1. res.download('/report-12345.pdf');
  3. res.download('/report-12345.pdf', 'report.pdf');
  5. res.download('/report-12345.pdf', 'report.pdf', function(err){
  6.   if (err) {
  7.     // 处理错误，请牢记可能只有部分内容被传输，所以
  8.     // 检查一下res.headerSent
  9.   } else {
  10.     // 减少下载的积分值之类的
  11.   }
  12. });

res.links(links)

合并给定的links, 并且设置给响应头里的"Link" 字段.

  1. res.links({
  2.   next: 'http://api.example.com/users?page=2',
  3.   last: 'http://api.example.com/users?page=5'
  4. });

转换后:

  1. Link: <http://api.example.com/users?page=2>; rel="next", 
  2.       <http://api.example.com/users?page=5>; rel="last"

res.locals

在某一次请求范围下的响应体的本地变量，只对此次请求期间的views可见。 另外这个API其实和 app.locals是一样的.

这个对象在放置请求级信息时非常有用，比如放置请求的路径名，验证过的用户，用户设置等等

  1. app.use(function(req, res, next){
  2.   res.locals.user = req.user;
  3.   res.locals.authenticated = ! req.user.anonymous;
  4.   next();
  5. });

res.render(view, [locals], callback)

渲染view, 同时向callback 传入渲染后的字符串。 callback如果不传的话，直接会把渲染后的字符串输出至请求方， 一般如果不需要再对渲染后的模板作操作，就不需要传callback。 当有错误发生时next(err)会被执行. 如果提供了callback参数，可能发生的错误和渲染的字符串都会被当作参数传入, 并且没有默认响应。

  1. res.render('index', function(err, html){
  2.   // ...
  3. });
  5. res.render('user', { name: 'Tobi' }, function(err, html){
  6.   // ...
  7. });