值得你学习的 Android 开发规范(下)

丈夫欲遂平生志,一载寒窗一举汤。这篇文章主要讲述值得你学习的 Android 开发规范(下)相关的知识,希望能为你提供帮助。
4
资源文件规范
4.1 资源布局文件(XML文件(layout布局文件))
全部小写,采用下划线命名法
 
4.1.1 contentView命名
必须以全部单词小写,单词间以下划线分割,使用名词或名词词组。
 
所有Activity或Fragment的contentView必须与其类名对应,对应规则为:将所有字母都转为小写,将类型和功能调换(也就是后缀变前缀)。
 
例如:activity_main.xml
 
4.1.2 Dialog命名
规则:dialog_描述.xml
例如:dialog_hint.xml
 
4.1.3 PopupWindow命名
规则:ppw_描述.xml
例如:ppw_info.xml
 
4.1.4 列表项命名
规则:item_描述.xml
例如:item_city.xml
 
4.1.5 包含项命名
规则:模块_(位置)描述.xml
例如:activity_main_head.xml、activity_main_bottom.xml
注意:通用的包含项命名采用:项目名称缩写_描述.xml
例如:xxxx_title.xml
 
4.2 资源文件(图片drawable文件夹下)
全部小写,采用下划线命名法,加前缀区分
命名模式:可加后缀  _small  表示小图,  _big  表示大图,逻辑名称可由多个单词加下划线组成,采用以下规则:

  • 用途_模块名_逻辑名称
  • 用途_模块名_颜色
  • 用途_逻辑名称
  • 用途_颜色
说明:用途也指控件类型。
 
例如:
值得你学习的 Android 开发规范(下)

文章图片

如果有多种形态,如按钮选择器:btn_xx.xml(selector)
值得你学习的 Android 开发规范(下)

文章图片

注意:使用androidStudio的插件SelectorChapek可以快速生成selector,前提是命名要规范。
 
4.3 动画文件(anim文件夹下)
全部小写,采用下划线命名法,加前缀区分。
 
具体动画采用以下规则:模块名_逻辑名称。
例如:refresh_progress.xml、market_cart_add.xml、market_cart_remove.xml。
 
普通的tween动画采用如下表格中的命名方式:动画类型_方向
值得你学习的 Android 开发规范(下)

文章图片

4.4 values中name命名
4.4.1 colors.xml
colors的name命名使用下划线命名法,在你的colors.xml文件中应该只是映射颜色的名称一个ARGB值,而没有其它的。不要使用它为不同的按钮来定义ARGB值。
 
不要这样做。
值得你学习的 Android 开发规范(下)

文章图片

使用这种格式,你会非常容易的开始重复定义ARGB值,这使如果需要改变基本色变的很复杂。同时,这些定义是跟一些环境关联起来的,如button或者comment, 应该放到一个按钮风格中,而不是在color.xml文件中。
 
相反,这样做
值得你学习的 Android 开发规范(下)

文章图片

向应用设计者那里要这个调色板,名称不需要跟"green"、"blue"等等相同。"brand_primary"、"brand_secondary"、"brand_negative"这样的名字也是完全可以接受的。 像这样规范的颜色很容易修改或重构,会使应用一共使用了多少种不同的颜色变得非常清晰。 通常一个具有审美价值的UI来说,减少使用颜色的种类是非常重要的。
 
注意:如果某些颜色和主题有关,那就独立出去写。
 
4.4.2 dimens.xml
像对待colors.xml一样对待dimens.xml文件 与定义颜色调色板一样,你同时也应该定义一个空隙间隔和字体大小的“调色板”。 一个好的例子,如下所示:
值得你学习的 Android 开发规范(下)

文章图片

布局时在写margins和paddings时,你应该使用spacing_xxxx尺寸格式来布局,而不是像对待string字符串一样直接写值。 这样写会非常有感觉,会使组织和改变风格或布局是非常容易。
 
4.4.3 strings.xml
strings的name命名使用下划线命名法,采用以下规则:模块名+逻辑名称,这样方便同一个界面的所有string都放到一起,方便查找。
值得你学习的 Android 开发规范(下)

文章图片

4.4.4 styles.xml
style的name命名使用大驼峰命名法,几乎每个项目都需要适当的使用style文件,因为对于一个视图来说有一个重复的外观是很常见的,将所有的外观细节属性(colors、padding、font)放在style文件中。 在应用中对于大多数文本内容,最起码你应该有一个通用的style文件,例如:
值得你学习的 Android 开发规范(下)

文章图片

应用到TextView中:
值得你学习的 Android 开发规范(下)

文章图片

你或许需要为按钮控件做同样的事情,不要停止在那里。将一组相关的和重复android:****的属性放到一个通用的style中。
 
将一个大的style文件分割成多个文件, 你可以有多个styles.xml 文件。Android SDK支持其它文件,styles这个文件名称并没有作用,起作用的是在文件 里xml的< style> 标签。因此你可以有多个style文件styles.xml、style_home.xml、style_item_details.xml、styles_forms.xml。 不同于资源文件路径需要为系统构建起的有意义,在res/values目录下的文件可以任意命名。
 
4.5 layout中的id命名
命名模式为:view缩写_模块名_逻辑名,比如btn_main_search
使用AndroidStudio的插件ButterKnife Zelezny,生成注解非常方便,原生的话可以使用Android Code Generator插件。
 
5
版本统一规范
Android开发存在着众多版本的不同,比如compileSdkVersion、minSdkVersion、targetSdkVersion以及项目中依赖第三方库的版本,不同的module及不同的开发人员都有不同的版本,所以需要一个统一版本规范的文件。
 
6
第三方库规范
希望Team能用时下较新的技术,对开源库的选取,一般都需要选择比较稳定的版本,作者在维护的项目,要考虑作者对issue的解决,以及开发者的知名度等各方面。选取之后,一定的封装是必要的。
 
个人推荐Team可使用如下优秀轮子:
  • Retrofit
  • RxAndroid
  • OkHttp
  • Glide  /  Fresco
  • Gson  /  Fastjson
  • EventBus  /  AndroidEventBus
  • GreenDao
  • Dagger2(选用)
  • Tinker(选用)
 
7
注释规范
为了减少他人阅读你代码的痛苦值,请在关键地方做好注释。
 
7.1 类注释
每个类完成后应该有作者姓名和联系方式的注释,对自己的代码负责。
值得你学习的 Android 开发规范(下)

文章图片

具体可以在AS中自己配制,Settings → Editor → File and Code Templates → Includes → File Header,输入
值得你学习的 Android 开发规范(下)

文章图片

这样便可在每次新建类的时候自动加上该头注释。
 
7.2 方法注释
每一个成员方法(包括自定义成员方法、覆盖方法、属性方法)的方法头都必须做方法头注释,在方法前一行输入/** + 回车或者设置Fix doc comment(Settings → Keymap → Fix doc comment)快捷键,AS便会帮你生成模板,我们只需要补全参数即可,如下所示。
值得你学习的 Android 开发规范(下)

文章图片

7.3 块注释
块注释与其周围的代码在同一缩进级别。它们可以是/* ... */风格,也可以是// ...风格(//后最好带一个空格)。对于多行的/* ... */注释,后续行必须从*开始, 并且与前一行的*对齐。以下示例注释都是OK的。
值得你学习的 Android 开发规范(下)

文章图片

注释不要封闭在由星号或其它字符绘制的框架里。
Tip:在写多行注释时,如果你希望在必要时能重新换行(即注释像段落风格一样),那么使用/* ... */。
 
7.4 其他一些注释
AS已帮你集成了一些注释模板,我们只需要直接使用即可,在代码中输入todo、fixme等这些注释模板,回车后便会出现如下注释。
值得你学习的 Android 开发规范(下)

文章图片

 
8
其他的一些规范
  1. 合理布局,有效运用< merge> 、< ViewStub> 、< include> 标签;
  2. Activity和Fragment里面有许多重复的操作以及操作步骤,所以我们都需要提供一个BaseActivity和BaseFragment,让所有的Activity和Fragment都继承这个基类。
  3. 方法基本上都按照调用的先后顺序在各自区块中排列;
  4. 相关功能作为小区块放在一起(或者封装掉);
  5. 当一个类有多个构造函数,或是多个同名方法,这些函数/方法应该按顺序出现在一起,中间不要放进其它函数/方法;
  6. 数据提供统一的入口。无论是在 MVP、MVC 还是 MVVM 中,提供一个统一的数据入口,都可以让代码变得更加易于维护。比如可使用一个DataManager,把 http、preference、eventpost、database 都放在DataManger里面进行操作,我们只需要与DataManger打交道;
  7. 多用组合, 少用继承;
  8. 提取方法, 去除重复代码。对于必要的工具类抽取也很重要,这在以后的项目中是可以重用的。
  9. 可引入 Dagger2 减少模块之间的耦合性。Dagger2 是一个依赖注入框架,使用代码自动生成创建依赖关系需要的代码。减少很多模板化的代码,更易于测试,降低耦合,创建可复用可互换的模块;
  10. 项目引入Rxjava  +  RxAndroid这些响应式编程,可以极大的减少逻辑代码;
  11. 通过引入事件总线,如:EventBus、AndroidEventBus、RxBus,它允许我们在DataLayer中发送事件,以便ViewLayer中的多个组件都能够订阅到这些事件,减少回调;
  12. 尽可能使用局部变量;
  13. 及时关闭流;
  14. 尽量减少对变量的重复计算;
 
如下面的操作:
值得你学习的 Android 开发规范(下)

文章图片

建议替换为:
值得你学习的 Android 开发规范(下)

文章图片

15.尽量采用懒加载的策略,即在需要的时候才创建;
 
例如:
值得你学习的 Android 开发规范(下)

文章图片

建议替换为:
值得你学习的 Android 开发规范(下)

文章图片

16.不要在循环中使用try…catch…,应该把其放在最外层;
17.使用带缓冲的输入输出流进行IO操作;
18.尽量使用HashMap、ArrayList、StringBuilder,除非线程安全需要,否则不推荐使用Hashtable、Vector、StringBuffer,后三者由于使用同步机制而导致了性能开销;
19.尽量在合适的场合使用单例;
使用单例可以减轻加载的负担、缩短加载的时间、提高加载的效率,但并不是所有地方都适用于单例,简单来说,单例主要适用于以下三个方面:
  • 控制资源的使用,通过线程同步来控制资源的并发访问
  • 控制实例的产生,以达到节约资源的目的
  • 控制数据的共享,在不建立直接关联的条件下,让多个不相关的进程或线程之间实现通信
20.把一个基本数据类型转为字符串,基本数据类型.toString()是最快的方式、String.valueOf(数据)次之、数据 + ""最慢;
21.使用AS自带的Lint来优化代码结构(什么,你不会?右键module、目录或者文件,选择Analyze → Inspect Code);
22.最后不要忘了内存泄漏的检测;
 
最后啰嗦几句:
  • 好的命名规则能够提高代码质量,使得新人加入项目的时候降低理解代码的难度;
  • 规矩终究是死的,适合团队的才是最好的;
  • 命名规范需要团队一起齐心协力来维护执行,在团队生活里,谁都不可能独善其身;
  • 一开始可能会有些不习惯,持之以恒,总会成功的。
 
附录
UI控件缩写表
值得你学习的 Android 开发规范(下)

文章图片
值得你学习的 Android 开发规范(下)

文章图片

常见的英文单词缩写表
值得你学习的 Android 开发规范(下)

文章图片
值得你学习的 Android 开发规范(下)

文章图片

程序中使用单词缩写原则:不要用缩写,除非该缩写是约定俗成的。
 
参考Android 开发最佳实践
Android 编码规范
阿里巴巴Java开发手册
Google Java编程风格指南
【值得你学习的 Android 开发规范(下)】小细节,大用途,35 个 Java 代码性能优化总结!


    推荐阅读