使用Express写接口

//app.js
//使用express 写接口
const express = require('express')
const apiRouter =require('./apiRouter.js')
const app = express()

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

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)=>{
    //通过req.query获取客户端通过查询字符串,发送到服务器的数据
    const query = req.query;

    //通过res.send()方法,向客户端响应处理的结果
    res.send({
        status:0,//0表示处理成功,1表示处理失败
        msg: 'GET 请求成功', //状态描述
        data:query //需要响应给客户端的数据
    })
})

//编写POST接口
apiRouter.post('/post',(req,res)=>{
    //获取客户端通过请求体,发送到服务器的URL-encoded数据
    const body = req.body;
    //调用res.send()方法,把数据响应给客户端
    res.send({
        status:0,
        msg:'POST请求成功',
        data:body
    })
})
module.exports = apiRouter

接口跨域问题

上述GET和POST 接口,存在一个很严重的问题:不支持跨域请求

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

1、CORS(主流解决方案,推荐使用)

2、JSONP(有缺陷的解决方案:只支持GET 请求)

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

npm install cors

const cors = require('cors')

app.use(cors()) //在路由之前调用
<button id="btnGET">GET</button>
<button id="btnPOST">POST</button>

<script>
    $(function () {
        $("#btnGET").on('click',function () {
            $.ajax({
                type:'GET',
                url:'http://127.0.0.1/api/get',
                data: {name:'zs',age:20},
                success: function (res) {
                    console.log(res)
                },
            })
        })
        $("#btnPOST").on('click',function () {
            $.ajax({
                type:'POST',
                url:'http://127.0.0.1/api/post',
                data: {name:'123',age:55},
                success: function (res) {
                    console.log(res)
                },
            })
        })
    })
</script>

在html页面中ajax请求访问get接口和post接口时会出现跨域问题。

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

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

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

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

CORS跨域资源共享响应头部

1、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')

2、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、applocation/x-www-form-urlencoded三者之一)

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

res.setHeader('Access-Control-Allow-Headers','Content-Type,X-Custom-Header')

3、Access-Control-allow-Method

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

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

res.setHeader('Access-Control-Allow-Methods','POST,GET,DELETE,HEAD')

CORS请求分类

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

1、简单请求

​ 满足:1、请求方式:GET、POST、HEAD三者之一

​ 2、HTTP头部信息不超过以下集中字段:无自定义头部字段、Accept、Accept-Language、 Content-Language、DPR、Downlink、Save-Data、Viewport-Width、Width、 Content-Type(值仅限于text/plain、multipart/form-data、applocation/x-www-form- urlencoded三者之一)

2、预检请求

​ 满足以下任何一个条件的请求:

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

​ 2、请求头中包含自定义头部字段

​ 3、向服务器发送了application/json格式的数据

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

JSONP接口

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

特点:

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

2、JSONP仅支持GET请求,不支持POST、PUT、DELETE等请求

创建JSONP接口的注意事项

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

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