Android开发中不可忽略的代码规范

Android开发中的代码规范

最在重构自己的项目的时候，发现自己在以前的开发中命名不是非常规范，给现在的代码重构和阅读造成了一定的影响。因此决定系统的总结一下开发中的命名规范和基本格式。

为什么要进行代码规范

代码规范可能是我们很多人都容易忽略的一点，但是作为一个合格的程序猿，我们不仅仅是实现此功能就OK，还要确保系统的可维护性和可读性。下面我将从两方面来介绍我们在开发中应该要注意的问题，包括Java开发编码规范和Android命名规范。

• 格式规范
  1. 注释
  2. 代码格式
• 编码规范
  1. 命名规范
• Android资源文件命名规范
  1. 布局文件
  2. 图片
  3. 属性
  4. 动画

代码格式

代码缩进

代码缩进可以增强代码的可阅读性，代码缩进一般为4个空格。在Android Studio 上选中使用Tab键就可以实现。使用代码缩进可以增加我们的代码层次感。示例如下：

public class MainActivity extends AppCompatActivity {
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
    }
}

可以看出来，我们在每一层嵌套下的代码缩进都为4个字符，这样阅读起来就很简单了。

长句分割

如果句子过长需要换行，或者我们在使用RxJava等框架的链式调用的时候，建议使用以下规范。

• 第二行相对第一行缩进 4 个空格，从第三行开始，不再继续缩进，参考示例。
• 运算符与下文一起换行。
• 方法调用的点符号与下文一起换行。
• 方法调用时，多个参数，需要换行时，在逗号后进行。
• 在括号前不要换行，见反例。

  client.newCall(new Request.Builder()
      .url(address)
      .build())
      .enqueue(new Callback() {
           @Override
           ublic void onFailure(Call call, IOException e) {
       }

反例

 client.newCall(new Request.Builder()
      .url(address)
      .build())
      .enqueue
      // 括号前不要换行，方法查看不方便
      (new Callback() {
           @Override
           ublic void onFailure(Call call, IOException e) {
       }

变量声明一句一行

建议在声明变量的时候一句一行，不要为了省变量类型少写，会给阅读带来很大麻烦。

int a = 0;
// 不建议这么写
int a = 0, b = 2;

大括号 { } 的使用规定

• 大括号内为空，则简洁地写成 { } 即可，不需要换行
• 大括号不为空 ，左大括号前不换行；左大括号后换行；右大括号换行；右大括号后还有 else 等代码则右大括号加else一起换行 ； 表示终止的右大括号后必须换行。示例如下：

// 大括号为空，写成{}不用换行
if (flag) {}
// 大括号不为空，左括号后换行
if (flag) {
    System.out.println("大括号不为空，左括号后换行");
// 右大括号换行，右大括号后有 else，一起换行
} else {
    System.out.println("右大括号换行，右大括号后有 else，一起换行");
// 终止大括号换行
}

空行分割

不同逻辑、不同语义、不同业务的代码之间插入一个空行分隔开来以提升可读性。但是我们没有必要加多个空行多此一举。

private ScrollView scrollView;
private TextView textView1;

@Override
protected void onCreate(Bundle savedInstanceState) {}

变量和方法之间添加空行方便阅读，区分逻辑。

小括号（）的使用规范

小括号使用的地方太多，函数传参，保留字配合括号的使用等等。

• if / for / while / switch / do 等保留字与括号之间都必须加空格

if (flag)
switch (str)

• 左右括号与字符之间不用加空格

if (a == b)
// 不建议这么写
if( a == b )

• 方法（）里面的参数建议逗号隔开，方法名与括号之间不用加空格

// 参数后面加空格
test("a", "b", "c");
// 不加空格是这样的，明显没有第一个阅读方便
test("a","b","c");

运算符使用规则

一目运算符左右两边不加空格，任何二目、三目运算符的左右两边都需要加一个空格

  a = a + b;
  a += b;

一目运算符

 // ++ 不用加空格
  a++;
  !a;
  ~a;

三目运算符使用上述规则

 a = a > b ? a ：b;
 b = (a == 10) ? 20 : 30; 

其它

• 在java语言规范中，分号代表一个语句的结束。; 分号不用加空格。
• 逗号 ，也不需要加空格，建议逗号后面加空格增强可读性。
• 点 . 同样不需要加空格。示例如下

 for (int i = 1, j = i + 10; i < 5; i++, j = i * 2) {
     System.out.println("i=" + i + "j=" + j);
 }

注释

类注释 写明类基本的功能和创建者和时间，其它的功能描述和逻辑可适当添加

/**
 * 登录注册数据Model
 * Created by rookie on 2017/3/5.
 */

行注释

根据需要适当说明Android Studio可以设置快捷键自动生成。

行注释

注释的双斜线与注释内容之间有且仅有一个空格。注释与描述的描述的内容同样的代码缩进。

// 双斜线之后有一个空格,代码缩放一致
String ygb = new String();

命名规范

• 变量，方法小驼峰写法，不能用拼音

sortByName();
int pageSize;

• 类名首字母大学。大驼峰写法

HttpUtil
MainActivity

• 包名统一使用小写，点分隔符之间有且仅有一个自然语义的英语单词，包名统一使用单数形式

com.example.rookie.myapplication

• 常量命名全部大写，单词间用下划线隔开，力求语义表达完整清楚，不要嫌名字长

  MAX_STOCK_COUNT;
  GET_NAME_URL;

• 单词缩写要规范，避免望文不知义，详见下面的文章
  单词缩写规范

Android 布局文件格式规范

layout文件下的布局文件命名,单词小写并用下划线分开

avtivity_main.xml
avtivity_user.xml

layout布局控件名称名,单词小写并用下划线分开

btn_user_login

drawable 、mipmap等文件命名格式可参考Android Studio自动生成的文件。

代码规范和命名规范是我们编程中的一个重要环节，希望各位小伙伴以后引起重视，提高自己的编码质量和可阅读性。