Android技术积累:开发规范

原创文章,转载请注明:转载自Keegan小钢
并标明原文链接:http://keeganlee.me/post/android/20150709
微信订阅号:keeganlee_me
写于2015-07-09


上个月发布了Android项目重构的三篇系列文章,其中,界面篇中提到了在项目中保持规范性的重要性,也有简单举了几个例子。这篇文章则将其延伸,提供更完整的开发规范说明。

书写规范

1. 编码方式统一用UTF-8. Android Studio默认已是UTF-8,只要不去改动它就可以了。

2. 缩进统一为4个空格,将Tab size设置为4则可以保证tab键按4个空格缩进。另外,不要勾选上Use tab character,可以保证切换到不同tab长度的环境时还能继续保持统一的4个空格的缩进样式。

3. 花括号不要单独一行,和它前面的代码同一行。而且,花括号与前面的代码之间用一个空格隔开。

public void method() { // Good 
      
} 

public void method()
{ // Bad
}  

public void method(){ // Bad
      
} 

4. 空格的使用

if、else、for、switch、while等逻辑关键字与后面的语句留一个空格隔开。

// Good
if (booleanVariable) {
    // TODO while booleanVariable is true
} else {
    // TODO else
}

// Bad
if(booleanVariable) {
    // TODO while booleanVariable is true
}else {
    // TODO else
}

运算符两边各用一个空格隔开。

int result = a + b; //Good, = 和 + 两边各用一个空格隔开
int result=a+b; //Bad,=和+两边没用空格隔开

方法的每个参数之间用一个空格隔开。

public void method(String param1, String param2); // Good,param1后面的逗号与String之间隔了一个空格
method(param1, param2); // Good,方法调用时,param1后面的逗号与param2之间隔了一个空格
method(param1,param2); // Bad,没有用一个空格隔开

5. 空行的使用

将逻辑相关的代码段用空行隔开,以提高可读性。空行也只空一行,不要空多行。在以下情况需用一个空行:

  • 两个方法之间
  • 方法内的两个逻辑段之间
  • 方法内的局部变量和方法的第一条逻辑语句之间
  • 常量和变量之间

6. 当一个表达式无法容纳在一行内时,可换行显示,另起的新行用8个空格缩进。

someMethod(longExpression1, longExpression2, longExpression3,  
        longExpression4, longExpression5);

7. 一行声明一个变量,不要一行声明多个变量,这样有利于写注释。

private String param1; // 参数1
private String param2; // 参数2

8. 行宽设置为100,设置格式化时自动断行到行宽位置。

9. 使用快捷键进行代码自动格式化。

Windows:CTRL+ALT+L
Mac:OPTION+COMMAND+L

10. 一个方法最多不要超过40行代码。

11. 范围型的常量用枚举类定义,而不要直接用整型或字符,这样可以减少范围值的有效性检查。

// 用枚举类定义,Good
public enum CouponType {
    // 现金券
    @SerializedName("1")
    CASH,
    
    // 抵用券
    @SerializedName("2")
    DEBIT,
    
    // 折扣券
    @SerializedName("3")
    DISCOUNT
}

// 用整型定义,Bad
public static final int TYPE_CASH = 1; // 现金券
public static final int TYPE_DEBIT = 2; // 抵扣券
public static final int TYPE_DISCOUNT = 3; // 折扣券

12. 文字大小的单位统一用sp,元素大小的单位统一用dp。

13. 应用中的字符串统一在strings.xml中定义,然后在代码和布局文件中引用。

14. 颜色值统一在colors.xml中定义,然后在代码和布局文件中引用。另外,不要在代码和布局文件中引用系统的颜色,除了透明。

命名规范

1. 包命名

域名反写+项目名称+模块名称,全部单词用小写字母。
例如,我的KAndroid项目的Model模块包名如下:

me.keeganlee.kandroid.model

2. 类和接口命名

使用大驼峰规则,用名词或名词词组命名,每个单词的首字母大写。
以下为几种常用类的命名:

  • activity类,命名以Activity为后缀,如:LoginActivity
  • fragment类,命名以Fragment为后缀,如:ShareDialogFragment
  • service类,命名以Service为后缀,如:DownloadService
  • adapter类,命名以Adapter为后缀,如:CouponListAdapter
  • 工具类,命名以Util为后缀,如:EncryptUtil
  • 模型类,命名以BO为后缀,如:CouponBO
  • 接口实现类,命名以Impl为后缀,如:ApiImpl

3. 方法命名

使用小驼峰规则,用动词命名,第一个单词的首字母小写,其他单词的首字母大写。
以下为几种常用方法的命名:

  • 初始化方法,命名以init开头,例:initView
  • 按钮点击方法,命名以to开头,例:toLogin
  • 设置方法,命名以set开头,例:setData
  • 具有返回值的获取方法,命名以get开头,例:getData
  • 通过异步加载数据的方法,命名以load开头,例:loadData
  • 布尔型的判断方法,命名以is或has,或具有逻辑意义的单词如equals,例:isEmpty

4. 控件缩写

控件 缩写 控件 缩写
TextView txt EditText edt
Button btn ImageButton ibtn
ImageView img ListView list
RadioGroup group RadioButton rbtn
ProgressBar progress SeekBar seek
CheckBox chk Spinner spinner
TableLayout table TableRow row
LinearLayout llayout RelativeLayout rlayout
ScrollView scroll SearchView search
TabHost host TabWidget widget

5. 常量命名

全部为大写单词,单词之间用下划线分开。

public final static int PAGE_SIZE = 20;

6. 变量命名

{范围描述+}意义描述+类型描述的组合,用驼峰式,首字母小写。

private TextView headerTitleTxt; // 标题栏的标题
private Button loginBtn; // 登录按钮
private CouponBO couponBO; // 券实例

7. 控件id命名

控件缩写_{范围_}意义,范围可选,只在有明确定义的范围内才需要加上。

<!-- 这是标题栏的标题 -->
<TextView
    android:id="@+id/txt_header_title"
    ... />

<!-- 这是登录按钮 -->
<Button
    android:id="@+id/btn_login"
    ... />

8. layout命名

组件类型_{范围_}功能,范围可选,只在有明确定义的范围内才需要加上。
以下为几种常用的组件类型命名:

  • activity_{范围_}功能,为Activity的命名格式
  • fragment_{范围_}功能,为Fragment的命名格式
  • dialog_{范围_}功能,为Dialog的命名格式
  • item_list_{范围_}功能,为ListView的item命名格式
  • item_grid_{范围_}功能,为GridView的item命名格式
  • header_list_{范围_}功能,为ListView的HeaderView命名格式
  • footer_list_{范围_}功能,为ListView的FooterView命名格式

9. strings的命名

类型_{范围_}功能,范围可选。
以下为几种常用的命名:

  • 页面标题,命名格式为:title_页面
  • 按钮文字,命名格式为:btn_按钮事件
  • 标签文字,命名格式为:label_标签文字
  • 选项卡文字,命名格式为:tab_选项卡文字
  • 消息框文字,命名格式为:toast_消息
  • 编辑框的提示文字,命名格式为:hint_提示信息
  • 图片的描述文字,命名格式为:desc_图片文字
  • 对话框的文字,命名格式为:dialog_文字
  • menu的item文字,命名格式为:action_文字

10. colors的命名

前缀{_控件}{_范围}{_后缀},控件、范围、后缀可选,但控件和范围至少要有一个。

  • 背景颜色,添加bg前缀
  • 文本颜色,添加text前缀
  • 分割线颜色,添加div前缀
  • 区分状态时,默认状态的颜色,添加normal后缀
  • 区分状态时,按下时的颜色,添加pressed后缀
  • 区分状态时,选中时的颜色,添加selected后缀
  • 区分状态时,不可用时的颜色,添加disable后缀

11. drawable的命名

前缀{_控件}{_范围}{_后缀},控件、范围、后缀可选,但控件和范围至少要有一个。

  • 图标类,添加ic前缀
  • 背景类,添加bg前缀
  • 分隔类,添加div前缀
  • 默认类,添加def前缀
  • 区分状态时,默认状态,添加normal后缀
  • 区分状态时,按下时的状态,添加pressed后缀
  • 区分状态时,选中时的状态,添加selected后缀
  • 区分状态时,不可用时的状态,添加disable后缀
  • 多种状态的,添加selector后缀(一般为ListView的selector或按钮的selector)

12. 动画文件命名

动画类型_动画方向。

  • fade_in,淡入
  • fade_out,淡出
  • push_down_in,从下方推入
  • push_down_out,从下方推出
  • slide_in_from_top,从头部滑动进入
  • zoom_enter,变形进入
  • shrink_to_middle,中间缩小

注释规范

1. 文件头注释

文件顶部统一添加版权声明,声明的格式如下:

/**
 * Copyright (c) 2015. Keegan小钢 Inc. All rights reserved.
 */

2. 类和接口注释

类和接口统一添加javadoc注释,格式如下:

/**
 * 类或接口的描述信息
 *
 * @author ${USER}
 * @date ${DATE}
 */

3. 方法注释

下面几种方法,都必须添加javadoc注释,说明该方法的用途和参数说明,以及返回值的说明。

  • 接口中定义的所有方法
  • 抽象类中自定义的抽象方法
  • 抽象父类的自定义公用方法
  • 工具类的公用方法
/**
 * 登录
 *
 * @param loginName 登录名
 * @param password  密码
 * @param listener  回调监听器
 */
public void login(String loginName, String password, ActionCallbackListener<Void> listener);

4. 变量和常量注释

下面几种情况下的常量和变量,都要添加注释说明,优先采用右侧//来注释,若注释说明太长则在上方添加注释。

  • 接口中定义的所有常量
  • 公有类的公有常量
  • 枚举类定义的所有枚举常量
  • 实体类的所有属性变量
public static final int TYPE_CASH = 1; // 现金券
public static final int TYPE_DEBIT = 2; // 抵扣券
public static final int TYPE_DISCOUNT = 3; // 折扣券

private int id;                // 券id
private String name;           // 券名称
private String introduce;      // 券简介

结束语

这份开发规范说明比较细,也许还不是非常完整,但里面提到的每一条规范都很有用。按照此规范严格执行,将大大提高代码的可读性和维护性。


扫描以下二维码即可关注订阅号。

Comments
Write a Comment
  • 面试官你好,很高兴能在博客上跟你交流,尤其都用FarBox和.me的域名。关于控件缩写,我保留我的意见,更好的可读性比更少键盘敲击次数更重要。(虽然Android的控件缩写已经有一定的主流规范,但我个人不推崇。iOS也是。)

    我会坚持写有质量的博客以及继续关注你的博客的。

    希望能得到录用^_^

  • 面试官你好,很高兴能在博客上跟你交流,尤其都用FarBox和.me的域名。关于控件缩写,我保留我的意见,更好的可读性比更少键盘敲击次数更重要。(虽然Android的控件缩写已经有一定的主流规范,但我个人不推崇。iOS也是。)

    我会坚持写有质量的博客以及继续关注你的博客的。

    希望能得到录用^_^

  • Keegan小钢 reply

    @小俊 关于控件缩写你不推崇,那你推崇的是怎样的呢?

  • 业务名称+控件全称,驼峰式,例如

    private TextView headerTextView; // 标题栏的标题

    private Button loginButton; // 登录按钮

    private ScrollView scrollView; //在当前环境下只有一个scrollview,无需区分

    private LinearLayout albumLayout;

    //如果有必要的话。起码比ll易读多了

    private LinearLayout albumLinearLayout;

    // 券实例,程序员通用的缩写可以使用

    private CouponBO couponBO;

    有时候,Android的类成员变量我会加m前缀,不过未成规范。

    当前,只要CPU允许,我会开启代码提示。

    再次补充,个人习惯而已。iOS和Android我都不喜欢控件缩写,尤其是类成员变量或者全局变量,小范围局部变量偶尔会用。具体一点,是不喜欢跟平台密切相关的缩写。

  • 业务名称+控件全称,驼峰式,例如

    private TextView headerTextView; // 标题栏的标题

    private Button loginButton; // 登录按钮

    private ScrollView scrollView; //在当前环境下只有一个scrollview,无需区分

    private LinearLayout albumLayout;

    //如果有必要的话。起码比ll易读多了

    private LinearLayout albumLinearLayout;

    // 券实例,程序员通用的缩写可以使用

    private CouponBO couponBO;

    有时候,Android的类成员变量我会加m前缀,不过未成规范。

    当前,只要CPU允许,我会开启代码提示。

    再次补充,个人习惯而已。iOS和Android我都不喜欢控件缩写,尤其是类成员变量或者全局变量,小范围局部变量偶尔会用。具体一点,是不喜欢跟平台密切相关的缩写。

  • 为什么点击评论一次会有两条评论?

  • Keegan小钢 reply

    @小俊 你喜欢用全称,可能跟你习惯了oc的开发有关。用全称,某种程度上来看控件的可识别性更高了,但用全称,名字显得更长了,而且,对于一个名字来说,程序员更关注的是它的逻辑名,但控件全称那么长,反而影响了真正的关注点,也就是说反而减低了可读性。名字太长反而不好,而且也没必要,swift为什么流行,就因为它够简洁。用一些大家都已经习惯,已经差不多成为大众尝试的缩写是很有更好的可读性的。

  • 嗯,你说的有道理。我会有所权衡的。

  • 嗯,你说的有道理。我会有所权衡的。

  • Czjchn reply

    支持博主!常量用枚举代替就更nice了

  • arshell reply

    博主能将 包命名这部分详细列出就好了! 如数据库这块a

  • sujinde reply

    关于第六和第七点:在xml布局文件定义的控件ID和Java源码文件定义的对应的控件的变量名,应该保持一致

  • Keegan小钢 reply

    @sujinde 你是说控件缩写位置的不一致吗?这是因为id引用时会出现整个应用全局的,控件缩写放在前面更容易搜索过滤,但变量名局限在本类中,关注点更多在于逻辑名称,因此将逻辑名放前面更合适。

  • sujinde reply

    (⊙v⊙)嗯,不过现在用ButterKnife Zelezny一键注入,默认两边的命名一样了。不过你这么说逻辑和和id的搜索过滤,貌似也不错,看看能不能修改黄油刀

  • Keegan小钢 reply

    @sujinde ButterKnife也只是id注入吧,跟变量名是可以不同的啊~~

  • sujinde reply

    我是说注入的时候,默认便把id当做控件的变量名了

  • 为什么有些文章http://lusfold.com/2015/08/29/%E4%B8%BA%E4%BB%80%E4%B9%88Android%E4%B8%AD%E4%B8%8D%E5%BB%BA%E8%AE%AE%E4%BD%BF%E7%94%A8Enums/(或android官网)不建议使用Enums呢。。。

  • Keegan小钢 reply

    @cfanr 你给的链接无法打开,你的意思是说:为什么 Android 中不建议使用 Enums?推荐你看下这个:http://stackoverflow.com/questions/5143256/why-was-avoid-enums-where-you-only-need-ints-removed-from-androids-performanc

  • Czjchn reply

    支持博主!常量用枚举代替就更nice了

  • Czjchn reply

    支持博主!常量用枚举代替就更nice了

  • 有态度网友06MY5V reply

    面试官你好,很高兴能在博客上跟你交流,尤其都用FarBox和.me的域名。关于控件缩写,我保留我的意见,更好的可读性比更少键盘敲击次数更重要。(虽然Android的控件缩写已经有一定的主流规范,但我个人不推崇。iOS也是。)<br>我会坚持写有质量的博客以及继续关注你的博客的。<br>希望能得到录用^_^

  • 有态度网友06MY5V reply

    @小俊 关于控件缩写你不推崇,那你推崇的是怎样的呢?

  • 有态度网友06MY5V reply

    业务名称 控件全称,驼峰式,例如<br>private TextView headerTextView; // 标题栏的标题<br>private Button loginButton; // 登录按钮<br><br>private ScrollView scrollView; //在当前环境下只有一个scrollview,无需区分<br><br>private LinearLayout albumLayout;<br>//如果有必要的话。起码比ll易读多了<br>private LinearLayout albumLinearLayout; <br><br>// 券实例,程序员通用的缩写可以使用<br>private CouponBO couponBO; <br><br>有时候,Android的类成员变量我会加m前缀,不过未成规范。<br><br>当前,只要CPU允许,我会开启代码提示。<br><br>再次补充,个人习惯而已。iOS和Android我都不喜欢控件缩写,尤其是类成员变量或者全局变量,小范围局部变量偶尔会用。具体一点,是不喜欢跟平台密切相关的缩写。

  • 有态度网友06MY5V reply

    @小俊 你喜欢用全称,可能跟你习惯了oc的开发有关。用全称,某种程度上来看控件的可识别性更高了,但用全称,名字显得更长了,而且,对于一个名字来说,程序员更关注的是它的逻辑名,但控件全称那么长,反而影响了真正的关注点,也就是说反而减低了可读性。名字太长反而不好,而且也没必要,swift为什么流行,就因为它够简洁。用一些大家都已经习惯,已经差不多成为大众常识的缩写是很有更好的可读性的。

  • 有态度网友06MY5V reply

    @小俊 你喜欢用全称,可能跟你习惯了oc的开发有关。用全称,某种程度上来看控件的可识别性更高了,但用全称,名字显得更长了,而且,对于一个名字来说,程序员更关注的是它的逻辑名,但控件全称那么长,反而影响了真正的关注点,也就是说反而减低了可读性。名字太长反而不好,而且也没必要,swift为什么流行,就因为它够简洁。用一些大家都已经习惯,已经差不多成为大众尝试的缩写是很有更好的可读性的。

  • 有态度网友06MY5V reply

    嗯,你说的有道理。我会有所权衡的。

  • 有态度网友06MY5V reply

    支持博主!常量用枚举代替就更nice了

  • 有态度网友06MY5V reply

    博主能将 包命名这部分详细列出就好了! 如数据库这块a

  • 有态度网友06MY5V reply

    关于第六和第七点:在xml布局文件定义的控件ID和Java源码文件定义的对应的控件的变量名,应该保持一致

  • 有态度网友06MY5V reply

    @sujinde 你是说控件缩写位置的不一致吗?这是因为id引用时会出现整个应用全局的,控件缩写放在前面更容易搜索过滤,但变量名局限在本类中,关注点更多在于逻辑名称,因此将逻辑名放前面更合适。

  • 有态度网友06MY5V reply

    (⊙v⊙)嗯,不过现在用ButterKnife Zelezny一键注入,默认两边的命名一样了。不过你这么说逻辑和和id的搜索过滤,貌似也不错,看看能不能修改黄油刀

  • 有态度网友06MY5V reply

    @sujinde ButterKnife也只是id注入吧,跟变量名是可以不同的啊~~

  • 有态度网友06MY5V reply

    我是说注入的时候,默认便把id当做控件的变量名了

  • 有态度网友06MY5V reply

    为什么有些文章http://lusfold.com/2015/08/29/为什么Android中不建议使用Enums/(或android官网)不建议使用Enums呢。。。

  • 有态度网友06MY5V reply

    @cfanr 你给的链接无法打开,你的意思是说:为什么 Android 中不建议使用 Enums?推荐你看下这个:http://stackoverflow.com/questions/5143256/why-was-avoid-enums-where-you-only-need-ints-removed-from-androids-performanc

  • 有态度网友06MY5Z reply

    Thanks,如果有中文字幕就更好了。关于Enums的使用,讨论得太多了,个人看法,用还是不用看场景,比如我的场景,如果用int类型常量,项目里有很多地方都需要做边界检查,那我就会选择用Enum,虽然开销大了一点,但是如果不用,有些程序员又忘了做边界检查,传错了参数,可是会导致程序奔溃的。你是选择牺牲一点性能开销呢,还是冒让程序奔溃的风险?

  • 有态度网友06MY5V reply

    不客气,看了你的博文真的受益良多。我觉得你的想法不错,用与不用,就是一个权衡。

  • 有态度网友06MY67 reply

    挺好的,android 控件命名,一般是下面这样:<br>private Button mBtnLogin;

  • 有态度网友06MY5Z reply

    你习惯就好,我更喜欢将逻辑名放前面

  • change_ck reply

    规范写的挺不错,不过Google 官方教程中说是说不推荐使用来着,http://hukai.me/android-performance-patterns-season-3/这个是中文翻译的地址。

  • 有态度网友06MY5Z reply

    这篇文章讲性能优化,跟规范有什么关系?

  • change_ck reply

    不推荐使用枚举类型

  • 有态度网友06MY5Z reply

    前面的评论里我已经说过我的观点

  • SlamDunk_小弓虽 reply

    colors.xml这样的命名不太好吧,这样很多颜色都重复了。

  • 有态度网友06MY5Z reply

    虽然有可能重复,但职责划分很明确,需要查找和更改颜色时都很方便,一改动也不会影响其他的。

  • 有态度网友06MY7S reply

    博主你好,我在一些博客中看到不推荐使用枚举类型,跟你这的似乎有点冲突。原因是枚举类型比较耗内存

  • 有态度网友06MY5Z reply

    首先,Google也说了,建议尽量少用enum,但是没说坚决不用,因为enum的好处依然存在,不然,Google就不是建议少用,而是直接取消不用了。

  • 有态度网友06MY88 reply

    如果开发SDK... 要提供给第三方使用, 这样命名资源文件,可能会引起冲突哦?

  • 有态度网友06MY5Z reply

    如果是SDK,可以在命名前面添加前缀标示防止冲突

  • 有态度网友06MY5V reply

    一般全局的前面m开头

  • 有态度网友06MY5V reply

    android官方推荐是少用枚举。

  • 有态度网友06MYa7 reply

    写的很好,收藏了,规范在coding时很重要。

  • Andy孙刚 reply

    写得很不错

  • 有态度网友06MYaj reply

    枚举比常量性能低很多

  • 有态度网友06MY5Z reply

    为什么这么多人只盯着性能,却不考虑比性能更重要的东西

  • 美一分 reply

    根据谷歌官方的建议,使用注解代替枚举。<br>@Retention(RetentionPolicy.SOURCE)<br> @IntDef({ServiceCode.SBCX, ServiceCode.GJJCX, ServiceCode.YHBG, ServiceCode.XLXJ, ServiceCode.YYSCX, ServiceCode.HFCZ})<br> public @interface ServiceCode {<br> /**<br> * 社保查询<br> */<br> int SBCX = 0;<br> /**<br> * 公积金<br> */<br> int GJJCX = 1;<br> /**<br> * 央行报告<br> */<br> int YHBG = 2;<br> /**<br> * 学历学籍<br> */<br> int XLXJ = 3;<br> /**<br> * 查询运营商<br> */<br> int YYSCX = 7;<br> /**<br> * 话费充值<br> */<br> int HFCZ = 12;<br> }

  • 美一分 reply

    在使用Android studio开发是,各个module下的资源都应该以module标识开头,便于调用而又避免冲突。