JAVA常见命名规范
常见命名规范
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.dubbomon.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前缀,否则部分框架解析会引起序列号错误。
如果模块、接⼝、类、⽅法使⽤了设计模式,在命名时需体现出具体模式。
版权声明:本站内容均来自互联网,仅供演示用,请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198,我们将在24小时内删除。
发表评论