CN113312038B - 一种生成Java代码类继承结构的实现方法 - Google Patents

Abstract

本发明提供一种生成Java代码类继承结构的实现方法，属于Java软件开发技术领域，本发明利用Java提供的Class动态加载机制，对指定目录下的字节码文件进行读取，利用反射机制获取类和接口的信息，并构建继承实现结构图，然后将该结构以图形化的方式直观地呈现给用户。

Description

一种生成Java代码类继承结构的实现方法

技术领域

本发明涉及Java软件开发技术领域，尤其涉及一种生成Java代码类继承结构的实现方法。

背景技术

在开源世界中，优秀的开源项目层出不穷，这些项目由世界各地的开发者共同构建而成。而在企业项目开发中，很多团队都会或多或少地使用开源框架提高自己的开发效率，其中有一些项目是直接在开源项目的基础上进行修改，以适应项目的需要。在这个过程中，就需要开发者理解开源框架的设计架构与具体的内部逻辑。很多开源项目出于各种需要，设计了很复杂的代码架构，这对于使用者来说，需要花费很多时间去逐步理解。对于一些开发者来说，直接阅读源码容易让人感到困惑，但如果有文档、图表等内容进行辅助阅读，就能更容易地理解代码结构。然而有些开源项目的文档并不是很齐全，而且文档更多地倾向于帮助开发者使用项目而不是理解项目的代码结构。虽然部分IDE提供了插件用于生成项目的结构图，但仍有部分开发者使用的开发工具不具备这样的功能。对于这部分开发者，需要一些工具对项目的代码结构进行整理，并以更直观的方式进行呈现。

发明内容

为了解决以上技术问题，本发明提供了一种生成Java代码类继承结构的实现方法，用于生成目标Java项目的类继承结构和接口实现结构，以直观的图形化方式进行呈现。帮助开发者加快理解Java开源项目或已有Java项目的代码结构，提高开发效率。

本发明的技术方案是：

一种生成Java代码类继承结构的实现方法，利用Java提供的Class动态加载机制，对指定目录下的字节码文件进行读取，利用反射机制获取类和接口的信息，并构建继承实现结构图，然后将该结构以图形化的方式直观地呈现给用户。

进一步的，

包括：

A、通过jar包运行：

i.生成一个目录下单个class或interface的继承实现结构图：

java–jar diagram.jar class字节码所在目录Class或Interface全限定名

ii.生成某个目录下所有class或interface的继承实现结构图：

java–jar diagram.jar class字节码所在目录

B、IDE运行：

iii.生成一个目录下单个class或interface的继承实现结构图：

运行参数：diagram.jar class字节码所在目录Class或Interface全限定名

iv.生成某个目录下所有class或interface的继承实现结构图：

运行参数：class字节码所在目录。

进一步的，

继承与实现结构图使用有向无环图进行存储，通过邻接链表实现。

进一步的，

具体步骤如下：

a)读取命令行参数；

b)构造URLClassLoader对象；url为目标目录；

c)构造有向无环图，生成Object节点。其中，顶点用HashMap保存，边用自定义的链表结构保存；

d)构造待处理全限定名List classNameList；

e)依次处理classNameList中的class或interface。

f)图形化输出继承结构图。

再进一步的，

步骤a)中的参数包括字节码所在目录、目标class或interface的全限定名。

步骤d)中,根据启动参数进行相应处理，若需要获取目标目录下所有class文件的结构信息，则需要遍历目标目录，根据目录结构和文件名拼接全限定名。

步骤e)中,通过URLClassLoader获取Class对象，获取其父类或者实现的接口，向有向无环图中添加一个节点，然后递归处理其父类或实现的接口，直到遇见Object或已加入图中的节点为止。

步骤f)中,通过抽象接口采用命令行字符输出的形式，打印结构图。

本发明的有益效果是

本发明利用Java提供的class动态加载以及反射机制，获取Java项目中的类和接口的继承和实现关系，并以图形化的形式进行呈现，帮助开发者方便快捷地理解Java项目的代码结构，提高开发效率。

本发明使用Java语言开发，在安装有Java运行时的环境下就能运行，不需要依赖特定IDE等第三方工具，便于开发者使用。

本发明提供了图形化输出接口，开发者可以提供自己的图形化输出实现。

附图说明

图1是邻接链表示意图；

图2是操作步骤示意图；

图3是使用有向无环图进行存储示意图；

图4是图形化输出继承结构示意图。

具体实施方式

为使本发明实施例的目的、技术方案和优点更加清楚，下面将结合本发明实施例中的附图，对本发明实施例中的技术方案进行清楚、完整地描述，显然，所描述的实施例是本发明一部分实施例，而不是全部的实施例，基于本发明中的实施例，本领域普通技术人员在没有做出创造性劳动的前提下所获得的所有其他实施例，都属于本发明保护的范围。

本发明提供了一种生成Java代码类继承结构的实现方法，以一种便捷获取Java项目的类继承结构与接口实现结构的方式，为Java开发者阅读源码、理解项目的架构设计提供帮助。

本发明利用Java原生提供的特性进行实现。

1)通过动态类加载机制加载目标字节码；

2)通过反射机制获取目标Class对象。

本发明以有向无环图作为数据结构存储结构图。

1)使用邻接链表实现。

2)提供了多种图形化输出支持。

一、相关技术：

a)Java class动态加载机制；

b)Java反射机制；

c)有向无环图。

二、使用方法：

A、通过jar包运行：

v.生成某个目录下单个class或interface的继承实现结构图：

java–jar diagram.jar class字节码所在目录Class或Interface全限定名

vi.生成某个目录下所有class或interface的继承实现结构图：

java–jar diagram.jar class字节码所在目录

B、IDE运行：

vii.生成某个目录下单个class或interface的继承实现结构图：

运行参数：diagram.jar class字节码所在目录Class或Interface全限定名

viii.生成某个目录下所有class或interface的继承实现结构图：

运行参数：class字节码所在目录

三、实现步骤：

为了获取class和interface的继承与实现结构，需要利用Java提供的反射机制，通过class和interface的Class对象，获取其父类或实现的接口名称，而为了获取Class对象，则需要通过ClassLoader动态加载目标字节码文件。

其中，继承与实现结构图使用有向无环图进行存储，通过邻接链表实现。虽然Java只支持类的单继承，可以使用树形结构进行存储，但一个类可以实现多个接口，意味着一个节点可以有多个父节点，同时类与接口之间的继承与实现关系不可能出现环路，因此这里使用有向无环图进行存储。Object类是图中的起始节点。如图3所示(注意，图中的箭头方向代表同时代表继承与实现关系，并未与UML类图对应，此处仅用作有向无环图的说明)

邻接链表图示如图1。

具体步骤如图2：

b)读取命令行参数。包括字节码所在目录、目标class或interface的全限定名；

c)构造URLClassLoader对象。url为目标目录；

d)构造有向无环图，生成Object节点。其中，顶点用HashMap保存，边用自定义的链表结构保存；

e)

f)构造待处理全限定名List classNameList。根据启动参数进行相应处理，若需要获取目标目录下所有class文件的结构信息，则需要遍历目标目录，根据目录结构和文件名拼接全限定名；

g)依次处理classNameList中的class或interface。通过URLClassLoader获取Class对象，获取其父类或者实现的接口，向有向无环图中添加一个节点，然后递归处理其父类或实现的接口，直到遇见Object或已加入图中的节点为止。

h)图形化输出继承结构图。通过抽象接口可以有多种图形化实现。这里采用命令行字符输出的形式，打印结构图，如图4所示。

以上所述仅为本发明的较佳实施例，仅用于说明本发明的技术方案，并非用于限定本发明的保护范围。凡在本发明的精神和原则之内所做的任何修改、等同替换、改进等，均包含在本发明的保护范围内。

Claims (7)

1.一种生成Java代码类继承结构的实现方法，其特征在于，

利用Java提供的Class动态加载机制，对指定目录下的字节码文件进行读取，利用反射机制获取类和接口的信息，并构建继承实现结构图，然后将该结构以图形化的方式直观地呈现给用户；

包括：

A、通过jar包运行：

i.生成一个目录下单个class或interface的继承实现结构图：

java –jar diagram.jar class字节码所在目录 Class或Interface全限定名；

ii. 生成一个目录下所有class或interface的继承实现结构图：

java –jar diagram.jar class字节码所在目录；

B、IDE运行：

iii. 生成一个目录下单个class或interface的继承实现结构图：

运行参数：diagram.jar class字节码所在目录 Class或Interface全限定名；

iv. 生成某个目录下所有class或interface的继承实现结构图：

运行参数：class字节码所在目录。

2.根据权利要求1所述的方法，其特征在于，

继承与实现结构图使用有向无环图进行存储，通过邻接链表实现。

3.根据权利要求2所述的方法，其特征在于，

具体步骤如下：

a）读取命令行参数；

b)构造URLClassLoader对象；url为目标目录；

c)构造有向无环图，生成Object节点；其中，顶点用HashMap保存，边用自定义的链表结构保存；

d)构造待处理全限定名List classNameList；

e)依次处理classNameList中的class或interface；

f)图形化输出继承结构图。

4.根据权利要求3所述的方法，其特征在于，

步骤a)中的参数包括字节码所在目录、目标class或interface的全限定名。

5.根据权利要求3所述的方法，其特征在于，

步骤d)中,根据启动参数进行相应处理，若需要获取目标目录下所有class文件的结构信息，则需要遍历目标目录，根据目录结构和文件名拼接全限定名。

6.根据权利要求3所述的方法，其特征在于，

步骤e)中, 通过URLClassLoader获取Class对象，获取其父类或者实现的接口，向有向无环图中添加一个节点，然后递归处理其父类或实现的接口，直到遇见Object或已加入图中的节点为止。

7.根据权利要求3所述的方法，其特征在于，

步骤f)中,通过抽象接口采用命令行字符输出的形式，打印结构图。

Images