架构核心

警告

默认请求前缀统一为/api，禁止修改，公共请求默认统一前缀为/api/common

目录释义&命名规范

┌─doc ------------------------------ 项目相关文档目录
├─hc-base -------------------------- 基础模块
├─hc-mybatis ----------------------- Mybatis模块
├─hc-redis ------------------------- Redis模块
├─hc-sdk-aliyunoss ----------------- [SDK] 阿里云OSS模块
├─hc-sdk-aliyunsms ----------------- [SDK] 阿里云短信模块
├─hc-sdk-huaweicloudobs ------------ [SDK] 华为云OBS模块
├─hc-sdk-huaweicloudsms ------------ [SDK] 华为云短信模块
├─hc-sdk-wxmp ---------------------- [SDK] 微信公众号模块
├─hc-service-main ------------------ 核心功能模块
│  │src
│  │  ├─main
│  │  │  ├─java/pro/haichuang/framework/service/项目Code
│  │  │  │  ├─config -------------------- 配置文件目录(ex.##Config)
│  │  │  │  │  ├─properties --------------YAML配置文件映射目录(ex.##Properties)
│  │  │  │  │  ├─runner ----------------- 自启动类目录(ex.##Runner)
│  │  │  │  │  ├─socket ----------------- Socket类目录(ex.##Socket)
│  │  │  │  │  ├─timing ----------------- 定时任务类目录(ex.##Scheduling|Timing)
│  │  │  │  │  └─ExampleConfig.java ----- 其他配置类(ex.##Config)
│  │  │  │  ├─constant ------------------ 常量目录(ex.##Constant或##Const)
│  │  │  │  ├─controller ---------------- Controller目录
│  │  │  │  │  ├─app ------------------------ APP接口目录(ex.App##Controller)
│  │  │  │  │  ├─cms ------------------------ 后台管理系统接口目录(ex.Cms##Controller)
│  │  │  │  │  ├─common --------------------- 公共接口目录(ex.Common##Controller, 子目录结构参考当前目录结构)
│  │  │  │  │  ├─mina ----------------------- 小程序接口目录(ex.Mina##Controller)
│  │  │  │  │  ├─mobile --------------------- 手机端页面接口目录(ex.Mobile##Controller)
│  │  │  │  │  ├─mp ------------------------- 微信公众号接口目录(Mp##Controller)
│  │  │  │  │  └─pc ------------------------- 电脑端页面接口目录(Pc##Controller)
│  │  │  │  ├─enums --------------------- 枚举目录(ex.##Enum)
│  │  │  │  ├─key ----------------------- Key目录(ex.##Key)
│  │  │  │  ├─mapper -------------------- Mapper目录(可拆分包)
│  │  │  │  ├─pojo ---------------------- POJO目录
│  │  │  │  │  ├─domain --------------------- 实体类目录(ex.##DO)
│  │  │  │  │  ├─dto ------------------------ DTO目录(ex.##DTO)
│  │  │  │  │  ├─request -------------------- 请求目录(ex.##Request或##Req)
│  │  │  │  │  └─vo ------------------------- 响应目录(ex.##VO)
│  │  │  │  ├─service ------------------- Service目录(ex.##Service, 可拆分包)
│  │  │  │  │  └─impl ----------------------- ServiceImpl目录(ex.##ServiceImpl)
│  │  │  │  ├─util ---------------------- 工具类目录
│  │  │  │  └─ServiceApplication.java -- 启动文件
│  │  │  └─resources
│  │  │    └─pro/haichuang/framework/service/项目code/mapper ----- Mapper对应Xml文件目录(需要手动将mapper包下的Xml移动到此目录)
│  │  │    application.yml ------------- 核心配置文件
│  │  │    application-dev.yml --------- 开发/测试环境配置文件
│  │  │    application-prod.yml -------- 生产环境配置文件
│  │  │    application-local.yml ------- 本地环境配置文件
│  │  │    application-publish.yml ----- 演示环境配置文件
│  │  └─test
│  │      └─java/pro/haichuang/framework/service/项目Code
│  │          └─CodeGenerateTest.java -- 代码生成器示例
│  └─pom.xml --------------------------- 核心Pom文件
│  pom.xml ------------------------ 版本控制
└─ README.md ---------------------- 统一开发文档