- 新增 service/wxpay.js:统一下单 / 查询订单 / 关闭订单 / APIv2 验签,二维码在服务端本地生成 SVG - 新增 pay/wechat.js 与 XML 编解码,公开回调 POST /api/pay/wechat/notify - 订单:同主体 + 同套餐复用未超时待支付单;2 小时超时关单;回调 / 查单 / 手工确认统一走 payNotify - 迁移 subject_orders 增加 code_url / prepay_id 等字段,配置项 WXPAY_* - 前端续期弹窗展示二维码并按 2s 轮询支付结果 - 文档与测试同步更新 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
342 lines
18 KiB
JavaScript
342 lines
18 KiB
JavaScript
'use strict';
|
||
|
||
const path = require('path');
|
||
|
||
const { env } = process;
|
||
|
||
/**
|
||
* 默认配置(所有环境生效),按环境差异请放到 config.{env}.js 覆盖
|
||
* @param {Egg.EggAppInfo} appInfo app 信息
|
||
*/
|
||
module.exports = (appInfo) => {
|
||
const config = (exports = {});
|
||
|
||
// cookie/session 签名用的 key,生产环境请改成随机字符串
|
||
config.keys = `${appInfo.name}_1729000000000_1971`;
|
||
|
||
// 部署在 nginx 后面:信任 X-Forwarded-Proto / X-Forwarded-For,
|
||
// 否则 ctx.origin / ctx.protocol 会一直认为是 http,二维码、邮件链接会拼成 http://
|
||
config.proxy = true;
|
||
|
||
// ==================== 站点/产品名 ====================
|
||
// 页标题、品牌位、邮件正文都用它 —— **改名字只改这里**(或设环境变量 SITE_NAME)
|
||
config.siteName = env.SITE_NAME || '云仓视频溯源系统';
|
||
|
||
// 中间件(app/middleware/xxx.js 后写 'xxx')
|
||
// cors:跨域头(小程序 H5 预览直连后端用;鉴权只靠 header 令牌,不依赖 cookie)
|
||
// errorHandler:接口异常统一返回 JSON
|
||
// frontend:**后端不渲染页面** —— 开发时把页面请求反代给前端 dev server,生产时托管前端构建产物
|
||
config.middleware = [ 'cors', 'errorHandler', 'frontend' ];
|
||
|
||
// ==================== 跨域 ====================
|
||
// `'*'` = 回显任意 Origin;需要收紧就设 CORS_ORIGINS=http://127.0.0.1:7301,https://trace.example.com
|
||
config.cors = {
|
||
enable: !/^(0|false|no|off)$/i.test(String(env.CORS_ENABLE === undefined ? 'true' : env.CORS_ENABLE)),
|
||
origins: String(env.CORS_ORIGINS || '*')
|
||
.split(',')
|
||
.map(value => value.trim())
|
||
.filter(Boolean),
|
||
};
|
||
|
||
// ==================== 安装包分发(软件自动更新) ====================
|
||
// 打包脚本会把产物放进按平台划分的子目录:
|
||
// - 桌面端 desktop/installer/build.ps1
|
||
// MSI → app/public/download/desktop/ (egg-static 提供 /download/desktop/*.msi,长缓存)
|
||
// version.json → app/public/version/desktop/ (**不在静态目录里**,由 controller/download.js 提供,
|
||
// 因为 koa-static 命中后不 next(),改不了缓存头)
|
||
// - Android backend/android_client/build.ps1
|
||
// APK → app/public/download/android_client/ (/download/android_client/*.apk)
|
||
// version.json → app/public/version/android_client/
|
||
// 桌面端软件启动时请求 GET /download/version.json 判断是否有新版本(路径不能改,老客户端写死了)。
|
||
config.static = {
|
||
prefix: '/download/',
|
||
dir: path.join(appInfo.baseDir, 'app/public/download'),
|
||
// 这里只会放“文件名带版本号”的 MSI / APK,内容永不变 → 可以放心长缓存
|
||
maxAge: 31536000,
|
||
buffer: false, // MSI / APK 几十 MB,流式发送
|
||
};
|
||
|
||
// ==================== Chrome 插件(集中配置) ====================
|
||
// 插件只拉取执行:`GET /api/web/extension/config`(公开只读,内容由平台管理员在
|
||
// `/api/web/admin/extension` 维护,存 sys_config 的 group=extension)。
|
||
// `appKey` 非空时要求 `?key=` 一致(env `EXTENSION_APP_KEY`),防止站点清单被随便抓走;
|
||
// 不设就完全公开(内网部署的常见做法)。
|
||
config.extension = {
|
||
appKey: env.EXTENSION_APP_KEY || '',
|
||
};
|
||
|
||
// ==================== 前端入口(页面不在后端渲染) ====================
|
||
// 开发(env=local):页面请求(非 /api、/health)反代到前端 dev server(frontend/ 里 npm run dev)
|
||
// 生产:直接托管前端构建产物 dist(SPA 深链回退到 index.html)
|
||
// 联调时只开一个地址:打开 http://127.0.0.1:7300 就是前端页面
|
||
config.frontend = {
|
||
enable: !/^(0|false|no|off)$/i.test(String(env.FRONTEND_ENABLE || 'true')),
|
||
devServer: env.FRONTEND_DEV_SERVER || 'http://127.0.0.1:7301',
|
||
distDir: env.FRONTEND_DIST || path.join(appInfo.baseDir, '../frontend/dist'),
|
||
};
|
||
|
||
// ==================== 运维/内部接口鉴权 ====================
|
||
// 对应 app/middleware/internal_auth.js:
|
||
// - token:给运维脚本 / 后台系统用(header `X-Internal-Token`);**不配则一律不认**
|
||
// - adminIds:允许访问内部接口的账号 id(user JWT 的 sub),默认 [1](内置管理员)
|
||
config.internal = {
|
||
token: env.INTERNAL_TOKEN || '',
|
||
adminIds: String(env.INTERNAL_ADMIN_IDS || '1')
|
||
.split(',')
|
||
.map(value => Number(value.trim()))
|
||
.filter(id => Number.isInteger(id) && id > 0),
|
||
};
|
||
|
||
// ==================== 协议(登录前同意) ====================
|
||
// 三张表:agreements / agreement_versions / user_agreements(见 database/migrations)
|
||
// enforce:
|
||
// 'mini_program'(默认)→ 只有声明 client=mini_program 的登录必须带当前协议版本
|
||
// 'all' → 所有客户端都必须(Web 登录表单也要先接入协议,否则会被 428 拦住)
|
||
// 'off' → 不校验(仍会记录主动提交的同意版本)
|
||
config.agreement = {
|
||
enforce: String(env.AGREEMENT_ENFORCE || 'mini_program').trim().toLowerCase(),
|
||
};
|
||
|
||
// ==================== 主体(租户)====================
|
||
// 新建主体默认赠送的试用天数(app/service/subject.js 用)
|
||
config.subject = {
|
||
trialDays: Number(env.SUBJECT_TRIAL_DAYS || 7),
|
||
// 主体状态(过期 / 停用)缓存秒数:设备心跳与上报判断都读它,续期后由写库方主动失效
|
||
stateCacheTtl: Number(env.SUBJECT_STATE_CACHE_TTL || 30),
|
||
};
|
||
|
||
// ==================== 服务端口 ==================== // 本地默认 **7300**(曾用 7001;避免与别的项目撞,也方便和前端 7301 排在一起)
|
||
// 临时换口:PORT=7400 npm run dev(PowerShell:$env:PORT=7400; npm run dev)
|
||
config.cluster = {
|
||
listen: {
|
||
port: Number(env.PORT || 7300),
|
||
},
|
||
};
|
||
|
||
// 多实例并存时用 LOG_DIR 把日志分到不同目录
|
||
// (具体生效位置见文件末尾:这里先不设,避开下面的 config.logger 赋值)
|
||
|
||
// ==================== 安全 ====================
|
||
// 前端是 SPA + **header 令牌**,后端没有任何基于 cookie/session 的表单:
|
||
// CSRF 保护(只对 cookie 会话有意义)整个关掉,登录响应里那个多余的 csrfToken cookie 也随之消失。
|
||
config.security = {
|
||
csrf: {
|
||
enable: false,
|
||
},
|
||
};
|
||
|
||
// ==================== MySQL ====================
|
||
// ==================== MySQL(Sequelize ORM) ====================
|
||
// 模型定义在 app/model/ 下,通过 app.model.User / ctx.model.User 访问
|
||
config.sequelize = {
|
||
dialect: 'mysql',
|
||
host: env.MYSQL_HOST || '127.0.0.1',
|
||
port: Number(env.MYSQL_PORT || 3307),
|
||
// 注意:账号名大小写敏感,必须是 packservice
|
||
username: env.MYSQL_USER || 'packservice',
|
||
// 密码不要写在这里,放 config.local.js 或环境变量 MYSQL_PASSWORD
|
||
password: env.MYSQL_PASSWORD || '',
|
||
database: env.MYSQL_DATABASE || 'packservice',
|
||
// 固定时区,避免服务器时区不同导致时间偏移
|
||
timezone: '+08:00',
|
||
charset: 'utf8mb4',
|
||
define: {
|
||
// 表名用单数形式(不自动加 s)
|
||
freezeTableName: true,
|
||
// 驼峰属性映射到下划线字段
|
||
underscored: true,
|
||
createdAt: 'created_at',
|
||
updatedAt: 'updated_at',
|
||
},
|
||
pool: {
|
||
max: Number(env.MYSQL_POOL_SIZE || 10),
|
||
min: 0,
|
||
acquire: 30000,
|
||
idle: 10000,
|
||
},
|
||
// 需要打印 SQL 时改成 console.log(或自定义 logger)
|
||
logging: false,
|
||
// 只读从库 / 多数据源可改用 datasources 配置
|
||
};
|
||
|
||
// ==================== Redis ====================
|
||
config.redis = {
|
||
client: {
|
||
host: env.REDIS_HOST || '127.0.0.1',
|
||
port: Number(env.REDIS_PORT || 6379),
|
||
// 无密码必须显式写 null
|
||
password: env.REDIS_PASSWORD || null,
|
||
db: Number(env.REDIS_DB || 0),
|
||
// 弱依赖:Redis 仅作缓存时,启动不阻塞
|
||
weakDependent: true,
|
||
},
|
||
};
|
||
|
||
// ==================== JWT(扫描器长期令牌) ====================
|
||
// 扫描器注册/登录时下发长期 JWT,后续调用本服务时带 Authorization: Bearer <token>
|
||
config.jwt = {
|
||
// 签名密钥:生产环境必须用环境变量 JWT_SECRET 注入(未设置时下面直接抛错)
|
||
secret: env.JWT_SECRET || 'pack-service-dev-secret-please-change',
|
||
issuer: 'pack-service',
|
||
audience: 'scanner',
|
||
// 扫描器令牌有效期(长期),支持 '365d' / '10y' / 秒数
|
||
scannerExpiresIn: env.SCANNER_JWT_EXPIRES || '365d',
|
||
// 设备扫码登录(GET /api/device/login)下发令牌的**默认时长,同时也是上限**:
|
||
// 设备可以用 ?expiresIn=30d 申请更短的,但不能比它长(要整体放宽就改这个)
|
||
deviceExpiresIn: env.DEVICE_JWT_EXPIRES || env.SCANNER_JWT_EXPIRES || '365d',
|
||
// 刷新令牌有效期(不透明随机串,库里只存 sha256)。每次刷新都会轮换并顺延;
|
||
// 默认 2 年:只要服务在跑就会持续续期,停用超过这个时间才需要重新激活。
|
||
deviceRefreshExpiresIn: env.DEVICE_REFRESH_EXPIRES || '730d',
|
||
// 用户令牌有效期(扫码登录 / 前端接口用的 JWT)
|
||
userExpiresIn: env.USER_JWT_EXPIRES || '7d',
|
||
};
|
||
|
||
if (!env.JWT_SECRET && appInfo.env === 'prod') {
|
||
throw new Error('[config] 生产环境必须通过环境变量 JWT_SECRET 指定 JWT 签名密钥');
|
||
}
|
||
|
||
// ==================== 支付(续期订单) ====================
|
||
// 真实支付渠道还没接:先把「订单 + 支付通知回调」的契约定下来,
|
||
// 渠道接入后只要按同样格式回调 `POST /api/pay/notify` 即可完成续期。
|
||
config.pay = {
|
||
// 模拟模式:允许不带签名直接回调(仅开发/测试;生产默认关闭,需要显式 PAY_MOCK=true)
|
||
mock: env.PAY_MOCK === undefined
|
||
? appInfo.env !== 'prod'
|
||
: !/^(0|false|no|off)$/i.test(String(env.PAY_MOCK)),
|
||
// 回调签名密钥(HMAC-SHA256);配了就必须带 X-Pay-Sign
|
||
callbackSecret: env.PAY_CALLBACK_SECRET || '',
|
||
// 每天默认价格(0 = 不校验金额,方便内部测试)
|
||
amountPerDay: Number(env.PAY_AMOUNT_PER_DAY || 0),
|
||
// 待支付订单有效期(秒,默认 2 小时):超时自动关闭(status=2),之后的回调/手工确认一律 409。
|
||
// 与微信扫码支付二维码 2 小时有效期对齐:二维码失效了,订单也不该还能付。
|
||
orderTtl: Number(env.PAY_ORDER_TTL || 7200),
|
||
};
|
||
|
||
// ==================== 微信支付(Native 扫码支付 / APIv2) ====================
|
||
// 文档:https://pay.weixin.qq.com/doc/v2/merchant/4011936530(统一下单)
|
||
// 流程:下单 → 统一下单拿 code_url → 前端展示二维码 → 用户微信扫码支付
|
||
// → 微信回调 `POST /api/pay/wechat/notify`(XML)→ `service.subjectOrder.payNotify()` 续期。
|
||
// ⚠️ 凭证由发布脚本上传到服务器(`config/env.prod.sh`,仓库里先留空);
|
||
// appId / mchId / apiKey 缺任意一项 = 未开通:仍然能建单,只是没有二维码(前端提示联系管理员)。
|
||
config.wxpay = {
|
||
// 临时停用(凭证齐全也可以先关掉):WXPAY_ENABLED=false
|
||
enabled: !/^(0|false|no|off)$/i.test(String(env.WXPAY_ENABLED === undefined ? 'true' : env.WXPAY_ENABLED)),
|
||
// Native 支付用的 appid(先在「商户平台 → 产品中心 → AppID 账号管理」把公众号/小程序 appid 关联到商户号)
|
||
appId: env.WXPAY_APP_ID || '',
|
||
// 商户号
|
||
mchId: env.WXPAY_MCH_ID || '',
|
||
// APIv2 密钥(商户平台 → 账户中心 → API 安全 → 设置 APIv2 密钥),下单签名与回调验签都用它
|
||
apiKey: env.WXPAY_API_KEY || '',
|
||
// 回调地址(必须是公网 https,不带参数);不配则用 SITE_URL/api/pay/wechat/notify
|
||
notifyUrl: env.WXPAY_NOTIFY_URL || '',
|
||
// 统一下单/查单/关单接口地址(切沙箱时改这里)
|
||
apiBase: String(env.WXPAY_API_BASE || 'https://api.mch.weixin.qq.com').replace(/\/+$/, ''),
|
||
// 签名类型:MD5(默认)/ HMAC-SHA256
|
||
signType: env.WXPAY_SIGN_TYPE || 'MD5',
|
||
// 商品描述(微信要求 ≤128 字节);不配则用「站点名-套餐名」
|
||
body: env.WXPAY_BODY || '',
|
||
// 调微信接口的超时(毫秒)
|
||
timeout: Number(env.WXPAY_TIMEOUT || 8000),
|
||
// 二维码(本地画 SVG,零外链):单元格像素 / 静默区格数(QR 规范建议 ≥ 4)
|
||
qrCellSize: Number(env.WXPAY_QR_CELL || 6),
|
||
qrMargin: Number(env.WXPAY_QR_MARGIN || 4),
|
||
};
|
||
|
||
// ==================== 业务配置 ====================
|
||
config.cache = {
|
||
// 缓存 key 前缀,多项目共用一个 Redis 时用来隔离
|
||
prefix: env.CACHE_PREFIX || 'packs:',
|
||
// 默认过期时间(秒)
|
||
ttl: Number(env.CACHE_TTL || 300),
|
||
};
|
||
|
||
// 跨网取流的分片上传是**原始字节流**(不是 JSON),必须跳过 bodyParser,
|
||
// 否则请求体会被解析成空,控制器里读 ctx.req 也拿不到数据(或直接超时)。
|
||
config.bodyParser = {
|
||
ignore: ctx => /^\/api\/scanner\/tasks\/[^/]+\/upload$/.test(ctx.path),
|
||
};
|
||
|
||
// 登录页的自助注册(生产环境建议关掉:REGISTER_ENABLED=false,改用 npm run user:pass 建号)
|
||
config.register = {
|
||
enable: !/^(0|false|no|off)$/i.test(String(env.REGISTER_ENABLED || 'true')),
|
||
};
|
||
|
||
// ==================== 邮件 / 邮箱验证码(注册时需要验证邮箱) ====================
|
||
config.email = {
|
||
// 未配置 SMTP_HOST 时走开发模式:验证码写日志并在注册页回显(仅本地/测试用)
|
||
// ⚠️ 生产环境(env=prod)永远不启用 devMode,避免把验证码 / 重置链接回传给前端
|
||
devMode: appInfo.env !== 'prod' && !env.SMTP_HOST,
|
||
// 发件人显示名用站点名(邮箱域名保持 pack-service.local,技术标识不动)
|
||
from: env.SMTP_FROM || `${config.siteName} <no-reply@pack-service.local>`,
|
||
smtp: {
|
||
host: env.SMTP_HOST || null,
|
||
port: Number(env.SMTP_PORT || 465),
|
||
secure: String(env.SMTP_SECURE || 'true') !== 'false',
|
||
user: env.SMTP_USER || null,
|
||
password: env.SMTP_PASSWORD || null,
|
||
},
|
||
// 验证码有效期(秒)/ 重发间隔(秒)/ 同一个验证码最多试几次
|
||
codeTtl: Number(env.EMAIL_CODE_TTL || 600),
|
||
resendInterval: Number(env.EMAIL_CODE_RESEND || 60),
|
||
maxAttempts: Number(env.EMAIL_CODE_ATTEMPTS || 5),
|
||
// 每个邮箱每天最多发几封验证码 / 重置邮件(跨场景共享,超出要等第二天)
|
||
dailyLimit: Number(env.EMAIL_DAILY_LIMIT || 10),
|
||
// 重置密码链接有效期(秒,默认 30 分钟)
|
||
resetTtl: Number(env.EMAIL_RESET_TTL || 1800),
|
||
// 邮件里链接用的站点地址(不配就用请求里的 host)
|
||
siteUrl: env.SITE_URL || '',
|
||
};
|
||
|
||
// ==================== 设备扫码登录(6 位串码 + 手机页确认) ====================
|
||
// ⚠️ 登录页扫码登录 / 绑定微信都改走微信登录网关(见下面的 config.wxGateway),
|
||
// 这里只剩「设备扫码登录」(`/api/device/login`)用到:串码、二维码、长轮询。
|
||
config.wechat = {
|
||
// 扫码串码:长度、二维码内容里的 spm 格式(`{code}` 占位)
|
||
codeLength: Number(env.WECHAT_CODE_LENGTH || 6),
|
||
spmPattern: env.WECHAT_SPM_PATTERN || '1.0.{code}.1',
|
||
// 二维码(本地生成 SVG,不引用任何第三方图片):单元格像素、静默区格数(QR 规范建议 ≥ 4)
|
||
qrCellSize: Number(env.WECHAT_QR_CELL || 6),
|
||
qrMargin: Number(env.WECHAT_QR_MARGIN || 4),
|
||
// 扫码状态(二维码)有效期(秒)
|
||
stateTtl: Number(env.WECHAT_STATE_TTL || 600),
|
||
// 长轮询最长挂起秒数(默认 60s;前端建议再留一点自己的超时,比如 +10s)
|
||
pollWait: Number(env.WECHAT_POLL_WAIT || 60),
|
||
};
|
||
|
||
// ==================== 微信登录网关(扫码登录 / 绑定微信) ====================
|
||
// 文档:https://gateway.gztbyc.com/#/docs
|
||
// 流程:应用服务端申请临时码 → 前端画成二维码 → 用户微信扫码确认 →
|
||
// 网关带签名 POST 通知本服务(`config.wxGateway.notifyPath`)→ 本服务落地
|
||
// (签发令牌 / 写绑定关系 / 扫码登入工作台)。
|
||
// ⚠️ 不配 appKey/appSecret 时这些功能一律返回 503,登录页自动隐藏扫码入口。
|
||
config.wxGateway = {
|
||
baseUrl: String(env.WX_GATEWAY_BASE || 'https://gateway.gztbyc.com').replace(/\/+$/, ''),
|
||
appKey: env.WX_GATEWAY_APP_KEY || '',
|
||
appSecret: env.WX_GATEWAY_APP_SECRET || '',
|
||
// 调网关接口的超时(毫秒)
|
||
timeout: Number(env.WX_GATEWAY_TIMEOUT || 8000),
|
||
// 本地扫码会话有效期(秒):网关临时码是 10 分钟,这里比它略长,收到通知时还有落脚点
|
||
sceneTtl: Number(env.WX_GATEWAY_SCENE_TTL || 660),
|
||
// 长轮询最长挂起秒数(前端自己再留一点超时,比如 +10s)
|
||
pollWait: Number(env.WX_GATEWAY_POLL_WAIT || 55),
|
||
// 通知里 timestamp 允许的偏差(秒):文档建议 5 分钟
|
||
notifySkew: Number(env.WX_GATEWAY_NOTIFY_SKEW || 300),
|
||
// 必须在网关管理台把这个路径配成「服务端通知地址」(只用于提示/自检)
|
||
notifyPath: '/api/wechat-gateway/notify',
|
||
};
|
||
|
||
// 日志(生产建议按需调整)
|
||
config.logger = {
|
||
consoleLevel: 'INFO',
|
||
};
|
||
|
||
// 多实例并存时用 LOG_DIR 把日志分到不同目录,免得到处翻同一个日志文件
|
||
// 例(PowerShell):$env:PORT=7400; $env:LOG_DIR='logs-test'; npm run dev
|
||
// ⚠️ 必须写在上面 config.logger 赋值之后,否则会被整个覆盖掉
|
||
if (env.LOG_DIR) {
|
||
config.logger.dir = path.resolve(appInfo.baseDir, env.LOG_DIR);
|
||
}
|
||
|
||
return config;
|
||
};
|