阿里Java编程规约(命名风格、常量定义、代码格式)

命名风格

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

反例:_name / __name / $name / name_ / name$ / name__

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

说明:正确的英文拼写和语法可以让阅读者易于理解,避免歧义。注意,纯拼音命名方式更要避免采用。

正例:renminbi / alibaba / taobao / youku / hangzhou 等国际通用的名称,可视同英文。

反例:DaZhePromotion [打折] / getPingfenByName() [评分] / int 某变量 = 3

3、【强制】类名使用 UpperCamelCase 风格,但以下情形例外:DO / BO / DTO / VO / AO

/ PO / UID 等。

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

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

4、【强制】方法名、参数名、成员变量、局部变量都统一使用 lowerCamelCase 风格,必须遵

从驼峰形式。

正例: localValue / getHttpMessage() / inputUserId

5、【强制】常量命名全部大写,单词间用下划线隔开,力求语义表达完整清楚,不要嫌名字

长。

正例:MAX_STOCK_COUNT / CACHE_EXPIRED_TIME

反例:MAX_COUNT / EXPIRED_TIME

6、【强制】抽象类命名使用 Abstract Base 开头;异常类命名使用 Exception 结尾;测试类

命名以它要测试的类的名称开始,以 Test 结尾。

7、【强制】类型与中括号紧挨相连来表示数组。

正例:定义整形数组 int[] arrayDemo;

反例: main 参数中,使用 String args[]来定义。

8、【强制】POJO 类中布尔类型变量都不要加 is 前缀,否则部分框架解析会引起序列化错误。

说明:在本文 MySQL 规约中的建表约定第一条,表达是与否的值采用 is_xxx的命名方式,所以,需要在

<resultMap>设置从 is_xxx xxx 的映射关系。

反例:定义为基本数据类型 Boolean isDeleted 的属性,它的方法也是 isDeleted()RPC 框架在反向解

析的时候,误以为对应的属性名称是 deleted,导致属性获取不到,进而抛出异常。

9、【强制】包名统一使用小写,点分隔符之间有且仅有一个自然语义的英语单词。包名统一使

单数形式,但是类名如果有复数含义,类名可以使用复数形式。

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

10、【强制】避免在子父类的成员变量之间、或者不同代码块的局部变量之间采用完全相同的命

名,使可读性降低。

说明:子类、父类成员变量名相同,即使是 public 类型的变量也是能够通过编译,而局部变量在同一方法

内的不同代码块中同名也是合法的,但是要避免使用。对于非 setter/getter 的参数名称也要避免与成员

变量名称相同。

反例:

public class ConfusingName {public int age;// 非 setter/getter 的参数名称,不允许与本类成员变量同名 public void getData(String alibaba) {if(condition) {final int money = 531;// ...}for (int i = 0; i < 10; i++) {// 在同一方法体中,不允许与其它代码块中的 money 命名相同final int money = 615;// ...} }}class Son extends ConfusingName {// 不允许与父类的成员变量名称相同 public int age;}

11、【强制】杜绝完全不规范的缩写,避免望文不知义。

反例:AbstractClass缩写命名成 AbsClasscondition缩写命名成 condi,此类随意缩写严重

降低了代码的可阅读性。

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

组合来表达其意。

正例: JDK 中,表达原子更新的类名为:AtomicReferenceFieldUpdater

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

13、【推荐】在常量与变量的命名时,表示类型的名词放在词尾,以提升辨识度。

正例:startTime / workQueue / nameList / TERMINATED_THREAD_COUNT

反例:startedAt / QueueOfWork / listName / COUNT_TERMINATED_THREAD

14、【推荐】如果模块、接口、类、方法使用了设计模式,在命名时需体现出具体模式。

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

正例: public class OrderFactory;

public class LoginProxy;

public class ResourceObserver;

15、【推荐】接口类中的方法和属性不要加任何修饰符号(public 也不要加),保持代码的简洁

性,并加上有效的 Javadoc 注释。尽量不要在接口里定义变量,如果一定要定义变量,肯定

是与接口方法相关,并且是整个应用的基础常量。

正例:接口方法签名 void commit();

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

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

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

16、接口和实现类的命名有两套规则:

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

Impl 的后缀与接口区别。

正例:CacheServiceImpl 实现 CacheService 接口。

2 【推荐】如果是形容能力的接口名称,取对应的形容词为接口名(通常是able 的形容词)。

正例:AbstractTranslator 实现 Translatable 接口。

17、【参考】枚举类名带上 Enum 后缀,枚举成员名称需要全大写,单词间用下划线隔开。

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

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

18、【参考】各层命名规约

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

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

2 获取多个对象的方法用 list 做前缀,复数形式结尾如:listObjects

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

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

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

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

B) 领域模型命名规约

1 数据对象:xxxDOxxx 即为数据表名。

2 数据传输对象:xxxDTOxxx 为业务领域相关的名称。

3 展示对象:xxxVOxxx 一般为网页名称。

4 POJO DO/DTO/BO/VO 的统称,禁止命名成 xxxPOJO

常量定义

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

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

cache.put(key, value);

// 缓存 get 时,由于在代码复制时,漏掉下划线,导致缓存击穿而出现问题

2、【强制】 long 或者 Long 赋值时,数值后使用大写的 L,不能是小写的 l,小写容易跟数

1 混淆,造成误解。

说明:Long a = 2l; 写的是数字的 21,还是 Long 型的 2

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

说明:大而全的常量类,杂乱无章,使用查找功能才能定位到修改的常量,不利于理解和维护。

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

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

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

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

2 应用内共享常量:放置在一方库中,通常是子模块中的 constant 目录下。

反例:易懂变量也要统一定义成应用内共享常量,两位工程师在两个类中分别定义了YES的变量:

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【推荐】如果变量值仅在一个固定范围内变化用 enum 类型来定义。

说明:如果存在名称之外的延伸属性应使用 enum 类型,下面正例中的数字就是延伸信息,表示一年中的

第几个季节。

正例:

public enum SeasonEnum {SPRING(1), SUMMER(2), AUTUMN(3), WINTER(4);private int seq; SeasonEnum(int seq) {this.seq = seq;}public int getSeq() {return seq;}}

 

代码格式

1、【强制】如果是大括号内为空,则简洁地写成{}即可,大括号中间无需换行和空格;如果是非

空代码块则:

1 左大括号前不换行。

2 左大括号后换行。

3 右大括号前换行。

4 右大括号后还有 else 等代码则不换行;表示终止的右大括号后必须换行。

2、左小括号和字符之间不出现空格同样,右小括号和字符之间也不出现空格;而左

大括号前需要空格。详见第 5 条下方正例提示。

反例:if (空格 a == b 空格)

3、【强制】if/for/while/switch/do 等保留字与括号之间都必须加空格。

4、【强制】任何二目、三目运算符的左右两边都需要加一个空格。

说明:运算符包括赋值运算符=、逻辑运算符&&、加减乘除符号等。

5、【强制】采用 4 个空格缩进,禁止使用 tab 字符。

说明:如果使用 tab 缩进,必须设置 1 tab 4 个空格。IDEA 设置 tab 4 个空格时,请勿勾选 Use

tab character;而在 eclipse 中,必须勾选 insert spaces for tabs

正例: (涉及 1-5 点)

public static void main(String[] args) {

// 缩进 4 个空格 String say = "hello";

// 运算符的左右必须有一个空格 int flag = 0;

// 关键词 if 与括号之间必须有一个空格,括号内的 f 与左括号,0 与右括号不需要空格 if (flag == 0) {

System.out.println(say); }

// 左大括号前加空格且不换行;左大括号后换行 if (flag == 1) {

 System.out.println("world");

// 右大括号前换行,右大括号后有 else,不用换行

} else {

System.out.println("ok");

// 在右大括号后直接结束,则必须换行 }

}

6、【强制】注释的双斜线与注释内容之间有且仅有一个空格。

正例:

// 这是示例注释,请注意在双斜线之后有一个空格 String param = new String();

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.mzph.cn/news/445309.shtml

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

PaperNotes(2)-Generative Adversarial Net-代码实现资料

Generative Adversarial Nets-生成对抗网络Abstract1.Introduction2.Related work3.Adversarial nets4.Theoretical Results4.1全局最优 pgpdatap_gp_{data}pg​pdata​4.2算法1的收敛性质5.Experiments6.Advantagesa and disadvantages7.Conclusions and future work8.GAN-代码…

深度学习(05)--典型CNN结构(VGG13,16,19)

文章目录目录1.VGG结构2.VGG结构解释3.3*3卷积核的优点4.VGG的muti-scale方法5.VGG的应用目录 1.VGG结构  LeNet5用大的卷积核来获取图像的相似特征  AlexNet用99、1111的滤波器  VGG 巨大的进展是通过依次采用多个 33 卷积&#xff0c;模仿出更大的感受野&#xff08;r…

redis——发布和订阅

频道的订阅和退订 当一个客户端执行 SUBSCRIBE 命令&#xff0c; 订阅某个或某些频道的时候&#xff0c; 这个客户端与被订阅频道之间就建立起了一种订阅关系。 Redis 将所有频道的订阅关系都保存在服务器状态的 pubsub_channels 字典里面&#xff0c; 这个字典的键是某个被订…

Pytorch(1)-内置/自己设计的损失函数使用

内置/自己设计的损失函数使用对比1.内置损失函数2.自己设计损失函数Pytorch内置了许多常用的损失函数&#xff0c;但是&#xff0c;实际应用中&#xff0c;往往需要依据不同的需求设计不同的损失函数。本篇博文对比总结了使用 内置和 自己设计损失函数的语法规则流程。1.内置损…

redis——事务

Redis 事务可以一次执行多个命令&#xff0c; 并且带有以下三个重要的保证&#xff1a; 批量操作在发送 EXEC 命令前被放入队列缓存。收到 EXEC 命令后进入事务执行&#xff0c;事务中任意命令执行失败&#xff0c;其余的命令依然被执行。在事务执行过程&#xff0c;其他客户端…

深度学习(06)-- Network in Network(NIN)

文章目录目录1.NIN 结构2.MLP卷积3.全局均值池化4.总体网络架构5.NIN补充5.1 广义线性模型&#xff08;GLM&#xff09;的局限性5.2 CCCP层5.3 1*1卷积核作用&#xff08;补充&#xff09;6.手势识别RGB图像--NIN结构目录 1.NIN 结构 2.MLP卷积 传统CNN的局部感受野窗口的运算…

Pytorch(2)-tensor常用操作

tensor常用数学操作1. 随机数1.1 torch.rand() - 均匀分布数字1.2 torch.randn() - 正态分布数字2. 求和2.1 torch.sum(data, dim)2.2 numpy.sum(data, axis)3. 求积3.1 点乘--对应位置相乘3.2 矩阵乘法4. 均值、方差4.1 torch tensor.mean() .std()4.2 numpy array.mean() .st…

Java编程规约(OOP)

1、【强制】避免通过一个类的对象引用访问此类的静态变量或静态方法&#xff0c;无谓增加编译器解析 成本&#xff0c;直接用类名来访问即可。 2、【强制】所有的覆写方法&#xff0c;必须加Override 注解。 说明&#xff1a;getObject()与 get0bject()的问题。一个是字母的…

深度学习(07)-- 经典CNN网络结构(Inception (v1-v4))

文章目录目录1.Inception介绍1.1 Inception结构1.2 Inception V1(GoogleNet)1.3 Inception V2(Batch Norm)1.4 Inception V3&#xff08;Factorization&#xff09;1.5 Inception V4&#xff08;ResNet&#xff09;1.5 Inception v1~v4 总结1.6 Inception进阶2.Inception实现目…

Python(13)-函数,lambda语句

函数1 函数定义2 函数调用3 函数注释文档4 函数参数4.1 参数列表,默认参数,任意参数4.1.1 无缺省值参数4.1.2&#xff08;部分&#xff09;缺省值参数4.1.3 数量不定形参数4.2 可变对象和不可变对象4.3 作用域4.3.1 globals()函数4.3.2 global 声明变量为全局变量5 函数返回值5…

深度学习(08)-- Residual Network (ResNet)

文章目录目录1.残差网络基础1.1基本概念1.2VGG19、ResNet34结构图1.3 梯度弥散和网络退化1.4 残差块变体1.5 ResNet模型变体1.6 Residual Network补充1.7 1*1卷积核&#xff08;补充&#xff09;2.残差网络介绍&#xff08;何凯明&#xff09;3.ResNet-50(Ng)3.1 非常深的神经网…

Python(14)-模块

模块Python标准库&#xff0c;第三方库都是一个个模块&#xff0c;我们还可以编写自己的模块。模块python程序架构的核心模块&#xff0c;模块是一个工具包。 每一个以.py为扩展名的源代码文件都是一个模块。 想要使用工具包中的工具&#xff0c;可以使用Import的方式导入。 …

redis——命令请求的执行过程

发送命令请求 当用户在客户端中键入一个命令请求时&#xff0c; 客户端会将这个命令请求转换成协议格式&#xff0c; 然后通过连接到服务器的套接字&#xff0c; 将协议格式的命令请求发送给服务器。 读取命令请求 当客户端与服务器之间的连接套接字因为客户端的写入而变得可…

深度学习(09)-- DenseNet

文章目录目录1.DenseNet网络结构2.稠密连接及其优点3.代码实现4.补充说明目录 1.DenseNet网络结构 2.稠密连接及其优点 每层以之前层的输出为输入&#xff0c;对于有L层的传统网络&#xff0c;一共有L个连接&#xff0c;对于DenseNet&#xff0c;则有L*(L1)/2。 这篇论文主要…

redis——缓存击穿/穿透/雪崩

缓存穿透 一般的缓存系统&#xff0c;都是按照key去缓存查询&#xff0c;如果不存在对应的value&#xff0c;就去后端系统查找&#xff08;比如DB&#xff09;。 一些恶意的请求会故意查询不存在的key,请求量很大&#xff0c;就会对后端系统造成很大的压力。这就叫做缓存穿透…

python(15)-window7配置iPython

前提&#xff1a;安装了Pythonanaconda anaconda安装参考&#xff1a;https://www.zhihu.com/question/58033789 在window系统下可以使用两种方法来实现类似与于Linux终端命令运行程序的方法&#xff08;推荐方式2&#xff09;: 1.cmd:自己没有操作过&#xff0c;可以参考下面…

深度学习(10)-- Capsules Networks(CapsNet)

版权声明&#xff1a;本文为博主原创文章&#xff0c;未经博主允许不得转载。 https://blog.csdn.net/malele4th/article/details/79430464 </div><div id"content_views" class"markdown_views"><!-- flowchart 箭头图标 勿删 --&g…

手把手maven的功能/安装/使用/idea集成

看这篇文章不用着急安装&#xff0c;跟着步骤一定会成功&#xff0c;要理解maven是什么&#xff0c;如何使用。 介绍 maven官网 对于一个小白来说&#xff0c;官网有用的信息就是这些 不管如何介绍maven&#xff0c;作为使用者来说&#xff0c;主要感觉两个方面有帮助&#x…

python(16)-列表list,for循环

高级数据类型--列表1列表定义2列表中取值3列表的增&#xff0c;删&#xff0c;查&#xff0c;改3.1修改指定位置的数据3.2确定指定元素的索引3.3增加操作3.4删除操作3.5 元素是否存在与列表中 in3.6在指定索引位置插入元素4列表的数据统计5列表排序6列表的循环遍历-for7多维度l…

深度学习(11)-- GAN

TensorFlow &#xff08;GAN&#xff09; 目录 TensorFlow &#xff08;GAN&#xff09;目录1、GAN1.1 常见神经网络形式1.2 生成网络1.3 新手画家 & 新手鉴赏家1.4 GAN网络1.5 例子 1、GAN 今天我们会来说说现在最流行的一种生成网络, 叫做 GAN, 又称生成对抗网络, 也…