Java中的命名规范

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 开头。
6、异常类命名使用 Exception 结尾。
7、测试类命名以它要测试的类的名称开始，以 Test 结尾。

通用命名规则

1. 尽量不要使用拼音；杜绝拼音和英文混用。对于一些通用的表示或者难以用英文描述的可以采用拼音，一旦采用拼音就坚决不能和英文混用。
   正例： BeiJing， HangZhou
   反例： validateCanShu
2. 命名过程中尽量不要出现特殊的字符，常量除外。
3. 尽量不要和jdk或者框架中已存在的类重名，也不能使用java中的关键字命名。
4. 妙用介词，如for(可以用同音的4代替), to(可用同音的2代替), from, with，of等。
   如类名采用User4RedisDO，方法名getUserInfoFromRedis，convertJson2Map等。

   变量取名-命名神器

   官网：https://www.yuque.com/codekiki/kc9xxv/gs6w5d#VDzfY
   

   参考文献

• 《阿里巴巴 Java 开发手册》
• 史上最全的Java命名规范参考！
• 变量取名一键直达——Codelf

[

](https://www.jianshu.com/p/f578791b0f2d)