您的位置 首页 java

阿里巴巴Java开发规范(1):代码中的命名

几乎所有大厂都会对代码规范有着严格要求,以确保多人协作开发出来的代码质量有统一的标准。在 Java 开发领域,《阿里巴巴Java开发手册》被开发者们广泛学习和应用。原手册内容较多,本文仅列出 代码命名 方面需要重点注意的事项(强制遵守的规则),并分析规定背后的原因,所谓知其然,亦知其所以然。

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

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

因为在Java语言底层标准库中有不少用下划线开头的命名,为了避免发生冲突,所以在开发过程中,应避免以下划线等特殊符合作为变量命名的开头。

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

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

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

使用英文命名变量,对于 阿里巴巴 这种国际化研发团队来说尤为重要,方便非中文母语的开发者也能看懂代码。因此阿里巴巴对于纯拼音命名方式也避免采用。

但这条规则不见得对所有开发领域都适用,有些国内项目,很多术语没有合适的英文翻译,如果望文生义的话会引发更多的歧义,这种情况最好用拼音命名。

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

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

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

DO / BO / DTO / VO / AO 这些都是Java开发的常用术语,如果把O改为小写,反而让人不习惯。

4. 方法名、参数名、成员变量、局部变量都统一使用 lowerCamelCase 风格,必须遵从驼峰形式。

正例: localValue / getHttpMessage() / inputUserId

类名开头字母要大写,方法、成员变量等开头字母要小写,这样从命名就知道哪个是类。

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

正例: MAX_STOCK_COUNT

反例: MAX_COUNT

常量全部大写,单词之间无法用驼峰式命名区分开来,所以就必须要用下划线分隔。

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

这条规则同样是为了通过类的命名,快速理解类的作用和定位,而不需要仔细阅读类的内部代码,有效提高开发者之间的协作。

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

反例: 使用 String args[] 的方式来定义。

[] 一定要紧挨着数据类型,否则类型定义很容易让人迷惑,如这句代码: String args[], argt;

args 是字符串数组,而 argt 是一个 字符串

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

反例: 基本数据类型属性 Boolean isDeleted ,它的方法也是 isDeleted() ,框架在反向解析的时候,会误以为属性名称是 deleted ,导致属性获取不到,进而抛出异常。

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

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

包名统一用单数,避免了开发者有人用单数,有人用复数,导致包引用时发生混淆。

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

反例: Abstract Class “缩写”命名成 AbsClass condition “缩写”命名成 condi

此类随意缩写严重降低了代码的可阅读性。

文章来源:智云一二三科技

文章标题:阿里巴巴Java开发规范(1):代码中的命名

文章地址:https://www.zhihuclub.com/186926.shtml

关于作者: 智云科技

热门文章

网站地图