1、JAVA编码规范vJAVA编码规范2011/6/20北京信息技术开发公司目 录：1 导言1.1 目的本文档旨在提供一个编码的标准，以便所有Java代码在产生的一开始就能够在整个开发团队中保持一致，从而能够更好的阅读和修改代码。1.2 范围本文档适用于信息中心项目开发团队的所有成员，为了使项目的后期维护和修改变的容易，在每个项目开发中一定要遵守本文档中的规定术语定义1.3 角色和职责编码负责人：本规范在具体项目中执行监督负责人。通过实施Source Review 制度，编程人员在完成自己的一个模块并提交测试前，由编码负责人进行Source Review，不符合本编程规约的程序一律打回，重新修改，
2、即编码人你认为自己的程序没有任何的功能问题。编码人员：本规范的遵守者。1.4 术语定义l Logger - 系统进行日志输出了类，为引用第三方（Apache Group）的输出类，具体用法见 Log输出规范的说明。2 源代码要求2.1 可读性要求可读性第一，在不严重影响系统性能的情况下要优先考虑程序的可读性。2.2 结构化要求1. 禁止出现两条等价的支路。2. 用 IF 语句来强调只执行两组语句中的一组。禁止 else break, else continue和else return。3. 用 CASE 实现多路分支。4. 不使用复杂算数表达式，如：+，-等符号在含两个算数项的表达式中使用。5
3、. 避免不必要的分支。6. 不要轻易用条件分支去替换逻辑表达式。2.3 正确性与容错性要求1. 程序首先是正确，其次是优美2. 每个开发人员要养成自我检查程序的习惯，将明显的错误码消除在交与测试之前。3. 对与进行系统测试或者生产运行中的系统，修改前应考虑修改方案对系统其它部分的影响，查找与对该修改处的所有引用，进行分析。4. 所有变量必须在声明时初始化。5. 对所有的用户输入，必须进行合法性检查。6. 不要比较浮点数的相等，只能进行范围比较。如： 10.0 * 0.1 = 1.0 ， 不可靠。7. 程序与环境或状态发生关系时，必须主动去处理发生的意外事件，如文件能否逻辑锁定、打印机是否联机等
4、。8. 单元测试也是编程的一部份，提交联调测试的程序必须通过单元测试。2.4 可重用性要求1. 重复使用的完成相对独立功能的算法或代码应抽象为公共函数或类。2. 公共函数或类应考虑OO思想，减少外界联系，考虑独立性或封装性。3. 公共函数或类应建立使用模板。4. 公共类和公共函数必须有详细的文档，说明功能、用法及缺陷。5. 程序编码力求简洁，结构清晰，避免太多的分支结构及太过于技巧性的程序，尽量不采用递归模式。6. 编写程序时，亦必须想好测试的方法，换句话说，”单元测试” 的测试方案应在程序编写时一并拟好。7. 程序中每个block 的开头 ” 及 ” 必须对齐，嵌套的block 每进一套，缩
5、进一个tab，TAB 为4个空格,block类型包括if、for、while、do等关键字引出的。8. 对于比较大的函数，每个block 和特殊的函数调用，都必须注明其功能。2.5 源代码管理所有源程序必须放入配置管理工具中进行管理，尤其要加强维护中的系统源代码管理。详细办法请遵守配置管理规范。3 格式3.1 缩进所有的缩进皆为4个空格。对应的括号通常在同一列的位置上。例如： void foo() while ( bar 0 ) Logger.debug(); bar- ; if ( oatmeal = tasty ) Logger.debug(Oatmeal is good and good
6、 for you); else if ( oatmeal = yak ) Logger.debug(Oatmeal tastes like sawdust); else Logger.debug(tell me pleeze what iz dis oatmeal); switch( suckFactor ) case 1: Logger.debug(This sucks); break; case 2: Logger.debug(This really sucks); break; default: Logger.debug(whatever); break; 1）所有的缩进是由Space(
7、空格)键形成的，而不是Tab键。2）所有的if、while和for语句中的状态内容必须用括号括起来，就算只有一个状态。if ( superHero = theTick ) Logger.debug(Spoon!);3.2间隔1）所有的标识符都必须被空白字符包围。 int theTick = 5 ; if ( theTick = 5 ) 这么做唯一可能成为麻烦的是复杂的布尔分析影响了清晰度，例： if ( ( hero = theTick ) & ( ( sidekick = arthur ) | ( sidekick = speak ) ) )不如这样： boolean isTickSidek
8、ick = ( ( sidekick = arthur ) | ( sidekick = speak ) );if ( ( hero = theTick ) & isTickSidekick ) 2）然而也有一些例外的情况，见下表：例外情况原由正确示例错误示例方法名习惯写法是在所有方法名之后直接跟上一个左括号foo( i ) ;start() ;args 0 ;tens i ;数组习惯写法是在所有数组名之后直接跟上一个左方括号args0 ;tens I ;args 0 ;tens i ;自加、自减运算符习惯写法是在所有一元运算符前面或后面直接加上操作数+count ; i- ;+count ;
9、 i - ;造型运算符习惯写法是所有造型都不加空格(MyClass)v.get( 3 ) ;(MyClass) v.get( 3 ) ;( MyClass )v.get( 3 ) ;3.3空行应该时不时的在各方法之间加入一些空格行来分割大段的代码；还应该在方法与方法之间加入一两行的空格行。3.4类成员的摆放顺序 class Order 1. final attributes2. attributes3. constructors4. methods 必须保持private方法被放置在使用该方法的其他方法之上，而在构造器（constructor）之下，即使该构造器有可能调用这些private方法
10、。3.5文件格式(File Format)package必须总保持第一个出现；import其次；再次，任何非javadoc的注释；然后是javadoc类文件最后便是类。注意：一个文件(File)只能有一个类，内部类除外。示例： package misc ; import java.io.* ; import .* ; /* this class does cool stuff * author Joe Programmer */ class SpaceMonkey . 3.6行最大长度不要让一行代码的长度超过120个字符，最好是低于80个字符。如果代码开始向右延伸得很长，你就应该考虑把它分割成
11、更多的方法。3.7括号使用括号的目的必须是在表达上不但能够标明优先顺序，而且有助于使表达更简单明了。另外，如果某一段代码有可能产生歧义，也需加括号。4 命名规则所有的标识符只能用字母（A-Z或a-z）和数字（0-9）。不能有货币符号或者其它非ASCII字符；4.1 包所有包名只能用小写字母。尽量别使包名长度超过8个字符，应该避免使用多个词作为包名。示例：commoncorelang4.2 类和接口所有类和接口标识符将都使用混合格表示。每个名称中的每个单词首字母必须大写，同时这个名称的首字母也必须大写；其它的字母均小写，除了缩写词之外（它们必须全部大写）。示例： CustomerSalesOrd
12、erTargetURLURLTarget4.3 方法1、 类方法一般以动词开始，第一个字母小写。2、 方法名中的每个词的第一个字母要大写。3、 方法中的形参命名办法参见普通变量命名规则。4.4 get和set方法（属性的定义）用于设置对象状态的方法必须在方法名前面加一个前缀set；用于检索一个布尔类型对象状态的方法必须在方法名前面加一个前缀is；而用于检索其它类型对象状态的方法则必须在方法名前面加上get。示例：setEnabled()getName()isEnabled()4.5 变量4.5.1 普通变量普通变量指的方法体中或者方法参数的变量。变量的命名应尽可能采用见名知义，基本命名规则如下
13、：变量名 = 变量前缀 + 变量含义变量前缀遵循匈牙利命名规则，定义如下：类型前缀shortsintncharchdoubledbooleanblonglfloatf4.5.2 常用对象变量类型前缀StringstrVectorvHashMaphmHashtablehtDatedtTimestamptsCollectioncollIteratoriterListlstObjectaryObj4.5.3 临时变量一般临时变量没有具体的意思，所以临时变量名为：临时变量名 = 变量前缀 + （Temp或Tmp）；其中有一些C语言延续下来的常见临时变量也可以接受：如i , j , k 一般用于表示一个
14、临时整型变量。4.5.4 成员变量无论是类成员变量是静态成员变量，都要在普通变量的命名规则基础上在加前缀”m_”，注意不可以使用”g_”。5 常量的命名 JAVA中常量命名使用Static Final 变量实现。常量名必须具有一定的实际意义；常量的名字必须都大写，每个单词之间用 ”_” 连接，并且指出完整含义；常量声明在类的最上边；每一条定义必须有一简单的注释，说明其作用；6 注 释大部分注释尽量用/；对于所有的javadoc的注释则用/* */；而临时对代码块进行的注释尽量用/* */。6.1 要求1、 类、方法、变量必须注释说明；注释内容应根据客户要求的语言进行，原则上，除常量、变量、变量
15、类型等以外的说明尽可能采用中文注释；2、 保持注释与代码一致。6.2 JavaDoc说明1）JavaDoc注释将用于说明那些被其它类调用的类、属性和方法。这些注释必须出现在所要说明的各项之前。2）JavaDoc注释一般不会用于说明一些显而易见的方法，例如：public static void main( String args ) 或public int getX( ) ；3）JavaDoc注释也不用于说明一些显而易见的参数，如：public void setX( int newX ) ；4）诸如servlet和EJB等那些没有被其它类调用的类，也不必加JavaDoc注释。把源码上交给整个团队
16、之前，必须先经过JavaDoc处理，并全面检查处理结果，以确定说明文字确实可读而且清楚明白。示例：/* * Copyright 2011 hongxin * Change Revision * - * Date Author Remarks * $date $user create * - */* * author xxx.xxx * version 创建时间：Jan 11, 2011 2:56:39 PM * 类说明 xxxxx */6.3 类每个类都要有类说明，类的JavaDoc说明文件必须包括以下内容：（1）简要的提纲（2）详细的描述（3）使用该类的示例代码段（4）用author标签列出
17、作者注意：由于JavaDoc中一个功能（feature）限制，所有示例代码的每行前面必须加入一个星号，以便保存每行的缩进。例如：类注释/* * author $user* version 创建时间：$date $time * 类说明 */ 6.4 方法方法的JavaDoc说明文档必须包含以下内容：（1）简要的提纲；（2）详细的描述（如果有必要在简要提纲内补充说明某些内容的话）；（3）用JavaDoc的param标签列出所有参数（如果有参数的话）；（4）用JavaDoc的return标签返回出方法的值列表（如果需要返回值的话）；（5）用JavaDoc的exception标签列出所有异常（exception）(如果有异常抛出的话)示例：方法注释/* * Title: $enclosing_method * Description: * $tags * return $return_type * throws */
