目录
使用Express写接口
一、编写Get接口
const express = require('express')
const app = express()
const router = require('./16-apiRouter')
app.use('/api',router)
app.listen(80,() => {
console.log('http://127.0.0.1');
})
//16-apiRouter.js
const express = require('express')
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 //需要响应给客户端的数据
})
})
module.exports = router
二、编写Post接口
const express = require('express')
const app = express()
const router = require('./16-apiRouter')
app.use('/api',router)
app.use(express.urlencoded({ extended: false }))
app.listen(80,() => {
console.log('http://127.0.0.1');
})
//16-apiRouter.js
const express = require('express')
const router = express.Router()
router.post('/post',(req,res) => {
//通过req.query获取客户端通过查询字符串发送到服务器的数据
const query = req.query
//调用res.send()方法,向客户端响应处理的结果
res.send({
status: 0, //0表示处理成功,1表示处理失败
msg: 'POST请求成功!', // 状态的描述
data: query //需要响应给客户端的数据
})
})
module.exports = router
三、CORS跨域资源共享
上面编写的GET和POST接口存在一个很严重的问题:不支持跨域请求。
解决接口跨域问题的方案主要有两种:①CORS
(主流的解决方案,推荐使用);②JSONP
(有缺陷的解决方案:只支持GET请求)。
什么是CORS
CORS(Cross-Origin Resource Sharing,跨域资源共享)
由一系列HTTP响应头组成,这些HTTP响应头决定了浏览器是否阻止前端JS代码跨域获取资源。浏览器的同源安全策略
默认会阻止网页“跨域”获取资源。但如果接口服务器配置了CORS相关的HTTP响应头,就可以解除浏览器端的跨域访问限制。注意:①CORS主要在服务器端进行配置,客户端浏览器无须做任何额外的配置即可请求开启CORS的接口;②CORS在浏览器中有兼容性。只有支持XMLHttpRequest Level2的浏览器,才能正常访问开启了CORS的服务端接口〔例如:IE10+.Chrome4+、FireFox3.5+)。
跨域问题报错案例:
CORS响应头部
1、Access-Control-Allow-Origin
响应头部中可以携带一个Access-Control-Allow-Origin
字段。如果指定了Access-Control-Allow-Origin字段的值为通配符*
,则表示允许来自任何域的请求。
//其中origin参数的值指定了允许访问该资源的外域URL
Access-Control-Allow-origin: <origin> | * //语法
//例如下面的字段值将只允许来自http://it.cn的请求
res.setHeader('Access-Control-Allow-origin', 'http://lit.cn')
//指定Access-Control-Allow-Origin字段的值为通配符*,表示允许来自任何域的请求
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对额外的请求头进行声明,否则这次请求会失败!
//允许客户端额外向服务器发送Content-Type请求头和X-Custom-Header请求头
//注意:多个请求头之问使用英文的逗号进行分割
res.setHeader('Access-Control-Allow-Headers','Coent-Type, x-Custom-Header')
3、Access-Control-Allow-Methods
默认情况下,CORS仅支持客户端发起GET、POST、HEAD请求。如果客户端希望通过 PUT、DELETE等方式请求服务器的资源,则需要在服务器端通过Access-Control-Alow-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
是Express的一个第三方中间件。通过安装和配置cors中间件可以很方便地解决跨域问题。使用步骤分为如下3步:①npm install cors
安装中间件;②使用const cors = require('cors')
导入中间件;③在路由之前调用app.use(cors())
配置中间件。
//在配置基本服务器的js中配置cors中间件解决跨域问题
const cors = require('cors')
app.use(cors())
CORS请求的分类
客户端在请求CORS接口时根据请求方式和请求头的不同可以将CORS的请求分为两大类,分别是简单请求
和预检请求
。
1、简单请求
`同时满足以下两大条件的请求就属于简单请求:
请求方式为GET、POST、HEAD三者之一;
- 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、预检请求
只要符合以下任意一个条件的请求都属于预检请求:
请求方式为GET、POST、HEAD之外的Method类型;
- 请求头中
包括
自定义头部字段; - 向服务器发送了
application/json格式的数据;
在浏览器与服务器正式通信之前,浏览器会先发送ОPTION请求进行预检,以获知服务器是否允许该实际请求,所以这一次的OPTION请求称为“预检请求”。服务器成功响应预检请求后,才会发送真正的请求,并且携带真实数据。
3、简单请求和预检请求的区别
简单请求的特点:客户端与服务器之间只会发生一次请求
。
预检请求的特点:客户端与服务器之间会发生两次请求
,OPTION预检请求成功之后才会发起真正的请求。
四、编写JSONP接口
概念:浏览器端通过<script>标签的src属性来请求服务器上的数据,同时服务器返回一个函数的调用。这种请求数据的方式叫做JSONP。
特点:①JSONP不属于真正的Ajax请求,因为它没有使用XMLHttpRequest这个对象;②JSONP仅支持GET 请求,不支持POST、PUT、DELETE等请求。
创建并实现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) => { })
实现JSONP接口的步骤:①获取客户端发送过来的回调函数的名字;②得到要通过JSONP形式发送给客户端的数据;③根据前两步得到的数据拼接出一个函数调用的字符串;④把上一步拼接得到的字符串,响应给客户端的<script>标签进行解析执行。
app.get('/api/jsonp', (req,res) => {
const funcName = req.query.callback //1、获取函数的名称
const data = { //2、定义要发送到客户端的数据对象
name: 'lisi',
age: 18
}
const scriptStr = `${funcName}(${JSON.stringify(data)})` //3、拼接出一个函数的调用
res.send(scriptStr) //4、把拼接的字符串响应给客户端
})
发起JSONP请求
在网页中使用jQuery 发起JSONP请求:调用$.ajax()函数
提供JSONP的配置选项从而发起JSONP请求,
$('#btnJSONP').on('click',function() {
$.ajax({
type: 'JSONP',
url: 'http://127.0.0.1/api/jsonp',
dataType: 'jsonp',
success: function(res) {
console.log(res);
}
})
})
关于Node.js的Express框架的学习就先到这了,下面将进行Node.js的一些项目的实操上手体验。Node.js学习之Express框架(一)、(二)的所有代码地址:Express基础知识—百度网盘
传送门:Node.js学习之Express框架(一)