Express4.x API (三)：Response (译)

Express4.x API 译文系列文章

技术库更迭较快，很难使译文和官方的API保持同步，更何况更多的大神看英文和中文一样的流畅，不会花时间去翻译--，所以我们看到express中文网更多的还是英文，我们只有提升自己的英语能力才能更快的适应库的更新迭代,阅读到最新资料.
所以我此次翻译的目的，一是熟悉express文档，二是锻炼自己英语阅读能力；

原文地址：express.com

Response

res对象表示一个Express应用程序在收到HTTP请求时发送的HTTP响应(response)

在这篇文档和惯例中，HTTP响应这个对象总是被称为res(HTTP请求则是req)，但是它的实际名称取决于您正在工作的回调函数的参数.

举个栗子：

app.get('/user/:id',function(req,res){
    res.send('user' + req.params.id)
})

当然你也可以这样：

app.get('/user/:id',function(request,response){
    response.send('user' + request.params.id)
})

Properties

res.app

此属性持有对使用中间件Express应用实例的引用

res.app和在request对象中的req.app属性是完全相同的

res.headersSent

布尔属性，表示这个app是否发送了HTTP头进行响应

app.get('/',function(req,res){
    console.log(res.headersSend);  // false
    res.send('ok');
    console.log(res.headersSend); // true
})

res.locals

一个对象包含局部变量作用域的请求的响应，因此只能用于在request/response周期中呈现的视图(如果有的话)。否者，此属性与app.locals是相同的

此属性用于公开request-level信息，例如请求的路径名(path name)，经过身份认证的用户(authenticated user),用户设置(user setting)等等

app.use(function(req,res,next){
    res.locals.user = req.user;
    req.locals.authenticated = !req.user.anonymous;
    next();
})

Methods

res.append(field[,value])

res.append在Expressv4.11.0+是支持的

将指定的值到http响应头字段.如果header还没有被设置，它创建具有指定值的头文件，value参数可以是字符串或数组

如果res.set()在res.append()之后的话将会重置以前设置的header头

res.append('Link',['<http://localhost/>','<http://localhost:3000/>'])
res.append('Set-Cookie','foo=bar;path=/;HttpOnly')
res.append('Warning','199 Miscellaneous warning')

res.attachment([filename])

使用attchment设置HTTP响应Content-Dispositon头字段.如果给了一个文件名filename，然后基于扩展名通过res.type()设置Content-Type,并设置Content-Disposition"fliename="参数

res.attachment();
// Content-Disposition:attachment

res.attachment('path/to/logo.png');
// Content-Disposition:attachment;filename='logo.png'
// Content-Type:image/png

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

给cookie名称设置值，value参数可以是一个字符串或者是对象转化为JSON，options参数可以是具有以下属性的对象

Property	Type	Description
domain	String	cookie的域名，默认应用程序的域名
expires	Date	格林尼治时间内cookie的到期日期，如果没有指明或设置为0，创建会话cookie
httpOnly	Boolean	标志cookie只能由web服务器访问
maxAge	String	在毫秒内设置相对于当前时间的方便选项
path	String	cookie的路径，默认为'/'
secure	Boolean	标记只于https一起使用的cookie
signed	Boolean	指示cookie是否被签署

提供带有选项设置的HTTP Set-Cookie``res.cookie起作用，未指定的任何选项默认值为RFC 6265

举个栗子：

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

maxAge选项是以当前时间为起点以毫秒为单位设置expires的便捷选项，下面这个栗子相当于上面例子中的第二个

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

你可以传递一个对象给value参数,然后通过bodyparser中间件将其序列化为JSON

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

当使用cookie-parser中间件时，此方法还支持签署cookie，只需要设置signed选项为true。然后res.cookie()将会秘密的传递给cookieParser(secret)去签署这个值

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

然后你可以通过req.signedCookie()访问此值

res.clearCookie(name,[,options])

通过cookie名称清除指定的cookie

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

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

将路径中文件作为附件(attachment)传输.通常，浏览器将提示用户下载.默认情况下，Content-Disposition头中"filename="参数是路径（这通常出现在浏览器对话框），用filename参数覆盖默认值

res.download('/report-12345.pdf');

res.download('/report-12345.pdf','report.pdf');

res.download('/report-12345.pdf','report.pdf',function(err){
    if(err){
        // 处理错误，但是请记得响应可能是部分发送的
        // 所以检查`res.headerssent`
    }else{
        // 减量下载，等
    }
})

res.end([data][,encoding])

结束响应进程，This method actually comes from Node core, specifically the response.end() method of http.ServerResponse.（这句话翻译过来我有些不理解，我就不再翻译，res.end用于结束响应）

快速结束响应而无需任何数据，如果你需要对数据进行响应，取而代之的是使用诸如res.send和res.json

res.send();
res.status(404).end();

res.format(object)

在请求对象时，在AcceptHTTP头对象上执行content-negotiation。他使用req.accepts基于可接受的质量值的有序类型为请求选择一个处理程序，如果header未指定，调用第一个回调函数.当没有找到匹配项，服务器响应406Not Acceptable或调用默认回调函数

当选择回调时，将设置Content-Type响应头.然而你可以使用回调方法在回调中更改此值例如：res.set或者res.type

下面这个例子当Accept头域设置为applocation/json或者*/json时，将会响应{'message':'hey'}(然而如果是"/",响应将会是'hey')

res.format({
    'text/plain':function(){
        res.send('hey')
    },

    'text/html':function(){
        res.send('<p>hey</p>')
    }

    'applaction/json':function(){
        res.send(message:'hey')
    }

    'default':function(){
        // 记录请求并用406响应
        res.status(406).send('Not Acceptable')
    }
})

除了规范化MOME类型，对于稍微不太详细的实现你还可以使用扩展名映射到这些类型

res.format({
    text:function(){
        res.send('hey');
    }

    html:function(){
        res.send('<p>hey</p>');
    }

    json:function(){
        res.send({message:'hey'});
    }
})

res.get(field)

返回由路由字段指定的http响应头(对大小写是不敏感的)

res.get('Content-Tpye');  // => 'text/plain'

res.json([body])

发送一个JSON响应，这个方法和res.send是一样的传递一个对象或者数组作为参数.但是你可以使用它将其他值转化为JSON,例如null，undefined（虽然这些在技术上不是有效的JSON）

res.json(null)
res.json(user:'tobi')
res.status(500).json(error:'message')

res.jsonp([body])

发送一个JSONP支持的JSON响应，这个方法和req.json()是相同的,除了他选择在JSONP的回调支持

res.jsonp(null) // => null

res.jsonp({user:'tobi'})  // => {"user":"tobi"}

res.status(500).jsonp({error:'message'})  // => {"error":"message"}

以下是一些JSONP响应用相同的代码的栗子：

// ?callback=foo
res.jsonp(user:"tobi")  // => foo({"user":"tobi"})

app.set('JSONP callback name ','cb');

// ?cb=foo
res.status(500).jsonp({error:'message'})  // => foo({"error":"message"})

res.links(links)

将提供的链接作为参数的属性添加到响应的Link HTTP 头字段

res.links({
    next:'http://api.example.com/user?page=2',
    last:'http://api.example.com/user?page=5'
})

产出

Link:<http://api.example.com/user?page=2>; rel='next'
    :<http://api.example.com/user?page=5>; rel='last'

res.location(path)

设置响应locationHTTP头为指定的path路径参数

res.location('/foo/bar');
res.location('http://example.com');
res.location('back');

带有back参数的的路径带有特殊的意义，它指的是在请求的Referer报头指定的URL，如果没有被指定，它指向"/"

res.redirect([status,] path)

重定向URL来自指定的路径，使用指定的HTTP状态码.如果没有指定状态，状态代码默认为'302 Found'

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

重定向可以完全的将URL重定向到另一个不同的网站

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

重定向可以使用相对主机的路径，例如，如果你的应用程序是"http://example.com/admin/post/new"，下面将会将它重定向到"http://example.com/admin"

res.redirect('/admin')

重定向可以相对于当前的URL，例如来自"http://example.com/blog/admin/"(注意最后的尾斜杠)，下面将重定向到"http://example.com/blog/admin/post/new"

res.redirect('post/new')

如果上面admin最后没有尾斜杠，将会重定向至"http://example.com/blog/post/new"

如果你发现上述行为令人困惑，把路径段看做目录（尾随斜杠）和文件，他将开始变得有意义

相对路径的重定向也是有可能的，如果你是"http://example.com/admin/post/new",下面将会重定向到"http://example.com/admin/post"

res.redirect('..');

一个back重定向到请求返回referer，如果referer丢失默认为'/'

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

呈现视图并将HTML发送给客户端，可选参数：

locals,属性定义视图的局部变量的对象
callback,回调函数，如果提供的话，返回可能的错误和呈现的字符串，但并不自动响应.当错误发生时,该方法在内部调用next(err)

res.render('index')

res.render('index',function(err,html){
    res.send(html)
})

// 将局部变量传递给视图
res.render('user',{name:'tobi'},function(err,html){
    // ..
})

res.send([body])

发送http响应
body参数可以是一个buffer对象，字符串，对象，数组.举个栗子：

res.send(new Buffer('whoop'))
res.send({some:'json'})
res.send('<p>some html</p>')
res.status(404).send('sorry,er can not find that!')
res.status(500).send({error:'something brew up'})

当参数是一个buffer对象时，该方法设置Content-Type响应头字段为application/octet-stream，除非先定义如下所示：

res.set('Content-Type':'text/html')
res.send(new Buffer('<p>some html</p>'))

当参数为字符串时，这个方法设置'Content-Type'为'text/html'

res.send('<p>some html</p>')

当参数为数组或者对象时，Express用JSON表示响应

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

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

res.sendFile()在Express v4.8.0之前被支持

在给定路径上传输文件，根据文件的扩展设置"Content-Tpye"响应HTTP头字段.除非在选项对象中设置根选项，路径必须是文件的绝对路径

下表中列出了选项对象中的详细信息

Property	Description	Default	Availability
maxAge	以毫秒为单位设置max-age缓存控制头或者MS格式的字符串	0
root	相关文件的根目录
lastModified	设置last-modified头设置为操作系统上文件的最后修改日期，设置false禁用它	Enabled	4.9.0+
headers	包含与文件服务对象的HTTP头
dotfiles	可能值为"allow","deny","ignore"	"ignore"

该方法调用一个回调函数fn(err)当传输完成或发生错误时.如果指定了回调函数并发生错误时，回调函数必须通过终止请求响应周期来显式地处理响应过程，或者传递控制给下一个路由

下面这个栗子使用了res.sendFile()的所有参数

res.send('/file/:name',function(req,res,next){
    var options={
        root:__dirname+'/public',
        dotfiles:'deny',
        headers:{
            'x-timestamp':Date.now(),
            'x-sent':true
        }
    }
    var flieName = req.params.name;
    res.sendFile(fileName,options,funcion(err){
        if(err){
            console.log(err);
            res.status(err.status).end();
        }else{
            console.log('Sent:', fileName);
        }
    })
})

res.sendFile()在下面的例子中，提供对文件服务的fine-grained支持，

app.get('/user/:uid/photos/:file',function(req,res){
    var uid = req.params.uid;
    var file = req.params.file;

    req.user.mayViewFilesFrom(uid,function(yes){
        if(yes){
            res.sendFile('/uploads/' + uid + '/' + file);
        }else{
            res.status(403).send("sorry you cant\'s see that.")
        }
    })
})

res.sendStatus(statusCode)

设置响应的HTTP状态码并将字符串形式作为响应体发送

res.sendStatus(200);  // 等于 res.status(200).send('ok')
res.sendStatus(403);  // 等于 res.status(403).send('Forbidden')
res.sendStatus(404);  // 等于 res.status(404).send('Not Found')
res.sendStatus(500);  // 等于 res.status(500).send('Internal Server Error')

如果指定了不受支持的状态代码，HTTP状态仍然设置状态码和代码的字符串版本为响应正文中发送

res.sendStatus(2000)  // 等于 res.status(2000).send('2000')

More about HTTP Status Codes

res.set(field [,value])

将HTTP响应头filed设置为value值.立即设置多个字段，传递一个对象作为参数

res.set('Content-Type':'text/plain');

res.set({
    'Content-Type':'text.plain',
    'Content-Length':'123',
    'ETag':'12345'
})

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

res.status(code)

使用此方法为响应设置HTTP状态，这是一个连贯性的Node response.statusCode别名

res.status(403).send();
res.status(400).send('Bad Request');
res.status(404).sendFile('/absolute/path/to/404.png')

res.type(type)

将Content-Type的HTTP头设置为MIME类型,通过mime.lookup指定类型.如果类型包含'/'字符，设置"Content-Type"为'type'

res.type('.html')  // => 'text/html'
res.type('html')  // =>'text/html'
res.type('json') // => 'application/json'
res.type('application/json')  // => 'application/json'
res.type('png') // => image/png:

res.vary(field)

如果它不在那里，添加字段到vary响应头

res.vary('User-Agent').render('docs');

写在后面

Express文档中Request部分就完成了，本人学识有限，难免有所纰漏，另外翻译仅仅是方便个人学习交流使用，无其他用意，原文地址：expressjs.com

posted @ 2017-12-22 19:46 OkayChen 阅读(2758) 评论(0) 编辑收藏举报

刷新页面返回顶部

okaychen

热衷于编程技术爱分享

Express4.x API (三)：Response (译)

Express4.x API 译文系列文章

Response

Properties

res.app

res.headersSent

res.locals

Methods

res.append(field[,value])

res.attachment([filename])

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

res.clearCookie(name,[,options])

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

res.end([data][,encoding])

res.format(object)

res.get(field)

res.json([body])

res.jsonp([body])

res.links(links)

res.location(path)

res.redirect([status,] path)

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

res.send([body])

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

res.sendStatus(statusCode)

res.set(field [,value])

res.status(code)

res.type(type)

res.vary(field)

写在后面

公告

okaychen

热衷于编程技术爱分享

Express4.x API (三)：Response (译)

Express4.x API 译文 系列文章

Response

Properties

res.app

res.headersSent

res.locals

Methods

res.append(field[,value])

res.attachment([filename])

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

res.clearCookie(name,[,options])

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

res.end([data][,encoding])

res.format(object)

res.get(field)

res.json([body])

res.jsonp([body])

res.links(links)

res.location(path)

res.redirect([status,] path)

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

res.send([body])

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

res.sendStatus(statusCode)

res.set(field [,value])

res.status(code)

res.type(type)

res.vary(field)

写在后面

公告

Express4.x API 译文系列文章