packServer/backend/config/config.default.js
liufumingren bd2363bf00 chore: 初始化仓库(backend / frontend / extension 三块)
- backend/:Egg 3 纯 JSON 接口服务(MySQL 8 + Redis),全部走 header 令牌鉴权;
  已彻底去掉服务端渲染(删除 page 控制器 / app/view / nunjucks / session / CSRF),
  开发时把页面请求反代到前端 dev server,生产托管 frontend/dist(SPA 回退)。
  单测 91 个通过(不需要本机数据库)。
- frontend/:Vite + Vue3 + TypeScript 的 SPA(登录 / 注册 / 找回密码 / 扫码登录与确认 /
  首页统计 / 设备管理 / 扫码记录 / 个人中心 / 测试页),vue-tsc 类型检查与构建通过。
- extension/:MV3 浏览器扩展(零构建),注入第三方 WMS 页面识别运单号并打开溯源页。
- 忽略规则统一放根 .gitignore:node_modules、dist、logs / logs-*、run、typings、
  .env*、config.local.js(含本机数据库与 Redis 密码,绝不入库)。
2026-10-17 08:50:32 +08:00

207 lines
9.1 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';
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`;
// ==================== 站点/产品名 ====================
// 页标题、品牌位、邮件正文都用它 —— **改名字只改这里**(或设环境变量 SITE_NAME)
config.siteName = env.SITE_NAME || '云仓视频溯源系统';
// 中间件(app/middleware/xxx.js 后写 'xxx')
// errorHandler:接口异常统一返回 JSON
// frontend:**后端不渲染页面** —— 开发时把页面请求反代给前端 dev server,生产时托管前端构建产物
config.middleware = [ 'errorHandler', 'frontend' ];
// ==================== 前端入口(页面不在后端渲染) ====================
// 开发(env=local):页面请求(非 /api、/health)反代到前端 dev server(frontend/ 里 npm run dev)
// 生产:直接托管前端构建产物 dist(SPA 深链回退到 index.html)
// 联调时只开一个地址:打开 http://127.0.0.1:7001 就是前端页面
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),
};
// ==================== 服务端口 ====================
// 本地默认 7001;“专用测试端口”用 `npm run dev:test`(egg-bin dev --port 7300)
// 也可临时覆盖:PORT=7300 npm run dev(PowerShell:$env:PORT=7300; npm run dev)
config.cluster = {
listen: {
port: Number(env.PORT || 7001),
},
};
// 多实例并存时用 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',
// 用户令牌有效期(扫码登录 / 前端接口用的 JWT)
userExpiresIn: env.USER_JWT_EXPIRES || '7d',
};
if (!env.JWT_SECRET && appInfo.env === 'prod') {
throw new Error('[config] 生产环境必须通过环境变量 JWT_SECRET 指定 JWT 签名密钥');
}
// ==================== 业务配置 ====================
config.cache = {
// 缓存 key 前缀,多项目共用一个 Redis 时用来隔离
prefix: env.CACHE_PREFIX || 'packs:',
// 默认过期时间(秒)
ttl: Number(env.CACHE_TTL || 300),
};
// 登录页的自助注册(生产环境建议关掉: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 时走开发模式:验证码写日志并在注册页回显(仅本地/测试用)
devMode: !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),
// 重置密码链接有效期(秒,默认 30 分钟)
resetTtl: Number(env.EMAIL_RESET_TTL || 1800),
// 邮件里链接用的站点地址(不配就用请求里的 host)
siteUrl: env.SITE_URL || '',
};
// ==================== 微信扫码登录(登录页右上角三角形切换) ====================
config.wechat = {
// 微信开放平台「网站应用」的 appid / secret;不配则二维码退化为本地演示码
appid: env.WECHAT_APPID || '',
secret: env.WECHAT_SECRET || '',
// 扫码回调地址(不配就按当前请求的 origin 自动拼 /login/wechat/callback)
redirectUri: env.WECHAT_REDIRECT_URI || '',
// 微信接口地址(默认官方;自建网关/联调时可改,如 http://127.0.0.1:7099)
apiBase: env.WECHAT_API_BASE || 'https://api.weixin.qq.com',
// 扫码串码:长度、二维码内容里的 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),
};
// 日志(生产建议按需调整)
config.logger = {
consoleLevel: 'INFO',
};
// 多实例并存时用 LOG_DIR 把日志分到不同目录,免得到处翻同一个日志文件
// 例(PowerShell):$env:LOG_DIR='logs-test'; npm run dev:test
// ⚠️ 必须写在上面 config.logger 赋值之后,否则会被整个覆盖掉
if (env.LOG_DIR) {
config.logger.dir = path.resolve(appInfo.baseDir, env.LOG_DIR);
}
return config;
};