Skip to content

Express写接口

4.1 创建基本的服务器

js
const express =require('express');

const app=express()

app.listen(80,()=>{

})

4.2 创建 API 路由模块

js
//router.js
const express=require('express');
const router=express.Router()
module.exports=router   //导出

//******************************************

//app.js 导入路由模块
const router=require('./14.apiRouter');
//把路由模块,注册到app上
app.use('/api',router)

4.3 编写 GET 接口

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

4.4 编写 POST 接口

js
//app.js	urlencoded要在router前引用
app.use(express.urlencoded({extended:false}))
app.use('/api',router)

//router.js
router.post('/post',(req,res)=>{
    const body=req.body
    res.send({
        status:0,
        msg:'POST请求成功',
        data:body
    })
    console.log(body);
})

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

4.5 CORS 跨域资源共享

1.跨域问题

刚才编写的 GET 和 POST接口,存在一个很严重的问题:不支持跨域请求。 解决接口跨域问题的方案主要有两种:

  1. CORS(主流的解决方案,
  2. JSONP(有缺陷的解决方案:只支持 GET 请求

2.CORS 解决跨域

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

1.安装中间件

sh
npm install cors

2.在 app.js 中导入并配置 cors 中间件:

js
const cors = require('cors')
app.use(cors())

3.CORS

  • CORS(Cross-Origin Resource Sharing,跨域资源共享)解决跨域,是通过 HTTP 响应头决定浏览器是否阻止前端 JS 代码跨域获取资源
  • 浏览器的同源安全策略默认会阻止网页“跨域”获取资源。但如果接口服务器配置了 CORS 相关的 HTTP 响应头,就可解除浏览器端的跨域访问限制
  • CORS 主要在服务器端进行配置。客户端浏览器无须做任何额外的配置,即可请求开启了 CORS 的接口。
  • CORS 在浏览器中有兼容性。只有支持 XMLHttpRequest Level2 的浏览器,才能正常访问开启了 CORS 的服务端接口(例如:IE10+、Chrome4+、FireFox3.5+)。

4.CORS 的注意事项

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

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

5.CORS 常见响应头

1.Access-Control-Allow-Origin:制定了允许访问资源的外域 URL

js
res.setHeader('Access-Control-Allow-Origin', 'http://bruceblog.io')
res.setHeader('Access-Control-Allow-Origin', '*')

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、application/x-www-form-urlencoded 三者之一)
  • 如果客户端向服务器发送了额外的请求头信息,则需要在服务器端,通过 Access-Control-Allow-Headers 对额外的请求头进行声明,否则这次请求会失败!
js
res.setHeader('Access-Control-Allow-Headers', 'Content-Type, X-Custom-Header')

3.Access-Control-Allow-Methods

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

6.CORS请求的分类

简单请求

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

请求方式三者之一

HTTP 头部信息不超过以下几种字段:无自定义头部字段、Accept、Accept-Language、Content-Language、DPR、 Downlink、Save-Data、Viewport-Width、Width 、Content-Type(只有三个值application/x-www-formurlencoded、multipart/form-data、text/plain)

预检请求

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

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

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

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

在浏览器与服务器正式通信之前,浏览器会先发送 ,所以这一 次的 OPTION 请求称为“预检请求”。

区别

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

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

4.6 JSONP接口

1.回顾 JSONP 的概念与特点

:浏览器端通过 <script>标签的 src 属性,请求服务器上的数据,同时,服务器返回一个函数的调用。这种请求数据

的方式叫做 JSONP。 特点: ① JSONP 不属于真正的 Ajax 请求,因为它没有使用 XMLHttpRequest 这个对象。 ② JSONP 仅支持 GET 请求,不支持 POST、PUT、DELETE 等请求

2.创建 JSONP 接口

的注意事项 如果项目中已经配置了 CORS 跨域资源共享

为了防止冲突,必须在配置 CORS 中间件之前声明 JSONP 的接口。否则 JSONP 接口会被处理成开启了 CORS 的接口。示例代码如下

js
//必须再cors中间件之前,配置jsonp接口
app.get('/api/jsonp',(req,res)=>{

})

const cors = require('cors')
app.use(cors())

3.实现 JSONP 接口的步骤

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

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

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

④ 把上一步拼接得到的字符串,响应给客户端的

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

js
//必须再cors中间件之前,配置jsonp接口
app.get('/api/jsonp', (req, res) => {
    const funcName = req.query.callback
    console.log(funcName);
    data = { name: 'xz', age: 20 }
    const scriptStr = `${funcName}(${JSON.stringify(data)})`

    res.send(scriptStr)
})

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

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

js
$('#btnJSONP').on('click',function(){
    $ajax({
        method:'GET',
        url:"http://127.0.0.1/api/jsonp",
        dataTyoe:'jsonp',
        success:function(){
            console.log(res);
        }
    })
})

MIT Licensed