oms/backend/config/config.default.js
liufumingren 3daa95c96f feat(backend): 新增蓝绿发布脚本与跨域支持
跨域:
- 新增 app/middleware/cors.js:按白名单回 Access-Control-Allow-Origin,OPTIONS 预检直接
  204,使用 Bearer Token 鉴权故不回 Allow-Credentials
- config.default.js 注册全局中间件 cors(置于 requestLog 之前),并新增 config.cors.origins
  (可用环境变量 CORS_ORIGINS 覆盖,默认放行 http/https 的 oms.gztbyc.com 与本地 vite)

端口:
- config.default.js 新增 config.cluster(读 EGG_PORT,默认 6090)
  原因:egg 只在 env=local 时加载 config.local.js,生产(env=prod)不加载它,
  原先把端口写在 config.local.js 会让生产退回框架默认的 7001

发布(参考 WMS 后端的 v1/v2 双实例蓝绿):
- 新增 script/deploy-lib.cjs、deploy-remote.cjs、rollback-remote.cjs、init-deploy-config.cjs
- 目标目录:清理旧代码(保留 logs/run/node_modules/.env)→ 解压 → 缺 .env 时从
  deployRoot/.env 复制 → npm install --production → 释放端口 → 启动 → 健康检查 →
  改写 nginx-upstream.conf 并 reload → 停旧实例;健康检查失败则不切换、回滚 current.md
  并清理新实例,线上不受影响
- 回滚 = 切回另一套版本目录(npm run rollback [-- --to=v1|v2]),秒级完成
- 发布包按 git 文件清单 + include/exclude 白名单生成,.env/uploads/logs 等不入包
  (含 .sequelizerc,便于服务器上直接跑迁移)

配置与依赖:
- 新增 config/deploy.config.example.cjs(模板入库;真实配置 deploy.config.local.cjs 已忽略)
- 新增 env.production.example:生产 .env 模板,说明 MySQL 端口、Redis 密码、
  JWT_SECRET、UPLOAD_DIR(必须放版本目录之外以让 v1/v2 共用)等
- package.json 增加 deploy/deploy:prod/deploy:init/rollback/rollback:prod;
  顺带登记导出任务用到的 exceljs 依赖
- .gitignore 增加:真实部署配置、backend/temp/(本地发布包)、backend/upload/(导出产物)
2026-09-14 22:14:20 +08:00

185 lines
6.6 KiB
JavaScript
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

'use strict';
// 加载项目根目录 .env(敏感配置不入库);文件不存在时自动忽略
require('dotenv').config();
const path = require('path');
const db = require('../database/config').development;
/**
* @param {Egg.EggAppInfo} appInfo app info
*/
module.exports = appInfo => {
/**
* built-in config
* @type {Egg.EggAppConfig}
**/
const config = exports = {};
// use for cookie sign key, should change to your own and keep security
config.keys = appInfo.name + '_1720000000000_1234';
// 监听端口与地址
// ⚠️ egg 只在 env=local 时加载 config.local.js(见 egg-core 的 getTypeFiles:
// 文件清单是 config.default + config.<env>),生产(egg-scripts start → env=prod)
// **不会**加载 config.local.js,因此端口必须写在这里,否则会退回 egg 默认的 7001。
// 双实例发布(v1/v2)由发布脚本按实例传入 EGG_PORT,两套实例必须用不同端口。
config.cluster = {
listen: {
port: Number(process.env.EGG_PORT || 6090),
hostname: '127.0.0.1',
},
};
// 全局中间件:cors 负责跨域预检(须在最前),requestLog 记录请求日志(洋葱模型,在响应阶段读取用户信息)
config.middleware = [ 'cors', 'requestLog' ];
// 跨域白名单:前端站点(oms.gztbyc.com)与后端 API 站点(api.oms.gztbyc.com)不同源时需要放行
// 可用环境变量 CORS_ORIGINS 覆盖(逗号分隔);填 '*' 表示不限制来源(不推荐,任意站点都能读取接口)
config.cors = {
origins: (
process.env.CORS_ORIGINS ||
'http://oms.gztbyc.com,https://oms.gztbyc.com,http://api.oms.gztbyc.com,https://api.oms.gztbyc.com,http://localhost:5173,http://127.0.0.1:5173'
).split(','),
// 预检结果缓存秒数,减少 OPTIONS 请求
maxAge: 86400,
};
// 请求日志配置
config.requestLog = {
keepDays: Number(process.env.REQUEST_LOG_KEEP_DAYS || 60),
maxBodyLength: Number(process.env.REQUEST_LOG_MAX_BODY || 2000),
// 不记录的路径前缀(Swagger 静态资源、图片读取等)
excludePaths: [ '/swagger', '/api/files/raw' ],
};
// 文件上传:使用 file 模式(先落临时文件再由控制器处理),仅允许图片
config.multipart = {
mode: 'file',
fileSize: '20mb',
files: 10,
whitelist: [ '.jpg', '.jpeg', '.png', '.gif', '.bmp', '.webp', '.svg' ],
};
// 文件资源存储:按「主体ID/年/月/日」分层,由上传时间决定(见 app/controller/file.js)
config.upload = {
dir: process.env.UPLOAD_DIR || path.join(appInfo.baseDir, 'uploads'),
// 访问前缀,与 router.js 中 /api/files/raw 保持一致
urlPrefix: '/api/files/raw',
};
// 对外通用回调接口(POST /openapi):展示给外部系统配置的回调服务地址前缀
// 未配置时按请求访问地址(ctx.protocol + ctx.host)动态生成,便于本地联调;
// 部署在网关/Nginx 后请用 OMS_CALLBACK_BASE_URL 指定对外可访问的地址
config.omsCallback = {
baseUrl: (process.env.OMS_CALLBACK_BASE_URL || '').replace(/\/+$/, ''),
};
// close csrf for easy debugging, please enable it in production if needed
config.security = {
csrf: {
enable: false,
},
};
// sequelize / mysql config,与 sequelize-cli 迁移共用 database/config.js
config.sequelize = {
...db,
define: {
underscored: true,
charset: 'utf8mb4',
dialectOptions: {
collate: 'utf8mb4_unicode_ci',
},
},
pool: {
max: 10,
min: 0,
idle: 10000,
},
};
// 邮件发送(SMTP)配置:未配置 SMTP_HOST 时验证码仅输出到日志,便于本地调试
config.mailer = {
host: process.env.SMTP_HOST || '',
port: Number(process.env.SMTP_PORT || 465),
secure: process.env.SMTP_SECURE !== 'false',
auth: {
user: process.env.SMTP_USER || '',
pass: process.env.SMTP_PASS || '',
},
from: process.env.SMTP_FROM || 'noreply@oms.local',
};
// AI 智能识别(收件人信息解析):与 WMS 复用同一套配置
// 配置项与 WMS 保持一致(config.deepseek = { apiKey, baseUrl }),密钥走 .env 的 DEEPSEEK_API_KEY
// 未配置 apiKey 时相关接口返回 400 并提示配置,不影响其它功能
config.deepseek = {
apiKey: process.env.DEEPSEEK_API_KEY || '',
baseUrl: 'https://api.deepseek.com',
};
// Redis 配置:缓存邮箱验证码等数据,敏感信息建议用环境变量覆盖
config.redis = {
client: {
host: process.env.REDIS_HOST || '127.0.0.1',
port: Number(process.env.REDIS_PORT || 6379),
password: process.env.REDIS_PASSWORD || 'qwe2019',
db: 0,
},
};
// 业务缓存有效期(秒):用户信息、主体信息、可选主体列表
// 主体/用户发生新增或更新时,相关缓存会被主动失效,这里的 TTL 仅作为兜底
config.cache = {
user: Number(process.env.CACHE_TTL_USER || 600),
principal: Number(process.env.CACHE_TTL_PRINCIPAL || 600),
principalOptions: Number(process.env.CACHE_TTL_PRINCIPAL_OPTIONS || 600),
};
// 邮箱验证码限流:同一邮箱发送间隔(秒)与每日发送上限
config.emailCode = {
interval: Number(process.env.EMAIL_CODE_INTERVAL || 60),
dailyLimit: Number(process.env.EMAIL_CODE_DAILY_LIMIT || 10),
};
// JWT 配置:secret 必须通过环境变量 JWT_SECRET 覆盖,切勿使用默认值上生产
// 自动续期:token 剩余有效期小于 renewThreshold 秒时,本次响应头(renewHeader)下发新 token,
// 前端读取该响应头并更新本地存储,活跃用户可无感续期;renewThreshold 设 0 可关闭续期
config.jwt = {
secret: process.env.JWT_SECRET || 'oms-dev-jwt-secret-change-me',
expiresIn: process.env.JWT_EXPIRES_IN || '2h',
renewThreshold: Number(process.env.JWT_RENEW_THRESHOLD || 1800),
renewHeader: process.env.JWT_RENEW_HEADER || 'X-Refresh-Token',
};
// swagger 文档:UI 访问 /swagger-ui.html,JSON 访问 /swagger-doc
config.swaggerdoc = {
dirScanner: './app/controller',
basePath: '/',
apiInfo: {
title: 'OMS API',
description: 'OMS 后端接口文档',
version: '1.0.0',
},
schemes: [ 'http', 'https' ],
consumes: [ 'application/json' ],
produces: [ 'application/json' ],
securityDefinitions: {
apikey: {
type: 'apiKey',
name: 'Authorization',
in: 'header',
},
},
enableSecurity: true,
routerMap: false,
// 生产环境关闭文档
enable: appInfo.env !== 'prod',
};
return {
...config,
};
};