Android编码规范

1. 为什么需要编码规范?

 

编码规范对于程序员而言尤为重要，有以下几个原因： 

 

l 一个软件的生命周期中，80%的花费在于维护 

l 几乎没有任何一个软件，在其整个生命周期中，均由最初的开发人员来维护 

l 编码规范可以改善软件的可读性，可以让程序员尽快而彻底地理解新的代码 

l 如果你将源码作为产品发布，就需要确任它是否被很好的打包并且清晰无误，一如你已构建的其它任何产品

 

2. 包命名

命名规则：一个唯一包名的前缀总是全部小写的ASCII 字母并且是一个顶级域名，通常是com，edu，gov，mil，net，org。包名的后续部分根据不同机构各自内部的命名规范而不尽相同。这类命名规范可能以特定目录名的组成来区分部门 (department) ，项目(project)，机器(machine)，或注册名(login names)。

 

3. 类和接口 命名

命名规则：类名是个一名词，采用大小写混合的方式，每个单词的首字母大写。尽量使你的类名简洁而富于描述。使用完整单词，避免缩写词(除非该缩写词被更广泛使用，像 URL，HTML)  

接口一般要使用able、ible、er 等后缀

例如： class Raster;  class ImageSprite;

 

规约：类名必须使用驼峰规则，即首字母必须大写，如果为词组，则每个单词的首字母也必须要大写，类名必须使用名词，或名词词组。要求类名简单，不允许出现无意义的单词（如 class XXXActivity）。

 

Activity应以Activity结尾。

Fragment应以Fragment结尾。

Adapter应以Adapter结尾。

 

4. 方法的命名

命名规则：方法名是一个动词，采用大小写混合的方式，第一个单词的首字母小写，其后单词的首字母大写。

例如： public void run(); public String getBookName();

 

类中常用方法的命名：

1. 类的获取方法（一般具有返回值）一般要求在被访问的字段名前加上get，如

getFirstName()，getLastName()。一般来说，get前缀方法返回的是单个值，find前缀的方法返回的是列表值。

2. 类的设置方法（一般返回类型为void）：被访问字段名的前面加上前缀 set，如

setFirstName(),setLastName().

3. 类的布尔型的判断方法一般要求方法名使用单词 is或has 做前缀，如isPersistent()，isString()。或者使用具有逻辑意义的单词，例如equal 或equals。

4. 类的普通方法一般采用完整的英文描述说明成员方法功能，第一个单词尽可能采用动词，首字母小写，如openFile（），addCount（）。

5. 构造方法应该用递增的方式写。（参数多的写在后面）。

6. toString()方法：一般情况下，每个类都应该定义toString()

 

5. 变量命名

命名规则：第一个单词的首字母小写，其后单词的首字母大写。变量名不应以下划线或美元符号开头，尽管这在语法上是允许的。变量名应简短且富于描述。变量名的选用应该易于记忆，即，能够指出其用途。尽量避免单个字符的变量名，除非是一次性的临时变量。临时变量通常被取名为 i，j，k，m 和 n，它们一般用于整型；c，d，e，它们一般用于字符型。

例如：String bookName; 

 

规约：变量命名也必须使用驼峰规则，但是首字母必须小写，变量名尽可能的使用名词或名词词组。同样要求简单易懂，不允许出现无意义的单词。

如：String bookName;  正确

如：String bookNameString; 错误！

 

除临时变量外，严格禁止使用无意义或完全不相关单词、词组为变量命名，以免产生歧义！

 

6. 成员变量命名

同变量命名。

 

7. 常量命名

命名规则：类常量的声明，应该全部大写，单词间用下划线隔开。

例如：static final int MIN_WIDTH = 4; 

例如：static final int MAX_WIDTH = 999; 

例如：static final int GET_THE_CPU = 1;  

 

8. 异常命名

自定义异常的命名必须以Exception为结尾。以明确标示为一个异常。

 

9. layout 命名

规约：layout xml 的命名必须以 全部单词小写，单词间以下划线分割，并且使用名词或名词词组，即使用 模块名_功能名称 来命名。

 

10. id 命名

规约：layout 中所使用的id必须以全部单词小写，单词间以下划线分割，并且使用名词或名词词组，并且要求能够通过id直接理解当前组件要实现的功能。

如：某TextView @+id/textbookname 错误 !应为 @+id/book_name_show

如：某EditText @+id/textbookname 错误 !应为 @+id/book_name_edit

 

11. 资源命名

规约：layout中所使用的所有资源（如drawable,style等）命名必须以全部单词小写，单词间以下划线分割，并且尽可能的使用名词或名词组，即使用 模块名_用途 来命名。如果为公共资源，如分割线等，则直接用用途来命名

如：menu_icon_navigate.png 正确

如：某分割线：line.png  或 separator.png 正确

 

注释

Java 程序有两类注释：实现注释(implementation comments)和文档注释(document comments)。实现注释是使用/*…*/和//界定的注释。文档注释(被称为"doc comments")由/**…*/界定。文档注释可以通过javadoc 工具转换成HTML 文件。

   

12. 类注释

每一个类都要包含注释，以说明当前类的功能等。

 

13. 方法注释

每一个方法都要包含注释 包括当前方法的用途，当前方法参数的含义，当前方法返回值的内容和抛出异常的列表。

 

14. 类成员变量和常量注释

成员变量和常量需要使用java doc形式的注释，以说明当前变量或常量的含义

  

15. 其他注释

方法内部的注释 如果需要多行 使用形式/*…*/，如果为单行是用//……形式的注释。不要在方法内部使用 java doc 形式的注释，简单的区分方法是，java doc形式的注释在 eclipse中为蓝色，普通注释为绿色。

 

16. XML注释

规约：如果当前layout 或资源需要被多处调用，或为公共使用的layout（若list_item），则需要在xml写明注释。要求注释清晰易懂。

 

17. 空行

空行将逻辑相关的代码段分隔开，以提高可读性。 

  下列情况应该总是使用空行： 

l 一个源文件的两个片段(section)之间

l 类声明和接口声明之间

l 两个方法之间

l 方法内的局部变量和方法的第一条语句之间

l 一个方法内的两个逻辑段之间，用以提高可读性  

 

规约：通常在 变量声明区域之后要用空行分隔，常量声明区域之后要有空行 分隔，方法声明之前要有空行分隔。

 

18. 行宽

无特别规定，因为现在的显示器都比较大，所以推荐使用120进行设置。

规约

1. 方法

l 一个方法尽量不要超过15行，如果方法太长，说明当前方法业务逻辑已经非常复杂，那么就需要进行方法拆分，保证每个方法只作一件事。

l 不要使用 try catch 处理业务逻辑！

 

19. 参数和返回值

l 一个方法的参数尽可能的不要超过4个！

l 如果一个方法返回的是一个错误码，请使用异常！！

l 尽可能不要使用null， 替代为异常 或者使用空变量 如返回 List 则可以使用Collections.emptyList()

 

20. 神秘的数

代码中不允许出现单独的数字，字符！如果需要使用数字或字符，则将它们按照含义封装为静态常量！（for语句中除外）

 

21. 控制语句

判断中如有常量，则应将常量置于判断式的左侧。如：

if ( true == isAdmin())...

尽量不使用三目条件的嵌套。

 

所有if 语句必须用{}包括起来,即便是只有一句：

if (true){

//do something......

}

if (true)

i = 0; //不要使用这种

 

对于循环：

//不推荐方式____________________________________________

while(index < products.getCount()){

//每此都会执行一次getCount()方法，

//若此方法耗时则会影响执行效率

//而且可能带来同步问题，若有同步需求，请使用同步块或同步方法

}

//推荐方式______________________________________________

//将操作结构保存在临时变量里，减少方法调用次数

final int count = products.getCount();

while(index < count){

}

 

22. 异常的捕捉处理

l 通常的思想是只对错误采用异常处理：逻辑和编程错误，设置错误，被破坏的数据，资源耗尽，等等。

l 通常的法则是系统在正常状态下以及无重载和硬件失效状态下，不应产生任何异常。

l 最小化从一个给定的抽象类中导出的异常的个数。对于经常发生的可预计事件不要采用异常。不要使用异常实现控制结构。

l 若有finally 子句，则不要在try 块中直接返回，亦不要在finally 中直接返回。

 

23. 访问控制

若没有足够理由，不要把实例或类变量声明为公有。通常，实例变量无需显式的设置(set)和获取(gotten)，通常这作为方法调用的边缘效应 (side effect)而产生。  

一个具有公有实例变量的恰当例子，是类仅作为数据结构，没有行为。亦即，若你要使用一个结构(struct)而非一个类(如果java 支持结构的话)，那么把类的实例变量声明为公有是合适的。

 

24. 圆括号 

一般而言，在含有多种运算符的表达式中使用圆括号来避免运算符优先级问题，是个好方法。

即使运算符的优先级对你而言可能很清楚，但对其他人未必如此。你不能假设别的程序员和你一样清楚运算符的优先级。 

 if (a == b && c == d)     // AVOID! 

 if ((a == b) && (c == d))  // RIGHT

 

25. 返回值 

设法让你的程序结构符合目的。例如： 

  if (booleanExpression) { 

      return true; 

  } else { 

      return false; 

  } 

应该代之以如下方法： 

return booleanExpression

 

类似地： 

  if (condition) { 

      return x; 

  } 

  return y; 

 

应该写做： 

   return (condition ? x : y);

26. 条件运算符"?"前的表达式 

如果一个包含二元运算符的表达式出现在三元运算符" ? : "的"?"之前，那么应该给表达式添上一对圆括号。例如：  

  (x >= 0) ? x : -x

27. 缩进

推荐缩进为4空格。

28. 变量赋值

避免在一个语句中给多个变量赋相同的值。它很难读懂。例如： 

fooBar.fChar = barFoo.lchar = 'c';

不要将赋值运算符用在容易与相等关系运算符混淆的地方。例如： 

   if (c++ = d++) {        // AVOID! (Java disallows) 

      ... 

  } 

 应该写成 

   if ((c++ = d++) != 0) { 

    ... 

  } 

不要使用内嵌(embedded)赋值运算符试图提高运行时的效率，这是编译器的工作。例如： 

  d = (a = b + c) + r;        // AVOID! 

应该写成 

  a = b + c; 

  d = a + r; 

29. 字符串和字符串数组资源应在strings.xml中定义，以适应不同的系统语言。