'样式标识换图片'

技术规范/Java后端开发规范.md

@@ -8,77 +8,77 @@
 
 本文为公司Java后端开发的代码规范，规范分如下两级：  
 
-- <span style="color:red">【强制】</span>：开发者必须遵循的开发规范要求
+- ![强制](../img/icon/强制.png) ：开发者必须遵循的开发规范要求
-- <span style="color:green">【推荐】</span>：开发者选择性遵循的开发规范要求
+- ![推荐](../img/icon/推荐.png) ：开发者选择性遵循的开发规范要求
 
 ## 编程约束
 
 ### 命名
 
-- <span style="color:red">【强制】</span>杜绝完全不规范的缩写，避免望文不知义。
+- ![强制](../img/icon/强制.png) 杜绝完全不规范的缩写，避免望文不知义。
 
-> <span style="color:red">【反例】</span>：AbstractClass缩写成AbsClass；condition缩写成condi；Function缩写成Fu。
+> ![反例](../img/icon/反例.png) ：AbstractClass缩写成AbsClass；condition缩写成condi；Function缩写成Fu。
 
-- <span style="color:red">【强制】</span>严禁使用非全世界都知道的拼音命名。
+- ![强制](../img/icon/强制.png) 严禁使用非全世界都知道的拼音命名。
 
-> <span style="color:green">正例</span>：alibaba/youku/hangzhou  
+> ![正例](../img/icon/正例.png) ：alibaba/youku/hangzhou  
-> <span style="color:red">反例</span>：suanFen【算分】，getGTHTypeCode【获取个体户类型编码】
+> ![反例](../img/icon/反例.png) ：suanFen【算分】，getGTHTypeCode【获取个体户类型编码】
 
 #### 类命名
 
-- <span style="color:red">【强制】</span>采用大驼峰（UpperCamelCase）命名法，禁止使用数字命名。
+- ![强制](../img/icon/强制.png) 采用大驼峰（UpperCamelCase）命名法，禁止使用数字命名。
 
-> <span style="color:green">【正例】</span>：KeyPair，GlobalConfig  
+> ![正例](../img/icon/正例.png) ：KeyPair，GlobalConfig  
-> <span style="color:red">【反例】</span>：areaSlice，AreaSlice1，AreaSlice2
+> ![反例](../img/icon/反例.png) ：areaSlice，AreaSlice1，AreaSlice2
 
-- <span style="color:green">【推荐】</span>采用【名词】，【形容词+名词】的格式进行命名
+- ![推荐](../img/icon/推荐.png) 采用【名词】，【形容词+名词】的格式进行命名
 
-> <span style="color:green">【正例】</span>：SMSSender，GlobalConfig  
+> ![正例](../img/icon/正例.png) ：SMSSender，GlobalConfig  
-> <span style="color:red">【反例】</span>：SendSMS
+> ![反例](../img/icon/反例.png) ：SendSMS
 
-- <span style="color:red">【强制】</span>抽象类必须以Abstract或Base开头（工具类例外：如StringUtils）；异常类名明必须以Exception结尾；测试类必须以Test结尾。
+- ![强制](../img/icon/强制.png) 抽象类必须以Abstract或Base开头（工具类例外：如StringUtils）；异常类名明必须以Exception结尾；测试类必须以Test结尾。
 
-- <span style="color:red">【强制】</span>接口的参数类必须要以VO或Dto结尾命名；接口与接口之间的传输参数传输类必须以Dto结尾命名。
+- ![强制](../img/icon/强制.png) 接口的参数类必须要以VO或Dto结尾命名；接口与接口之间的传输参数传输类必须以Dto结尾命名。
 
 #### 方法命名
 
-- <span style="color:red">【强制】</span>采用小驼峰（LowerCamelCase）命名法，禁止使用拼音命名
+- ![强制](../img/icon/强制.png) 采用小驼峰（LowerCamelCase）命名法，禁止使用拼音命名
 
-- <span style="color:green">【推荐】</span>方法参数不多于5个，多于5个后改用DTO进行传输。
+- ![推荐](../img/icon/推荐.png) 方法参数不多于5个，多于5个后改用DTO进行传输。
 
 #### 变量命名
 
-- <span style="color:red">【强制】</span>常量与枚举均使用大写+下划线组合的方式命名
+- ![强制](../img/icon/强制.png) 常量与枚举均使用大写+下划线组合的方式命名
 
-> <span style="color:green">【正例】</span>LIMIT_SIZE，ENTITY_TYPE
+> ![正例](../img/icon/正例.png) LIMIT_SIZE，ENTITY_TYPE
 
-- <span style="color:red">【强制】</span>采用小驼峰（LowerCamelCase）命名法，禁止使用拼音命名
+- ![强制](../img/icon/强制.png) 采用小驼峰（LowerCamelCase）命名法，禁止使用拼音命名
 
-- <span style="color:red">【强制】</span>局部非循环与下标变量，不可使用单字母命名（特殊数学含义例外，如斜截式的斜率a，常数b）
+- ![强制](../img/icon/强制.png) 局部非循环与下标变量，不可使用单字母命名（特殊数学含义例外，如斜截式的斜率a，常数b）
 
 ## 异常处理
 
-- <span style="color:red">【强制】</span>方法若有显式的RuntimeException异常抛出，必须使用`throws`关键字将其标识到方法上
+- ![强制](../img/icon/强制.png) 方法若有显式的RuntimeException异常抛出，必须使用`throws`关键字将其标识到方法上
 
-- <span style="color:red">【强制】</span>异常的打印均用日志对象的error等级输出
+- ![强制](../img/icon/强制.png) 异常的打印均用日志对象的error等级输出
 
-- <span style="color:red">【强制】</span>IDEA发现的空指针问题必须要处理掉
+- ![强制](../img/icon/强制.png) IDEA发现的空指针问题必须要处理掉
 
-- <span style="color:red">【强制】</span>捕获异常和跑异常必须完全匹配，或者捕获异常是抛异常的父类
+- ![强制](../img/icon/强制.png) 捕获异常和跑异常必须完全匹配，或者捕获异常是抛异常的父类
 
-- <span style="color:red">【强制】</span>若异常被捕获，如果数据需要回滚，一定要注意进行手动回滚
+- ![强制](../img/icon/强制.png) 若异常被捕获，如果数据需要回滚，一定要注意进行手动回滚
 
 ## 日志规约
 
-- <span style="color:red">【强制】</span>日志对象在项目引用了lombok的情况下，请用@SLF4J注解声明
+- ![强制](../img/icon/强制.png) 日志对象在项目引用了lombok的情况下，请用@SLF4J注解声明
 
-- <span style="color:red">【强制】</span>所有日志文件至少保存15天
+- ![强制](../img/icon/强制.png) 所有日志文件至少保存15天
 
-- <span style="color:red">【强制】</span>日志信息拼接使用`{}`占位符，以提高可读性和拼接性能
+- ![强制](../img/icon/强制.png) 日志信息拼接使用`{}`占位符，以提高可读性和拼接性能
 
-- <span style="color:red">【强制】</span>生产环境进制直接使用`System.out`，`System.err`或`e.printStackTrace()`充当日志输出
+- ![强制](../img/icon/强制.png) 生产环境进制直接使用`System.out`，`System.err`或`e.printStackTrace()`充当日志输出
 
-- <span style="color:red">【强制】</span>避免重复打印日志，浪费磁盘空间，务必在日志配置文件中的子logger配置additivity=false
+- ![强制](../img/icon/强制.png) 避免重复打印日志，浪费磁盘空间，务必在日志配置文件中的子logger配置additivity=false
 
 ```xml
 <logger name="com.chinaweal.dao" level="debug" additivity="false"/>
@@ -86,8 +86,8 @@
 
 ## 代码结构
 
-- <span style="color:green">【推荐】</span>`{}`代码块嵌套不应超过4层
+- ![推荐](../img/icon/推荐.png) `{}`代码块嵌套不应超过4层
 
 ## 工程结构
 
-- <span style="color:green">【推荐】</span>目录结构com.chinaweal.{项目简称}.{通用配置名/数据源缩写}.{controller/service/entity/mapper}
+- ![推荐](../img/icon/推荐.png) 目录结构com.chinaweal.{项目简称}.{通用配置名/数据源缩写}.{controller/service/entity/mapper}