1、Express
官方给出的概念: Express 是基于 Node.js 平台,快速、开放、极简的 Web 开发框架
通俗的理解: Express 的作用和 Node,js 内置的 http 模块类似,是专门用来创建 Web 服务器的
Express的本质:就是一个npm 上的第三方包,提供了快速创建Web 服务器的便捷方法
Express 的中文官网: www.expressjs.com.cn/
1.1 Express的基本使用
安装
在项目所处的目录中,运行如下的终端命令,即可将express 安装到项目中使用:
npm i express
创建web服务器
// 1.导入 express
const express = require('express')
// 2、创建 web 服务器
const app = express()
// 3.调用 app.listen(端口号,启动成功后的回调函数) ,启动服务器
app.listen(80, () => {
console.log('服务启动~')
})
监听GET请求和POST请求
通过app.get() 方法,可以监听客户端的 GET 请求
通过app.post() 方法,可以监听客户端的 POST请求
const express = require('express')
const app = express()
app.get('/user', (req, res) => {
console.log(req.url)
res.send({ name: 'lily', age: 18 })
})
app.post('/list', (req, res) => {
res.send('请求成功')
})
app.listen(8081, () => {
console.log('服务启动~')
})
获取URL中携带的查询参数
通过 req.query 对象,可以访问到客户端通过查询字符串的形式,发送到服务器的参数
获取URL中的动态参数
通过 req.params 对象,可以访问到 URL中,通过:匹配到的动态参数:
托管静态资源
express 提供了一个非常好用的函数,叫做 express.static(),通过它,我们可以非常方便地创建一个静态资源服务器例如,通过如下代码就可以将 public 目录下的图片、CSS 文件、JavaScript 文件对外开放访问了:
app.use(express.static('public'))
现在,就可以访问 public 目录中的所有文件了:
http://localhost:3000/images/bg.jpg
http://localhost:3000/css/style.css
http://localhost:3000/js/login.js
注意: Express在指定的静态目录中查找文件,并对外提供资源的访问路径因此,存放静态文件的目录名不会出现在 URL 中
托管多个静态资源目录
如果要托管多个静态资源目录,多次调用express.static()函数:
app.use(express.static( 'public' ))
app.use(express.static( 'files'))
挂载路径前缀
如果希望在托管的静态资源访问路径之前,挂载路径前缀,则可以使用如下的方式:
app.use( '/abc',express.static('public'))
nodemon
在编写调试 Node.s 项目的时候,如果修改了项目的代码,则需要频繁的手动 close 掉,然后再重新启动,非常繁琐现在,我们可以使用 nodemon(www.npmis.com/package/nod…) 这个具,它能够监听项目文件的变动,当代码被修改后,nodemon 会自动帮我们重启项目,极大方便了开发和调试。
安装nodemon
在终端中,运行如下命令,即可将 nodemon 安装为全局可用的工具:
npm install -g nodemon
使用nodemon
当基于 Node.js 编写了一个网站应用的时候,传统的方式,是运行 node app.js 命令,来启动项目。这样做的坏处是:代码被修改之后,需要手动重启项目。
现在,我们可以将 node 命令替换为 nodemon 命令,使用 nodemon app.js 来启动项目。这样做的好处是:代码被修改之后,会被nodemon 监听到,从而实现自动重启项目的效果。
nodemon index.js
Express路由
在 Express 中,路由指的是客户端的请求与服务器处理函数之间的映射关系
Express 中的路由分3 部分组成,分别是请求的类型、请求的 URL 地址、处理函数
路由的匹配过程
每当一个请求到达服务器之后,需要先经过路由的匹配,只有匹配成功之后,才会调用对应的处理函数
在匹配时,会按照路由的顺序进行匹配,如果请求类型和请求的 URL同时匹配成功,则Express 会将这次请求,转交给对应的function函数进行处理
模块化路由
为了方便对路由进行模块化的管理,Express 不建议将路由直接挂载到 app 上,而是推荐将路由抽离为单独的模块
将路由抽离为单独模块的步骤如下:
- 创建路由模块对应的js 文件
- 调用 express.Router()函数创建路由对象
- 向路由对象上挂载具体的路由
- 使用 module.exports 向外共享路由对象
- 使用app.use()函数注册路由模块
新建router.js
const express = require('express')
const router = express.Router()
router.get('/user/list', (req, res) => {
res.send('getUserList')
})
router.post('/user/add', (req, res) => {
res.send('add new user')
})
module.exports = router
在index.js中挂载router
const express = require('express')
const app = express()
const userRouter = require('./router')
//app.use 注册全局中间件
app.use(userRouter)
app.listen(8081, () => {
console.log('服务启动~')
})
为路由模块添加前缀
类似于托管静态资源时,为静态资源统一挂载访问前缀一样,路由模块添加前缀的方式也非常简单
// 1.导入路由模块
const userRouter = require( './router/user.js' )
// 2.使用 app.use()注册路由模块,并添加统一的访问前缀 /api
app.use( '/api', userRouter)
Express中间件
Express 中间件的调用流程
当一个请求到达 Express的服务器之后,可以连续调用多个中间件,从而对这次请求进行预处理
Express中间件的格式
Express的中间件,本质上就是一个 function 处理函数
注意: 中间件函数的形参列表中,必须包合 next 参数。而路由处理函数中只包含 req 和 res。
next函数的作用
next 函数是实现多个中间件连续调用的关键,它表示把流转关系转交给下一个中间件或路由。
定义中间件函数
可以通过如下的方式,定义一个最简单的中间件函数:
// 常量 mw 所指向的,就是一个中间件函数
const mw = function (req, res, next) {
console.log("这是一个最简单的中间件函数)
// 注意: 在当前中间件的业务处理完毕后,必须调用 next() 函数// 表示把流转关系转交给下一个中间件或路由
next()
}
全局生效的中间件
客户端发起的任何请求,到达服务器之后,都会触发的中间件,叫做全局生效的中间件
通过调用 app.use(中间件函数),即可定义一个全局生效的中间件,示例代码如下:
app.use((req, res, next) => {
console.log('这是最简单的中间件函数')
// 把流转关系,转交给下一个中间件或路由
next()
})
中间件的作用
多个中间件之间,共享同一份 req 和 res。基于这样的特性,我们可以在上游的中间件中,统一为req或res 对象添加自定义的属性或方法,供下游的中间件或路由进行使用。
app.use((req, res, next) => {
req.time = Date.now()
console.log('我是中间件')
next()
})
定义多个全局中间件
可以使用 app.use()连续定义多个全局中间件。客户端请求到达服务器之后,会按照中间件定义的先后顺序依次进行调用,示例代码如下:
app.use(function(req,res,next)( // 第1个全局中间件
console.log("调用了第1个全局中间件")
next()
})
app.use(function(req,res,next){ // 第2个全局中间件
console.log('调用了第2个全局中间件)
next()
})
app.get('/user’,(req,res) =>{ // 请求这个路由,会依次触发上述两个全局中间件
res.send( 'home page .')
})
局部生效的中间件
不使用 app.use() 定义的中间件,叫做局部生效的中间件,示例代码如下:
const express = require('express')
const app = express()
const mw = function (req, res, next) {
req.time = Date.now()
console.log('我是中间件')
next()
}
app.use('/api', mw, (req, res) => {
res.send('home page')
})
app.listen(8081, () => {
console.log('服务启动~')
})
定义多个局部中间件
可以在路由中,通过如下两种等价的方式,使用多个局部中间件:
app.get('/',mw1, mw2, (req, res) => { res.send( 'Home page.') })
app.get('/',[mw1, m2], (req, res) => [ res.send('Home page.') })
中间件的5个使用注意事项
- 一定要在路由之前注册中间件
- 客户端发送过来的请求,可以连续调用多个中间件进行处理
- 执行完中间件的业务代码之后,不要忘记调用 next() 函数
- 为了防止代码逻辑混乱,调用 next函数后不要再写额外的代码
- 连续调用多个中间件时,多个中间件之间,共享 req 和 res 对象
中间件分类
应用级别的中间件
通过 app.use0 或 app.get0 或 app.post0,绑定到 app 实例上的中间件,叫做应用级别的中间件,代码示例如下
// 应用级别的中间件《全局中间件)
app.use((req, res, next) => {
next()
})
// 应用级别的中间件《局部中间件)
app.get('/', mw1, (req, res) => {
res.send( ' Home page . ')
})
路由级别的中间件
绑定到 express.Router0 实例上的中间件,叫做路由级别的中间件。它的用法和应用级别中间件没有任何区别。只不过,应用级别中间件是绑定到 app 实例上,路由级别中间件绑定到 router 实例上,代码示例如下
var app = express()
var router = express .Router()
// 路由级别的中间件
router.use(function (req, res, next) {
console.log('Time:', Date.now())
next()
})
app.use(' /', router)
错误级别的中间件
错误级别中间件的作用:专门用来捕获整个项目中发生的异常错误,从而防止项目异常崩溃的问题。
格式: 错误级别中间件的 function 处理函数中,必须有 4 个形参,形参顺序从前到后,分别是(err, req, res, next)。
app.get('/', function (reg, res) (// 1.路由
throw new Error(服务器内部发生了错误!) // 1.1 抛出一个自定义的错误
res.send("Home Page .' )
})
app.use(function (err,req,res,next){
console.log('发生了错误:'+ err.message)
res.send('Error'+ err.message)
})
注意: 错误级别的中间件必须注册在所有路由之后!
Express内置的中间件
自Express 4.16.0 版本开始,Express 内置了3 个常用的中间件极大的提高了 Express 项目的开发效率和体验:
- express.static 快速托管静态资源的内置中间件,例如: HTML 文件、图片、CSS 样式等(无兼容性)
- express.json 解析JSON 格式的请求体数据 (有兼容性,仅在 4.16.0+ 版本中可用)
- express.urlencoded 解析 form 表单格式的请求体数据(有兼容性,仅在 4.16.0+ 版本中可用)
// 配置解析 application/json 格式数据的内置中间件
app.use(express.json())
// 配置解析 application/x-ww-form-urlencoded 格式数据的内置中间件
app.use(express.urlencoded({ extended: false }))
express.json和express.urlencoded使用
const app = express()
// 注意: 除了错误级别的中间件,其他的中间件,必须在路由之前进行配置
// 通过 express.json() 这个中间件,解析表单中的 JSON 格式的数据
app.use(express.json())
//解析form表单格式的数据
app.use(express.urlencoded({ extended: false }))
app.post('/user', (req, res) => {
// 在服务器,可以使用 req.body 这个属性,来接收客户端发送过来的请求体数据
// 默认情况下,如果不配置解析表单数据的中间件,则 reg.body 默认等于 undefined
console.log(req.body)
res.send('ok')
})
第三方的中间件
非Express 官方内置的,而是由第三方开发出来的中间件,叫做第三方中间件。
在项目中,大家可以按需下载并配置第三方中间件,从而提高项目的开发效率。 例如:在express@4.16.0之前的版本中,经常使用 body-parser 这个第三方中间件,来解析请求体数据。使用步骤如下:
- 运行 npm install body-parser 安装中间件
- 使用 require 导入中间件
- 用 app.use() 注册并使用中间件
// 1.导入解析表单数据的中间件 body-parser
const parser = require( 'body-parser')
// 2.使用 app.use() 注册中间件
app.use(parser.urlencoded(f extended: false }))
CORS接口跨域问题
GET 和 POST接口,存在一个很严重的问题: 不支持跨域请求
解决接口跨域问题的方案主要有两种:
- CORS(主流的解决方案,推荐使用)
- JSONP (有缺陷的解决方案: 只支持 GET 请求)
使用CORS中间件来解决跨域问题
cors 是 Express 的一个第三方中间件。通过安装和配置cors 中间件,可以很方便地解决跨域问题.使用步骤分为如下3步:
- 运行 npm install cors 安装中间件
- 使用 const cors = require(cors)导入中间件
- 在路由之前调用 app.use(cors()) 配置中间件
CORS注意事项
- CORS 主要在服务器端进行配置,客户端浏览器无须做任何额外的配置,即可请求开启了 CORS 的接口。
- CORS 在浏览器中有兼容性。只有支持 XMLHttpRequest Level2 的浏览器,才能正常访问开启了 CORS 的服务端接口 (例如: IE10+、Chrome4+、FireFox3.5+)。
CORS跨域资源共享
CORS 响应头部 - Access-Control-Allow-Origin
响应头部中可以携带一个 Access-Control-Allow-Origin 字段,其语法如下:
Access-Control-Allow-Origin: <origin> | *
其中,origin 参数的值指定了允许访问该资源的外域 URL.
例如,下面的字段值将只允许来自 itcast.cn 的请求
res.setHeader('Access-Control-Allow-Origin','http://itcast.cn')
如果指定了Access-Control-Allow-Origin 字段的值为通配符*,表示允许来自任何域的请求,示例代码如下:
res .setHeader('Access-Control-Allow-Origirn','*')
CORS 响应头部 - Access-Control-Allow-Headers
默认情况下,CORS 仅支持客户端向服务器发送如下的9个请求头:
Accept、Accept-Language、 Content-Language、 DPR、Downlink, Save-Data, Viewport-Width, WidthContent-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,HEAD')
// 允许所有的 HTTP 请求方法
res.setHeader('Access-Control-Allow-Methods'.'*')