QDox
QDox 一款简单，高效的Java源代码解析器，可以提取Java类、接口、方法、参数名称、类型等。
另外不得不说的是这个项目可以说是一个上古时期的项目了，看了 Github 上的提交记录，最早的一条提交记录是 2002 年的时候，因为这个项目之前使用的是 svn，所以具体时间可能更早。一个开源项目维护了快 20 年也是一件挺令人钦佩的事。不过到目前为止，这个项目在 github 上只有 303个 star，如果这个项目对你有所帮助，希望大家可以给作者一个 star。github 上有太多类似的项目默默无闻的出现，又默默无闻的消逝。
不过据说maven 的官方 javadoc 插件 maven-javadoc-plugin 就是使用它来解析代码中的 doc tags 的。所以可能你没有直接使用它，但是它其中已经在你本地的 maven 仓库内躺着了。有官方背书，对于它的使用就比较放心了。
github:https://github.com/paul-hammant/qdox
简单介绍一下怎么用。
集成
目前最新版本2.0-M10
Maven
<dependency> <groupId>com.thoughtworks.qdox</groupId> <artifactId>qdox</artifactId> <version>2.0-M10</version> </dependency>
Gradle
compile group: 'com.thoughtworks.qdox', name: 'qdox', version: '2.0-M10'
用法
package com.mini.test; import java.util.Random; /** * QDox 测试 * @author: jujun chen * @date: 2019/07/07 */ public class TestClass extends BaseTestClass implements Test{ /** * 登录接口 * @param userName 用户名 * @param password 密码 * @return Person对象 */ public Person Login(String userName, String password) { int age = new Random().nextInt(); Person person = new Person(userName, password, age); System.out.println(person); return person; } } class Person { private String userName; private String password; private int age; public Person(String userName, String password, int age) { this.userName = userName; this.password = password; this.age = age; } } class BaseTestClass { } interface Test { }
测试：
@Test public void getMeClass() throws IOException { JavaProjectBuilder builder = new JavaProjectBuilder(); builder.addSourceTree(new File("src/main/java/com/mini/test")); //目录下的所有class System.out.println("====目录下的所有class===="); Collection<JavaClass> classes = builder.getClasses(); System.out.println(classes + "\n"); //根据class全限定名获取 JavaClass javaClass = builder.getClassByName("com.mini.test.TestClass"); //获取类的注释 System.out.println("====获取类的注释===="); System.out.println(javaClass.getComment()); List<DocletTag> classTags = javaClass.getTags(); classTags.forEach(item -> { System.out.println(item.getName() + "" + item.getValue()); }); System.out.println("\n"); //获取继承的父类 System.out.println("====获取继承的父类===="); System.out.println(javaClass.getSuperClass() + "\n"); //获取接口 System.out.println("====获取接口===="); System.out.println(javaClass.getImplements() + "\n"); //获取方法 System.out.println("====获取方法===="); List<JavaMethod> methods = javaClass.getMethods(); System.out.println(methods + "\n"); //get Login方法 JavaMethod javaMethod = methods.get(0); //方法返回类型 System.out.println("====获取方法返回类型===="); System.out.println(javaMethod.getReturns() + "\n"); //获取参数 System.out.println("====获取参数===="); List<JavaParameter> parameters = javaMethod.getParameters(); System.out.println(parameters); //获取参数类型 //get userName参数 JavaParameter parameter = parameters.get(0); //参数名称 System.out.println(parameter.getName()); //参数类型 System.out.println(parameter.getType() + "\n"); System.out.println("====获取方法注释===="); //获取方法注释 System.out.println(javaMethod.getComment()); //获取参数备注 List<DocletTag> tags =javaMethod.getTags(); tags.forEach(item -> { System.out.println(item.getName() + ":" + item.getValue()); }); }
测试结果：
====目录下的所有class==== [class com.mini.test.TestClass, class com.mini.test.Person, class com.mini.test.BaseTestClass, interface com.mini.test.Test] ====获取类的注释==== QDox 测试 author:jujun chen date:2019/07/07 ====获取继承的父类==== com.mini.test.BaseTestClass ====获取接口==== [com.mini.test.Test] ====获取方法==== [public com.mini.test.Person com.mini.test.TestClass.Login(java.lang.String,java.lang.String)] ====获取方法返回类型==== com.mini.test.Person ====获取参数==== [String userName, String password] userName java.lang.String ====获取方法注释==== 登录接口 param:userName 用户名 param:password 密码 return:Person对象
总结
使用该工具，可以解析Java源代码，很方便，速度也很快😎。脑洞一下吧，可以利用它来做点什么，提高生产力。
