Log4j2 api 在 OSGi 环境中找不到 Log4j2 核心

Log4j2 api cannot find Log4j2 core in OSGi environment

我正在尝试使用 log4j2 OSGi 包,但 log4j2 api 似乎无法在 OSGi 环境中找到 log4j2 核心。我不断收到以下异常:

ERROR StatusLogger Log4j2 could not find a logging implementation. Please add log4j-core to the classpath. Using SimpleLogger to log to the console

我发现在几个地方讨论过相同的异常,但我仍然无法弄清楚这个问题。我怀疑我遇到这个问题是因为 log4j2 api 在 log4j2 核心的 META-INF 目录中找不到 log4j-provider.properties。 有什么线索为什么我会收到这个异常,我该如何纠正这个问题? (如果有人有添加 log4j 依赖项和捆绑的正确 pom 文件,请与我分享)

这些是我用过的依赖

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

我使用 apache felix 作为捆绑插件。发生此错误是因为 log4j2-core 的 META-INF 中的资源,特别是 log4j-providoer.properties 文件对 log4j api.

不可见

谢谢!

Log4j 不适合 OSGi 环境。幸运的是,替换 pax-logging 有一个很好的下降。在您的包中,您使用 log4j api 或任何其他受支持的 apis(我更喜欢 slf4j-api)。然后将 pax 日志记录部署到 OSGi 框架和捆绑包。 您可以使用标准 log4j 配置配置 pax 日志记录。所以它非常容易使用。如果你想要一个非常简单的开始,你可以简单地安装 apache karaf 并将你的包部署到它。 Karaf 已经包含一个完全设置的 pax 日志记录。

尝试将 jar 文件的名称更改为不包含核心词的内容(例如:log4j-zore),然后重试

您需要在 META-INF/MANIFEST.MF 中指定与您的包相关的 OSGI 依赖项,方法是添加以下依赖项:

Require-Bundle: org.apache.logging.log4j.core;org.apache.logging.log4j.api

当 Activator 启动并开始搜索日志插件时,log4j-core bundle 注册一个 bundle listener,如果找到某些东西,它会执行一系列类似于通常的 Logger 初始化的操作(不是真正惯用的 OSGi 东西,我我不确定它是否有效,但它似乎至少设置了 Log4jContextSelectorLoggerContextFactory),只是为了确定它,你是否安装了 启动log4j-core bundle 并验证没有任何改变?

更新:

我做了一些测试,发现对于 log4j2 OSGi 问题什么是可以接受的 solution/workaround。但正如其他人所推荐的那样,我也可以使用 slf4j、pax-logging 或简单的 OSGi 日志服务(最简单的一种)。

@Grant,你有两件事需要修复:

1. 如您所述,"Log4j2 could not find a logging implementation" 错误是由于 log4j2-api 包无法找到 log4j-provider.properties文件,修复后,log4j2-api找不到log4j2-core类(这是一个不同的包,log4j2-api 没有特定的导入包:对于那些 类)。

解决方法是为 log4j2-api(我将我的 log4j 命名为 log4j-api-config.jar)使用 [=22= 中的 .properties 文件创建一个小片段包] 和强制动态导入的清单:

    Manifest-Version: 1.0
    Bundle-ManifestVersion: 2
    Bundle-Name: Log4j API configurator
    Bundle-SymbolicName: org.apache.logging.log4j.apiconf
    Bundle-Version: 1.0.0
    Bundle-Vendor: None
    Bundle-RequiredExecutionEnvironment: OSGi/Minimum-1.2
    Fragment-Host: org.apache.logging.log4j.api
    DynamicImport-Package: *

我在此处导入 *,您可以改进它,添加 log4j2-api 需要的 log4j2-core 包的必需子集。

有了这个,那个错误就会消失,但是 log4j 会注意到你没有提供 log4j2 配置文件,接下来要修复(只有你关心这种情况)。

2.此时Felix会显示:

log4j2.xml not found by org.apache.logging.log4j.core
ERROR StatusLogger No log4j2 configuration file found. Using default configuration: logging only errors to the console.

而且我想您可能想要添加自己的 log4j2.xml 而不会弄乱原来的 log4j2-core.jar。您可以创建另一个片段包,这次由 log4j2-core 托管,根目录中只有一个 log4j2.xml 配置文件和一个简单的清单:

Manifest-Version: 1.0
Bundle-ManifestVersion: 2
Bundle-Name: Log4j Core configurator
Bundle-SymbolicName: org.apache.logging.log4j.coreconf
Bundle-Version: 1.0.0
Bundle-Vendor: None
Bundle-RequiredExecutionEnvironment: OSGi/Minimum-1.2
Fragment-Host: org.apache.logging.log4j.core

我在测试期间使用了这个简单的 log4j2.xml 配置:

<?xml version="1.0" encoding="UTF-8"?>
<Configuration status="INFO">
  <Appenders>
    <Console name="Console" target="SYSTEM_OUT">
      <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n"/>
    </Console>
  </Appenders>
  <Loggers>
    <Root level="info">
      <AppenderRef ref="Console"/>
    </Root>
  </Loggers>
</Configuration>

有了这个,您将不再需要下面描述的那种 "bridge" 包,您只需要一个简单的 Import-Package: org.apache.logging.log4j 来使用包中的 log4j。

更新二:

重要的是要注意这两个片段不是原始包的依赖项(不需要修改 log4j jar 甚至你的包来添加 import/export),所以原始包和你自己的自定义包将保持不变。 此外,它们也不依赖于原始包,它们只是带有清单和附加文本文件的基本 jar 存档,没有代码,不需要 Import-Package 或 Export-Package。

您只需在安装主机包后安装每个片段。

我从一个空 jar 开始手动创建了两个片段,然后在存档中复制属性文件并使用文本编辑器修改 MANIFEST.MF,你可以用这个 pom.xml 创建它们,记得把log4j-provider.properties复制到pom.xml所在的地方。

对于 log4j2-api 片段:

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>my.group</groupId>
    <artifactId>log4j2-api-config</artifactId>
    <version>1.0</version>
    <name>log4j2-api-config</name>
    <packaging>bundle</packaging>
    <properties>
        <java-version>1.7</java-version>
    </properties>

    <dependencies>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.felix</groupId>
                <artifactId>maven-bundle-plugin</artifactId>
                <version>2.0.0</version>
                <extensions>true</extensions>
                <configuration>
                    <instructions>
                        <Bundle-SymbolicName>org.apache.logging.log4j.apiconf</Bundle-SymbolicName>
                        <Bundle-Name>Log4j API Configurator</Bundle-Name>
                        <Bundle-Version>1.0.0</Bundle-Version>
                        <Fragment-Host>org.apache.logging.log4j.api</Fragment-Host>
                        <DynamicImport-Package>
                            *;resolution:=optional
                        </DynamicImport-Package>
                    </instructions>
                </configuration>
            </plugin>
        </plugins>
        <resources>
            <resource>
                <directory>.</directory>
                <includes>
                    <include>log4j-provider.properties</include>
                </includes>
                <targetPath>META-INF</targetPath>
            </resource>
        </resources>
    </build>
</project>

在适当的地方修改此 pom(包括文件、包名称)以生成另一个具有 log4j2-core 配置的 pom。

对我来说,这个错误是通过以下方式解决的:

  • 确保 log4j-api 包在调用记录器之前实际激活 - 而不仅仅是解析。我通过将其设置为低启动级别的自动启动来做到这一点。
  • 让 log4j-api 导入 log4j-core 的 类(如 @uraime 所述)以确保它找到 log4j-core。最干净的方法是使用片段。除了动态导入,您还可以将其添加到清单中:

    要求包:org.apache.logging.log4j.core

我还使用了 log4j-core 的片段让它找到我的 log4j2.xml 配置文件,但是当不使用这个片段时,log4j 会显示不同的错误消息。

此外,我发现不需要激活 log4j-core 包(仅已解决),但请注意,这确实意味着 Activator 无法找到自定义 log4j2 插件。