Express+Node.js的学习

Express 认识

官网链接

tip Express 是基于 Node.js 平台，快速、开放、极简的 Web 开发框架。

安装 Express

nmp i express

创建基本服务器

const express = require('express')
// 创建 web 服务器
const app = express()

// 监听客户端的 GET 和 POST 请求 
// 并向客户端响应具体内容

//通过 app.get(’请求url‘，function(req,res)) 方法，
//可以监听客户端的 GET 请求
app.get('/user',(req,res)=>{
    res.send({
        name:'湘伦',
        age:'18'
    })
})
// post 请求 语法和 get 的差别不大
app.post('/user',(req,res)=>{
    res.send('ok')
})
// 通过 req.query 可以获取到客户端发送过来的查询参数
app.get('/user',(req,res)=>{
    // req.query 默认是空对象
    // 客户端使用 ?name=zs&age20 查询字符串的形式，发送到服务器
    // 可以通过req.query 对象访问
    // 例如 输出 zs
    console.log(req.query.name)
    
})

// 通过 req.params 对象，可以访问到 URL 中，通过 : 匹配到的动态参数
// 这里的 :id 是一个动态的参数
app.get('/user/:ids/:username', (req, res) => {
  // req.params 是动态匹配到的 URL 参数，默认是一个空对象
  console.log(req.params)
  res.send(req.params)
})

// 启动服务器
app.listen(80, () => {
  console.log('express server running at http://127.0.0.1')
})

托管静态资源

  • 通过 express.static() 方法可创建静态资源服务器，向外开放访问静态资源。
  • Express 在指定的静态目录中查找文件，并对外提供资源的访问路径，存放静态文件的目录名不会出现在 URL 中
  • 访问静态资源时，会根据托管顺序查找文件
  • 可为静态资源访问路径添加前缀
app.use(express.static('public'))
app.use(express.static('files'))
app.use('/bruce', express.static('bruce'))

/*
可直接访问 public, files 目录下的静态资源
http://localhost:3000/images/bg.jpg
http://localhost:3000/css/style.css
http://localhost:3000/js/login.js

通过带有 /bruce 前缀的地址访问 bruce 目录下的文件
http://localhost:8080/bruce/images/logo.png
*/

Express 路由

tip 在 Express 中，路由指的是客户端的请求与服务器处理函数之间的映射关系

简单用法

在 Express 中使用路由最简单的方式，就是把路由挂载到 app 上

const express = require('express')
// 创建 web 服务器，命名为 app
const app = express()

// 挂载路由
app.get('/',(req,res)=>{
    res.send('hello world')
})
app.post('/',(req,res)=>{
    res.send('hello world')
})

// 启动服务器
app.listen(80,()=>{
      console.log('express server running at http://127.0.0.1')
})

模块化路由

tip 为了方便对路由进行模块化的管理，Express 不建议将路由直接挂载到 app 上，而是推荐将路由抽离为单独的模块。

将路由抽离为单独模块的步骤如下：

  1. 创建路由模块对应的 .js 文件
  2. 调用 express.Router() 函数创建路由对象
  3. 向路由对象上挂载具体的路由
  4. 使用 module.exports 向外共享路由对象
  5. 使用 app.use() 函数注册路由模块

创建路由模块

// user.js
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

注册使用路由模块

// app.js
const express = require('express')
// 创建 web 服务器，命名为 app
const app = express()
// 导入路由模块
const userRouter = require('./router/user.js')
// 使用 app.use() 注册路由模块，添加统一访问的前缀 api
app.use('/api',userRouter)

Express 中间件

概念

  • 中间件是指流程的中间处理环节

  • 服务器收到请求后，可先调用中间件进行预处理

  • 中间件是一个函数，包含 req, res, next 三个参数，next() 参数把流转关系交给下一个中间件或路由

注意事项

  • 在注册路由之前注册中间件（错误级别中间件除外）
  • 中间件可连续调用多个
  • 别忘记调用 next() 函数
  • next() 函数后别写代码
  • 多个中间件共享 req、 res对象

全局作用域

通过 app.use() 定义的中间件为全局中间件

// 定义第一个全局中间件
app.use((req, res, next) => {
  console.log('调用了第1个全局中间件')
  next()
})
// 定义第二个全局中间件
app.use((req, res, next) => {
  console.log('调用了第2个全局中间件')
  next()
})

局部中间件

不使用 app.use() 定义的中间件，叫做局部生效的中间件

// 定义中间件函数
const mw = (req,res,next)=>{
    console.log('局部中间件函数')
    next()
}
// 使用，只能在当前使用的路由生效，其他的路由无法使用
app.get('/',mw,(req,res)=>{})

中间件的类型

应用级别的中间件

通过 app.use() 或 app.get() 或 app.post() ，绑定到 app 实例上的中间件

// 应用级别的中间件(全局中间件)
app.use((req,res,next)=>{
    next()
})
// 应用级别的中间件(局部中间件)
app.get('/',mw,(req,res)=>{
    next()
})

路由级别的中间件

绑定到 express.Router() 实例上的中间件，叫做路由级别的中间件。用法和应用级别中间件没有区别。应用级别中间件是绑定到 app 实例上，路由级别中间件绑定到 router 实例上

const app = express()
const router = express.Router()
// 路由级别的中间件
router.use(function (req, res, next) {
  console.log(1)
  next()
})

app.use('/', router)

错误级别的中间件

tip 错误级别中间件的作用：专门用来捕获整个项目中发生的异常错误，从而防止项目异常崩溃的问题

格式：错误级别中间件的 function 处理函数中，必须有 4 个形参，形参顺序从前到后，分别是 (err, req, res, next)

错误级别的中间件必须注册在所有路由之后

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

app.get('/', (req, res) => {
   // 抛出错误
  throw new Error('服务器内部发生了错误！')
  res.send('Home page.')
})

// 定义错误级别的中间件，
//捕获这个项目的异常错误，从而防止程序崩溃
app.use((err,res,req,next)=>{
    console('发生了错误！' + err.message)
    res.send('Error:' + err.message)
})

Express 内置的中间件

tip 自 Express 4.16.0 版本开始，Express 内置了 3 个常用的中间件，极大的提高了 Express 项目的开发效率和体验

  • express.static 快速托管静态资源的内置中间件，例如： HTML 文件、图片、CSS 样式等（无兼容性）
  • express.json 解析 JSON 格式的请求体数据（有兼容性，仅在 4.16.0+ 版本中可用）
  • express.urlencoded 解析 URL-encoded 格式的请求体数据（有兼容性，仅在 4.16.0+ 版本中可用

第三方的中间件

非 Express 官方内置的，而是由第三方开发出来的中间件，叫做第三方中间件。在项目中，大家可以按需下载并配置第三方中间件，从而提高项目的开发效率。

例如：在 express@4.16.0之前的版本中，经常使用 body-parser 这个第三方中间件，来解析请求体数据。使用步骤如下：

  • ① 运行 npm install body-parser 安装中间件
  • 使用 require 导入中间件
  • 调用 app.use() 注册并使用中间件

CORS 跨域资源共享

使用：

  • 安装中间件：npm install cors
  • 导入中间件：const cors = require('cors')
  • 配置中间件：app.use(cors())

注意事项：

  • CORS 主要在服务器端进行配置。客户端浏览器无须做任何额外的配置，即可请求开启了 CORS 的接口。
  • CORS 在浏览器中有兼容性。只有支持 XMLHttpRequest Level2 的浏览器，才能正常访问开启了 CORS 的服务端接口（例如：IE10+、Chrome4+、FireFox3.5+）。

CORS 响应头部 - Access-Control-Allow-Origin

响应头部中可以携带一个 Access-Control-Allow-Origin 字段

// 指定域名访问
res.setHeader('Access-Control-Allow-Origin', 'http://blog.luckjin.cool')
// 任何域可访问
res.setHeader('Access-Control-Allow-Origin', '*')

  • 默认情况下，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 对额外的请求头进行声明，否则这次请求会失败！

  • 默认情况下，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', '*')

CORS 请求分类

简单请求

  • 请求方式：GET、POST、HEAD 三者之一

  • HTTP 头部信息不超过以下几种字段：无自定义头部字段、Accept、Accept-Language、Content-Language、DPR、Downlink、Save-Data、Viewport-Width、Width 、Content-Type（只有三个值 application/x-www-formurlencoded、multipart/form-data、text/plain）

预检请求

  • 请求方式为 GET、POST、HEAD 之外的请求 Method 类型

  • 请求头中包含自定义头部字段

  • 向服务器发送了 application/json 格式的数据

在浏览器与服务器正式通信之前，浏览器会先发送 OPTION 请求进行预检，以获知服务器是否允许该实际请求，所以这一次的 OPTION 请求称为“预检请求”。服务器成功响应预检请求后，才会发送真正的请求，并且携带真实数据

简单请求和预检请求的区别

  • 简单请求的特点：客户端与服务器之间只会发生一次请求。
  • 预检请求的特点：客户端与服务器之间会发生两次请求，OPTION 预检请求成功之后，才会发起真正的请求。

使用 Express 写接口

// app.js
// 创建基本服务器
const express = require('express')
// 创建服务器实例
const app = express()
// 如果要获取 URL-encoded 格式的请求体数据，
// 必须配置中间件 app.use(express.urlencoded({ extended: false }))
app.use(express.urlencoded({ extended: false }))
// 导入注册路由模块
const apiRouter = require('./apiRouter.js')
app.use('/api',apiRouter)
// 启动服务器
app.listen(80,function(){
  console.log('express server running at http://127.0.0.1')
})

// =======分割线=======
// apiRouter.js 路由模块
const express = require('express')
const apiRouter = express.Router()
// 编写 GET 接口
apiRouter.get('/get',(req,res)=>{
    // 获取客户端通过查询字符串发送过来的数据
    const query = req.query
    // 调用 res.send()方法，把数据响应给客户端
    res.send({
        // 状态 ，0成功 ，1失败
        status:0,
        msg:'GET请求成功'
        // 数据响应给客户端
        data:query
    })
})
// 编写 POST 接口
apiRouter.post('/get',(req,res)=>{
    // 获取客户端通过请求体，发送到服务器的 URL-encoded 数据
    const body = req.body
    // 调用 res.send()方法，把数据响应给客户端
    res.send({
        // 状态 ，0成功 ，1失败
        status:0,
        msg:'POST请求成功'
        // 数据响应给客户端
        data:body
    })
})
// 导出
module.exports = apiRouter