Android 你应该注意的开发规范

学向勤中得,萤窗万卷书。这篇文章主要讲述Android 你应该注意的开发规范相关的知识,希望能为你提供帮助。
本文由Blankj投稿。
Blankjd的博客地址:
http://www.jianshu.com/u/46702d5c6978
 
为了利于项目维护以及规范开发,促进成员之间Code Review的效率,故提出以下开发规范,如有更好建议,欢迎到GitHub提issue。
 

https://github.com/Blankj/androidStandardDevelop

 
1
AS规范
 
工欲善其事,必先利其器。
 
  1. 尽量使用最新版的IDE进行开发;
  2. 编码格式统一为UTF-8;
  3. 编辑完.java、  .xml等文件后一定要格式化(基本格式方面使用 AS 默认模板即可);
  4. 删除多余的import,减少警告出现,可利用AS的Optimize Imports(Settings → Keymap → Optimize Imports)快捷键;
  5. AS常用开发插件可以参考这里~AS常用开发插件(http://www.jianshu.com/p/c76b0d8a642d)
     
2
命名规范
 
代码中的命名严禁使用拼音与英文混合的方式,更不允许直接使用中文的方式。正确的英文拼写和语法可以让阅读者易于理解,避免歧义。
 
注意:即使纯拼音命名方式也要避免采用。但alibaba、taobao、youku、hangzhou等国际通用的名称,可视同英文。
  2.1 包名 
包名全部小写,连续的单词只是简单地连接起来,不使用下划线,采用反域名命名规则,全部使用小写字母。
 
一级包名是顶级域名,通常为com,edu,gov,net,org等,二级包名为公司名,三级包名根据应用进行命名,后面就是对包名的划分了,关于包名的划分,推荐使用按功能分,一开始我们也是按照层去分包的,很坑爹。
 
按照功能分可能你不是很好区分在哪个功能中,不过也比你按照层区分要好找很多。
 
具体可以参考这篇博文~Package by features, not layers:
 
https://medium.com/@cesarmcferreira/package-by-features-not-layers-2d076df1964d#.mp782izhh
 
当然,我们大谷歌也有相应的sample~iosched
 
https://github.com/google/iosched/tree/master/android/src/main/java/com/google/samples/apps/iosched
 
其结构很值得学习(自己clone看一下,太长了,在手机端不太好阅读)。
 
参考Google I/O 2015的代码结构,按功能分包具体可以这样做:
 
Android 你应该注意的开发规范

文章图片

 
PBF(按功能分包Package By Feature)与PBL(按层分包Package By Layer)相比较有如下优势:
 
package内高内聚,package间低耦合
 
哪块要添新功能,只改某一个package下的东西;
 
按class职能分层(PBL)降低了代码耦合,但带来了package耦合,要添新功能,需要改model、dbHelper、view、service等等,需要改动好几个package下的代码,改动的地方越多,越容易产生新问题,不是吗?
 
按功能分包(PBF),featureA相关的所有东西都在featureA包,feature内高内聚高度模块化,不同feature之间低耦合,相关的东西都放在一起,还好找
 
package有私有作用域(package-private scope)
 
你负责开发这块功能,这个目录下所有东西都是你的;
 
PBL的方式是把所有工具方法都放在util包下,小张开发新功能时候发现需要一个xxUtil,但它又不是通用的,那应该放在哪里?
 
没办法,按照分层原则,我们还得放在util包下,好像不太合适,但放在其它包更不合适,功能越来越多,util类也越定义越多。后来小李负责开发一块功能时发现需要一个xxUtil,同样不通用,去util包一看,怎么已经有了,而且还没法复用,只好放弃xx这个名字,改为xxxUtil……因为PBL的package没有私有作用域,每一个包都是public(跨包方法调用是很平常的事情,每一个包对其它包来说都是可访问的)
 
如果是PBF,小张的xxUtil自然放在feautreA下,小李的xxUtil在featureB下,如果觉得util好像是通用的,就去util包看看要不要把工具方法添进xxUtil,class命名冲突没有了;
 
PBF的package有私有作用域,featureA不应该访问featureB下的任何东西(如果非访问不可,那就说明接口定义有问题)
 
很容易删除功能
 
统计发现新功能没人用,这个版本那块功能得去掉
 
如果是PBL,得从功能入口到整个业务流程把受到牵连的所有能删的代码和class都揪出来删掉,一不小心就完蛋;
如果是PBF,好说,先删掉对应包,再删掉功能入口(删掉包后入口肯定报错了),完事。
 
高度抽象
 
解决问题的一般方法是从抽象到具体,PBF包名是对功能模块的抽象,包内的class是实现细节,符合从抽象到具体,而PBL弄反了;
 
PBF从确定AppName开始,根据功能模块划分package,再考虑每块的具体实现细节,而PBL从一开始就要考虑要不要dao层,要不要com层等等
 
只通过class来分离逻辑代码
 
PBL既分离class又分离package,而PBF只通过class来分离逻辑代码
没有必要通过package分离,因为PBL中也可能出现尴尬的情况:
├─service         │MainServ.java

按照PBL,service包下的所有东西都是Controller,应该不需要Serv后缀,但实际上通常为了码起来方便,直接import service包,Serv后缀是为了避免引入的class和当前包下的class命名冲突。
 
当然,不用后缀也可以,得写清楚包路径,比如new net.ayqy.service.Main(),麻烦;而PBF就很方便,无需import,直接new MainServ()即可。
 
package的大小有意义了
 
PBL中包的大小无限增长是合理的,因为功能越添越多;而PBF中包太大(包里class太多)表示这块需要重构(划分子包)。
  2.2 类名
 
类名都以UpperCamelCase风格编写。
 
类名通常是名词或名词短语,接口名称有时可能是形容词或形容词短语。现在还没有特定的规则或行之有效的约定来命名注解类型。
 
名词,采用大驼峰命名法,尽量避免缩写,除非该缩写是众所周知的, 比如html,  URL,如果类名称中包含单词缩写,则单词缩写的每个字母均应大写。
 
描述 例如
Activity 类
Activity为后缀标识
欢迎页面类WelcomeActivity
Adapter类
Adapter 为后缀标识
新闻详情适配器 NewDetailAdapter
解析类
Parser为后缀标识
首页解析类HomePosterParser
工具方法类
Utils或Manager为后缀标识(与系统或第三方的Utils区分)或功能+Utils
线程池管理类:ThreadPoolManager日志工具类:LogUtils(Logger也可)打印工具类:PrinterUtils
数据库类
以DBHelper后缀标识
新闻数据库:NewDBHelper
Service类
以Service为后缀标识
时间服务TimeService
BroadcastReceiver类
以Receiver为后缀标识
推送接收JPushReceiver
ContentProvider类
以Provider为后缀标识
ShareProvider
自定义的共享基础类
以Base开头
BaseActivity,BaseFragment
 
测试类的命名以它要测试的类的名称开始,以Test结束。例如:HashTest或HashIntegrationTest。
 
接口(interface):命名规则与类一样采用大驼峰命名法,多以able或ible结尾,如:


interface Runnable、interface Accessible。
 
注意:如果项目采用MVP,所有Model、View、Presenter的接口都以I为前缀,不加后缀,其他的接口采用上述命名规则。
  2.3 方法名 
方法名都以lowerCamelCase风格编写。
方法名通常是动词或动词短语。
 
方法 说明
initXX()
初始化相关方法,使用init为前缀标识,如初始化布局initView()
isXX() checkXX()
方法返回值为boolean型的请使用is或check为前缀标识
getXX()
返回某个值的方法,使用get为前缀标识
setXX()
设置某个属性值
handleXX()/processXX()
对数据进行处理的方法
displayXX()/showXX()
弹出提示框和提示信息,使用display/show为前缀标识
updateXX()
更新数据
saveXX()
保存数据
resetXX()
重置数据
clearXX()
清除数据
removeXX()
移除数据或者视图等,如removeView();
drawXX()
绘制数据或效果相关的,使用draw前缀标识
  2.4 常量名 
常量名命名模式为CONSTANT_CASE,全部字母大写,用下划线分隔单词。那,到底什么算是一个常量?
 
每个常量都是一个静态final字段,但不是所有静态final字段都是常量。在决定一个字段是否是一个常量时,考虑它是否真的感觉像是一个常量。
 
例如,如果任何一个该实例的观测状态是可变的,则它几乎肯定不会是一个常量。只是永远不打算改变对象一般是不够的,它要真的一直不变才能将它示为常量。
 
 
Android 你应该注意的开发规范

文章图片

 
2.5 非常量字段名

 
非常量字段名以lowerCamelCase风格的基础上改造为如下风格:
 
基本结构为scopeVariableNameType。
 
scope:范围
 
非公有,非静态字段命名以m开头。
静态字段命名以s开头。
公有非静态字段命名以p开头。
公有静态字段(全局变量)命名以g开头。
 
例子:
 
Android 你应该注意的开发规范

文章图片

 
使用1字符前缀来表示作用范围,1个字符的前缀必须小写,前缀后面是由表意性强的一个单词或多个单词组成的名字,而且每个单词的首写字母大写,其它字母小写,这样保证了对变量名能够进行正确的断句。
 
Type:类型
 
考虑到Android中使用很多UI控件,为避免控件和普通成员变量混淆以及更好达意,所有用来表示控件的成员变量统一加上控件缩写作为后缀(文末附有缩写表)。
 
对于普通变量一般不添加类型后缀,如果统一添加类型后缀,请参考文末的缩写表。
 
用统一的量词通过在结尾处放置一个量词,就可创建更加统一的变量,它们更容易理解,也更容易搜索。
 
注意:如果项目中使用ButterKnife,则不添加m前缀,以lowerCamelCase风格命名。
 
例如,请使用mCustomerStrFirst和mCustomerStrLast,而不要使用mFirstCustomerStr和mLastCustomerStr。
 
量词列表 量词后缀说明
First
一组变量中的第一个
Last
一组变量中的最后一个
Next
一组变量中的下一个变量
Prev
一组变量中的上一个
Cur
一组变量中的当前变量
 
说明:
集合添加如下后缀:List、Map、Set
数组添加如下后缀:Arr
 
注意:所有的VO(值对象)统一采用标准的lowerCamelCase风格编写,所有的DTO(数据传输对象)就按照接口文档中定义的字段名编写。
  2.6 参数名 
参数名以lowerCamelCase风格编写。
参数应该避免用单个字符命名。
 
2.7 局部变量名 
局部变量名以lowerCamelCase风格编写,比起其它类型的名称,局部变量名可以有更为宽松的缩写。
 
虽然缩写更宽松,但还是要避免用单字符进行命名,除了临时变量和循环变量。
 
即使局部变量是final和不可改变的,也不应该把它示为常量,自然也不能用常量的规则去命名它。
 
2.8 临时变量 
临时变量通常被取名为i、j、k、m和n,它们一般用于整型;c、d、e,它们一般用于字符型。 如:for (int i = 0; i < len ; i++)。
 
2.9 类型变量名 
类型变量可用以下两种风格之一进行命名:
1.单个的大写字母,后面可以跟一个数字(如:E,  T,  X,  T2)。
2.以类命名方式(参考3.2 类名),后面加个大写的T(如:RequestT,  FooBarT)。
 
更多还可参考~阿里巴巴Java开发手册
https://102.alibaba.com/newsInfo.htm?newsId=6
 
3
资源文件规范
 
3.1 资源布局文件(XML文件(layout布局文件))
 
全部小写,采用下划线命名法
 
3.1.1 contentView命名 
必须以全部单词小写,单词间以下划线分割,使用名词或名词词组。
所有Activity或Fragment的contentView必须与其类名对应,对应规则为:将所有字母都转为小写,将类型和功能调换(也就是后缀变前缀)。
 
例如:activity_main.xml
  3.1.2 Dialog命名 
规则:dialog_描述.xml
例如:dialog_hint.xml
 
3.1.3 PopupWindow命名 
规则:ppw_描述.xml
例如:ppw_info.xml
 
3.1.4 列表项命名 
规则:item_描述.xml
例如:item_city.xml
  3.1.5 包含项命名 
规则:模块_(位置)描述.xml
例如:activity_main_head.xml、activity_main_bottom.xml
注意:通用的包含项命名采用:项目名称缩写_描述.xml
例如:xxxx_title.xml
  3.2 资源文件(图片drawable文件夹下) 
全部小写,采用下划线命名法,加前缀区分
命名模式:可加后缀  _small  表示小图,  _big  表示大图,逻辑名称可由多个单词加下划线组成,采用以下规则:
 
  • 用途_模块名_逻辑名称
  • 用途_模块名_颜色
  • 用途_逻辑名称
  • 用途_颜色
 
说明:用途也指控件类型(具体见附录UI控件缩写表)
 
http://www.jianshu.com/p/419f5357357d#ui%E6%8E%A7%E4%BB%B6%E7%BC%A9%E5%86%99%E8%A1%A8
 
例如:
 
名称 说明
btn_main_home.png
按键用途_模块名_逻辑名称
divider_maket_white.png
分割线用途_模块名_颜色
ic_edit.png
图标用途_逻辑名称
bg_main.png
背景用途_逻辑名称
btn_red.png
红色按键用途_颜色
btn_red_big.png
红色大按键用途_颜色
ic_head_small.png
小头像用途_逻辑名称
bg_input.png
输入框背景用途_逻辑名称
divider_white.png
白色分割线用途_颜色
bg_main_head
主模块头部背景图片用途_模块名_逻辑名称
def_search_cell
默认搜索界面单元图片用途_模块名_逻辑名称
ic_more_help
更多帮助图标用途_逻辑名称
divider_list_line
列表分割线用途_逻辑名称
selector_search_ok
【Android 你应该注意的开发规范】搜索界面确认选择器用途_模块名_逻辑名称
shape_music_ring
音乐界面环形形状用途_模块名_逻辑名称
 
如果有多种形态,如按钮选择器:btn_xx.xml(selector)
 
名称 说明
btn_xx
按钮图片使用btn_整体效果(selector)
btn_xx_normal
按钮图片使用btn_正常情况效果
btn_xx_pressed
按钮图片使用btn_点击时候效果
btn_xx_focused
state_focused聚焦效果
btn_xx_disabled
state_enabled  (false)不可用效果
btn_xx_checked
state_checked选中效果
btn_xx_selected
state_selected选中效果
btn_xx_hovered
state_hovered悬停效果
btn_xx_checkable
state_checkable可选效果
btn_xx_activated
state_activated激活的
btn_xx_windowfocused
state_window_focused
注意:使用AndroidStudio的插件SelectorChapek可以快速生成selector,前提是命名要规范。
  3.3 动画文件(anim文件夹下) 
全部小写,采用下划线命名法,加前缀区分。
具体动画采用以下规则:模块名_逻辑名称。
例如:refresh_progress.xml、market_cart_add.xml、market_cart_remove.xml。
 
普通的tween动画采用如下表格中的命名方式:动画类型_方向
 
名称 说明
fade_in
淡入
fade_out
淡出
push_down_in
从下方推入
push_down_out
从下方推出
push_left
推向左方
slide_in_from_top
从头部滑动进入
zoom_enter
变形进入
slide_in
滑动进入
shrink_to_middle
中间缩小
  3.4 values中name命名   3.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来说,减少使用颜色的种类是非常重要的。
 
注意:如果某些颜色和主题有关,那就独立出去写。
  3.4.2 dimens.xml 
像对待colors.xml一样对待dimens.xml文件 与定义颜色调色板一样,你同时也应该定义一个空隙间隔和字体大小的“调色板”。 一个好的例子,如下所示:
 
Android 你应该注意的开发规范

文章图片

 
布局时在写margins和paddings时,你应该使用spacing_xxxx尺寸格式来布局,而不是像对待string字符串一样直接写值。 这样写会非常有感觉,会使组织和改变风格或布局是非常容易。
  3.4.3 strings.xml 
strings的name命名使用下划线命名法,采用以下规则:模块名+逻辑名称,这样方便同一个界面的所有string都放到一起,方便查找。
 
名称 说明
main_menu_about
主菜单按键文字
friend_title
好友模块标题栏
friend_dialog_del
好友删除提示
login_check_email
登录验证
dialog_title
弹出框标题
button_ok
确认键
loading
加载文字
  3.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目录下的文件可以任意命名。
 
3.5 layout中的id命名 
命名模式为:view缩写_模块名_逻辑名,比如btn_main_search
使用AndroidStudio的插件ButterKnife Zelezny,生成注解非常方便,原生的话可以使用Android Code Generator插件。
 
如果想对资源文件进行分包可以参考我这篇文章~Android Studio下对资源进行分包
 
http://www.jianshu.com/p/8e893581b9c7
 
4
版本统一规范
 
Android开发存在着众多版本的不同,比如compileSdkVersion、minSdkVersion、targetSdkVersion以及项目中依赖第三方库的版本,不同的module及不同的开发人员都有不同的版本,所以需要一个统一版本规范的文件。
具体可以参考我写的这篇博文~Android开发之版本统一规范
 
http://www.jianshu.com/p/db6ef4cfa5d1
 
 
5
第三方库规范
 
别再闭门造车了,用用最新最火的技术吧,安利一波~Android 流行框架查速表(http://www.ctolib.com/cheatsheets-Android-ch.html),顺便带上自己的干货~Android开发人员不得不收集的代码
 
https://github.com/Blankj/AndroidUtilCode

 
 
希望Team能用时下较新的技术,对开源库的选取,一般都需要选择比较稳定的版本,作者在维护的项目,要考虑作者对issue的解决,以及开发者的知名度等各方面。选取之后,一定的封装是必要的。
 
个人推荐Team可使用如下优秀轮子:
 
  • Retrofit
  • RxAndroid
  • OkHttp
  • Glide  /  Fresco
  • Gson  /  Fastjson
  • EventBus  /  AndroidEventBus
  • GreenDao
  • Dagger2(选用)
  • Tinker(选用)
 
6
注释规范
 
为了减少他人阅读你代码的痛苦值,请在关键地方做好注释。
  6.1 类注释 
每个类完成后应该有作者姓名和联系方式的注释,对自己的代码负责。
/** * < pre> *     author : Blankj *     e-mail : [email  protected] *     time   : 2017/03/07 *     desc   : xxxx描述 *     version: 1.0 * < /pre> */ public class WelcomeActivity {       ... }

具体可以在AS中自己配制,Settings → Editor → File and Code Templates → Includes → File Header,输入
/** * < pre> *     author : ${USER} *     e-mail : [email  protected] *     time   : ${YEAR}/${MONTH}/${DAY} *     desc   : *     version: 1.0 * < /pre> */

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

文章图片

 
6.3 块注释 
块注释与其周围的代码在同一缩进级别。它们可以是/* ... */风格,也可以是// ...风格(//后最好带一个空格)。
 
对于多行的/* ... */注释,后续行必须从*开始, 并且与前一行的*对齐。以下示例注释都是OK的。
/* * This is           // And so           /* Or you can * okay.             // is this.           * even do this. */ */

注释不要封闭在由星号或其它字符绘制的框架里。
 
Tip:在写多行注释时,如果你希望在必要时能重新换行(即注释像段落风格一样),那么使用/* ... */。
  6.4 其他一些注释 
AS已帮你集成了一些注释模板,我们只需要直接使用即可,在代码中输入todo、fixme等这些注释模板,回车后便会出现如下注释
// TODO: 17/3/14 需要实现,但目前还未实现的功能的说明 // FIXME: 17/3/14 需要修正,甚至代码是错误的,不能工作,需要修复的说明

 
最后啰嗦几句:
  • 好的命名规则能够提高代码质量,使得新人加入项目的时候降低理解代码的难度;
  • 规矩终究是死的,适合团队的才是最好的;
  • 命名规范需要团队一起齐心协力来维护执行,在团队生活里,谁都不可能独善其身;
  • 一开始可能会有些不习惯,持之以恒,总会成功的。









    推荐阅读