当前位置：首页 > news >正文

dexcount-gradle-plugin扩展开发：如何自定义计数规则和输出格式

news 2026/6/16 13:21:49

dexcount-gradle-plugin扩展开发：如何自定义计数规则和输出格式

【免费下载链接】dexcount-gradle-pluginA Gradle plugin to report the number of method references in your APK on every build.项目地址: https://gitcode.com/gh_mirrors/de/dexcount-gradle-plugin

dexcount-gradle-plugin是一款强大的Gradle插件，用于在每次构建时报告APK中的方法引用数量，帮助开发者监控应用大小增长并避免超过65,536方法限制。本指南将深入探讨如何扩展和自定义这款插件，实现个性化的计数规则和输出格式。

📊 插件核心功能与配置

Dexcount插件通过DexCountExtension提供丰富的配置选项。在app/build.gradle中，您可以这样配置：

dexcount { // 输出格式：LIST, TREE, JSON, YAML format = OutputFormat.JSON // 是否包含类级别的统计 includeClasses = false // 是否包含字段计数 includeFieldCount = true // 是否包含总方法数 includeTotalMethodCount = false // 按方法数量排序 orderByMethodCount = true // 最大包深度限制 maxTreeDepth = 3 // 构建失败阈值 maxMethodCount = 64000 }

🔧 自定义计数规则开发指南

1. 理解PackageTree数据结构

插件的核心是PackageTree类，它负责存储和管理方法、字段、类的计数信息。要自定义计数规则，首先需要了解这个数据结构：

层级结构：PackageTree使用树形结构组织包和方法数据
计数类型：支持DECLARED（声明）和REFERENCED（引用）两种计数方式
去混淆支持：内置Deobfuscator处理混淆后的类名

2. 扩展CountReporter类

CountReporter是生成报告的核心类。要自定义输出逻辑，可以继承并重写以下方法：

public class CustomCountReporter extends CountReporter { @Override public void report() throws IOException { // 自定义报告逻辑 printCustomSummary(); generateCustomOutput(); } private void printCustomSummary() { // 实现自定义摘要输出 logger.warn("自定义统计报告:"); logger.warn("总方法数: {}", packageTree.getMethodCount()); logger.warn("总字段数: {}", packageTree.getFieldCount()); // 添加自定义过滤逻辑 filterLargePackages(); } }

3. 实现自定义过滤规则

在PackageTree.java中，您可以添加自定义过滤方法：

public PackageTree filterByMethodCount(int minCount) { PackageTree filtered = new PackageTree(name, deobfuscator); for (Map.Entry<String, PackageTree> entry : children.entrySet()) { PackageTree child = entry.getValue(); if (child.getMethodCount() >= minCount) { filtered.children.put(entry.getKey(), child); } } return filtered; }

📝 自定义输出格式开发

1. 扩展OutputFormat枚举

当前插件支持四种输出格式：LIST, TREE, JSON, YAML。要添加新格式，需要扩展OutputFormat枚举：

public enum OutputFormat { LIST(".txt"), TREE(".txt"), JSON(".json"), YAML(".yml"), // 添加自定义格式 CSV(".csv"), HTML(".html"), XML(".xml"); private final String extension; OutputFormat(String extension) { this.extension = extension; } public String getExtension() { return extension; } }

2. 实现自定义输出生成器

创建自定义输出生成器类：

public class CustomOutputGenerator { private final PackageTree tree; private final PrintOptions options; public CustomOutputGenerator(PackageTree tree, PrintOptions options) { this.tree = tree; this.options = options; } public void generateCSV(Writer writer) throws IOException { writer.write("Package,Methods,Fields,Classes\n"); generateCSVRecursive(writer, tree, ""); } private void generateCSVRecursive(Writer writer, PackageTree node, String prefix) throws IOException { String fullName = prefix.isEmpty() ? node.getName() : prefix + "." + node.getName(); if (!node.getName().isEmpty()) { writer.write(String.format("%s,%d,%d,%d\n", fullName, node.getMethodCount(), node.getFieldCount(), node.getClassCount())); } for (PackageTree child : node.getChildren().values()) { generateCSVRecursive(writer, child, fullName); } } }

3. 集成到ReportOutputWorker

修改ReportOutputWorker以支持自定义格式：

private void actuallyExecute() throws IOException { TreeGenOutput treeGen = readTreeGenFile(); PackageTree tree = PackageTree.fromThrift(treeGen.tree); OutputFormat format = getParameters().getPrintOptions().get().getFormat(); switch (format) { case CSV: generateCSVOutput(tree); break; case HTML: generateHTMLOutput(tree); break; default: // 使用原有的CountReporter CountReporter reporter = new CountReporter( tree, getParameters().getVariantName().get(), LOGGER, getParameters().getPrintOptions().get(), treeGen.inputRepresentation, false); reporter.report(); } }

🎨 可视化输出示例

上图展示了Dexcount插件生成的环形旭日图，直观显示了不同包的方法分布情况。中心数字"8684"表示总方法数，不同颜色的区块代表不同的包或模块，区块大小对应方法数量的比例。

🛠️ 实战：创建自定义插件扩展

步骤1：创建扩展类

public class CustomDexCountExtension { private boolean includeThirdParty = false; private boolean groupByModule = true; private String customOutputPath = "build/reports/dexcount/custom"; // Getter和Setter方法 public boolean isIncludeThirdParty() { return includeThirdParty; } public void setIncludeThirdParty(boolean includeThirdParty) { this.includeThirdParty = includeThirdParty; } // 更多自定义配置... }

步骤2：修改任务配置

在DexCountOutputTask中集成自定义配置：

@Nested public abstract Property<CustomDexCountExtension> getCustomConfigProperty(); @TaskAction public void run() { PrintOptions opts = PrintOptions.fromDexCountExtension(getConfigProperty().get()) .withIsAndroidProject(getAndroidProject().get()); // 应用自定义配置 CustomDexCountExtension customConfig = getCustomConfigProperty().get(); if (customConfig != null) { opts = opts.withCustomOptions(customConfig); } // 继续原有逻辑... }

步骤3：配置build.gradle

dexcount { format = OutputFormat.JSON includeClasses = true includeFieldCount = true maxTreeDepth = 4 } customDexCount { includeThirdParty = true groupByModule = false customOutputPath = "build/custom-reports" }

📈 性能优化建议

1. 增量处理优化

在treegen/workers目录下的工作器类中，可以添加增量处理逻辑：

public class OptimizedAndroidWorker extends BaseWorker { @Override protected void processIncremental(File input, File output) { // 检查输入文件是否变化 if (!hasInputChanged(input)) { reusePreviousResults(output); return; } // 执行完整处理 super.process(input, output); } }

2. 内存优化策略

在PackageTree处理大量数据时，可以添加内存优化：

public class MemoryOptimizedPackageTree extends PackageTree { private final Map<String, SoftReference<PackageTree>> cache = new HashMap<>(); @Override public PackageTree getChild(String name) { SoftReference<PackageTree> ref = cache.get(name); PackageTree child = ref != null ? ref.get() : null; if (child == null) { child = super.getChild(name); cache.put(name, new SoftReference<>(child)); } return child; } }

🔍 调试与测试

单元测试示例

查看PackageTreeSpec.groovy了解如何测试自定义功能：

class CustomPackageTreeSpec extends Specification { def "测试自定义过滤功能"() { given: def tree = new PackageTree() // 构建测试数据 when: def filtered = tree.filterByMethodCount(100) then: filtered.children.size() == expectedCount filtered.methodCount >= 100 } }