Java 代码为外部库中的类抛出 NoClassDefFoundError

Question

我有一个 maven 项目，其中包含一个使用 gradle 作为 pom 依赖项创建的 jar。 在包含 Jar 的代码中，我引用了 log4j logmanager。 当我尝试访问外部 jar 中的方法时，它会在外部 jar 中的类所引用的 logmanager 上抛出 java.lang.NoClassDefFoundError。

外部 jar 的 build.gradle 是：

plugins {
    id 'java'
}

group 'com.somecompany.somethingelse'
version '1.0-SNAPSHOT'

sourceCompatibility = 1.8

repositories {
    mavenCentral()
}

dependencies {

    implementation group: 'org.apache.logging.log4j', name: 'log4j-api', version: '2.13.0'
    implementation group: 'org.apache.logging.log4j', name: 'log4j-core', version: '2.13.0'

}

我使用 gradle clean assemble 构建 jar

我使用 mvn install:install-file 将这个 jar 本地安装到 .m2 中，然后在 pom 中为消费应用程序添加它的依赖项。

我不确定这里发生了什么。

外部Jar类代码

package com.company.something;

import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;

public abstract class MyClass{

     private static Logger logger = LogManager.getLogger();

     public static String myMethod(String someInput){
         logger.info("entered myMethod");
         ......some code goes here.....

     }

}

Jar 消费类代码

import com.company.something.MyClass;

public class consumingClass{

   public String consumingMethod(){
      MyClass.myMethod("someinput");
      return "something";
    }
}

Answer 1

当您使用mvn install:install-file 时，您正在安装 jar 文件并使用纯 Maven 为其创建默认 pom。如果你不做任何其他事情，pom 将不包含任何传递依赖项。毕竟，Maven 只看到一个 jar 文件，对周围的 Gradle 脚本一无所知。这就是它在运行时失败的原因，因为库（“外部”）pom 中缺少 Log4J 依赖项。

您应该改为使用Maven Publish Plugin for Gradle 为您的库创建一个合适的 pom。通过添加来做到这一点：

plugins {
    id 'maven-publish'
}

publishing {
    publications {
        myLibrary(MavenPublication) {
            from components.java
        }
    }
}

然后，您可以使用 gradle publishToMavenLocal 将 jar 文件上传到带有完整 pom 的本地 .m2 存储库。

另外，ysakhno's answer 在编译类路径中不需要log4j-core 的部分是正确的——这只是不好的做法。相反，您应该要么 删除它并让使用项目将其添加为显式依赖项， 或 将配置从implementation 更改为runtimeOnly。这两种方法都很好，具体取决于您希望将 Log4j 与库耦合的紧密程度。

我还认为在库中使用 Log4J2 API 非常好，即使它可以在使用许多不同日志记录实现的项目中使用。毕竟，将 Log4J2 API 绑定到 SLF4J 就像反过来一样容易。两者都是受欢迎且非常好的选择。

Answer 2

你可能想添加这个 compile group: 'org.apache.logging.log4j', name: 'log4j-1.2-api', version: '2.2' 太 想法是您没有足够的依赖项来满足您的需求。它经常发生在记录器之类的东西上

参考： unexpected exception: java.lang.NoClassDefFoundError: org/apache/log4j/LogManager

Answer 3

一般来说，日志库有 2 个 JAR（就像您展示的示例一样）的原因是让库编译 仅针对库的 API JAR，然后工作（执行）在运行时，日志库的实际实现（在你的情况下是log4j-core）出现在消费应用程序的类路径的某个地方。

考虑到上述情况，您必须分离库和应用程序之间的依赖关系，即在库的build.gradle 中，您应该有这样的：

dependencies {

    implementation group: 'org.apache.logging.log4j', name: 'log4j-api', version: '2.13.0'
    // Note: you do not need the 'actual' implementation of Log4j in your library
    // at all!  It should compile very well with just the API, you'll then have
    // to put an 'implementation' dependency on log4j-core in your consuming
    // application's build.gradle (or pom.xml for that matter)

}

然后在你的应用程序的 pom.xml 中你必须把这个：

    <dependency>
        <groupId>org.apache.logging.log4j</groupId>
        <artifactId>log4j-core</artifactId>
        <version>2.13.0</version>
    </dependency>

如果您确实希望保留所有内容（强烈不推荐）并将库中的依赖项包含在消费应用程序中，请使用 api 依赖项配置而不是implementation 一。这是一个很好的StackOverflow answer explaining the difference between the two。

在旁注中，我建议让您的库不依赖于 Log4j 的 API，而是依赖于 Simple Logging Facade for Java 之一，因为这样消费应用程序可以选择使用哪个日志库实现。如SLF4J's FAQ中所述：

[...] 库和其他嵌入式组件应该考虑 SLF4J 满足他们的日志记录需求，因为图书馆负担不起 他们对最终用户的日志记录框架的选择。

注意：无论您选择做什么，都不要在 Gradle 构建脚本中使用 compile 依赖配置，因为它在一段时间前已被弃用，并且可能不适用于 Gradle 的未来版本。大致相当于compile的配置是api。