【node】使用Express写接口

一、创建基本的服务器

//导入express模块

const express = require('express')

//创建express的服务器实例

const app = express()

//调用app.listen方法，指定端口号并启动web服务器

app.listen(80,function(){

        console.log('Express server running at http://127.0.0.1')

})

二、创建API路由模块

//apiRouter.js【路由模块】

const express = require('express')

const apiRouter = repress.Router()

module.exports = apiRouter

//app.js【导入并注册路由模块】另一个文件

const apiRouter = require('./apiRouter.js')

app.use('/api',apiRouter)

三、编写GET接口

apiRouter.get('/get',(req,res)=>{

        //1、获取到客户端通过查询字符串，发送到服务器的数据

        const query = req.query

        //2、调用res.send()方法，把数据响应给客户端

        res.send({

                status:0,        //状态，0表示成功，1表示失败

                msg:'GET请求成功！',        //状态描述

                data:query,        //需要响应给客户端的具体数据

        })

})

四、编写POST接口

apiRouter.post('/post',(req,res)=>{

        //1、获取客户端通过请求体，发送到服务器的URL-encoded数据

        const body = req.body

        //2、调用res.send()方法，把数据响应给客户端

        res.send({

                status:0,

                msg:'POST请求成功！',

                data:body

        })

})

注意：如果要获取URL-encoded格式的请求体数据，必须配置中间件

const parser = require('body-parser')

app.use(parser .urlencoded({extended:false}))

五、CORS跨域资源共享

        ①        CORS(主流的解决方案，推荐使用)        

        ②        JSONP(有缺陷的解决方案：只支持GET请求)

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

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

        步骤：

        ①运行npm install cors 安装中间件

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

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

        2、什么是CORS

        CORS由一些列HTTP响应头组成，这些HTTP响应头决定浏览器是否阻止前端JS代码跨域获取资源。

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

        3、CORS的注意事项

        ① CORS主要在服务器端进行配置，客户端浏览器无须做任何额外的配置，即可请求开启了CORS的接口。

        ② CORS在浏览器中有兼容性。只有支持XMLHttpRequest Level2的浏览器，才能正常访问开启了CORS的服务端接口（例如：IE10+、Chrome4+、FireFox3.5+）。

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

        5、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)

        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、CORS请求的分类

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

        （1）简单请求

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

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

                ② HTTP头部信息不超过以下几种字段：无自定义头部字段、Accept、Accept-Language、Content-Language、DPR、Downlink、Save-Data、Viewport-Width、Width

Content-Type（值仅限于text/plain、multipart/form-data、application/x-www-form-urlencoded三者之一）

        （2）预检请求

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

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

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

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

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

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

        简单请求的特点：客户端与服务器之间只会发生一次请求。

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

六、JSONP接口

        1、回顾JSONP的概念与特点

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

        特点：       

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

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

        2、创建JSONP接口的注意事项

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

        //优先创建JSONP接口【这个接口不会被处理成CORS接口】

        app.get('/api/jsonp',(req,res)=>{        })

        //在配置CORS中间件【后缀的所有接口，都会被处理成CORS接口】

        app.use(cors())

        //这是一个开启了CORS的接口

        app.get('api/get',(req,res)=>{        })

        3、实现JSONP接口的步骤

        ① 获取客户端发送过来的回调函数的名字

        ② 得到要通过JSONP形式发送给客户端的数据

        ③ 根据前两部得到的数据，拼接出一个函数调用的字符串

        ④ 把上一步拼接得到的字符串，响应给客户端的<script>标签进行解析执行

        4、实现JSONP接口的具体代码

        app.get('/api/jsonp',(req,res)=>{

                //1、获取客户端发送过来的回调函数的名字

                const funcName = req.query.callback

                //2、得到要通过JSONP形式发送给客户端的数据

                const data = {name:'zs',age:'23'}

                //3、根据前两部得到的数据，拼接出一个函数调用的字符串

                const scriptStr = `${funcName}(${JSON.stringify(data)})`

                //4、把上一步拼接得到的字符串，响应给客户端的<script>标签进行解析执行

                res.send(scriptStr)

        })

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

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

        $('#btnJSONP').on('click',function(){

                $.ajax({

                        method:'GET',

                        url:'http://127.0.0.1/api/jsonp',

                        dataType:'jsonp',

                        success:function(res){

                                console.log(res)

                        }

                })

        })