Android开发规范

转载自Keegan小钢
原文链接：http://keeganlee.me/post/android/20150709

书写规范

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

}

1. 空格的使用

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，没有用一个空格隔开

1. 空行的使用

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

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

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

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

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

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

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

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

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; // 折扣券

1. 文字大小的单位统一用sp，元素大小的单位统一用dp。
2. 应用中的字符串统一在strings.xml中定义，然后在代码和布局文件中引用。

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

   命名规范

4. 包命名

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

me.keeganlee.kandroid.model

1. 类和接口命名

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

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

1. 方法命名

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

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

1. 控件缩写
   控件 缩写 控件 缩写
   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
2. 常量命名

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

public final static int PAGE_SIZE = 20;

1. 变量命名

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

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

1. 控件id命名

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