|
|
51CTO旗下网站
|
|
移动端

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

一份合格的代码不应只满足于实现功能, 更应该遵循良好的规范. 遵循良好的代码规范有利于:提升程序稳定性, 减少代码隐患, 降低故障率;增强可扩展性, 大幅提高维护效率;统一标准, 提升多人协作效率;方便新人快速上手, 在项目组人员发生变动时保证项目进度。

作者:techlearn来源:安卓巴士|2019-10-31 09:52

【线上直播】11月21日晚8点贝壳技术总监侯圣文《数据安全之数据库安全黄金法则》

前言

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

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

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

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

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

下面是规范正文

系统设计

强制:

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

推荐:

  • 推荐使用MVP或者MVVM架构;
  • 推荐使用Kotlin语言;
  • 采用模块分类方式替代文件类别方式, 方便快速查找模块相关内容, 例: LoginActivity/LoginPreenter/LoginHttpRequest/LoginBean/LoginAdapter等所属同一登录模块的文件放入一个文件夹, 而不是所有activity放入一个文件夹, 所有adapter放入一个文件夹。

命名方式

强制:

  • 不允许出现中文命名方式;
  • 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"。

推荐:

  • 文件/资源命名时采用 模块+类型 的方式, 以便迅速查找相关内容, 例如登录页面: LoginActivity.kt, login_activity.xml, login_logo.png, 网络错误, #f3f3f3
  • java使用的布局中的id名建议使用小驼峰方式, 并且使用控件类型缩写开头, 例: android:id="@+id/tvLogin", 附录常用控件缩写:

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

可见性

强制:

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

推荐:

  • java定义的父类中定义的方法如果子类重写会导致问题时, 添加final关键字;

注释相关

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

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

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

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

推荐:

  • 一段逻辑建议使用/* */的方式;
  • 方法/参数建议添加 @Nullable, @NotNull, @UiThread 等注解;

代码风格

  • 此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必须要成对出现;

推荐:

  • Activity#onPause/onStop中结合isFinishing的判断来执行资源的释放, 必免放在执行时机较晚的Activity#onDestroy()中执行;
  • 不要在Activity#onPause中执行耗时操作, 这样会导致界面跳转卡顿, 可以放入Activity#onStop中执行;

UI/布局

强制:

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

推荐:

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

进程/线程/消息推送

强制:

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

推荐:

  • 多进程间共享数据使用ContentProvider替代SharedPreferences#MODE_MULTI_PROCESS;

文件/数据库

强制:

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

推荐:

SharedPreference仅存储简单数据类型, 不要存储复杂数据, 如json数据/Bitmap编码等;

SharedPreference提交数据时, 尽量使用Editor#apply(), 而非Editor#commit();

图片/动画

强制:

  • 加载大图时必须在子线程中处理, 否则会卡UI;
  • 在Activity.onPause()/onStop()中关闭当前activity正在执行的动画;

推荐:

  • Android图片建议转化为WebP格式, 可以减少APK体积;
  • 动画尽量不要使用AnimationDrawable, 占用非常多内存;
  • 使用ARGB_565代替ARGB_888, 减少内存占用;
  • 当Animation执行结束时, 调用View.clearAnimation()释放相关资源;

安全性

强制:

  1. 上线包必须混淆;
  2. 加解密的秘钥/盐不允许硬编码到代码中, 以防反编译获取;
  3. Https处理时必须校验证书, 不允许直接接受任意证书;
  4. 使用Android的AES/DES/DESede加密算法时, 不要使用默认的加密模式ECB, 应显示指定使用CBC/CFB加密模式;
  5. 禁止把敏感信息打印到log中;
  6. 在应用发布时必须确保android:debuggable为false;
  7. 必须利用X509TrustManager子类中的checkServerTrusted函数效验服务器端证书的合法性,
  8. 必须将android:allowbackup属性设置为false, 防止adb backup导出应用数据。 

【编辑推荐】

  1. 安卓封闭堕落or自我救赎?谈Android 10的巨大变化
  2. 如何正确的在 Android 上使用 Kotlin 协程?
  3. Android 中的“后台无效动画“行为分析
  4. Chrome OS 80 将可以直接构建 Android 应用
  5. Google 努力了三年,终于让 Android 手机的升级速度变快了些
【责任编辑:未丽燕 TEL:(010)68476606】

点赞 0
分享:
大家都在看
猜你喜欢

订阅专栏+更多

骨干网与数据中心建设案例

骨干网与数据中心建设案例

高级网工必会
共20章 | 捷哥CCIE

378人订阅学习

中间件安全防护攻略

中间件安全防护攻略

4类安全防护
共4章 | hack_man

136人订阅学习

CentOS 8 全新学习术

CentOS 8 全新学习术

CentOS 8 正式发布
共16章 | UbuntuServer

284人订阅学习

读 书 +更多

Head First 设计模式(中文版)

本书共有14章,每章都介绍了几个设计模式,完整地涵盖了四人组版本全部23个设计模式。前言先介绍这本书的用法;第1章到第11章陆续介绍的设...

订阅51CTO邮刊

点击这里查看样刊

订阅51CTO邮刊

51CTO服务号

51CTO官微