2020-06-26阿里巴巴Android规范文档

前言

一份合格的代码不应只满足于实现功能，更应该遵循良好的规范，遵循良好的代码规范有利于：

1.提升程序稳定性，减少代码隐患，降低故障率；

2.增强可展性，大幅提高维护效率。

3.统一标准，提升多人协作效率。

4.方便信任快速上手，在项目组人员发生变动时保证项目进度；

这里梳理一下android开发过程中需要注意的一些地方，包括多个部分，另外根据约束力强弱分为两类：

1.强制：

如果不遵循会导致代码容易混乱，后期维护复杂，设置出现严重bug;

2.推荐：

如果不遵守可能会导致代码描述不清，理解困难，导致功能越多维护越难的问题；

规范正文

系统设计

强制：

1.不允许出现两段相同的逻辑块，必须抽出公共方法，差异性使用参数控制，避免修改时多处修改导致遗漏。

2.不允许出现两段相同的处于同一逻辑组的复杂布局，必须抽为单独的include/merge.

3.不允许父类中出现子类具体方法，如果需要的话可以父类定义抽象方法，交由子类实现；

4.不允许Activity内多个Fragment之间的直接沟通，必须通过Acitivity中转。

推荐：

1.推荐使用MVP或者MVVM架构。

2.推荐使用Kotlin语言。

3.采用模块分类替代文件类别方式，方便快速查找模块相关内容，ex:

LoginActivity/LoginPreenter/LoginHttpRequest/LoginBean/LoginAdapter等所属同一登录模块的文件放入一个文件夹，而不是所有activity放入一个文件夹，所有Adapter放入一个文件夹。

命名方式：

强制：

1.不允许出现中文命名方式；

2.java/kotlin文件使用大驼峰方式 ex: LoginActivity.kt ,NewAdapter.kt, NewsBean.java;

3.layout/drawable/anim/style的resource文件使用小写+下划线的方式，ex: login_activity.xml, login_logo.png;

4.类的定义使用大驼峰方式，ex: classLoginPresenter{} , NewsBean newsBean;

5.对象使用小驼峰方式，ex:LoginPresenter loginPrersenter, NewsBeans newsBeans;

6.静态敞亮使用全大写+下划线的方式，ex: public static final boolean IS_RELESAE = ture;

7.Kotlin 使用的布局中的控件id必须使用小驼峰方式，ex：android:id="@+id/tvLogin";

推荐：

1.java定义的父类中定义的方法如果子类重写会导致问题时，添加final关键字；

注释相关

类/复杂或者不能从方法名看出意图的方法必须添加注释，当类/复杂添加注释时，必须使用此类型注释：

类/复杂或者不能从方法名字看出意图的方法必须添加注释, 当类/方法添加注释时, 必须使用此类型注释:

/**

* Created by XXX on 2019/6/19.

* 描述此类作用, 逻辑复杂的说明一下主要思路

public class LoginPresenter {

/**

* 用于进行网络请求

* @params xxx XXX

public void doLoginRequest(...){}

}

变量注释不允许使用与类/方法一致的注释形式;

方法注释中不允许出现@params, @return的参数描述错误的情况, 必须实时更新;

推荐：

一段逻辑建议使用/* */的方式;

方法/参数建议添加 @Nullable, @NotNull, @UiThread 等注解;

代码风格

此Git目录下同时存在 AndroidCodeStyleSetting.jar配置文件，用于AndroidStudio导入后按照统一风格进入代码的格式.

如果没有编写代码时随时格式化代码的习惯。可以在andoridS徒弟哦版本控制提交窗口右侧Before Commit中勾选Reformat code 选项。

Android基本组件

强制：

1.intent通信时不允许传递1M的数据，可以采用外部Ptesenter中转或者EventBus传递的方式。

2.intent隐式启动时必须检查目标是否存在，否则会出现目标未找到崩溃。 if (getPackageManager().resolveActivity(intent, PackageManager.MATCH_DEFAULT_ ONLY) != null);

3.Acitivity/Service/BroadcastReceiver内如果有耗时操作，必须采用多线程处理；

4.应用内部发送广播时，只能使用：

LocalBroadcastManager.getInstance(this).sendBroadcast(intent), 不允许 context.sendBroadcast(intent), 避免外部应用拦截;

5.不允许在Application中缓存数据，全局的共享数据可以使用persenter存储，或者使用sharedpreference读写；

6.Activity或者Fragment中动态注册BroadCastReceiver时，registerReceiver和unregisterReceiver必须要成对出现。

推荐：

1.Activity#onPause/onStop中结合isFinishing 的判断来执行资源的释放，避免放在执行时机较晚的Acitivity#onDestroy()中实行。

2.不要在Activity#onPause中执行耗时操作，这样会导致界面跳转卡顿，可以放入Activity#onStop中执行。

ui布局

强制：

1.局部xml优先使用ConstainLayout,可以保证无嵌套的情况下完成包括部分空间同时显隐需求在内的99%的布局要求；

2.不允许使用ScrollView包裹ListView/GridView/ExpandableListVIew.复杂多项列表可以使用ItemType进行处理；

推荐：

在Activity中显示对话框或弹出浮层时，尽量使用DiaglogFragment,而非Dialog/AlertDialog.便于Activity生命周期管理弹窗的生命周期；

进程/线程/消息推送

强制：

1.存在多进程的情况时，Application中的初始化代码要根据进程分别处理，避免初始化不必要的业务；

2.新建线程时，必须通过线程池的方式。不允许采用new Thread()方式。

3.Activity/Fragment使用handler时。必须使用静态内部类+WeakReferences方式或者在OnStop中调用hander.removeCallbacksAndMessages;

推荐：

多进程间共享数据ContentProvider 代替 sharePreferences#MODE_MULTI_PROCESS;

文件/数据库

强制：

1.使用系统API获取文件路径，避免手拼字符串，ex:

Android.os.Environment#getExternalStorageDirectroy().Context#getFileDir(),错误示例：File file = new File("/mnt/sdcard/Download/Album",name);

2.当使用外部存储时，必须检查外部存储的可用性：

Environment.MEDIA_MOUNTED.equals(Environment.getExternalStorageState());

3.数据库Cursor使用后必须关闭，以免内存泄露。

推荐：

SharePreference仅存储简单数据类型，不要存储复杂数据，如json数据/bitmap编码等。

sharePreference提交数据时，尽量使用Eidtor#apply()，而非Editor.commit();

图片/动画

强制：

1.加载大图时，必须在子线程中处理。否则会卡UI；

2.在Activity.onPause()/onStop()中关闭当前activity正在执行的动画；

推荐：

1.android图片建议转化为webP格式，可以减少APK体积。

2.动画尽量不要使用AnimationDrawable,占用非常多的内存；

3.使用ARGB_565代替ARGB_888，减少内存的占用。

4.当Animations执行结束时，调用View.clearAnimation()释放相关的资源；

安全性

强制：

1.上线包必须混淆；

2.加解密的密匙/盐不允许硬编码到代码中，以防止反编译获取；

3.https处理时必须校验证书，不允许直接接受任意证书；

4.使用Android的 AES/DES/DESede加密算法时，不要使用默认的加密模式ECB，应显示指定使用CBC/CFB加密模式；

5.禁止把敏感信息打印于log中。

6.在应用发布时必须确保android:debuggable为fasle;

7.必须利用X509TrusManager子类中的checkServerTrusted函数校验服务器端证书的合法性；

8.必须将andorid:allowbackup属性设置为false,防止adb backup到出应用数据。