利用javadocApi自定义读取注释生成内容

需求时帮别人写了几个接口,然后字段挺多的,我都加了注释,但是不能给人家看类啊,当时又没有用swagger,太懒了,所以就干脆根据注释生成一个markdown字段说明表吧,一番折腾,搞个Demo

package com.server.simple.markdown;

import cn.hutool.core.collection.CollUtil;
import cn.hutool.core.io.FileUtil;
import cn.hutool.core.util.ArrayUtil;
import cn.hutool.core.util.ClassUtil;
import com.sun.javadoc.*;
import pers.conan.mdcoffee.exception.DisablePutException;
import pers.conan.mdcoffee.markdown.*;

import java.io.File;
import java.util.List;
import java.util.stream.Collectors;

public class CustomerDoclet extends Doclet {

    private static ClassDoc[] docClasses = null;
    private static RootDoc docRoot = null;

    public static boolean start(RootDoc root) {
        ClassDoc[] classes = root.classes();
        docRoot = root;
        docClasses = classes;
        //注释文档信息,自己爱怎么解析注释就怎么解析了,看自己需求
        return true;
    }

    public static void main(String[] args) throws Exception {
        System.out.println(ClassUtil.getClassPathURL());
        List<File> files = FileUtil.loopFiles("/Users/tony/workspace/IdeaProjects/Server/src/main/java/com/server/simple/entity");
        List<String> filePaths = files.stream().map(file -> file.getAbsolutePath()).collect(Collectors.toList());

        String[] docArgs =
                new String[]{
                        "-private",
                        "-doclet", CustomerDoclet.class.getName()
                };
        for (String filePath : filePaths) {
            docArgs = ArrayUtil.append(docArgs, filePath);
        }
        com.sun.tools.javadoc.Main.execute(docArgs);

        show();
    }


    // 显示DocRoot中的基本信息
    public static void show() throws DisablePutException {
        ClassDoc[] classes = docClasses;
        TopMark content = new TopMark();
        for (ClassDoc classDoc : classes) {
            TableMark tableMark = handClass(classDoc);
            TopMark top = new TopMark();
            TitleMark titleMark = new TitleMark(tableMark.getText());
            top.put(titleMark);
            top.put(tableMark);
            content.put(top);

        }
        FileUtil.writeString(content.translate(), FileUtil.file("/Users/tony/workspace/pro/markdown/完整.md"), "UTF-8");
    }

    public static TableMark handClass(ClassDoc classDoc) {

        CustomTableMark tableMark = new CustomTableMark();
        tableMark.setText(classDoc.commentText());
        TableHeadMark headMark = new TableHeadMark(CollUtil.newArrayList(new CellMark("字段"), new CellMark("类型"), new CellMark("说明")));
        tableMark.setHead(headMark);
        for (FieldDoc field : classDoc.fields()) {
            String type = field.type().simpleTypeName();
            String comment = field.commentText();
            String fieldName = field.name();
            TableRowMark rowMark = new TableRowMark(CollUtil.newArrayList(new CellMark(fieldName), new CellMark(type), new CellMark(comment)));
            tableMark.put(rowMark);
        }
        return tableMark;
    }

}

注释写法必须是/**多行注释的那种,例子:

@Data
/**
 * 测试用户
 */
public class User {
    
    /**
     * 姓名
     */
    public String name;
}

这里导出Markdown我用了大神写的代码:
https://gitee.com/ConanJordan/markdowncoffee
不过导出表格稍微有点Bug,自己改改就行了,就是那个表格头的下一行--- 那种,源代码只加了一列,需要自己改改代码,或者有时间提个merge吧。

©著作权归作者所有,转载或内容合作请联系作者
禁止转载,如需转载请通过简信或评论联系作者。
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 215,012评论 6 497
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,628评论 3 389
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 160,653评论 0 350
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,485评论 1 288
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,574评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,590评论 1 293
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,596评论 3 414
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,340评论 0 270
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,794评论 1 307
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,102评论 2 330
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,276评论 1 344
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,940评论 5 339
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,583评论 3 322
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,201评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,441评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,173评论 2 366
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,136评论 2 352

推荐阅读更多精彩内容