Android编码规范(基于Java)

​ 目录

一、编程规约 ................................ ................................ ......... 1

(一) 命名风格 ................................ ................................ ... 2

(二) 变(常)量定义 ................................ ................................ ... 3

(三) 代码格式 ................................ ................................ ... 4

(四) OOP规约 ................................ ................................ ... 6

(五) 集合处理 ................................ ................................ ... 9

(六) 多线程处理 ................................ ................................ .. 12

(七) 控制语句 ................................ ................................ .. 14

(八) 注释规约 ................................ ................................ .. 16

(九) MVP规约 ................................ ................................ .. 16

(十) 代码整理 ................................ ................................ .. 16

(十一) 注意事项 ................................ .............................. .. 16

二、异常日志 ................................ ................................ ........ 18

(一) 异常处理 ................................ ................................ .. 18

(二) 日志规约 ................................ ................................ .. 19

三、单元测试 ................................ ................................ ........ 21

(一) 功能测试 ................................ ................................ .. 24

(二) 接口数据测试 ................................ ................................ .. 25

(三) 内存泄漏检查 ................................ ................................ .. 27

四、安全规约 ................................ ................................ ........ 23

五、SQLite数据库 ................................ ................................ .... 24

(一) 建表规约 ................................ ................................ .. 24

(二) SQL语句 ................................ ................................ .. 27

六、工程结构 ................................ ................................ ........ 30

(一) 项目结构 ................................ ................................ .. 30

附 1:版权说明 ................................ ................................ ....... 34

附 2:版本记录 ................................ ................................ ....... 34

一、编程规约

(一) 命名风格
  1. 【强制】代码中的命名均不能以下划线或美元符号开始,也不能以下划线或美元符号结束。反例:name/__name/$Object/ name /name$ / Object$

  2. 【强制】代码中的命名严禁使用拼音与英文混合的方式,更不允许直接使用中文的方式。 说明:正确的英文拼写和语法可以让阅读者易于理解,避免歧义。注意,即使纯拼音命名方式也要避免采用。正例:huawei / youku / shanghai 等国际通用的名称,可视同英文。 反例:DaZhePromotion [打折] / getPingfenByName() [评分] / int 某变量 = 3

  3. 【强制】类名使用UpperCamelCase风格,必须遵从驼峰形式 正例:MarcoPolo / XmlService / TcpUdpDeal / TaPromotion 反例:macroPolo / XMLService / TCPUDPDeal / TAPromotion

  4. 【强制】方法名、参数名、成员变量、局部变量都统一使用lowerCamelCase风格,必须遵从驼峰形式。 正例: localValue / getHttpMessage() / inputUserId

  5. 【强制】常量命名全部大写,单词间用下划线隔开,力求语义表达完整清楚,不要嫌名字长。 正例:MAX_STOCK_COUNT 反例:MAX_COUNT

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

  7. 【强制】中括号是数组类型的一部分,数组定义如下:String[] args; 反例:使用String args[]的方式来定义。

  8. 【强制】包名统一使用小写,点分隔符之间有且仅有一个自然语义的英语单词。包名统一使用单数形式,但是类名如果有复数含义,类名可以使用复数形式。 正例: 应用工具类包名为com.homily.open.util、类名为MessageUtils

  9. 【强制】杜绝完全不规范的缩写,避免望文不知义。 反例:AbstractClass“缩写”命名成AbsClass;condition“缩写”命名成 condi,此类随意缩写严重降低了代码的可阅读性。

  10. 【强制】控件名缩写:

    控件缩写控件缩写

    | 控件 | 缩写 | 控件 | 缩写 | | ------------ | ---- | ---------------- | ---- | | TextView | tv | EditText | et | | Button | btn | ImageButton | ib | | ImageView | iv | ListView | lv | | RadioGroup | rg | RadioButton | rb | | ProgressBar | pb | SeekBar | sb | | CheckBox | cb | Spinner | sp | | TableLayout | tl | TableRow | tr | | ScrollView | sv | SearchView | sev | | TabHost | th | TabWidget | tw | | CardView | cv | RecyclerView | rv | | ViewPager | vp | NestedScrollView | nsv | | LinearLayout | ll | RelativeLayout | rl |

  11. 【强制】控件id、strings、colors命名规则,模块名+功能名+...+控件缩写。正例:android:id="@+id/login_save_pwd_cb"

  12. 【强制】layout、drawable等文件命名规则,模块名+功能名...+用途。正例:login_act.xml,login_define_input_et.xml

  13. 【推荐】为了达到代码自解释的目标,任何定义编程元素在命名时使用尽量完整单词 组合来表达其意。正例: 从远程仓库拉取代码的类命名为 PullCodeFromRemoteRepository 。 反例: 变量 int a; int a; int a; 的随意命名 方式。

  14. 【推荐】如果模块、接口、类、方法使用了设计模式,在命名时体现出具体模式。 说明:将设计模式体现在名字中,有利于阅读者快速理解架构设计理念。 正例:public class OrderFactory; public class LoginProxy; public class ResourceObserver;

  15. 【推荐】接口类中的方法和属性不要加任何修饰符号(public 也不要加),保持代码的简洁性,并加上有效的Javadoc注释。尽量不要在接口里定义变量,如果一定要定义变量,肯定是与接口方法相关,并且是整个应用的基础常量。 正例:接口方法签名:void f(); 接口基础常量表示:String COMPANY = "homily"; 反例:接口方法定义:public abstract void f(); 说明:JDK8中接口允许有默认实现,那么这个default方法,是对所有实现类都有价值的默认实现。

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

    1)【强制】用Impl的后缀与接口区别。 正例:CacheServiceImpl实现CacheService接口。

    2)【推荐】如果是形容能力的接口名称,取对应的形容词做接口名(通常是–able的形式)。 正例:AbstractTranslator实现 Translatable。

  17. 【参考】枚举类名建议带上Enum后缀,枚举成员名称需要全大写,单词间用下划线隔开。 说明:枚举其实就是特殊的常量类,且构造方法被默认强制是私有。正例:枚举名字为ProcessStatusEnum的成员名称:SUCCESS / UNKOWN_REASON。

  18. 【参考】各层命名规约:

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

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

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

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

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

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

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

B) 领域模型命名规约

​ 1) 数据对象:xxxDao,xxx即为数据库表名,dao(Data Access Object 数据访问对象)。

​ 2) 数据传输对象:xxxDto,xxx为业务领域相关的名称,dto(Data Transfer Object 数据传输对象)。

​ 3) 展示对象:xxxVo,xxx一般为Activity数据绑定对象,Vo(Value Object)。

​ 4) 领域对象:xxxDo,xxx就是从现实世界中抽象出来的有形或无形的业务实体。Do(Domain Object)

​ 5) POJO是Do/Dto/Bo/Vo/Dao的统称,禁止命名成xxxPOJO。

(二) 变(常)量定义

  1. 【强制】变量命名在Activity中使用以m开头+有意义的驼峰格式命名, dao层中的实体类属性命名与数据库表中的字段名,与服务器交互且需转JSON字符串的实体类首单词全部小写+驼峰格式命名

  2. 【强制】long或者Long初始赋值时,使用大写的L,不能是小写的l,小写容易跟数字1混淆,造成误解。 说明:Long a = 2l; 写的是数字的21,还是Long型的2?

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

    反例1:

    switch(index) {
        case 1: sendMessage(1); 
        break; 
      case 2: sendMessage(2); 
        break;
    }
    

    此处的1和2是魔法值;

    反例2

    int priceTable[] = new int[16];
    

    应修改为

    static final int PRICE_TABLE_MAX = 16; //OK:带名字 
    int priceTable[] = new int [PRICE_TABLE_MAX]; //OK:名字的含义是很清楚的
    
  4. 【强制】尽量避免随意使用静态变量,当某个对象被定义为static的变量所引用,那么gc通常是不会回收这个对象所占有的堆内存的。反例:

    public class A{
        private static B b = new B();
    }
    
  5. 【推荐】不要使用一个常量类维护所有常量,按常量功能进行归类,分开维护。 说明:大而全的常量类,非得使用查找功能才能定位到修改的常量,不利于理解和维护。 正例:缓存相关常量放在类CacheConsts下;系统配置相关常量放在类ConfigConsts下。

  6. 【推荐】常量的复用层次有五层:全局共享常量、Message常量、EventBus常量、接口名常量、发布信息常量等。

  7. 【推荐】如果变量值仅在一个范围内变化,且带有名称之外的延伸属性,定义为枚举类。下面正例中的数字就是延伸信息,表示星期几。 正例:public Enum { MONDAY(1), TUESDAY(2), WEDNESDAY(3), THURSDAY(4), FRIDAY(5), SATURDAY(6), SUNDAY(7);}

(三) 代码格式

  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

    正例: (涉及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. 【强制】注释的双斜线与注释内容之间 正例:// 注释内容,注意在//和一个空格之间有一个空格。

  7. 【强制】单行字符数限制不超过 80 个,超出需要换行,换行时遵循如下原则:

    1) 第二行相对第一行缩进 4 个空格,从第三行开始,不再继续缩进,参考示例。

    2) 运算符与下文一起换行。

    3) 方法调用的点符号与下文一起换行。

    4) 方法调用时,多个参数,需要换行时,在逗号后进行。

    5) 在括号前不要换行,见反例。

    正例:

    StringBuffer sb = new StringBuffer();
    
    // 超过 80 个字符的情况下,换行缩进 4 个空格,点号和方法名称一起换行 sb.append("zi").append("xin")...
    
    .append("huang")...
    
    .append("huang")...
    
    .append("huang");
    

    反例:

    StringBuffer sb = new StringBuffer();
    
    // 超过 80 个字符的情况下,不要在括号前换行 sb.append("zi").append("xin")...append("huang");
    
    // 参数很多的方法调用可能超过 80 个字符,不要在逗号前换行 method(args1, args2, args3, ... , argsX);
    
  8. 【强制】方法参数在定义和传入时,多个参数逗号后边必须加空格。 正例:下例中实参的"a",后边必须要有一个空格。 method("a", "b", "c");

  9. 【强制】IDE的text file encoding设置为UTF-8; IDE中文件的换行符使用Unix格式, 不要使用 Windows 格式。

  10. 【推荐】没有必要增加若干空格来使某一行的字符与上一行对应位置的字符对齐。正例:

      int a = 3;
    
      long b = 4L;
    
      float c = 5F;
    
      StringBuffer sb = new StringBuffer();
    

    说明:增加 sb 这个变量,如果需要对齐,则给 a、b、c 都要增加几个空格,在变量比较多的情况下,是一种累赘的事情。

  11. 【推荐】方法体内的执行语句组、变量的定义语句组、不同的业务逻辑之间或者不同的语义之间插入一个空行。相同业务逻辑和语义之间不需要插入空行。 说明:没有必要插入多个空行进行隔开。

(四) OOP 规约

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

  2. 【强制】所有的覆写方法,必须加@Override 注解。 说明:getObject()与 get0bject()的问题。一个是字母的 O,一个是数字的 0,加@Override 可以准确判断是否覆盖成功。另外,如果在抽象类中对方法签名进行修改,其实现类会马上编译报错。

  3. 【强制】相同参数类型,相同业务含义,才可以使用 Java 的可变参数,避免使用 Object。 说明:可变参数必须放置在参数列表的最后。(提倡同学们尽量不用可变参数编程) 正例:public User getUsers(String type, Integer... ids) {...}

  4. 【强制】外部正在调用或者二方库依赖的接口,不允许修改方法签名,避免对接口调用方产生影响。接口过时必须加@Deprecated注解,并清晰地说明采用的新接口或者新服务是什么。

  5. 【强制】不能使用过时的类或方法。说明:java.net.URLDecoder 中的方法 decode(String encodeStr) 这个方法已经过时,应该使用双参数 decode(String source, String encode)。接口提供方既然明确是过时接口, 那么有义务同时提供新的接口; 作为调用方来说,有义务去考证过时方法的新实现是什么。

  6. 【强制】Object 的 equals 方法容易抛空指针异常,应使用常量或确定有值的对象来调用 equals。 正例:"test".equals(object); 反例:object.equals("test"); 说明:推荐使用 java.util.Objects#equals(JDK7 引入的工具类)

  7. 【强制】所有的相同类型的包装类对象之间值的比较,全部使用 equals 方法比较。 说明:对于 Integer var = ? 在-128 至 127 范围内的赋值,Integer 对象是在IntegerCache.cache 产生,会复用已有对象,这个区间内的 Integer 值可以直接使用==进行 判断,但是这个区间之外的所有数据,都会在堆上产生,并不会复用已有对象,这是一个大坑, 推荐使用 equals 方法进行判断。

  8. 关于基本数据类型与包装数据类型的使用标准如下:

    1) 【推荐】所有的局部变量使用基本数据类型。

    说明:POJO 类属性没有初值是提醒使用者在需要使用时,必须自己显式地进行赋值,任何NPE问题,或者入库检查,都由使用者来保证。 正例:数据库的查询结果可能是 null,因为自动拆箱,用基本数据类型接收有 NPE(NullPointException) 风险。 反例:比如显示成交总额涨跌情况,即正负 x%,x 为基本数据类型,调用的 RPC 服务,调用 不成功时,返回的是默认值,页面显示为 0%,这是不合理的,应该显示成中划线。所以包装数据类型的 null 值,能够表示额外的信息,如:远程调用失败,异常退出。

  9. 【强制】序列化类新增属性时,请不要修改 serialVersionUID 字段,避免反序列失败;如果完全不兼容升级,避免反序列化混乱,那么请修改 serialVersionUID 值。 说明:注意 serialVersionUID 不一致会抛出序列化运行时异常。

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

  11. 【强制】及时关闭流。Java编程过程中,进行数据库连接、I/O流操作时务必小心,在使用完毕后,及时关闭以释放资源。

  12. 【强制】尽量减少对变量的重复计算。

    正例:

    for (int i = 0, int length = list.size(); i < length; i++){
            ...
    }
    

    反例:

    for (int i = 0; i < list.size(); i++){
        ...
    }
    
  13. 【强制】不要在循环中使用try…catch…,应该把其放在最外层, 除非不得已。

  14. 【推荐】尽量在合适的场合使用单例。

    使用单例可以减轻加载的负担、缩短加载的时间、提高加载的效率,但并不是所有地方都适用于单例,简单来说,单例主要适用于以下三个方面:

​ (1)控制资源的使用,通过线程同步来控制资源的并发访问

​ (2)控制实例的产生,以达到节约资源的目的

​ (3)控制数据的共享,在不建立直接关联的条件下,让多个不相关的进程或线程之间实现通信

  1. 【推荐】使用索引访问用 String 的 split 方法得到的数组时,需做最后一个分隔符后有无内容的检查,否则会有抛 IndexOutOfBoundsException 的风险。 说明: String str = "a,b,c,,"; String[] ary = str.split(","); // 预期大于 3,结果是 3 System.out.println(ary.length);

  2. 【推荐】当一个类有多个构造方法,或者多个同名方法,这些方法应该按顺序放置在一起, 便于阅读,此条规则优先于第 15 条规则。

  3. 【推荐】类内方法定义顺序依次是:公有方法或保护方法 > 私有方法 > getter/setter 方法。 说明:公有方法是类的调用者和维护者最关心的方法,首屏展示最好;保护方法虽然只是子类关心,也可能是“模板设计模式”下的核心方法; 而私有方法外部一般不需要特别关心,是一个黑盒实现;因为承载的信息价值较低,所有 Service 和 DAO 的 getter/setter 方法放在类体最后。

  4. 【推荐】setter 方法中,参数名称与类成员变量名称一致,this.成员名 = 参数名。在getter/setter 方法中,不要增加业务逻辑,增加排查问题的难度。

    反例:

    public Integer getData() {
        if (true) {
            return this.data + 100;
        } else {
            return this.data - 100;
        }
    }
    
  5. 【推荐】循环体内,字符串的连接方式,使用 StringBuilder 的 append 方法进行扩展。 说明:反编译出的字节码文件显示每次循环都会 new 出一个 StringBuilder 对象,然后进行 append 操作,最后通过 toString 方法返回 String 对象,造成内存资源浪费。

    反例:

    String str = "start";
    for (int i = 0; i < 100; i++) {
        str = str + "hello";
    }
    
  6. 【推荐】final 可以声明类、成员变量、方法、以及本地变量,下列情况使用 final 关键字:

    1) 不允许被继承的类,如:String 类。

    2) 不允许修改引用的域对象,如:POJO 类的域变量。

    3) 不允许被重写的方法,如:POJO 类的 setter 方法。

    4) 不允许运行过程中重新赋值的局部变量。

    5) 避免上下文重复使用一个变量,使用 final 描述可以强制重新定义一个变量,方便更好地进行重构。

  7. 【推荐】慎用 Object 的 clone 方法来拷贝对象。说明:对象的 clone 方法默认是浅拷贝,若想实现深拷贝需要重写 clone 方法实现属性对象的拷贝。

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

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

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

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

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

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

    6) 若是static成员变量,必须考虑是否为final。

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

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

(五) 集合处理

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

1) 只要重写equals,就必须重写hashCode。

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

3) 如果自定义对象做为Map的键,那么必须重写hashCode和equals。 说明:String 重写了 hashCode 和 equals 方法,所以我们可以非常愉快地使用 String 对象作为 key 来使用。

2.【强制】ArrayList的subList结果不可强转成ArrayList,否则会抛出ClassCastException 异常,即java.util.RandomAccessSubList cannot be cast to java.util.ArrayList. 说明:subList 返回的是 ArrayList 的内部类 SubList,并不是 ArrayList ,而是 ArrayList 的一个视图,对于SubList子列表的所有操作最终会反映到原列表上。

3.【强制】在 subList 场景中,高度注意对原集合元素个数的修改,会导致子列表的遍历、增加、 删除均会产生ConcurrentModificationException 异常。

4.【强制】使用集合转数组的方法,必须使用集合的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 错误。

5.【强制】使用工具类 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)也会随之修改。

6.【强制】泛型通配符<? extends T>来接收返回的数据,此写法的泛型集合不能使用add方法,而<? super T>不能使用get方法,做为接口调用赋值时易出错。 说明:扩展说一下PECS(Producer Extends Consumer Super)原则:第一、频繁往外读取内容的,适合用<? extends T>。第二、经常往里插入的,适合用<? super T>。

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

正例:

Iterator<String> iterator = list.iterator();
    while (iterator.hasNext()) {

        String item = iterator.next();

        if (删除元素的条件) {

        iterator.remove();
    }
}

反例:

List<String> list = new ArrayList<String>();

    list.add("1");

    list.add("2");

    for (String item : list) {

    if ("1".equals(item)) {

        list.remove(item);

    }
}

说明:以上代码的执行结果肯定会出乎大家的意料,那么试一下把“1”换成“2”,会是同样的 结果吗?

8.【强制】 在 JDK7 版本及以上,Comparator 要满足如下三个条件,不然 Arrays.sort, Collections.sort 会报 IllegalArgumentException 异常。说明:三个条件如下

1) x,y的比较结果和y,x的比较结果相反。

3) x=y,则x,z比较结果和y,z比较结果相同。

2) x>y,y>z,则x>z。 反例:下例中没有处理相等的情况,实际使用中可能会出现异常:

new Comparator<Student>() {

    @Override
    public int compare(Student o1, Student o2) {
        return o1.getId() > o2.getId() ? 1 : -1;
    }

};
  1. 【推荐】集合初始化时,指定集合初始值大小。说明:HashMap使用HashMap(int initialCapacity) 初始化,正例:initialCapacity = (需要存储的元素个数 / 负载因子) + 1。注意负载因子(即 loader factor)默认为 0.75,如果暂时无法确定初始值大小,请设置为 16(即默认值)。 反例:HashMap 需要放置 1024 个元素,由于没有设置容量初始大小,随着元素不断增加,容量 7 次被迫扩大,resize 需要重建 hash 表,严重影响性能。

10.【推荐】使用 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 值组合集合。

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

集合类KeyValueSuper说明Hashtable不允许为 null不允许为 nullDictionary线程安全ConcurrentHashMap不允许为 null不允许为 nullAbstractMap锁分段技术(JDK8:CAS)TreeMap不允许为 null允许为 nullAbstractMap线程不安全HashMap允许为 null允许为 nullAbstractMap线程不安全反例: 由于 HashMap 的干扰,很多人认为 ConcurrentHashMap 是可以置入 null 值,而事实上,存储 null 值时会抛出 NPE 异常。

  1. 【参考】合理利用好集合的有序性(sort)和稳定性(order),避免集合的无序性(unsort)和不稳定性(unorder)带来的负面影响。 说明:有序性是指遍历的结果是按某种比较规则依次排列的。稳定性指集合每次遍历的元素次序是一定的。如:ArrayList 是 order/unsort;HashMap 是 unorder/unsort;TreeSet 是 order/sort。

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

(六) 多线程处理

  1. 【强制】获取单例对象需要保证线程安全,其中的方法也要保证线程安全。说明:工具类、单例工厂类都需要注意。

  2. 【强制】创建线程或线程池时请指定有意义的线程名称,方便出错时回溯。

正例:

public class TimerTaskThread extends Thread {

public TimerTaskThread() {

    super.setName("TimerTaskThread");

    ... 
}
  1. 【强制】线程资源必须通过线程池提供,不允许在应用中自行显式创建线程。 说明:使用线程池的好处是减少在创建和销毁线程上所花的时间以及系统资源的开销,解决资源不足的问题。如果不使用线程池,有可能造成系统创建大量同类线程而导致消耗完内存或者 “过度切换”的问题。

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

    1) FixedThreadPool 和 SingleThreadPool:

    允许的请求队列长度为 Integer.MAX_VALUE,可能会堆积大量的请求,从而导致 OOM。

​ 2) CachedThreadPool 和 ScheduledThreadPool:

允许的创建线程数量为 Integer.MAX_VALUE,可能会创建大量的线程,从而导致 OOM。

  1. 【强制】SimpleDateFormat 是线程不安全的类,一般不要定义为static变量,如果定义为 static,必须加锁,或者使用 DateUtils 工具类。

    正例:注意线程安全,使用 DateUtils。亦推荐如下处理:

private static final ThreadLocal<DateFormat> df = new ThreadLocal<DateFormat>() {

    @Override

    protected DateFormat initialValue() {

        return new SimpleDateFormat("yyyy-MM-dd");

    }

};

说明:如果是 JDK8 的应用,可以使用 Instant 代替 Date,LocalDateTime 代替 Calendar, DateTimeFormatter 代替 SimpleDateFormat,官方给出的解释:simple beautiful strong immutable thread-safe。

  1. 【强制】存在多线程时,同步调用应该去考量锁的性能损耗。能用无锁数据结构,就不要用锁; 能锁代码块,就不要锁整个方法体; 能用对象锁,就不要用类锁。 说明:尽可能使加锁的代码块工作量尽可能的小,避免在锁代码块中调用 RPC 方法。

  2. 【强制】对多个资源、数据库表、对象同时加锁时,需要保持一致的加锁顺序,否则可能会造成死锁。说明:线程一需要对表 A、B、C 依次全部加锁后才可以进行更新操作,那么线程二的加锁顺序也必须是 A、B、C,否则可能出现死锁。

  3. 【强制】并发修改同一记录时,避免更新丢失,需要加锁。要么在应用层加锁,要么在缓存加锁,要么在数据库层使用乐观锁,使用 version 作为更新依据。 说明:如果每次访问冲突概率小于 20%,推荐使用乐观锁,否则使用悲观锁。乐观锁的重试次数不得小于 3 次。

  4. 【强制】多线程并行处理定时任务时,Timer 运行多个 TimeTask 时,只要其中之一没有捕获抛出的异常,其它任务便会自动终止运行,使用 ScheduledExecutorService 则没有这个问题。

  5. 【推荐】使用 CountDownLatch 进行异步转同步操作,每个线程退出前必须调用 countDown 方法,线程执行代码注意 catch 异常,确保 countDown 方法被执行到,避免主线程无法执行至 await 方法,直到超时才返回结果。 说明:注意,子线程抛出异常堆栈,不能在主线程 try-catch 到。

  6. 【推荐】避免 Random 实例被多线程使用,虽然共享该实例是线程安全的,但会因竞争同一 seed 导致的性能下降。

说明:Random 实例包括 java.util.Random 的实例或者 Math.random()的方式。

正例:在 JDK7 之后,可以直接使用 API ThreadLocalRandom,而在 JDK7 之前,需要编码保证每个线程持有一个实例。

12.【推荐】在可能多线程场景下,通过双重检查锁(double-checked locking)实现延迟初始化的优化问题隐患(可参考 The "Double-Checked Locking is Broken" Declaration),推荐解决方案中较为简单一种(适用于 JDK5 及以上版本),将目标属性声明为 volatile 型。

反例:

class Singleton {

    private Helper helper = null;

    public Helper getHelper() {

        if (helper == null)

            synchronized(this) {

                if (helper == null)

                    helper = new Helper();
        }
    return helper;
    }
    // other methods and fields...
}

13.【参考】volatile 解决多线程内存不可见问题。对于一写多读,是可以解决变量同步问题,但是如果多写,同样无法解决线程安全问题。如果是 count++操作,使用如下类实现: AtomicInteger count = new AtomicInteger(); count.addAndGet(1); 如果是 JDK8,推荐使用 LongAdder 对象,比 AtomicLong 性能更好(减少乐观锁的重试次数)。

14.【参考】HashMap 在容量不够进行 resize 时由于高并发可能出现死链,导致 CPU 飙升,在开发过程中可以使用其它数据结构或加锁来规避此风险。

15.【参考】ThreadLocal 无法解决共享对象的更新问题,ThreadLocal 对象建议使用 static 修饰。这个变量是针对一个线程内所有操作共享的,所以设置为静态变量,所有此类实例共享此静态变量 ,也就是说在类第一次被使用时装载,只分配一块存储空间,所有此类的对象(只要是这个线程内定义的)都可以操控这个变量。

(七) 控制语句

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

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

  3. 【推荐】表达异常的分支时,少用 if-else 方式,这种方式可以改写成:

if (condition) { 
    ...
    return obj; 
}
// 接着写 else 的业务逻辑代码;

说明:如果非得使用 if()...else if()...else...方式表达逻辑,【强制】避免后续代码维护困难,请勿超过 3 层。

正例:超过 3 层的 if-else 的逻辑判断代码可以使用卫语句、策略模式、状态模式等来实现, 其中卫语句示例如下:

public void today() { 
    if (isBusy()) {
        System.out.println(“change time.”); return;
    }

    if (isFree()) {
        System.out.println(“go to travel.”);
        return; 
    }

    System.out.println(“stay at home to learn Alibaba Java Coding Guidelines.”);
    return; 
}
  1. 【推荐】除常用方法(如 getXxx/isXxx)等外,不要在条件判断中执行其它复杂的语句,将复杂逻辑判断的结果赋值给一个有意义的布尔变量名,以提高可读性。 说明:很多 if 语句内的逻辑相当复杂,阅读者需要分析条件表达式的最终结果,才能明确什么样的条件执行什么样的语句,那么,如果阅读者分析逻辑表达式错误呢?

正例:

// 伪代码如下

final boolean existed = (file.open(fileName, "w") != null) && (...) || (...); 
if (existed) {
    ... 
}

反例:

if ((file.open(fileName, "w") != null) && (...) || (...)) { 
    ...
}
  1. 【推荐】循环体中的语句要考量性能,以下操作尽量移至循环体外处理,如定义对象、变量、获取数据库连接,进行不必要的 try-catch 操作(这个 try-catch 是否可以移至循环体外)。

  2. 【推荐】接口入参保护,这种场景常见的是用于做批量操作的接口。

(八) 注释规约

  1. 【强制】类、类属性、类方法的注释必须使用 Javadoc 规范,使用/*内容/格式,不得使用 // xxx方式。 说明:在 IDE 编辑窗口中,Javadoc 方式会提示相关注释,生成 Javadoc 可以正确输出相应注释;在 IDE 中,工程调用方法时,不进入方法即可悬浮提示方法、参数、返回值的意义,提高阅读效率。

  2. 【强制】所有的抽象方法(包括接口中的方法)必须要用 Javadoc 注释、除了返回值、参数、 异常说明外,还必须指出该方法做什么事情,实现什么功能。 说明:对子类的实现要求,或者调用注意事项,请一并说明。

  3. 【强制】所有的类都必须添加创建者和创建日期。

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

  5. 【强制】所有的枚举类型字段必须要有注释,说明每个数据项的用途。

  6. 【推荐】与其“半吊子”英文来注释,不如用中文注释把问题说清楚。专有名词与关键字保持英文原文即可。 反例:“TCP 连接超时”解释成“传输控制协议连接超时”,理解反而费脑筋。

  7. 【推荐】代码修改的同时,注释也要进行相应的修改,尤其是参数、返回值、异常、核心逻辑 等的修改。 说明:代码与注释更新不同步,就像路网与导航软件更新不同步一样,如果导航软件严重滞后,就失去了导航的意义。

  8. 【参考】谨慎注释掉代码。在上方详细说明,而不是简单地注释掉。如果无用,则删除。 说明:代码被注释掉有两种可能性:

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

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

  9. 【参考】对于注释的要求:

    第一、能够准确反应设计思想和代码逻辑;

    第二、能够描述业务含义,使别的程序员能够迅速了解到代码背后的信息。完全没有注释的大段代码对于阅读者形同天书,注释是给自己看的,即使隔很长时间,也能清晰理解当时的思路; 注释也是给继任者看的,使其能够快速接替自己的工作。

  10. 【参考】好的命名、代码结构是自解释的,注释力求精简准确、表达到位。避免出现注释的一个极端:过多过滥的注释,代码的逻辑一旦修改,修改注释是相当大的负担。

    反例:

    // put elephant into fridge
    put(elephant, fridge);
    

    方法名 put,加上两个有意义的变量名 elephant 和 fridge,已经说明了这是在干什么,语义清晰的代码不需要额外的注释。

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

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

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

(九) MVP规约

  1. 【强制】对于逻辑较为复杂的Activity类,且代码行数超过500行,必须使用MVP模式;否则可以直接继承Activity或者MActivity类

  2. 【强制】将功请求API、数据库访问及数据的封装的代码放至Model层

(十) 代码整理

  1. 【强制】 Activity、Fragment、Service等生命周期方法必须按顺序放置在class的方法的前面,且生命周期中的方法必须少于50行,超过请拆分方法。
  2. 【强制】每次提交请删除那些被注释掉的代码,必须保证版本管理中的主线代码整洁干净

(十一) 注意事项

  1. 【强制】在使用正则表达式时,利用好其预编译功能,可以有效加快正则匹配速度。 说明:不要在方法体内定义:Pattern pattern = Pattern.compile(规则);

  2. 【强制】注意 Math.random() 这个方法返回是 double 类型,注意取值的范围 0≤x<1(能够 取到零值,注意除零异常),如果想获取整数类型的随机数,不要将 x 放大 10 的若干倍然后取整,直接使用 Random 对象的 nextInt 或者 nextLong 方法。

  3. 【强制】获取当前毫秒数 System.currentTimeMillis(); 而不是 new Date().getTime(); 说明:如果想获取更加精确的纳秒级时间值,使用 System.nanoTime()的方式。在 JDK8 中, 针对统计时间等场景,推荐使用 Instant 类。

  4. 【推荐】任何数据结构的构造或初始化,都应指定大小,避免数据结构无限增长吃光内存。

  5. 【推荐】及时清理不再使用的代码段或配置信息。 说明:对于垃圾代码或过时配置,坚决清理干净,避免程序过度臃肿,代码冗余。 正例:对于暂时被注释掉,后续可能恢复使用的代码片断,在注释代码上方,统一规定使用三个斜杠(///)来说明注释掉代码的理由。

  6. 【强制】为避免类存在内存泄漏的情况,请做好上下文对象及其他对象是否被其他类持有,导致当前类无法被GC。

二、异常日志

(一) 异常处理

  1. 【强制】Java 类库中定义的一类 RuntimeException 可以通过预先检查进行规避,而不应该通过catch 来处理,比如:IndexOutOfBoundsException,NullPointerException等等。 说明:无法通过预检查的异常除外,如在解析一个外部传来的字符串形式数字时,通过 catch NumberFormatException 来实现。

    正例:

    if (obj != null) {
        ...
    }
    

    反例:

    try { 
        obj.method() 
    } catch (NullPointerException e) {
        ...
    }
    
  2. 【强制】异常不要用来做流程控制,条件控制,因为异常的处理效率比条件分支低。

  3. 【强制】对大段代码进行 try-catch,这是不负责任的表现。catch 时请分清稳定代码和非稳定代码,稳定代码指的是无论如何不会出错的代码。对于非稳定代码的 catch 尽可能进行区分异常类型,再做对应的异常处理。

  4. 【强制】捕获异常是为了处理它,不要捕获了却什么都不处理而抛弃之,如果不想处理它,请将该异常用框架包中的ExUtils类来处理。最外层的业务使用者,必须处理异常,将其转化为用户可以理解的内容。

  5. 【强制】有 try 块放到了事务代码中,catch 异常后,如果需要回滚事务,一定要注意手动回滚事务。

  6. 【强制】finally 块必须对资源对象、流对象进行关闭,有异常也要做 try-catch。 说明:如果 JDK7 及以上,可以使用 try-with-resources 方式。

  7. 【强制】不能在 finally 块中使用 return,finally 块中的 return 返回后方法结束执行,不会再执行 try 块中的 return 语句。

  8. 【强制】捕获异常与抛异常,必须是完全匹配,或者捕获异常是抛异常的父类。 说明:如果预期对方抛的是绣球,实际接到的是铅球,就会产生意外情况。

  9. 【推荐】方法的返回值可以为 null,不强制返回空集合,或者空对象等,必须添加注释充分说明什么情况下会返回 null 值。调用方需要进行 null 判断防止 NPE 问题。 说明:本手册明确防止 NPE 是调用者的责任。即使被调用方法返回空集合或者空对象,对调用者来说,也并非高枕无忧,必须考虑到远程调用失败、序列化失败、运行时异常等场景返回 null 的情况。

  10. 【推荐】防止 NPE,是程序员的基本修养,注意 NPE 产生的场景:

    1)返回类型为基本数据类型,return 包装数据类型的对象时,自动拆箱有可能产生 NPE。 反例:public int f() { return Integer 对象}, 如果为 null,自动解箱抛 NPE。

    2) 数据库的查询结果可能为null。

    3) 集合里的元素即使isNotEmpty,取出的数据元素也可能为null。

    4) 远程调用返回对象时,一律要求进行空指针判断,防止NPE。

    5) 对于Session中获取的数据,建议NPE检查,避免空指针。

    6) 级联调用obj.getA().getB().getC();一连串调用,易产生NPE。 正例:使用 JDK8 的 Optional 类来防止 NPE 问题。

  11. 【推荐】定义时区分unchecked/checked 异常,避免直接抛出newRuntimeException(), 更不允许抛出 Exception 或者 Throwable,应使用有业务含义的自定义异常。推荐业界已定义过的自定义异常,如:DAOException / ServiceException等。

  12. 【参考】避免出现重复的代码(Don’t Repeat Yourself),即DRY原则。

    说明:随意复制和粘贴代码,必然会导致代码的重复,在以后需要修改时,需要修改所有的副本,容易遗漏。必要时抽取共性方法,或者抽象公共类,甚至是组件化。

    正例:一个类中有多个 public 方法,都需要进行数行相同的参数校验操作,这个时候请抽取:

    private boolean checkParam(DTO dto) {...}
    

(二) 日志(埋点)规约

  1. 【强制】每个app都需要实现登录日志接口。
  2. 【强制】对于核心模块需要添加埋点

三、单元测试

  1. 【强制】好的单元测试必须遵守 AIR 原则。 说明:单元测试在线上运行时,感觉像空气(AIR)一样并不存在,但在测试质量的保障上,却是非常关键的。好的单元测试宏观上来说,具有自动化、独立性、可重复执行的特点。A:Automatic(自动化)I:Independent(独立性)  R:Repeatable(可重复)

  2. 【强制】单元测试应该是全自动执行的,并且非交互式的。测试框架通常是定期执行的,执行过程必须完全自动化才有意义。输出结果需要人工检查的测试不是一个好的单元测试。单元测试中不准使用 System.out 来进行人肉验证,必须使用 Log 来验证。

  3. 【强制】保持单元测试的独立性。为了保证单元测试稳定可靠且便于维护,单元测试用例之间决不能互相调用,也不能依赖执行的先后次序。 反例:method2 需要依赖 method1 的执行,将执行结果做为 method2 的输入。

  4. 【强制】单元测试是可以重复执行的,不能受到外界环境的影响。 说明:单元测试通常会被放到持续集成中,每次有代码check in时单元测试都会被执行。如果单测对外部环境(网络、服务、中间件等)有依赖,容易导致持续集成机制的不可用。

  5. 【强制】对于单元测试,要保证测试粒度足够小,有助于精确定位问题。单测粒度至多是类级别,一般是方法级别。 说明:只有测试粒度小才能在出错时尽快定位到出错位置。单测不负责检查跨类或者跨系统的交互逻辑,那是集成测试的领域。

  6. 【强制】核心业务、核心应用、核心模块的增量代码确保单元测试通过。 说明:新增代码及时补充单元测试,如果新增代码影响了原有单元测试,请及时修正。

  7. 【强制】单元测试代码必须写在如下工程目录:src/androidTest,不允许写在业务代码目录下。 说明:源码构建时会跳过此目录,而单元测试框架默认是扫描此目录。

  8. 【推荐】单元测试的基本目标:语句覆盖率达到 70%;核心模块的语句覆盖率和分支覆盖率都要达到 100%

  9. 【推荐】编写单元测试代码遵守 BCDE 原则,以保证被测试模块的交付质量。

    B:Border,边界值测试,包括循环边界、特殊取值、特殊时间点、数据顺序等。

    C:Correct,正确的输入,并得到预期的结果。

    D:Design,与设计文档相结合,来编写单元测试。

    E:Error,强制错误信息输入(如:非法数据、异常流程、非业务允许输入等),并得到预期的结果。

  10. 【推荐】对于数据库相关的查询,更新,删除等操作,不能假设数据库里的数据是存在的, 或者直接操作数据库把数据插入进去,请使用程序插入或者导入数据的方式来准备数据。 反例:删除某一行数据的单元测试,在数据库中,先直接手动增加一行作为删除目标,但是这一行新增数据并不符合业务插入规则,导致测试结果异常。

  11. 【推荐】和数据库相关的单元测试,可以设定自动回滚机制,不给数据库造成脏数据。或者对单元测试产生的数据有明确的前后缀标识。

  12. 【推荐】对于不可测的代码建议做必要的重构,使代码变得可测,避免为了达到测试要求而书写不规范测试代码。

  13. 【推荐】在设计评审阶段,开发人员需要和测试人员一起确定单元测试范围,单元测试最好覆盖所有测试用例(UC)。

  14. 【推荐】单元测试作为一种质量保障手段,不建议项目发布后补充单元测试用例,建议在项目提测前完成单元测试。

  15. 【参考】为了更方便地进行单元测试,业务代码应避免以下情况:

    构造方法中做的事情过多。

    存在过多的全局变量和静态方法。

    存在过多的外部依赖。

    存在过多的条件语句。 说明:多层条件语句建议使用卫语句、策略模式、状态模式等方式重构。

  16. 【参考】不要对单元测试存在如下误解:

    那是测试同学干的事情。本文是开发手册,凡是本文内容都是与开发同学强相关的。

    单元测试代码是多余的。汽车的整体功能与各单元部件的测试正常与否是强相关的。

    单元测试代码不需要维护。一年半载后,那么单元测试几乎处于废弃状态。

    单元测试与线上故障没有辩证关系。好的单元测试能够最大限度地规避线上故障。

四、安全规约

  1. 【强制】尽可能的要求后台开发人员对登录信息进行加密。

  2. 【强制】用户输入的 SQL 参数严格使用参数绑定,防止 SQL 注入, 禁止字符串拼接 SQL 访问数据库。

五、SQLite数据库

(一) 建表规约

  1. 【强制】表达是与否概念的字段,必须使用 is_xxx 的方式命名。

  2. 【强制】表名、字段名必须使用小写字母或数字,禁止出现数字开头,禁止两个下划线中间只出现数字。数据库字段名的修改代价很大,因为无法进行预发布,所以字段名称需要慎重考虑。

正例:ty_user,rdc_config,level3_name 反例:TyAdmin,rdcConfig,level_3_name

  1. 【强制】表名不使用复数名词。 说明:表名应该仅仅表示表里面的实体内容,不应该表示实体数量。

  2. 【推荐】表的命名最好是加上“业务名称_表的作用”。 正例:check_task / force_project / trade_config

  3. 【推荐】库名与应用名称尽量一致。

  4. 【推荐】如果修改字段含义或对字段表示的状态追加时,需要及时更新字段注释。

(二) SQL 语句

  1. 【强制】不要使用 count(列名)或 count(常量)来替代 count(),count()是 SQL92 定义的 标准统计行数的语法,跟数据库无关,跟 NULL 和非 NULL 无关。 说明:count(*)会统计值为 NULL 的行,而 count(列名)不会统计此列为 NULL 值的行。

  2. 【强制】当某一列的值全是 NULL 时,count(col)的返回结果为 0,但 sum(col)的返回结果为 NULL,因此使用 sum()时需注意 NPE 问题。 正例:可以使用如下方式来避免sum的NPE问题:SELECT IF(ISNULL(SUM(g)),0,SUM(g)) FROM table;

  3. 【强制】使用 ISNULL()来判断是否为 NULL 值。 说明:NULL 与任何值的直接比较都为 NULL。

    1) NULL<>NULL的返回结果是NULL,而不是false。

    2) NULL=NULL的返回结果是NULL,而不是true。

    3) NULL<>1的返回结果是NULL,而不是true。

  4. 【强制】在代码中写分页查询逻辑时,若 count 为 0 应直接返回,避免执行后面的分页语句。

  5. 【推荐】操作数据库时,删除和修改记录时,要先 select,避免出现误删除,确认无误才能执行更新语句。

  6. 【推荐】in 操作能避免则避免,若实在避免不了,需要仔细评估 in 后边的集合元素数量,控制在 1000 个之内。

六、工程结构

(一) 项目结构

  1. 【强制】包结构必须使用cn.homily.项目名 或者 com.tjgeo.项目名 开始

  2. 【强制】包结构必须使用cn.homily.项目名.ui.模块名,模块名下如果是MVP模式可以有子包presenter包、model包、view包(view包下存放Activity/fragment/自定义view等,两个或两个以上类似的类需建子包),也可以是不建包

  3. 【强制】包结构必须使用cn.homily.项目名.support包下有db、utils、entities、service、widgets(第三方源码)等

附 1:版权说明

本《Android编码规范(基于Java)》以《阿里巴巴Java开发手册终极版v1.3.0》为基础进行修改,部分版权归阿里巴巴所有,并保留部分所有权。

序号 版本号 修改内容 修改日期 修改人
1 1.0.0 新增1.10.1、1.10.2、2.2.2 20190902 洛易
©2020 洛易                        皖ICP备15026941号-4 该文件修订时间: 2019-10-02 12:54:03

results matching ""

    No results matching ""