[计算机]Java编程规范.doc

Java编码规范Java编码规范制定本编程格式的目的是为了使软件可读性好、兼容性好、易维护等等。注：加（*）者为重要保证要求。一、命名规范1.1 Package 的命名(*)Package 的名字应由一个小写单词组成。为了保证包的唯一性，一般以公司国际域名开头。例如：com.te。1.2 Class 的命名(*)Class 的名字必须由大写字母开头，并且其它单词的首写字母也要大写。例如：DbAccess。1.3 Class 成员属性及变量的命名(*)变量/成员属性的名字用一个小写字母开头，后面的单词以大写字母开头。例如：private String lastName;1.4 常量的命名(*)Java 里的常量，是用static final 修饰的，应该用全大写加下划线命名，并且常量名应尽量指出完整含义。如：public static final String ORACLE_DB_DRIVER = oracle.jdbc.driver.OracleDriver ;1.5 数组的命名数组应该总是用下面的形式来命名：byte buffs;而不是：byte buffs;1.6 方法的参数和变量的命名规范一致，且应使用有意义的参数命名，如果可能的话，使用和要赋值的属性一样的名字，如：setCounter(int size)this.size = size;1.7 方法命名(*)用一个小写字母开头，后面的单词以大写字母开头。应意义明确，对于属性的存取方法，应使用getXXX()和setXXX()名称，以isXXX()，hasXXX()来命名返回值为boolean 类型的方法。1.8 一般命名注意事项a. 用有意义的名字命名变量首先，用完整的英语单词或约定俗成的简写命名变量，鼓励多用约定俗成的简写命名变量。例如：public String zipCodepublic int errNob. 用复数命名Collection 类变量Collection， 包括数组，Vector 等。命名时使用复数：例如：public Collection customers二、Java 源文件样式Java(*.java) 源文件应遵守如下的样式规则2.1 Class 代码布局：package Javadoc 注释或者其它文件头注释类声明Fields 声明空行构造函数空行克隆方法空行其它方法（不包括main)空行内部（Inner）类空行main()方法2.2 版权信息版权信息必须在java 文件的开头，例如：/* * Title:编码过滤器 * Description: 该类实现把request请求编码为web.xml文件中所配置的字符集 * Copyright: Copyright (c) 2003 * Company: 广州德易计算机科技有限公司 * author 张三 * version 1.0 */ 2.3 Package/Imports(*)package 行要在版权信息之前，中间空一行。将import 的classes 归类，按顺序罗列：a. Java 标准类(java.*)b. Java 扩充类(javax.*)c. 第三方类d. 你的应用程序的类每一类空一行。注意在第三方类里进行注释，说明它们的来源。如果import 行中包含了同一个包中的多个类，不推荐用import pakage.* 来处理，推荐把要用的类一一import出来。这样程序用到哪些类就可以非常清楚的看出来，有利于代码的维护，增强了代码的可读性。例如：import java.util.Observable;import java.util.Date;import javax.sql.Connection;/Apache Xercesimport org.apache.xml.*;import org.apache.xerces.dom.*;/Application classesimport com.te.db.DbAccess2.4 Class Fields类的成员变量：/* Packet counters*/protected int packets;public 的成员变量必须以生成文档（JavaDoc）的方式进行注释（/* */）。protected、private 和package 定义的成员变量如果名字含义明确的话，可以没有注释。Field 定义可遵从以下顺序：a. public 常量b. public 变量c. protected 常量d. protected 变量e. package 常量f. package 变量g. private 常量h. private 变量2.5 构造方法(*)重载的构造方法应该用递增的方式写（参数多的写在后面）。public CounterSet()this(10);public CounterSet(int size)this.size = size;2.6 克隆方法如果这个类是可以被克隆的，就应实现clone 方法：public Object clone() try CounterSet obj = (CounterSet)super.clone();obj.packets = (int)packets.clone();obj.size = size;return obj;catch(CloneNotSupportedException e) throw new InternalError(Unexpected CloneNotSUpportedException: +e.getMessage();2.7 存取方法(getter，setter)接下来是类成员变量的存取的方法。2.8 类方法下面开始写类方法：/* Set the packet counters* (such as when restoring from a database)*/protected final void setArray(int r1, int r2, int r3, int r4)throws IllegalArgumentException / Ensure the arrays are of equal size/if (r1.length != r2.length | r1.length != r3.length | r1.length !=r4.length)throw new IllegalArgumentException(Arrays must be of the same size);System.arraycopy(r1, 0, r3, 0, r1.length);System.arraycopy(r2, 0, r4, 0, r1.length);2.9 toString 方法每一个类都最好定义toString 方法：public String toString() String retval = CounterSet: ;for (int i = 0; i 0) i + ; / 正确, 单独作为一行不推荐使用：if (i0) i + ; / 错误, 和 在同一行或if (i0) / 错误, 应在上一行末尾。i + ; 语句永远单独作为一行。3.8 if else 语句(*)多条件连续判断语句应按以下格式书写：if ( ) else if () else 应注意if 语句总应使用括号，要避免以下容易出错的写法：if (condition) / 避免。此处略去了!statement;或if (condition) statement; 3.9 括号左括号和后一个字符之间不应该出现空格, 同样, 右括号和前一个字符之间也不应该出现空格。下面的例子说明括号和空格的错误及正确使用:CallProc( AParameter ); / 错误CallProc(AParameter); / 正确不要在语句中使用无意义的括号。括号只应该为达到某种目的（如语法要求或增加程序可读性）而出现在源代码中。下面的例子说明错误和正确的用法：if (I) = 42) / 错误，括号毫无意义if (I = 42) or (J = 42) / 正确，的确需要括号3.10 语句每行只能包括一句代码。如：argv+; / 正确argc-; / 正确argv+; argc-; / 避免!3.11 使用空格空格应依如下规则使用：1关键字与括号之间应加一空格(*)，如：（while 与小括号间有空格）while (true) .注意在方法名和左括号之间不应加空格，这样有助于区分关键字和方法调用。2参数列表中逗号后面应加一个空格(*)。3操作数与操作符之间应该加一空格，除了“.”操作符和一元操作符，即“+”和“”。(*)例：a += c + d;a = (a + b) / (c * d);while (d+ = s+) n+;printSize(size is + foo + n);4for 语句中的表达式应以空格分开(*)：for (expr1; expr2; expr3)5强制类型转换应加空格，如：myMethod(byte) aNum, (Object) x);myMethod(int) (cp + 5), (int) (i + 3)+ 1);3.12 空行和注释源程序中尽量避免连续的行有太多，应根据功能有适当的空行。源程序中要有适当的注释。四、程序编写规范4.1 使用方法来访问实例变量和类变量(*)如果没有很好的理由，一般不应将实例变量或类变量设为public ，将变量设为public的典型应用是此类代表一个“数据结构”，而不包含任何方法。4.2 引用类变量和类方法(*)避免使用对象引用来访问类（static)变量或类方法，而应使用类名来访问。如：classMethod(); /OKAClass.classMethod(); /OKanObject.classMethod(); / 避免!4.3 常量(*)数字常量不应直接在编码中出现，除非是for 循环中用于计数的1，0，或1。字符串常量尽量不直接在编码中出现。4.4 ?前的逻辑运算表达式?前的逻辑运算表达式应以括号括起，如：(x = 0) ? x : -x;4.5 特殊注释注释用XXX 表示当前是伪码，但可以工作，用FIXME 标记有问题的部分。(Use XXX ina comment to flag something that is bogus but works. Use FIXME to flag something thatis bogus and broken.)4.6 例外申明的错误应该抛出一个RuntimeException 或者派生的例外。顶层的main()函数应该截获所有的例外，并且打印（或者记录在日志中）在屏幕上。五、编程实践问题5.1 exit()exit 除了在main 中可以被调用外，其他的地方不应该调用。因为这样做不给任何代码机会来截获退出。一个类似后台服务的程序不应该因为某一个库模块决定了要退出就退出。5.2 垃圾收集JAVA使用成熟的后台垃圾收集技术来代替引用计数。但是这样会导致一个问题：你必须在使用完对象的实例以后进行清场工作。例如： FileOutputStream fos = new FileOutputStream(projectFile) ; project.save(fos, IDE Project File) ; fos.close() ;fos = null ;记住！必须在使用完对象的实例以后将其关闭并且将其设置为null。5.3 final 类绝对不要因为性能的原因将类定义为final 的（除非程序的框架要求）如果一个类还没有准备好被继承，最好在类文档中注明，而不要将她定义为final 的。这是因为没有人可以保证会不会由于什么原因需要继承它。5.4 性能在写代码的时候，从头至尾都应该考虑性能问题。这不是说时间都应该浪费在优化代码上，而是我们时刻应该提醒自己要注意代码的效率。比如：如果没有时间来实现一个高效的算法，那么我们应该在文档中记录下来，以便在以后有空的时候再来实现她。不是所有的人都同意在写代码的时候应该优化性能这个观点，他们认为性能优化的问题应该在项目的后期再去考虑，也就是在程序的轮廓已经实现了以后。应注意：不必要的对象构造不要在循环中构造和释放对象5.5 使用StringBuffer 对象在处理String 的时候要尽量使用StringBuffer 类，StringBuffer 类是构成String 类的基础。String 类将StringBuffer 类封装了起来，（以花费更多时间为代价）为开发人员提供了一个安全的接口。当我们在构造字符串的时候，我们应该用StringBuffer 来实现大部分的工作，当工作完成后将StringBuffer 对象再转换为需要的String 对象。比如：如果有一个字符串必须不断地在其后添加许多字符来完成构造，那么我们应该使用StringBuffer 对象和她的append() 方法。如