简单吧，运行上面代码段就能自定义 javadoc 输出解析了。跑了下发现没问题，那就开始搞事情吧。
实现一个 gradle 插件进行 javadoc 自定义操作
这里我们为了简单和直接说明核心，所以打算实现一个检查 android、androidLibrary、java、javaLibrary 代码源文件中是否包含 javadoc @author 的插件，插件名称 gradle-javadoc-checker，具体完整插件源码可以访问https://github.com/yanbober/gradle-javadoc-checker获取。
注意：这部分内容需要你先对 gradle 插件开发比较熟悉才能看懂，所以建议先掌握所说的知识后进行研读。
添加依赖dependencies {
compile gradleApi()
compile ‘com.android.tools.build:gradle:3.1.0’
//tools.jar 的依赖
compile files(org.gradle.internal.jvm.Jvm.current().toolsJar)
}
编写自定义 javadoc 判断 @author 工具public class JavaDocReader {
private static RootDoc root;
//自定义 doclet
public static class CustomerDoclet {
public static boolean start(RootDoc root) {
JavaDocReader.root = root;
return true;
}
}
//tools.jar 中 javadoc 的封装
public static RootDoc process(String[] extraArges) {
List argsOrderList = new ArrayList<>();
argsOrderList.add("-doclet");
argsOrderList.add(CustomerDoclet.class.getName());
argsOrderList.addAll(Arrays.asList(extraArges));
String[] args = argsOrderList.toArray(new String[argsOrderList.size()]);
System.out.println(args);
Main.execute(args);
return root;
}
//tools.jar 中 javadoc 的封装
public static void process(List sourcePaths, List javapackages,
List excludePackages, String outputDir) throws Exception {
String paths = list2formatString(sourcePaths, “;”);
String includes = list2formatString(javapackages, “:”);
String excludes = list2formatString(excludePackages, “:”);
List argsOrderList = new ArrayList<>();
argsOrderList.add("-doclet");
argsOrderList.add(CustomerDoclet.class.getName());
if (paths != null && paths.length() > 0) {
argsOrderList.add("-sourcepath");
argsOrderList.add(paths);
}
argsOrderList.add("-encoding");
argsOrderList.add(“utf-8”);
argsOrderList.add("-verbose");
if (includes != null && includes.length() > 0) {
argsOrderList.add("-subpackages");
argsOrderList.add(includes);
}
if (excludes != null && excludes.length() > 0) {
argsOrderList.add("-exclude");
argsOrderList.add(excludes);
}
String[] args = argsOrderList.toArray(new String[argsOrderList.size()]);
System.out.println(Arrays.toString(args));
//执行 tools.jar 中的 javadoc 命令
Main.execute(args);
File file = new File(outputDir);
if (!file.exists()) {
file.mkdirs();
}
file = new File(file, new Date().toString() + “.txt”);
FileOutputStream outputStream = new FileOutputStream(file);
//判断每个顶级 java class 是否有编写 @author 人，没有就筛出来写入一个文件记录
ClassDoc[] classes = root.classes();
if (classes != null) {
for (int i = 0; i < classes.length; ++i) {
if (classes[i].containingClass() == null && classes[i].isPublic()) {
Tag[] authorTags = classes[i].tags(“author”);
if (authorTags == null || authorTags.length == 0) {
String filename = classes[i].position().file().getAbsolutePath();
outputStream.write((filename+"rn").getBytes());
}
}
}
}
root = null;
outputStream.flush();
outputStream.close();
}
private static String list2formatString(List srcs, String div) {
StringBuilder stringBuilder = new StringBuilder();
for (int index=0; index if (index > 0) { stringBuilder.append(div); } stringBuilder.append(srcs.get(index)); } return stringBuilder.toString(); } } 有了 javadoc 自定义工具类，接下来编写 gradle 自定义 task 即可。 //groovy 编写 class JavaDocCheckerTask extends DefaultTask { //自定义 task 的输入 @Input List includePackages @Input List excludePackages @Input List sourcePaths //自定义 task 的输出 @OutputDirectory String outputDir //自定义 task 的执行逻辑 @TaskAction void checker() { if (sourcePaths == null || sourcePaths.size() == 0) { throw new GradlescriptException(“JavaDocCheckerTask sourcePaths params can’t be null or empty!”) } if (outputDir == null || outputDir.length() == 0) { throw new GradlescriptException(“JavaDocCheckerTask outputDir params can’t be null or empty!”) } //task 依据输出输出参数进行 javadoc 命令操作 JavaDocReader.process(sourcePaths, includePackages, excludePackages, outputDir) } } 有了自定义 gradle task 进行 javadoc 操作，接下来就该接入插件了。 先定义插件的 extension 拓展参数： class CheckerExtension { public static final String NAME = “javadocChecker” List includePackages List excludePackages List sourcePaths String outputDirectory } 将拓展参数与 task 结合： class JavaDocCheckerPlugin implements Plugin { @Override void apply(Project project) { //插件添加自定义 extension project.extensions.create(CheckerExtension.NAME, CheckerExtension) //将自定义任务加入 project project.tasks.create(“javaDocChecker”, 《一线大厂Java面试题解析+后端开发学习笔记+最新架构讲解视频+实战项目源码讲义》 【docs.qq.com/doc/DSmxTbFJ1cmN1R2dB】 完整内容开源分享 JavaDocCheckerTask) //依据 apply 的是 java、androidlibrary、androidapplication 分别获取对应的拓展参数 JavaPluginConvention java = null baseExtension android = null if (project.plugins.hasPlugin(AppPlugin)) { android = project.extensions.getByType(AppExtension) } else if(project.plugins.hasPlugin(LibraryPlugin)) { android = project.extensions.getByType(LibraryExtension) } else if (project.plugins.hasPlugin(JavaPlugin)) { java = project.convention.getPlugin(JavaPluginConvention) } if (java == null && android == null) { throw new GradleException(“it’s a not support plugin type!”) } project.afterevaluate { afterevaluateInner(project, java, android) } } private void afterevaluateInner(Project project, JavaPluginConvention java, baseExtension android) { if (java != null) { //java 插件就进行 java 的 sourceSets 处理 processJava(project, java) } else if (android != null) {
