Android编码规范

Posted 2020-09-27 lxjshuju

android编码规范

介绍

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

 

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

 

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

l  差点儿没有不论什么一个软件，在其整个生命周期中，均由最初的开发者来维护

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

l  假设你将源代码作为产品公布。就须要确任它是否被非常好的打包而且清晰无误，一如你已构建的其他不论什么产品

 

命名

2.        包命名

命名规则：一个唯一包名的前缀总是所有小写的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

 

3.        类和接口 命名

命名规则：类名是个一名词，採用大写和小写混合的方式。每一个单词的首字母大写。尽量使你的类名简洁而富于描写叙述。

使用完整单词。避免缩写词(除非该缩写词被更广泛使用，像 URL，html) 

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

比如： class Raster;  class ImageSprite;

 

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

如：class BookMarkAdd à正确

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

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.        成员变量命名

同变量命名，但不要在私有变量前加入m字样。

7.        常量命名

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

比如：staticfinal int MIN_WIDTH = 4;

比如：staticfinal int MAX_WIDTH = 999;

比如：staticfinal int GET_THE_CPU = 1; 

8.        异常命名

自己定义异常的命名必须以Exception为结尾。

已明白标示为一个异常。

9.        layout 命名

规约：layout xml 的命名必须以 所有单词小写。单词间下面划线切割。而且使用名词或名词词组。即使用模块名_功能名称 来命名。

如：knowledge_gained_main.xmlà正确

如：list_book.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 程序有两类凝视：实现凝视(implementationcomments)和文档凝视(document comments)。实现凝视是使用/*...*/和//界定的凝视。

文档凝视(被称为"doc comments")由/**...*/界定。文档凝视能够通过javadoc 工具转换成HTML 文件。

 

1.        文件凝视

全部的源文件都应该在开头有一个凝视。当中列出类名、版本号信息、日期和版权声明。

例如以下：

  /*

   * 文件名称

   * 包括类名列表

   * 版本号信息，版本号号

   * 创建日期。

   * 版权声明

   */

2.        类凝视

每个类都要包括例如以下格式的凝视。以说明当前类的功能等。

 

/**

 * 类名

 * @author 作者 <br/>

 *   实现的主要功能。

 *   创建日期

*   改动者，改动日期。改动内容。

*/

 

3.        方法凝视

每个方法都要包括 例如以下格式的凝视 包括当前方法的用途。当前方法參数的含义。当前方法返回值的内容和抛出异常的列表。

 

/**

     *

     * 方法的一句话概述

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

     * @param s 说明參数含义

     * @return 说明返回值含义

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

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

     */

 

4.        类成员变量和常量凝视

成员变量和常量须要使用java doc形式的凝视，以说明当前变量或常量的含义

/**

*XXXX含义

  */

 

5.        其它凝视

方法内部的凝视 假设须要多行 使用/*…… */形式。假设为单行是用//……形式的凝视。不要再方法内部使用 java doc 形式的凝视“/**……**/”，简单的区分方法是。java doc形式的凝视在 eclipse中为蓝色。普通凝视为绿色。

6.        XML凝视

规约：假设当前layout 或资源须要被多处调用，或为公共使用的layout（若list_item），则须要在xml写明凝视。要求凝视清晰易懂。

代码风格

1.        缩进

规约：不同意使用Tab进行缩进，使用空格进行缩进，推荐缩进为2空格。

2.        空行

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

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

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

l  类声明和接口声明之间

l  两个方法之间

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

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

 

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

3.        行宽

无特别规定，由于如今的显示器都比較大。所以推荐使用120进行设置。

规约

1.        方法

l  一个方法尽量不要超过15行，假设方法太长，说明当前方法业务逻辑已经很复杂，那么就须要进行方法拆分。保证每一个方法仅仅作一件事。

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

！

！

2.        參数和返回值

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

l  假设一个方法返回的是一个错误码，请使用异常。！

l  尽可能不要使用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 intcount = products.getCount();

while(index < count){

}

 

5.        异常的捕捉处理

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

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

l  最小化从一个给定的抽象类中导出的异常的个数。对于常常发生的可估计事件不要採用异常。

不要使用异常实现控制结构。

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

 

6.        訪问控制

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

 

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

约定俗成

1.        变量赋值

避免在一个语句中给多个变量赋同样的值。

它非常难读懂。

比如：

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

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

   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

21种代码的坏味道

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

1.        Duplicated Code

代码反复差点儿是最常见的异味了。

他也是Refactoring 的主要目标之中的一个。

代码反复往

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

2.        Long method

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

放在一起。

3.        Large Class

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

4.        Divergent Change

一个类里面的内容变化率不同。某些状态一个小时变一次。某些则几个月一年才变一次；某些状态由于这方面的原因发生变化。而还有一些则由于其它方面的原因变一次。面向对象的抽象就是把相对不变的和相对变化相隔离。把问题变化的一方面和还有一方面相隔离。这使得这些相对不变的能够重用。

问题变化的每一个方面都能够单独重用。这样的相异变化的共存使得重用很困难。

5.        Shotgun Surgery

这正好和上面相反。

对系统一个地方的改变涉及到其它很多地方的相关改变。

这些变化率和变化内容相似的状态和行为通常应当放在同一个类中。

6.        Feature Envy

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

7.        Data Clumps

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

8.        Primitive Obsession

面向对象的新手通常习惯使用几个原始类型的数据来表示一个概念。

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

9.        Switch Statement

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

10.    Parallel InheritanceHierarchies

并行的继承层次是shotgun surgery 的特殊情况。

由于当你改变一个层次中的某一个类时。你必须同一时候改变另外一个层次的并行子类。

11.    Lazy Class

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

 

12.    Speculative Generality

一个类实现了从未用到的功能和通用性。

通常这种类或方法唯一的用户是testcase。不要犹豫，删除它。

13.    Temporary Field

一个对象的属性可能仅仅在某些情况下才有意义。

这种代码将难以理解。

专门建立一个对象来持有这种孤儿属性，把仅仅和他相关的行为移到该类。最常见的是一个特定的算法须要某些仅仅有该算法才实用的变量。

14.    Message Chain

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

15.    Middle Man

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

16.    Inappropriate Intimacy

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

17.    Alternative Classes withDifferent Interfaces

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

18.    Incomplete Library Class

要建立一个好的类库很困难。我们大量的程序工作都基于类库实现。然而，如此广泛而又相异的目标对库构建者提出了苛刻的要求。

库构建者也不是万能的。有时候我们会发现库类无法实现我们须要的功能。而直接对库类的改动有很困难。这时候就须要用各种手段进行Refactoring。

19.    Data Class

对象包含状态和行为。假设一个类仅仅有状态没有行为。那么肯定有什么地方出问题了。

20.    Refused Bequest

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

21.    Comments

常常认为要写非常多凝视表示你的代码难以理解。假设这样的感觉太多。表示你须要Refactoring。

Eclipse配置方法

 

1.        凝视模板

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

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

2.设置类凝视模板

 

2.        导入方法

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

可是注意改动类凝视和文件凝视的作者名称为自己的。

 

3.        格式化模板

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

4.        XML格式化

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