创建基本的服务器
如下:
//导入Express模块
const express = require('express')
//创建Express的服务器实例
const app = express()
//调用app.listen方法,指定端口号并启动服务器
app.listen(80,function(){
console.log('Express server running at http://127.0.0.01')
创建API路由模块
如下:
//apiRouter.js【路由模块】
const express = require('express')
const apiRouter = express.Router()
// ...
moudle.exports = apiRouter
//------------------------------------
//app.js【导入并注册路由模块】
const apiRouter = require('./apiRouter.js')
app.use('/api',apiRouter)
编写GET接口
如下:
apiRuter.get('/get',(req,res)=>{
//获取到客户端通过查询字符串,发送到服务器的数据
const query = req.query
//调用res.send()方法,把数据响应给客户端
res.send({
status:0, //状态,0表示成功,1表示失败
msg:'GET请求成功'), //状态描述
data:query // 需要响应给客户端的具体数据
})
})
在终端打开服务器,启动成后,在postman中进行测试,有:接下来可以动态的输入要查询的参数,如下:
编写POST接口
apiRuter.post('/post',(req,res)=>{
//获取到客户端通过查询字符串,发送到服务器的数据
const body = req.body
//调用res.send()方法,把数据响应给客户端
res.send({
status:0, //状态,0表示成功,1表示失败
msg:'GET请求成功'), //状态描述
data:body // 需要响应给客户端的具体数据
})
})
在终端打开服务器,启动成后,在postman中进行测试,有:接下来可以动态的输入要查询的参数,如下:响应的内容为:
CORS跨域资源共享
接口的跨域问题
刚才编写的GET和POST接口,存在一个很严重的问题:不支持跨域请求。验证如下:创建一个html文件,如下:
Title
打开浏览器进行运行,有:发现报错,这就是因为跨域问题导致的。我门打开的网页是在解决接口跨域问题的方案主要有两种:
CORSJSONP
使用cors中间件解决跨域问题
cors是Express的一个第三方中间件。通过安装和配置cors中间件,可以很方便地解决跨域问题。使用步骤分为如下3步:运行npminstallcors安装中间件使用constcors=require('cors')导入中间件在路由之前调用app.use(cors())配置中间件配置完成后,再去运行测试接口跨域问题.html,如下:跨域请求成功。
什么是CORS
CORS由一系列HTTP响应头组成,这些HTTP响应头决定浏览器是否阻止前端JS代码跨域获取资源。浏览器的同源安全策略默认会阻止网页“跨域”获取资源。但如果接口服务器配置了CORS相关的HTTP响应头,就可以解除浏览器端的跨域访问限制。如下所示:但是需要注意的是:
CORS主要在服务器端进行配置。客户端浏览器无须做任何额外的配置,即可请求开启了CORS的接口。CORS在浏览器中有兼容性。只有支持XMLHttpRequestLevel2的浏览器,才能正常访问开启了CORS的服务端接口。
CORS响应头部-Access-Control-Allow-Origin
响应头部中可以携带一个Access-Control-Allow-Origin字段,其语法如下:
其中,origin参数的值指定了允许访问该资源的外域URL。例如,下面的字段值将只允许来自http://www.cn的请求:
如果指定了Access-Control-Allow-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。如果客户端向服务器发送了额外的请求头信息,则需要在服务器端,通过Access-Control-Allow-Headers对额外的请求头进行声明,否则这次请求会失败!
需要注意的是,多个请求头之间要使用英文逗号分隔。
CORS响应头部-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-Method','*')
CORS请求的分类
客户端在请求CORS接口时,根据请求方式和请求头的不同,可以将CORS的请求分为两大类,分别是:简单请求和预检请求。
简单请求
同时满足以下两大条件的请求,就属于简单请求:请求方式:GET、POST、HEAD三者之一HTTP头部信息不超过以下几种字段:无自定义头部字段、Accept、Accept-Language、Content-Language、DPR、Downlink、Save-Data、Viewport-Width、Width、Content-Type
预检请求
只要符合以下任何一个条件的请求,都需要进行预检请求:请求方式为GET、POST、HEAD之外的请求Method类型请求头中包含自定义头部字段向服务器发送了application/json格式的数据在浏览器与服务器正式通信之前,浏览器会先发送OPTION请求进行预检,以获知服务器是否允许该实际请求,所以这一次的OPTION请求称为“预检请求”。服务器成功响应预检请求后,才会发送真正的请求,并且携带真实数据。
简单请求和预检请求的区别
简单请求的特点:客户端与服务器之间只会发生一次请求。预检请求的特点:客户端与服务器之间会发生两次请求,OPTION预检请求成功之后,才会发起真正的请求。如下,我们在添加一个delete请求,作为预检请求,然后,在页面给其添加点击事件,通过ajax发起一个请求,然后在添加一个delete接口:
$('.btn3').on('click',function(){
$.ajax({
type:'DELETE',
url:'http://127.0.0.1/api/delete',
success:function(res){
console.log(res)
}
})
})
router.delete('/delete',(req,res)=>{
res.send({
status:0,
msg:'DELETE请求成功',
})
})
打开浏览器进行测试:可以看到在delete请求中,客户端与服务器之间会发生两次请求。
JSONP接口
前期已经对JSONP进行过详细的说明,这里在说一下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'),)res,req)=>{ })
实现JSONP接口的步骤
获取客户端发送过来的回调函数的名字
得到要通过JSONP形式发送给客户端的数据:
const data = {name:'王欢',age:18}
根据前两步得到的数据,拼接出一个函数调用的字符串:
const = scriptStr = `${funcName}(${JSON.stringify(data)})`
把上一步拼接得到的字符串,响应给客户端的