基于
03_Express.pdf整理
适合作为 Express 入门、路由、中间件与接口开发的结构化笔记。
这份 PDF 主要分成四部分:
如果说前两天的重点是:
那么这一天的重点就是:
如何用 Express 更高效地搭建 Web 服务器和 API 服务器。
Express 官方定义:
Express 是基于 Node.js 平台,快速、开放、极简的 Web 开发框架。
通俗理解:
http 模块一样,都可以创建 Web 服务器Express 的本质:
它是 npm 上的一个第三方包,是对 Node.js 原生
http模块的进一步封装。
http 还要学 Express因为原生 http 虽然能写服务器,但使用起来较繁琐。
而 Express 做了很多封装:
课程里的类比非常好记:
http和 Express 的关系,有点像浏览器原生 Web API 和 jQuery 的关系。
Express 最常见的两个使用场景:
用于:
用于:
一句话总结:
Express 既能做网站服务器,也能做接口服务器。
npm install express
Express 的最小可运行示例:
const express = require('express')
const app = express()
app.listen(3000, () => {
console.log('server running at http://127.0.0.1:3000')
})
核心步骤:
expressexpress() 创建服务器实例app.listen() 启动服务app.get('/user', (req, res) => {
res.send({ name: 'zs', age: 20 })
})
app.post('/user', (req, res) => {
res.send('请求成功')
})
res.send() 响应客户端res.send() 是 Express 中最常用的响应方法。
它可以发送:
例如:
res.send('Hello Express')
res.send({ code: 0, msg: 'ok' })
req.query当客户端通过 URL 查询字符串传参时,可以通过 req.query 获取。
例如:
/user?id=1&name=zs
服务端:
app.get('/user', (req, res) => {
console.log(req.query)
res.send(req.query)
})
得到:
{ id: '1', name: 'zs' }
req.params当 URL 中使用动态占位符时,可以通过 req.params 获取。
例如:
app.get('/user/:id', (req, res) => {
console.log(req.params)
res.send(req.params)
})
如果访问:
/user/123
则可得到:
{ id: '123' }
这也是后面做 RESTful 接口非常常见的写法。
express.static()Express 提供了一个非常实用的内置中间件:
express.static()
可以把某个目录直接托管为静态资源目录。
例如:
app.use(express.static('public'))
这样 public 目录下的文件就能直接访问,例如:
/images/bg.jpg/css/style.css/js/login.js当托管静态资源时:
静态目录名本身不会出现在 URL 中。
也就是说:
public/images/bg.jpg/images/bg.jpg可以多次调用:
app.use(express.static('public'))
app.use(express.static('files'))
Express 会按照注册顺序查找资源。
如果希望静态资源带统一前缀,可以这样写:
app.use('/public', express.static('public'))
这时访问路径会变成:
/public/images/kitten.jpg/public/css/style.css在 Node 项目开发中,如果每次改代码都要手动重启服务,会非常低效。
nodemon 的作用就是:
监听文件变化,并在代码修改后自动重启项目。
课程中介绍的是全局安装:
npm install -g nodemon
以前启动:
node app.js
现在可以换成:
nodemon app.js
这样改完代码后,服务会自动重启。
广义上,路由就是:
映射关系
在 Express 中,路由表示:
客户端请求与服务器处理函数之间的映射关系。
一个完整路由通常由三部分组成:
例如:
app.get('/user', (req, res) => {
res.send('获取用户信息')
})
每当请求到达服务器时,Express 会依次进行路由匹配。
匹配规则:
因此,路由顺序很重要。
直接挂到 app 上:
app.get('/user', (req, res) => {
res.send('获取用户信息')
})
app.post('/user', (req, res) => {
res.send('新增用户信息')
})
如果所有路由都直接写在 app.js 里,项目一大就会混乱。
因此 Express 推荐:
把路由拆成独立模块。
课程给出的步骤非常标准:
express.Router() 创建路由对象module.exports 导出路由对象app.use() 注册路由模块const express = require('express')
const router = express.Router()
router.get('/user/list', (req, res) => {
res.send('Get user list.')
})
router.post('/user/add', (req, res) => {
res.send('Add new user.')
})
module.exports = router
const express = require('express')
const app = express()
const router = require('./router')
app.use(router)
app.use('/api', router)
这样原本的:
/user/list会变成:
/api/user/list这在实际项目里非常常见。
中间件(Middleware)就是:
请求处理流程中的中间处理环节。
也可以把它理解为:
本质上,中间件就是一个函数。
基本格式:
const mw = function (req, res, next) {
// 中间件逻辑
next()
}
注意:
nextreq 和 resnext() 的作用next() 是 Express 中间件机制的关键。
它表示:
把处理权交给下一个中间件或路由。
如果不调用 next(),请求通常会卡住。
全局中间件会对所有请求生效。
app.use((req, res, next) => {
console.log('触发了中间件')
next()
})
课程特别强调一个非常重要的点:
多个中间件之间,共享同一份
req和res。
因此可以在上游中间件中给 req / res 挂自定义属性,供下游使用。
例如:
app.use((req, res, next) => {
req.startTime = Date.now()
next()
})
app.get('/', (req, res) => {
res.send('请求时间:' + req.startTime)
})
可以连续注册多个:
app.use((req, res, next) => {
console.log('中间件 1')
next()
})
app.use((req, res, next) => {
console.log('中间件 2')
next()
})
执行顺序按注册顺序来。
如果某个中间件只想服务某条路由,就可以写成局部中间件:
const mw = (req, res, next) => {
console.log('局部中间件')
next()
}
app.get('/', mw, (req, res) => {
res.send('Home page.')
})
可以写成数组,也可以按参数顺序传多个。
例如:
app.get('/', [mw1, mw2], (req, res) => {
res.send('Home page.')
})
课程总结了 5 个高频注意点:
next()next() 后尽量不要再写额外逻辑req 和 res这些点非常重要,后面做登录校验、日志记录、权限判断时都会频繁碰到。
课程把常见中间件分成 5 类:
绑定到 app 实例上的中间件,例如:
app.use((req, res, next) => {
next()
})
绑定到 router 实例上的中间件。
它和应用级别中间件用法一样,只是挂载对象不同。
用于捕获全局错误,防止项目崩溃。
格式必须是:
app.use((err, req, res, next) => {
console.log('发生了错误:' + err.message)
res.send('Error: ' + err.message)
})
关键特点:
err, req, res, next从 Express 4.16.0 开始,常见内置中间件有:
express.static():托管静态资源express.json():解析 JSON 请求体express.urlencoded():解析表单格式请求体例如:
body-parsercors在旧版本 Express 中,body-parser 很常用于解析请求体。
如今 express.urlencoded() 本质上就是对此类能力的进一步封装。
课程设计了一个练习:
手写一个类似
express.urlencoded()的中间件,解析客户端 POST 提交的表单数据。
req 的 data 事件req 的 end 事件querystring.parse() 解析数据req.bodynext()data 事件可能触发多次因为当请求体较大时,客户端可能会把数据分多次发送。
所以:
data 事件获取到的是片段querystring 的作用Node.js 内置 querystring 模块,可以把 URL-encoded 格式的字符串解析成对象。
例如:
const qs = require('querystring')
const body = 'name=zs&age=20'
console.log(qs.parse(body))
得到:
{ name: 'zs', age: '20' }
const querystring = require('querystring')
app.use((req, res, next) => {
let str = ''
req.on('data', chunk => {
str += chunk
})
req.on('end', () => {
req.body = querystring.parse(str)
next()
})
})
req.body因为:
reqreq.body 后,下游路由就能直接用这就是中间件“预处理请求”的经典用法。
Express 写接口的起点仍然是:
const express = require('express')
const app = express()
接口项目中,非常推荐把 API 路由单独拆成模块,例如:
router/apiRouter.js再统一挂到:
app.use('/api', apiRouter)
这样接口路径会更清晰,例如:
/api/get/api/postapp.get('/api/get', (req, res) => {
res.send({
status: 0,
msg: 'GET 请求成功',
data: req.query,
})
})
如果要解析表单格式请求体,必须先注册:
app.use(express.urlencoded({ extended: false }))
然后:
app.post('/api/post', (req, res) => {
res.send({
status: 0,
msg: 'POST 请求成功',
data: req.body,
})
})
这里的重点是:
写接口前,先把请求体解析中间件注册好。
前端页面和接口服务器如果不是同源,浏览器会触发同源策略限制。
课程中给出了两种解决方案:
cors 中间件解决跨域步骤:
npm install cors
const cors = require('cors')
app.use(cors())
注意:
CORS 全称:
Cross-Origin Resource Sharing(跨域资源共享)
它本质上依赖一组 HTTP 响应头,由服务器告诉浏览器:
也就是说:
CORS 主要是服务端配置,客户端浏览器通常不需要额外处理。
Access-Control-Allow-Origin用于指定允许访问资源的外域。
例如只允许某个域:
res.setHeader('Access-Control-Allow-Origin', 'http://itcast.cn')
允许所有域:
res.setHeader('Access-Control-Allow-Origin', '*')
Access-Control-Allow-Headers如果客户端发送了额外自定义请求头,服务器必须显式声明允许。
否则请求可能失败。
Access-Control-Allow-Methods默认情况下,CORS 主要支持:
如果要支持:
就需要通过该响应头显式声明。
课程把 CORS 请求分为两类:
满足这些条件之一组时,属于简单请求:
GET / POST / HEADContent-Type 仅限于以下三种之一:
application/x-www-form-urlencodedmultipart/form-datatext/plain特点:
浏览器和服务器之间只发生一次请求。
以下任一情况通常会触发预检:
GET / POST / HEADapplication/json浏览器会先发送一个:
OPTIONS请求去询问服务器是否允许。
如果服务器允许,浏览器才会再发送真正请求。
特点:
服务器和浏览器之间会发生两次请求:预检 + 真正请求。
JSONP 的本质是:
<script> 标签的 src 发请求所以 JSONP:
XMLHttpRequest它是早期跨域方案之一。
但因为限制太多,现在更多是用于理解历史方案,实际项目优先用 CORS。
课程给出的步骤:
<script> 标签app.get('/api/jsonp', (req, res) => {
const funcName = req.query.callback
const data = { name: 'zs', age: 20 }
const scriptStr = `${funcName}(${JSON.stringify(data)})`
res.send(scriptStr)
})
课程提醒:
如果项目中同时配置了 CORS 和 JSONP:
JSONP 路由要写在 CORS 中间件之前。
否则 JSONP 接口会被当成普通开启了 CORS 的接口处理。
如果只看这份 PDF,最少要掌握这些内容:
http 的关系app.get() / app.post()res.send()req.query / req.paramsexpress.static()next() 的作用req / resexpress.urlencoded() 的作用cors 解决跨域const express = require('express')
const app = express()
app.listen(3000)
app.get('/user', (req, res) => {
res.send(req.query)
})
app.post('/user', (req, res) => {
res.send('ok')
})
app.get('/user/:id', (req, res) => {
res.send(req.params)
})
app.use(express.static('public'))
app.use('/public', express.static('public'))
app.use((req, res, next) => {
next()
})
app.use(express.urlencoded({ extended: false }))
app.use(express.json())
app.use('/api', router)
const cors = require('cors')
app.use(cors())
app.use((err, req, res, next) => {
res.send('Error: ' + err.message)
})
建议你按这个顺序自己再练一遍:
req.query 和 req.paramscors这份 PDF 的核心目标,可以概括成一句话:
Express 通过路由和中间件,把原本繁琐的 Node.js 服务器开发流程变成了结构清晰、效率很高的工程化开发方式。
正在加载评论...