转载

腾讯架构师教你如何写出Android规范文档

前言

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

提升程序稳定性, 减少代码隐患, 降低故障率;
增强可扩展性, 大幅提高维护效率;
统一标准, 提升多人协作效率;
方便新人快速上手, 在项目组人员发生变动时保证项目进度;

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

强制: 如果不遵守会导致代码严重混乱, 后期维护复杂, 甚至会出现严重bug;
推荐: 如果不遵守可能会导致代码描述不清, 理解困难, 导致功能越多维护越难的问题;

腾讯架构师教你如何写出Android规范文档

下面是规范正文

系统设计

强制：

不允许出现两段相同的逻辑块, 必须抽出为公共方法, 差异性使用参数控制, 避免修改时多处修改导致遗漏;
不允许出现两段相同的处于同一逻辑组的复杂布局, 必须抽为单独的include/merge;
不允许父类中出现子类具体方法, 如果需要的话可以父类定义抽象方法, 交由子类实现;
不允许Activity内多Fragment之间的直接沟通, 必须通过Activity中转;

命名方式

强制：

不允许出现中文命名方式;
java/kotlin文件使用大驼峰方式, 例: LoginActivity.kt, NewsAdapter.kt, NewsBean.java;
layout/drawable/anim/style等resource文件使用小写+下划线的方式, 例: login_activity.xml, login_logo.png;
类定义使用大驼峰方式, 例: class LoginPresenter {}, class NewsBean {};
对象使用小驼峰方式, 例: LoginPresenter loginPresenter, NewsBean newsBean;
静态常量使用全大写+下划线的方式, 例: public static final boolean IS_RELESAE = true;
Kotlin使用的布局中的控件id必须使用小驼峰方式, 例: android:id="@+id/tvLogin"

可见性

强制：

所有新定义的类/方法, 默认写成private, 只有在其他类需要引用时再看情况标为public, protected, package-private;

注释相关

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

/** 
* Created by XXX on 2019/6/19. 
* 描述此类作用, 逻辑复杂的说明一下主要思路 
*/ 
public class LoginPresenter { 
/** 
* 用于进行网络请求 
* @params xxx XXX 
*/ 
public void doLoginRequest(...){} 
}

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

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

代码风格

此git目录下同时存有 AndroidCodeStyleSetting.jar 配置文件, 用于AndroidStudio导入后按照统一风格进行代码的格式化.
如果没有编写代码时随时格式化代码的习惯, 可以在AndroidStudio版本控制提交窗口右侧Before Commit中勾选Reformat code选项.

Android基本组件

强制：

Intent通信时不允许传递超过1M的数据, 可以采用外部Presenter中转或者EventBus传递的方式;
Intent隐式启动时必须检查目标是否存在, 否则会出现目标未找到崩溃: if (getPackageManager().resolveActivity(intent, PackageManager.MATCH_DEFAULT_ ONLY) != null);
Activity/Service/BroadcastReceiver内如果有耗时操作, 必须采用多线程进行处理;
应用内部发送广播时, 只能使用LocalBroadcastManager.getInstance(this).sendBroadcast(intent), 不允许 context.sendBroadcast(intent), 避免外部应用拦截;
不允许在Application中缓存数据, 全局的共享数据可以使用某presenter存储, 或者使用SharedPreference读写;
Activity或者Fragment中动态注册BroadCastReceiver时，registerReceiver和unregisterReceiver必须要成对出现;

UI/布局

强制：

布局xml优先使用ConstraintLayout, 可以保证无嵌套的情况下完成包括部分控件同时显隐需求在内的99%的布局要求;
不允许使用ScrollView包裹ListView/GridView/ExpandableListVIew等列表View, 复杂多项式列表可以使用多ItemType进行处理;

进程/线程/消息推送

强制：

存在多进程的情况时, Application中的初始化代码要根据进程分别处理, 避免初始化不必要的业务;
新建线程时, 必须通过线程池的方式, 不允许采用new Thread()的方式;
Activity/Fragment中使用Handler时, 必须使用静态内部类+WeakReferences方式或者在onStop中调用handler.removeCallbacksAndMessages;

文件/数据库

强制：

使用系统API获取文件路径, 避免手拼字符串, 例: android.os.Environment#getExternalStorageDirectory(), Context#getFilesDir(), 错误示例: File file = new File("/mnt/sdcard/Download/Album", name);
当使用外部存储时, 必须检查外部存储的可用性: Environment.MEDIA_MOUNTED.equals(Environment.getExternalStorageState());
数据库Cursor使用之后必须关闭, 以免内存泄漏;