Asone 开发者文档Asone 开发者文档
  • 项目架构
  • 技术栈
  • 目录结构
  • 本地启动
  • 新增功能
  • 开发规范
  • 数据库
  • 图表语法
  • 部署
  • 文档同步规则
  • 相关文档
  • 项目架构
  • 技术栈
  • 目录结构
  • 本地启动
  • 新增功能
  • 开发规范
  • 数据库
  • 图表语法
  • 部署
  • 文档同步规则
  • 相关文档
  • 新增功能
    • 新增业务域
    • 新增接口
    • 新增前端页面
    • 其他常见改动

新增功能

这一节回答「我要加的这些东西应该放在哪、按什么顺序做」。开始前先确认两件事:

  1. 属于哪个业务域。跨域复用的能力一律下沉到 asone-server-system,业务模块之间不互相依赖。
  2. 项目里是否已有同类能力。优先复用现有模块与已有依赖(dayjs、RestClient、springdoc、MyBatis-Plus 分页),不引入功能重叠的新库。

落位速查

图 1 · 我要加的东西放哪
我要做的事放在哪详细步骤
新增一个业务域 / Maven 模块asone-server/asone-module-xxx + src/pages/Xxx新增业务域
新增一个后端接口业务模块 controller / service / mapper / model新增接口
新增一个前端页面src/pages/<域>/<功能> + config/routes/<域>Routes.ts新增前端页面
新增定时任务业务模块 task/ 加 @XxlJob,再到调度中心登记其他常见改动
新增数据导出业务模块 export/ 实现 ExportTaskHandler其他常见改动
接入新广告渠道asone-module-channel-report/config + 模块 docs/其他常见改动
新增权限点 / 菜单后端 hasAuthority 字符串 + src/constants/permissions.ts + 后台菜单管理其他常见改动
新增接口文案模块 i18n/messages-xxx*.properties + 前端 src/locales/{zh-CN,en-US}其他常见改动
表结构变更直接改 docs/developer-docs/docs/public/1-ddl.sql数据库
全局异常码asone-server-system/constants/ResponseCodeEnum其他常见改动

改动前后的固定动作

  • 动手前:按目录结构确认落位,不新开与现有约定并列的目录。
  • 编码时:遵守开发规范,只用当前版本未废弃的 API。
  • 提交前:后端 mvn compile、前端 pnpm lint(Biome + tsc + i18n-check + 脚本测试),数据库只做只读查询。
  • 提交时:按提交与代码质量写 Conventional Commits 中文信息,无关改动拆成多个提交。
  • 若本次改动引入了新技术栈、新模块、新目录或新的部署方式:同步更新本站页面,见文档同步规则。