You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
sims-order-lxzy/README.md

190 lines
5.7 KiB

12 months ago
# 订单项目使用说明
### 打包说明
- **dxhy-consumer** `[订单+基础服务+销项后台合并jar包]`
- **sims-base-consumer** `[基础服务jar包]`
- **sims-order-consumer** `[订单jar包]`
- **sims-back-consumer** `[后台jar包]`
***
***
# 业务模块
## 通用模块
### sims-base-thirdservice(通用中间件)
- **aop** `[所有controller异常统一拦截器]`
- **config** `[中间件需要加载的配置文件入口]`
- **filter** `[拦截器(防sql注入)]`
- **module** `[第三方中间件配置或通用调用平台级服务入口]`
- **base** `[文件下载,生成ID,敏感词]`
- **thirdservice** `[第三方和中间件]`
- **filestore** `[文件存储]`
- **itax** `[大B通知和日志]`
- **mongodb** `[MongoDB]`
- **openapi** `[开放平台接口]`
- **rabbitmq** `[队列操作相关]`
- **redis** `[redis相关]`
***
***
## 订单模块
### order-management-base-service(订单通用模块)
- **annotation** `[日志拦截注解]`
- **config** `[订单配置读取]`
- **constant** `[静态文件和枚举文件]`
- **exception** `[异常文件]`
- **model** `[业务数据交互使用到的bean]`
- **utils** `[基础服务使用到的工具类]`
***
### order-management-invoice(订单发票模块)
- **config** `[订单发票配置读取]`
- **model** `[订单发票业务数据交互使用到的bean]`
- **module** `[订单发票业务模块]`
- **invoice** `[订单发票业务]`
- **invoicespecial** `[订单红字信息表业务]`
- **rabbitmq** `[订单发票队列业务]`
- **utils** `[订单发票业务使用到的工具类]`
***
### order-management-invoice-sender(订单发票邮寄模块)
- **config** `[订单发票配置读取]`
- **module** `[订单发票业务模块]`
- **sender** `[订单发票邮寄业务]`
***
### sims-base-service(订单基础业务模块)
- **aop** `[业务拦截]`
- **config** `[随服务启动或者一些初始化的中间件操作]`
- **job** `[基于xxl进行的定时任务]`
- **modules** `[核心部分,所有对外业务模块]`
- **base** `[基础业务]`
- **...** `[其他业务]`
- **openapi** `[基础对外接口部分]`
- **utils** `[工具类]`
***
### order-management-order(订单业务模块)
- **aop** `[业务拦截]`
- **config** `[随服务启动或者一些初始化的中间件操作]`
- **constant** `[基础服务静态文件和枚举文件]`
- **dao** `[数据库持久层]`
- **handle** `[基于xxl进行的定时任务]`
- **model** `[业务数据交互使用到的bean]`
- **modules** `[核心部分,所有对外业务模块]`
- **bigdata** `[调用大数据业务]`
- **...** `[其他业务]`
- **openapi** `[订单对外接口部分]`
- **utils** `[工具类]`
***
***
## 后台模块
### sims-back-common(后台通用模块)
- **constant** `[静态文件和枚举文件]`
- **exception** `[异常文件]`
- **model** `[业务数据交互使用到的bean]`
- **utils** `[工具类]`
***
### order-management-order(订单业务模块)
- **aop** `[业务拦截]`
- **api** `[对外接口部分]`
- **config** `[随服务启动或者一些初始化的中间件操作]`
- **constant** `[基础服务静态文件和枚举文件]`
- **job** `[基于xxl进行的定时任务]`
- **mapper** `[数据库持久层]`
- **model** `[业务数据交互使用到的bean]`
- **modules** `[核心部分,所有对外业务模块]`
- **analysis** `[数据统计]`
- **...** `[其他业务]`
- **utils** `[工具类]`
***
***
## 配置相关说明
### mycat-config(mycat配置文件)
- **nsrsbh-partition-hash-int.txt** `[分库分表规则]`
- **rule.xml** `[路由规则]`
- **schema.xml** `[分表信息]`
- **server.xml** `[主配置信息]`
***
### sims_common_config(nacos通用配置)
- **DEFAULT_GROUP** `[默认分组]`
- **common-middleware-std.yaml** `[中间件和通用配置]`
- **remove-nacos.yaml** `[去除nacos配置,不需要导入到nacos中,外挂配置读取本地配置时使用]`
- **.metadata.yaml** `[nacos导入说明]`
***
### sims_config_all(nacos服务合并后配置)
- **sims-all-std** `[分组]`
- **sims-all-std.yaml** `[服务合并后配置]`
- **.metadata.yaml** `[nacos导入说明]`
***
### sims_config_back(nacos后台配置)-8.0.0版本后合并到sims-all-std.yaml中
- **sims-back-config** `[分组]`
- **sims-back-std.yaml** `[后台配置]`
- **.metadata.yaml** `[nacos导入说明]`
***
### sims_config_base(nacos后台配置)-8.0.0版本后合并到sims-all-std.yaml中
- **sims-base-config** `[分组]`
- **sims-base-std.yaml** `[基础服务配置]`
- **.metadata.yaml** `[nacos导入说明]`
***
### sims_config_order(nacos后台配置)-8.0.0版本后合并到sims-all-std.yaml中
- **sims-order-config** `[分组]`
- **sims-order-std.yaml** `[订单配置]`
- **.metadata.yaml** `[nacos导入说明]`
***
# git 提交说明
- feature:新功能开发
- fix:Bug修复
- docs:只添加或更改代码注释及文档
- style:无逻辑更改,纯格式变更
- refactor:完全不改变系统行为的代码重构,例如纯用IDEA的refactor功能产生的代码变更。如果改后会影响代码运行结果,则原则上不应算是refactor。
- perf:非bug修复,也非新功能的性能优化。如果改后会影响代码运行结果,则原则上不应算是perf。
- chore:不含代码变更的杂项,例如更改版本号等
- revert:前次更改的回退。
---