oms/backend/config/config.default.js
liufumingren 8597cf5ac9 feat(backend): 用户鉴权、菜单权限、主体与系统基础模块
- 登录/邮箱验证码/密码流程(controller/auth.js、lib/emailCode.js、middleware/jwt_auth.js)
- 主体(principal)隔离与主体用户、对外接口配置模块及 principalCheck 中间件
- 菜单、用户、文件上传、快递公司字典(express_companies)等基础模块
- 通用工具:分页(lib/pagination.js)、缓存(service/cache.js)
- 全量接口契约(contract/index.js)与路由注册(router.js)、config.default.js 配置
- 相关迁移:菜单组件调整与菜单种子、创建 files 表
2026-09-13 02:23:34 +08:00

158 lines
5.0 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';
// 全局中间件:requestLog 记录请求日志(洋葱模型,在响应阶段读取用户信息)
config.middleware = [ 'requestLog' ];
// 请求日志配置
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 覆盖,切勿使用默认值上生产
config.jwt = {
secret: process.env.JWT_SECRET || 'oms-dev-jwt-secret-change-me',
expiresIn: process.env.JWT_EXPIRES_IN || '2h',
};
// 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,
};
};