Express 入门

最新推荐文章于 2023-04-03 17:59:58 发布

孙先森428

最新推荐文章于 2023-04-03 17:59:58 发布

阅读量1.1k

点赞数 1

分类专栏： Express 文章标签：前端服务器 node.js

本文链接：https://blog.csdn.net/Everglow___/article/details/123539082

版权

Express 专栏收录该内容

1 篇文章 0 订阅

订阅专栏

express 是一个创建web服务器的工具，它基于node中的 http 模块，但功能更加强大。

1. express创建一个基本的服务器

// 1. 导入 express
const express = require('express')
// 2. 创建 web 服务器
const app = express()
// 3. 启动 web 服务器
app.listen(8080, () => {
  console.log('express server running at http://127.0.0.1:8080');
})

2. express 创建共享静态资源服务器

使用 express.static() 方法，可以快速的对外提供静态资源。

const express = require('express')
const app = express()
// 调用 express.static() 方法,快速的对外提供静态资源
// public 这个目录不会出现在 url 中
app.use(express.static('./public'))
app.listen(8080, () => [
  console.log('express server running at http://127.0.0.1:8080')
])

客户端在访问静态资源时，public 这个目录不会出现在 url 中。例如，访问public 文件夹下的index.html文件：http://127.0.0.1:8080/index.html

express 也可以提供多个静态资源：

app.use(express.static('./public'))
// 如果想要 提供多个静态资源, 就多次调用 express.static() 方法
// 注意 访问静态资源文件时, express.static()函数会根据目录的添加顺序查找所需文件
app.use(express.static('./xingyu-tools'))

例如，如果要访问index.html 这个文件，上图两个文件夹中都包含 index.html，express.static()函数只会按照目录的添加顺序，访问 public 这个目录下的index.html文件，而不会从xingyu-tools这个目录下查找。

在被访问文件的前面加上一个访问前缀：

// 如果想要在访问的文件前面加一个访问前缀 就需要在 express.static() 前面在加一个参数
app.use('/abc', express.static('./public'))
// 此时访问的 url就是  http://127.0.0.1:8080/abc/index.html

3. express 路由

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

express 中的路由分 3 部分组成，分别是 请求的类型、请求的 URL 地址、处理函数，格式如下：

app.METHOD(PATH, HANDLER)

（1）路由的匹配过程

每当一个请求到达服务器之后，需要先经过路由的匹配，只有匹配成功后，才会调用对应的处理函数。

在匹配时，会按照路由的顺序进行匹配，如果请求类型和请求的URL 同时匹配成功，则Express 会将这次请求，转交给对应的 function 函数进行处理。

（2）路由的基本用法

在 Express 中使用路由最基本的方式，就是挂载到app上

const express = require('express')
const app = express()
// 挂载路由
app.get('/user', (req, res)=> {
  res.send({name:'张三', age: 20})
})
app.post('/user', (req, res) => {
  res.send('post请求成功')
})

app.listen(8080, () => {
  console.log('express server running at http://127.0.0.1:8080');
})

（3）模块化路由

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

步骤如下：

创建路由模块对应的 .js 文件

调用 express.Router() 函数创建路由对象

向路由对象上挂载具体的路由

使用 module.exports 向外共享路由对象

使用 app.use() 函数注册路由模块

// 这是路由模块
// 1. 导入 express
const express = require('express')
// 2.创建路由对象
const router = express.Router()
// 3. 挂载具体的路由
router.get('/user', (req, res)=> {
  res.send({name:'张三', age: 20})
})
router.post('/user', (req, res) => {
  res.send('post请求成功')
})

// 向外暴漏路由对象
module.exports = router

注册路由模块：

const express = require('express')
const app = express()
// 1.导入路由模块
const router = require('./04-模块化路由')
// 2.注册路由模块
app.use(router)
app.listen(8080, () => {
  console.log('express server running at http://127.0.0.1:8080');
})

如果想要在路由前面加上一个访问前缀，就在app.use() 方法的router参数前面，再加上一个参数。

例如：app.use('/abc', router) 这时访问的url 就变成 http://127.0.0.1:8080/abc/user

4. Express 中间件

中间件就是业务流程的中间处理环节。当一个请求到达 Express 的服务器之后，可以连续调用多个中间件，从而对这次请求进行预处理。

next 函数是实现多个中间件连续调用的关键，它表示把流转关系转交给下一个中间件或路由。

(1) 创建一个最基本的全局中间件

客户端发起的任何请求，到达服务器之后，都会触发的中间件，叫做全局生效的中间件。

通过调用 app.use(中间件函数) ，即可定义一个全局生效的中间件。如下：

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

// 定义一个最简单的中间件函数
const mw = function(req, res, next) {
  console.log('这是最简单的中间件函数')
  // 把流转关系，转交给下一个中间件或路由
  next()
}

// 将 mw 注册为全局生效的中间件
app.use(mw)

app.get('/', (req, res) => {
  res.send('主页')
})
app.get('/user', (req, res) => {
  res.send('我的')
})

app.listen(8080, ()=>{
  console.log('http://127.0.0.1:8080')
})

（2）中间件的作用

多个中间件之间，共享同一份 req 和 res，基于这样的特性，我们可以在上游的中间件中，统一为req 或 res 对象添加自定义的属性或方法，供下游的中间件或路由进行使用。

app.use(function(req, res, next) {
  // 获取请求到达服务器的时间
  const time = Date.now()
  // 为 req 对象，挂载自定义属性，从而把时间共享给后面的路由
  req.startTime = time
  next()
})

app.get('/', (req, res) => {
  res.send('主页' + req.startTime)
})
app.get('/user', (req, res) => {
  res.send('我的' + req.startTime)
})

（3）定义多个全局中间件

多次调用多个 app.use() 方法，就可以定义多个全局中间件。Express 会根据中间件定义的先后顺序依次执行。

app.use(function(req, res, next) {
  console.log('这是第一个中间件');
  next()
})
app.use(function(req, res, next) {
  console.log('这是第二个中间件');
  next()
})
app.get('/', (req, res) => {
  res.send('主页')
})

（4）定义局部中间件

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

在路由中使用局部中间件：需要在 url 和响应函数中间再加一个参数，如下：

// 定义中间件函数
const mw = function(req, res, next) {
  console.log('这是一个局部中间件');
  next()
}
// mw 这个中间件只在当前路由中生效
app.get('/', mw, (req, res) => {
  res.send('主页')
})
// mw 不会影响下面这个路由
app.get('/user', (req, res) => {
  res.send('我的')
})

调用多个局部中间件，可以使用如下两种方式：

app.get('/', mw1, mw2, (req, res) => {res.send('主页')})
app.get('/', [mw1, mw2], (req, res) => {res.send('主页')})

(5) 中间件的5个使用注意事项

一定要在路由之前注册中间件

客户端发送过来的请求，可以连续调用多个中间件进行处理

执行完中间件的业务代码之后，不要忘记调用 next() 函数

为了防止代码逻辑混乱，调用 next() 函数之后不要再写额外的代码

连续调用多个中间件时，多个中间件之间，共享 req 和 res 对象

(6) 中间件的分类

应用级中间件：在app上挂载的中间件；

路由级中间件：在 Router 上挂载的中间件；

错误级中间件：专门用来捕获整个项目中发生的异常错误，从而防止项目异常崩溃的问题。错误级中间件的处理函数中，必须有4个形参，形参顺序从前到后分别是 (err, req, res, next)。

const express = require('express')
const app = express()
// 1. 定义路由
app.get('/user', (req, res)=> {
  // 1.1 人为的制造错误
  throw new Error('服务器内部出错!')
  res.send({name:'张三', age: 20})
})

// 2. 定义错误级别的中间件,捕获整个项目的异常错误,从而防止程序崩溃
app.use((err, req, res, next) => {
  console.log('发生了错误!' + err.message) // 在服务器打印错误消息
  res.send('Error:'+ err.message) // 在客户端响应错误相关的内容
})
app.listen(8080, () => {
  console.log('express server running at http://127.0.0.1:8080');
})

注意：错误级别中间件，必须注册在所有路由之后。

Express 内置中间件：

express.static 快速托管静态资源的内置中间件

express.json 解析JSON格式的请求体数据

express.urlencoded 解析URL-encoded 格式的请求体数据

// 配置解析 application/json 格式数据的内置中间件
app.use(express.json())
// 配置解析application/x-www-form-urlencoded 格式数据的内置中间件
app.use(express.urlencoded({ extended: false})

具体示例：

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

// 注意:除了错误级别中间件,其他中间件,必须在路由之前进行配置
// 通过 express.json() 这个中间件,解析表单中 JSON 格式的数据
app.use(express.json())
// 通过 express.urlencoded() 这个中间件,解析表单中 url-encoded 格式的数据
app.use(express.urlencoded({ extended: false }))

app.post('/user', (req, res)=> {
  // 在服务器中,可以使用 req.body 这个属性,来接收客户端发送过来的请求体数据
  // 默认情况下,如果不配置解析表单数据的中间件,则 req.body 默认等于 undefined
  console.log(req.body)
  res.send({name:'张三', age: 20})
})

app.post('/book', (req, res) => {
  // 默认情况下,如果不配置解析 url-encoded 的中间件,则 req.body 默认等于 {}
  console.log(req.body)
  res.send('请求成功')
})
app.listen(8080, () => {
  console.log('express server running at http://127.0.0.1:8080');
})

注意: 除了错误级别中间件,其他中间件,必须在路由之前进行配置。

第三方的中间件：

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

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

1. 运行 npm i body-parser 安装中间件

2. 使用 require 导入中间件

3. 调用 app.use() 注册并使用中间件

自定义中间件：

自定义一个解析表单数据的中间件：

// 引入 node 内置的 querystring 模块
const qs = require('querystring')

// 自定义中间件
function bodyParser(req, res, next) {
  // 定义中间件具体的业务逻辑
  // 1. 定义一个 str 字符串，专门用来存储客户端发送过来的请求体数据
  let str = ''
  // 2. 监听 req 的 data 事件
  req.on('data', (chunk) => {
    // 有时客户端发送的数据量过大,会一段一段发送,所以把每次请求的请求体数据拼接到一起
    str += chunk
  })
  // 3. 监听 req 的 end 事件 该事件在请求结束后自动触发
  req.on('end', ()=>{
    // 此时 str 表示客户端请求体的完整数据
    // 调用 querystring.parse() 方法，把字符串格式的请求体数据，解析成对象格式
    const body = qs.parse(str)
    // 将解析好的数据挂载到 req 身上, 以供下游中间件或路由使用
    req.body = body
    next()
  })
}

// 导出中间件
module.exports = bodyParser

使用自定义中间件：

const express = require('express')
const app = express()
// 1. 引入中间件
const bodyParser = require('./13-custom-body-parser')
// 2. 调用自定义中间件
app.use(bodyParser)

app.post('/user', (req, res) => {
  res.send(req.body)
  console.log('请求成功')
})

app.listen(8080, () => {
  console.log('express server running at http://127.0.0.1:8080');
})

5. 使用 Express 编写接口

（1）编写 GET 接口

首先建立一个 Express 服务器：

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

// 导入路由模块
const router = require('./15-apiRouter')
//  注册路由 添加一个访问前缀 /api
app.use('/api', router)

app.listen(8080, () => {
  console.log('express server running at http://127.0.0.1:8080');
})

声明路由模块：

const express = require('express')
const router = express.Router()
// 在这里挂载对应的路由
router.get('/get', (req, res) => {
  // 通过req.query 获取客户端通过查询字符串,发送到服务器的数据
  const query = req.query
  // 调用 res.send() , 向客户端响应处理的结果
  res.send({
    status: 0, // 0表示成功, 1 表示失败
    msg: 'GET 请求成功', // 状态描述
    data: query, // 需要响应给客户端的数据
  })
})
module.exports = router

（2）编写 POST 接口

在路由模块中添加：

router.post('/post', (req, res) => {
  // 通过req.body 获取客户端发送到服务器的 URL-encoded数据
  const body = req.body
  // 调用 res.send() , 向客户端响应处理的结果
  res.send({
    status: 0, // 0表示成功, 1 表示失败
    msg: 'POST 请求成功', // 状态描述
    data: body, // 需要响应给客户端的数据
  })
})

注意：在服务器中配置解析表单数据(urlencoded)的中间件

// 配置解析表单数据的中间件
app.use(express.urlencoded({ extended: false }))

（3）使用 CORS 中间件解决跨域问题

cors 本质上是由一系列 HTTP 响应头组成，这些 HTTP 响应头决定浏览器是否阻止前端 JS代码跨域获取资源。cors 主要在服务器端进行配置，客户端浏览器无需做任何配置，即可请求开启了CORS的接口。cors 在浏览器中有兼容性，只有支持 XMLHttpRequest Level2 的浏览器，才能正常访问开启了 cors 的服务器接口（例如 IE10+、Chrome4+、FireFox3.5+）。

cors 是 Express 的一个第三方中间件，通过安装配置 cors 中间件，可以很方便的解决跨域问题

使用步骤：

运行 npm i cors 安装中间件

使用 const cors = require('cors) 导入中间件

在路由之前调用 app.use(cors()) 配置中间件

(4) CORS 响应头 Access-Control-Allow-Origin

响应头中可以携带一个 Access-Control-Allow-Origin 字段，语法如下：

Access-Control-Allow-Origin: <origin> | *

其中，origin 参数的值指定了允许访问该资源的外域URL

例如，下面字段值将只允许莱字 http://baidu.com 的请求：

res.setHeader('Access-Control-Allow-Origin', 'http://baidu.com')
// * 表示允许来自任何域的请求
res.setHeader('Access-Control-Allow-Origin', '*')

（5）CORS 响应头 Access-Control-Allow-Headers

默认情况下，CORS 仅支持客户端向服务器发送如下的 9 个请求头：

Accept、Accept-Language、Content-Language、DPR、Downlink、Save-Data、Viewport-Wideth、Width、Content-Type

如果客户端向服务器发送了额外的请求头信息，则需要在服务器端，通过Access-Control-Allow-Headers对额外的请求头进行声明，否则这次请求会失败

// 允许客户端额外的向服务器发送 Content-Type 请求头和 X-Custom-Header 请求头
// 注意：多个请求头之间使用英文的逗号进行分割
res.setHeader('Access-Control-Allow-Headers', 'Content-Type, X-Custom-Header')

（6）CORS 响应头 Access-Control-Allow-Methods

默认情况下，CORS 仅支持客户端发起 GET、POST、HEAD请求

如果客户端希望通过 PUT、DELETE 等方式请求服务器的资源，则需要在服务器端，通过Access-Control-Allow-Methods 来指明实际请求所允许使用的 HTTP 方法。

示例：

// 只允许 post、get、delete、head 请求方法
res.setHeader('Access-Control-Allow-Methods', 'POST, GET, DELETE, HEAD')
// 允许所有的 HTTP 请求方法
res.setHeader('Access-Control-Allow-Methods', '*')

（7）JSONP 接口

概念：浏览器端通过 <script> 标签的 src 属性，请求服务器上的数据，同时，服务器返回一个函数的调用，这种请求数据的方式叫做 JSONP。

JSONP 不属于真正的 Ajax 请求，因为它没有使用 XMLHttpRequest 这个对象。

JSONP 仅支持 GET 请求。

实现 JSONP 接口步骤：

// 必须在配置 cors 中间件之前，配置 JSONP 的接口
app.get('/api/jsonp', (req, res) => {
  // 1. 获取客户端发送过来的回调函数的名称
  const funcName = req.query.callback
  // 2. 定义要发送到客户端的数据对象
  const data = { name: 'ww', age: 18}
  // 3. 拼接一个函数调用的字符串
  const scriptStr =  `${funcName}(${JSON.stringify(data)})`
  // 4. 把拼接的字符串，响应给客户端
  res.send(scriptStr)
})

使用 Ajax 发送请求：

      // 测试 jsonp 接口
      $('#jsonp').on('click', function() {
        $.ajax({
          type:'GET',
          url:'http://127.0.0.1:8080/api/jsonp',
          dataType: 'jsonp',
          success: function(res) {
            console.log('jsonp请求成功')
            console.log(res)
          }
        })
      })

孙先森428

关注

1
点赞
踩
6

收藏

觉得还不错? 一键收藏
0
评论
Express 入门

express 是一个创建web服务器的工具，它基于node中的 http 模块，但功能更加强大。1. express创建一个基本的服务器// 1. 导入 expressconst express = require('express')// 2. 创建 web 服务器const app = express()// 3. 启动 web 服务器app.listen(8080, () => { console.log('express server running at http:
复制链接

扫一扫