常见命名规范
Java语言基本命名规范
-
1、类名需要使用大驼峰命名法(UpperCamelCase) 风格。
方法名、参数名、成员变量、局部变量需要使用小驼峰命名法(lowerCamelCase) -
2、测试方法名、常量、枚举名称需要使用蛇形命名法(snake_case),比如
should_get_200_status_code_when_request_is_valid、CLIENT_CONNECT_SERVER_FAILURL.并且,测试方法名称要求全部小写,常量以及枚举名称需要全部大写。 -
3、项目文件夹名称使用串式命名法(kebab-case),比如dubbo-registry
-
4、包名统一使用小写,尽量使用单个单词作为包名,各个单词通过"."分隔符连接,并且各个单词必须为单数。
正例:org.apache.dubbo.common.threadlocal
反例:org.apache_dubbo.Common.threadLocals -
5、抽象类命名使用Abstract开头
//为远程传输部分抽象出来的一个抽象类(出处:Dubbo源码)
public abstract class AbstractClient extends AbstractEndpoint implements Client {
}
- 6、异常类命名使用Exception结尾。
//自定义的 NoSuchMethodException(出处:Dubbo源码)
public class NoSuchMethodException extends RuntimeException {
private static final long serialVersionUID = -2725364246023268766L;
public NoSuchMethodException() {
super();
}
public NoSuchMethodException(String msg) {
super(msg);
}
}
- 7、测试类命名以它要测试的类的名称开始,以Test结尾。
//为 AnnotationUtils 类写的测试类(出处:Dubbo源码)
public class AnnotationUtilsTest {
......
}
POJO类中布尔类型的变量,都不要加is前缀,否则部分框架解析会引起序列号错误。
如果模块、接口、类、方法使用了设计模式,在命名时需体现出具体模式。