编码规范
<pre><code>1、命名风格:
代码命名不能以下划线或美元符号开始或结束。
禁止使用拼音与英文混合的方式,也不允许直接使用中文。
类名使用UpperCamelCase风格,但DO/BO/DTO/VO/AO/PO/UID等除外。
方法名、参数名、成员变量、局部变量都统一使用lowerCamelCase风格。
常量命名全部大写,单词间用下划线隔开。
抽象类以Abstract或Base开头,异常类以Exception结尾,测试类以测试的类的名称开头,以Test结尾。
包名统一小写,点分隔符之间有且仅有个自然语义的英语单词。
避免在父子类和不同代码块中采用相同变量名。
避免不规范的缩写命名,在对元素命名时用完整单词组合表达其意。
2、编程规约:
POJO类中的任何布尔类型的变量,都不要加is前缀,以避免部分框架解析引起序列化错误。
类型与中括号紧挨相连来表示数组。
避免在子父类的成员变量之间、或者不同代码块的局部变量之间采用完全相同的命名,以提高代码的可理解性。
3、特殊情况:
Service/DAO层命名规约:获取单个对象的方法用get做前缀,获取多个对象的方法用list做前缀,获取统计值的方法用count做前缀,插入方法用save/insert做前缀,删除方法用delete/remove做前缀,修改方法用update做前缀。
领域模型命名规范:数据对象使用xxxDO,数据传输对象使用xxxDTO,展示对象使用xxxVO,POJO是对DO、DTO、VO、BO的统称。
以上规范旨在提高代码的可读性和维护性,确保团队间的协作效率。</code></pre>
<p>暂无代码生成工具,目前是自己引入mybatis-plus-generator生成代码后拷贝到项目中。</p>