��p��先生 — Thu, 05 Apr 2007 01:40:00 GMT

[原文]http://www.ibm.com/developerworks/cn/java/j-cq01307/index.html

开发�h员测试的主要�~�点是：�l�大部分��试都是在理想的场景中进行的。在�q�些情况下�ƈ不会出现�~�陷 —�?能导致出现问题的往往是那些边界情��c�?/p>

什么是边界情况呢？比方��_��?null ��g��入一个�ƈ未编写如何处�?null 值的�Ҏ(gu��)��中，�q�就是一�U�边界情��c��大多数开发�h员通常都不能成功测试这��L��场景�Q�因��没多大意义。但不管有没有意义，发生了这��L��情况�Q�就会抛��Z��?NullPointerException�Q�然后整个程序就会崩溃�?/p>

本月�Q�我��ؓ�(zh��n)�推荐一�U�多层面的方法，来处理代码中那些不易预料的缺陗��尝试�ؓ应用�E�序整合�q�防御性编�E�、契�U�式设计和一�U�叫�?OVal 的易用的通用验证框架�?/p>

��敌人暴露出�?/a>

清单 1 中的代码为给定的 Class 对象�Q�省��M�� java.lang.Object�Q�因为所有对象都最�l�由它扩展）构徏一个类层次。但如果仔细看的话，�(zh��n)�会注意��C��个有待发现的潜在�~�陷�Q�即该方法对对象值所做的假设�?/p>
清单 1. 不检�?null 的方�?/a>

            public static Hierarchy buildHierarchy(Class clzz){
            Hierarchy hier = new Hierarchy();
            hier.setBaseClass(clzz);
            Class superclass = clzz.getSuperclass();
            if(superclass != null && superclass.getName().equals("java.lang.Object")){
            return hier;
            }else{
            while((clzz.getSuperclass() != null) &&
            (!clzz.getSuperclass().getName().equals("java.lang.Object"))){
            clzz = clzz.getSuperclass();
            hier.addClass(clzz);
            }
            return hier;
            }
            }

刚编好这个方法，我还没注意到�q�个�~�陷�Q�但�׃��我狂热地崇拜开发�h员测试，于是我编写了一个��?TestNG 的常规测试。而且�Q�我�q�利用了 TestNG 方便�?DataProvider �Ҏ(gu��)��，借助该特性，我创��Z��一个通用的测试用例�ƈ通过另一个方法来改变它的参数。运行清�?2 中定义的��试用例会��生两个通过�l�果�Q�一切都�q��{良好�Q�不是吗�Q?/p>
清单 2. 验证两个值的 TestNG ��试

            import java.util.Vector;
            import static org.testng.Assert.assertEquals;
            import org.testng.annotations.DataProvider;
            import org.testng.annotations.Test;
            public class BuildHierarchyTest {
            @DataProvider(name = "class-hierarchies")
            public Object[][] dataValues(){
            return new Object[][]{
            {Vector.class, new String[] {"java.util.AbstractList",
            "java.util.AbstractCollection"}},
            {String.class, new String[] {}}
            };
            }
            @Test(dataProvider = "class-hierarchies"})
            public void verifyHierarchies(Class clzz, String[] names) throws Exception{
            Hierarchy hier = HierarchyBuilder.buildHierarchy(clzz);
            assertEquals(hier.getHierarchyClassNames(), names, "values were not equal");
            }
            }

��x��Q�我�q�是没有发现�~�陷�Q�但一些代码问题却困扰着我。如果有��Z��l�意��Cؓ Class 参数传入一�?null ��g��怎么样呢�Q?a >清单 1 中第 4 行的 clzz.getSuperclass() 调用会抛��Z��?NullPointerException�Q�是�q�样吗？

��试我的理论很容易；甚至都不用从头开始。仅仅把 {null, null} ��d��到初�?BuildHierarchyTest �?dataValues �Ҏ(gu��)��中的多维 Object 数组中，然后再次�q�行它。我定会得到如图 1 所�C�的 NullPointerException�Q?/p>
�?1. 可怕的 NullPointerException

参见�q�里�?全图�?/p>

关于静态分�?/a>

诸如 FindBugs �{�静态分析工具通过��字节码和一�p�d�� bug 模式相匹配来��验类�?JAR 文�g从而寻找潜在问题。针�Ҏ(gu��)��例的代码�q�行 FindBugs 不会揭示出清�?1 中找到的 NullPointerException�?/p>

防�M性编�E?/a>

一旦出现这个问题，下一步就是要拿出�Ҏ(gu��)��的策略。问题是我控制不了这个方法能否接收这�U�输入。对于这�c�问题，开发�h员通常会��用防御性编�E�技术，该技术专门用来在发生摧毁性后果前捕捉潜在错误�?/p>

对象验证是处理不��定性的一��经典的防�M性编�E�策略。相应地�Q�我会添加一��Ҏ(gu��)��验来验证 clzz 是否�?null�Q�如清单 3 所�C�。如果其值最�l��ؓ null�Q�我��׃��抛出一�?RuntimeException 来警告他人注意这个潜在问题�?/p>
清单 3. ��d��验证 null 值的��?

            public static Hierarchy buildHierarchy(Class clzz){
            if(clzz == null){
            throw new RuntimeException("Class parameter can not be null");
            }
            Hierarchy hier = new Hierarchy();
            hier.setBaseClass(clzz);
            Class superclass = clzz.getSuperclass();
            if(superclass != null && superclass.getName().equals("java.lang.Object")){
            return hier;
            }else{
            while((clzz.getSuperclass() != null) &&
            (!clzz.getSuperclass().getName().equals("java.lang.Object"))){
            clzz = clzz.getSuperclass();
            hier.addClass(clzz);
            }
            return hier;
            }
            }

很自�Ӟ��我也会编写一个快速测试用例来验证我的��验是否真能避�?NullPointerException�Q�如清单 4 所�C�：

清单 4. 验证 null ��?/a>

            @Test(expectedExceptions={RuntimeException.class})
            public void verifyHierarchyNull() throws Exception{
            Class clzz = null;
            HierarchyBuilder.buildHierarchy(null);
            }

在本例中�Q�防御性编�E�似乎解决了问题。但仅依靠这��策略会存在一些缺陗��?

防�M的缺�?/a>

关于断言

清单 3 使用一个条件来验证 clzz 的��|��实际�?assert 也同样好用。��用断�a��Q�无需指定条�g�Q�也不需要指定异常语句。在启用了断�a�的情况下�Q�防御性编�E�的��x��点全部由 JVM 处理�?/p>

��管防�M性编�E�有效地保证了方法的输入条�g�Q�但如果在一�p�d��Ҏ(gu��)��中��用它�Q�不免过于重复。熟�(zh��n)�面向方面编�E�（�?AOP�Q�的��Z��会把它认为是横切��x��点，�q�意味着防�M性编�E�技术横跨了代码库。许多不同的对象都采用这些语法，��管从纯面向对象的观�Ҏ(gu��)��看这些语法跟对象毫不相关�?/p>

而且�Q�横切关注点开始渗入到契约式设计（DBC�Q�的概念中。DBC 是这样一��Ҏ(gu��)��术，它通过在组件的接口昑ּ�地陈�q�每个组件应有的功能和客��h��的期望值来��保�pȝ��中所有的�l��g完成它们应尽的职责。从 DBC 的角度讲�Q�组件应有的功能被认为是后置条�g�Q�本质上��是�l��g的责任，而客��h��的期望值则普遍被认为是前置条�g。另外，在纯 DBC 术语中，遵��@ DBC 规则的类针对其将�l�护的内部一致性与外部世界有一个契�U�，即�h所��q��的类不变式�?/p>

契约式设�?/a>

我在以前的一��关于用 Nice �~�程的文章中介绍�q?DBC 的概念，Nice 是一门与 JRE 兼容的面向对象编�E�语�a��Q�它的特�Ҏ(gu��)��侧重于模块性、可表达性和安全性。有��的是，Nice �q�入了功能性开发技术，其中包括了一些在面向斚w��~�程中的技术。功能性开发��得�ؓ�Ҏ(gu��)��指定前置条�g和后�|�条件成为可能�?/p>

��管 Nice 支持 DBC�Q�但它与 Java™ 语言完全不同�Q�因而很隑ְ�其用于开发。幸�q�的是，很多针对 Java 语言的库也都�?DBC 提供了方�ѝ��每个库都有其优点和�~�点�Q�每个库�?DBC 内针�?Java 语言�q�行构徏的方法也不同�Q�但最�q�的一些新�Ҏ(gu��)��大都利用了 AOP 来更多地��?DBC ��x��点包括进来，�q�些��x��点基本上��q��当于�Ҏ(gu��)��的包装器�?/p>

前置条�g在包装过的方法执行前��d��Q�后�|�条件在该方法完成后��d��。��?AOP 构徏 DBC �l�构的一个好处（请不要同该语�a�本��n相�؜淆！�Q�是�Q�可以在不需�?DBC ��x��点的环境中将�q�些�l�构��x��Q�就像断�a�能被��x��一��P��。以横切的方式对待安全性关注点的真正妙处是�Q�可以有效地重用 �q�些��x��炏V��众所周知�Q�重用是面向对象�~�程的一个基本原则。AOP 如此完美地补充了 OOP ��N��不是一件极好的事情吗？

�l�合�?OVal �?AOP

OVal 是一个通用的验证框�Ӟ��它通过 AOP 支持��单的 DBC �l�构�q�明��地允许�Q?

为类字段和方法返回值指定约束条�?
为结构参数指定约束条�?
为方法参数指定约束条�?

此外�Q�OVal �q�带来大量预定义的约束条�Ӟ��q�让创徏新条件变得相当容易�?/p>

�׃�� OVal 使用 AspectJ �?AOP 实现来�ؓ DBC 概念定义��Q�所以必��d�� AspectJ �q�入一个��?OVal 的项目中。对于不熟�?zh��n)?AOP �?AspectJ 的�h们来��_��好消息是�q�不隑֮�玎ͼ�且��?OVal �Q�甚��x��创徏新的�U�束条�g�Q��ƈ不需要真正对斚w��q�行�~�码�Q�只需�~�写一个简单的自引导程序即可，该程序会�?OVal 所附带的默认方面植入�?zh��n)�的代码中�?/p>

在创��个自引导�E�序斚w��前，要先下蝲 AspectJ。具体地��_��(zh��n)�需要将 aspectjtools �?aspectjrt JAR 文�g�q�入�(zh��n)�的构徏中来�~�译所需的自引导�E�序斚w��q�将其编入�?zh��n)�的代码中�?/p>

自引�?AOP

下蝲�?AspectJ 后，下一步是创徏一个可扩展 OVal GuardAspect 的方面。它本��n不需要做什么，如清�?5 所�C�。请��保文�g的扩展名�?.aj �l�束�Q�但不要试着用常规的 javac 对其�q�行�~�译�?/p>
清单 5. DefaultGuardAspect 自引导程序方�?/a>

            import net.sf.oval.aspectj.GuardAspect;
            public aspect DefaultGuardAspect extends GuardAspect{
            public DefaultGuardAspect(){
            super();
            }
            }

AspectJ 引入了一�?Ant ��d��Q�称�?iajc�Q�充当着 javac 的角�Ԍ��此过�E�对斚w��q�行�~�译�q�将其编入主体代码中。在本例中，只要是我指定�?OVal �U�束条�g的地方，�?OVal 代码中定义的逻辑��׃��~�入我的代码�Q�进而充当�v前置条�g和后�|�条件�?/p>

误��?iajc 代替�?javac。例如，清单 6 是我�?Ant build.xml 文�g的一个代码片�D�，其中对代码进行了�~�译�q�把通过代码标注发现的所�?OVal 斚w��~�入�q�来�Q�如下所�C�：

清单 6. �?AOP �~�译�?Ant 构徏文�g片段

�?OVal 铺好了�\、�ؓ AOP �q�程做了引导之后�Q�就可以开始��?Java 5 标注来�ؓ代码指定��单的�U�束条�g了�?/p>

OVal 的可重用�U�束条�g

�?OVal 为方法指定前�|�条件必��d��Ҏ(gu��)��参数�q�行标注。相应地�Q�当调用一个用 OVal �U�束条�g标注�q�的�Ҏ(gu��)��Ӟ��OVal 会在该方法真正执行前验证该约束条件�?/p>

在我的例子中�Q�我惌��指定�?Class 参数的��gؓ null �Ӟ��buildHierarchy �Ҏ(gu��)��不能被调用。OVal 通过 @NotNull 标注支持此约束条�Ӟ��该标注在�Ҏ(gu��)��所需的所有参数前指定。也要注意，��M��惌��使用 OVal �U�束条�g的类也必��d��c�d��ơ上指定 @Guarded 标注�Q�就像我在清�?7 中所做的那样�Q?/p>
清单 7. OVal �U�束条�g

            import net.sf.oval.annotations.Guarded;
            import net.sf.oval.constraints.NotNull;
            @Guarded
            public class HierarchyBuilder {
            public static Hierarchy buildHierarchy(@NotNull Class clzz){
            Hierarchy hier = new Hierarchy();
            hier.setBaseClass(clzz);
            Class superclass = clzz.getSuperclass();
            if(superclass != null && superclass.getName().equals("java.lang.Object")){
            return hier;
            }else{
            while((clzz.getSuperclass() != null) &&
            (!clzz.getSuperclass().getName().equals("java.lang.Object"))){
            clzz = clzz.getSuperclass();
            hier.addClass(clzz);
            }
            return hier;
            }
            }
            }

通过标注指定�q�个�U�束条�g意味着我的代码不再会被重复的条件弄得�ؕ七八�p�，�q�些条�g��?null ��|��q�且一旦找到该值就会抛出异常。现在这��w��辑�?OVal 处理�Q�且处理的方法有些相�?—�?事实上，如果�q�反了约束条�Ӟ��OVal 会抛��Z��?ConstraintsViolatedException�Q�它�?RuntimeException 的子�c�R�?

当然�Q�我下一步就要编�?HierarchyBuilder �c�d�� 清单 5 中相应的 DefaultGuardAspect �c�R��我�?清单 6 中的 iajc ��d��来实现这一目的�Q�这��h��p��?OVal 的行为编入我的代码中了�?

接下来，我更�?清单 4 中的��试用例来验证是否抛��Z��一�?ConstraintsViolatedException�Q�如清单 8 所�C�：

清单 8. 验证是否抛出�?ConstraintsViolatedException

            @Test(expectedExceptions={ConstraintsViolatedException.class})
            public void verifyHierarchyNull() throws Exception{
            Class clzz = null;
            HierarchyBuilder.buildHierarchy(clzz);
            }

指定后置条�g

正如�(zh��n)�所见，指定前置条�g其实相当�Ҏ(gu��)��Q�指定后�|�条件的�q�程也是一栗��例如，如果我想�Ҏ(gu��)��有调�?buildHierarchy 的程序保证它不会�q�回 null ��|��q�样�Q�这些调用程序就不需要再��查这个了�Q�，我可以在�Ҏ(gu��)��声明之上攄��一�?@NotNull 标注�Q�如清单 9 所�C�：

清单 9. OVal 中的后置条�g

            @NotNull
            public static Hierarchy buildHierarchy(@NotNull Class clzz){
            //method body
            }

当然�Q?code>@NotNull �l�不�?OVal 提供的惟一�U�束条�g�Q�但我发现它能非常有效地限制�q�些令�h讨厌�?NullPointerException�Q�或臛_��能够快速地暴露它们�?/p>

更多�?OVal �U�束条�g

OVal 也支持在�Ҏ(gu��)��调用前或后对�c�L��员进行预先验证。这�U�机制具有限刉��对特定约束条件的重复条�g��试的好处，如集合大��或之前讨论�q�的�?null 的情��c�?/p>

例如�Q�在清单 10 中，我��?HierarchyBuilder 定义了一个�ؓ�c�d��ơ构建报告的 Ant ��d��。请注意 execute() �Ҏ(gu��)��是如何调�?validate 的，后者会依次验证 fileSet �c�L��员是否含��|��如果不含�Q�会抛出一个异常，因�ؓ没有了要评估的类�Q�该报告不能�q�行�?/p>
清单 10. 带条件检验的 HierarchyBuilderTask

            public class HierarchyBuilderTask extends Task {
            private Report report;
            private List fileSet;
            private void validate() throws BuildException{
            if(!(this.fileSet.size() > 0)){
            throw new BuildException("must supply classes to evaluate");
            }
            if(this.report == null){
            this.log("no report defined, printing XML to System.out");
            }
            }
            public void execute() throws BuildException {
            validate();
            String[] classes = this.getQualifiedClassNames(this.fileSet);
            Hierarchy[] hclz = new Hierarchy[classes.length];
            try{
            for(int x = 0; x < classes.length; x++){
            hclz[x] = HierarchyBuilder.buildHierarchy(classes[x]);
            }
            BatchHierarchyXMLReport xmler = new BatchHierarchyXMLReport(new Date(), hclz);
            this.handleReportCreation(xmler);
            }catch(ClassNotFoundException e){
            throw new BuildException("Unable to load class check classpath! " + e.getMessage());
            }
            }
            //more methods below....
            }

因�ؓ我用的是 OVal�Q�所以我可以完成下列��d��Q?/p>

�?fileSet �c�L��员指定一个约束条�Ӟ��保使用 @Size 标注时其大小��L��臛_��?1 或更大�?
��保在��?@PreValidateThis 标注调用 execute() �Ҏ(gu��)��?验证�q�个�U�束条�g�?

�q�两步让我能够有效地去除 validate() �Ҏ(gu��)��中的条�g��验，�?OVal 为我完成�q�些�Q�如清单 11 所�C�：

清单 11. �l�过改进、无条�g��验的 HierarchyBuilderTask

            @Guarded
            public class HierarchyBuilderTask extends Task {
            private Report report;
            @Size(min = 1)
            private List fileSet;
            private void validate() throws BuildException {
            if (this.report == null) {
            this.log("no report defined, printing XML to System.out");
            }
            }
            @PreValidateThis
            public void execute() throws BuildException {
            validate();
            String[] classes = this.getQualifiedClassNames(this.fileSet);
            Hierarchy[] hclz = new Hierarchy[classes.length];
            try{
            for(int x = 0; x < classes.length; x++){
            hclz[x] = HierarchyBuilder.buildHierarchy(classes[x]);
            }
            BatchHierarchyXMLReport xmler = new BatchHierarchyXMLReport(new Date(), hclz);
            this.handleReportCreation(xmler);
            }catch(ClassNotFoundException e){
            throw new BuildException("Unable to load class check classpath! " + e.getMessage());
            }
            }
            //more methods below....
            }

清单 11 中的 execute() 一�l�调用（�?Ant 完成�Q�，OVal ��׃��验证 fileSet 成员。如果其为空�Q�就意味着没有指定��M��要评估的�c�，��׃��抛出一�?ConstraintsViolatedException。这个异�怼�暂停�q�一�q�程�Q�就像初始代码一��P��只不�q�初始代码会抛出一�?BuildException�?/p>

��p��先生 2007-04-05 09:40 发表评论

久久综合狠狠综合久久综青草,日本精品在线一区,天堂аⅴ在线最新版在线