为什么更新Gradle break log4j导入？

编程问答 2022-08-14

问题描述

我正在尝试更新到Kotlin 1.4。在我的build.gradle文件中，我有以下内容：

buildscript {
    allprojects {
        ext {
            kotlin_version = "1.3.70"
            ktor_version = "1.2.2"
            junit_version = "5.4.2"
            log4j_version = "2.11.2"
            jackson_version = "2.9.9"
            kafka_version = "2.3.0"
        }
    }
    repositories {
        maven {
            url 'https://smartward.jfrog.io/smartward/gradle-dev'
            credentials {
                username = "${artifactory_user}"
                password = "${artifactory_password}"
            }
        }
    }


    dependencies {
        classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
        classpath "org.jfrog.buildinfo:build-info-extractor-gradle:4.9.7"
    }
}

及以后：

        implementation(
        "org.jetbrains.kotlin:kotlin-stdlib-jdk8:$kotlin_version","org.jetbrains.kotlin:kotlin-reflect:$kotlin_version","org.apache.logging.log4j:log4j-slf4j-impl:$log4j_version","org.apache.logging.log4j:log4j-api:$log4j_version",// For JSON mapping
        "com.fasterxml.jackson.module:jackson-module-kotlin:$jackson_version","com.fasterxml.jackson.datatype:jackson-datatype-jsr310:$jackson_version","com.fasterxml.jackson.dataformat:jackson-dataformat-yaml:$jackson_version","com.natpryce:konfig:1.6.10.0","org.apache.kafka:kafka-clients:$kafka_version","io.ktor:ktor-server-netty:$ktor_version","io.ktor:ktor-locations:$ktor_version","io.ktor:ktor-jackson:$ktor_version","io.ktor:ktor-client-core:$ktor_version","io.ktor:ktor-client-apache:$ktor_version","io.ktor:ktor-client-json:$ktor_version"
    )

我的第一步是将kotlin_version更改为“ 1.4.0”。运行构建脚本时，我被告知Gradle也需要更新。我这样做了，更改了gradle-wrapper.properties文件（如下所示）：

-distributionUrl=https\://services.gradle.org/distributions/gradle-4.10.3-all.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-5.3-all.zip

这现在意味着我的某些log4j导入不再起作用。即：

import org.apache.logging.log4j.core.Logger
import org.apache.logging.log4j.core.config.Configurator

我试图还原到Kotlin 1.3.70，而没有还原Gradle更新，并且问题仍然存在，所以我怀疑Gradle或我的构建脚本有问题，但是我不确定为什么或如何修复它。我还尝试将Gradle 6.6与org.jfrog.buildinfo：build-info-extractor-gradle的4.17.1版本一起使用，但是问题仍然存在。

解决方法

使用dependencyInsight查看出了什么问题

听起来好像正在发生的事情是最终使用的log4j版本不是您期望的版本。

依赖版本解析可能会变得非常复杂，尤其是当您有很多依赖时。不同的事物需要同一个依赖项的不同版本，但是Gradle必须选择一个最终会出现在类路径中的版本。通常，它将从已请求的所有版本中选择最新版本。

我有两个原因可以想到，升级Gradle可能会更改最终使用的log4j版本：

  • Gradle本身的某些功能可能会增加对log4j的依赖关系，并且现在可能会要求使用比较早的Gradle发行版中更高的版本。
  • 另一方面，在较新的Gradle版本中，解决版本冲突的方式实际上已经发生了微妙的变化。

幸运的是，Gradle为您提供了一些工具来帮助您了解正在发生的事情。我建议比较在更新Gradle版本之前和之后的以下命令的输出。

gradle dependencyInsight --dependency log4j

这将打印出使用log4j的所有内容的树状报告，并告诉您为什么选择了特定版本。可能需要一些时间来理解该报告，特别是如果报告很长，则值得仔细阅读。

使用platform约束来强制使用正确的版本

诸如log4j之类的项目由多个工件（log4j-api，log4j-core等）组成。解决构建中各种可传递依赖项版本的过程最终可能会引入彼此不匹配的版本。重要的是要确保所有工件都具有匹​​配的版本。

为帮助解决此问题，log4j提供了额外的“物料清单”工件log4j-bom。 BOM工件不包含任何代码，但它们指定依赖项列表以及应使用的版本。

从版本{5，Gradle lets you use BOM files开始，为一组依赖项建议或强制使用版本。应用这种“平台”依赖关系不会在您的构建中添加或删除任何实际的依赖关系，但是会影响或控制您已经拥有的依赖关系的版本。

在您的情况下，您可以将以下内容添加到依赖项中：

dependencies {
    implementation enforcedPlatform("org.apache.logging.log4j:log4j-bom:$log4j_version")
}

这会将log4j-bom添加为enforcedPlatform依赖项，保证，在您的应用程序中使用的 every log4j依赖项将始终具有您指定的版本。这是一个功能强大的工具，应该有助于确保您将来不会遇到此类问题。

,

根据official documentation of Log4j，您需要同时链接到log4j-api和log4j-core才能正确使用该软件包。

gradlekotlinkotlinlog4j2