用 Koa2 搭建一个可跨域的本地接口服务,并在前端进行访问。


后端接口项目搭建:

一. 安裝依赖:

- npm init
- npm install koa2
- npm i koa-router
- npm i koa2-cors // 解决跨域

二. 编写接口

在根目录新建一个入口文件 server.js 内容如下:
const koa = require('koa2');
const app = new koa();
const router = require('koa-router')();
// CORS是一个W3C标准,全称是"跨域资源共享"(Cross-origin resource sharing)。
// 下面以koa2-cors为例,
const cors = require('koa2-cors');

// app.use(cors()); // 全部允许跨域

app.use(cors({ // 指定一个或多个可以跨域的域名
  origin: function (ctx) { // 设置允许来自指定域名请求
    if (ctx.url === '/test') {
      return "*"; // 允许来自所有域名请求, 这个不管用
    }
    return 'http://localhost:8000'; // 这样就能只允许 http://localhost:8000 这个域名的请求了
  },
  maxAge: 5, // 指定本次预检请求的有效期,单位为秒。
  credentials: true,  // 是否允许发送Cookie
  allowMethods: ['GET', 'POST', 'PUT', 'DELETE', 'OPTIONS'],  // 设置所允许的HTTP请求方法
  allowHeaders: ['Content-Type', 'Authorization', 'Accept'],  // 设置服务器支持的所有头信息字段
  exposeHeaders: ['WWW-Authenticate', 'Server-Authorization'] // 设置获取其他自定义字段
}))

router.post('/', async function (ctx) {
  ctx.body = JSON.stringify({ data: '恭喜 __小朱__ 你成功登陆了' })
});

app.use(router.routes())
app.use(router.allowedMethods());

app.listen(3000);

三. 修改 package.json 文件

在 "scripts" 里加入 "start": "node server.js"

四. 启动项目

在跟目录执行 - npm run start
 

前端请求

到此为止,后端服务器已经搭建并开启了。并且 url 地址是:http://localhost:3000
可接收的请求地址:http://localhost:8000,即我们的前端项目的本地地址。
当然也可以设置成全部地址允许跨域:app.use(cors())
 fetch("http://localhost:3000", {
   method:'post'
 }).then((res, req) => {
   return res.json()
 }).then(res => {
   console.log(res) // {data: "恭喜 __小朱__ 你成功登陆了"}
 })

 

深入研究

下面我们以具体的请求头信息解释上面的代码,也就是cors具体的实现过程

// 我们可以用下面的中间件理解app.use(cors({}))
app.use(async (ctx, next) => {
    // 允许来自所有域名请求
    ctx.set("Access-Control-Allow-Origin", "*");
    // 这样就能只允许 http://localhost:8080 这个域名的请求了
    // ctx.set("Access-Control-Allow-Origin", "http://localhost:8080");
 
    // 设置所允许的HTTP请求方法
    ctx.set("Access-Control-Allow-Methods", "OPTIONS, GET, PUT, POST, DELETE");
 
    // 字段是必需的。它也是一个逗号分隔的字符串,表明服务器支持的所有头信息字段.
    ctx.set("Access-Control-Allow-Headers", "x-requested-with, accept, origin, content-type");
 
    // 服务器收到请求以后,检查了Origin、Access-Control-Request-Method和Access-Control-Request-Headers字段以后,确认允许跨源请求,就可以做出回应。
 
    // Content-Type表示具体请求中的媒体类型信息
    ctx.set("Content-Type", "application/json;charset=utf-8");
 
    // 该字段可选。它的值是一个布尔值,表示是否允许发送Cookie。默认情况下,Cookie不包括在CORS请求之中。
    // 当设置成允许请求携带cookie时,需要保证"Access-Control-Allow-Origin"是服务器有的域名,而不能是"*";
    ctx.set("Access-Control-Allow-Credentials", true);
 
    // 该字段可选,用来指定本次预检请求的有效期,单位为秒。
    // 当请求方法是PUT或DELETE等特殊方法或者Content-Type字段的类型是application/json时,服务器会提前发送一次请求进行验证
    // 下面的的设置只本次验证的有效时间,即在该时间段内服务端可以不用进行验证
    ctx.set("Access-Control-Max-Age", 300);
 
    /*
    CORS请求时,XMLHttpRequest对象的getResponseHeader()方法只能拿到6个基本字段:
        Cache-Control、
        Content-Language、
        Content-Type、
        Expires、
        Last-Modified、
        Pragma。
    */
    // 需要获取其他字段时,使用Access-Control-Expose-Headers,
    // getResponseHeader('myData')可以返回我们所需的值
    ctx.set("Access-Control-Expose-Headers", "myData");
 
    await next();
})

理解的上面的代码,估计你也能猜到app.use(cors({}))里面的配置信息了。当然还有其他可选的信息,具体设置并无多大差别,在这就不多解释了。

 

 

 
 
 
 
 

 


免责声明!

本站转载的文章为个人学习借鉴使用,本站对版权不负任何法律责任。如果侵犯了您的隐私权益,请联系本站邮箱yoyou2525@163.com删除。



 
粤ICP备18138465号  © 2018-2025 CODEPRJ.COM