使用Express写接口

创建基本的服务器

//导入express模块
const express = require('./module/node_modules/express/lib/express.js');

//创建express服务器实例
const app = express();

//省略部分代码

//调用 app.listen方法 指定端口号并开启服务器
app.listen(80, () => {
    console.log('Express server running at http://127.0.01');
});

 

创建API路由模块

//apiRouter.js 路由模块
const express = require('./module/node_modules/express/lib/express.js');
const apiRouter = express.Router();

//省略部分代码
module.exports = apiRouter;

/*-------分割线-------*/

//app.js 导入并注册路由模块
const apiRouter = require('./apiRouter.js');
app.use('/api', apiRouter);

 

编写GET接口

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

 

编写POST接口

router.post('/post', (req, res) => {
    //通过 req.body 获取客户端的请求体中 发送到服务器 URL-encoded 格式的数据
    const body = req.body;
    //调用 res.send() 方法
    res.send({
        status: 0,
        msg: 'POST请求成功!',
        data: body
    })
})

注意: 如果希望通过req.body获取到url-encoded格式的数据,必须要配置一个中间件来解析表单数据

app.use(express.urlencoded({ extended: false }));

在路由模块之前配置这个中间件

 

完整代码

自定义路由模块

const express = require('../module/node_modules/express/lib/express.js');

const router = express.Router();

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

router.post('/post', (req, res) => {
    //通过 req.body 获取客户端的请求体中 发送到服务器 URL-encoded 格式的数据
    const body = req.body;
    //调用 res.send() 方法
    res.send({
        status: 0,
        msg: 'POST请求成功!',
        data: body
    })
})

//定义DELETE接口
router.delete('/delete', (req, res) => {
    res.send({
        status: 0,
        msg: 'DELETE请求成功!'
    })
})

module.exports = router;

创建服务器调用自定义模块

//导入express模块
const express = require('../module/node_modules/express/lib/express.js');
//创建apiRouter路由模块
const apiRouter = express.Router();

//创建express服务器实例
const app = express();

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

//在路由之前配置 cors 中间件 从而解决接口跨域问题
const cors = require('cors');
app.use(cors());

//导入路由模块
const router = require('./apiRouter');

//把路由模块注册到app上
app.use('/api', router);

//调用 app.listen方法 指定端口号并开启服务器
app.listen(80, () => {
    console.log('Express server running at http://127.0.01');
});

 

CORS跨域资源共享

接口的跨域问题

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

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

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

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

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

使用步骤为以下3步:

1. 运行 npm install cors 安装中间件 (如果安装失败可以切换淘宝镜像源)
2. 使用 const cors = require('cors') 导入中间件
3. 在路由之前调用 app,use(cors()) 配置中间件

什么是CORS

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

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

 CORS注意事项

1. CORS主要在服务器端进行配置,客户端浏览器无需做出任何额外的配置,计科请求开启了CORS的接口
2. CORS在浏览器中由兼容性,只有支持XMLHttpRequest Level2 的浏览器,才能正常访问开启了CORS的服务器接口

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-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/from-data, application/x-www/form-urlencoded 三者之一)

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

//允许客户端额外想服务器发送Content-Type请求头和X-Custom-Header请求头
//注意: 多个请求头之间使用英文的逗号进行分割
res.setHeader('Access-Control-Allow-Header', 'Content-Type, X-Custom-Header')

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

CORS请求的分类

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

1. 简单请求
   1. 请求方式: GET, POST, HEAD 三者之一
   2. HTTP头部信息不能超过以下几种字段: 无自定义头部字段,Accept, Accept-Language, DPR, Downlink, Save-Data, Viewport-Width, Content-Type(只有三个值application/x-www-form-urlencoded, multipart.form-data, text/plain)
2. 预检请求 (只要符合以下任何一个要求的请求,都需要进行预检请求)
   1. 请求方式为GET, POST, HEAD 之外的请求Method变量
   2. 请求头中包含自定义头部字段
   3. 向服务器发送了application/json格式的数据

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

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

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

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