使用可执行 JAR 时指定 Log4j2 配置文件

Question

我在使用可执行 JAR 文件时无法指定 Log4j2 配置文件位置。如果我将所有 JAR 分开，它工作正常，但是当我尝试将它们组合成一个可执行 JAR 文件时，由于某种原因，log4j2.xml 文件没有从命令行中获取。

我试过这两种指定位置的方法：

java -Djava.libary.path=..\bin -cp ..\config -jar MyApplication.jar

java -Djava.libary.path=..\bin -Dlog4j.configurationFile=..\config\log4j2.xml -jar MyApplication.jar

这些都不起作用。我还尝试将包含配置文件的目录添加到 JAR 清单文件中的 class 路径：

Manifest-Version: 1.0
Ant-Version: Apache Ant 1.9.2
Created-By: 1.7.0_21-b11 (Oracle Corporation)
Main-Class: com.abc.MyApplication
Class-Path: ../config/

我用这个方法也没有成功。知道我可能做错了什么吗？

在此先感谢您的帮助！

编辑

啊，我相信我弄错了问题。最初，这是我在命令行输出中看到的错误：

ERROR StatusLogger No log4j2 configuration file found. Using default configuration: logging only errors to the console.

但是在我更改内容的某个时候，错误消息在我没有意识到的情况下更改为：

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

所以我发现即使我正在构建的可执行 JAR 包含 log4j-core-2.1.jar 和 log4j-api-2.1.jar JAR 并且在 MANIFEST 文件的 class路径，有问题。我编写 ant 文件以将库合并到我创建的单个 JAR 中的方式成功地复制了目录和 class 文件，但由于某种原因没有复制其他类型，这显然也是必要的（例如 Log4j-config.xsd、Log4j-events.dtd 等）。

为了解决这个问题，我将在 Ant 构建文件中合并 JAR 的方式更改为：

<jar destfile="${dist}/${jarName}" basedir="${classes}" 
    excludes=".svn">

    <!-- Merge this JAR with all the JARs in the lib directory, so that
    we are only creating one distribution JAR that includes all the
    libraries that you need. -->
    <fileset dir="${classes}" includes="**/*.class" />
    <zipgroupfileset dir="${lib}" includes="**/*.jar" />

    <!-- Specify the manifest file of the JAR -->
    <manifest>
        <attribute name="Main-Class" value="com.abc.MyApplication"/>
        <attribute name="Class-Path" value=". ${manifest.classpath}"/>
    </manifest>
</jar>

这解决了问题并将所有文件从 JAR 复制到我新创建的 JAR 中。

解决此问题后，我在上面发布的第二条命令用于指定配置文件的位置。（正如下面 @rewolf 所指出的，第一个命令将不起作用，因为在 JAR 的 MANIFEST 中指定的 classpath 覆盖了命令行中指定的任何 classpath .

感谢您的回复，他们确实帮助我走上了纠正错误的正确道路。

Answer 1

在 Java 文档中没有非常 well/obviously 解释的是，如果您使用的是可执行 Jar，它将仅使用指定的 Class-Path在清单文件中。它不会听取 -cp 或 --classpath 参数。

-Dlog4j.configurationFile=directory/file.xml

不过应该绝对有效。鉴于您的斜线方向，我假设您在 Windows 上运行。您确定运行它来自正确的相对目录吗？

更新

我刚刚在 Windows 中尝试过，没有任何问题。我使用了以下清单：

Manifest-Version: 1.0
Built-By: andrew.flower
Build-Jdk: 1.7.0_67
Class-Path: lib/log4j-api-2.1.jar lib/log4j-core-2.1.jar
Created-By: Apache Maven 3.2.3
Main-Class: com.andrew_flower.test.Log4jTest
Archiver-Version: Plexus Archiver

Log4j2 jar 位于 lib/ 目录中，log4j2.xml 位于 conf/ 目录中。我执行了以下命令，成功找到了配置。

java -Dlog4j.configurationFile=conf\log4j2.xml -jar log4j2test1-1.0-SNAPSHOT.jar

Answer 2

对于可能遇到此问题的其他人...

确保您的 -Dlog4j.configurationFile 选项出现在之前您的 '-jar' 而不是之后。可能看起来很明显，但曾经看到过这个错误。
尝试将文件位置视为 url 并查看是否可行。 IE。使用 %20 等转义空格。还可以使用 'file://path'，将反斜杠替换为正斜杠。
Windows路径可以写成file://c:/path/to/log4j2.xml

因此，如果您在 C:\Program Files\ExampleApp 中的 exampleApp 的程序文件夹中有一个 log4j2.xml，那么...

java.exe -Dlog4j.configurationFile=file://c:/program%20files/exampleapp/log4j2.xml -jar exampleApp.jar ...

...应该有效

Answer 3

我解决了在我从 Eclipse 创建的可运行 Jar 中指定 log4j2 配置位置的问题，方法是将其包含在我的 java 代码中：

System.setProperty("log4j.configurationFile", "resources/log4j2.xml");

我有一个包，所以我需要指定 "resources" 文件夹的路径（在 Eclipse 中的 "src" 文件夹中）：

System.setProperty("log4j.configurationFile", "com/company/app/resources/log4j2.xml");

注意我没有在我的路径中包含 "src"，我认为这是 "bin" 文件夹中的路径是必需的：即在我的例子中 "com/company/app/resources/log4j2.xml"

我的配置文件如下所示：

<?xml version="1.0" encoding="UTF-8"?>
<Configuration> 

<appenders>

<Console name="Console" target="SYSTEM_OUT">
  <PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level - %msg%n"/>  
</Console>

<RollingFile 
        name="RollingFile" 
        fileName="${sys:logFilename}"
        filePattern="${sys:logFilename}-%d{yyyy-MM-dd}-%i.log"> 
  <PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss.SSS} [%t] %-5level - %msg%n"/>      
  <Policies>
    <SizeBasedTriggeringPolicy size="1 MB"/>
  </Policies>  
  <DefaultRolloverStrategy max="10"/> 
</RollingFile>

</appenders> 


<loggers>     
 <root level="all">
  <appender-ref ref="Console"/>      
  <appender-ref ref="RollingFile"/> 
 </root>    
</loggers>

另请注意，我通过将其包含在我的 java 代码中来动态分配滚动日志文件路径 + 名称“${sys:logFilename}”：

System.setProperty("logFilename", "logs/myApp.log");

为了让这 2 个动态 System.setProperty 赋值工作，它们需要在 "getLogger" 语句之前执行，因此我的 java 代码如下所示：

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

public class MyTestLoggingClass {

 public static Logger logger = null;

 ...................
 setUpLogging();
 ...............

 public static void setUpLogging() {
    System.setProperty("log4j.configurationFile",  "com/company/app/resources/log4j2.xml");
    System.setProperty("logFilename", "logs/myApp.log");

    logger = LogManager.getLogger(Logger.class.getName());  
 }

}

在 class 的开头声明 "logger"（但在我的 2 System.setProperty 语句之前不调用 "getLogger"）使我能够引用 "logger"在其他方法中。我不得不初始化它，所以我选择了 "null" 但后来用 "getLogger" 语句更新它 - 鉴于此我不能做到 "final" （只能分配一次）但可以将其设为静态 - 一个常量 class 变量。

nb 我在构建路径中包含的 2 个 log4j2 jar 是：

log4j-api-2.6.2.jar
log4j-core-2.6.2.jar

Answer 4

我在使用 Log4j2 2.8 版时遇到了这个问题。当相应的 Log4j2 jar 被替换为 Log4j2 的 2.6 版时，这就消失了。

使用可执行 JAR 时指定 Log4j2 配置文件

Specifying Log4j2 Configuration File When Using Executable JAR

java

logging

executable-jar

log4j2