最详细最权威的Android 编码规范
nsnhgxeoyy
8年前
<h2>1. 前言</h2> <p>这份文档参考了 <a href="/misc/goto?guid=4959671967124920959">Google Java 编程风格规范</a>和 <a href="/misc/goto?guid=4959670211384064735">Google 官方 Android 编码风格规范</a>。该文档仅供参考，只要形成一个统一的风格，见量知其意就可。</p> <h2>1.1 术语说明</h2> <p>在本文档中，除非另有说明：</p> <ol> <li>术语 class 可表示一个普通类，枚举类，接口或是annotation类型(@interface)</li> <li>术语 comment 只用来指代实现的注释(implementation comments)，我们不使用”documentation comments”一词，而是用 Javadoc。其他的术语说明会偶尔在后面的文档出现。</li> </ol> <h2>1.2 指南说明本文档中的示例代码并不作为规范，仅供参考。</h2> <p>基本格式方面使用 AndroidStudio 默认模板即可（使用格式化快捷键处理后基本符合）。</p> <p>2. 源文件基础</p> <h2>2.1 文件名</h2> <p>源文件以其最顶层的类名来命名，大小写敏感，文件扩展名为.java。</p> <h2>2.2 文件编码：UTF-8</h2> <p>源文件编码格式为 UTF-8。</p> <h2>2.3 特殊字符</h2> <h3>2.3.1 空白字符</h3> <p>除了行结束符序列，ASCII水平空格字符(0×20，即空格)是源文件中唯一允许出现的空白字符，这意味着：</p> <ol> <li>所有其它字符串中的空白字符都要进行转义。</li> <li>制表符不用于缩进（可以在IDE中Tab键设置为若干个空格）。</li> </ol> <h3>2.3.2 特殊转义序列</h3> <p>对于具有特殊转义序列的任何字符(\b, \t, \n, \f, \r, \”, \’及)，我们使用它的转义序列，而不是相应的八进制(比如\012)或Unicode(比如\u000a)转义。</p> <h3>2.3.3 非ASCII字符</h3> <p>对于剩余的非ASCII字符，是使用实际的Unicode字符(比如∞)，还是使用等价的Unicode转义符(比如\u221e)，取决于哪个能让代码更易于阅读和理解。</p> <blockquote> <p>Tip:在使用Unicode转义符或是一些实际的Unicode字符时，建议做些注释给出解释，这有助于别人阅读和理解。</p> </blockquote> <p>例如：</p> <pre> <code class="language-java">String unitAbbrev = "μs"; | 赞，即使没有注释也非常清晰 String unitAbbrev = "\u03bcs"; // "μs" | 允许，但没有理由要这样做 String unitAbbrev = "\u03bcs"; // Greek letter mu, "s" | 允许，但这样做显得笨拙还容易出错 String unitAbbrev = "\u03bcs"; | 很糟，读者根本看不出这是什么 return '\ufeff' + content; // byte order mark | Good，对于非打印字符，使用转义，并在必要时写上注释</code></pre> <blockquote> <p>Tip:永远不要由于害怕某些程序可能无法正确处理非ASCII字符而让你的代码可读性变差。当程序无法正确处理非ASCII字符时，它自然无法正确运行， 你就会去fix这些问题的了。(言下之意就是大胆去用非ASCII字符，如果真的有需要的话)</p> </blockquote> <p>3. 源文件结构</p> <p>一个源文件包含(按顺序地)：</p> <ol> <li>许可证或版权信息(如有需要)</li> <li>package语句</li> <li>import语句</li> <li>一个顶级类(只有一个)以上每个部分之间用一个空行隔开。</li> </ol> <h2>3.1 许可证或版权信息</h2> <p>如果一个文件包含许可证或版权信息，那么它应当被放在文件最前面。</p> <h2>3.2 package语句</h2> <p>package 语句不换行，列限制(4.4节)并不适用于package语句。(即package语句写在一行里)</p> <h2>3.3 import语句</h2> <h3>3.3.1 import不要使用通配符</h3> <p>即，不要出现类似这样的import语句：import java.util.*;</p> <h3>3.3.2 不要换行</h3> <p>import语句不换行，列限制(4.4节)并不适用于import语句。(每个import语句独立成行)</p> <h3>3.3.3 顺序和间距</h3> <p>import语句可分为以下几组，按照这个顺序，每组由一个空行分隔：</p> <ol> <li>所有的静态导入独立成组</li> <li>com.google imports(仅当这个源文件是在com.google包下)</li> <li>第三方的包。每个顶级包为一组，字典序。例如：android, com, junit, org, sun</li> <li>java imports5.javax imports组内不空行，按字典序排列。</li> </ol> <h2>3.4 类声明</h2> <h3>3.4.1 只有一个顶级</h3> <p>类声明每个顶级类都在一个与它同名的源文件中(当然，还包含.java后缀)。<br> 例外：package-info.java，该文件中可没有package-info类。</p> <h3>3.4.2 类成员顺序</h3> <p>类的成员顺序对易学性有很大的影响，但这也不存在唯一的通用法则。不同的类对成员的排序可能是不同的。</p> <p>最重要的一点，每个类应该以某种逻辑去排序它的成员，维护者应该要能解释这种排序逻辑。比如， 新的方法不能总是习惯性地添加到类的结尾，因为这样就是按时间顺序而非某种逻辑来排序的。</p> <p>3.4.2.1 区块划分</p> <p>建议使用注释将源文件分为明显的区块，区块划分如下</p> <ol> <li>常量声明区</li> <li>UI控件成员变量声明区</li> <li>普通成员变量声明区</li> <li>内部接口声明区</li> <li>初始化相关方法区</li> <li>事件响应方法区</li> <li>普通逻辑方法区</li> <li>重载的逻辑方法区</li> <li>发起异步任务方法区</li> <li>异步任务回调方法区</li> <li>生命周期回调方法区（出去onCreate()方法）</li> <li>内部类声明区</li> </ol> <p>3.4.2.2 类成员排列通用规则</p> <ol> <li>按照发生的先后顺序排列</li> <li>常量按照使用先后排列</li> <li>UI控件成员变量按照layout文件中的先后顺序排列</li> <li>普通成员变量按照使用的先后顺序排列</li> <li>方法基本上都按照调用的先后顺序在各自区块中排列</li> <li>相关功能作为小区块放在一起（或者封装掉）</li> </ol> <p>3.4.2.3 重载：永不分离</p> <p>当一个类有多个构造函数，或是多个同名方法，这些函数/方法应该按顺序出现在一起，中间不要放进其它函数/方法。</p> <p>4. 格式术语</p> <p>说明：块状结构(block-like construct)指的是一个类，方法或构造函数的主体。需要注意的是，数组初始化中的初始值可被选择性地视为块状结构(4.8.3.1节)。</p> <h2>4.1 大括号</h2> <h3>4.1.1 使用大括号(即使是可选的)</h3> <p>大括号与if, else, for, do, while语句一起使用，即使只有一条语句(或是空)，也应该把大括号写上。</p> <h3>4.1.2 非空块：K & R 风格</h3> <p>对于非空块和块状结构，大括号遵循 Kernighan 和 Ritchie 风格 (Egyptian brackets):</p> <ul> <li>左大括号前不换行</li> <li>左大括号后换行</li> <li>右大括号前换行</li> <li>如果右大括号是一个语句、函数体或类的终止，则右大括号后换行; 否则不换行。</li> </ul> <p>例如，如果右大括号后面是else或逗号，则不换行。</p> <p>示例：</p> <pre> <code class="language-java">return new MyClass() { @Override public void method() { if (condition()) { try { something(); } catch (ProblemException e) { recover(); } } } };</code></pre> <p>4.8.1节给出了enum类的一些例外。</p> <h3>4.1.3 空块：可以用简洁版本</h3> <p>一个空的块状结构里什么也不包含，大括号可以简洁地写成{}，不需要换行。</p> <p>例外：如果它是一个多块语句的一部分(if/else 或 try/catch/finally) ，即使大括号内没内容，右大括号也要换行。<br> 示例：</p> <pre> <code class="language-java">void doNothing() {}</code></pre> <h2>4.2 块缩进：4个空格</h2> <p>每当开始一个新的块，缩进增加4个空格，当块结束时，缩进返回先前的缩进级别。缩进级别适用于代码和注释。(见4.1.2节中的代码示例)</p> <h2>4.3 一行一个语句</h2> <p>每个语句后要换行。</p> <h2>4.4 列限制：80或100</h2> <p>一个项目可以选择一行80个字符或100个字符的列限制，除了下述例外，任何一行如果超过这个字符数限制，必须自动换行。</p> <p>例外：</p> <ul> <li>不可能满足列限制的行(例如，Javadoc中的一个长URL，或是一个长的JSNI方法参考)。</li> <li>package和import语句(见3.2节和3.3节)。</li> <li>注释中那些可能被剪切并粘贴到shell中的命令行。</li> </ul> <h2>4.5 自动换行</h2> <p>术语说明：一般情况下，一行长代码为了避免超出列限制(80或100个字符)而被分为多行，我们称之为自动换行(line-wrapping)。我们并没有全面，确定性的准则来决定在每一种情况下如何自动换行。很多时候，对于同一段代码会有好几种有效的自动换行方式。</p> <blockquote> <p>Tip:提取方法或局部变量可以在不换行的情况下解决代码过长的问题(是合理缩短命名长度吧)</p> </blockquote> <h3>4.5.1 从哪里断开</h3> <p>自动换行的基本准则是：更倾向于在更高的语法级别处断开。</p> <ol> <li>如果在非赋值运算符处断开，那么在该符号前断开(比如+，它将位于下一行)。注意：这一点与 Google 其它语言的<a href="/misc/goto?guid=4958871875461400341" title="编程风格">编程风格</a>不同(如 C++ 和 JavaScript )。</li> <li>这条规则也适用于以下”类运算符”符号：点分隔符(.)，类型界限中的 &（)，catch 块中的管道符号(catch (FooException | BarException e)</li> <li>如果在赋值运算符处断开，通常的做法是在该符号后断开(比如=，它与前面的内容留在同一行)。这条规则也适用于foreach语句中的分号。</li> <li>方法名或构造函数名与左括号留在同一行。</li> <li>逗号(,)与其前面的内容留在同一行。</li> </ol> <h3>4.5.2 自动换行时缩进至少+8个空格</h3> <p>自动换行时，第一行后的每一行至少比第一行多缩进8个空格(注意：制表符不用于缩进。见2.3.1节)。当存在连续自动换行时，缩进可能会多缩进不只8个空格(语法元素存在多级时)。一般而言，两个连续行使用相同的缩进当且仅当它们开始于同级语法元素。</p> <p>第4.6.3水平对齐一节中指出，不鼓励使用可变数目的空格来对齐前面行的符号。</p> <h2>4.6 空白</h2> <h3>4.6.1 垂直空白</h3> <p>以下情况需要使用一个空行：</p> <ol> <li>类内连续的成员之间：字段，构造函数，方法，嵌套类，静态初始化块，实例初始化块。 例外： 两个连续字段之间的空行是可选的，用于字段的空行主要用来对字段进行逻辑分组。</li> <li>在函数体内，语句的逻辑分组间使用空行。</li> <li>类内的第一个成员前或最后一个成员后的空行是可选的(既不鼓励也不反对这样做，视个人喜好而定)。</li> <li>要满足本文档中其他节的空行要求(比如3.3节：import语句)</li> <li>多个连续的空行是允许的，但没有必要这样做(我们也不鼓励这样做)。</li> </ol> <h3>4.6.2 水平空白</h3> <p>除了语言需求和其它规则，并且除了文字，注释和Javadoc用到单个空格，单个ASCII空格也出现在以下几个地方：</p> <ol> <li>分隔任何保留字与紧随其后的左括号(()(如if, for catch等)。</li> <li>分隔任何保留字与其前面的右大括号(})(如else, catch)。</li> <li>在任何左大括号前({)，两个例外：<br> o @SomeAnnotation({a, b})(不使用空格)。<br> o String[][] x = foo;(大括号间没有空格，见下面的Note)。</li> <li>在任何二元或三元运算符的两侧。这也适用于以下”类运算符”符号：<br> o 类型界限中的&()。<br> o catch块中的管道符号(catch (FooException | BarException e)。<br> o foreach语句中的分号。</li> <li>在, : ;及右括号())后</li> <li>如果在一条语句后做注释，则双斜杠(//)两边都要空格。这里可以允许多个空格，但没有必要。</li> <li>类型和变量之间：List list。</li> <li>数组初始化中，大括号内的空格是可选的，即new int[] {5, 6}和new int[] { 5, 6 }都是可以的。</li> </ol> <blockquote> <p>Note：这个规则并不要求或禁止一行的开关或结尾需要额外的空格，只对内部空格做要求。</p> </blockquote> <h3>4.6.3 水平对齐：不做要求</h3> <p>术语说明：水平对齐指的是通过增加可变数量的空格来使某一行的字符与上一行的相应字符对齐。<br> 这是允许的(而且在不少地方可以看到这样的代码)，但Google编程风格对此不做要求。即使对于已经使用水平对齐的代码，我们也不需要去保持这种风格。</p> <p>以下示例先展示未对齐的代码，然后是对齐的代码：</p> <pre> <code class="language-java">private int x; // this is fine private Color color; // this too private int x; // permitted, but future edits private Color color; // may leave it unaligned</code></pre> <blockquote> <p>Tip：对齐可增加代码可读性，但它为日后的维护带来问题。考虑未来某个时候，我们需要修改一堆对齐的代码中的一行。<br> 这可能导致原本很漂亮的对齐代码变得错位。很可能它会提示你调整周围代码的空白来使这一堆代码重新水平对齐(比如<a href="/misc/goto?guid=4958838642943725656" title="程序员">程序员</a>想保持这种水平对齐的风格)。<br> 这就会让你做许多的无用功，增加了reviewer的工作并且可能导致更多的合并冲突。</p> </blockquote> <h2>4.7 用小括号来限定组：推荐</h2> <p>除非作者和reviewer都认为去掉小括号也不会使代码被误解，或是去掉小括号能让代码更易于阅读，否则我们不应该去掉小括号。</p> <p>我们没有理由假设读者能记住整个Java运算符优先级表。</p> <h2>4.8 具体结构</h2> <h3>4.8.1 枚举类</h3> <p>枚举常量间用逗号隔开，换行可选。</p> <p>没有方法和文档的枚举类可写成数组初始化的格式：</p> <pre> <code class="language-java">private enum Suit { CLUBS, HEARTS, SPADES, DIAMONDS }</code></pre> <p>由于枚举类也是一个类，因此所有适用于其它类的格式规则也适用于枚举类。</p> <h3>4.8.2 变量声明</h3> <p>4.8.2.1 每次只声明一个变量</p> <p>不要使用组合声明，比如int a, b;。</p> <p>4.8.2.2 需要时才声明，并尽快进行初始化</p> <p>不要在一个代码块的开头把局部变量一次性都声明了(这是c语言的做法)，而是在第一次需要使用它时才声明。 局部变量在声明时最好就进行初始化，或者声明后尽快进行初始化。</p> <h3>4.8.3 数组</h3> <p>4.8.3.1 数组初始化：可写成块状结构</p> <p>数组初始化可以写成块状结构，比如，下面的写法都是OK的：</p> <pre> <code class="language-java">new int[] { 0, 1, 2, 3 } new int[] { 0, 1, 2, 3 } new int[] { 0, 1, 2, 3 } new int[] {0, 1, 2, 3}</code></pre> <p>4.8.3.2 非C风格的数组声明</p> <p>中括号是类型的一部分：String[] args， 而非 String args[]。</p> <h3>4.8.4 switch语句</h3> <p>术语说明：switch块的大括号内是一个或多个语句组。<br> 每个语句组包含一个或多个switch标签(case FOO:或default:)，后面跟着一条或多条语句。</p> <p>4.8.4.1 缩进</p> <p>与其它块状结构一致，switch块中的内容缩进为2个空格。每个switch标签后新起一行，再缩进2个空格，写下一条或多条语句。</p> <p>4.8.4.2 Fall-through：注释</p> <p>在一个switch块内，每个语句组要么通过break, continue, return或抛出异常来终止，要么通过一条注释来说明程序将继续执行到下一个语句组， 任何能表达这个意思的注释都是OK的(典型的是用// fall through)。这个特殊的注释并不需要在最后一个语句组(一般是default)中出现。</p> <p>示例：</p> <pre> <code class="language-java">switch (input) { case 1: case 2: prepareOneOrTwo(); // fall through case 3: handleOneTwoOrThree(); break; default: handleLargeNumber(input); }</code></pre> <p>4.8.4.3 default的情况要写出来</p> <p>每个switch语句都包含一个default语句组，即使它什么代码也不包含。</p> <h3>4.8.5 注解(Annotations)</h3> <p>注解紧跟在文档块后面，应用于类、方法和构造函数，一个注解独占一行。这些换行不属于自动换行(第4.5节，自动换行)，因此缩进级别不变。</p> <p>例如：</p> <p>@Nullable public String getNameIfPresent() { … }</p> <p>例外：单个的注解可以和签名的第一行出现在同一行。</p> <p>例如：</p> <p>@Override public int hashCode() { … }应用于字段的注解紧随文档块出现，应用于字段的多个注解允许与字段出现在同一行。</p> <p>例如：</p> <p>@Partial @Mock DataLoader loader;</p> <p>参数和局部变量注解没有特定规则。</p> <h3>4.8.6 注释</h3> <p>4.8.6.1 块注释风格</p> <p>块注释与其周围的代码在同一缩进级别。它们可以是/<em> … </em>/风格，也可以是// …风格。对于多行的/<em> … </em>/注释，后续行必须从<em>开始， 并且与前一行的</em>对齐。</p> <p>以下示例注释都是OK的。</p> <pre> <code class="language-java">/** This is // And so /* Or you can * okay. // is this. * even do this. */ */</code></pre> <p>注释不要封闭在由星号或其它字符绘制的框架里。</p> <blockquote> <p>Tip：在写多行注释时，如果你希望在必要时能重新换行(即注释像段落风格一样)，那么使用/<em> … </em>/。</p> </blockquote> <h3>4.8.7 Modifiers</h3> <p>类和成员的modifiers如果存在，则按Java语言规范中推荐的顺序出现。</p> <p>public protected private abstract static final transient <a href="/misc/goto?guid=4958971586558472088" title="Volatile">Volatile</a> synchronized native strictfp</p> <p>5. 命名约定</p> <h2>5.1 对所有标识符都通用的规则</h2> <p>标识符只能使用ASCII字母和数字，因此每个有效的标识符名称都能匹配正则表达式\w+。</p> <h2>5.2 标识符类型的规则</h2> <h3>5.2.1 包名</h3> <p>包名全部小写，连续的单词只是简单地连接起来，不使用下划线。</p> <p>采用反域名命名规则，全部使用小写字母。一级包名为com，二级包名为xx（可以是公司或则个人的随便），三级包名根据应用进行命名，四级包名为模块名或层级名。</p> <p>例如：com.jiashuangkuaizi.kitchen</p> <table> <thead> <tr> <th>包名</th> <th>此包中包含</th> </tr> </thead> <tbody> <tr> <td>com.xx.应用名称缩写.activity</td> <td>页面用到的Activity类 (activitie层级名用户界面层)</td> </tr> <tr> <td>com.xx.应用名称缩写.base</td> <td>基础共享的类</td> </tr> <tr> <td>com.xx.应用名称缩写.adapter</td> <td>页面用到的Adapter类 (适配器的类)</td> </tr> <tr> <td>com.xx.应用名称缩写.util</td> <td>此包中包含：公共工具方法类（util模块名）</td> </tr> <tr> <td>com.xx.应用名称缩写.bean</td> <td>下面可分：vo、po、dto 此包中包含：JavaBean类</td> </tr> <tr> <td>com.xx.应用名称缩写.model</td> <td>此包中包含：模型类</td> </tr> <tr> <td>com.xx.应用名称缩写.db</td> <td>数据库操作类</td> </tr> <tr> <td>com.xx.应用名称缩写.view (或者 com.xx.应用名称缩写.widget )</td> <td>自定义的View类等</td> </tr> <tr> <td>com.xx.应用名称缩写.service</td> <td>Service服务</td> </tr> <tr> <td>com.xx.应用名称缩写.receiver</td> <td>BroadcastReceiver服务</td> </tr> </tbody> </table> <blockquote> <p>注意：<br> 如果项目采用MVP，所有M、V、P抽取出来的接口都放置在相应模块的i包下，所有的实现都放置在相应模块的impl下</p> </blockquote> <h3>5.2.2 类名</h3> <p>类名都以UpperCamelCase风格编写。</p> <p>类名通常是名词或名词短语，接口名称有时可能是形容词或形容词短语。现在还没有特定的规则或行之有效的约定来命名注解类型。</p> <p>名词，采用大驼峰命名法，尽量避免缩写，除非该缩写是众所周知的， 比如HTML,URL，如果类名称中包含单词缩写，则单词缩写的每个字母均应大写。</p> <table> <thead> <tr> <th>类</th> <th>描述</th> <th>例如</th> </tr> </thead> <tbody> <tr> <td>Activity 类</td> <td>Activity为后缀标识</td> <td>欢迎页面类WelcomeActivity</td> </tr> <tr> <td>Adapter类</td> <td>Adapter 为后缀标识</td> <td>新闻详情适配器 NewDetailAdapter</td> </tr> <tr> <td>解析类</td> <td>Parser为后缀标识</td> <td>首页解析类HomePosterParser</td> </tr> <tr> <td>工具方法类</td> <td>Util或Manager为后缀标识（与系统或第三方的Utils区分）或功能+Util</td> <td>线程池管理类：ThreadPoolManager日志工具类：LogUtil（Logger也可）打印工具类：PrinterUtil</td> </tr> <tr> <td>数据库类</td> <td>以DBHelper后缀标识</td> <td>新闻数据库：NewDBHelper</td> </tr> <tr> <td>Service类</td> <td>以Service为后缀标识</td> <td>时间服务TimeServiceBroadcast</td> </tr> <tr> <td>Receiver类</td> <td>以Receiver为后缀标识</td> <td>推送接收JPushReceiver</td> </tr> <tr> <td>ContentProvider</td> <td>以Provider为后缀标识</td> <td> </td> </tr> <tr> <td>自定义的共享基础类</td> <td>以Base开头</td> <td>BaseActivity,BaseFragment</td> </tr> </tbody> </table> <p>测试类的命名以它要测试的类的名称开始，以Test结束。</p> <p>例如：HashTest 或 HashIntegrationTest。</p> <p>接口（interface）：命名规则与类一样采用大驼峰命名法，多以able或ible结尾，如</p> <p>interface Runnable ;<br> interface Accessible。</p> <blockquote> <p>注意：<br> 如果项目采用MVP，所有Model、View、Presenter的接口都以I为前缀，不加后缀，其他的接口采用上述命名规则。</p> </blockquote> <h3>5.2.3 方法名</h3> <p>方法名都以 LowerCamelCase 风格编写。</p> <p>方法名通常是动词或动词短语。</p> <table> <thead> <tr> <th>方法</th> <th>说明</th> </tr> </thead> <tbody> <tr> <td>initXX()</td> <td>初始化相关方法,使用init为前缀标识，如初始化布局initView()</td> </tr> <tr> <td>isXX() checkXX()</td> <td>方法返回值为boolean型的请使用is或check为前缀标识</td> </tr> <tr> <td>getXX()</td> <td>返回某个值的方法，使用get为前缀标识</td> </tr> <tr> <td>handleXX()</td> <td>对数据进行处理的方法，尽量使用handle为前缀标识</td> </tr> <tr> <td>displayXX()/showXX()</td> <td>弹出提示框和提示信息，使用display/show为前缀标识</td> </tr> <tr> <td>saveXX()</td> <td>与保存数据相关的，使用save为前缀标识</td> </tr> <tr> <td>resetXX()</td> <td>对数据重组的，使用reset前缀标识</td> </tr> <tr> <td>clearXX()</td> <td>清除数据相关的</td> </tr> <tr> <td>removeXXX()</td> <td>清除数据相关的</td> </tr> <tr> <td>drawXXX()</td> <td>绘制数据或效果相关的，使用draw前缀标识</td> </tr> </tbody> </table> <p>下划线可能出现在JUnit测试方法名称中用以分隔名称的逻辑组件。一个典型的模式是：test_，例如testPop_emptyStack。</p> <p>并不存在唯一正确的方式来命名测试方法。</p> <h3>5.2.4 常量名</h3> <p>常量名命名模式为CONSTANT_CASE，全部字母大写，用下划线分隔单词。那，到底什么算是一个常量？</p> <p>每个常量都是一个静态final字段，但不是所有静态final字段都是常量。在决定一个字段是否是一个常量时，考虑它是否真的感觉像是一个常量。</p> <p>例如，如果任何一个该实例的观测状态是可变的，则它几乎肯定不会是一个常量。只是永远不打算改变对象一般是不够的，它要真的一直不变才能将它示为常量。</p> <pre> <code class="language-java">// Constants static final int NUMBER = 5; static final ImmutableListNAMES = ImmutableList.of("Ed", "Ann"); static final Joiner COMMA_JOINER = Joiner.on(','); // because Joiner is immutable static final SomeMutableType[] EMPTY_ARRAY = {}; enum SomeEnum { ENUM_CONSTANT } // Not constants static String nonFinal = "non-final"; final String nonStatic = "non-static"; static final SetmutableCollection = new HashSet(); static final ImmutableSetmutableElements = ImmutableSet.of(mutable); static final Logger logger = Logger.getLogger(MyClass.getName()); static final String[] nonEmptyArray = {"these", "can", "change"};</code></pre> <p>这些名字通常是名词或名词短语。</p> <h3>5.2.5 非常量字段名</h3> <p>非常量字段名以LowerCamelCase风格的基础上改造为如下风格：</p> <p>基本结构为scopeVariableNameType，</p> <p><strong>scope：范围</strong></p> <p>非公有，非静态字段命名以m开头。</p> <p>静态字段命名以s开头。</p> <p>公有非静态字段命名以p开头。</p> <p>公有静态字段（全局变量）命名以g开头。</p> <p>public static final 字段(常量) 全部大写，并用下划线连起来。</p> <p>例子：</p> <pre> <code class="language-java">public class MyClass { public static final int SOME_CONSTANT = 42; public int pField; private static MyClass sSingleton; int mPackagePrivate; private int mPrivate; protected int mProtected; public static int gField; }</code></pre> <p>使用1字符前缀来表示作用范围，1个字符的前缀必须小写，前缀后面是由表意性强的一个单词或多个单词组成的名字，而且每个单词的首写字母大写，其它字母小写，这样保证了对变量名能够进行正确的断句。</p> <p><strong>Type：类型</strong></p> <p>考虑到Android中使用很多UI控件，为避免控件和普通成员变量混淆以及更好达意，所有用来表示控件的成员变量统一加上控件缩写作为后缀（文末附有缩写表）。</p> <p>对于普通变量一般不添加类型后缀，如果统一添加类型后缀，请参考文末的缩写表。</p> <p>用统一的量词通过在结尾处放置一个量词，就可创建更加统一的变量，它们更容易理解，也更容易搜索。</p> <blockquote> <p>注意：如果项目中使用ButterKnife，则不添加m前缀，以LowerCamelCase风格命名。</p> </blockquote> <p>例如，请使用 mCustomerStrFirst 和 mCustomerStrLast，而不要使用mFirstCustomerStr和mLastCustomerStr。</p> <p>量词列表：量词后缀说明</p> <p>First 一组变量中的第一个<br> Last 一组变量中的最后一个<br> Next 一组变量中的下一个变量<br> Prev 一组变量中的上一个<br> Cur 一组变量中的当前变量。</p> <p>说明：</p> <p>集合添加如下后缀：List、Map、Set</p> <p>数组添加如下后缀：Arr</p> <blockquote> <p>注意：所有的VO（值对象）统一采用标准的lowerCamelCase风格编写，所有的DTO（数据传输对象）就按照接口文档中定义的字段名编写。</p> </blockquote> <h3>5.2.6 参数名</h3> <p>参数名以LowerCamelCase风格编写</p> <h3>5.2.7 局部变量名</h3> <p>局部变量名以LowerCamelCase风格编写，比起其它类型的名称，局部变量名可以有更为宽松的缩写。</p> <p>虽然缩写更宽松，但还是要避免用单字符进行命名，除了临时变量和循环变量。</p> <p>即使局部变量是final和不可改变的，也不应该把它示为常量，自然也不能用常量的规则去命名它。</p> <p><strong>临时变量</strong></p> <p>临时变量通常被取名为i，j，k，m和n，它们一般用于整型；c，d，e，它们一般用于字符型。 如： for (int i = 0; i < len ; i++)，并且它和第一个单词间没有空格。</p> <h3>5.2.8 类型变量名</h3> <p>类型变量可用以下两种风格之一进行命名：</p> <ul> <li>单个的大写字母，后面可以跟一个数字(如：E, T, X, T2)。</li> <li>以类命名方式(5.2.2节)，后面加个大写的T(如：RequestT, FooBarT)。</li> </ul> <h3>5.2.9 资源文件命名规范</h3> <p><em>1. 资源布局文件（XML文件（layout布局文件））：</em></p> <p>全部小写，采用下划线命名法<br> 1) contentview 命名<br> 必须以全部单词小写，单词间以下划线分割，使用名词或名词词组。<br> 所有Activity或Fragment的contentView必须与其类名对应，对应规则为：<br> 将所有字母都转为小写，将类型和功能调换（也就是后缀变前缀）。<br> 例如：<code>activity_main.xml</code></p> <p>2) Dialog命名：<code>dialog_描述.xml</code><br> 例如：<code>dialog_hint.xml</code></p> <p>3) PopupWindow命名：<code>ppw_描述.xml</code><br> 例如：<code>ppw_info.xml</code></p> <p>4) 列表项命名：<code>item_描述.xml</code><br> 例如：<code>item_city.xml</code></p> <p>5) 包含项命名：<code>模块_(位置)描述.xml</code><br> 例如：<code>activity_main_head.xml</code>、<code>activity_main_bottom.xml</code><br> 注意：通用的包含项命名采用：<code>项目名称缩写_描述.xml</code><br> 例如：<code>xxxx_title.xml</code><br> <em>2. 资源文件（图片drawable文件夹下）：</em><br> 全部小写，采用下划线命名法，加前缀区分<br> 命名模式：可加后缀 <code>_small</code> 表示小图, <code>_big</code> 表示大图，逻辑名称可由多个单词加下划线组成，采用以下规则：<br> <code>用途_模块名_逻辑名称</code><br> <code>用途_模块名_颜色</code><br> <code>用途_逻辑名称</code><br> <code>用途_颜色</code><br> 说明：用途也指控件类型（具体见UI控件缩写表）<br> 例如：<br> <code>btn_main_home.png</code> 按键<br> <code>divider_maket_white.png</code> 分割线<br> <code>ic_edit.png</code> 图标<br> <code>bg_main.png</code> 背景<br> <code>btn_red.png</code> 红色按键<br> <code>btn_red_big.png</code> 红色大按键<br> <code>ic_head_small.png</code> 小头像<br> <code>bg_input.png</code> 输入框背景<br> <code>divider_white.png</code> 白色分割线<br> 如果有多种形态如按钮等除外如 <code>btn_xx.xml</code>（selector）</p> <table> <thead> <tr> <th>名称</th> <th>功能</th> </tr> </thead> <tbody> <tr> <td><code>btn_xx</code></td> <td>按钮图片使用<code>btn_整体效果</code>（selector）</td> </tr> <tr> <td><code>btn_xx_normal</code></td> <td>按钮图片使用<code>btn_正常情况效果</code></td> </tr> <tr> <td><code>btn_xx_pressed</code></td> <td>按钮图片使用<code>btn_点击时候效果</code></td> </tr> <tr> <td><code>btn_xx_focused</code></td> <td><code>state_focused</code>聚焦效果</td> </tr> <tr> <td><code>btn_xx_disabled</code></td> <td><code>state_enabled</code> (false)不可用效果</td> </tr> <tr> <td><code>btn_xx_checked</code></td> <td><code>state_checked</code>选中效果</td> </tr> <tr> <td><code>btn_xx_selected</code></td> <td><code>state_selected</code>选中效果</td> </tr> <tr> <td><code>btn_xx_hovered</code></td> <td><code>state_hovered</code>悬停效果</td> </tr> <tr> <td><code>btn_xx_checkable</code></td> <td><code>state_checkable</code>可选效果</td> </tr> <tr> <td><code>btn_xx_activated</code></td> <td><code>state_activated</code>激活的</td> </tr> <tr> <td><code>btn_xx_windowfocused</code></td> <td><code>state_window_focused</code></td> </tr> <tr> <td><code>bg_head</code></td> <td>背景图片使用<code>bg_功能_说明</code></td> </tr> <tr> <td><code>def_search_cell</code></td> <td>默认图片使用<code>def_功能_说明</code></td> </tr> <tr> <td><code>ic_more_help</code></td> <td>图标图片使用<code>ic_功能_说明</code></td> </tr> <tr> <td><code>seg_list_line</code></td> <td>具有分隔特征的图片使用<code>seg_功能_说明</code></td> </tr> <tr> <td><code>sel_ok</code></td> <td>选择图标使用<code>sel_功能_说明</code></td> </tr> </tbody> </table> <p>注意：</p> <p>使用AndroidStudio的插件SelectorChapek可以快速生成selector，前提是命名要规范。</p> <p><em>3. 动画文件（anim文件夹下）：</em></p> <p>全部小写，采用下划线命名法，加前缀区分。<br> 具体动画采用以下规则：<br> <code>模块名_逻辑名称</code><br> 逻辑名称<br> <code>refresh_progress.xml</code><br> <code>market_cart_add.xml</code><br> <code>market_cart_remove.xml</code><br> 普通的tween动画采用如下表格中的命名方式<br> // 前面为动画的类型，后面为方向</p> <table> <thead> <tr> <th>动画命名例子</th> <th>规范写法</th> </tr> </thead> <tbody> <tr> <td><code>fade_in</code></td> <td>淡入</td> </tr> <tr> <td><code>fade_out</code></td> <td>淡出</td> </tr> <tr> <td><code>push_down_in</code></td> <td>从下方推入</td> </tr> <tr> <td><code>push_down_out</code></td> <td>从下方推出</td> </tr> <tr> <td><code>push_left</code></td> <td>推向左方</td> </tr> <tr> <td><code>slide_in_from_top</code></td> <td>从头部滑动进入</td> </tr> <tr> <td><code>zoom_enter</code></td> <td>变形进入</td> </tr> <tr> <td><code>slide_in</code></td> <td>滑动进入</td> </tr> <tr> <td><code>shrink_to_middle</code></td> <td>中间缩小</td> </tr> </tbody> </table> <p><em>4. values中name命名</em></p> <table> <thead> <tr> <th>类别</th> <th>命名</th> <th>示例</th> </tr> </thead> <tbody> <tr> <td>strings</td> <td>strings的name命名使用下划线命名法，采用以下规则：模块名+逻辑名称</td> <td>main_menu_about 主菜单按键文字friend_title 好友模块标题栏friend_dialog_del 好友删除提示login_check_email 登录验证 <p> </p> <p>dialog_title 弹出框标题</p> <p>button_ok 确认键 loading 加载文字</p> <p> </p> </td> </tr> <tr> <td>colors</td> <td>colors的name命名使用下划线命名法，采用以下规则：模块名+逻辑名称 颜色</td> <td>friend_info_bg friend_bg transparent gray</td> </tr> <tr> <td>styles</td> <td>styles的name命名使用 Camel命名法，采用以下规则：模块名+逻辑名称</td> <td>main_tabBottom</td> </tr> </tbody> </table> <p><em>5. layout中的id命名</em></p> <p>命名模式为：<code>view缩写_view的逻辑名称</code><br> 使用 AndroidStudio 的插件 ButterKnife Zelezny，生成注解非常方便。<br> 如果不使用 ButterKnife Zelezny，则建议使用 view 缩写做后缀，如：<code>username_tv</code>（展示用户名的TextView）</p> <p>6. 编程实践</p> <h2>6.1 @Override：能用则用</h2> <p>只要是合法的，就把@Override注解给用上。</p> <h2>6.2 捕获的异常：不能忽视</h2> <p>除了下面的例子，对捕获的异常不做响应是极少正确的。(典型的响应方式是打印日志，或者如果它被认为是不可能的，则把它当作一个 AssertionError 重新抛出。)</p> <p>如果它确实是不需要在catch块中做任何响应，需要做注释加以说明(如下面的例子)。</p> <pre> <code class="language-java">try { int i = Integer.parseInt(response); return handleNumericResponse(); } catch (NumberFormatException ok) { // it's not numeric; that's fine, just continue } return handleTextResponse(response);</code></pre> <p>例外：在测试中，如果一个捕获的异常被命名为expected，则它可以被不加注释地忽略。下面是一种非常常见的情形，用以确保所测试的方法会抛出一个期望中的异常，因此在这里就没有必要加注释。</p> <pre> <code class="language-java">try { emptyStack.pop(); fail(); } catch (NoSuchElementException expected) { }</code></pre> <h2>6.3 静态成员：使用类进行调用</h2> <p>使用类名调用静态的类成员，而不是具体某个对象或表达式。</p> <pre> <code class="language-java">Foo aFoo = ...; Foo.aStaticMethod(); // good aFoo.aStaticMethod(); // bad somethingThatYieldsAFoo().aStaticMethod(); // very bad</code></pre> <h2>6.4 Finalizers: 禁用</h2> <p>极少会去重载Object.finalize。</p> <blockquote> <p>Tip：<br> 不要使用finalize。如果你非要使用它，请先仔细阅读和理解Effective Java 第7条款：”Avoid Finalizers”，然后不要使用它。</p> </blockquote> <p>7. Javadoc</p> <h2>7.1 格式</h2> <h3>7.1.1 一般形式</h3> <p>Javadoc块的基本格式如下所示：</p> <pre> <code class="language-java">/** * Multiple lines of Javadoc text are written here, * wrapped normally... */ public int method(String p1) { ... }</code></pre> <p>或者是以下单行形式：</p> <pre> <code class="language-java">/** An especially short bit of Javadoc. */</code></pre> <p>基本格式总是OK的。当整个Javadoc块能容纳于一行时(且没有Javadoc标记@XXX)，可以使用单行形式。</p> <h3>7.1.2 段落</h3> <p>空行(即，只包含最左侧星号的行)会出现在段落之间和Javadoc标记(@XXX)之前(如果有的话)。</p> <p>除了第一个段落，每个段落第一个单词前都有标签<code><p></code>，并且它和第一个单词间没有空格。</p> <h3>7.1.3 Javadoc标记</h3> <p>标准的Javadoc标记按以下顺序出现：@param, @return, @throws, @deprecated,</p> <p>前面这4种标记如果出现，描述都不能为空。 当描述无法在一行中容纳，连续行需要至少再缩进4个空格。</p> <h2>7.2 摘要片段</h2> <p>每个类或成员的Javadoc以一个简短的摘要片段开始。这个片段是非常重要的，在某些情况下，它是唯一出现的文本，比如在类和方法索引中。</p> <p>这只是一个小片段，可以是一个名词短语或动词短语，但不是一个完整的句子。它不会以A {@code Foo} is a…或This method returns…开头,它也不会是一个完整的祈使句，如Save the record…。然而，由于开头大写及被加了标点，它看起来就像是个完整的句子。</p> <blockquote> <p>Tip：<br> 一个常见的错误是把简单的Javadoc写成</p> <code>/** @return the customer ID */，这是不正确的。它应该写成/** Returns the customer ID. */</code>。 </blockquote> <h2>7.3 哪里需要使用Javadoc</h2> <p>至少在每个public类及它的每个public和protected成员处使用Javadoc，以下是一些例外：</p> <h3>7.3.1 例外：不言自明的方法</h3> <p>对于简单明显的方法如getFoo，Javadoc是可选的(即，是可以不写的)。这种情况下除了写”Returns the foo”，确实也没有什么值得写了。</p> <p>单元测试类中的测试方法可能是不言自明的最常见例子了，我们通常可以从这些方法的描述性命名中知道它是干什么的，因此不需要额外的文档说明。</p> <blockquote> <p>Tip：<br> 如果有一些相关信息是需要读者了解的，那么以上的例外不应作为忽视这些信息的理由。例如，对于方法名getCanonicalName，</p> </blockquote> <p>就不应该忽视文档说明，因为读者很可能不知道词语canonical name指的是什么。</p> <h3>7.3.2 例外：重载</h3> <p>如果一个方法重载了超类中的方法，那么Javadoc并非必需的。</p> <h3>7.3.3 可选的Javadoc</h3> <p>对于包外不可见的类和方法，如有需要，也是要使用Javadoc的。如果一个注释是用来定义一个类，方法，字段的整体目的或行为，那么这个注释应该写成Javadoc，这样更统一更友好。</p> <p>附录：</p> <p>表1 UI控件缩写表</p> <table> <thead> <tr> <th>控件</th> <th>缩写</th> <th>例子</th> </tr> </thead> <tbody> <tr> <td>LinearLayout</td> <td>ll</td> <td>llFriend或者mFriendLL</td> </tr> <tr> <td>RelativeLayout</td> <td>rl</td> <td>rlMessage或mMessageRL</td> </tr> <tr> <td>FrameLayout</td> <td>fl</td> <td>flCart或mCartFL</td> </tr> <tr> <td>TableLayout</td> <td>tl</td> <td>tlTab或mTabTL</td> </tr> <tr> <td>Button</td> <td>btn</td> <td>btnHome或mHomeBtn</td> </tr> <tr> <td>ImageButton</td> <td>ibtn</td> <td>btnPlay或mPlayIBtn</td> </tr> <tr> <td>TextView</td> <td>tv</td> <td>tvName或mNameTV</td> </tr> <tr> <td>EditText</td> <td>et</td> <td>etName或mNameET</td> </tr> <tr> <td>ListView</td> <td>lv</td> <td>lvCart或mCartLV</td> </tr> <tr> <td>ImageView</td> <td>iv</td> <td>ivHead或mHeadIV</td> </tr> <tr> <td>GridView</td> <td>gv</td> <td>gvPhoto或mPhotoGV</td> </tr> </tbody> </table> <p>表2 常见的英文单词缩写:</p> <table> <thead> <tr> <th>名称</th> <th>缩写</th> </tr> </thead> <tbody> <tr> <td>icon</td> <td>ic （主要用在app的图标）</td> </tr> <tr> <td>color</td> <td>cl（主要用于颜色值）</td> </tr> <tr> <td>divider</td> <td>di（主要用于分隔线，不仅包括Listview中的divider，还包括普通布局中的线）</td> </tr> <tr> <td>selector</td> <td>sl（主要用于某一view多种状态，不仅包括Listview中的selector，还包括按钮的selector）</td> </tr> <tr> <td>average</td> <td>avg</td> </tr> <tr> <td>background</td> <td>bg（主要用于布局和子布局的背景）</td> </tr> <tr> <td>buffer</td> <td>buf</td> </tr> <tr> <td>control</td> <td>ctrl</td> </tr> <tr> <td>delete</td> <td>del</td> </tr> <tr> <td>document</td> <td>doc</td> </tr> <tr> <td>error</td> <td>err</td> </tr> <tr> <td>escape</td> <td>esc</td> </tr> <tr> <td>increment</td> <td>inc</td> </tr> <tr> <td>infomation</td> <td>info</td> </tr> <tr> <td>initial</td> <td>init</td> </tr> <tr> <td>image</td> <td>img</td> </tr> <tr> <td>Internationalization</td> <td>I18N</td> </tr> <tr> <td>length</td> <td>len</td> </tr> <tr> <td>library</td> <td>lib</td> </tr> <tr> <td>message</td> <td>msg</td> </tr> <tr> <td>password</td> <td>pwd</td> </tr> <tr> <td>position</td> <td>pos</td> </tr> <tr> <td>server</td> <td>srv</td> </tr> <tr> <td>string</td> <td>str</td> </tr> <tr> <td>temp</td> <td>tmp</td> </tr> <tr> <td>window</td> <td>wnd(win)</td> </tr> </tbody> </table> <p>程序中使用单词缩写原则：不要用缩写，除非该缩写是约定俗成的。</p> <p>来源：http://www.jianshu.com/p/0a984f999592</p>