050101编程规范《Java》.docx

1、050101编程规范Java 企业技术规范 Java语言编程规范目 次前言 .31 范围112 规范性引用文件113 术语和定义114 排版规范124.1 规则121.*程序块要采用缩进风格编写，缩进的空格数为4个。122.*分界符（如大括号和）应各独占一行并且位于同一列，同时与引用它们的语句左对齐。在函数体的开始、类和接口的定义、以及if、for、do、while、switch、case语句中的程序都要采用如上的缩进方式。123.*较长的语句、表达式或参数（80字符）要分成多行书写，长表达式要在低优先级操作符处划分新行，操作符放在新行之首，划分出的新行要进行适当的缩进，使排版整齐，语句可读。

2、 134.*不允许把多个短语句写在一行中，即一行只写一条语句135.*if, for, do, while, case, switch, default 等语句自占一行，且if, for, do, while等语句的执行语句无论多少都要加括号。136.*相对独立的程序块之间、变量说明之后必须加空行。137.*对齐只使用空格键，不使用TAB键。148.*在两个以上的关键字、变量、常量进行对等操作时，它们之间的操作符之前、之后或者前后要加空格；进行非对等操作时，如果是关系密切的立即操作符（如.），后不应加空格。144.2 建议151.类属性和类方法不要交叉放置，不同存取范围的属性或者方法也尽量不要

3、交叉放置。155 注释规范165.1 规则161.一般情况下，源程序有效注释量必须在30以上。162.包的注释：包的注释写入一个名为 package.html 的HTML格式的说明文件放入当前路径。163.包的注释内容：简述本包的作用、详细描述本包的内容、产品模块名称和版本、公司版权。164.文件注释：文件注释写入文件头部，包名之前的位置。165.文件注释内容：版权说明、描述信息、生成日期、修改历史。176.类和接口的注释：该注释放在 package 关键字之后，class 或者 interface 关键字之前。187.类和接口的注释内容：类的注释主要是一句话功能简述、功能详细描述，188.类

4、属性、公有和保护方法注释：写在类属性、公有和保护方法上面。199. 成员变量注释内容：成员变量的意义、目的、功能，可能被用到的地方。1910.公有和保护方法注释内容：列出方法的一句话功能简述、功能详细描述、输入参数、输出参数、返回值、违例等。1911.对于方法内部用throw语句抛出的异常，必须在方法的注释中标明，对于所调用的其他方法所抛出的异常，选择主要的在注释中说明。 对于非RuntimeException，即throws子句声明会抛出的异常，必须在方法的注释中标明。2012.*注释应与其描述的代码相近，对代码的注释应放在其上方或右方（对单条语句的注释）相邻位置，不可放在下面，如放于上方则

5、需与其上面的代码用空行隔开。2013.*注释与所描述内容进行同样的缩排。2014.*将注释与其上面的代码用空行隔开。2115.*对变量的定义和分支语句（条件分支、循环语句等）必须编写注释。2116.*对于switch语句下的case语句，如果因为特殊情况需要处理完一个case后进入下一个case处理，必须在该case语句处理完、下一个case语句前加上明确的注释。2117.*边写代码边注释，修改代码同时修改相应的注释，以保证注释与代码的一致性。不再有用的注释要删除。2118.*注释的内容要清楚、明了，含义准确，防止注释二义性。2119.*避免在注释中使用缩写，特别是不常用缩写。215.1 建议

6、211.*避免在一行代码或表达式的中间插入注释。222.*通过对函数或过程、变量、结构等正确的命名以及合理地组织代码的结构，使代码成为自注释的。223.*在代码的功能、意图层次上进行注释，提供有用、额外的信息。224.*在程序块的结束行右方加注释标记，以表明某程序块的结束。225.*注释应考虑程序易读及外观排版的因素，使用的语言若是中、英兼有的，建议多使用中文，除非能用非常流利准确的英文表达。226.方法内的单行注释使用 /。227.注释尽量使用中文注释和中文标点。方法和类描述的第一句话尽量使用简洁明了的话概括一下功能，然后加以句号。接下来的部分可以详细描述。238.顺序实现流程的说明使用1、

7、2、3、4在每个实现步骤部分的代码前面进行注释。239. 一些复杂的代码需要说明。236 命名规范246.1 规则241.包名采用域后缀倒置的加上自定义的包名，采用小写字母。在部门内部应该规划好包名的范围，防止产生冲突。部门内部产品使用部门的名称加上模块名称。产品线的产品使用产品的名称加上模块的名称。242.类名和接口使用类意义完整的英文描述，每个英文单词的首字母使用大写、其余字母使用小写的大小写混合法。243.方法名使用类意义完整的英文描述：第一个单词的字母使用小写、剩余单词首字母大写其余字母小写的大小写混合法。244.方法中，存取属性的方法采用setter 和 getter方法，动作方法采

8、用动词和动宾结构。245.属性名使用意义完整的英文描述：第一个单词的字母使用小写、剩余单词首字母大写其余字母小写的大小写混合法。属性名不能与方法名相同。256.常量名使用全大写的英文描述，英文单词之间用下划线分隔开，并且使用 final static 修饰。257.属性名可以和公有方法参数相同，不能和局部变量相同，引用非静态成员变量时使用 this 引用，引用静态成员变量时使用类名引用。256.2 建议251.常用组件类的命名以组件名加上组件类型名结尾。252.如果函数名超过15 个字母，可采用以去掉元音字母的方法或者以行业内约定俗成的缩写方式缩写函数名。263.准确地确定成员函数的存取控制符

9、号，不是必须使用 public 属性的，请使用 protected，不是必须使用 protected, 请使用 private。264.含有集合意义的属性命名，尽量包含其复数的意义。267 编码规范277.1 规则271.*明确方法功能，精确（而不是近似）地实现方法设计。一个函数仅完成一件功能，即使简单功能也应该编写方法实现。 272.应明确规定对接口方法参数的合法性检查应由方法的调用者负责还是由接口方法本身负责，缺省是由方法调用者负责。273.明确类的功能，精确（而不是近似）地实现类的设计。一个类仅实现一组相近的功能。274.所有的数据类必须重载toString() 方法，返回该类有意义的内

10、容。275.数据库操作、IO操作等需要使用结束close()的对象必须在try -catch-finally 的finally中close()。276.异常捕获后，如果不对该异常进行处理，则应该纪录日志或者ex.printStackTrace() 。287.自己抛出的异常必须要填写详细的描述信息。288.运行期异常使用RuntimeException的子类来表示，不用在可能抛出异常的方法声明上加throws子句。非运行期异常是从Exception继承而来的，必须在方法声明上加throws子句。299.在程序中使用异常处理还是使用错误返回码处理，根据是否有利于程序结构来确定，并且异常和错误码不应

11、该混合使用，推荐使用异常。2910.*注意运算符的优先级，并用括号明确表达式的操作顺序，避免使用默认优先级。2911.*避免使用不易理解的数字，用有意义的标识来替代。涉及物理状态或者含有物理意义的常量，不应直接使用数字，必须用有意义的静态变量来代替。2912.数组声明的时候使用 int index ，而不要使用 int index 。3013.调试代码的时候，不要使用 System.out 和 System.err 进行打印，应该使用一个包含统一开关的测试类进行统一打印。3014.用调测开关来切换软件的DEBUG版和正式版，而不要同时存在正式版本和DEBUG版本的不同源文件，以减少维护的难度。

12、307.2建议301.记录异常不要保存exception.getMessage()，而要记录exception.toString()。302.一个方法不应抛出太多类型的异常。313.异常捕获尽量不要直接 catch (Exception ex)，应该把异常细分处理。314.*如果多段代码重复做同一件事情，那么在方法的划分上可能存在问题。315.对于创建的主要的类，最好置入main()函数，包含用于测试那个类的代码 。316.集合中的数据如果不使用了应该及时释放，尤其是可重复使用的集合。317.*源程序中关系较为紧密的代码应尽可能相邻。318.*不要使用难懂的技巧性很高的语句，除非很有必要时。3

13、18 JTEST规范328.1 规则（1-2 级）321.在switch 中每个 case 语句都应该包含 break 或者 return 。322.不要使用空的for 、if 、while 语句。323.在运算中不要减小数据的精度。324.switch 语句中的 case 关键字要和后面的常量保持一个空格，switch 语句中不要定义case 之外的无用标签。325.不要在if 语句中使用等号= 进行赋值操作。326.静态成员或者方法使用类名访问，不使用句柄访问。327.方法重载的时候，一定要注意方法名相同，避免类中使用两个非常相似的方法名。328.不要在ComponentLponentRe

14、sized() 方法中调用 serResize() 方法。329.不要覆盖父类的静态方法和私有方法。3210.不要覆盖父类的属性。3211.不要使用两级以上的内部类。3212.把内部类定义成私有类。3213.去掉接口中多余的定义（不使用 public, abstract, static, final 等，这是接口中默认的）。3214.不要定义不会被用到的局部变量、类私有属性、类私有方法和方法参数。3215.显式初始化所有的静态属性。3216.不要使用 System.getenv() 方法。3217.不要硬编码 n和r作为换行符号。3218.不要直接使用 java.awt.peer.* 里面的接

15、口。3219.使用 System.arraycopy() ，不使用循环来复制数组。3220.避免不必要的 instanceof 比较运算和类造型运算。3221.不要在 finalize() 方法中删除监听器（Listeners）。3222.在 finalize() 方法中一定要调用 super.finalize() 方法。3223.在 finalize() 方法中的 finally 中调用 super.finalize() 方法。3224.进行字符转换的时候应该尽可能的较少临时变量。3225.使用ObjectStream 的方法后，调用reset() ，释放对象。3226.线程同步中，在循环里

16、面使用条件测试（使用 while(isWait) wait() 代替 if(isWait) wait()）。3227.不掉用 Thread 类的 resume(), suspend(), stop() 方法。3228.减小单个方法的复杂度，使用的 if, while, for, switch 语句要在10个以内。3229.在Servlets中，重用JDBC连接的数据源。3230.减少在Sevlets中使用的同步方法。3231.不定义在包中没有被用到的友好属性、方法和类。3232.没有子类的友好类应该定义成 final 。3233.没有被覆盖的友好方法应该定义成 final 。328.2 建议（

17、3级或以上）331.为 switch 语句提供一个 default 选项。332.不要在 for 循环体中对计数器的赋值。333.不要给非公有类定义 public 构建器。334.不要对浮点数进行比较运算，尤其是不要进行 =, !=运算，减少 , , 。3444.一个字符的连接使用 而不使用 “ ”，如：String a = b + c。3445.不要在循环体内调用同步方法和使用 try-catch 块。3446.不要使用不必要的布尔值比较，如：if (a.equals(b), 而不是 if (a.equals(b)=true)。3447.常量字符串使用 String, 非常量字符串使用 St

18、ringBuffer 。3448.在循环条件判断的时候不要使用复杂的表达式。3449.对于“if (condition) do1; else do2;”语句使用条件操作符“if (condition)?do1:do2;”。3450.不要在循环体内定义变量。3451.使用StringBuffer的时候设置初始容量。3452.尽可能的使用局部变量进行运算。3453.尽可能少的使用 !操作符。（5级）3454.尽可能的对接口进行 instanceof 运算。（5级）3455.不要使用 Date 而要使用 long 替代。3456.不要显式调用 finalize() 。3457.不要使用静态集合，其内

19、存占用增长没有边界。3458.不要重复调用一个方法获取对象，使用局部变量重用对象。3459.线程同步中，使用 notifyAll() 代替 notify()。3460.避免在同步方法中调用另一个同步方法造成的死锁。3461.非同步方法中不能调用 wait() , notify() 方法。3462.使用 wait(), notify() 代替 while(), sleep() 。3463.不要使用同步方法，使用同步块。（5级）3464.把所有的公有方法定义为同步方法。 （5级）3465.实现的 Runnable.run() 方法必须是同步方法。 （5级）3466.一个只有abstract方法、f

20、inal static 属性的类应该定义成接口。3467.在 clone() 方法中应该而且必须使用 super.clone() 而不是 new 。3468.常量必须定义为 final 。3469.在 for 循环中提供终止条件。3470.在 for, while 循环中使用增量计数。3471.使用 StringTokenizer 代替 indexOf() 和 substring() 。3472.不要在构建器中使用非 final 方法。3473.不要对参数进行赋值操作。（5级）3574.不要通过名字比较两个对象的类，应该使用 getClass() 。3575.安全：尽量不要使用内部类。3576

21、.安全：尽量不要使类可以克隆。3577.安全：尽量不要使接口可以序列化。3578.安全：尽量不要使用友好方法、属性和类。3579.Servlet：不要使用 java.beans.Beans.instantiate() 方法。3580.Servlet：不再使用HttpSession时，应该尽早使用 invalidate() 方法释放 。3581.Servlet：不再使用JDBC资源时，应该尽早使用 close() 方法释放 。3582.Servlet：不要使用Servlet的 SingleThreadModel，会消耗大量资源。3583.国际化：不要使用一个字符进行逻辑操作，使用 Characa

22、ter。3584.国际化：不要进行字符串连接操作，使用MessageFormat 。3585.国际化：不要使用 Date.toString() ，Time.toString() 方法。3586.国际化：字符和字符串常量应该放在资源文件中。3587.国际化：不要使用数字的 toString() 方法。3588.国际化：不要使用 StringBuffer , StringTokenizer类。3589.国际化：不要使用 String 类的 compareTo(), equals() 方法。3590.复杂度：建议的最大规模：351 参考文献36前 言本规范是参考公司的软件编程规范总则和SUN公司Ja

23、va Coding Style Guide结合而成的Java语言编程规范。本规范没有涉及到的相关部分，请参见软件编程规范总则。本规范由技术部提出。本规范主要起草和解释部门：技术部本规范主要起草人：Syman本规范主要审核人：Like C本规范批准人：本规范规范所替代的历次修订情况和修订人为：智能业务部对本规范的以下方面进行了补充和完善：1、排版规范，2、注释规范，3、命名规范，4、编码规范，5、JTEST规范。并且按照最新模版进行重新排版。Java语言编程规范1 范围本规范规定了使用Java语言编程时排版、注释、命名、编码和JTEST的规则和建议。本规范适用于使用Java语言编程的部门和产品。

24、2 规范性引用文件下列文件中的条款通过本规范的引用而成为本规范的条款。凡是注日期的引用文件，其随后所有的修改单（不包括勘误的内容）或修订版均不适用于本规范，然而，鼓励根据本规范达成协议的各方研究是否可使用这些文件的最新版本。凡是不注日期的引用文件，其最新版本适用于本规范。编号名称1公司-0000软件编程规范总则 同总则的部分使用*号2公司-DKBA200106-003Java语言编程规范1 术语和定义规则：编程时强制必须遵守的原则。建议：编程时必须加以考虑的原则。格式：对此规范格式的说明。说明：对此规范或建议进行必要的解释。 示例：对此规范或建议从正、反两个方面给出例子。2 排版规范2.1 规则1. *程序块要采用缩进风格编写，缩进的空格数为4个。说明：对于由开发工具自动生成的代码可以有不一致。2. *分界符（如大括号和）应各独占一行并且位于同一列，同时与引用它们的语句左对齐。在函数体的开始、类和接口的定义、以及if、for、do、while、switch、case语句中的程序都要采用如上的缩进方式。示例：如下例子不符合规范。for (.) . / program codeif (.) . / program code void example_fun( void ) . / program code 应如下书写。for (.) . / program codeif (.)