egg-cors 插件使用教程

egg-cors 插件使用教程

项目地址:https://gitcode.com/gh_mirrors/eg/egg-cors

项目介绍

egg-cors 是一个为 Egg.js 框架提供的 CORS（跨域资源共享）插件。它基于 @koa/cors 实现，使得在 Egg.js 应用中处理跨域请求变得简单和高效。该插件允许开发者通过配置白名单来控制哪些域名可以访问应用资源，从而增强应用的安全性。

项目快速启动

安装

首先，你需要在你的 Egg.js 项目中安装 egg-cors 插件：

npm i egg-cors --save

启用插件

在 {app_root}/config/plugin.js 文件中启用 egg-cors 插件：

exports.cors = {
  enable: true,
  package: 'egg-cors',
};

配置 CORS

在 {app_root}/config/config.default.js 文件中配置 CORS 相关设置：

config.security = {
  domainWhiteList: ['http://example.com'], // 添加允许跨域的域名
};

示例代码

以下是一个简单的示例，展示如何在 Egg.js 应用中使用 egg-cors 插件：

// app/router.js
module.exports = app => {
  const { router, controller } = app;
  router.get('/api/data', controller.home.getData);
};

// app/controller/home.js
exports.getData = async ctx => {
  ctx.body = {
    data: 'Hello World',
  };
};

应用案例和最佳实践

应用案例

假设你有一个前端应用运行在 http://localhost:3000，而后端 API 运行在 http://localhost:7001。通过配置 egg-cors 插件，你可以允许前端应用访问后端 API：

// config/config.default.js
config.security = {
  domainWhiteList: ['http://localhost:3000'],
};

最佳实践

1. 限制域名：仅将必要的域名添加到 domainWhiteList 中，避免不必要的跨域访问。
2. 安全配置：结合 Egg.js 的安全插件 egg-security，进一步增强应用的安全性。

典型生态项目

egg-cors 插件是 Egg.js 生态系统中的一个重要组成部分。它与其他 Egg.js 插件（如 egg-security、egg-validate 等）协同工作，共同构建一个安全、高效的后端服务。

相关插件

• egg-security：提供一系列安全相关的中间件，如 CSRF 防护、XSS 过滤等。
• egg-validate：提供数据验证功能，确保输入数据的合法性。

通过这些插件的组合使用，可以构建一个健壮的 Egg.js 应用，满足各种复杂业务需求。

egg-cors CORS plugin for egg 项目地址: https://gitcode.com/gh_mirrors/eg/egg-cors