1. 创建基本的服务器
//导入 express
const express = require('express')
const app = express()
app.listen(80, () => {
console.log("express sever running at http://127.0.0.1");
})
2.创建api路由模块
const express = require('express')
//创建路由对象
const apiRouter = express.Router()
//TODO挂载路由
//向外暴露
module.exports = apiRouter
--------------------------------分割线
//aap.js
//导入并注册路由项目
const apiRouter = require('./27api路由模块')
app.use('/api',apiRouter)
3. 编写get接口
apiRouter.get('/get', (req, res) => {
//1.获取到客户端通过查询字符串,发送到服务器的数据
const query = req.query
//2.调用res.send()方法 把数据响应给客户端
res.send({
status: 0, //状态 0 表示成功,状态 1表示失败
msg: 'GET请求成功', //状态描述
data: query //需要响应给客户端的具体数据
})
})
4. 编写post接口
apiRouter.post('/post', (req, res) => {
//1.获取客户端通过请求体,发送到服务器 URL-encoded数据
const body = req.body
//2.调用 res.send() 方法把数据响应给客户端
res.send({
status: 0, //状态 0 表示成功,状态 1表示失败
msg: 'POST请求成功', //状态描述
data: body //需要响应给客户端的具体数据
})
})
注意:如果要获取URL-encoded格式的请求数据 必须要配置中间件 app.use(express.urlencoded({extended:false}))
接口的跨域问题
刚才编写的GET和POST接口,存在一个很严重的问题:不支持跨域请求。
解决接口跨域问题的方案主要有两种:
1.CORS(主流的的解决方案,推荐使用)
2.JSONP(有缺陷的解决饭干,只支持GET请求)
使用cors中间件解决跨域问题
cors是Express的一个第三方中间件,通过安装和配置cors中间件,可以很方便的解决跨域问题。
使用步骤:
- 运行 npm install cors 安装中间件
- 使用 const cors = require(‘cors’)导入中间件
- 在路由之前调用 app.use(cors()) 配置中间件
- 注意: 一点要在路由之前配置cors中间件,从而解决接口跨域问题
什么是 CORS跨域资源共享
CORS (Cross-Oringin Resource Sharing,跨域资源共享) 由一系列HTTP响应头组成,这些HTTP响应头决定浏览器是否阻止前端JS代码跨域获取资源
浏览器的同源安全策略默认会阻止网页’跨域’获取资源。但是如果接口服务器配置了CORS相关的HTTP响应头,就可以解除浏览器前端的跨域访问限制。
浏览器—跨域请求---->接口服务器—响应---->x---- 浏览器
响应的结果被浏览器拦截,网页无法获取到跨域响应的数据。
浏览器—跨域请求---->接口服务器(配置Acess-Control-Allow相关的响应头—响应-----> 浏览器
在服务器端,配置cors相关的响应头,从而解除浏览器端的跨域访问限制
CORS的注意事项
- cors 主要在服务端进行配置。客户端浏览器无需任何额外的配置,即可请求开启了cors的接口。
- cors 在浏览器中有兼容性。只有支持XMLHttpRequest Level2 的浏览器,才能正常访问开启了CORSDE服务器端接口(例如:IE10+,Chrom4+,FireFox3.5+)
CORS响应头部 Acess-Control-Allow-Origin
响应头部可以携带一个 Acess-Control-Allow-Oringin字段,其语法如下:
Acess-Control-Allow-Origin:<origin>|*
其中,origin参数的值指定了允许访问该资源的外域URL。
例如,下面的字段值只允许来自 http://itcast.cn 的请求
res.setHeader('Acess-Control-Allow-Origin','http://itcast.cn')
如果指定了Acess-Control-Allow-Origin字段的值为通配符*,表示允许来自任何域的请求,示例代码如下:
res.setHeader('Acess-Control-Allow','*')
CORS 响应头部 -Acess-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 三者之一)
如果客户端向服务器发送了额外的请求头信息,则需要在服务器端,通过Acess-Control-Allow-Headers对额外得请求头进行声明,否则这次请求会失败!
例如:
//允许客户端额外向服务器发送Content-Type 请求头和 X-Custom-Header 请求头
//注意:多个请求头之间使用英文的逗号进行分割
res.setHeader('Access-Control-Allow-Headers','Content-type,X-Custom-Header')
CORS 响应头部 -Acess-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 请求的分类
客户端在请求CROS接口时,根据请求方法和请求头不同,可将CORS分为两大类,分别是:
1.简单请求 2. 预检请求
-
简单请求
同时满足以下两大条件,就属于简单请求:
1)请求方式:GET POST HEAD 三者之一
2)HTTP头部信息不超过以下几种字段:无自定义头部字段、Accept、Accept-Language、Content-Language、DPR、Downlink、Save-Data、Viewport-Width、Width、Content-Type(只有三个值 text/plain 、multipart/form-data、application/x-www-form-urlencoded) -
预检请求
只要符合以下任何一个条件的请求,都需要进行预检请求
- 请求方式为GET、POST、HEAD之外的请求Method类型
- 请求头中包含自定义头部字段
- 向服务器发送了 application/json 格式的数据
在浏览器与服务器正式通信之前,浏览器会先发送 OPTION 请求进行预检,以获知服务器是否允许该实际请求,所以这一次的OPTION请求成为’预检请求’。服务器
成功响应预检请求后,才会发送真正的请求,并且携带真实数据。
- 简单请求和预检请求的区别
简单请求的特点:客户端与服务器之间只会发生一次请求
预检请求的特点: 客户端与服务器之间会发生两次请求,OPTION预检请求成功后,才会发起真正的请求。
JSONP接口
-
JSONP概念与特点
概念: 浏览器端通过
//优先创建 JSONP的接口 (这个接口不会被处理成 CORS接口)
app.get('/api/jsonp',(req,res)=>{})
//再配置 cors中间件(后续所有的接口,都会被处理成CORS接口)
app.use(cors())
//这是一个开启了cors的接口
app.get('/api/get',(req,res)=>{})
- 实现JSONP接口的步骤
- 获取客户端发送过来的回调函数名字
- 得到通过jsonp形式发送给客户端的数据
- 根据前两部拼接出一个函数调用的字符串
- 把拼接得到的字符串,响应给客户端的
app.get('/api/jsonp', (req, res) => {
//1.获取客户端发送过来的回调函数的名字
const funcName = req.query.callback
//2.得到要通过 JSONP形式发送给客户端的数据
const data = { name: 'zs', age: 22 }
//3.根据前两步得到的数据拼接出一个函数调用的字符串
const scriptStr = `${funcName}(${JSON.stringify(data)})`
//4.把上一步拼接得到的字符串响应给客户端的<script>标签进行解析执行
res.send(scriptStr)
})
- 在网页中使用jQuery发起JSONP请求 测试上面
调用 $.ajax()函数,提供JSONP配置选项,dataType,从而发起JSONP请求。
$('#btn4').on('click', function() {
$.ajax({
type: 'GET',
url: 'http://127.0.0.1/api/jsonp',
dataType: 'jsonp',
success: function(res) {
console.log(res); //objec {name:'zs',age:20}
}
})
})