Strive-NUAA
0%

Node.js-利用express编写接口

发表于 分类于
......

Node.js-利用express编写接口

创建基本的服务器

1
2
3
4
5
6
7
8
9
10
11
12
//创建服务器
//导入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路由模块

1
2
3
4
5
6
7
8
const express = require("express")
const APIRouter = express.Router()


//在这里挂载对应的路由


module.exports = APIRouter

服务器中注册路由

1
2
3
4
//导入路由模块
const router = require('./接口1.js')
//把路由模块，注册到app上
app.use('/api',router)

编写get接口

1
2
3
4
5
6
7
8
9
10
11
///定义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接口

1
2
3
4
5
6
7
8
9
10
11
12
//定义post接口
APIRouter.post('/post',(req,res) => {
    //通过req. body获取请求体中包含的url-encoded格式的数据
    const body = req.body
    //调用res.send() 方法，向客户端响应接结果
    res.send({
        status: 0,//0:表示处理成功，1：表示处理失败
        msg: 'get 请求成功',  //状态描述
        data: body //需要响应给客户端的数据
    })

})

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

CORS跨域资源共享

接口的跨域问题

解决跨域问题的方式有两种：

  1. CORS(主流的解决方案，推荐使用)
  2. JSONP(有缺陷的解决方案:只支持GET请求)
使用cors中间件解决跨域问题

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

  1. 运行npm install cors 安装中间件
  2. 使用const cors = require(“cors”)导入中间件
  3. 在路由之前调用app.use(cors())配置中间件
1
2
3
//定要在路由之前，配置 cors这个中间件，从而解决接口跨域的问题
const cors = require('cors')
app.use(cors())

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

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

注意：

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

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

1
2
3
4
5
6
Access-Control-Allow-Origin:<origin>|*
//其中，origin参数的值指定了允许访问该资源的外域URL。

示例：
下面的字段值将只允许来自http://itcast.cn的请求:
res.setHeader("Access-Control-Allow-origin","http:ll/itcast.cn')

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

1
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 对额外的请求头进行声明，否则这次请求会失败!

1
2
3
//允许客户端额外向服务器发送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方法。

1
2
3
4
//只允许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. 简单请求（a.请求方式:GET、POST、HEAD三者之一 b.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) （满足上面两种））
  2. 预检请求（a.请求方式为GET、POST、HEAD之外的请求 Method类型 b.请求头中包含自定义头部字段 c.向服务器发送了application/json格式的数据 (满足任意一种)）

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

两种请求的区别;

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

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

JSONP接口

概念:浏览器端通过