Express 框架 速查备忘单

Express 核心工厂方法，用于解析 JSON、提供静态文件、创建可挂载的独立路由对象等常见 Web 任务。

路由器是完整的中间件与路由系统，可看作只能执行中间件与路由的「迷你应用」，便于模块化组织路径。

应用程序对象表示整个 Express 应用，通常命名为 app，用于注册路由、中间件与各类设置项。

var express = require('express');
var app = express();

console.dir(app.locals.title);
//=> 'My App'
console.dir(app.locals.email);
//=> 'me@myapp.com'

属性 (Attribute)

事件 (Events)

方法 (Method)

请求对象包含 HTTP 请求的全部信息，包括查询参数、请求体、请求头以及路由匹配结果等。

属性 (Attribute)

方法 (Method)

响应对象封装向客户端发送 HTTP 响应所需的全部方法与属性，支持设置状态码、响应头以及多种内容类型。

app.get('/', function (req, res) {
  console.dir(res.headersSent); //false
  res.send('OK');
  console.dir(res.headersSent); //true
});

属性 (Attribute)

方法 (Method)

路由器实例是完整的中间件与路由系统。可把它当作「迷你应用」挂到 app.use() 或其他路由器上，使路由组织更清晰、更易维护。

对传递给此路由器的任何请求调用

router.use(function (req, res, next) {
  //.. 这里可以放一些逻辑，像其他中间件一样
  next();
});

将处理以 /events 结尾的任何请求

// 取决于路由器 "use()" 的位置
router.get('/events', (req, res, next) => {
  //..
});

res 对象表示 Express 应用程序在收到 HTTP 请求时发送的 HTTP 响应。它提供设置状态、发送内容与链式调用能力，通常在路由处理函数中命名为 res。

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

req 对象表示 HTTP 请求，具有请求查询字符串、参数、正文、HTTP 标头等属性。理解其属性与方法是构建动态 Web 应用的关键基础。

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

用于快速结束响应而不发送数据，或结束已通过其他方法写出的响应。

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

结束响应过程。此方法实际来自 Node 核心，特别是 response.end() 方法，属于 http.ServerResponse

发送 JSON 格式响应；会自动序列化对象并设置正确的 Content-Type。

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

为路径上的所有 HTTP 方法加载中间件；无论 GET、POST、PUT 等都会执行该回调。

app.all('/secret', function (req, res, next) {
  console.log('access secret section...');
  next(); // 将控制权传递给下一个处理程序
});

处理 HTTP DELETE 请求，通常用于删除服务器上的资源。

app.delete('/', function (req, res) {
  res.send('DELETE request to homepage');
});

将名为 name 的布尔设置设为 false；等价于 app.set('foo', false)。

app.disable('trust proxy');
app.get('trust proxy');
// => false

检查设置 name 是否为禁用（false）；属性为 false 时返回 true。

app.disabled('trust proxy');
// => true

app.enable('trust proxy');
app.disabled('trust proxy');
// => false

为指定文件扩展名注册模板引擎。默认会按扩展名 require() 对应引擎。

var engines = require('consolidate');

app.engine('haml', engines.haml);
app.engine('html', engines.hogan);

绑定并监听指定主机与端口；与 Node 的 http.Server.listen() 相同。端口省略或为 0 时由系统分配空闲端口。

var express = require('express');

var app = express();
app.listen(3000);

路由定义应用如何响应特定 URI 与 HTTP 方法；结构为 app.METHOD(PATH, HANDLER)。

const express = require('express');
const app = express();

// 向主页发出 GET 请求时响应 "hello world"
app.get('/', (req, res) => {
  res.send('hello world');
});

// GET 方法路由
app.get('/', (req, res) => {
  res.send('GET request to the homepage');
});

// POST 方法路由
app.post('/', (req, res) => {
  res.send('POST request to the homepage');
});

中间件可访问请求、响应与下一中间件；可执行逻辑、修改对象、结束周期或继续传递控制权。

function logOriginalUrl(req, res, next) {
  console.log('ReqURL:', req.originalUrl);
  next();
}

function logMethod(req, res, next) {
  console.log('Request Type:', req.method);
  next();
}

const log = [logOriginalUrl, logMethod];

app.get('/user/:id', log, (req, res, next) => {
  res.send('User Info');
});

Express 可用 Pug、EJS、Handlebars 等模板引擎动态生成 HTML；需先设置视图引擎，再在 views 中放置模板。

app.set('view engine', 'pug');

在 views 目录中创建名为 index.pug 的 Pug 模板文件，内容如下

html
  the head
    title= title
  the body
    h1=message

创建路由以渲染 index.pug 文件。如果未设置视图引擎属性，则必须指定视图文件的 扩展名

app.get('/', (req, res) => {
  res.render('index', {
    title: 'Hey',
    message: 'Hello there!'
  });
});