如何从java源码中读取注释信息?(注意不是指通过反射读取annotation类,是comment,就是程序员在源码中加的注释) 比如:
/**
* 使用当前类的class loader加载工具对象
* @param classname
* @return
* @throws ClassNotFoundException
* @throws InstantiationException
* @throws IllegalAccessException
*/
大概很少会有人需要用到这个,不过最近的项目中需要对自动生成的代码中加入原始代码的注释,就需要从原始代码中获取注释。所以需要在程序实现读取源码中的注释信息,网上找了很多文章都想通过分析源码文件(正则表达式)来把注释提取出来,差点被这些文章带到坑里,休息的时候突然想如果javadoc有API可以调用,应该就能通过javadoc来获取完整的注释,而不用自己费力去搞。
google一查,果然javadoc有API的,就在$JAVA_HOME/lib/tools.jar
中,官网也提供了完整的文档告诉你如何定制自己的javadoc输出。最关键的一点就是提供一个Doclet 类,利用-doclet
参数去替换掉javadoc默认的Doclet,然后你的Doclet类就能获得一个包含完整丰富的结构化信息的注释对象RootDoc.然后你想怎么玩就随你啦。
关于如何在maven中将$JAVA_HOME/lib/tools.jar添加到dependency,参见 参考资料2
package gu.doc;
import com.sun.javadoc.ClassDoc;
import com.sun.javadoc.MethodDoc;
import com.sun.javadoc.RootDoc;
public class JavaDocReader {
private static RootDoc root;
// 一个简单Doclet,收到 RootDoc对象保存起来供后续使用
// 参见参考资料6
public static class Doclet {
public Doclet() {
}
public static boolean start(RootDoc root) {
JavaDocReader.root = root;
return true;
}
}
// 显示DocRoot中的基本信息
public static void show(){
ClassDoc[] classes = root.classes();
for (int i = 0; i < classes.length; ++i) {
System.out.println(classes[i]);
System.out.println(classes[i].commentText());
for(MethodDoc method:classes[i].methods()){
System.out.printf("\t%s\n", method.commentText());
}
}
}
public static RootDoc getRoot() {
return root;
}
public JavaDocReader() {
}
public static void main(final String ... args) throws Exception{
// 调用com.sun.tools.javadoc.Main执行javadoc,参见 参考资料3
// javadoc的调用参数,参见 参考资料1
// -doclet 指定自己的docLet类名
// -classpath 参数指定 源码文件及依赖库的class位置,不提供也可以执行,但无法获取到完整的注释信息(比如annotation)
// -encoding 指定源码文件的编码格式
com.sun.tools.javadoc.Main.execute(new String[] {"-doclet",
Doclet.class.getName(),
"-docletpath",
Doclet.class.getResource("/").getPath(),
"-encoding","utf-8",
"-classpath",
"D:/j/facelog/facelog-main/target/classes;D:/j/facelog/db/target/classes;D:/j/facelog/db/sql2java/lib/swift-annotations-0.14.2.jar",
"J:/facelog/facelog-main/src/main/java/net/gdface/facelog/FaceLogDefinition.java"});
show();
}
}
1:《javadoc OPTIONS》 2:《JDK tools.jar as maven dependency》 3:《Running the Standard Doclet Programmatically》 4:《Doclet Overview》 5:《stackoverflow:Running the Standard Doclet Programmatically》 6:《A Simple Example Doclet》