Nodejs Express 4.X 中文API 3--- Response篇

相关阅读:

Express 4.X API 翻译[一] --  Application篇

Express4.XApi 翻译[二] --  Request篇

Express4.XApi 翻译[三] --- Response篇

Express4.XApi 翻译[四] --- Router篇

本篇是Express 4.0 API翻译的第三篇,本篇的内容主要是Response的相关操作。

res.status(code)

支持连贯调用的node’s的 res.statusCode = 的别名。

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

res.set(field,[value])

设置请求头的字段为指定的值,或者通过一个对象一次设置多个值。

1 res.set(‘Content-Type‘,‘text/plain‘);
2
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] 是一个方便的设置项来设置过期时间,值为相对于当前时间的毫秒时间。下面的代码就是这样的一个例子。

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});

被签名的cookie也同样被支持通过这种方法设置,简单的通过signed参数。当被给定的res.cookie()将会使用通过cookieParser(secret)传递进来的参数来签名。

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

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

res.clearCookie(name,[options])

清除名为 name 的cookie ,默认作用域为’/’

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

res.redirect([status],url)

重定向至给定的 url 并且支持指定 status 代码,默认为 302 方式

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

Express支持 一下几种重定向首先是通过全的符合规则的URL重定向到一个完全不同的域名。

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

第二点是相对根域名重定向,例如,如果你想从http://example.com/admin/post/new 跳转至 /admin 下,你使用下面的代码,将会是你跳转到http://ehttp://example.com/admin

1 res.redirect(‘/admin‘);

第三点是相对于挂载点跳转,例如,如果你的博客程序挂载在’/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),当来源不存在时默认定向至 ‘/’下。

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.send([body|status],[body])

发送一个响应。

1 res.send(new Buffer(‘whoop‘));
2 res.send({sond:‘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‘));

当一个数组或者是对象被传入Express将会自动转化为JSON的形式响应:

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

最后,如果给定的参数是一个数字,而且没有上面提到的任何一个响应体,Express会为你设置一个默认的响应体。例如200 将会被设置响应体为 “OK” 和 404 将会被设置为”Not Found” 等。

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

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

发送一个JSON响应。这个方法与res.send()是完全相同的,当一个对象或者数组被传入的时候。然而它或许是有用的,例如在转化一些非对象(null,undefined,等等),因为这些并不是有效的JSON。

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

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

发送一个支持JSONP的JSON响应。这个方法是和res.json()完全相同的,但是它支持JSONP callback

1 res.jsonp(null);
2 //=>null
3 res.jsonp({user:‘tobi‘});
4 //=>{"user": "tobi"}
5 res.jsonp(500,{error:‘message‘})
6 //=>{"error":"message"}

默认的JSONP回调函数名字是callback ,然而你可以通过jsonp callback name 设置项来设置,下面的代码是使用jsonp的一些例子。

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

res.type(type)

将内容的类型设置为MIME类型的 type ,可以是简写,也可以是存在’/’的字符串。当’/’存在时,类型就确定为type

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

res.format(object)

设置特定请求头的响应,这个方法是使用req.accepted,这个是一个根据其可接受类型的重要性排序的数组,否则,第一个回调函数将会被调用。当没有合适的匹配时,系统返回406 “NotAcceptable” 或者调用 default 回调函数。

Content-Type会被设置好在你被选择的回调函数执行的时候,然而你可以通过res.set()或者res.type()更改这里的类型。

下面的例子为在接受请求头字段被设置为”application/json”或者”*/json”的时候回返回{“message”:”hey”},然而,如果”*/*”时将会返回”hey”。

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

除了使用一些标准的MIME类型,你也可以是用扩展名映射这些类型,下面是一些详细的展示。

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

res.attachment([filename])

设置响应头”Content-Disposition”的值为”attachment”。如果一个文件被给定,然后Content-Type将会被自动设置为基于其扩展名的的类型通过res.type(),然后Content-Disposition的”filename=”字段将会自动被设置。

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

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

path用来传递文件的路径。

通过文件的扩展名将会自动设置默认的Content-Type,然后回调函数 fn(err)将会被调用在传送后或者是产生任何错误的时候。

Options:

  • maxAge 以毫秒为单位,默认是0
  • root 相对于文件名的根目录

这种方法提供了细粒度的文件存储缩略图服务

 1 app.get(‘/user/:uid/photo/:file‘,function(req,res){
 2     var uid = req.params.uid,
 3         file = req.params.file;
 4     req.user.mayVierFilesFrom(uid,function(yes){
 5         if(yes){
 6             res.sendfile(‘/uploads/‘+uid+‘/‘+file);
 7         }else{
 8             res.send(403,‘Sorry! you cant see that.‘);
 9         }
10      })
11 })

点击此处寻求更多的帮助,send

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

path传输所需要传输的文件的路径,通常浏览器会提示用户下载。浏览器弹出的下载文件窗口的文件名和响应头里的Content-Disposition 的”filename=”参数是一致的。你也可以自己定义文件名。

当发生错误或者是一个文件传送完成将会调用回调函数 fn 。这个方法是用res.sendfile()来发送文件。

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

res.link(links)

合并并填充响应头内的”Link”字段,通过给定的links。

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

一次请求的本地化变量,因此只能保持在一次请求/响应的view的输出之前,其实这个和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传递渲染后的字符串,如果在渲染过程中有错误发生next(err)将会被自动调用。callback将会被传入一个可能发生的错误以及渲染后的页面,这样就不会自动输出了。

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

转自:http://www.90it.net/expressjs-4-api-zh-cn-response.html

时间: 2024-10-27 10:16:19

Nodejs Express 4.X 中文API 3--- Response篇的相关文章

Nodejs Express 4.X 中文API 1--- Application篇

相关阅读: Express 4.X API 翻译[一] --  Application篇 Express4.XApi 翻译[二] --  Request篇 Express4.XApi 翻译[三] --- Response篇 Express4.XApi 翻译[四] --- Router篇 本文是Express 4.x Api翻译系列的第一篇.由于笔者最近在学习NodeJs,刚刚接触了Node式的开发模式,被异步IO的编程方式深深吸引,于是准备系统学习一下这项新技术.因为没有任何NodeJs的基础,

Nodejs Express 4.X 中文API 2--- Request篇

相关阅读: Express 4.X API 翻译[一] --  Application篇 Express4.XApi 翻译[二] --  Request篇 Express4.XApi 翻译[三] --- Response篇 Express4.XApi 翻译[四] --- Router篇 req.params 这是一个包含着被命名的路由规则“参数”的对象属性.例如如果你有一个路由规则为:”/user/:name”,然后这个”name”属性你就可以使用req.params.name来调用,这个属性默

Nodejs Express 4.X 中文API 4--- Router篇

相关阅读: Express 4.X API 翻译[一] --  Application篇 Express4.XApi 翻译[二] --  Request篇 Express4.XApi 翻译[三] --- Response篇 Express4.XApi 翻译[四] --- Router篇 本篇是Express 4.0 API翻译的第四篇,本篇的内容主要是Router的相关操作. Router() 路由器是一个孤立的中间件和路由的实例.路由器可以被认为是一个”mini”的应用程序,仅能执行中间件和路

NodeJs+Express+SqlServer简易后台API服务搭建

首先安装nodejs 第一步 创建node项目配置package.json如下 express 使用方法可参考http://www.runoob.com/nodejs/nodejs-express-framework.html 连接sqlserver数据库我用的是node-mssql组件 使用方法可参考https://github.com/patriksimek/node-mssql 执行npm install 安装组件 第二步 新建server.js 代码如下: 第三步 执行代码 第四步 访问

vue+nodejs+express+mysql 建立一个在线网盘程序

vue+nodejs+express+mysql 建立一个在线网盘程序 目录 vue+nodejs+express+mysql 建立一个在线网盘程序 第一章 开发环境准备 1.1 开发所用工具简介 1.2 安装 MySQL 1.2.1 下载安装 MySQL 1.2.2 可能出现的问题和解决方案 1.3 安装 vue-cli 1.4 安装 express 第二章 数据库设计和创建 2.1 数据库和表设计 2.2 user 表 2.3 file 表 2.4 创建数据库和表所用 sql 语句参考 第三

nodeJS+Express+MongoDB

目录 一.MongoDB 1.1.安装MongoDB 1.1.1.配置运行环境 1.1.2.运行MongoDB 1.2.数据库操作 1.2.1.创建数据库与查看数据库 1.2.2.删除数据库 1.2.3.插入数据 1.2.4.查询数据 1.2.5.修改 1.2.6.删除 二.NodeJS访问MongoDB 2.1.安装MongoDB访问驱动 2.2.添加数据 2.3.修改数据 2.4.查询数据 2.5.删除数据 三.NodeJS+Express+MongoDB示例 四.示例下载 一.MongoD

使用nodejs+express+mongodb开发web的例子

介绍:简单的介绍下nodejs+express+mongodb这三者. nodejs:是运行在服务器端的程序语言,表面上看过去就是javascript一样的东西,实际是由c++开发是服务器语言. express:是nodejs的一种web框架,node有很多的开源框架,express是一个大神开发的(这尊神已经移驾到go语言的开发去了).express可以让你更方便的操作node(因为直接用nodejs写web比较麻烦,nodejs是事件驱动的,所以有很多异步回调,写多了就看着晕...) mon

nodejs+express+ejs+mongoose实例

nodejs+express+ejs+mongoose实例 nodejs学得异常痛苦,在这里将学的东西做一番整理,算是自我安慰吧.根据网上todo示例,用express和mongoose重写了部分代码,主要是业务逻辑这块(CRUD),这个没什么难度.目前尚未解决的问题是:express不能使用ejs layout template,查了好久也没解决,知道的麻烦告诉我一下. 一.代码目录 二.第三方模块 1.express (1)express中文入门指引手册 (2)nodejs中文电子书 (3)

NodeJS+Express+MySQL开发小记(2):服务器部署

http://borninsummer.com/2015/06/17/notes-on-developing-nodejs-webapp/ NodeJS+Express+MySQL开发小记(1)里讲过在本地搭建 NodeJS 网站的若干细节.本人最近在阿里云服务器上面按最低配租了4个月的云服务器,所以想试着把这个项目部署到云上.云服务器操作系统是Ubuntu 14.04 LTS.之前一直在Windows下做开发,对于Linux下的环境搭建.配置还不是很熟悉,搭建的过程中学到很多东西. 本文简单记