java 程序编码规范.txt

java学习文档

[PRE]	...	{		FileOutputStream fos = new FileOutputStream(projectFile);		project.save(fos, "IDE Project File"); 	}	...[/PRE][/TD][/TR][/TABLE]除非输出流一出作用域就关闭，非引用计数的程序语言，比如JAVA，是不能自动完成变量的清场工作的。必须象下面一样写： [TABLE][TR][TD]
[PRE]	FileOutputStream fos = new FileOutputStream(projectFile);	project.save(fos, "IDE Project File"); 	fos.close();[/PRE][/TD][/TR][/TABLE][/LI][/UL][UL][LI]Clone 
下面是一种有用的方法： [TABLE][TR][TD]
[PRE]  implements Cloneable  public    Object clone()    {      try {        ThisClass obj = (ThisClass)super.clone();        obj.field1 = (int[])field1.clone();        obj.field2 = field2;        return obj;      } catch(CloneNotSupportedException e) {        throw new InternalError("Unexpected CloneNotSUpportedException: " + e.getMessage());      }  }[/PRE][/TD][/TR][/TABLE][/LI][/UL][UL][LI]final 类 
绝对不要因为性能的原因将类定义为 final 的（除非程序的框架要求） 
如果一个类还没有准备好被继承，最好在类文档中注明，而不要将她定义为 final 的。这是因为没有人可以保证会不会由于什么原因需要继承她。 [/LI][/UL][UL][LI]访问类的成员变量 
大部分的类成员变量应该定义为 protected 的来防止继承类使用他们。 
注意，要用"int[] packets"，而不是"int packets[]"，后一种永远也不要用。 [TABLE][TR][TD]
[PRE]	public void setPackets(int[] packets) { this.packets = packets; }	  CounterSet(int size)		{		  this.size = size;		}[/PRE][/TD][/TR][/TABLE][/LI][/UL]

[b]编程技巧[/b] 
[UL][LI]byte 数组转换到 characters 
为了将 byte 数组转换到 characters，你可以这么做： 

"Hello world!".getBytes(); 

[/LI][/UL][UL][LI]Utility 类 
Utility 类（仅仅提供方法的类）应该被申明为抽象的来防止被继承或被初始化。 

[/LI][/UL][UL][LI]初始化 
下面的代码是一种很好的初始化数组的方法： 

objectArguments = new Object[] { arguments }; 

[/LI][/UL][UL][LI]枚举类型 
JAVA 对枚举的支持不好，但是下面的代码是一种很有用的模板： [TABLE][TR][TD]
[PRE]class Colour {  public static final Colour BLACK = new Colour(0, 0, 0);  public static final Colour RED = new Colour(0xFF, 0, 0);  public static final Colour GREEN = new Colour(0, 0xFF, 0);  public static final Colour BLUE = new Colour(0, 0, 0xFF);  public static final Colour WHITE = new Colour(0xFF, 0xFF, 0xFF);}[/PRE][/TD][/TR][/TABLE]这种技术实现了RED, GREEN, BLUE 等可以象其他语言的枚举类型一样使用的常量。 他们可以用 '==' 操作符来比较。 
但是这样使用有一个缺陷：如果一个用户用这样的方法来创建颜色 BLACK 

new Colour(0,0,0) 

那么这就是另外一个对象，'=='操作符就会产生错误。她的 equal() 方法仍然有效。由于这个原因，这个技术的缺陷最好注明在文档中，或者只在自己的包中使用。 [/LI][/UL]

[b]Swing[/b] 
[UL][LI]避免使用 AWT 组件 [UL][LI]混合使用 AWT 和 Swing 组件 
如果要将 AWT 组件和 Swing 组件混合起来使用的话，请小心使用。实际上，尽量不要将他们混合起来使用。 

[/LI][/UL][UL][LI]滚动的 AWT 组件 
AWT 组件绝对不要用 JscrollPane 类来实现滚动。滚动 AWT 组件的时候一定要用 AWT ScrollPane 组件来实现。 

[/LI][/UL][UL][LI]避免在 InternalFrame 组件中使用 AWT 组件 
尽量不要这么做，要不然会出现不可预料的后果。 

[/LI][/UL][UL][LI]Z-Order 问题 
AWT 组件总是显示在 Swing 组件之上。当使用包含 AWT 组件的 POP-UP 菜单的时候要小心，尽量不要这样使用。 

[/LI][/UL][/LI][/UL]

[b]调试[/b] 
[UL][LI]调试在软件开发中是一个很重要的部分，存在软件生命周期的各个部分中。调试能够用配置开、关是最基本的。 

很常用的一种调试方法就是用一个 PrintStream 类成员，在没有定义调试流的时候就为 null，类要定义一个 debug 方法来设置调试用的流。 

[/LI][/UL]

[b]性能[/b] 
[UL][LI]在写代码的时候，从头至尾都应该考虑性能问题。这不是说时间都应该浪费在优化代码上，而是我们时刻应该提醒自己要注意代码的效率。比如：如果没有时间来实现一个高效的算法，那么我们应该在文档中记录下来，以便在以后有空的时候再来实现她。 

不是所有的人都同意在写代码的时候应该优化性能这个观点的，他们认为性能优化的问题应该在项目的后期再去考虑，也就是在程序的轮廓已经实现了以后。 [/LI][/UL][UL][LI]不必要的对象构造 [UL][LI]不要在循环中构造和释放对象 

[/LI][/UL][UL][LI]使用 StringBuffer 对象 
在处理 String 的时候要尽量使用 StringBuffer 类，StringBuffer 类是构成 String 类的基础。String 类将 StringBuffer 类封装了起来，（以花费更多时间为代价）为开发人员提供了一个安全的接口。当我们在构造字符串的时候，我们应该用 StringBuffer 来实现大部分的工作，当工作完成后将 StringBuffer 对象再转换为需要的 String 对象。比如：如果有一个字符串必须不断地在其后添加许多字符来完成构造，那么我们应该使用 StringBuffer 对象和她的 append() 方法。如果我们用 String 对象代替 StringBuffer 对象的话，会花费许多不必要的创建和释放对象的 CPU 时间。 
[/LI][/UL][/LI][/UL][UL][LI]避免太多的使用 synchronized 关键字 
避免不必要的使用关键字 synchronized，应该在必要的时候再使用她，这是一个避免死锁的好方法。 [/LI][/UL]

[b]可移植性[/b] 
Borland Jbulider 不喜欢 synchronized 这个关键字，如果你的断点设在这些关键字的作用域内的话，调试的时候你会发现的断点会到处乱跳，让你不知所措。除非必须，尽量不要使用。 
[UL][LI]换行 
如果需要换行的话，尽量用 println 来代替在字符串中使用"\n"。 
你不要这样： 

System.out.print("Hello,world!\n"); 

要这样： 

System.out.println("Hello,world!"); 

或者你构造一个带换行符的字符串，至少要象这样： 

String newline = System.getProperty("line.separator"); 
System.out.println("Hello world" + newline); 

[/LI][/UL][UL][LI]PrintStream 
PrintStream 已经被不赞成（deprecated）使用，用 PrintWrite 来代替她。 [/LI][/UL]

[b]参考资料[/b][UL][LI]查找有关 Thread 类和 [url href=http://java.sun.com/products/jdk/1.2/docs/api/index.html]Java 2 平台，标准版，API 规范[/url]的其他方面的信息。 [/LI][/UL]