【JAVA】开发规范_编程规约

：基本编程规范

内容主要来源阿里巴巴开发规范文档，建议去看这个文档，写的很详细，我就是在学习然后做点学习笔记，方便记忆。

命名规约：

1.代码中的各类命名均不能一美元符号或者是下划线开始，也不能以其作为命名的结束
例如：
_name 、$name 等都是不合乎规范的
2、命名要易于理解 ，避免起义。因此在使用的过程中要避免使用拼音甚至是中文。
例如：
对于学生的命名： 正确命名：student 不合规范命名：xueshegn
3、对于类的命名要合乎驼峰命名规范UpperCamelCase风格，除了模型中的DO、DTO、VO…外
例如
UserAccount:是正确的命名 userAccount 这都是不规范的类名的命名 UserDO：对于DO之类的模型这样的命名是规范的
4、对于方法名、参数名、变量名等使用的命名规则则是lowerCamelCase的风格。
例如：
方法名：个体User Info() 变量名：userId
5、对于常量的命名，也就是final定义的常量，我们在命名时需要全部大写，在力求变量名语义表达完成的情况下，在多个单词间用下划线分隔，不用担心命名会不会太长的我问题。
例如
常量用户名的最大长度：USER_NAME_MAX_LENGTH 这样也是规范的
6、抽象类的命名要使用关键字 Abstract或者是Base开头；对于异常类或者是测试类，在命名时要能命名他的类型和作用，那么异常类命名可以在结尾以Exception结束，测试类可以以它要测试的类的类名+Test的方式
例如：
抽象类用户信息：AbstractUserInfo 用户测试类：UserTest 异常类：UserException
7、在POJO类中的布尔类型的变量尽量不要写成 isxxx 的形式，因为这样的写法在某些框架中可能会引起序列话错误的问题
8、包名统一使用小写，并且在每一个被点号分隔的报名尽量保持只有一个自然语义的英语单词
例如：
工具类的包名表示：com.xxx.util
9、在需要进行命名缩写时，应尽量保持其原本的语义，不能因为缩写而导致望文不生义。因此，在命名时尽量使用完整的单词来命名
例如：
userComponent缩写成 userCo这样代码的可读性就降低了
10、对于方法的创建要及时在方法上加上有效的Javadoc 注释，对于类需要加上有效的 author 注解信息。
11、对与service的实现类要以Impl后缀结尾
例如：
UserService 的实现类 应该为：UserServiceImpl
12、对于枚举类的名命名，要带上Enum的后缀以区分，并且枚举成员的名称需要全部大写，多个单词之间使用下划线分隔
13、service层和dao层方法名的命名
(1.)、 获取单个对象的方法 用get 做前缀
(2.)、获取多个对象用list做前缀，复数形式结尾如listObject
(3.)、获取统计值的方法用count做前缀。
(4.)、插入的方法用sava或insert
(5.)、删除用deleted或remove
(6.)修改就用update
14、对于模型的使用
DO：对应的是数据对象，即与数据库中的表是一一对应的，也可以说，每个表只有一个DO
DTO：数据传输对象，是直接展示到前端的数据模型
VO：对应接口的请求数据模型
15、避免魔法变量的使用。
例如：
user("cod123") 中 cod123若为一个固定的数据传递，那么在使用时不能直接 这么写上，可以预先将其定义成常量再使用