Android代码规范

作者: 花椒人生 | 来源:发表于2018-01-09 17:18 被阅读0次

Android编码规范
Android命名规范
Android开发中的优化方案
Android：你不能忽略的代码命名规范
Android代码规范
Android代码规范
Android 代码规范
Android代码规范
Android代码规范
Android代码规范

在刚开始编程的时候，代码毫无规范而言，命名则是根据自己的喜好而来，记得英文的时候直接上英文，忘记的时候直接拼音，有时候想凸显逼格，竟然英文拼音双混合，尤其是自己添加的注释模棱两可，导致后期需求更改的时候，bug修复的时候，代码合并的时候，是何等的酸爽。
所以下面简单总结了一下Android命名规范，注释添加规范，文章后期会有更新，有引用，文章结尾会注明出处。

* 规范编码的目的是让开发者更容易理解他人的代码，而不是约束你编码的方式

* 制定规范不需要太多的理论知识，只要记住两点：尽量简单，多写注释。

标识符命名法

驼峰（Camel）命名法：又称为小驼峰命名法，除首单词外，其余所有单词的第一个字母大写。
帕斯卡（pascal）命名法：又称大驼峰命名法，所有单词的第一个字母大写。
下划线命名法：单词与单词之间用下划线做间隔。
匈牙利命名法：广泛应用于微软编程环境中，在以Pascal命名法的变量前附加小写序列说明该变量的类型。量的取名方式为：<scope> + <prefix_> + <qualifier> 范围前缀，类型前缀，限定词。

AS 规范

尽量使用最新版的IDE进行开发；
编码格式统一为UTF-8；
编辑完.java、 .xml等文件后一定要格式化（基本格式方面使用 AS 默认模板即可）；
删除多余的import，减少警告出现，可利用AS的Optimize Imports(Settings → Keymap → Optimize Imports)快捷键；

Android 命名规范

~ 命名不能反人类（例如：错：PersonActivityAddCustomer.java 正：AddCustomerActivity.java）
~ 要望文而知义，清晰准确。（例如：错：btton1 正：login_btton 或 btnLogin）
~ 严重摒弃 MyGridView之类的命名。
~ 命名规范应当简单明了。

下面说具体规则

Java类文件命名规范。
- Activity命名规范：以Activity为后缀。（例：PersonActivity）
- Adapter命名规范：以Adapter为后缀。（例：PersonAdapter）
- Entity命名规范：以Entity为后缀。（例：PersonEntity）
资源文件命名规范。
- layout目录下的命名规范：
  1. 页面布局文件。以为act_为前缀，以Activity中所在的Pacakage作为中缀，以Activity的名称（去掉Activity后缀）作为后缀。（注：都是小写例：对于Person模块下的AddCustomerActivity act_person_addcustomer.xml）
  2. ListView 中 item 布局文件。以 item_ 作为固定前缀，列表项的名称作为后缀。（注：都是小写。例：某个页面下面有一个用户列表，控件名为 lvUserListView, 那么item的layout 应该是：item_lvUserList.xml）
  3. Dialog 布局文件。以 dlg_ 作为固定前缀，Dialog的功能名称为后缀。（注：都是小写例：dlg_hint.xml ）
- drawable 目录下文件命名规范。drawable目录下大部分都是资源文件，大部分是图片，部分Selector的xml文件。
  1. 对于只有一个页面使用的资源，就以改页面的名称作为前缀。
  2. 对于只在一个模块下面多个页面使用的资源，就以该模块的名称作为前缀。
  3. 对于在各个模块、各个页面都有可能使用的资源（例如上下导航，以 com-mon 作为前缀）。
Java类中控件对象的命名规范。控件类型缩写+控件的逻辑名称（首字母大写例：登录按钮 btnLogin）

WX20180109-171212.png
Layout中控件对象的命名规范。这里建议与Activity中相对于的控件名称保持一致。（例如 Button btnLogin = (Button)findViewById(R.id.sign_in_button)）;
string.xml中常量的命名。
- 因为这些值大多数在Layout中的控件上使用，所以以该常量所在的Activity名称作为前缀，后面接控件名称（例：登录页面中登录按钮上显示的文字 login_Activity_btnLogin_text）;
- 另外一种使用场景是在Java代码中使用，可能出现在Activity中，也可能出现在Utils工具类中，如果是和具体的Activity相关，则和上面一样，如果涉及到公共模块可控件相关，就以common_ 作为前缀。
- string.xml 命名规则，甚至可以按照模块将其拆分成多个string文件，只要resoures标签下都是string标签就行，在编译打包时会将同类文件进行合并。
常量命名。
只能包含首字母和下划线，字母全部大写，单词之间用下划线隔开。

Android 编码规范

要分门别类存放各种类

WX20180109-171150.png

参考Google I/O 2015的代码结构，按功能分包具体可以这样做：

src
└─com
    └─domain
        └─app
            │  AppApplication.java  定义Application类
            │  Config.java          定义配置数据（常量）
            │
            ├─framework
            │      定义interface以及相关基类
            │
            ├─io
            │      数据定义（model）、数据操作（比如json解析，但不包括db操作）
            │
            ├─model
            │      定义model（数据结构以及getter/setter、compareTo、equals等等，不含复杂操作）
            │      以及modelHelper（提供便于操作model的api）
            │
            ├─provider
            │      实现ContentProvider，及其依赖的db操作
            │
            ├─receiver
            │      实现Receiver
            │
            ├─service
            │      实现Service（比如IntentService），用于在独立线程中异步do stuff
            │
            ├─ui
            │      实现BaseActivity，以及自定义view和widget，相关的Adapter也放这里
            │
            ├─util
            │      实现工具类，提供静态方法
            │
            ├─feature1
            │      Item.java                定义model
            │      ItemHelper.java          实现modelHelper
            │      feature1Activity.java    定义UI
            │      feature1DAO.java         私有db操作
            │      feature1Utils.java       私有工具函数
            │      ...其它私有class
            │
            ├─...其它feature

Layout 中的常量，要在资源文件string.xml中定义
Activity 中要设置一些常量，也需要定义在string.xml中
Layout 中所有控件的字体大小，都定义在dimens.xml中，对于所有控件的Margin偏移量，要统一规格。如果有必要，我们要使用style来统一控制风格。
在Activity中，定义新的生命周期，分拆onCreate方法。
Activity中不要嵌套内部类，尽量都独立出来
Adapter 所有的Adapter都放在adapter单独的包中。
数据类型转换一定要进行检验。
使用常量值来代替枚举。