Node.js笔记--Day4

//匹配 GET 请求，且请求URL为 / 
app.get('/',fungtion (req,res) {
    res.send('Hello wor1d!')
})
//匹配POST请求，且请求 URL为 / 
app.post('/', function (req,res) {
    res.send('Got a POST request')
})

路由的匹配过程

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

        路由匹配的注意点：

                按照定义的先后顺序进行匹配
                请求类型和请求的URL同时匹配成功,才会调用对应的处理函数

1.2 路由的使用

最简单的用法

在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('Post Request.')})
//启动web服务器
app.listen(80,() => { console.log('server running at http://127.0.0.1')})

模块化路由

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

将路由抽离为单独模块的步骤如下:
1.创建路由模块对应的.js 文件
2.调用express.Router()函数创建路由对象

3.向路由对象上挂载具体的路由
4.使用module.exports向外共享路由对象

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

创建路由模块

var express = require('express')             // 1，导入express
var 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.')
})
module.exports = router                      // 5．向外导出路由对象

注册路由模块

//1. 导入路由模块
const userRouter = require('./router/user.js')

//2. 使用 app.use() 注册路由模块
app.use(userRouter)

为路由模块添加前缀

类似于托管静态资源时，为静态资源统一挂载访问前缀一样，路由模块添加前缀的方式也非常简单:

//1．导入路由模块
const userRouter = require('./router/user.js')

// 2．使用 app.use() 注册路由模块，并添加统一的访问前缀  /api
app.use('/api',userRouter)

2.【Express 中间件】

2.1 中间件的概念

什么是中间件

中间件(Middleware ) ，特指业务流程的中间处理环节。

现实生活中的例子

在处理污水的时候，一般都要经过三个处理环节，从而保证处理过后的废水，达到排放标准。

处理污水的这三个中间处理环节，就可以叫做中间件。

Express 中间件的调用流程

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

Express中间件的格式

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

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

next 函数的作用

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

2.2 Express 中间件的初体验

定义中间函数

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

全局生效的中间件

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

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

//常量 mw 所指向的，就是一个中间件函数
const mw = function (req,res,next) {
    console.log('这是一个最简单的中间件函教')
    next()
}
 
//注册为全局生效的中间件 
app.use(mw)

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

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

中间件的作用

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

定义多个全局中间件

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


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

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

//定义一个路由
app.get('/user', (req, res) => {
    res.send('User page.')
})

局部生效的中间件

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


//1.定义中间件函数
const mw1 = (req, res, next) => {
    console.log('调用了局部生效的中间件')
    next()
}

// 2．创建路由 mw 1这个中间件只在"当前路由中生效"，这种用法属于"局部生效的中间件"
app.get('/', mw1, (req, res) => {
    res.send('Home page.')
})

//3.mw1  这个中间件不会影响向下面这个路由
app.get('/user', (req, res) => {
    res.send('User page.')
})

定义多个局部中间件

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

//方法一
app.get('/',mw1, mw2, (req, res) => {
     res.send('Home page.')
})
//方法二
app.get('/', [mw1, mw2], (req, res) => {
    res.send('Home page.')
})

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

1.一定要在路由之前注册中间件
2.客户端发送过来的请求，可以连续调用多个中间件进行处理

3.执行完中间件的业务代码之后，不要忘记调用next()函数
4.为了防止代码逻辑混乱，调用 next() 函数后不要再写额外的代码

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

2.3 中间件的分类

5大分类

        为了方便大家理解和记忆中间件的使用，Express官方把常见的中间件用法，分成了5大类，分别是:
                        应用级别的中间件
                        路由级别的中间件

                        错误级别的中间件

                        Express内置的中间件

                        第三方的中间件

应用级别的中间件

通过 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实例上，代码示例如下:

var app = express()
var router = express.Router()

//路由级别的中间件
5 router.use(function (req,res,next) {
    console.log( 'Time:',Date.now())
    next()
})

app.use('/', router)

错误级别的中间件

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

//1. 路由
app.get('/',function (req,res) {
    //1.1抛出一个自定义的错误
    throw new Error('服务器内部发全了错误!')
    res.send('Home Page.')
//2．错误级别的中间件
app.use(function(err,req,res,next) {
    //2.1在服务器打印错误消息
    console.log('发生了错误: ' +err.message)
    //2.2向客户端响应错误相关的内容
    res.send('Error! '+ err.message)

Express内置的中间件

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

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

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

第三方的中间件

        非 Express官方内置的，而是由第三方开发出来的中间件，叫做第三方中间件。在项目中，大家可以按需下载并配置第三方中间件，从而提高项目的开发效率。
        例如:在 express@4.16.0之前的版本中，经常使用 body-parser这个第三方中间件，来解析请求体数据。使用步骤如下:
1.运行 npm install body-parser 安装中间件

2.使用 require 导入中间件
3.调用 app.use() 注册并使用中间件

注意:

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

2.4 自定义中间件

需求描述与实现步骤

自己手动模拟一个类似于express.urlencoded这样的中间件，来解析POST提交到服务器的表单数据。
实现步骤:
1.定义中间件
2.监听req的data事件
3.监听req的end事件
4.使用querystring模块解析请求体数据
5.将解析出来的数据对象挂载为 req.body

定义中间件

        使用app.use()来定义全局生效的中间件，代码如下:
                        app.use( function(req,res, next) {
//中间件的业务逻辑

                         })

监听 req 的 data 事件

在中间件中，需要监听 req 对象的 data 事件，来获取客户端发送到服务器的数据。
如果数据量比较大，无法一次性发送完毕，则客户端会把数据切割后，分批发送到服务器。所以data事件可能会触发多次，每一次触发 data 事件时，获取到数据只是完整数据的一部分，需要手动对接收到的数据进行拼接。

// 定义一个str字符串，专门用来存储客户端发送过来的请求体数据
let str = ''
// 监听 req 的 data 事件  (客户端发送过来的新的请求体数据)
 req.on('data', (chunk) => {
       //拼接请求体数据，隐式转换为字符串
       str += chunk
})

监听 req 的 end 事件

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


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

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

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

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

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

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

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

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

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

// custom-body-parser.js横块中的代码
const qs.= require('querystring')
function bodyParser(req,res,next) { /*省略其它代码*/}
//向外导出解析请求体数据的中间件函数
module.exports = bodyParser 


//1．导入自定义的中间件模块
const myBodyParser = require('custom-body-parser')
//2．注册自定义的中间件模块
app.use(myBodyParser)

3.【使用 Express 写接口】

3.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')
})

3.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)

3.3 编写 GET 接口

apiRouter.get('/get', (req, res) => {
    // 1.通过req. query获取客户端通过查询字符串，发送到服务器的数据
    const query = req.query
    // 2.调用res.send()方法，向客户端响应处理的结果
    res.send({
        // 0表示处理成功，1表示处理失败
        status: 0, 
        //状态描述
        msg: 'GET 请求成功',
        //需要响应给客户端的数据
        data: query 
    })

})

3.4 编写 POST 接口

apiRouter.post('/post', (req, res) => {
    //通过req.body获取请求体中包含的url-encoded格式的数据
    const body = req.body
    //调用res.send()方法，向客户端响应处理的结果
    res.send({
         // 0 表示处理成功，1 表示处理失败
         status: 0,
         //状态描述
         msg: 'POST 请求成功', 
         //需要响应给客户端的具体数据
         data: body 
    })

})

3.5 编写 DELETE 接口

router.delete('/delete', (req, res) => {
    res.send({
        // 0 表示处理成功，1 表示处理失败
        status: 0, 
        //状态的描述
        msg: 'DELETE 请求成功', 
    })

})

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

4.5 CORS跨域资源共享

接口的跨域问题

编写的GET和POST接口，存在一个很严重的问题:不支持跨域请求。

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

1.CORS (主流的解决方案，推荐使用)
2.JSONP (有缺陷的解决方案:只支持GET请求)

使用cors中间件解决跨域问题

        cors 是 Express 的一个第三方中间件。通过安装和配置cors 中间件，可以很方便地解决跨域问题。使用步骤分为如下3步:
1.运行 npm install cors 安装中间件
2.使用 const cors = require('cors')  导入中间件

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

注意：

        一定要在路由之前，配置cors这个中间件，从而解决接口跨域的问题

什么是 CORS

CORS (Cross-Origin Resource Sharing，跨域资源共享）由一系列 HTTP响应头组成，这些HTTP响应头决定浏览器是否阻止前端JS代码跨域获取资源。

浏览器的同源安全策略默认会阻止网页“跨域”获取资源。但如果接口服务器配置了CORS相关的HTTP响应头,就可以解除浏览器端的跨域访问限制。

CORS的注意事项

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

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

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

Access-Control-Al1ow-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','*')

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-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','*')

CORS请求的分类

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

1.简单请求

2.预检请求

简单请求

        同时满足以下两大条件的请求，就属于简单请求:

1.请求方式:GET、POST、HEAD三者之一
2.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)

预检请求

只要符合以下任何一个条件的请求，都需要进行预检请求:

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

2.请求头中包含自定义头部字段
3.向服务器发送了 application / json格式的数据

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

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

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

4.6 JSONP 接口

概念与特点

概念:浏览器端通过<script>标签的src属性，请求服务器上的数据，同时，服务器返回一个函数的调用。这种请求数据的方式叫做JSONP。
特点:
1.JSONP 不属于真正的 Ajax请求，因为它没有使用XMLHttpRequest这个对象。

2.JSONP仅支持GET请求，不支持POST、PUT、DELETE等请求。

创建JSONP接口的注意事项

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

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

注意：必须在配置 cors 中间件之前，配置 JSONP 的接口

实现JSONP接口的步骤

1.获取客户端发送过来的回调函数的名字
2.得到要通过JSONP形式发送给客户端的数据
3.根据前两步得到的数据，拼接出一个函数调用的字符串
4.把上一步拼接得到的字符串，响应给客户端的<script>标签进行解析执行

实现JSONP接口的具体代码

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

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

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

$('#btnJSONP').on('click',function () {
    $.ajax({
        method: 'GET'，
        url: 'http://127.0.0.1/api/jsonp',
        dataType: 'jsonp',
        //表示要发起JSONP的请求
        success: function (res) {
            console.log(res)
        }
    })
})