浅析Android Gradle Plugin处理module-info.class报错原因及解决方案

2023-10-17 09:59:21

前言

随着Kotlin在Android开发中的日益普及，开发者们不可避免地会遇到与Kotlin相关的Gradle构建问题。其中，处理module-info.class文件时出现的报错尤为常见。本文将深入剖析这类报错的原因，并提出实用的解决方案，助力开发者轻松解决这一难题。

报错详情

当Gradle Plugin尝试处理module-info.class文件时，可能会抛出以下异常：

java.lang.NoClassDefFoundError: [module-info class]

该异常通常伴随着如下错误信息：

java.lang.UnsupportedClassVersionError: [module-info class]

问题根源

上述报错的根本原因在于版本冲突 。module-info.class文件是由Java 9引入的，而某些Gradle Plugin（例如asm和javassist）可能无法识别或处理此类文件。当这些插件尝试操作module-info.class时，便会引发上述异常。

解决方案

解决这一问题有多种方法，具体取决于使用的Gradle Plugin：

1. 升级Gradle Plugin

最新版本的Gradle Plugin通常能够正确处理module-info.class文件。因此，升级Gradle Plugin至最新版本是一个可行的解决方案。

2. 配置Gradle脚本

在Gradle脚本中添加以下配置可以解决该问题：

android.buildFeatures.buildConfig = false

此配置会禁用BuildConfig类的生成，从而避免Gradle Plugin处理module-info.class文件。

3. 使用兼容的插件

如果无法升级或修改Gradle脚本，可以使用兼容module-info.class文件的插件。例如：

ASM 9.3+
Javassist 3.28+

4. 排除有问题的依赖

如果依赖库中包含了引起冲突的插件，可以将该依赖排除在构建之外。在Gradle脚本中添加以下依赖排除语句即可：

dependencies {
  // 排除有问题的依赖
  implementation(exclude: [group: '...', module: '...'])
}

实例

以下是一个解决module-info.class处理错误的实际示例：

android.buildFeatures.buildConfig = false

dependencies {
  implementation 'com.android.support:support-v4:28.0.0'
  implementation 'com.google.code.gson:gson:2.8.6'
  // 排除asm依赖，解决java.lang.NoClassDefFoundError异常
  implementation(exclude: [group: 'org.ow2.asm', module: 'asm'])
}