?

?

Android编码规范

?

?

?

项目名称：

?

项目编号：

?

编写人员： 周江南

?

编写日期： 2014-11-14

?

审批人员：

?

审批日期：

?

?

?

历史修改记录

?

目 录

Android编码规范????1

1引言????4

2开发环境的配置????4

2.1 Eclipse版本要求????4

2.2 Eclipse编码格式????4

2.3 Eclipse配置方法????5

1.????注释模板????5

2.????导入方法????6

3.????格式化模板????7

4.????XML格式化????7

3命名注释规范????8

3.1命名规范汇总????8

1包命名????10

2类和接口 命名????10

3方法的命名????10

4变量命名????11

3.2注释规范????11

1文件注释????11

2类注释????12

3方法注释????12

4类成员变量和常量注释????12

5其他注释????13

6????XML注????13

5.生成API的方法????13

3.3代码风格????13

1缩进????13

2空行????13

3行宽????13

3.4代码规约????14

1方法????14

2参数和返回值????14

3神秘的数????14

4控制语句????14

5异常的捕捉处理????15

6访问控制????15

3.5约定俗称????15

1变量赋值????15

2圆括号????15

3返回值????16

4条件运算符"?"前的表达式????16

3.6其他专门要求????16

1.????编码????16

2.????变量：????16

3.????异常处理????17

4．引入????17

5.注释????17

6.括号 { }????17

7.TODO的使用????18

8.提高代码质量????18

9. Log的使用????18

10.测试代码????18

4 21种代码的坏味????18

1.????Duplicated Code????19

2.????Long method????19

3.????Large Class????19

4.????Divergent Change????19

5.????Shotgun Surgery????19

6.????Feature Envy????19

7.????Data Clumps????19

8.????Primitive Obsession????19

9.????Switch Statement????19

10.????Parallel Inheritance Hierarchies????19

11.????Lazy Class????20

12.????Speculative Generality????20

13.????Temporary Field????20

14.????Message Chain????20

15.????Middle Man????20

16.????Inappropriate Intimacy????20

17.????Alternative Classes with Different Interfaces????20

18.????Incomplete Library Class????20

19.????Data Class????20

20.????Refused Bequest????20

21.????Comments????20

?

1引言

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

?

• 一个软件的生命周期中，80%的花费在于维护
• 几乎没有任何一个软件，在其整个生命周期中，均由最初的开发人员来维护
• 编码规范可以改善软件的可读性，可以让程序员尽快而彻底地理解新的代码
• 如果你将源码作为产品发布，就需要确任它是否被很好的打包并且清晰无误，一如你已构建的其它任何产品

?

2开发环境的配置

2.1 Eclipse版本要求

使用Eclipse 3.5以上的版本

2.2 Eclipse编码格式

请将eclipse编码格式设为UTF-8格式，设置方法如下：

window->Preferences->general->Workspace，右 侧Text file encoding，选择Other，改变为UTF-8，以后新建立工程其属性对话框中的Text file encoding即为UTF-8.

window->Preferences->general->Content Types，右侧Context Types树，点开Text，选择Java Source File，在下面的Default encoding输入框中输入UTF-8，点Update，则设置Java文件编码为UTF-8。其他java应用开发相关的文件如： properties、XML等已经由Eclipse缺省指定，分别为ISO8859-1，UTF-8，如开发中确需改变编码格式则可以在此指定。

模板和格式模板文件

导入方法下：

Window->preferences->Java->Code Style->Organize Imports 导入android.imported

Window->preferences->Java->Code Style->Formatter导入android-formatting.xml

Tab与空格

程序中不允许出现Tab符号，所有的Tab需用4个空格来代替，请用如下方法配置：

Window->Preferences->General->Editors->Text Editors->Insert spaces for tabs

XML文件的Tab格式也需要单独配置一下，用如下方法配置:

Window->Preferences->XML->XML Files->Editor

2.3 Eclipse配置方法

1. 注释模板

在eclipse 的preferences 中，选择 java à code style àcode Template

1. 添加文件创建日志模板

?

?

?

?

?

?

?

?

?

?

?

?

?

?

?

2.设置类注释模板

?

1. 导入方法

在eclipse 的preferences 中，选择 java à code style àcode Template 中选择 Import，选择附件中的文件。

?

但是注意修改 类注释 和 文件注释 的作者名称为自己的！

?

1. 格式化模板

在eclipse 的preferences 中，选择 java à code style àformatter 中选择 Import，选择附件中的文件。

1. XML格式化

在eclipse 的preferences 中，选择 xml à xml files à xml editor 中 做如下设置

?

?

?

?

。

3命名注释规范

命名规范使程序更易读，从而更易于理解。它们也可以提供一些有关标识符功能的信息，以助于理解代码，不论它是一个常量、包、还是类。

需要注意的是：

1.使用完整的英文描述来命名

2.避免命名超长（15 个字符以内比较好）

3.避免相似的命名。例如：persistentObj 和persistentObjs 不要一起使用；anSqlStmt 和anSQLStmt 不要一起使用

4.慎用缩写，如果要用到缩写，请参考下一条

5.按照缩写规则使用缩写。例如：No.代表number 数字，ID.代表identification标示。

?

3.1命名规范汇总

?

?

?

1包命名

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

例如： com.hymobile.nloc.activities

?

规约：包命名必须以com.hymobile开始，后面跟有项目名称（或者缩写）,再后面为模块名或层级名称。

如：com.hymobile.项目缩写.模块名 à com.hymobile.nloc.bookmark

如：com.hymobile.项目缩写.层级名 à com.hymobile.nloc.activities

?

2类和接口 命名

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

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

例如： class Raster; class ImageSprite;

?

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

如：class BookMarkAdd à 正确

如：class AddBookReadPlanActivity à 错误！ 应为 class BookReadPlanAdd

3方法的命名

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

例如： 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(),其格式为：

?

4变量命名

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

例如：String bookName;

????????String mBookName；

?

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

如：String bookName; à 正确

如：String bookNameString; à错误！

?

?

?

3.2注释规范

?

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

?

1文件注释

所有的源文件都应该在开头有一个注释，其中列出类名、版本信息、日期和版权声明。

如下：

/*

* 文件名

* 包含类名列表

* 版本信息，版本号

* 创建日期。

* 版权声明

*/

2类注释

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

?

/**

* 类名

* @author 作者 <br/>

*????实现的主要功能。

*????创建日期

*????修改者，修改日期，修改内容。

*/

?

3方法注释

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

?

/**

???? *

???? * 方法的一句话概述

???? * <p>方法详述（简单方法可不必详述）</p>

???? * @param s 说明参数含义

???? * @return 说明返回值含义

???? * @throws IOException 说明发生此异常的条件

???? * @throws NullPointerException 说明发生此异常的条件

???? */

?

方法注释的内容（1，5，6，7项正常情况下都要写上去）

1.类该方法是做什么的。

2.该方法如何工作。

3.代码修改历史纪录。

4.方法调用代码示范。

5.必须传入什么样的参数给这个方法。@param

6.异常处理。@throws

7.这个方法返回什么。@return

?

?

4类成员变量和常量注释

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

/**

* XXXX含义

*/

?

5其他注释

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

1. XML注

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

?

1. 生成API的方法

选择工程，鼠标右键菜单Export ，选择Java 下面的Javadoc ，点"next" 按钮

Javadoc command 里选javadoc.exe 的目录，如：C:\Program Files\Java\jdk1.6.0_10\bin\javadoc.exe

选择生成到Javadoc 文档中的内容( 一般选public 或protected) ，选存放目录( 默认即可) ，next下一步 ,此页全默认即可，再next 下一步 。

如果项目采用的是 UTF － 8 的编码 ，一定要在这一页的Extra Javadoc options 中加" -encoding UTF-8 -charset UTF-8 〃 。否则生成的网页中文注释都是乱码。 点 Finish 完成

所有的代码注释都会被自动加入api中，所以为了让他人看懂所写代码，在编写程序代码的时候尽量加全所有可以被加入到api中的注释。

3.3代码风格

1缩进

规约：不允许使用Tab进行缩进，使用空格进行缩进，推荐缩进为4空格。

2空行

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

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

• 一个源文件的两个片段(section)之间
• 类声明和接口声明之间
• 两个方法之间
• 方法内的局部变量和方法的第一条语句之间
• 一个方法内的两个逻辑段之间，用以提高可读性

?

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

3行宽

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

?

3.4代码规约

1方法

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

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

2参数和返回值

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

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

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

3神秘的数

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

4控制语句

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

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){

}

?

5异常的捕捉处理

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

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

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

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

?

6访问控制

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

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

3.5约定俗称

1变量赋值

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

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;

?

2圆括号

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

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

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

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

?

3返回值

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

if (booleanExpression) {

return true;

} else {

return false;

}

应该代之以如下方法：

return booleanExpression

?

类似地：

if (condition) {

return x;

}

return y;

?

应该写做：

return (condition ? x : y);

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

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

(x >= 0) ? x : -x

3.6其他专门要求

1. 编码

2. 除了String.xml文件中可以出现非英文字符外，其他所有的Java文件，xml文件中只允许出现英文字符。
3. 所有Java文件，UI配置xml文件中不允许出现硬编码。字符串的国际化请写入String.xml文件，配置信息请写入config.xml文件，分辨率相关信息请写入dimens.xml文件

4. 变量：

5. 变量的命名应具有"自明性"，例如声明一个表示电话号码的局部变量，可以这么写："String mobileNumber"。 除了for循环中可以使用int i，j这样的命名方式，其他地方禁止使用这种没有"自明性"的命名
6. 所有静态变量都必须以s开头，例如："sMobileNumber"
7. 所有的非静态变量必须以m开头，例如："mMobileNumber"
8. 所有常量必须采用全大写方式，单词之间用下划线分割，例如："MOBILE_NUMBER"。此时f.不要再加如"s"或"m"前缀
9. 局部变量的作用域一定要最小化
10. 所有成员变量必须都定义在类的开始，定义顺序如下：常量->public 变量->private 变量
11. 所有xml配置文件中的变量命名，采用全小写命名，单词间用下划线分割。

12. 异常处理

13. 尽量不要使用try catch捕获异常，而是显式的抛出一个异常。
14. 使用try catch 一定要在catch语句中做好相应的处理，不能留空。在catch中可以赋默认值，做错误处理或抛出一个自己封装的异常类对象（但不能抛出RuntimeException异常）
15. 不要捕获Exception类型的异常
16. 使用Finally这个关键字时，需要注意其中的代码执行时间点是无法确定的（无法确定是return之前还是之后）。

4．引入

1. 引用顺序：android，第三方包按字母表，java(x) (这是一个graceful的问题)
2. 引用方式：一定要引全类名，不要引用整个包。 例如：

imports foo.Bar; //right

imports foo.* ; //wrong

5.注释

1. 文件开头要有CopyRight Statement，声明结束后空一行写代码(非必须)
2. 每个类都要有描述注释
3. 方法一定要写注释描述功能，参数，返回值，重要的变量要有注释

6.括号 { }

所有的复合语句必须用花括号包围，例如：

if (condition) {

body(); // 标准

}

7.TODO的使用

当有需要在未来完成的工作时，加上TODO注释，并给出触发事件或者时间点

// TODO: Remove this code after the UrlTable2 has been checked in.

// TODO: Change this to use a flag instead of a constant.

8.提高代码质量

1. 删除无用的变量
2. 删除无用的引入
3. 对于可以复用的部分，一定提取成共用的方法，减少代码量
4. 变量/方法命名一定要符合清晰易懂，不用太在乎长度
5. 代码完成后，进行code review，减少出错几率

9. Log的使用

在调试中，应该使用Log查找问题，但在版本release之前，一定要将所有的Log关闭。

代码要使用规范的TAG和调试开关，方便以后查找和关闭，例如：

private static final boolean DBG = true;

private static final String TAG = "MediaScanner";

if(DBG) {

Log.d(TAG,"debug info");

}

在调试中，应该使用Log查找问题，但在版本release之前，一定要将所有的Log关闭。

代码要使用规范的TAG和调试开关，方便以后查找和关闭。为了方便对Log行为做全局控制，重新封装出LogUtil类。新的调用方式如下：

private static final String TAG = "MediaScanner";

LogUtil.d(TAG,"debug info");

?

10.测试代码

在正规开发中，一定要有测试的环节，android有自己一套测试的工具 。具体的写法可以参考Android的系统源代码。

?

4 21种代码的坏味

?

?

?

应该在编程中尽量避免这21种"坏味道"。

1. Duplicated Code

代码重复几乎是最常见的异味了。他也是Refactoring 的主要目标之一。代码重复往

往来自于copy-and-paste 的编程风格。

1. Long method

它是传统结构化的"遗毒"。一个方法应当具有自我独立的意图，不要把几个意图

放在一起。

1. Large Class

大类就是你把太多的责任交给了一个类。这里的规则是One Class One Responsibility。

1. Divergent Change

一个类里面的内容变化率不同。某些状态一个小时变一次，某些则几个月一年才变一次；某些状态因为这方面的原因发生变化，而另一些则因为其他方面的原因变一次。面向对象的抽象就是把相对不变的和相对变化相隔离。把问题变化的一方面和另一方面相隔离。这使得这些相对不变的可以重用。问题变化的每个方面都可以单独重用。这种相异变化的共存使得重用非常困难。

1. Shotgun Surgery

这正好和上面相反。对系统一个地方的改变涉及到其他许多地方的相关改变。这些变化率和变化内容相似的状态和行为通常应当放在同一个类中。

1. Feature Envy

对象的目的就是封装状态以及与这些状态紧密相关的行为。如果一个类的方法频繁用get 方法存取其他类的状态进行计算，那么你要考虑把行为移到涉及状态数目最多的那个类。

1. Data Clumps

某些数据通常像孩子一样成群玩耍：一起出现在很多类的成员变量中，一起出现在许多方法的参数中…..，这些数据或许应该自己独立形成对象。

1. Primitive Obsession

面向对象的新手通常习惯使用几个原始类型的数据来表示一个概念。譬如对于范围，他们会使用两个数字。对于Money，他们会用一个浮点数来表示。因为你没有使用对象来表达问题中存在的概念，这使得代码变的难以理解，解决问题的难度大大增加。好的习惯是扩充语言所能提供原始类型，用小对象来表示范围、金额、转化率、邮政编码等等。

1. Switch Statement

基于常量的开关语句是OOM 的大敌，你应当把他变为子类、state 或strategy。

1. Parallel Inheritance Hierarchies

并行的继承层次是shotgun surgery 的特殊情况。因为当你改变一个层次中的某一个类时，你必须同时改变另外一个层次的并行子类。

1. Lazy Class

一个干活不多的类。类的维护需要额外的开销，如果一个类承担了太少的责任，应当消除它。

?

1. Speculative Generality

一个类实现了从未用到的功能和通用性。通常这样的类或方法唯一的用户是testcase。不要犹豫，删除它。

1. Temporary Field

一个对象的属性可能只在某些情况下才有意义。这样的代码将难以理解。专门建立一个对象来持有这样的孤儿属性，把只和他相关的行为移到该类。最常见的是一个特定的算法需要某些只有该算法才有用的变量。

1. Message Chain

消息链发生于当一个客户向一个对象要求另一个对象，然后客户又向这另一对象要求另一个对象，再向这另一个对象要求另一个对象，如此如此。这时，你需要隐藏分派。

1. Middle Man

对象的基本特性之一就是封装，而你经常会通过分派去实现封装。但是这一步不能走得太远，如果你发现一个类接口的一大半方法都在做分派，你可能需要移去这个中间人。

1. Inappropriate Intimacy

某些类相互之间太亲密，它们花费了太多的时间去砖研别人的私有部分。对人类而言，我们也许不应该太假正经，但我们应当让自己的类严格遵守禁欲主义。

1. Alternative Classes with Different Interfaces

做相同事情的方法有不同的函数signature，一致把它们往类层次上移，直至协议一致。

1. Incomplete Library Class

要建立一个好的类库非常困难。我们大量的程序工作都基于类库实现。然而，如此广泛而又相异的目标对库构建者提出了苛刻的要求。库构建者也不是万能的。有时候我们会发现库类无法实现我们需要的功能。而直接对库类的修改有非常困难。这时候就需要用各种手段进行Refactoring。

1. Data Class

对象包括状态和行为。如果一个类只有状态没有行为，那么肯定有什么地方出问题了。

1. Refused Bequest

超类传下来很多行为和状态，而子类只是用了其中的很小一部分。这通常意味着你的类层次有问题。

1. Comments

经常觉得要写很多注释表示你的代码难以理解。如果这种感觉太多，表示你需要Refactoring。

Android编码规范