JAVA开发中一些日常编程规范

发表于 | 分类于

类注释

在import之后，class声明之前进行注释，格式如下：

1
2
3
4
5
6
7
8
9
10
/**
 * 这个类是用来产生随机数
 * @author  zhangsan
 * @author  lisi
 * @see     java.lang.Object#toString()
 * @see     java.lang.StringBuffer
 * @version   1.2
 */
public class RandomNum {
}

方法注释

在方法定义之前进行注释说明，格式如下：

1
2
3
4
5
6
7
8
9
10
public class RandomNum {
    /**
     * 该方法用来生成随机数
     * @param num The value to be squared. 
     * @return num squared. 
     */
    public String genRandomNum(double num) {
        return num * num;
    }
}

命名约定

Java中类名，方法名等使用的命名风格是“驼峰式”规范。

  • 包名

包名全部小写，连续的单词只是简单地连接起来，不使用下划线。

1
2
com.baidu.ai.autodriven
com.sina.webo.as
  • 类名

类名都以UpperCamelCase风格编写。类名通常是名词或名词短语，接口名称有时可能是形容词或形容词短语。现在还没有特定的规则或行之有效的约定来命名注解类型。

测试类的命名以它要测试的类的名称开始，以Test结束。例如，HashTest或HashIntegrationTest。

  • 方法名

方法名都以lowerCamelCase风格编写。方法名通常是动词或动词短语。

  • 常量名

常量名命名模式为CONSTANT_CASE，全部字母大写，用下划线分隔单词。

  • 非常量字段名

非常量字段名以lowerCamelCase风格编写。这些名字通常是名词或名词短语。

  • 参数名

参数名以lowerCamelCase风格编写。参数应该避免用单个字符命名。

  • 局部变量名

局部变量名以lowerCamelCase风格编写，比起其它类型的名称，局部变量名可以有更为宽松的缩写。

Java编程规范的一些最佳实践

（1）抽象类命名使用Abstract或Base开头。异常类命名使用Exception结尾。测试类命名以它要测试的类的名称开始，以Test结尾。

（2）Service/DAO层方法命名规约：

获取单个对象的方法用get做前缀，如getStudent
获取多个对象的方法用list做前缀，复数结尾，如listStudents
获取统计值的方法用count做前缀
插入的方法用save/insert做前缀
删除的方法用remove/delete做前缀
修改的方法用update做前缀

（3）领域模型命名规约

数据对象:xxxDO，xxx即为数据表名
数据传输对象:xxxDTO，xxx为业务领域相关的名称
展示对象:xxxVO，xxx一般为网页名称
POJO是DO/DTO/BO/VO的统称，禁止命名成xxxPOJO

（4）不要使用一个常量类维护所有常量，按常量功能进行归类，分开维护。大而全的常量类，不利于理解和维护。建议缓存相关常量放在类CacheConsts下；系统配置相关常量放在类ConfigConsts下。

（5）省略花括号

当if或for控制语句的执行体，只有一行时，可以省略花括号。如下写法都是可以的：

1
2
3
4
5
6
7
8
9
10
public static void testfunc() {
    for(int i = 0; i < 5; i++) System.out.println("aaaaa");
    for (int i = 0; i < 5; i++)
        System.out.println("aaaaa");
        
    int a = 3;
    if (a > 1) System.out.println("bbbbb");
    if (a > 1)
        System.out.println("bbbbb");
}

（6）一行声明/定义多个变量

1
int a = 3, b = 6, c = 4, d = 9;