CN103279631B - 设计模式制导的爪哇代码评审方法 - Google Patents

Abstract

本发明提供了一种设计模式制导的爪哇代码评审方法，用户首先要提供待评审的爪哇（Java）程序的源代码及其设计时信息，对设计时信息中的类图进行分析，提取出设计模式信息，生成设计模式的各个参与角色的对应关系，根据该信息，利用预定义的规则模板，将规则模板实例化为一组应该在代码上满足的约束规则，读入这些规则对待评审的Java源代码的抽象语法树进行分析，判断其实现是否满足了设计时的约束，对于那些不满足约束的情况给出提示。本发明能够自动的对代码进行评审，减少整个评审过程中人工检查代码的工作量，提高代码的评审效率。

Description

设计模式制导的爪哇代码评审方法

技术领域

本发明涉及一种用于自动检测设计模式信息在设计类图与爪哇（Java）代码实现之间的一致性的方法，属于计算机技术领域。

背景技术

自从设计模式的概念被提出之后，它已经在科研和工业界中被广泛地使用。设计模式是一种高度抽象的设计时信息，提供一种良好的模块化解决方案，它是一套被反复使用、多数人知晓的、经过分类编目的、代码设计经验的总结。使用设计模式是为了可重用代码、让代码更容易被他人理解、保证代码可靠性。，设计模式在代码实现时需要程序员的理解，故这个过程很容易地引入人为的错误。

代码评审方法是一种在测试之前对代码进行检查的过程，它根据一系列事先准备好的检查项列表，在代码中查找是否存在不满足检查项描述的约束的情况，从而能够提前发现代码中存在的缺陷。现有的代码评审工具大部分关注的是代码的修改所引入的缺陷检查，还有的关注的是代码本身应该满足的特性，很少关注设计信息，所以可结合设计模式信息，将设计模式在设计时的信息规约成一系列的规则，这些规则也就是所谓的检查项。将这些规则表示成计算机可以识别的格式，那么就可以自动地检查代码实现是否符合设计时的意图，提供一个自动检查工具来检测这种一致性约束，从而减少整个评审过程的人为干预。

Java是一种可以撰写跨平台应用软件的面向对象的程序设计语言，是由SunMicrosystems公司于1995年5月推出的Java程序设计语言和Java平台（即JavaSE、JavaEE、JavaME）的总称。Java技术具有卓越的通用性、高效性、平台移植性和安全性，广泛应用于个人PC、数据中心、游戏控制台、科学超级计算机、移动电话和互联网，同时拥有全球最大的开发者专业社群。在全球云计算和移动互联网的产业环境下，Java更具备了显著优势和广阔前景。

发明内容

技术问题：本发明目的是提供一种设计模式信息从设计类图到Java代码实现的一致性代码评审方法，解决代码评审中的过多人为干预问题。

技术方案：本发明所述设计模式制导的Java代码评审方法中，首先用户提供待评审Java程序的源代码及其设计时信息，然后对设计时信息中的类图进行分析，提取出设计模式信息，根据该信息，利用预定义的规则模板，接着根据设计模式的各个参与角色的对应关系将规则模板实例化为一组应该在代码上满足的约束规则，最后读入这些约束规则对源代码的抽象语法树进行分析，判断其实现是否满足设计时约束，对于那些不满足约束的情况给出提示。

本发明所述设计模式制导的Java代码评审方法包括以下步骤：

步骤1、用户提供待评审的爪哇Java源代码及其包括类图的设计时信息；

步骤2、分析类图中存在的继承和关联关系，提取出相应的设计模式，将每个设计模式描述成各个类所扮演的角色关系，将这些角色关系提交给用户选取出有效的设计模式；

步骤3、用户提供用于Java代码评审的预定义的规则模板，根据有效设计模式的角色关系，用类名以及类的位置信息对规则模板进行实例化，形成与各个类相关的规则；所述预定义的规则模板定义所有适用于设计模式的角色关系的约束，包括以下模板：

规则1，继承规则：类的父类或者继承的接口是否满足约束；

规则2，关联规则：类是否有满足约束的属性；

规则3，参数方法定义规则：类是否有方法的参数满足规则约束；

规则4，this参数方法调用规则：类的方法内部是否用参数调用带this指针的方法；

规则5，同名方法调用规则：类的方法的实现中是否调用了另外一个对象的同名方法；

规则6，返回值方法定义规则：类的方法是否有一个方法返回值满足约束；

规则7，返回子类方法实现规则：类中返回值为约束描述的方法在实现时是否返回的是返回值的子类；

规则8，集合关联规则：类的属性是否有一个集合关联到规则约束描述的类；

规则9，接口方法互相调用规则：类是否继承了一个接口方法，在这些继承方法中调用另外一个接口的方法；

规则10，引用调用接口方法规则：类继承了一个接口，并且保存一个到另外一个类的引用，在继承的接口方法中，是否用这个引用来调用其方法；

规则11，私有构造方法规则：类的构造函数是否是私有的；

规则12，参数构造方法定义规则：类的构造函数是否定义了满足参数约束的构造函数；

规则13，内部类规则：类是否为一个内部类；

步骤4、读入与实例化后形成的规则相关的类对应的待评审Java源代码，建立这些类的抽象语法树，根据语法树对上述规则进行匹配，检查类是否满足规则的约束，如果不满足，告诉用户待评审的Java源代码不满足哪些规则，所述抽象语法树是Java源代码的抽象语法结构的树状表现形式，树上的每个节点都表示源代码中的一种结构，根据预定义的规则模板，针对设计模式中类a与类b之间角色关系，对实例化形成的规则评审后给出的结果如下：

规则1、类a未继承类b；

规则2、类a未关联类b；

规则3、类a未定义参数为b的方法；

规则4、类a未在方法m内用this参数调用类b的方法；

规则5、类a在方法m内未调用类b中同名的方法；

规则6、类a未定义返回值为类b的方法；

规则7、类a在返回值为类b的方法m内未返回一个类b的子类；

规则8、类a未关联一个类b的集合；

规则9、类a未在继承于类b的方法内调用继承于类c的方法；

规则10：类a未在继承于类b的方法内用一个类c的变量调用类c的方法；

规则11、类a存在一个非私有的构造函数；

规则12、类a未定义一个以类b为参数的构造函数；

规则13、类a不是类b的内部类；

所述类a、类b和类c均为Java类的名称。

有益效果：本发明所述的设计模式制导的Java代码评审方法实现了Java源代码与设计模式之间的一致性检查功能，从设计模式的角度提供了Java代码正确性的评审依据。具体来说，本发明所述的方法具有如下的有益效果：

（1）在本发明所述设计模式制导的Java代码评审方法中，将原来不被实现关注的设计时信息与源代码紧密结合，提供了一种设计与实现的一致性评审方法；

（2）本发明所述的设计模式制导的Java代码评审方法从设计类图中提取设计模式信息，可以自动地检查代码实现是否符合设计时的意图，提供一个自动检查工具来检测这种一致性约束，从而减少整个评审过程的人为干预。

附图说明

图1是设计模式制导的Java代码评审方法具体实施框架，

图2是设计模式与规则的对应关系。

具体实施方式

本发明给出一种Java代码评审方法，用于检测设计模式信息在设计类图和源代码上的一致性，图1是设计模式制导的Java代码评审方法具体实施框架，在具体实施中，可以利用现有的设计模式检测器、规则编辑器、规则产生器、规则评审器等工具或者自行构建这些工具。

本发明具体的实施过程如下：

步骤1、用户提供待评审的Java源代码及其所有类的类图、Java源文件以及类图的位置等信息。

步骤2、设计模式检测器分析类图中存在的继承和关联关系，获得有效的设计模式。在具体实施中，可以利用设计模式检测器工具，提取出类图中用到的具体设计模式，每个设计模式的定义都会有一组角色参与，这些角色间存在一些约束关系。在得到类图的设计模式后，将这些类对应到设计模式的各个角色上，这样就形成了具体的与各个类相关的角色关系。有了这些设计模式中的角色关系后，提交给用户进行人工确认，哪些确实是有效的设计模式，确认后的结果供后续的步骤使用。

步骤3、用户根据规则编辑工具，为Java代码评审提供预定义的规则模板，根据有效设计模式的角色关系，通过规则产生器，对规则模板进行实例化，形成与各个类相关的规则。在具体实施中，所述预定义的规则模板定义所有适用于设计模式的角色关系的约束，包括以下模板：

规则1（继承规则）：类的父类或者继承的接口是否满足约束；

规则2（关联规则）：类是否有满足约束的属性；

规则3（参数方法定义规则）：类是否有方法的参数满足规则约束；

规则4（this参数方法调用规则）：类的方法内部是否用参数调用带this指针的方法；

规则5（同名方法调用规则）：类的方法的实现中是否调用了另外一个对象的同名方法；

规则6（返回值方法定义规则）：类的方法是否有一个方法返回值满足约束；

规则7（返回子类方法实现规则）：类中返回值为约束描述的方法在实现时是否返回的是返回值的子类；

规则8（集合关联规则）：类的属性是否有一个集合关联到规则约束描述的类；

规则9（接口方法互相调用规则）：类是否继承了一个接口方法，在这些继承方法中调用另外一个接口的方法；

规则10（引用调用接口方法规则）：类继承了一个接口，并且保存一个到另外一个类的引用，在继承的接口方法中，是否用这个引用来调用其方法；

规则11（私有构造方法规则）：类的构造函数是否是私有的；

规则12（参数构造方法定义规则）：类的构造函数是否定义了满足参数约束的构造函数；

规则13（内部类规则）：类是否为一个内部类。

在具体实施中，结合预定义的规则模板，根据步骤2获得有效的设计模式，有了参与设计模式的各个类角色，就可将这些类用于规则的实例化，图2给出了设计模式与规则的对应关系表，当读入一条设计模式后，查找该设计模式应该生成哪些具体的规则，将生成的这一组规则保存下来供后续步骤使用并继续读入下一条设计模式。在遍历完所有的设计模式后，就得到了针对本次评审所需的所有规则。

步骤4：根据步骤3生成的结果，对于每一条实例化的规则，读入规则中描述的类对应的Java源代码，建立这些类的抽象语法树，通过规则评审器工具检查Java源代码是否满足规则的约束。在具体实施中，评审源代码是否满足设计模式的约束时，采用的是建立抽象语法树并根据语法树对规则进行匹配的方法，该方法利用EclipseAST库建立类的抽象语法树，根据不同的规则，匹配抽象语法树应该满足的约束条件，遍历完各条规则后就得到的本次的评审结果。

步骤5：根据步骤4所作的评审，对于那些不符合设计模式约束的源代码实现给出提示，告诉用户所不满足哪些规则，根据预定义的规则模板，针对设计模式中类a与类b之间角色关系，对实例化形成的规则评审后给出的结果如下：

规则1、类a未继承类b；

规则2、类a未关联类b；

规则3、类a未定义参数为b的方法；

规则4、类a未在方法m内用this参数调用类b的方法；

规则5、类a在方法m内未调用类b中同名的方法；

规则6、类a未定义返回值为类b的方法；

规则7、类a在返回值为类b的方法m内未返回一个类b的子类；

规则8、类a未关联一个类b的集合；

规则9、类a未在继承于类b的方法内调用继承于类c的方法；

规则10：类a未在继承于类b的方法内用一个类c的变量调用类c的方法；

规则11、类a存在一个非私有的构造函数；

规则12、类a未定义一个以类b为参数的构造函数；

规则13、类a不是类b的内部类。

在具体实施中，所述类a、类b和类c均为Java类的名称。

在具体实施中，最终用户可以根据上述评审结果修改其代码实现。

Claims (1)

1.一种设计模式制导的爪哇代码评审方法，其特征在于该方法包括以下步骤：

步骤1、用户提供待评审的爪哇Java源代码及其包括类图的设计时信息；

步骤2、分析类图中存在的继承和关联关系，提取出相应的设计模式，将每个设计模式描述成各个类所扮演的角色关系，将这些角色关系提交给用户选取出有效的设计模式；

步骤3、用户提供用于Java代码评审的预定义的规则模板，根据有效设计模式的角色关系，用类名以及类的位置信息对规则模板进行实例化，形成与各个类相关的规则；所述预定义的规则模板定义所有适用于设计模式的角色关系的约束，包括以下模板：

规则1，继承规则：类的父类或者继承的接口是否满足约束；

规则2，关联规则：类是否有满足约束的属性；

规则3，参数方法定义规则：类是否有方法的参数满足规则约束；

规则4，this参数方法调用规则：类的方法内部是否用参数调用带this指针的方法；

规则5，同名方法调用规则：类的方法的实现中是否调用了另外一个对象的同名方法；

规则6，返回值方法定义规则：类的方法是否有一个方法返回值满足约束；

规则7，返回子类方法实现规则：类中返回值为约束描述的方法在实现时是否返回的是返回值的子类；

规则8，集合关联规则：类的属性是否有一个集合关联到规则约束描述的类；

规则9，接口方法互相调用规则：类是否继承了一个接口方法，在这些继承方法中调用另外一个接口的方法；

规则10，引用调用接口方法规则：类继承了一个接口，并且保存一个到另外一个类的引用，在继承的接口方法中，是否用这个引用来调用其方法；

规则11，私有构造方法规则：类的构造函数是否是私有的；

规则12，参数构造方法定义规则：类的构造函数是否定义了满足参数约束的构造函数；

规则13，内部类规则：类是否为一个内部类；

步骤4、读入与实例化后形成的规则相关的类对应的待评审Java源代码，建立这些类的抽象语法树，根据语法树对上述规则进行匹配，检查类是否满足规则的约束，如果不满足，告诉用户待评审的Java源代码不满足哪些规则，所述抽象语法树是Java源代码的抽象语法结构的树状表现形式，树上的每个节点都表示源代码中的一种结构，根据预定义的规则模板，针对设计模式中类a与类b之间角色关系，对实例化形成的规则评审后给出的结果如下：

规则1、类a未继承类b；

规则2、类a未关联类b；

规则3、类a未定义参数为b的方法；

规则4、类a未在方法m内用this参数调用类b的方法；

规则5、类a在方法m内未调用类b中同名的方法；

规则6、类a未定义返回值为类b的方法；

规则7、类a在返回值为类b的方法m内未返回一个类b的子类；

规则8、类a未关联一个类b的集合；

规则9、类a未在继承于类b的方法内调用继承于类c的方法；

规则10：类a未在继承于类b的方法内用一个类c的变量调用类c的方法；

规则11、类a存在一个非私有的构造函数；

规则12、类a未定义一个以类b为参数的构造函数；

规则13、类a不是类b的内部类；

所述类a、类b和类c均为Java类的名称。