JUnit 5在Android项目中处理重复LICENSE.md文件冲突的解决方案

在Android开发中使用JUnit 5进行单元测试时，开发者可能会遇到一个常见的构建错误：多个JAR文件中包含相同路径的META-INF/LICENSE.md文件导致构建失败。这个问题通常发生在使用Android Studio Koala版本和较新版本的AGP(Android Gradle Plugin)时。

问题现象

当项目依赖了JUnit 5相关库(如junit-jupiter-api、junit-jupiter-engine等)时，Gradle构建过程会报错，提示发现了7个相同路径的META-INF/LICENSE.md文件。这些文件来自JUnit 5的不同模块，包括：

• junit-jupiter
• junit-jupiter-engine
• junit-jupiter-params
• junit-jupiter-api
• junit-vintage-engine
• junit-platform-engine
• junit-platform-commons

问题原因

这个问题本质上是Android构建系统对重复资源文件的严格检查机制导致的。虽然多个JAR文件包含相同的许可证文件在Java生态中很常见(因为每个模块都需要包含自己的许可证信息)，但Android的构建系统默认不允许这种情况。

解决方案

方法一：在Gradle中排除冲突文件

在模块级的build.gradle文件中添加以下配置：

android {
    packagingOptions {
        exclude 'META-INF/LICENSE.md'
        exclude 'META-INF/LICENSE-notice.md'
    }
}

这个配置告诉Android构建系统在合并资源时忽略这些特定的许可证文件。

方法二：使用pickFirst选择第一个匹配文件

如果确实需要保留许可证文件，可以使用pickFirst选择第一个遇到的副本：

android {
    packagingOptions {
        pickFirst 'META-INF/LICENSE.md'
    }
}

方法三：升级依赖版本

检查是否有更新的JUnit 5版本可用，有时新版本可能已经解决了这类打包问题。

注意事项

1. 在应用这些解决方案后，建议执行一次干净的构建(clean + rebuild)以确保更改生效。

2. 如果项目中使用ProGuard或R8进行代码混淆，排除这些文件不会影响最终APK的功能性，因为这些只是许可证文本文件。

3. 对于库模块开发者，建议在发布库时考虑使用不同的许可证文件命名方式，避免与其他库冲突。

深入理解

这个问题实际上反映了Java/Android生态系统中模块化设计的一个小挑战。每个JUnit 5模块都是独立开发和发布的，因此都包含了自己的许可证文件。在传统的Java应用中，类加载器可以很好地处理这种情况，但Android的打包机制更加严格，需要显式处理这种重复。

理解这个问题的本质有助于开发者更好地处理类似情况，不仅限于JUnit 5，其他库的类似问题也可以采用相同的解决思路。