Express.js中文文档－Request对象

request对象代表HTTP请求，及请求中的查询字符串、请求体、HTTP头等。Express的request对象是对Node.jshttp.IncomingMessage对象的扩展，在IncomingMessage对象基础上增加了一些Web应用中常用的属性和方法。按照习惯，在本文档中request对象被表示为req。

1. Request对象
2. 属性
   • 2.1 req.app
   • 2.2 req.baseUrl
   • 2.3 req.body
   • 2.4 req.cookies
   • 2.5 req.fresh
   • 2.6 req.hostname
   • 2.7 req.ip
   • 2.8 req.ips
   • 2.9 req.method
   • 2.10 req.originalUrl
   • 2.11 req.params
   • 2.12 req.path
   • 2.13 req.protocol
   • 2.14 req.query
   • 2.15 req.route
   • 2.16 req.secure
   • 2.17 req.signedCookies
   • 2.18 req.stale
   • 2.19 req.subdomains
   • 2.20 req.xhr
3. 方法
   • 3.1 检测内容类型：req.accepts()
   • 3.2 字符集检测：req.acceptsCharsets()
   • 3.3 编码方式检测：req.acceptsEncodings()
   • 3.4 语言检测：req.acceptsLanguages()
   • 3.5 获取HTTP请求头值：req.get()
   • 3.6 MIMＥ类型检查：req.is()
   • 3.7 获取参数值：req.param()

1. Request对象

Request对象继承自Node.js的IncomingMessage对象，IncomingMessage中的属性、事件、方法，在Request对象中都可以使用。它在收到用户请求时被自动创建，我们可以在路由处理器（即：回调函数）中访问这个对象。

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

按习惯我们可以将request简写为req：

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

2. 属性

2.1 req.app

req.app是对Expressapplication实例的引用，通过个属性我们可以访问app对象中的设置、属性、中间件等。

如果我们创建了一个模块，如果我们仅exports导出了中间件函数，且在主文件中require()引用了它，那么我们可以在Express的req.app实例中访问这个中间件。

如：

//index.js
app.get('/viewdirectory', require('./mymiddleware.js'))

//mymiddleware.js
module.exports = function (req, res) {
  res.send('The views directory is ' + req.app.get('views'));
});

2.2 req.baseUrl

路由实例被挂载后的URL路径。

req.baseUrl属性类似app对象的mountpath属性，但app.mountpath会返回匹配到的路径模式。如：

var greet = express.Router();

greet.get('/jp', function (req, res) {
  console.log(req.baseUrl); // /greet
  res.send('Konichiwa!');
});

app.use('/greet', greet); // 在'/greet'上挂载路由处理器

即使你使用一个路径模式或一组路径模式加载路由处理器，baseUrl仍会返回匹配的字符串而不是路由模式（s）。下面是一个加载两个路径模式的示例：

app.use(['/gre+t', '/hel{2}o'], greet); // 在'/gre+t' 和 '/hel{2}o'上挂载路由处理器

2.3 req.body

表示请求体的一个key-value数据对象。默认值是undefined，其在body-parser和multer等body解析器解析后可访问。

我们可以在Express的app.js文件中添加了一个body解析器器中间件：

var app = require('express')();
var bodyParser = require('body-parser');
var multer = require('multer'); // v1.0.5
var upload = multer(); // 解析 multipart/form-data 类型数据

app.use(bodyParser.json()); // 解析 application/json 类型数据
app.use(bodyParser.urlencoded({ extended: true })); // 解析 application/x-www-form-urlencoded 类型数据

app.post('/profile', upload.array(), function (req, res, next) {
  console.log(req.body);
  res.json(req.body);
});

2.4 req.cookies

当使用cookie-parser中间件解析cookie后，req.cookies属性是一个表示cookie的key-value对象。没有使用cookie时，其值为{}。

// Cookie: name=tj
req.cookies.name
// => "tj"

2.5 req.fresh

表示请求是"fresh"（新请求）的，与req.stale属性要反。

如果是true状态，如果cache-control请求头中没有no-cache指令，那么以下项都为true：

• if-modified-since请求头已经指定且last-modified请求头等于或早于modified响应头
• if-none-match请求头是*
• if-none-match请求头指令解析后与etag响应头不匹配

req.fresh
// => true

2.6 req.hostname

表示来自HTTP头信息中主机的主机名。

如果信任代理（trust proxy）的设置值不是false，这个属性会替换X-Forwarded-Host头字段的值。这个头一般由客户端或代理设置。

// Host: "niefengjun.cn:3000"
req.hostname
// => "niefengjun.cn"

2.7 req.ip

表示客户端请求的远程主机IP。

如果信任代理（trust proxy）的设置值不是false，这个属性会从X-Forwarded-Host头字段中获取。这个头一般由客户端或代理设置。

req.ip
// => "127.0.0.1"

2.8 req.ips

如果信任代理（trust proxy）的设置值不是false，此属性包含一个表示指向X-Forwarded-Host请头中IP的数组。否则，是一个空数组。这个头一般由客户端或代理设置。

如，如果X-Forwarded-For是客户端proxy1、proxy2，那么req.ips属性值为["client", "proxy1", "proxy2"]

2.9 req.method

表示客户端的HTTP请求方法，如：GET、PUT、POST等。

var method = req.method.toLowerCase();

if (method==='get'){
  // GET请求处理
} else if (method==='put'){
  // PUT请求处理
}

2.10 req.originalUrl

这是一个Node.jshttp模块的属性。这个属性类似于req.url，但是它保留原始请求的URL，它允许你重写req.url内部的路径目的地。

// GET /search?q=something
req.originalUrl
// => "/search?q=something"

2.11 req.params

这是一个表示路径参数的对象。如，我们使用/user/:name路径时，那么req.params.name表示路径中的:name属性。该对象默认值为{}。

// GET /user/tj
req.params.name
// => "tj"

2.12 req.path

表示请求URL中的路径部分。

// example.com/users?sort=desc
req.path
// => "/users"

2.13 req.protocol

表示HTTP请求的协议类型：http或https。

如果信任代理（trust proxy）的设置值不是false，这个属性会从X-Forwarded-Proto头字段中获取。这个头一般由客户端或代理设置。

req.protocol
// => "http"

2.14 req.query

这个属性表示URL查询字符串（'?'之后的部分）的key-value对象。如果请求中不包括查询字符串，这个属性的值为{}。

// GET /search?q=tobi+ferret
req.query.q
// => "tobi ferret"

// GET /shoes?order=desc&shoe[color]=blue&shoe[type]=converse
req.query.order
// => "desc"

req.query.shoe.color
// => "blue"

req.query.shoe.type
// => "converse"

2.15 req.route

表示当前请示中匹配到的路径字符串。

app.get('/user/:id?', function userIdHandler(req, res) {
  console.log(req.route);
  res.send('GET');
});

{ path: '/user/:id?',
  stack:
   [ { handle: [Function: userIdHandler],
       name: 'userIdHandler',
       params: undefined,
       path: undefined,
       keys: [],
       regexp: /^\/?$/i,
       method: 'get' } ],
  methods: { get: true } }

2.16 req.secure

表示是否使用TLS连接的一个布尔值。

'https' == req.protocol;

2.17 req.signedCookies

当使用cookie解析中间件时，该属性表示请求时使用的cookie签名，签名的作用是防止cookie被篡改。

// Cookie: user=tobi.CP7AWaXDfAKIRfH49dQzKJx7sKzzSoPq7/AcBBRVwlI3
req.signedCookies.user
// => "tobi"

2.18 req.stale

表示请求是"stale"（旧请求）的，与req.fresh属性要反。

req.stale
// => true

2.19 req.subdomains

一个表示请求中的子域名的数组。

// Host: "tobi.ferrets.niefengjun.cn"
req.subdomains
// => ["ferrets", "tobi"]

2.20 req.xhr

一个表示客户是否使用Ajax请求的布尔值，如果X-Requested-With请求头为XMLHttpRequest时，则为true。

req.xhr
// => true

3. 方法

3.1 检测内容类型：req.accepts()

req.accepts(types)

检测是否是可访问的内容类型，基于AcceptHTTP请求头检测。如果匹配失败，则返回false，这时应用应该响应406（不可接受的请求类型）。

// Accept: text/html
req.accepts('html');
// => "html"

// Accept: text/*, application/json
req.accepts('html');
// => "html"
req.accepts('text/html');
// => "text/html"
req.accepts(['json', 'text']);
// => "json"
req.accepts('application/json');
// => "application/json"

// Accept: text/*, application/json
req.accepts('image/png');
req.accepts('png');
// => undefined

// Accept: text/*;q=.5, application/json
req.accepts(['html', 'json']);
// => "json"

3.2 字符集检测：req.acceptsCharsets()

req.acceptsCharsets(charset [, ...])

返回一个可接受的字符集。该方法会根据Accept-CharsetHTTP头检测，如果指定的字符集不可用，则返回false。

3.3 编码方式检测：req.acceptsEncodings()

req.acceptsEncodings(encoding [, ...])

返回一个可接受的编码方式。该方法会根据Accept-EncodingHTTP头检测，如果指定的字符集不可用，则返回false。

3.4 语言检测：req.acceptsLanguages()

req.acceptsLanguages(lang [, ...])

返回一个可接受的语言。该方法会根据Accept-LanguageHTTP头检测，如果指定的语言不可用，则返回false。

3.5 获取HTTP请求头值：req.get()

req.get(field)

返回指定HTTP请求头的字段值（不区分大小写），推荐使用Referrer替换Referer字段。

req.get('Content-Type');
// => "text/plain"

req.get('content-type');
// => "text/plain"

req.get('Something');
// => undefined

3.6 MIMＥ类型检查：req.is()

req.is(type)

检查Content-TypeHTTP头中是否是指定类型的typeMIME类型。

// 当 Content-Type: text/html; charset=utf-8
req.is('html');
req.is('text/html');
req.is('text/*');
// => true

//  当 Content-Type 是 application/json
req.is('json');
req.is('application/json');
req.is('application/*');
// => true

req.is('html');
// => false

3.7 获取参数值：req.param()

req.param(name [, defaultValue])

获取req.params、req.body或req.query的参数值，其获取顺序为：

• req.params
• req.body
• req.query

// ?name=tobi
req.param('name')
// => "tobi"

// POST name=tobi
req.param('name')
// => "tobi"

// /user/tobi for /user/:name
req.param('name')
// => "tobi"