当前位置: 代码网 > it编程>编程语言>Java > 一文详解Java如何自动生成简单的Mermaid类图

一文详解Java如何自动生成简单的Mermaid类图

2025年10月10日 Java 我要评论
背景虽说手动生成类图的过程有利于加深自己的理解,但是查看各个类/接口的信息毕竟比较麻烦,如果可以把生成类图的过程自动化,就可以大大提升画类图的效率了。本文展示了我自己写的可以生成简单类图的 java

背景

虽说手动生成类图的过程有利于加深自己的理解,但是查看各个类/接口的信息毕竟比较麻烦,如果可以把生成类图的过程自动化,就可以大大提升画类图的效率了。

本文展示了我自己写的可以生成简单类图的 java 代码。文中展示了用它生成的以下类的类图

  • arraylist
  • linkedlist
  • java.util.arrays$arraylistarrays.aslist(...) 方法返回的是它的实例)
  • list/set/deque
  • hashmap/linkedhashmap/concurrenthashmap
  • set12/setnset.of(...) 方法返回的是它们的实例)
  • java.util.jumboenumset 和 java.util.regularenumset (enumset.of(...) 方法返回的是它们的实例)
  • java.util.concurrent.threadpoolexecutor

代码

我写了如下的 java 代码,它可以自动生成简单的 mermaid 类图。 请将以下代码保存为 classdiagramgenerator.java 

import java.lang.reflect.accessflag;
import java.util.*;

public class classdiagramgenerator {
    private final map<class<?>, class<?>[]> realizationrelations = new hashmap<>();
    private final map<class<?>, class<?>> inheritancerelations = new hashmap<>();

    private final set<class<?>> analyzedclasses = new hashset<>();

    public static void main(string[] args) {
        classdiagramgenerator generator = new classdiagramgenerator();
        generator.convert(args).foreach(generator::analyzehierarchy);

        generator.generateclassdiagram();
        generator.generatenamemappingtable();
    }

    /**
     * convert class name to the corresponding class object
     *
     * @param classnames give class names
     * @return a list that contains corresponding class objects
     */
    private list<class<?>> convert(string[] classnames) {
        if (classnames.length == 0) {
            string hint = "please refer to below usage and specify at least one class name!";
            string usage = "usage: java classdiagramgenerator 'java.util.arraylist' 'java.util.linkedlist'";
            throw new illegalargumentexception(string.join(system.lineseparator(), hint, usage));
        }

        list<class<?>> classlist = new arraylist<>(classnames.length);
        for (string classname : classnames) {
            try {
                class<?> clazz = class.forname(classname);
                classlist.add(clazz);
            } catch (classnotfoundexception e) {
                string message = string.format("class with name=%s can't be found, please check!", classname);
                throw new runtimeexception(message);
            }
        }
        return classlist;
    }

    /**
     * generate header for mermaid class diagram
     */
    private void generateheader() {
        system.out.println("```mermaid");
        system.out.println("classdiagram");
        system.out.println();
    }

    /**
     * generate footer for mermaid class diagram
     */
    private void generatefooter() {
        system.out.println("```");
    }

    /**
     * generate main content in mermaid class diagram
     */
    private void generateclassdiagram() {
        generateheader();
        dogenerateclassdiagram();
        generatefooter();
    }

    /**
     * generate a markdown table that contains name mapping
     */
    private void generatenamemappingtable() {
        system.out.println();
        system.out.println("| 在上图中的类名/接口名 | `fully qualified name` |");
        system.out.println("| --- | --- |");
        map<string, string> classnames = new treemap<>();
        analyzedclasses.foreach(c -> {
            string simplename = c.getsimplename();
            if (classnames.containskey(simplename)) {
                string prevname = classnames.get(simplename);
                string currname = c.getname();
                string message = string.format("duplicated simple class name detected! (%s and %s have the same simple name)", prevname, currname);
                throw new illegalargumentexception(message);
            }
            classnames.put(simplename, c.getname());
        });

        classnames.foreach((simplename, name) -> {
            string row = string.format("| `%s` | `%s` |", simplename, name);
            system.out.println(row);
        });
    }

    private void dogenerateclassdiagram() {
        analyzedclasses.foreach(c -> {
            if (inheritancerelations.containskey(c)) {
                system.out.printf("%s <|-- %s%n", inheritancerelations.get(c).getsimplename(), c.getsimplename());
            }
            if (realizationrelations.containskey(c)) {
                string type = c.isinterface() ? "<|--" : "<|..";
                arrays.stream(realizationrelations.get(c)).foreach(item -> {
                    system.out.printf("%s %s %s%n", item.getsimplename(), type, c.getsimplename());
                });
            }
        });

        generatespecialclassannotation();
    }

    /**
     * this method generates annotation for
     * 1. abstract classes
     * 2. interfaces
     */
    private void generatespecialclassannotation() {
        set<class<?>> abstractclasses = new linkedhashset<>();
        set<class<?>> interfaces = new linkedhashset<>();

        analyzedclasses.foreach(c -> {
            if (c.isinterface()) {
                interfaces.add(c);
            } else if (c.accessflags().contains(accessflag.abstract)) {
                abstractclasses.add(c);
            }
        });

        if (!abstractclasses.isempty() || !interfaces.isempty()) {
            system.out.println();
            abstractclasses.foreach(c -> system.out.println("<<abstract>> " + c.getsimplename()));
            interfaces.foreach(c -> system.out.println("<<interface>> " + c.getsimplename()));
        }
    }

    private void analyzehierarchy(class<?> currclass) {
        if (!analyzedclasses.contains(currclass)) {
            analyzesuperclass(currclass);
            analyzeinterfaces(currclass);

            analyzedclasses.add(currclass);
        }
    }

    private void analyzesuperclass(class<?> currclass) {
        class<?> superclass = currclass.getsuperclass();
        if (superclass == null || superclass == object.class) {
            return;
        }
        analyzehierarchy(superclass);
        inheritancerelations.put(currclass, superclass);
    }

    private void analyzeinterfaces(class<?> currclass) {
        class<?>[] interfaces = currclass.getinterfaces();
        for (class<?> item : interfaces) {
            analyzehierarchy(item);
        }

        realizationrelations.put(currclass, interfaces);
    }
}

用以下命令可以编译 classdiagramgenerator.java

javac classdiagramgenerator.java

注意事项

请注意,classdiagramgenerator 生成的类图中,不包含任何泛型信息,而且也不展示任何字段/方法。

例子

下面举一些例子,说明 classdiagramgenerator.java 的用法。

例1: 生成arraylist的类图

请运行以下命令以生成对应的内容 

java classdiagramgenerator 'java.util.arraylist'

运行结果是 markdown 格式的

运行结果

在上图中的类名/接口名fully qualified name
abstractcollectionjava.util.abstractcollection
abstractlistjava.util.abstractlist
arraylistjava.util.arraylist
cloneablejava.lang.cloneable
collectionjava.util.collection
iterablejava.lang.iterable
listjava.util.list
randomaccessjava.util.randomaccess
sequencedcollectionjava.util.sequencedcollection
serializablejava.io.serializable

变通的方式

如果您无法在掘金的文档中使用 mermaid,那么也可以前往 mermaid.live/ 来查看对应的类图,我在 mermaid.live/ 看到的效果如下 (需要自行将结果复制到那个网页去)

例2: 生成linkedlist的类图

请运行以下命令以生成对应的内容 

java classdiagramgenerator 'java.util.linkedlist'

运行结果是 markdown 格式的,展示如下

运行结果

在上图中的类名/接口名fully qualified name
abstractcollectionjava.util.abstractcollection
abstractlistjava.util.abstractlist
abstractsequentiallistjava.util.abstractsequentiallist
cloneablejava.lang.cloneable
collectionjava.util.collection
dequejava.util.deque
iterablejava.lang.iterable
linkedlistjava.util.linkedlist
listjava.util.list
queuejava.util.queue
sequencedcollectionjava.util.sequencedcollection
serializablejava.io.serializable

例3: 生成java.util.arrays$arraylist的类图

调用 arrays.aslist(...) 方法,得到的是 java.util.arrays$arraylist 的实例。 请运行以下命令以生成对应的内容 

java classdiagramgenerator 'java.util.arrays$arraylist'

运行结果是 markdown 格式的,展示如下

运行结果

请注意下图中的 arraylistjava.util.arrays 中的一个嵌套类,而不是我们平时常用的 java.util.arraylist

在上图中的类名/接口名fully qualified name
abstractcollectionjava.util.abstractcollection
abstractlistjava.util.abstractlist
arraylistjava.util.arrays$arraylist
collectionjava.util.collection
iterablejava.lang.iterable
listjava.util.list
randomaccessjava.util.randomaccess
sequencedcollectionjava.util.sequencedcollection
serializablejava.io.serializable

例4: 生成list/set/deque的类图

请运行以下命令以生成对应的内容 

java classdiagramgenerator 'java.util.list' 'java.util.set' 'java.util.deque'

运行结果是 markdown 格式的,展示如下

运行结果

在上图中的类名/接口名fully qualified name
collectionjava.util.collection
dequejava.util.deque
iterablejava.lang.iterable
listjava.util.list
queuejava.util.queue
sequencedcollectionjava.util.sequencedcollection
setjava.util.set

例5: 生成hashmap/linkedhashmap/concurrenthashmap的类图

请运行以下命令以生成对应的内容 

java classdiagramgenerator 'java.util.hashmap' 'java.util.linkedhashmap' 'java.util.concurrent.concurrenthashmap'

运行结果是 markdown 格式的,展示如下

运行结果

在上图中的类名/接口名fully qualified name
abstractmapjava.util.abstractmap
cloneablejava.lang.cloneable
concurrenthashmapjava.util.concurrent.concurrenthashmap
concurrentmapjava.util.concurrent.concurrentmap
hashmapjava.util.hashmap
linkedhashmapjava.util.linkedhashmap
mapjava.util.map
sequencedmapjava.util.sequencedmap
serializablejava.io.serializable

例6: 生成java.util.immutablecollections$set12和java.util.immutablecollections$setn的类图

当我们调用 set.of(...) 方法时,会得到以下两个类的实例 

  • java.util.immutablecollections$set12
  • java.util.immutablecollections$setn

请运行以下命令以生成对应的内容 

java classdiagramgenerator 'java.util.immutablecollections$set12' 'java.util.immutablecollections$setn'

运行结果是 markdown 格式的,展示如下

运行结果

在上图中的类名/接口名fully qualified name
abstractcollectionjava.util.abstractcollection
abstractimmutablecollectionjava.util.immutablecollections$abstractimmutablecollection
abstractimmutablesetjava.util.immutablecollections$abstractimmutableset
collectionjava.util.collection
iterablejava.lang.iterable
serializablejava.io.serializable
setjava.util.set
set12java.util.immutablecollections$set12
setnjava.util.immutablecollections$setn

例7: 生成java.util.jumboenumset和java.util.regularenumset的类图

当我们调用 enumset.of(...) 方法时,会得到以下两个类的实例 

  • java.util.jumboenumset
  • java.util.regularenumset

请运行以下命令以生成对应的内容 

java classdiagramgenerator 'java.util.jumboenumset' 'java.util.regularenumset'

运行结果是 markdown 格式的,展示如下

运行结果

在上图中的类名/接口名fully qualified name
abstractcollectionjava.util.abstractcollection
abstractsetjava.util.abstractset
cloneablejava.lang.cloneable
collectionjava.util.collection
enumsetjava.util.enumset
iterablejava.lang.iterable
jumboenumsetjava.util.jumboenumset
regularenumsetjava.util.regularenumset
serializablejava.io.serializable
setjava.util.set

例8: 生成threadpoolexecutor的类图

请运行以下命令以生成对应的内容 

java classdiagramgenerator 'java.util.concurrent.threadpoolexecutor'

运行结果是 markdown 格式的,展示如下

运行结果

在上图中的类名/接口名fully qualified name
abstractexecutorservicejava.util.concurrent.abstractexecutorservice
autocloseablejava.lang.autocloseable
executorjava.util.concurrent.executor
executorservicejava.util.concurrent.executorservice
threadpoolexecutorjava.util.concurrent.threadpoolexecutor

到此这篇关于一文详解java如何自动生成简单的mermaid类图的文章就介绍到这了,更多相关java生成mermaid类图内容请搜索代码网以前的文章或继续浏览下面的相关文章希望大家以后多多支持代码网!

(0)

相关文章:

版权声明:本文内容由互联网用户贡献,该文观点仅代表作者本人。本站仅提供信息存储服务,不拥有所有权,不承担相关法律责任。 如发现本站有涉嫌抄袭侵权/违法违规的内容, 请发送邮件至 2386932994@qq.com 举报,一经查实将立刻删除。

发表评论

验证码:
Copyright © 2017-2025  代码网 保留所有权利. 粤ICP备2024248653号
站长QQ:2386932994 | 联系邮箱:2386932994@qq.com