Java是一门面向对象编程语言。

Java开发命名规范

没有规矩不成方圆,没有规范难以协同,我们为了增加Java代码的可读性,减少项目组因人员流动而带来的损失,JAVA命名规范必不可缺。

1.代码中的命名均不能以下划线或美元符号开始,也不能以下划线或美元符号结束。  

2.代码中的命名严禁使用拼音与英文混合的方式,更不允许直接使用中文的方式。

3.类名使用 UpperCamelCase 风格,必须遵从驼峰形式,但以下情形例外:DO/BO/DTO/VO/AO 

正例:MarcoPolo / UserDO / XmlService / TcpUdpDeal / TaPromotion

反例:macroPolo / UserDo / XMLService / TCPUDPDeal / TAPromotion 

4.常量命名全部大写,单词间用下划线隔开,力求语义表达完整清楚,不要嫌名字长。

正例:MAX_STOCK_COUNT 

反例:MAX_COUNT

5.抽象类命名使用 Abstract 或 Base 开头;异常类命名使用 Exception 结尾;测试类 命名以它要测试的类的名称开始,以 Test 结尾。

6.括号是数组类型的一部分,数组定义如下:String[] args。

7.POJO 类中布尔类型的变量,都不要加 is,否则部分框架解析会引起序列化错误。

8.包名统一使用小写,点分隔符之间有且仅有一个自然语义的英语单词。包名统一使用 单数形式,但是类名如果有复数含义,类名可以使用复数形式。

正例: 应用工具类包名为com.alibaba.open.util、类名为MessageUtils(此规则参考 spring 的框架结构)

9.杜绝完全不规范的缩写,避免望文不知义。

反例:AbstractClass“缩写”命名成 AbsClass;condition“缩写”命名成 condi,此类随 意缩写严重降低了代码的可阅读性。

10.为了达到代码自解释的目标,任何自定义编程元素在命名时,使用尽量完整的单词 组合来表达其意。

正例:从远程仓库拉取代码的类命名为 PullCodeFromRemoteRepository。 

反例:变量 int a; 的随意命名方式。

11.如果模块、接口、类、方法使用了设计模式,在命名时体现出具体模式。

说明:将设计模式体现在名字中,有利于阅读者快速理解架构设计理念。 

正例: 

public class OrderFactory; 

public class LoginProxy; 

public class ResourceObserver;

12.接口类中的方法和属性不要加任何修饰符号(public也不要加),保持代码的简洁性,并加上有效的 Javadoc 注释。

尽量不要在接口里定义变量,如果一定要定义变量,如果一定要使用变量,那么应该是常量,在相应的接口的平级包enum中定义。

正例:

接口方法签名:void f(); 

接口基础常量表示:String COMPANY = "alibaba"; 

反例:

接口方法定义:public abstract void f(); 

说明:JDK8 中接口允许有默认实现,那么这个default ­­­方法,是对所有实现类都有价值的默认实现。

13. 如果是形容能力的接口名称,取对应的形容词做接口名(通常是–able 的形式)。 

正例:AbstractTranslator 实现 Translatable。

14. 枚举类名建议带上 Enum 后缀,枚举成员名称需要全大写,单词间用下划线隔开。

说明:枚举其实就是特殊的常量类,且构造方法被默认强制是私有。

正例:枚举名字为ProcessStatusEnum的成员名称:

SUCCESS /UNKOWN_REASON。

15. 方法名称,参数名称,成员变量名称和局部变量名称应该写在lowerCamelCase中。

正面的例子:localValue / getHttpMessage()/ inputUserId


当前位置:Java教程网 »
本文地址:http://www.javajcw.com/41.html
喜欢 or
默认图片
发表我的评论
取消评论