Android 编程规范阿里巴巴开发手册读后感

作者: __素颜__ | 来源:发表于2019-11-20 14:35 被阅读0次

(一) 命名风格

1.类名使用驼峰式，但是以下情形例外：DO / BO / DTO / VO / AO / PO / UID等。

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

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

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

正例: localValue / getHttpMessage() / inputUserId

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

反例:MAX_COUNT

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

5. POJO $\color{#FF0000}{类中布尔类型的变量，都不要加 is 前缀，}$ 否则部分框架解析会引起序列化错误。

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

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

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

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

正例:接口方法签名void commit();
接口基础常量String COMPANY = "alibaba";

反例:接口方法定义public abstract void f();
说明:JDK8 中接口允许有默认实现，那么这个 default 方法，是对所有实现类都有价值的默认实现。

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

说明:枚举其实就是特殊的类，域成员均为常量，且构造方法被默认强制是私有。正例:枚举名字为ProcessStatusEnum的成员名称:SUCCESS / UNKNOWN_REASON。

(二) 常量定义

1. 在 long 或者 Long 赋值时，数值后使用大写的 L，不能是小写的 l，小写容易跟数字 1 混淆，造成误解。

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

2. 不要使用一个常量类维护所有常量，要按常量功能进行归类，分开维护。说明:大而全的常量类，杂乱无章，使用查找功能才能定位到修改的常量，不利于理解和维护。

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

(三) 代码格式

1.【强制】左小括号和字符之间不出现空格;同样，右小括号和字符之间也不出现空格;而左大括号前需要空格。

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

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

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

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

4 . 【强制】采用 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");
   // 在右大括号后直接结束，则必须换行
}

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

正例: // 这是一个注释，请注意与双斜杠后面有一个空格

6. 【强制】方法参数在定义和传入时，多个参数逗号后边必须加空格。

正例:下例中实参的 args1，后边必须要有一个空格。 method(args1, args2, args3);

7. 【推荐】单个方法的总行数不超过 80 行。

说明:包括方法签名、结束右大括号、方法内代码、注释、空行、回车及任何不可见字符的总行数不超过 80 行。

正例:代码逻辑分清红花和绿叶，个性和共性，绿叶逻辑单独出来成为额外方法，使主干代码更加清晰;共性逻辑抽取成为共性方法，便于复用和维护。

8. 【推荐】不同逻辑、不同语义、不同业务的代码之间插入一个空行分隔开来以提升可读性。说明:任何情形，没有必要插入多个空行进行隔开。

(四) OOP 规约

1. 【强制】避免通过一个类的对象引用访问此类的静态变量或静态方法，无谓增加编译器解析成本，直接用类名来访问即可。

2. 【强制】Object 的 equals 方法容易抛空指针异常，应使用常量或确定有值的对象来调用 equals。

正例:"test".equals(object);

反例:object.equals("test");
说明:推荐使用 java.util.Objects#equals(JDK7 引入的工具类)

3. 【强制】所有的相同类型的包装类对象之间值的比较，全部使用 equals 方法比较。

说明:对于 Integer var = ? 在-128 至 127 范围内的赋值，Integer 对象是在 IntegerCache.cache 产生，会复用已有对象，这个区间内的 Integer 值可以直接使用==进行判断，但是这个区间之外的所有数据，都会在堆上产生，并不会复用已有对象，这是一个大坑，推荐使用 equals 方法进行判断。

4. 【强制】构造方法里面禁止加入任何业务逻辑，如果有初始化逻辑，请放在 init 方法中。

5. 【推荐】使用索引访问用 String 的 split 方法得到的数组时，需做最后一个分隔符后有无内容的检查，否则会有抛 IndexOutOfBoundsException 的风险。

说明:
String str = "a,b,c,,";
String[] ary = str.split(","); // 预期大于 3，结果是 3 System.out.println(ary.length);

6. 【推荐】当一个类有多个构造方法，或者多个同名方法，这些方法应该按顺序放置在一起，便于阅读.

7. 【推荐】循环体内，字符串的连接方式，使用 StringBuilder 的 append 方法进行扩展。

说明:下例中，反编译出的字节码文件显示每次循环都会 new 出一个 StringBuilder 对象，然后进行 append 操作，最后通过 toString 方法返回 String 对象，造成内存资源浪费。
反例:
String str = "start";
for (int i = 0; i < 100; i++) {

str = str + "hello"; }

8. 【推荐】类成员与方法访问控制从严:

如果不允许外部直接通过new来创建对象，那么构造方法必须是private。

工具类不允许有public或default构造方法。

类非static成员变量并且与子类共享，必须是protected。

类非static成员变量并且仅在本类使用，必须是private。

类static成员变量如果仅在本类使用，必须是private。

若是static成员变量，考虑是否为final。

类成员方法只供类内部调用，必须是private。

类成员方法只对继承类公开，那么限制为protected。

说明:任何类、方法、参数、变量，严控访问范围。过于宽泛的访问范围，不利于模块解耦。思考:如果是一个 private 的方法，想删除就删除，可是一个 public 的 service 成员方法或成员变量，删除一下，不得手心冒点汗吗?变量像自己的小孩，尽量在自己的视线内，变量作用域太大，无限制的到处跑，那么你会担心的。

(五) 集合处理

1. 【强制】关于 hashCode 和 equals 的处理，遵循如下规则:

只要重写equals，就必须重写hashCode。

因为Set存储的是不重复的对象，依据hashCode和equals进行判断，所以Set存储的对象必须重写这两个方法。

如果自定义对象作为Map的键，那么必须重写hashCode和equals。

说明:String 重写了 hashCode 和 equals 方法，所以我们可以非常愉快地使用 String 对象作为 key 来使用。(有面试问)

2.【强制】使用集合转数组的方法，必须使用集合的toArray(T[] array)，传入的是类型完全一样的数组，大小就是 list.size()。

说明:使用 toArray 带参方法，入参分配的数组空间不够大时，toArray 方法内部将重新分配内存空间，并返回新数组地址;如果数组元素个数大于实际所需，下标为[ list.size() ]的数组元素将被置为 null，其它数组元素保持原值，因此最好将方法入参数组大小定义与集合元素个数一致。

正例:
List<String> list = new ArrayList<String>(2);
list.add("guan");
list.add("bao");
String[] array = new String[list.size()];
array = list.toArray(array);

反例:直接使用 toArray 无参方法存在问题，此方法返回值只能是 Object[]类，若强转其它类型数组将出现 ClassCastException 错误。

3. 【强制】使用工具类 Arrays.asList()把数组转换成集合时，不能使用其修改集合相关的方法，它的 add/remove/clear 方法会抛出 UnsupportedOperationException 异常。

说明:asList 的返回对象是一个 Arrays 内部类，并没有实现集合的修改方法。Arrays.asList 体现的是适配器模式，只是转换接口，后台的数据仍是数组。
String[] str = new String[] { "you", "wu" };
List list = Arrays.asList(str);

第一种情况:list.add("yangguanbao"); 运行时异常。

第二种情况:str[0] = "gujin"; 那么list.get(0)也会随之修改。

4. 【强制】不要在 foreach 循环里进行元素的 remove/add 操作。remove 元素请使用 Iterator方式，如果并发操作，需要对 Iterator 对象加锁。

正例:

List<String> list = new ArrayList<>(); 
list.add("1");
list.add("2");
Iterator<String> iterator = list.iterator(); 
while (iterator.hasNext()) {
String item = iterator.next();
     if (删除元素的条件) {
          iterator.remove();
     } 
}

反例:

for (String item : list) {
        if ("1".equals(item)) {
               list.remove(item);
    }
}

5. 【推荐】集合初始化时，指定集合初始值大小。

说明:HashMap使用HashMap(int initialCapacity) 初始化。

正例:initialCapacity = (需要存储的元素个数 / 负载因子) + 1。注意负载因子(即 loader factor)默认为 0.75，如果暂时无法确定初始值大小，请设置为 16(即默认值)。

反例:HashMap 需要放置 1024 个元素，由于没有设置容量初始大小，随着元素不断增加，容量 7 次被迫扩大，resize 需要重建 hash 表，严重影响性能。

6. 【推荐】使用 entrySet 遍历 Map 类集合 KV，而不是 keySet 方式进行遍历。

说明:keySet 其实是遍历了 2 次，一次是转为 Iterator 对象，另一次是从 hashMap 中取出 key 所对应的 value。而 entrySet 只是遍历了一次就把 key 和 value 都放到了 entry 中，效率更高。如果是 JDK8，使用 Map.foreach 方法。

正例:values()返回的是 V 值集合，是一个 list 集合对象;keySet()返回的是 K 值集合，是一个 Set 集合对象;entrySet()返回的是 K-V 值组合集合。

7. 【推荐】高度注意 Map 类集合 K/V 能不能存储 null 值的情况，如下表格:

image.png

反例: 由于 HashMap 的干扰，很多人认为 ConcurrentHashMap 是可以置入 null 值，而事实上，存储 null 值时会抛出 NPE 异常。

8. 【参考】利用 Set 元素唯一的特性，可以快速对一个集合进行去重操作，避免使用 List 的 contains 方法进行遍历、对比、去重操作。

(六) 并发处理

1. 【强制】线程资源必须通过线程池提供，不允许在应用中自行显式创建线程。

说明:使用线程池的好处是减少在创建和销毁线程上所消耗的时间以及系统资源的开销，解决资源不足的问题。如果不使用线程池，有可能造成系统创建大量同类线程而导致消耗完内存或者“过度切换”的问题。

2. 【强制】线程池不允许使用 Executors 去创建，而是通过 ThreadPoolExecutor 的方式，这样的处理方式让写的同学更加明确线程池的运行规则，规避资源耗尽的风险。

说明:Executors 返回的线程池对象的弊端如下:

1)FixedThreadPool 和 SingleThreadPool:
允许的请求队列长度为 Integer.MAX_VALUE，可能会堆积大量的请求，从而导致 OOM。

2)CachedThreadPool 和 ScheduledThreadPool:
允许的创建线程数量为 Integer.MAX_VALUE，可能会创建大量的线程，从而导致 OOM。

(七) 控制语句

1. 【强制】在一个 switch 块内，每个 case 要么通过 break/return 等来终止，要么注释说明程序将继续执行到哪一个 case 为止;在一个 switch 块内，都必须包含一个 default 语句并且放在最后，即使空代码。

2. 【强制】在 if/else/for/while/do 语句中必须使用大括号。即使只有一行代码，避免采用单行的编码方式:if (condition) statements;

3. 【推荐】除常用方法(如 getXxx/isXxx)等外，不要在条件判断中执行其它复杂的语句，将复杂逻辑判断的结果赋值给一个有意义的布尔变量名，以提高可读性。

说明:很多 if 语句内的逻辑相当复杂，阅读者需要分析条件表达式的最终结果，才能明确什么样的条件执行什么样的语句，那么，如果阅读者分析逻辑表达式错误呢?

正例:
// 伪代码如下
final boolean existed = (file.open(fileName, "w") != null) && (...) || (...);
if (existed) {
... }

反例:
if ((file.open(fileName, "w") != null) && (...) || (...)) { ...
}

(八) 注释规约

1. 【强制】类、类属性、类方法的注释必须使用 Javadoc 规范，使用/*内容/格式，不得使用 // xxx方式。

说明:在 IDE 编辑窗口中，Javadoc 方式会提示相关注释，生成 Javadoc 可以正确输出相应注释;在 IDE 中，工程调用方法时，不进入方法即可悬浮提示方法、参数、返回值的意义，提高阅读效率。

2. 【强制】所有的抽象方法(包括接口中的方法)必须要用 Javadoc 注释、除了返回值、参数、异常说明外，还必须指出该方法做什么事情，实现什么功能。

说明:对子类的实现要求，或者调用注意事项，请一并说明。

3. 【强制】方法内部单行注释，在被注释语句上方另起一行，使用//注释。方法内部多行注释使用/* */注释，注意与代码对齐。

4. 【参考】谨慎注释掉代码。在上方详细说明，而不是简单地注释掉。如果无用，则删除。

说明:代码被注释掉有两种可能性:

1)后续会恢复此段代码逻辑。

2)永久不用。前者如果没有备注信息，难以知晓注释动机。后者建议直接删掉(代码仓库保存了历史代码)

5. 【参考】特殊注释标记，请注明标记人与标记时间。注意及时处理这些标记，通过标记扫描，经常清理此类标记。线上故障有时候就是来源于这些标记处的代码。

待办事宜(TODO):( 标记人，标记时间，[预计处理时间]) 表示需要实现，但目前还未实现的功能。这实际上是一个 Javadoc 的标签，目前的 Javadoc还没有实现，但已经被广泛使用。只能应用于类，接口和方法(因为它是一个 Javadoc 标签)。

错误，不能工作(FIXME):(标记人，标记时间，[预计处理时间])在注释中用 FIXME 标记某代码是错误的，而且不能工作，需要及时纠正的情况

Android 编程规范 阿里巴巴开发手册读后感

(一) 命名风格

1.类名使用驼峰式，但是以下情形例外：DO / BO / DTO / VO / AO / PO / UID等。

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

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

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

5. POJO 否则部分框架解析会引起序列化错误。

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

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

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

(二) 常量定义

1. 在 long 或者 Long 赋值时，数值后使用大写的 L，不能是小写的 l，小写容易跟数字 1 混淆，造成误解。

2. 不要使用一个常量类维护所有常量，要按常量功能进行归类，分开维护。 说明:大而全的常量类，杂乱无章，使用查找功能才能定位到修改的常量，不利于理解和维护。

(三) 代码格式

1.【强制】左小括号和字符之间不出现空格;同样，右小括号和字符之间也不出现空格;而左大 括号前需要空格。

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

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

4 . 【强制】采用 4 个空格缩进，禁止使用 tab 字符。

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

6. 【强制】方法参数在定义和传入时，多个参数逗号后边必须加空格。

7. 【推荐】单个方法的总行数不超过 80 行。

8. 【推荐】不同逻辑、不同语义、不同业务的代码之间插入一个空行分隔开来以提升可读性。 说明:任何情形，没有必要插入多个空行进行隔开。

(四) OOP 规约

1. 【强制】避免通过一个类的对象引用访问此类的静态变量或静态方法，无谓增加编译器解析成 本，直接用类名来访问即可。

2. 【强制】Object 的 equals 方法容易抛空指针异常，应使用常量或确定有值的对象来调用 equals。

3. 【强制】所有的相同类型的包装类对象之间值的比较，全部使用 equals 方法比较。

4. 【强制】构造方法里面禁止加入任何业务逻辑，如果有初始化逻辑，请放在 init 方法中。

5. 【推荐】使用索引访问用 String 的 split 方法得到的数组时，需做最后一个分隔符后有无内容的检查，否则会有抛 IndexOutOfBoundsException 的风险。

6. 【推荐】当一个类有多个构造方法，或者多个同名方法，这些方法应该按顺序放置在一起， 便于阅读.

7. 【推荐】循环体内，字符串的连接方式，使用 StringBuilder 的 append 方法进行扩展。

8. 【推荐】类成员与方法访问控制从严:

(五) 集合处理

1. 【强制】关于 hashCode 和 equals 的处理，遵循如下规则:

2.【强制】使用集合转数组的方法，必须使用集合的toArray(T[] array)，传入的是类型完全一样的数组，大小就是 list.size()。

3. 【强制】使用工具类 Arrays.asList()把数组转换成集合时，不能使用其修改集合相关的方 法，它的 add/remove/clear 方法会抛出 UnsupportedOperationException 异常。

4. 【强制】不要在 foreach 循环里进行元素的 remove/add 操作。remove 元素请使用 Iterator方式，如果并发操作，需要对 Iterator 对象加锁。

5. 【推荐】集合初始化时，指定集合初始值大小。

6. 【推荐】使用 entrySet 遍历 Map 类集合 KV，而不是 keySet 方式进行遍历。

7. 【推荐】高度注意 Map 类集合 K/V 能不能存储 null 值的情况，如下表格:

8. 【参考】利用 Set 元素唯一的特性，可以快速对一个集合进行去重操作，避免使用 List 的 contains 方法进行遍历、对比、去重操作。

(六) 并发处理

1. 【强制】线程资源必须通过线程池提供，不允许在应用中自行显式创建线程。

2. 【强制】线程池不允许使用 Executors 去创建，而是通过 ThreadPoolExecutor 的方式，这样的处理方式让写的同学更加明确线程池的运行规则，规避资源耗尽的风险。

(七) 控制语句

1. 【强制】在一个 switch 块内，每个 case 要么通过 break/return 等来终止，要么注释说明程 序将继续执行到哪一个 case 为止;在一个 switch 块内，都必须包含一个 default 语句并且 放在最后，即使空代码。

2. 【强制】在 if/else/for/while/do 语句中必须使用大括号。即使只有一行代码，避免采用 单行的编码方式:if (condition) statements;

3. 【推荐】除常用方法(如 getXxx/isXxx)等外，不要在条件判断中执行其它复杂的语句，将 复杂逻辑判断的结果赋值给一个有意义的布尔变量名，以提高可读性。

(八) 注释规约

1. 【强制】类、类属性、类方法的注释必须使用 Javadoc 规范，使用/*内容/格式，不得使用 // xxx方式。

2. 【强制】所有的抽象方法(包括接口中的方法)必须要用 Javadoc 注释、除了返回值、参数、 异常说明外，还必须指出该方法做什么事情，实现什么功能。

3. 【强制】方法内部单行注释，在被注释语句上方另起一行，使用//注释。方法内部多行注释使用/* */注释，注意与代码对齐。

4. 【参考】谨慎注释掉代码。在上方详细说明，而不是简单地注释掉。如果无用，则删除。

5. 【参考】特殊注释标记，请注明标记人与标记时间。注意及时处理这些标记，通过标记扫描， 经常清理此类标记。线上故障有时候就是来源于这些标记处的代码。

相关文章

网友评论

延伸阅读

深度阅读

栏目导航

热点阅读

Android 编程规范阿里巴巴开发手册读后感

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

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

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

5. POJO $\color{#FF0000}{类中布尔类型的变量，都不要加 is 前缀，}$ 否则部分框架解析会引起序列化错误。

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

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

2. 不要使用一个常量类维护所有常量，要按常量功能进行归类，分开维护。说明:大而全的常量类，杂乱无章，使用查找功能才能定位到修改的常量，不利于理解和维护。

1.【强制】左小括号和字符之间不出现空格;同样，右小括号和字符之间也不出现空格;而左大括号前需要空格。

8. 【推荐】不同逻辑、不同语义、不同业务的代码之间插入一个空行分隔开来以提升可读性。说明:任何情形，没有必要插入多个空行进行隔开。

1. 【强制】避免通过一个类的对象引用访问此类的静态变量或静态方法，无谓增加编译器解析成本，直接用类名来访问即可。

6. 【推荐】当一个类有多个构造方法，或者多个同名方法，这些方法应该按顺序放置在一起，便于阅读.

3. 【强制】使用工具类 Arrays.asList()把数组转换成集合时，不能使用其修改集合相关的方法，它的 add/remove/clear 方法会抛出 UnsupportedOperationException 异常。

1. 【强制】在一个 switch 块内，每个 case 要么通过 break/return 等来终止，要么注释说明程序将继续执行到哪一个 case 为止;在一个 switch 块内，都必须包含一个 default 语句并且放在最后，即使空代码。

2. 【强制】在 if/else/for/while/do 语句中必须使用大括号。即使只有一行代码，避免采用单行的编码方式:if (condition) statements;

3. 【推荐】除常用方法(如 getXxx/isXxx)等外，不要在条件判断中执行其它复杂的语句，将复杂逻辑判断的结果赋值给一个有意义的布尔变量名，以提高可读性。

2. 【强制】所有的抽象方法(包括接口中的方法)必须要用 Javadoc 注释、除了返回值、参数、异常说明外，还必须指出该方法做什么事情，实现什么功能。

5. 【参考】特殊注释标记，请注明标记人与标记时间。注意及时处理这些标记，通过标记扫描，经常清理此类标记。线上故障有时候就是来源于这些标记处的代码。