代码规范一(Alibaba)

背着黄油面包的猫

于 2023-03-14 21:04:24 发布

阅读量130

点赞数 1

文章标签：代码规范 Powered by 金山文档

本文链接：https://blog.csdn.net/m0_62569064/article/details/129438083

版权

首先来解释一个问题，为什么要学习代码规范？

可读性：代码规范最大的目的就是保持可读性。

可维护性：在可读性得基础上，就是我们写的代码后期不一定由自己来维护，为了后期别人维护时好维护。所以要坚持代码规范

本文参考阿里巴巴Java开发手册终极版v1.3.0 而写成

1.命名规则

1.1命名风格

（以下皆是强制要求）

代码中的命名不能以下划线或美元符号开始，也不能以下划线或美元符号结束

反例：_name/$name/name_/name$

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

注释：一般来说都是用英文命名，为了大家都好理解，都是拼音也行，但是不建议这么使用。

例：alibaba/taobao/hangzhou……这一类是国际通用的。所以可以用英文

反例：DaZhePromotion/int 变量一=3

类名使用UpperCamlCase风格(大驼峰命名法)，必须遵循驼峰形式，但是以下情形例外：DO/BO/DTO/VO/AO

例：MarcoPolo/UserDo/XmlService/TcpUdpDeal/TaPromotion

反例：marcoPolo/UserDo/XMlService/TCPUDPeal/TAPromotion

方法名、参数名、成员变量、局部变量都统一使用lowerCamelCase风格（小驼峰命名法），必须遵从驼峰的形式。

例：localValue/getHttpMessage()/inputUserId

常量命名全部大写，单词间用下划线隔开，力求语义表达完整，可以很长

例：MAX_STOCK_COUNT

反例：MAX_COUNT

抽象类命名使用Abstract或Base开头：异常类命名使用Exception结尾；测试类命名以它要测试的类名开始，以Test结尾。

中括号是数组类型的一部分，数组定义如下：String[] args:

反例：String args[]的方式来定义。

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

反例：定义为基本数据类型Boolean isDeleted;的属性，它的方法也是isDeleted(),RPC框架在反向解析的时候，“以为”对应的属性名称是deleted，导致属性获取不到，进而抛出异常。

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

应用工具com.alibaba.open.util、类名为MessageUtils(参考Spring框架)

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

例：AbstractClass“缩写”为AbsClass；condition“缩写”命名为condi，此类随意缩写严重降低了代码的可阅读性。

（推荐使用的一些方式）

为了达到代码自解释的目标，任何自定义编程元素在命名时，使用尽量完整的单词

组合来表达其意。

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

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

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

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

正例：public class OrderFactory;

public class LoginProxy;

public class ResourceObserver;

接口类中的方法和属性不要加任何修饰符号（public 也不要加），保持代码的简洁性，并加上有效的 Javadoc 注释。尽量不要在接口里定义变量，如果一定要定义变量，肯定是与接口方法相关，并且是整个应用的基础常量。

正例：接口方法签名：void f();

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

反例：接口方法定义：public abstract void f();

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

接口和实现类的命名有两套规则：

1）【强制】对于 Service 和 DAO 类，基于 SOA 的理念，暴露出来的服务一定是接口，内部

的实现类用 Impl 的后缀与接口区别。

正例：CacheServiceImpl 实现 CacheService 接口。

2）【推荐】如果是形容能力的接口名称，取对应的形容词做接口名（通常是–able 的形式）。

正例：AbstractTranslator 实现 Translatable。

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

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

正例：枚举名字为 ProcessStatusEnum 的成员名称：SUCCESS / UNKOWN_REASON。

各层命名规约：

A) Service/DAO 层方法命名规约

1）获取单个对象的方法用 get 做前缀。

2）获取多个对象的方法用 list 做前缀。

3）获取统计值的方法用 count 做前缀。

4）插入的方法用 save/insert 做前缀。

5）删除的方法用 remove/delete 做前缀。

6）修改的方法用 update 做前缀。

B) 领域模型命名规约

1）数据对象：xxxDO，xxx 即为数据表名。

2）数据传输对象：xxxDTO，xxx 为业务领域相关的名称。

3）展示对象：xxxVO，xxx 一般为网页名称。

4） POJO 是 DO/DTO/BO/VO 的统称，禁止命名成 xxxPOJO。

1.2常量定义

1. 【强制】不允许任何魔法值（即未经定义的常量）直接出现在代码中。

反例：String key = "Id#taobao_" + tradeId;

cache.put(key, value);

2. 【强制】long 或者 Long 初始赋值时，使用大写的 L，不能是小写的 l，小写容易跟数字 1 混

淆，造成误解。

说明：Long a = 2l; 写的是数字的 21，还是 Long 型的 2?

3. 【推荐】不要使用一个常量类维护所有常量，按常量功能进行归类，分开维护。

说明：大而全的常量类，非得使用查找功能才能定位到修改的常量，不利于理解和维护。

正例：缓存相关常量放在类 CacheConsts 下；系统配置相关常量放在类 ConfigConsts 下。

4. 【推荐】常量的复用层次有五层：跨应用共享常量、应用内共享常量、子工程内共享常量、包

内共享常量、类内共享常量。

1）跨应用共享常量：放置在二方库中，通常是 client.jar 中的 constant 目录下。

2）应用内共享常量：放置在一方库中，通常是 modules 中的 constant 目录下。

反例：易懂变量也要统一定义成应用内共享常量，两位攻城师在两个类中分别定义了表示

“是”的变量：

类 A 中：public static final String YES = "yes";

类 B 中：public static final String YES = "y";

A.YES.equals(B.YES)，预期是 true，但实际返回为 false，导致线上问题。

3）子工程内部共享常量：即在当前子工程的 constant 目录下。

4）包内共享常量：即在当前包下单独的 constant 目录下。

5）类内共享常量：直接在类内部 private static final 定义。

5. 【推荐】如果变量值仅在一个范围内变化，且带有名称之外的延伸属性，定义为枚举类。下面

正例中的数字就是延伸信息，表示星期几。

正例：public Enum { MONDAY(1), TUESDAY(2), WEDNESDAY(3), THURSDAY(4), FRIDAY(5), SATURDAY(6),

SUNDAY(7);}