oms/backend/config/config.default.js
liufumingren eaf957ed14 feat(express): 外部打单快递接口、自定义快递编码与回 OMS 取号
- 外部打单平台快递接口:按账号同步平台模板、绑定快递编码、查看模板明细;打开列表只读库,仅「从平台同步数据」时拉取
- 系统管理新增自定义快递编码字典,订单改快递 / 物流下拉合并系统与自定义编码,推送奇门沿用订单上的编码
- 新增 OpenAPI deliveryorder.getwaybill:WMS 批量回取号(单次≤100、并发4、逐单结果),快递编码只取 WMS 报文,取消/作废/归档返回失败,已取号直接复用
- 新增 openapi_request_idempotency 请求级幂等:request_id 回放、报文摘要校验、30 分钟 stale 接管、7 天定时清理
- 外部打单平台订单按平台 fetch_waybill_no 下发 need_oms_waybill,推送时实时判定并回写单据
- 店铺、打单账号平台配置与「平台+编码→模板」绑定走 Redis 缓存,绑定/账号变更主动失效,避免批量推送与取号逐单查库

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
2026-11-04 04:10:37 +08:00

209 lines
8.3 KiB
JavaScript
Raw Permalink 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' ];
// 跨域白名单:生产前后端同源(https://oms.gztbyc.com/api),浏览器不会触发跨域,
// 默认只放行本地开发(vite dev server)与直连后端调试;
// 需要其它来源时用环境变量 CORS_ORIGINS 覆盖(逗号分隔);填 '*' 表示不限制来源(不推荐)
config.cors = {
origins: (
process.env.CORS_ORIGINS ||
'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,
// .xlsx 用于商品批量导入(见 app/controller/product.js importProducts)
whitelist: [ '.jpg', '.jpeg', '.png', '.gif', '.bmp', '.webp', '.svg', '.xlsx' ],
};
// 文件资源存储:按「主体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',
};
// 微信登录网关(公众号网页静默授权):扫码绑定微信 / 扫码登录
// 网关地址与接入凭证在网关管理台创建应用后下发;appKey / appSecret 只保存在服务端,
// 禁止下发到前端或写进二维码内容。开发与生产各自独立的一套应用(互不复用密钥)。
// 未配置 appKey / appSecret 时微信相关接口返回 400 并提示配置,不影响账号密码 / 邮箱验证码登录
config.wechatGateway = {
baseUrl: (process.env.WX_GATEWAY_BASE_URL || 'https://gateway.gztbyc.com').replace(/\/+$/, ''),
appKey: process.env.WX_GATEWAY_APP_KEY || '',
appSecret: process.env.WX_GATEWAY_APP_SECRET || '',
// 调用网关接口的超时时间(毫秒)
timeout: Number(process.env.WX_GATEWAY_TIMEOUT || 8000),
// 临时码 / 扫码会话在本地 Redis 的有效期(秒),与网关临时码默认 10 分钟保持一致
stateTtl: Number(process.env.WX_GATEWAY_STATE_TTL || 600),
// 通知签名允许的时间偏差(毫秒),超出视为重放
notifyTolerance: Number(process.env.WX_GATEWAY_NOTIFY_TOLERANCE || 5 * 60 * 1000),
// 扫码登录二维码申请的频率限制(同一 IP 在窗口内的最大次数),防止刷接口消耗网关临时码配额
loginLimitPerIp: Number(process.env.WX_GATEWAY_LOGIN_LIMIT || 20),
loginLimitWindow: Number(process.env.WX_GATEWAY_LOGIN_LIMIT_WINDOW || 600),
};
// 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 仅作为兜底
// shop / platform 用于推送、取号高频读取的店铺、打单账号与平台配置,避免逐单查库
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),
shop: Number(process.env.CACHE_TTL_SHOP || 300),
platform: Number(process.env.CACHE_TTL_PLATFORM || 300),
};
// 邮箱验证码限流:同一邮箱发送间隔(秒)与每日发送上限
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,
};
};