Big Bug Ban

兴趣 践行 创新

Archive for the ‘borrow’ Category

转载的内容~

六种JAVA异常处理的陋习

 

在JAVA异常处理中,经常会遇到一些问题,下面这个代码里面有六个问题

OutputStreamWriter out = ...
java.sql.Connection conn = ...
 try { // ⑸
  Statement stat = conn.createStatement();
  ResultSet rs = stat.executeQuery(
   "select uid, name from user");
  while (rs.next())
  {
   out.println("ID:" + rs.getString("uid") // ⑹
    ",姓名:" + rs.getString("name"));
  }
  conn.close(); // ⑶
  out.close();
  }
 catch(Exception ex) // ⑵
 {
  ex.printStackTrace(); //⑴,⑷
    }

作为一个Java程序员,你至少应该能够找出两个问题。但是,假如你不能找出全部六个问题,请继承阅读本文。

本文讨论的不是Java异常处理的一般性原则,由于这些原则已经被大多数人熟知。我们要做的是分析各种可称为“反例”(anti-pattern)的违反优秀编码规范的常见坏习惯,匡助读者认识这些典型的反面例子,从而能够在实际工作中敏锐地察觉和避免这些题目。

反例之一:丢弃异常

代码:15行-18行。

这段代码捕捉了异常却不作任何处理,可以算得上Java编程中的杀手。从题目泛起的频繁程度和祸害程度来看,它也许可以和C/C++程序的一个恶名远播的题目相提并论??不检查缓冲区是否已满。假如你看到了这种丢弃(而不是抛出)异常的情况,可以百分之九十九地肯定代码存在题目(在极少数情况下,这段代码有存在的理由,但最好加上完整的注释,以免引起别人曲解)。

这段代码的错误在于,异常(几乎)老是意味着某些事情分歧错误劲了,或者说至少发生了某些不平常的事情,我们不应该对程序发出的求救信号保持沉默沉静和无动于衷。调用一下printStackTrace算不上“处理异常”。不错,调用printStackTrace对调试程序有匡助,但程序调试阶段结束之后,printStackTrace就不应再在异常处理模块中担负主要责任了。

丢弃异常的情形非常普遍。打开JDK的ThreadDeath类的文档,可以看到下面这段说明:“特别地,固然泛起ThreadDeath是一种‘正常的情形’,但ThreadDeath类是Error而不是Exception的子类,由于很多应用会捕捉所有的Exception然后丢弃它不再理睬。”这段话的意思是,固然ThreadDeath代表的是一种普通的题目,但鉴于很多应用会试图捕捉所有异常然后不予以适当的处理,所以JDK把 ThreadDeath定义成了Error的子类,由于Error类代表的是一般的应用不应该去捕捉的严峻题目。可见,丢弃异常这一坏习惯是如斯常见,它甚至已经影响到了Java本身的设计。

那么,应该怎样改正呢?主要有四个选择:

1、处理异常。针对该异常采取一些步履,例如修正题目、提醒某个人或进行其他一些处理,要根据详细的情形确定应该采取的动作。再次说明,调用printStackTrace算不上已经“处理好了异常”。

2、重新抛出异常。处理异常的代码在分析异常之后,以为自己不能处理它,重新抛出异常也不失为一种选择。

3、把该异常转换成另一种异常。大多数情况下,这是指把一个初级的异常转换成应用级的异常(其含义更轻易被用户了解的异常)。

4、不要捕捉异常。

结论一:既然捕捉了异常,就要对它进行适当的处理。不要捕捉异常之后又把它丢弃,不予理睬。

反例之二:不指定详细的异常

代码:15行。

很多时候人们会被这样一种“美妙的”想法主意吸引:用一个catch语句捕捉所有的异常。最常见的情形就是使用catch(Exception ex)语句。但实际上,在绝大多数情况下,这种做法不值得提倡。为什么呢?

要理解其原因,我们必需回顾一下catch语句的用途。catch语句表示我们预期会泛起某种异常,而且但愿能够处理该异常。异常类的作用就是告诉 Java编译器我们想要处理的是哪一种异常。因为绝大多数异常都直接或间接从java.lang.Exception派生,catch(Exception ex)就相称于说我们想要处理几乎所有的异常。

再来看看前面的代码例子。我们真正想要捕捉的异常是什么呢?最显著的一个是SQLException,这是JDBC操纵中常见的异常。另一个可能的异常是 IOException,由于它要操纵OutputStreamWriter。显然,在统一个catch块中处理这两种截然不同的异常是分歧适的。假如用两个catch块分别捕捉SQLException和IOException就要好多了。这就是说,catch语句应当尽量指定详细的异常类型,而不应该指定涵盖范围太广的Exception类。

另一方面,除了这两个特定的异常,还有其他很多异常也可能泛起。例如,假如因为某种原因,executeQuery返回了null,该怎么办?谜底是让它们继承抛出,即不必捕捉也不必处理。实际上,我们不能也不应该去捕捉可能泛起的所有异常,程序的其他地方还有捕捉异常的机会??直至最后由JVM处理。

结论二:在catch语句中尽可能指定详细的异常类型,必要时使用多个catch。不要试图处理所有可能泛起的异常。

反例之三:占用资源不开释

代码:3行-14行。

异常改变了程序正常的执行流程。这个道理固然简朴,却经常被人们忽视。假如程序用到了文件、Socket、JDBC连接之类的资源,即使碰到了异常,也要准确开释占用的资源。为此,Java提供了一个简化这类操纵的枢纽词finally。

finally是样好东西:无论是否泛起了异常,Finally保证在try/catch/finally块结束之前,执行清理任务的代码老是有机会执行。遗憾的是有些人却不习惯使用finally。

当然,编写finally块应当多加小心,特别是要留意在finally块之内抛出的异常??这是执行清理任务的最后机会,尽量不要再有难以处理的错误。

结论三:保证所有资源都被准确开释。充分运用finally枢纽词。

反例之四:不说明异常的具体信息

代码:3行-18行。

仔细观察这段代码:假如轮回内部泛起了异常,会发生什么事情?我们可以得到足够的信息判定轮回内部犯错的原因吗?不能。我们只能知道当前正在处理的类发生了某种错误,但却不能获得任何信息判定导致当前错误的原因。

printStackTrace的堆栈跟踪功能显示出程序运行到当前类的执行流程,但只提供了一些最基本的信息,未能说明实际导致错误的原因,同时也不易解读。

因此,在泛起异常时,最好能够提供一些文字信息,例如当前正在执行的类、方法和其他状态信息,包括以一种更适合阅读的方式收拾整顿和组织printStackTrace提供的信息。

结论四:在异常处理模块中提供适量的错误原因信息,组织错误信息使其易于理解和阅读。

反例之五:过于庞大的try块

代码:3行-14行。

常常可以看到有人把大量的代码放入单个try块,实际上这不是好习惯。这种现象之所以常见,原因就在于有些人图省事,不愿花时间分析一大块代码中哪几行代码会抛出异常、异常的详细类型是什么。把大量的语句装入单个巨大的try块就象是出门旅游时把所有日常用品塞入一个大箱子,固然东西是带上了,但要找出来可不轻易。

一些新手经常把大量的代码放入单个try块,然后再在catch语句中声明Exception,而不是分离各个可能泛起异常的段落并分别捕捉其异常。这种做法为分析程序抛出异常的原因带来了难题,由于一大段代码中有太多的地方可能抛出Exception。

结论五:尽量减小try块的体积。

反例之六:输出数据不完整

代码:7行-11行。

不完整的数据是Java程序的隐形杀手。仔细观察这段代码,考虑一下假如轮回的中间抛出了异常,会发生什么事情。轮回的执行当然是要被打断的,其次,catch块会执行??就这些,再也没有其他动作了。已经输出的数据怎么办?使用这些数据的人或设备将收到一份不完整的(因而也是错误的)数据,却得不到任何有关这份数据是否完整的提示。对于有些系统来说,数据不完整可能比系统休止运行带来更大的损失。

较为理想的处置办法是向输出设备写一些信息,声明数据的不完整性;另一种可能有效的办法是,先缓冲要输出的数据,预备好全部数据之后再一次性输出。

结论六:全面考虑可能泛起的异常以及这些异常对执行流程的影响。

改写后的代码

根据上面的讨论,下面给出改写后的代码。也许有人会说它轻微有点啰嗦,但是它有了比较完备的异常处理机制。

OutputStreamWriter out = ...
java.sql.Connection conn = ...
try {
 Statement stat = conn.createStatement();
 ResultSet rs = stat.executeQuery(
  "select uid, name from user");
 while (rs.next())
 {
  out.println("ID:" + rs.getString("uid") + ",姓名: " + rs.getString("name"));
 }
}
catch(SQLException sqlex)
{
 out.println("警告:数据不完整");
 throw new ApplicationException("读取数据时出现SQL错误", sqlex);
}
catch(IOException ioex)
{
 throw new ApplicationException("写入数据时出现IO错误", ioex);
}
finally
{
 if (conn != null) {
  try {
   conn.close();
  }
  catch(SQLException sqlex2)
  {
   System.err(this.getClass().getName() + ".mymethod - 不能关闭数据库连接: " + sqlex2.toString());
  }
 }

 if (out != null) {
  try {
   out.close();
  }
  catch(IOException ioex2)
  {
   System.err(this.getClass().getName() + ".mymethod - 不能关闭输出文件" + ioex2.toString());
  }
 }
}

Written by princehaku

12月 25th, 2010 at 3:22 下午