ps:作者是正在学习Java的小白,文章内容主要转载于JavaGuide,并且根据自己需要进行了一些改动,便于以后coding使用,原文地址:https://github.com/Snailclimb/JavaGuide/blob/master/docs/system-design/naming.md
Java 命名
好的命名即是注释,别人一看到你的命名就知道你的变量、方法或者类是做什么的! 好的命名对于其他人(包括你自己)理解你的代码有着很大的帮助!
以下内容分为两部分介绍:常见命名规则以及适用场景、常见命名规范。
常见命名规则以及适用场景
以下是 3 种最常见的命名规范。
驼峰命名法(CamelCase)
驼峰命名法应该我们最常见的一个,这种命名方式使用大小写混合的格式来区别各个单词,并且单词之间不使用空格隔开或者连接字符连接的命名方式。
1. 大驼峰命名法(CamelCase)
-
类名需要使用大驼峰命名法(UpperCamelCase)
正例:
// 类名 ServiceDiscovery、ServiceInstance、LruCacheFactory
反例:
serviceDiscovery、Serviceinstance、LRUCacheFactory
2. 小驼峰命名法(lowerCamelCase)
-
方法名、参数名、成员变量、局部变量需要使用小驼峰命名法(lowerCamelCase)
正例:
// 方法名以及参数名 getUserInfo()、createCustomThreadPool()、setNameFormat(String nameFormat) // 成员变量以及局部变量 Uservice userService; int i, j ,k;
反例:
GetUserInfo()、CreateCustomThreadPool()、setNameFormat(String NameFormat) Uservice user_service
蛇形命名法(snake_case)
-
测试方法名、常量、枚举名称需要使用蛇形命名法(snake_case)
在蛇形命名法中,各个单词之间通过下划线“_”连接,比如
should_get_200_status_code_when_request_is_valid
、CLIENT_CONNECT_SERVER_FAILURE
。正例:
@Test void should_get_200_status_code_when_request_is_valid() { ...... }
反例:
@Test void shouldGet200StatusCodoWhenRequestIsValid() { ...... }
串式命名法(kebab-case)
在串式命名法中,各个单词之间通过下划线“-”连接,比如dubbo-registry
。
建议项目文件夹名称使用串式命名法(kebab-case)。
常见命名规范
Java 语言基本命名规范
1. 类名需要使用大驼峰命名法(UpperCamelCase)风格。方法名、参数名、成员变量、局部变量需要使用小驼峰命名法(lowerCamelCase)。
2. 测试方法名、常量、枚举名称需要使用蛇形命名法(snake_case),比如should_get_200_status_code_when_request_is_valid
、CLIENT_CONNECT_SERVER_FAILURE
。并且,测试方法名称要求全部小写,常量以及枚举名称需要全部大写。
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 结尾。
命名易读性规范
1. 为了能让命名更加易懂和易读,尽量不要缩写/简写单词,除非这些单词已经被公认可以被这样缩写/简写。比如 CustomThreadFactory
不可以被写成 ~~CustomTF
。
2. 命名不像函数一样要尽量追求短,可读性强的名字优先于简短的名字,虽然可读性强的名字会比较长一点。
3. 避免无意义的命名,你起的每一个名字都要能表明意思。
正例:UserService userService;
int userCount
;
反例: UserService service
int coun
4. 避免命名过长(50 个字符以内最好),过长的命名难以阅读并且丑陋。
5. 不要使用拼音,更不要使用中文。 注意:像 alibaba 、wuhan、taobao 这种国际通用名词可以当做英文来看待。
正例:discount
反例:dazhe