`
iamxi
  • 浏览: 192221 次
  • 性别: Icon_minigender_1
  • 来自: 杭州
社区版块
存档分类
最新评论

Java异常处理之违背优秀编码规范的常见坏习惯

    博客分类:
  • Java
阅读更多
你觉得自己是一个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());
        }
    }
}


  本文的结论不是放之四海皆准的教条,有时常识和经验才是最好的老师。如果你对自己的做法没有百分之百的信心,务必加上详细、全面的注释。

  另一方面,不要笑话这些错误,不妨问问你自己是否真地彻底摆脱了这些坏习惯。即使最有经验的程序员偶尔也会误入歧途,原因很简单,因为它们确确实实带来了“方便”。所有这些反例都可以看作Java编程世界的恶魔,它们美丽动人,无孔不入,时刻诱惑着你。也许有人会认为这些都属于鸡皮蒜毛的小事,不足挂齿,但请记住:勿以恶小而为之,勿以善小而不为。
分享到:
评论

相关推荐

    腾讯java编码规范

    腾讯 Java 编码规范 腾讯 Java 编码规范是腾讯集团管理标准的一部分,旨在确保公司项目代码的易维护性和编码安全性。该规范涵盖了 Java 编码风格、文件组织、代码风格、注释、命名、声明、异常、习惯等方面。 一、...

    编码规范 华为编码规范 JAVA 华为编码规范 JAVA

    《华为编码规范JAVA详解》 编码规范是软件开发中至关重要的一环,尤其对于大型企业如华为,一套统一、严谨的编码规范能确保代码的质量、可读性和可维护性。华为编码规范JAVA是华为公司为Java开发者制定的一套详细且...

    JAVA开发手册与安全编码规范.zip

    Java开发手册以 Java 开发者为中心视角,划分为编程规约、异常日志、单元测试、安全规约、MySQL 数据库、工程结构、设计规约七个维度进行...Java安全编码规范明确安全编码的基本原则,常见漏洞对应的安全编码方法等。

    Java编码规范(中文版)

    【Java编码规范(中文版)】是一份关于Java编程实践中应当遵循的规范和准则的文档,旨在提升代码质量,提高可读性和可维护性。以下是对这份规范的详细解释: 1. **一般规则** - **保持一致的风格**:在修改已有代码...

    Java开发手册编码规范.docx

    异常处理是Java开发手册编码规范的重要组成部分,涵盖了异常处理的基本规约。在Java中,异常通常使用try-catch语句来捕捉和处理。异常处理通常使用自定义异常类来封装异常信息。 (二) 日志规约 日志规约是Java开发...

    Java编码规范

    为使开发项目中所有的JAVA程序代码的风格保持一致,增加代码的可读性,便于维护及内部交流,使JAVA程序开发人员养成良好的编码习惯,有必要对JAVA程序的代码编码风格做统一的规范约束。本文档定义了我公司软件开发...

    华为java安全编码规范考试3.1.md

    华为java安全编码规范考试3.1 血与泪整理除的答案,当前时间保证是最新的,基本所有题都能找到。有几题答案没写出来,但是写了所有的错误答案…………排除法

    阿里巴巴编码规范(Java)满分答卷.docx

    阿里巴巴编码规范(Java)满分答卷是对Java开发手册的总结,涵盖了Java开发中的多个方面,包括单元测试、并发处理、分页查询、水平权限控制、数据库中NULL的处理、接口使用抛异常还是返回错误码、类的序列化、Java的...

    JAVA 编码规范

    1命名规则 3 1.1 共性规则 3 1.2 应用程序命名规则 4 1.3 Java命名规则 4 1.4 子系统命名规范 5 1.5 层次命名规范 6 1.6 JNDI命名规则 6 1.7 主机名命名规则 7 ...5异常处理规范 16 6附录1 17 7附录2: Java编程参考 17

    Java编码规范及实践

    《Java编码规范及实践》是一本深入探讨Java编程标准与最佳实践的资源,旨在提高代码质量和可维护性。本文将围绕这个主题,结合提供的博客链接和相关材料,详细阐述Java编码规范的重要性和实践方法。 首先,Java编码...

    华为JAVA编程规范、编程军规

    4. **错误处理**:《JAVA十大低级错误.doc》中可能涵盖了一些常见的编程错误,如空指针异常、数组越界、类型转换异常等。华为规范强调应正确使用异常处理机制,避免使用空catch块。 5. **资源管理**:对于数据库...

    Android Studio 阿里java代码规范化插件与开发手册、android开发手册

    阿里巴巴的Java开发规范是一份权威的代码编写指南,涵盖了命名规则、注释规范、类和对象设计、异常处理、多线程编程等多个方面。遵循这份规范,开发者可以写出更清晰、更一致的Java代码,降低代码的出错率,并减少...

    阿里巴巴编码规范基础技能认证考题分析(考题答案).rar

    阿里巴巴Java编码规范基础技能认证考题分析(考题答案) “阿里巴巴编码规范”是阿里云大学基于《阿里巴巴Java开发手册》打造的认证,用于考察以及让开发者自查对规范的掌握程度。《阿里巴巴Java开发手册》是阿里内部...

    java检查邮政编码的class

    java用于检查某些国家邮政编码的class

    java编码总结1

    【标题】:“Java编码总结1”揭示了关于Java编程中的编码规范、常见问题以及最佳实践。这个主题旨在帮助开发者理解如何在Java项目中正确处理字符编码,以避免常见的乱码问题,提高代码质量和可读性。 【描述】:这...

    java错误处理:java.lang.OutOfMemoryError: Java heap space

    其中,“java.lang.OutOfMemoryError: Java heap space”是一种常见的异常情况,它表明Java虚拟机(JVM)的堆内存空间已耗尽。 #### 标题和描述中的知识点详解 **标题:“java错误处理:java.lang.OutOfMemoryError:...

    java工程师优秀简历

    - 强调你的编程能力,如面向对象设计、多线程、并发处理、异常处理等。 3. **项目经验**: - 描述你参与过的项目,尤其是那些使用Java技术的项目。 - 说明你在项目中的角色,比如系统分析员、开发者或团队负责人...

    阿里巴巴JAVA开发规范word和pdf去水印高清版

    1. **基本编码规范**:这部分涵盖了变量命名、注释规则、空格与换行、代码缩进等基础编码约定。例如,建议使用驼峰命名法为变量命名,注释应清晰易懂,代码行宽控制在一定范围内,以提高代码的可读性。 2. **异常...

    java代码规范

    在Java编码规范中,一般规则是基础,包括但不限于代码结构、异常处理、错误检查等方面。比如,避免使用魔法数字(即硬编码的数值),而应将其定义为常量;合理使用异常处理机制,避免滥用checked exceptions;以及...

Global site tag (gtag.js) - Google Analytics