# 初始 Express
# Express 简介
# 概念
官方给出的概念:Express 是基于 Node.js 平台,快速、开放、极简的 Web 开发框架
# 理解
Express 对 Node.js 提供的原生 http 进行了封装,能够提高开发效率
# 作用
- Web 网站服务器:专门对外提供 Web 网页资源的服务器
- API 接口服务器:专门对外提供 API 接口的服务器
# Express 基本使用
# 安装
npm i express@4.17.1
# 创建基本的 Web 服务器
// 1. 导入 express | |
const express = require('express'); | |
// 2. 创建 web 服务器 | |
const app = express(); | |
// 3. 调用 app.listen (端口号,启动成功后的回调函数),启动服务器 | |
app.listen(80,() => { | |
console.log('express is running'); | |
}) |
# 监听 GET 请求和 POST 请求,响应给客户端
// 1. 导入 express | |
const express = require('express'); | |
// 2. 创建 web 服务器 | |
const app = express(); | |
// 3. 调用 app.listen (端口号,启动成功后的回调函数),启动服务器 | |
app.listen(80,() => { | |
console.log('express is running'); | |
}) | |
// 4. 调用 GET 请求 | |
app.get('/user',(req,res) => { | |
res.send('GET请求'); | |
}) | |
// 5. 调用 POST 请求 | |
app.post('/user',(req,res) => { | |
res.send('POST请求'); | |
}) |
# 获取 URL 中携带的查询参数
通过 req.query 对象,可以访问到客户端通过查询字符串的形式,发送到服务器的参数
app.get('/',(req,res) => { | |
console.log(req.query); | |
}) | |
// 客户端使用 http:localhost/id=1&name=baozi 打印结果为 id 和 name 的对象 |
# 获取 URL 里的动态参数
通过 req.params 对象,可以访问到 URL 中,通过 : 匹配到的动态参数
app.get('/user/:id/:name',(req,res) => { | |
console.log(req.params); | |
}) |
# 托管静态资源
# express.static()
express 提供了一个非常好用的函数,叫做 express.static (),通过它,我们可以非常方便地创建一个静态资源服务器
app.use(express.static('publish')); | |
// 可以访问 public 文件下的静态资源 |
# 托管多个敬爱资源目录
app.use(express.static('piblic')); | |
app.use(express.static('files')); |
# 挂载路径前缀
app.use('/public',express.static('piblic')); |
# nodemon
# 概念
我们可以使用 nodemon(https://www.npmjs.com/package/nodemon) 这个工具,它能够监听项目文件
的变动,当代码被修改后,nodemon 会自动帮我们重启项目,极大方便了开发和调试
# 安装
npm install -g nodemon
# 使用 nodemon
用 nodemon 的命令替换 node 启动项目
npx nodemon app.js
# Express 路由
# 路由的概念
# 什么是路由
路由就是映射关系
# Express 中的路由
在 Express 中,路由指的是客户端的请求与服务器处理函数之间的映射关系
Express 中的路由分 3 部分组成,分别是请求的类型、请求的 URL 地址、处理函数
# Express 中的路由的例子
app.get('/',(req,res) => { | |
res.send('Hello World'); | |
}) | |
app.post('/',(req,res) => { | |
res.send('Hello Post'); | |
}) |
# 路由匹配过程
每当一个请求到达服务器之后,需要先经过路由的匹配,只有匹配成功之后,才会调用对应的处理函数
在匹配时,会按照路由的顺序进行匹配,如果请求类型和请求的 URL 同时匹配成功,则 Express 会将这次请求,转交给对应的 function 函数进行处理
# 路由的使用
# 最简单用法
const express = require('express'); | |
const app = express(); | |
// 挂载路由 | |
app.get('/',(req,res) => { | |
res.send('Hello World'); | |
}) | |
app.post('/',(req,res) => { | |
res.send('Hello Post'); | |
}) | |
// 启动 Web 服务器 | |
app.listen(80,() => { | |
console.log('server is running'); | |
}) |
# 模块化路由
为了方便对路由进行模块化的管理,Express 不建议将路由直接挂载到 app 上,而是推荐将路由抽离为单独的模块
- 创建路由模块对应的.js 文件
- 调用 express.Router () 函数创建路由对象
- 向路由对象上挂载具体的路由
- 使用 moudle.exports 向外共享路由对象
- 使用 app.use () 函数注册路由模块
# 创建路由模块
// 1. 导入 express | |
const express = require('express'); | |
// 2. 创建路由对象 | |
const router = express.Router(); | |
// 3. 挂载获取用户列表的路由 | |
router.get('/user/list',(req,res) => { | |
res.send('Get user list'); | |
}) | |
router.post('/user/add',(req,res) => { | |
res.send('Post user add'); | |
}) | |
// 4. 向外导入路由对象 | |
moudle.exports = router |
# 注册路由模块
// 1. 导入路由模块 | |
const userRouter = require('./userRouter.js'); | |
// 2. 使用 app.use () 注册路由模块 | |
app.use(userRouter); |
# 为路由模块添加后缀
// 1. 导入路由模块 | |
const userRouter = require('./userRouter.js'); | |
// 2. 使用 app.usr () 注册路由模块,并设置统一的访问前缀 /api | |
app.use('/api',userRouter); |
# Express 中间件
# 中间件的概念
# 什么是中间件
中间件(Middleware ),特指业务流程的中间处理环节
# Express 中间件的调用流程
当一个请求到达 Express 的服务器之后,可以连续调用多个中间件,从而对这次请求进行预处理
# Express 中间件格式
Express 的中间件,本质上就是一个 function 处理函数
# next () 函数的作用
next 函数是实现多个中间件连续调用的关键,它表示把流转关系转交给下一个中间件或路由
# Express 中间件初体验
# 定义中间件函数
// 常量 mv 所指向的是一个中间件函数 | |
const mv = function(req,res,next) { | |
console.log('这是一个最简单的中间件函数'); | |
// 表示把流转关系转到下一个中间件或者路由 | |
next(); | |
} |
# 全局生效的中间件
客户端发起的任何请求,到达服务器之后,都会触发的中间件,叫做全局生效的中间件
// 常量 mv 所指向的是一个中间件函数 | |
const mv = function(req,res,next) { | |
console.log('这是一个最简单的中间件函数'); | |
// 表示把流转关系转到下一个中间件或者路由 | |
next(); | |
} | |
// 全局生效中间件 | |
app.use(mv); |
# 定义全局中间件的简化形式
// 全局生效中间件 | |
app.use(function(req,res,next) { | |
console.log('这是一个最简单全局中间件函数'); | |
next(); | |
}) |
# 中间件的作用
多个中间件之间,共享同一份 req 和 res。基于这样的特性,我们可以在上游的中间件中,统一为 req 或 res 对象添
加自定义的属性或方法,供下游的中间件或路由进行使用
# 定义多个全局中间件
可以使用 app.use () 连续定义多个全局中间件。客户端请求到达服务器之后,会按照中间件定义的先后顺序依次进行
调用
app.use(function(req,res,next) { | |
console.log('调用了第一个全局中间件'); | |
next(); | |
}) | |
app.use(function(req,res,next) { | |
console.log('调用了第二个全局中间件'); | |
}) | |
app.get('/user',(req,res) => { | |
res.send('Home page'); | |
}) |
# 局部生效的中间件
不使用 app.use () 定义的中间件,叫做局部生效的中间件
const mw = function(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'); | |
}) |
app.get('/',[mw1,mw2],(req,res) => { | |
res.send('Home page'); | |
}) |
# 中间件的分类
# 应用级别中间件
通过 app.use () 或 app.get () 或 app.post () ,绑定到 app 实例上的中间件,叫做应用级别的中间件
app.use((req,res,next) => { | |
next(); | |
}) | |
app.get('/',mw,(req,res) => { | |
res.send('Home page'); | |
}) |
# 路由级别的中间件
绑定到 express.Router () 实例上的中间件,叫做路由级别的中间件。它的用法和应用级别中间件没有任何区别。只不
过,应用级别中间件是绑定到 app 实例上,路由级别中间件绑定到 router 实例上
const app = express(); | |
const router = express.Router(); | |
// 路由级别的中间件 | |
router.use((req,res,next) => { | |
console.log('Time',Date.now()); | |
next(); | |
}) | |
app.use('/',router); |
# 错误级别的中间件
错误级别中间件的作用:专门用来捕获整个项目中发生的异常错误,从而防止项目异常崩溃的问题
格式:错误级别中间件的 function 处理函数中,必须有 4 个形参,形参顺序从前到后,分别是 (err, req, res, next)
** 注意:** 错误级别的中间件,必须注册在所有路由之后
app.get('/',(req,res) => { | |
throw new Error('服务器内部发生了错误'); | |
res.send('Home page'); | |
}) | |
app.use((err,req,res,next) => { | |
console.log('发生了错误' + err.message); | |
res.send('Error' + err.message); | |
}) |
# Express 内置的中间件
内置了三个常用中间件
- express.static 快速托管静态资源的内置中间件,例如: HTML 文件、图片、CSS 样式等
- express.json 解析 JSON 格式的请求体数据
- express.urlencoded 解析 URL-encoded 格式的请求体数据
// 配置解析 application/json 格式数据的内置中间件 | |
app.use(express.json()); | |
// 配置解析 application/x-www-form-urlencoded 格式数据的内置中间件 | |
app.use(express.urlencoded({ extend: false })) |
# 第三方的中间件
非 Express 官方内置的,而是由第三方开发出来的中间件,叫做第三方中间件。在项目中,大家可以按需下载并配置
第三方中间件,从而提高项目的开发效率
- 运行
npm i body-parser
- 使用 require 导入中间件
- 调用 app.use () 注册并使用中间件
# 使用 Express 写接口
# 创建最基本的服务器
// 1. 导入 express 模块 | |
const express = require('express'); | |
// 2. 创建 express 服务器实例 | |
const app = express(); | |
// 3. 调用 app.listen () 方法,指定端口启动服务器 | |
app.listen(80,() => { | |
console.log('server is running'); | |
}) |
# 创建 API 路由模块
//apiRouter.js 模块 | |
const express = require('express'); | |
const apiRouter = express.Router(); | |
moudle.exports = apiRouter; | |
//app.js 导入注册模块 | |
const apiRouter = require('./apiRouter.js'); | |
app.use('/api',apiRouter); |
# 编写 GET 接口
apiRouter.get('/get',(req,res) => { | |
// 1. 获取到客户端通过查询字符串,发送到服务器的数据 | |
const query = req.query; | |
// 2. 调用 res.send () 方法,把数据响应给客户端 | |
res.send({ | |
status: 0, | |
msg: 'GET请求成功', | |
data: query | |
}) | |
}) |
# 编写 POST 接口
apiRouter.post('/post',(req,res) => { | |
// 1. 获取到客户端通过查询字符串,发送到服务器的数据 | |
const body = req.body; | |
// 2. 调用 res.send () 方法,把数据响应给客户端 | |
res.send({ | |
status: 0, | |
msg: 'GET请求成功', | |
data: body | |
}) | |
}) |
# CORS 跨域资源共享
# 接口的跨域问题
刚才编写的 GET 和 POST 接口,存在一个问题,不支持跨域请求
解决跨域问题的两个方案:
- CORS(主流的解决方案)
- JSONP(有缺陷的解决方案:只支持 GET 请求)
# 使用 cors 中间件解决跨域问题
cors 是 Express 的一个第三方中间件。通过安装和配置 cors 中间件,可以很方便地解决跨域问题
步骤:
- 运行
npm install cors
安装中间件 - 使用
const cors = require('cors')
导入中间件 - 在路由之前调用
app.use(cors())
配置中间件
# 什么是 CORS
CORS (Cross-Origin Resource Sharing,跨域资源共享)由一系列 HTTP 响应头组成,这些 HTTP 响应头决定浏览器是否阻止前端 JS 代码跨域获取资源
浏览器的同源安全策略默认会阻止网页 “跨域” 获取资源。但如果接口服务器配置了 CORS 相关的 HTTP 响应头,就可以解除浏览器端的跨域访问限制
# CORS 的注意事项
① CORS 主要在服务器端进行配置。客户端浏览器无须做任何额外的配置,即可请求开启了 CORS 的接口
② CORS 在浏览器中有兼容性。只有支持 XMLHttpRequest Level2 的浏览器,才能正常访问开启了 CORS 的服务端接口
# 5.5 CORS 响应头部 -Accress-Control-Allow-Origin
响应头部中可以携带一个 Access-Control-Allow-Origin 字段
res.setHeader('Access-Control-Allow-Origin','http://itcast.cn'); |
如果指定了 Access-Control-Allow-Origin 字段的值为通配符 *****,表示允许来自任何域的请求
res.setHeader('Access-Control-Allow-Origin','*'); |
# CORS 响应头部 -Accress-Control-Allow-Headers
默认情况下,CORS 仅支持客户端向服务器发送如下的 9 个请求头
Accept、Accept-Language、Content-Language、DPR、Downlink、Save-Data、Viewport-Width、Width 、Content-Type (值仅限于 text/plain、multipart/form-data、application/x-www-form-urlencoded 三者之一)
如果客户端向服务器发送了额外的请求头信息,则需要在服务器端,通过 Access-Control-Allow-Headers 对额外的请求头进行声明,否则这次请求会失败
res.setHeader('Access-Control-Allow-Headers','Content-Type,X-Custom-Header'); |
# CORS 响应头部 -Access-Control-Allow-Methods
默认情况下,CORS 仅支持客户端发起 GET、POST、HEAD 请求
如果客户端希望通过 PUT、DELETE 等方式请求服务器的资源,则需要在服务器端,通过 Access-Control-Alow-Methods 来指明实际请求所允许使用的 HTTP 方法
// 只允许 POST,GET,DELETE,HEAD 请求方法 | |
res.setHeader('Access-Control-Allow-Methods',"POST,GET,DELETE,PUT"); | |
// 允许所有的 HTTP 请求方法 | |
res.setHeader('Access-Control-Allow-Methods','*'); |
# 简单请求
同时满足以下两大条件:
- 请求方式:GET、POST、HEAD 三者之一
- HTTP 头部信息不超过以下几种字段:无自定义头部字段、Accept、Accept-Language、Content-Language、DPR、Downlink、Save-Data、Viewport-Width、Width 、Content-Type(只有三个值 application/x-www-form-urlencoded、multipart/form-data、text/plain)
# 预检请求
只要符合以下任何一个条件的请求,都需要进行预检请求:
- 请求方式为 GET、POST、HEAD 之外的请求 Method 类型
- 请求头中包含自定义头部字段
- 向服务器发送了 application/json 格式的数据
在浏览器与服务器正式通信之前,浏览器会先发送 OPTION 请求进行预检,以获知服务器是否允许该实际请求,所以这一次的 OPTION 请求称为 “预检请求”。服务器成功响应预检请求后,才会发送真正的请求,并且携带真实数据。
# JSONP 接口
# JSONP 概念和特点
# 概念
浏览器端通过 <script> 标签的 src 属性,请求服务器上的数据,同时,服务器返回一个函数的调用。这种请求数据
的方式叫做 JSONP
# 特点
- JSONP 不属于真正的 Ajax 请求,因为它没有使用 XMLHttpRequest 这个对象
- JSONP 仅支持 GET 请求,不支持 POST、PUT、DELETE 等请求
# 创建 JSONP 接口注意事项
如果项目中已经配置了 CORS 跨域资源共享,为了防止冲突,必须在配置 CORS 中间件之前声明 JSONP 的接口。否则 JSONP 接口会被处理成开启了 CORS 的接口
// 优先创建 JSONP 接口 | |
app.get('/api/jsonp',(req,res) => { | |
}) | |
// 再配置 CORS 中间件 | |
app.use(cors())l | |
// 这是一个开启了 CORS 的接口 | |
app.get('/api/get',(req,res) => { | |
}) |
# 实现 JSONP 接口的步骤
-
# 获取客户端发过来的回调函数的名字
-
得到要通过 JSONP 形式发送给客户端的数据
-
根据前两步得到的数据,拼接出一个函数调用的字符串
-
把上一步拼接得到的字符串,响应给客户端的 <script> 标签进行解析执行
# 代码实现
app.get('/api/jsonp',(req,res) => { | |
// 1. 获取客户端发送过来的回调函数的名字 | |
const funcName = req.query.callback | |
// 2. 得到要通过的 JSONP 形式发送给客户端的数据 | |
const data = {name: 'zs',age: 23}; | |
// 3. 根据前两步得到的数据,拼接出函数调用的字符串 | |
const srciptStr = '${funcName}(${JSON.stringify(data)})'; | |
// 4. 把上一步拼接得到的字符串,响应给客户端 & lt;script > 标签进行解析 | |
res.send(srcipStr); | |
}) |