Express

  • 初识Express
    • 1.1 Express 简介
      • 1.1.1 什么是 express
      • 1.1.2 进一步理解 Express
      • 1.1.3 Express可以做什么
    • 1.2 Express 的基本使用
      • 1.2.1 安装 `npm i express@4.17.1`
      • 1.2.2 创建基本的 Web 服务器
      • 1.2.3 监听 GET 请求
      • 1.2.4 监听 POST 请求
      • 1.2.5 把内容响应给客户端
      • 1.2.6 获取 URL 中携带的查询参数
      • 1.2.7 获取 URL 中的动态参数
      • 完整代码
    • 1.3 托管静态资源
      • 1.3.1 express.static()
      • 1.3.2. 托管多个静态资源目录
      • 1.3.3. 挂载路径前缀
    • 1.4 nodemon
      • 1.4.1 为什么要使用 nodemon
      • 1.4.2. 安装 nodemon `npm install -g nodemon`
      • 1.4.3 使用 nodemon
  • 2.express 路由
    • 2.1 路由的概念
      • 2.1.1 什么是路由
      • 2.1.2 生活中的路由
      • 2.1.3 Express中的路由
      • 2.1.4 express 路由中的例子
      • 2.1.5 路由的匹配过程
    • 2.2 路由的使用
      • 2.2.1 最简单的用法
      • 2.2.2 模块化路由
      • 2.2.3 创建路由模块
      • 2.2.4 注册路由模块
      • 2.2.5 为路由模块添加前缀
  • 3. Express中间件
    • 3.1 中间件的概念
      • 3.1.1 什么是中间件
      • 3.1.2 生活中的例子
      • 3.1.3 Express 中间件的调用流程
      • 3.1.4 Express 中间件的格式
      • 3.1.5 next 函数的作用
    • 3.2 Express 中间件的初体验
      • 3.2.1 定义中间件函数
      • 3.2.2 全局生效的中间件
      • 3.3.3 定义全局生效中间件的简化形式
      • 3.3.4 中间件的作用
      • 3.3.5 定义`多个`全局中间件
      • 3.3.6 局部生效的中间件
      • 3.3.7 定义多个局部中间件
      • 3.3.8 了解中间件的5个使用注意事项
      • 3.3.9 中间件的分类
    • 3.3 自定义中间件
      • 3.3.1定义中间件
      • 3.3.2 监听 req 的 data 事件
      • 3.3.3 监听 req 的 end 事件
      • 3.3.4 使用 querystring 模块解析请求体数据
      • 3.3.5 将解析出来的数据对象挂载为 req.body
      • 3.3.6 将自定义中间件封装为模块
      • 3.3.7 (未拆分)自定义中间件封装为模块的完整代码
      • 3.3.8 (拆分)对自定义的中间件进行模块化的拆分
  • 4. 使用 Express 接口
    • 4.1 创建基本的服务器
    • 4.2 创建API 路由模块
    • 4.3 编写 GET 接口
    • 4.4 编写 POST 接口
    • 4.5 CORS 跨域资源共享
      • 4.5.1 接口的跨域问题
      • 4.5.2 使用CORS中间件解决跨域问题
      • 4.5.3 什么是CORS
      • 4.5.4 CORS 的注意事项
      • 4.5.5 CORS 响应头部 - Access-Control-Allow-`Origin`
      • 4.5.6. CORS 响应头部 - Access-Control-Allow-`Headers`
      • 4.5.7 CORS 响应头部 - Access-Control-Allow-`Methods`
      • 4.5.8 CORS请求的分类
      • 4.5.9 简单请求和预检请求的区别
    • 4.6 JSON 接口
      • 4.6.1 回顾 JSONP 的概念与特点
      • 4.6.2 创建 JSONP 接口的注意事项
      • 4.6.3 实现 JSONP 接口的步骤
    • (完整代码)使用express写接口
      • 4.6.4 在网页中使用 jQuery 发起 JSONP 请求

初识Express

1.1 Express 简介

1.1.1 什么是 express

  • 官方给出的概念:Express 是基于 Node.js 平台快速、开放、极简Web 开发框架
  • 通俗的理解:Express 的作用和 Node.js 内置的 http 模块类似,是专门用来创建 Web 服务器的
  • Express 的本质:就是一个 npm 上的第三方包,提供了快速创建 Web 服务器的便捷方法。

Express 的中文官网: http://www.expressjs.com.cn/

1.1.2 进一步理解 Express

思考:不使用 Express 能否创建 Web 服务器?
答案:能,使用 Node.js 提供的原生 http 模块即可。

思考:既生瑜何生亮(有了 http 内置模块,为什么还要用 Express)?
答案:http 内置模块用起来很复杂,开发效率低;Express 是基于内置的 http 模块进一步封装出来的,能够极大的提高开发效率。

思考:http 内置模块与 Express 是什么关系?
答案:类似于浏览器中 Web API 和 jQuery 的关系。后者是基于前者进一步封装出来的。

1.1.3 Express可以做什么

对于前端程序员来说,最常见的两种服务器分别是:

  • Web服务器网站:专门对外提供 Web 网页资源的服务器。
  • API接口服务器:专门对外提供 API 接口的服务器。

使用Express,可以方便、快速的创建 Web服务器 或 API接口服务器。

1.2 Express 的基本使用

1.2.1 安装 npm i express@4.17.1

在项目所处的目录中,运行如下的终端命令,即可将 express 安装到项目中去使用:

npm i express@4.17.1

1.2.2 创建基本的 Web 服务器

// 1.导入 express
const express = require('express')
//2.创建 web 服务器
const app = express()// 3.调用app.listen(端口号,启动成功之后的回调函数),启动服务器
app.listen(80,()=>{console.log('express server running at http://127.0.0.1')
}

1.2.3 监听 GET 请求

通过 app.get() 方法,可以监听客户端的 GET 请求,具体的语法格式如下:

 // 参数1:客户端请求的 URL 地址// 参数2: 请求对应的处理函数//      req:请求对象(包含了与请求相关的属性与方法)//      res:响应对象(包含了与响应相关的属性与方法)app.get('请求URL',function(req,res){/*处理函数*/})

1.2.4 监听 POST 请求

通过 app.post() 方法,可以监听客户端的 POST 请求,具体的语法格式如下:

 // 参数1:客户端请求的 URL 地址// 参数2: 请求对应的处理函数//      req:请求对象(包含了与请求相关的属性与方法)//      res:响应对象(包含了与响应相关的属性与方法)app.post('请求URL',function(req,res){/*处理函数*/})

1.2.5 把内容响应给客户端

通过res.send() 方法,可以把处理好的内容,发送给客户端

app.get('/user',(res,req)=>{// 向客户端发送 JSON 对象
res.send({name: 'll',age: 19,gender: '女'})
})app.post('/user',(req,res) =>{// 向客户端发送文本内容
// 调用express提供的 res.send()方法,向客户端响应一个文本字符串
res.send('请求成功!')
})

1.2.6 获取 URL 中携带的查询参数

通过 req.query 对象,可以访问到客户端通过查询字符串的形式,发送到服务器的参数:

//获取URL中携带的查询参数
app.get('/', (req, res) => {//res.query 默认是一个空对象//客户端使用 ?name=ll&age=19 这种查询字符串形式,发送到客户端的参数//可以使用 res.query 对象访问到//res.query.name  res.query.ageconsole.log(req.query)res.send(req.query)})

1.2.7 获取 URL 中的动态参数

通过 req.params 对象,可以访问到 URL 中,通过 : 匹配到的动态参数

    //注意:这里的 id 是一个动态的参数
app.get('/user/:id/:name', (req, res) => {//req.params 是动态匹配到的URL参数,默认也是一个空对象// 里面存放着通过 : 动态匹配到的参数值console.log(req.params)res.send(req.params)})

完整代码

//1.导入express
const express = require('express')//2.创建web服务器
const app = express()//4.监听客户端的 GET 和 POST 请求并向客户端响应具体的内容
app.get('/user', (req, res) => {//调用express 提供的  res.send()方法,向客户端响应一个 JSON方法res.send({name: 'zs',age: 20,gender: '男'})
})
app.post('/user', (req, res) => {//调用express提供的 res.send()方法,向客户端响应一个文本字符串res.send('请求成功')
})//获取URL中携带的查询参数
app.get('/', (req, res) => {//res.query 默认是一个空对象//客户端使用 ?name=zs&age=20 这种查询字符串形式,发送到客户端的参数//可以使用 res.query 对象访问到//res.query.name  res.query.ageconsole.log(req.query)res.send(req.query)})//注意:这里的 id 是一个动态的参数
app.get('/user/:id/:name', (req, res) => {//req.params 是动态匹配到的URL参数,默认也是一个空对象console.log(req.params)res.send(req.params)})//3.启动express
app.listen(80, () => {console.log('express server running at http://127.0.0.1')
})

1.3 托管静态资源

1.3.1 express.static()

通过 express.static()可以非常方便地创建一个静态资源服务器。
例如,通过如下代码就可以将 public 目录下的图片CSS 文件JavaScript 文件对外开放访问了

app.use(express.static('public'))

注意:Express 在指定的静态目录中查找文件,并对外提供资源的访问路径。
因此,存放静态文件的目录名不会出现在 URL 中

1.3.2. 托管多个静态资源目录

如果要托管多个静态资源目录,要多次调用 express.static 函数:

app.use(express.static('public'))
app.use(express.static('files'))

访问静态资源文件时,express.static() 函数会根据目录的查找顺序查找所需的文件。

1.3.3. 挂载路径前缀

在托管的静态资源访问路径之前,需要挂载路径前缀,则可以使用如下的方式:

app.use('/public',express.static('public'))

然后就可以通过带有 /public 前缀地址来访问 public 目录中的文件:
http://localhost:3000/public/images/kitten.jpg
http://localhost:3000/public/css/style.css

1.4 nodemon

1.4.1 为什么要使用 nodemon

  • 在编写调试 Node.js 项目的时候,如果修改了项目的代码,则需要频繁的手动 close 掉,然后再重新启动,非常繁琐。
  • 我们可以使用 nodemon(https://www.npmjs.com/package/nodemon) 这个工具,它能够监听项目文件的变动,当代码被修改后,nodemon 会自动帮我们重启项目,极大方便了开发和调试。

1.4.2. 安装 nodemon npm install -g nodemon

在终端中,运行如下命令,即可将 nodemon 安装为全局可用的工具

npm install -g nodemon

1.4.3 使用 nodemon

  • 基于 Node.js 编写了一个网站应用的时候,运行 node app.js 命令,来启动项目
    这样做的坏处是:代码被修改之后,需要手动重启项目。
  • 将 node 命令替换为 nodemon 命令,使用 nodemon app.js 来启动项目。
    这样做的好处是:代码被修改之后,会被 nodemon 监听到,从而实现自动重启项目的效果
node app.js
// 将上面的终端命令,替换为下面的终端命令,即可实现自动重启项目的效果
nodemon app.js

2.express 路由

2.1 路由的概念

2.1.1 什么是路由

路由就是映射关系

2.1.2 生活中的路由

拨打 10086 查询服务的时候,按键1->业务查询,按键2->手机充值等等
在这里,路由是 按键服务 之间的映射关系

2.1.3 Express中的路由

在Express中,路由指的是 客户端的请求 与 服务器处理函数之间 的映射关系。
Express 中的路由分 3 部分组成,分别是请求的类型请求的URL地址处理函数 , 格式如下:

 app.method(path,handler)

2.1.4 express 路由中的例子

//挂载路由 // 匹配 GET 请求,且请求 URL 为 /
app.get('/', (req, res) => {res.send('hello world!')
})
// 匹配 POST 请求,且请求 URL 为 /
app.post('/', (req, res) => {res.send('express request')})

2.1.5 路由的匹配过程

  • 每当一个请求到达服务器之后,需要先经过路由的匹配,只要匹配成功之后,才会调用对应的处理函数。
  • 在匹配时,会按照路由的顺序进行匹配,如果请求类型请求的 URL 同时匹配成功,则 Express 会将这次请求,转交给对应的 function 函数进行处理。

路由匹配的注意点:

①按照定义的先后顺序进行匹配

请求类型请求的URL同时匹配成功,才会调用对应的处理函数

2.2 路由的使用

2.2.1 最简单的用法

在Express 中使用路由最简单的方式就是把路由挂载到 app 上,示例代码如下所示:


const express = require('express')
//创建web服务器
const app = express()//挂载路由
app.get('/', (req, res) => {res.send('hello world!')
})app.post('/', (req, res) => {res.send('Post request')})//启动web服务器
app.listen(80, () => {console.log('express server running at http://127.0.0.1')
})

2.2.2 模块化路由

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

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

  • ① 创建路由模块对应的 .js 文件
  • ② 调用 express.Router() 函数创建路由对象
  • ③ 向路由对象上挂载具体的路由
  • ④ 使用 module.exports 向外共享路由对象
  • ⑤ 使用 app.use() 函数注册路由模块

2.2.3 创建路由模块

const express = require('express')  // 1.导入express
const router = express.Router()     // 2.创建路由对象router.get('./user/list',function(req,res){ // 3. 挂载获取用户列表的路由
res.send('Get user list')
})
router.post('/user/add',function(req,res) { // 4.挂载添加用户的路由
res.send('Add new user')
})
modules.exports = router    // 5.向外导出路由对象

2.2.4 注册路由模块

// 1. 导入路由模块
const userRouter = require('./router/user.js')// 2. 使用 app.use() 注册路由模块
app.use(userRouter)

2.2.5 为路由模块添加前缀

路由模块添加前缀的方式 类似于 托管静态资源时,为静态资源统一挂载访问前缀一样

// 1. 导入路由模块
const userRouter = require('./router/user.js')// 2. 使用 app.use() 注册路由模块,并添加统一的访问前缀 /api
app.use('/api',userRouter)

3. Express中间件

3.1 中间件的概念

3.1.1 什么是中间件

中间价(Middleware), 特指业务流程中间处理环节

3.1.2 生活中的例子

3.1.3 Express 中间件的调用流程

当一个请求到达 Express 的服务器之后,可以连续调用多个中间件,从而对这次请求进行预处理

3.1.4 Express 中间件的格式

Express 的中间件,本质上就是一个 function 处理函数,Express 中间件的格式如下:


注意:中间件函数的形参列表中,必须包含 next 参数。而路由处理函数中只包含 req 和 res。

3.1.5 next 函数的作用

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

3.2 Express 中间件的初体验

3.2.1 定义中间件函数

可以通过如下的方式,定义一个最简单的中间件函数:

// 常量mv 所指向的,就是一个中间件函数
const mv = function(req,res,next){console.log('这是一个最简单的中间件函数!')
// 注意: 在当前中间件的业务处理完毕之后,必须调用next()这个函数
// 表示把流转关系转交给下一个中间件或路由
next()
}

3.2.2 全局生效的中间件

客户端发起的任何请求,到达服务端之后,都会触发这个中间件,叫做全局生效的中间件。
通过调用app.use(中间件函数),即可定义一个全局生效的中间件,示例代码如下:

//定义一个最简单的中间件函数
const mw = function(req, res, next) {console.log('这是最简单的中间件函数')//把流转关系,转交给下一个中间件或路由next()}//将 mw 注册为全局生效的中间件
app.use(mw)

3.3.3 定义全局生效中间件的简化形式

//全局生效的中间价app.use(function(req,res,next){console.log('这是最简单的中间件函数')next()})

3.3.4 中间件的作用

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

3.3.5 定义多个全局中间件

可以使用app.use() 连续定义多个 全局中间件。客户端请求到达服务器之后,会按照中间件定义的先后顺序依次调用,示例代码如下:

    //定义第一个中间件
app.use((req, res, next) => {console.log('调用了第一个中间件')next()})//定义第二个中间件
app.use((req, res, next) => {console.log('调用了第二个中间件')next()})//定义一个路由
app.get('/user', (req, res) => { //请求这个路由,会依次触发上述两个全局中间件res.send('Home page.')
})

3.3.6 局部生效的中间件

不使用app.use()定义的中间件,叫做局部生效的中间件,示例代码如下:

//定义一个局部中间件函数
const mw1 = (req, res, next) => {console.log('这是一个局部中间件函数')next()
}
//mw1 只会在当前路由生效  这种用法属于“局部生效的中间件”
app.get('/', mw1, (req, res) => {res.send('home page.')
})
//  mv1中间件不会影响下面的这个路由
app.get('/user', (req, res) => {res.send('user page.')
})

3.3.7 定义多个局部中间件

可以在路由中,通过两种等价的方式,使用多个局部中间件

// 以下两种写法是“完全等价”的,根据自己的喜好,任意选择任意一种方式使用
app.get('/',mw1,mw2,(req,res)=>{res.send('Home page')})
app.get('/',[mw1,mw2],(req,res)=>{res.send('Home page')})

3.3.8 了解中间件的5个使用注意事项

  • ① 一定要在路由之前注册中间件
  • ② 客户端发送过来的请求,可以连续调用多个中间件进行处理
  • ③ 执行完中间的业务代码之后,不要忘记调用 next() 函数
  • ④ 为了防止代码逻辑混乱,调用 next() 函数后不要再写额外的代码
  • ⑤ 连续调用多个中间件时,多个中间件之间,共享 req 和 res 对象

3.3.9 中间件的分类

Express 官方把常见的中间件用法,分成了 5 大类,分别是:

  • ① 应用级别的中间件
    通过 app.use()app.get()app.post()绑定到 app 实例上的中间件,叫做应用级别的中间件,代码示例如下:
// 引用级别的中间件(全局中间件)
app.use((req,res,next)=>{next()
})//应用级别的中间件(局部中间件)
app.get('/',mw1,(req,res)=>{res.send('Home page')
})
  • ② 路由级别的中间件
    绑定到 express.Router() 实例上的中间件,叫做路由级别的中间件。它的用法和应用级别中间件没有任何区别。只不过,应用级别中间件是绑定到 app 实例上,路由级别中间件绑定到 router 实例上,代码示例:
const app = express()
const 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(req,res) {           // 1. 路由
throw new Error('服务器内部发生了错误!') //  1.1 抛出一个自定义的错误
res.send('Home page.')
})
app.use(function(err,req,res,next) {  // 2. 错误级别的中间件
console.log('发生了错误:' + err.message)   // 2.1 在服务器打印错误信息
res.send('Error!' + err.message)           // 2.2 向客户端响应错误相关的内容
})

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

  • ④ Express 内置的中间件

    • 自 Express 4.16.0 版本开始,Express 内置了 3 个常用的中间件,极大的提高了 Express 项目的开发效率和体验:
    • express.static 快速托管静态资源的内置中间件,例如: HTML 文件、图片、CSS 样式等(无兼容性)
    • express.json 解析 JSON 格式的请求体数据(有兼容性,仅在 4.16.0+ 版本中可用)
      • express.urlencoded 解析 URL-encoded 格式的请求体数据(有兼容性,仅在 4.16.0+ 版本中可用)
// 配置解析 application/json 格式数据的内置中间件
app.use(express.json())
//配置解析 application/x-www-form-urlencoded 格式数据的内置中间件
app.use()express.urlencoded({ extended: false })
  • ⑤ 第三方的中间件

由第三方开发出来的中间件,叫做第三方中间。在项目中,大家可以按需下载配置第三方中间件,从而提高项目的开发效率。
例如:在 express@4.16.0 之前的版本中,经常使用 body-parser 这个第三方中间件,来解析请求体数据。使用步骤如下:
① 运行 npm install body-parser 安装中间件
② 使用 require 导入中间件
③ 调用 app.use() 注册并使用中间件

注意:Express 内置的 express.urlencoded 中间件,就是基于 body-parser 这个第三方中间件进一步封装出来的。

3.3 自定义中间件

手动模拟一个类似于 express.urlencoded 这样的中间件,来解析 POST 提交到服务器的表单数据

实现步骤:

3.3.1定义中间件

使用 app.use() 来定义全局生效的中间件,代码如下:

app.use(function(req,res,next){// 中间件的业务逻辑
})
在这里插入代码片

3.3.2 监听 req 的 data 事件

  • 在中间件中,需要监听 req 对象的 data 事件,来获取客户端发送到服务器的数据。
  • 如果数据量比较大,无法一次性发送完毕,则客户端会把数据切割后,分批发送到服务器。所以 data 事件可能会触发多次,每一次触发 data 事件时,获取到数据只是完整数据的一部分,需要手动对接收到的数据进行拼接。
// 定义变量,用来存储客户端发送过来的请求体数据
let str = ''
// 监听 req 对象的 data 事件(客户端发送过来的新的请求体数据)
req.on('data',(chunk)=>{//拼接请求体数据,隐式转换为字符串
str +=chunk
})

3.3.3 监听 req 的 end 事件

当请求体数据接收完毕之后,会自动触发 req 的 end 事件。
因此,我们可以在 req 的 end 事件中,拿到并处理完整的请求体数据。示例代码如下:

// 监听 req 对象的 end 事件(请求体发送完毕之后自动触发)
req.on('end',()=>{// 打印完整的请求体数据
console.log(str)
//TODO :把字符串格式的请求体数据,解析成对象格式
})

3.3.4 使用 querystring 模块解析请求体数据

Node.js 内置了一个 querystring 模块,专门用来处理查询字符串。通过这个模块提供的 parse() 函数,可以轻松把查询字符串,解析成对象的格式。示例代码如下:

// 导入处理 querystring 的 Node.js 内置魔魁啊
const qs = require('querystring')// 调用 qs.parse() 方法,把查询字符串解析为对象
const body = qs.parse(str)

3.3.5 将解析出来的数据对象挂载为 req.body

上游中间件下游中间件及路由之间,共享同一份 req 和 res。因此,我们可以将解析出来的数据,挂载为 req 的自定义属性,命名为 req.body,供下游使用。示例代码如下:

req.on('end',()=>{const body = qs.parse(str) //调用 qs.parse()方法,把查询字符串解析为对象
req.body = body            // 将解析出来的请求体对象,挂载为 req.body 属性
next()                    // 一定要调用 next() 函数,执行后续的业务逻辑
})
})

3.3.6 将自定义中间件封装为模块

为了优化代码的结构,我们可以把自定义的中间件函数,封装为独立的模块,示例代码如下:

// 导入 Node.js 内置的 querystring 模块
const qs = require('querystring')const bodyParser = (req, res, next) => {// 定义中间件具体的业务逻辑// 1. 定义一个 str 字符串,专门用来存储客户端发送过来的请求体数据let str = ''// 2. 监听 req 的 data 事件req.on('data', (chunk) => {str += chunk})// 3. 监听 req 的 end 事件req.on('end', () => {// 在 str 中存放的是完整的请求体数据// console.log(str)// TODO: 把字符串格式的请求体数据,解析成对象格式const body = qs.parse(str)req.body = bodynext()})
}
module.exports = bodyParser

3.3.7 (未拆分)自定义中间件封装为模块的完整代码

  // 导入 express 模块const express = require('express')// 创建 express 服务器实例const app = express()// 导入 node.js 内置的 querystring 模块const qs = require('querystring')//   这是解析表单数据的中间件app.use((req, res, next) => {//定义中间件具体的逻辑业务//2.定义变量 用来存储客户端发送过来的请求体数据let str = ''//2.监听req对象的data事件 (客户端发送过来的请求体数据)req.on('data', (chunk) => {//拼接请求体数据 隐式转换为字符串str += chunk})//3.监听 res 的end事件req.on('end', () => {// 在 str 中存放的是完整的请求体是数据//   console.log(str)const body = qs.parse(str)//把字符串格式的请求体数据 解析成对象格式//   console.log(body)req.body = bodynext()})})app.post('/user', (req, res) => {//   res.send('ok')res.send(req.body)})//调用app.listen()方法,指定端口号并启动web服务器app.listen(80, () => {console.log('http://127.0.0.1')})

3.3.8 (拆分)对自定义的中间件进行模块化的拆分


// 13-对自定义的中间件进行模块化的拆分.js//导入 express 模块
const express = require('express')
// 创建 express 的服务器实例
const app = express()//  1.导入自己封装的中间件函数
const customBodyParser = require('./14-custom-body-parser')
//  2.将自定义的中间件函数注册为全局可用的中间件
app.use(customBodyParser)app.post('/user', (req, res) => {//   res.send('ok')res.send(req.body)
})//调用app.listen()方法,指定端口号并启动web服务器
app.listen(80, () => {console.log('http://127.0.0.1')
})
// 14-custom-body-parse.js// 导入 node.js 内置的 querystring 模块
const qs = require('querystring')
const bodyParser = (req, res, next) => {//定义中间件具体的逻辑业务//2.定义变量 用来存储客户端发送过来的请求体数据let str = ''//2.监听req对象的data事件 (客户端发送过来的请求体数据)req.on('data', (chunk) => {//拼接请求体数据 隐式转换为字符串str += chunk})//3.监听 res 的end事件req.on('end', () => {// 在 str 中存放的是完整的请求体是数据//   console.log(str)const body = qs.parse(str)//把字符串格式的请求体数据 解析成对象格式//   console.log(body)req.body = bodynext()})
}//把 bodyParse这个模块导出出去
module.exports = bodyParser

4. 使用 Express 接口

4.1 创建基本的服务器

// 导入 express 模块
const express = require('express')
// 创建 express 的服务器实例
const app = express()// write your code here// 调用app.listen() 方法,指定端口号并启动web服务器
app.listen(80,function(){console.log('Express server running at http://127.0.0.1')
})

4.2 创建API 路由模块

//apiRouter.js [路由模块]
const express = require('express')
const apiRouter = express.Router()//bind your router here...module.exports = apiRouter// ------------------------------// app.js [导入并注册路由模块]
const apiRouter = require('./apiRouter.js')
app.use('./api',apiRouter)

4.3 编写 GET 接口

//在这里挂载对应的路由
apiRouter.get('/get', (req, res) => {// 1.获取到客户端通过查询字符串,发送到服务器的数据const query = req.query
// 2.调用res.send()方法,把数据响应给客户端res.send({status: 0,              //状态,0表示成功,1 表示 失败msg: 'GET请求失败!',    // 状态描述data: query            // 需要响应给客户端的具体数据})})

4.4 编写 POST 接口

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

注意:如果要获取 URL-encoded 格式的请求体数据,必须配置中间件 app.use(express.urlencoded({ extended: false }))

4.5 CORS 跨域资源共享

4.5.1 接口的跨域问题

刚才编写的 GET 和 POST 接口,存在着一个很严重的问题,不支持跨域请求

解决接口跨域问题的方案主要有两种:

CORS (主流的解决方案,推荐使用)
JSON(有缺陷的请求方案,只支持 GET 请求)

4.5.2 使用CORS中间件解决跨域问题

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

使用步骤分为如下 3 步:
① 运行 npm install cors 安装中间件
② 使用 const cors = require('cors') 导入中间件
③ 在路由之前调用 app.use(cors()) 配置中间件

4.5.3 什么是CORS

  • CORS(Cross-Origin Resource Sharing,跨域资源共享)由一系列的 HTT响应头 组成,这些HTTP响应头决定是否阻止前端JS代码跨域获取资源
  • 浏览器的同源安全策略默认会组织网页“跨域” 获取资源。但如果接口服务器配置了CORS相关的HTTP响应头,就可以解除浏览器的跨域访问限制

4.5.4 CORS 的注意事项

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

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

响应头部中可以携带一个 Access-Control-Allow-Origin 字段,其语法如下:

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

其中,origin 参数的值指定了允许访问该资源的外域 URL
例如,下面的字段值将只允许来自 http://itcast.cn 的请求:

res.setHeader('Access-Control-Allow-Origin','http://itcast.cn')

如果指定了 Access-Control-Allow-Origin 字段的值为通配符 *,表示允许来自任何域的请求,示例代码如下:

res.setHeader('Access-Control-Allow-Origin','*')

4.5.6. CORS 响应头部 - Access-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 对额外的请求头进行声明,否则这次请求会失败!

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

4.5.7 CORS 响应头部 - Access-Control-Allow-Methods

  • 默认情况下,CORS 仅支持客户端发起 GET、POST、HEAD 请求。
  • 如果客户端希望通过 PUT、DELETE 等方式请求服务器的资源,则需要在服务器端,通过 Access-Control-Alow-Methods来指明实际请求所允许使用的 HTTP 方法。
//默认情况下,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','*')

4.5.8 CORS请求的分类

客户端在请求 CORS接口时,根据请求方式请求头的不同,可以将 CORS 请求分为两大类,分别是:
① 简单请求

满足简单请求的两大条件:

  • 请求方式: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 请求称为“预检请求”。服务器成功响应预检请求后,才会发送真正的请求,并且携带真实数据。

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

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

4.6 JSON 接口

4.6.1 回顾 JSONP 的概念与特点

概念:浏览器端通过 < script> 标签的 src 属性,请求服务器上的数据,同时,服务器返回一个函数的调用。这种请求数据的方式叫做 JSONP。
特点
① JSONP 不属于真正的 Ajax 请求,因为它没有使用 XMLHttpRequest 这个对象。
② JSONP 仅支持 GET 请求,不支持 POST、PUT、DELETE 等请求。

4.6.2 创建 JSONP 接口的注意事项

如果项目中已经配置了 CORS 跨域资源共享,为了防止冲突必须在配置 CORS 中间件之前声明 JSONP 的接口。否则 JSONP 接口会被处理成开启了 CORS 的接口。示例代码如下:

// 优先创建 JSON 接口【这个接口不会处理成 CORS 接口】
app.get('/api/jsonp',(req,res)=>{})// 再配置CORS中间件【后续的所有接口,都会被处理成 CORS 接口】
app.use(cors())// 这是一个开启了 CORS 的接口
app.get('./api/get',(req,res)=>{req,res})

4.6.3 实现 JSONP 接口的步骤

  • 获取客户端发送过来的回调函数的名字
  • 得到要通过 JSONP 形式发送给客户端的数据
  • 根据前两步得到的数据,拼接出一个函数调用的字符串
  • 把上一步拼接得到的字符串,响应给客户端的
app.get('/api/jsonp',(req,res)=>{// 1.获取客户端发送过来的回调函数的名字
const funcName = req.query.callback
// 2.得到要通过 JSONP 形式发送给客户端的数据
const data = {name:'ll',age: 19}
// 3.根据前两步得到的数据。拼接出一个函数调用的字符串
const scriptStr = `${funcName}(${JSON.stringfy(data)})`
// 4. 把上一步拼接得到的字符串 ,响应给客户端的<script> 标签进行解析执行
res.send(scriptStr)
})

(完整代码)使用express写接口

15- 使用express 写接口.js

// 15- 使用express 写接口.js
// 导入 express
const express = require('express')
// 创建服务器实例
const app = express()// 配置解析表单数据的中间件
app.use(express.urlencoded({ extended: false }))// 必须在配置 cors 中间件之前,配置 JSONP 的接口
app.get('/api/jsonp', (req, res) => {// TODO: 定义 JSONP 接口具体的实现过程// 1. 得到函数的名称const funcName = req.query.callback// 2. 定义要发送到客户端的数据对象const data = { name: 'll', age: 19 }// 3. 拼接出一个函数的调用const scriptStr = `${funcName}(${JSON.stringify(data)})`// 4. 把拼接的字符串,响应给客户端res.send(scriptStr)
})// 一定要在路由之前,配置 cors 这个中间件,从而解决接口跨域的问题
const cors = require('cors')
app.use(cors())// 导入路由模块
const router = require('./16.apiRouter')
// 把路由模块,注册到 app 上
app.use('/api', router)// 启动服务器
app.listen(80, () => {console.log('express server running at http://127.0.0.1')
})

16-apiRouter.js

// 16-apiRouter.js
// 导入 express 模块
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, // 需要响应给客户端的数据})
})// 定义 POST 接口
router.post('/post', (req, res) => {// 通过 req.body 获取请求体中包含的 url-encoded 格式的数据const body = req.body// 调用 res.send() 方法,向客户端响应结果res.send({status: 0,msg: 'POST 请求成功!',data: body,})
})// 定义 DELETE 接口
router.delete('/delete', (req, res) => {res.send({status: 0,msg: 'DELETE请求成功',})
})module.exports = router

4.6.4 在网页中使用 jQuery 发起 JSONP 请求

调用 $.ajax() 函数,提供 JSONP 的配置选项,从而发起 JSONP 请求,示例代码如下:

<button id="btnJSONP">JSONP</button>
<script>$(function() {$('#btnJSONP').on('click', function () {$.ajax({type: 'GET',url: 'http://127.0.0.1/api/jsonp',dataType: 'jsonp',success: function (res) {console.log(res)}})})})
</script>

Node 学习 | Day03 express (初识Express、Express 路由、Express 中间件、使用 Express 写接口)相关推荐

  1. express 路由中间件_Express通过示例进行解释-安装,路由,中间件等

    express 路由中间件 表达 (Express) When it comes to build web applications using Node.js, creating a server ...

  2. Node.js—Express、Express 路由 、Express 中间件、使用 Express 写接口

    目标: 能够使用 express.static() 快速托管静态资源 能够使用 express 路由精简项目结构 能够使用常见的 express 中间件 能够使用 express 创建API接口 能够 ...

  3. node.js服务端笔记文档学会写接口,学习分类:path、包、模块化、fs、express、中间件、jwt、开发模式、cors。

    node.js 学习笔记 node.js服务端笔记文档学会写接口,path.包.模块化.fs.express.中间件.JWT.开发模式.cors. gitee:代码接口笔记 1什么是node.js n ...

  4. KOA2路由koa-router实现类似express router的文件结构设计---KOA入门学习

    说明 用过express的都知道express入口文件只有一个app.js,里面写好了很多路由配置,通常情况下,会有一个routes文件夹,用来对对应路由规则的数据进行处理,响应请求,而不是将所有的功 ...

  5. 使用Express在Node.js中实现非常基本的路由

    by Pau Pavón 通过保罗·帕文(PauPavón) 使用Express在Node.js中实现非常基本的路由 (Really, really basic routing in Node.js ...

  6. 【Node学习】—Express框架的安装

    [Node学习]-Express框架的安装 安装的步骤 创建一个目录,然后进入此目录并将其作为当前工作目录. 通过 npm init 命令为你的应用创建一个 package.json 文件. 目录下安 ...

  7. node.js学习笔记3 express基本使用、托管静态资源、express中间件

    内容 1. 什么是express 1.1 http模块和express的关系 2. express能做什么 3. express的基本使用 3.1 安装 3.2 创建最基本的web服务器 3.3 监听 ...

  8. Express请求处理-构建模块化路由

    场景 Node的Web应用框架Express的简介与搭建HelloWorld: Node的Web应用框架Express的简介与搭建HelloWorld_霸道流氓气质的博客-CSDN博客 注: 虽然可以 ...

  9. nodejs开发 过程中express路由与中间件的理解 - pyj063 - 博客园

    nodejs开发 过程中express路由与中间件的理解 nodejs开发 express路由与中间件 路由 通常HTTP URL的格式是这样的: http://host[:port][path] h ...

最新文章

  1. 关于logits and labels must have the same first dimension, got logits shape [128,10] and labels shape报错
  2. hdu3400 两重三分
  3. springboot+vue用websocket消息推送和监听端口
  4. 百度为什么发现不了旗下网站的恶意代码?
  5. LinearLayout和RelativeLayout 区别
  6. bbb mmc_blk_probe 分析
  7. [有限元]桁架结构中杆单元的节点序号和单元序号的确定依据
  8. 德鲁伊 oltp oltp_内存中OLTP系列–简介
  9. 每天学一点Flash(55) 认识类的结构
  10. linux系统下如何设置和修改文件和文件夹的读、写、执行权限
  11. 【每日算法Day 101】字节跳动 AI Lab 精选面试编程题
  12. 8.6 归纳式迁移学习
  13. 微信抢号软件_快来抢微信靓号!微信小商店正式上线
  14. 支持向量回归(多核函数)
  15. virtualbox不能桥接的解决办法
  16. Android 实现图片闪烁效果
  17. gcc用-O0优化无问题,-O3优化时程序崩溃的问题
  18. Java之Snake历程
  19. 开源办公开发平台丨Mysql5.7两套四节点主从结构环境搭建教程(一)
  20. 20个免费的webservice接口(测试人员必须知道)

热门文章

  1. 零基础如何学习自动化测试
  2. nvme 驱动详解[转]
  3. 发表16篇Nature、14篇Science!这位顶尖学者告诉你论文十大诀窍
  4. 【一周头条盘点】中国软件网(2017.12.18~2017.12.22)
  5. Python 三人斗地主手牌生成
  6. 分化成功的标志及特异性神经递质的检测
  7. DTC品牌如何冷启动?
  8. 微信属于计算机操作系统吗,一款国产操作系统的微信电脑版使用体验
  9. Python ❀ 插入排序
  10. 工厂模式--简单工厂模式--抽象工厂模式