java1.txt

一些java方面的编程规范,初学java的人可以多看看

ccsdba专栏狗子他爹的技术专栏
  CSDNBlog  |  我的首页  |  联系作者  |  聚合    |  搜索  |  登录  		  6篇原创:: 0篇翻译:: 19篇转载:: 5958次点击:: 19个评论:: 2个Trackbacks 

公告
对 软件架构|项目管理|ORACLE|JAVA|AJAX 相关领域有所感悟。所谓达则兼善天下，甘愿将仅有的一点微薄的经验与大家分享。欢迎同道中人来此交流、探讨。  
文章
·	AJAX(RSS) 
·	Base.java(RSS) 
·	IT传奇(RSS) 
·	JDBC.java(RSS) 
·	OpenSource.java(RSS) 
·	Oracle(RSS) 
·	PM(RSS) 
·	谋事在人(RSS)
收藏
相册
类聚
·	Buffalo - Home 
·	gmtsao@sina 
·	SenTom
其它
推荐
·	BEA dev2dev Online(RSS) 
·	IBM developerWorks 中国 
·	JAVA 开源大全 
·	Oracle Technology Network(RSS)
存档
·	2006年06月(12) 
·	2006年05月(13)
最近评论
·	ccsdba：由于IT的发展是从欧美开始的，他们自然成为主流，这是不得不承认的。因此，搞IT要领先于国内同仁，必须要学好英语。这是一门基础，一条通往IT的关键路径。但如果把大多数时间都放在学习英语上了。我感觉有点误入歧途，舍本逐末了。我以前是过分的忽略了，现在不幸成了反面教材。借此提醒那些对IT事业情有独钟又想有所建树的人不要重蹈覆辙。 
·	flyback：你可能错了,我们学习英语的出发点是好的,但是错的是没有用上,如果你看到某省专门为老外开的工业园里,受采访的老外一口流利的汉语的时候,我想你会感到背部发凉 
·	song6295：大学很多时间都学英语了 
·	talentluo：大哥，请改掉斜体字，看的好累呀！ 
文章还是蛮不错的！ 
支持你！ 
快出其它的规则吧！ 
急切等待中！！ 
·	[e-mail]：如果这篇文章是原创的话，那么这位朋友一定看过很多Java语言方面的书，基础很好。



   编写高效的JAVA程序－－编程规范  
基本篇 
 

本文介绍的JAVA规则的说明分为5个级别，级别1是最基本也是最重要的级别，在今后将陆续写出其他的规则。遵守了这些规则可以提高程序的效率、使代码有更好的可读性等。 
 
（1） 避免使用NEW关键字来创建String对象。
把一个String常量copy到String 对象中通常是多余、浪费时间的
Public class test{
Public void method(){
System.out.print (str);
}
private String str = new String ("1"); //这里新建对象是完全没有必要的
private String str2=”2” //正确的应该如此
}
参考：Joshua Bloch: "Effective Java - Programming Language Guide"

（2） 避免使用不必要的嵌套。
过多的嵌套会使你的代码复杂化，减弱可读性。
Public class test {
String add (){
Int c=(a=a+b)+b; //过于复杂
Return c
}
}
参考：http://java.sun.com/docs/codeconv/html/CodeConventions.doc9.html#177
（3） 避免在同一行声明不同类型的多个变量
这样可以使程序更加清晰，避免混乱
private int index, index1[];
正确的应该如此：
private int index; 
private int index1[];

参考：http://java.sun.com/docs/codeconv/html/CodeConventions.doc5.html#2992
(4) 在每一行里写一条语句
这条规则不包括for语句：比如：'for (int i = 0; i < 10; i++) x--;’可以增加代码的可读性。
public class OSPL {
int method (int a, int b) {
int i = a + b; return i; // 可读性不强
}
正确的：
public class OSPLFixed {
int method (int a, int b) {
int i = a + b; 
return i; 
}
}
参考：Section 7.1 of http://java.sun.com/docs/codeconv/html/CodeConventions.doc6.html#431

（5）经常从finalize ()中调用super.finalize ()
这里的finalize ()是java在进行垃圾收集的时候调用的，和finally不一样。如果你的父类没有定义finally（）的话，你也应该调用。这里有两个原因：（1）在不改变代码的情况下能够将父类的finally方法加到你的类中。 （2）以后你会养成习惯调用父类的finally方法，即使父类没有定义finally方法的时候。
正确的方法应该如此：
public class parentFinalize {
protected void finalize () throws Throwable {
super.finalize(); // FIXED 
}
参考："The Java Programming Language" by Ken Arnold and James Gosling, page 49.
（6） 不要在finalize ()中注销listeners
不要再finalize ()方法中中注销listeners，finalize ()只有再没有对象引用的时候调用，如果listeners从finalize()方法中去除了，被finalize的对象将不会在垃圾收集中去除。
public void finalize () throws Throwable {
bButton.removeActionListener (act); 
}
(7) 不要显式的调用finalize ()方法
虽然显式的调用这个方法可以使你确保你的调用，但是当这个方法收集了以后垃圾收集会再收集一次。
public class T7 { public void finalize() throws Throwable { close_resources (); super.finalize (); } public void close_resources() {}}class Test { void cleanup () throws Throwable { t71.finalize(); // 调用 t71 = null; } private t71 = new T7 ();}
对于这样的调用我们应该自己创建一个释放的方法，做最初finalize ()所作的事情，当你每次想显式的调用finalize ()的时候实际上调用了释放方法。然后再使用一个判断字段来确保这个方法只执行一次，以后再调用就没关系了。
public class T7 { public synchronized void release () throws Throwable{ if (!_released) { close_resources (); // do what the old 'finalize ()' did _released = true; } } public void finalize () throws Throwable { release (); super.finalize (); } public void close_resources() {} private boolean _released = false;}class TestFixed { void closeTest () throws Throwable { t71 .release (); // FIXED t71 = null; } private T7 t71 = new T7 ();}

参考：Nigel Warren, Philip Bishop: "Java in Practice - Design Styles and Idioms
for Effective Java". Addison-Wesley, 1999. pp.110-111

(8)不要使用不推荐的API
尽量使用JDK1.3推荐的API。在类和方法或者java组件里有很多方法是陈旧的或者是可以选择的。有一些方法SUN用了"deprecated“标记。最好不要使用例如：
private List t_list = new List ();
t_list.addItem (str); 
如果查一下javadoc的话，会发现建议用add()来代替addItem()。
参考：http://java.sun.com/j2se/1.3/docs/api/index.html
（9）为所有序列化的类创建一个'serialVersionUID'
可以避免从你各种不同的类破坏序列的兼容性。如果你不特别制订一个UID的话，那么系统为自动产生一个UID（根据类的内容）。如果UID在你新版本的类中改变了，即使那个被序列化的类没改变，你也不能反序列化老的版本了。
public class DUID implements java.io.Serializable { public void method () {}}
在里面加一个UID，当这个类的序列化形式改变的时候，你也改变这个UID就可以了。
public class DUIDFixed implements java.io.Serializable { public void method () {} private static final long serialVersionUID = 1; }

参考：Joshua Bloch: "Effective Java - Programming Language Guide"
Addison Wesley, 2001, pp. 223
（10）对于private常量的定义
比较好的做法是对于这样的常量，加上final标记，这样的常量从初始化到最后结束值都不会改变。
private int size = 5; 
改变后的做法是：
private final int size = 5; 
(11)避免把方法本地变量和参数定义成和类变量相同的名字。
这样容易引起混扰，建议把任何的变量字都定义成唯一的。这样看来，SCJP里的那些题目在现实中就用不到了：）
public void method (int j) { final int i = 5; // VIOLATION } private int j = 2;
建议：
public void method (int j1) { final int i = 5; // VIOLATION } private int j = 2;
中级篇
 

本文介绍的JAVA规则的说明分为3个主要级别，中级是平时开发用的比较多的级别，在今后将陆续写出其他的规则。遵守了这些规则可以提高程序的效率、使代码又更好的可读性等。
（1） 在finally方法里关掉input或者output 资源
再方法体里面定义了input或者output流的话，需要在finally里面把它关掉。
以下这几种调用不需要遵守这条规则，因为colse()方法不起作用：）
java.io.StringWriter java.io.ByteArrayOutputStream java.io.ByteArrayInputStream
如果再方法返回的时候没有调用close()方法来释放input()和output()的资源的话，会导致一个系统资源泄漏。而且在任何情况下都要确定在返回全调用了close() 方法，包括出现异常的时候。所以需要在finally方法里面加入这个方法。这样就保证了在任何情况下都会关闭资源。
错误示例：
public class CIO {
public void method (java.io.File f) {
java.io.FileInputStream fis = null;
try {
fis = new java.io.FileInputStream (f);
fis.read ();
fis.close ();
} catch (java.io.FileNotFoundException e1) {
System.out.println("File not found");
} catch (java.io.IOException e2) {
System.out.println("I/O Exception");
}
// 如果出现异常，这里就不能保证关闭资源。
}
}
修正后的代码：
public class CIOFixed {
public void method (java.io.File f) {
java.io.FileInputStream fis = null;
try {
fis = new java.io.FileInputStream (f);
fis.read ();
} catch (java.io.FileNotFoundException e1) {
System.out.println("File not found");
} catch (java.io.IOException e2) {
System.out.println("I/O Exception");
} finally {
if (fis != null) {
try {
fis.close (); 
} catch (java.io.IOException e) { 
System.out.println("I/O Exception");
}
}
}
}
} 
 
（2） else的注意问题.
一般总认为如果if语句只有一句的话，那么{}就是可要可不要的了。可是如果if有else嵌套的话，就不一样了，{}是必需的
错误示例：
if (i < 5) 
if (i < 2)
i++;
else
i--;
修改后：
if (i < 5) { 
if (i < 2)
i++;
}
else {
i--;
}
（3） 不要再catch()块里什么代码也不放
在catch()块里面放入一些错误处理代码是一个好的习惯。但是如果catch()里面有有关javadoc 的代码，那也是可以的。
错误示例：
try {
System.in.read ();
} catch (java.io.IOException e) {
// 错误
}
正确：
try {
System.in.read ();
} catch (java.io.IOException e) {
System.out.println("Descriptive error"); 
}
参考：Joshua Bloch: "Effective Java - Programming Language Guide".
Addison-Wesley, 2001, pp. 187
（4） 不要在if条件里面附值
如果这样做的话，系统会报告错误。在java的很多条件声明里面用附值是很不明智的，而且系统也会报告错误。很容易引起异常。遵守这条规者能够使维护简单，避免不一致。
错误示例：
if (b = true)
正确的：
if (b == true)
参考：Section 10.4 of http://java.sun.com/docs/codeconv/html/CodeConventions.doc9.html#547
(5) for语句需要循环体。 
如果没有{}的话,for语句只会执行一次！
错误示例：
for (i = 0; i < 10; i++) ; 
System.out.println (i);
这里print() 只会执行一次。
正确：
for (i = 0; i < 10; i++) { // FIXED
System.out.println (i); 
}
（5） 不要把方法定义成main().
在java里，main()方法是一个特别的方法。所以在自己定义方法的时候不要定义这样的名字，以免引起混扰。
(6)不要直接或者间接的定义'Error'和'Throwable'的子类
'java.lang.Error'只在JVM出现反常的时候覆盖这个方法，如果你定义了直接或者不直接的类继承了类'Error'，也就指出了这个错误是JVM内部的，而不是这个类的。所以对于java编译器来说是不可见的，这样就不能检查错误的异常处理了。
'java.lang.Throwable'是'java.lang.Exception'和'java.lang.Error'的上级类，用户如果象定义异常类的话应该继承'java.lang.Exception'。
错误示例：public class ABC extends Error
正确：public class ABC extends Exception
(7)有关"switch"语句里面的"case"问题
最好在每一个 “case”里都定义一个”return”或者“break”来控制不要走到下面的 “case”里去。如果一个”case”语句在代码的最后没有一个”break”或者”return”句，程序就会走到下一个”case”。如果这个”case”是最后一个的话，那就没什么问题，如果后面还有”case” 的话，看起来就不太安全了。
错误示例：
switch (i) {
case 1:
x = 10;
break;
case 2: 
x = 20;
default:
a = 40;
break;
正确：