使用可执行 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 清单文件中的类路径中：

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 文件的类路径中，还是存在问题。我编写我的 ant 文件以将库组合到我正在创建的单个 JAR 中的方式是成功复制目录和类文件，但由于某种原因没有复制其他类型，这显然也是必要的（例如 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 中指定的类路径会覆盖命令行中指定的任何类路径。

感谢您的回复，他们肯定帮助我走上了正确的道路，以找出我的错误。

Answer 1

Java 文档中没有很好/很明显地解释的是，如果您使用的是可执行 Jar，它将仅使用清单文件中指定的类路径。它不会监听-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

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

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

我有一个包，所以我需要指定“资源”文件夹的路径（在 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());  
 }

}

在我的课程开始时声明“logger”（但在我的 2 个 System.setProperty 语句之前没有调用“getLogger”）使我能够在其他方法中引用“logger”。我有义务初始化它，所以我选择了“null”，但后来用“getLogger”语句更新它 - 鉴于此，我不能使其成为“最终”（只能分配一次）但可以使其成为静态 -一个常量类变量。

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

1. log4j-api-2.6.2.jar

2. log4j-core-2.6.2.jar

Answer 3

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

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

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

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

...应该可以工作

Answer 4

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