'代码规范'

This commit is contained in:
黎润豪 2021-12-22 11:00:26 +08:00
parent 0382c55735
commit 1794a23152
1 changed files with 23 additions and 1 deletions

View File

@ -67,6 +67,28 @@
- <font color="red">【强制】</font>捕获异常和跑异常必须完全匹配,或者捕获异常是抛异常的父类
- <font colr="red">【强制】</font>若异常被捕获,如果数据需要回滚,一定要注意进行手动回滚
- <font color="red">【强制】</font>若异常被捕获,如果数据需要回滚,一定要注意进行手动回滚
## 日志规约
- <font color="red">【强制】</font>日志对象在项目引用了lombok的情况下请用@SLF4J注解声明
- <font color="red">【强制】</font>所有日志文件至少保存15天
- <font color="red">【强制】</font>日志信息拼接使用`{}`占位符,以提高可读性和拼接性能
- <font color="red">【强制】</font>生产环境进制直接使用`System.out``System.err`或`e.printStackTrace()`充当日志输出
- <font color="red">【强制】</font>避免重复打印日志浪费磁盘空间务必在日志配置文件中的子logger配置additivity=false
```xml
<logger name="com.chinaweal.dao" level="debug" additivity="false"/>
```
## 代码结构
- <font color="green">【推荐】</font>`{}`代码块嵌套不应超过4层
## 工程结构
- <font color="green">【推荐】</font>目录结构com.chinaweal.{项目简称}.{通用配置名/数据源缩写}.{controller/service/entity/mapper}