Log4j，配置Web App以使用相对路径

https://stackoverflow.com/questions/216781

03-07-2019
|

题

我有一个必须在Win或Linux机器上部署的java webapp。我现在想添加log4j用于日志记录，我想使用日志文件的相对路径，因为我不想在每次部署时更改文件路径。容器很可能是Tomcat，但不一定。

这样做的最佳方式是什么？

解决方案 2

我终于以这种方式完成了它。

添加了一个ServletContextListener，它执行以下操作：

public void contextInitialized(ServletContextEvent event) {
    ServletContext context = event.getServletContext();
    System.setProperty("rootPath", context.getRealPath("/"));
}

然后在log4j.properties文件中：

log4j.appender.file.File=${rootPath}WEB-INF/logs/MyLog.log

通过这样做，Log4j将写入正确的文件夹，只要您不在“rootPath”之前使用它。系统属性已设置。这意味着您无法从ServletContextListener本身使用它，但您应该能够在应用程序的任何其他位置使用它。

它应该适用于每个Web容器和操作系统，因为它不依赖于特定于容器的系统属性，并且不受操作系统特定路径问题的影响。使用Tomcat和Orion Web容器以及Windows和Linux进行测试，到目前为止工作正常。

您怎么看？

其他提示

Tomcat设置catalina.home系统属性。您可以在log4j属性文件中使用它。像这样：

log4j.rootCategory=DEBUG,errorfile

log4j.appender.errorfile.File=${catalina.home}/logs/LogFilename.log

在Debian（包括Ubuntu）上， $ {catalina.home} 将无效，因为它指向/ usr / share / tomcat6，它没有链接到/ var / log / tomcat6。这里只需使用 $ {catalina.base} 。

如果您使用其他容器，请尝试查找类似的系统属性，或定义您自己的属性。设置系统属性将因平台和容器而异。但是对于Linux / Unix上的Tomcat，我会在CATALINA_HOME / bin目录中创建一个setenv.sh。它将包含：

export JAVA_OPTS="-Dcustom.logging.root=/var/log/webapps"

然后你的log4j.properties将是：

log4j.rootCategory=DEBUG,errorfile

log4j.appender.errorfile.File=${custom.logging.root}/LogFilename.log

如果你使用Spring，你可以：

1）创建一个log4j配置文件，例如＆QUOT; /WEB-INF/classes/log4j-myapp.properties" 请勿将其命名为“log4j.properties”

示例：

log4j.rootLogger=ERROR, stdout, rollingFile

log4j.appender.stdout=org.apache.log4j.ConsoleAppender
log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
log4j.appender.stdout.layout.ConversionPattern=%d %p [%c] - <%m>%n

log4j.appender.rollingFile=org.apache.log4j.RollingFileAppender
log4j.appender.rollingFile.File=${myWebapp-instance-root}/WEB-INF/logs/application.log
log4j.appender.rollingFile.MaxFileSize=512KB
log4j.appender.rollingFile.MaxBackupIndex=10
log4j.appender.rollingFile.layout=org.apache.log4j.PatternLayout
log4j.appender.rollingFile.layout.ConversionPattern=%d %p [%c] - %m%n
log4j.appender.rollingFile.Encoding=UTF-8

我们将定义“myWebapp-instance-root”稍后点（3）

2）在web.xml中指定配置位置：

<context-param>
  <param-name>log4jConfigLocation</param-name>
  <param-value>/WEB-INF/classes/log4j-myapp.properties</param-value>
</context-param>

3）为您的网络应用根指定唯一变量名称，例如＆QUOT; myWebapp实例根＆QUOT;

<context-param>
  <param-name>webAppRootKey</param-name>
  <param-value>myWebapp-instance-root</param-value>
</context-param>

4）添加一个Log4jConfigListener：

<listener>
  <listener-class>org.springframework.web.util.Log4jConfigListener</listener-class>
</listener>

如果您选择其他名称，请记住在log4j-myapp.properties中更改它。

查看我的文章（仅限意大利语......但这应该是可以理解的）： http://www.megadix.it/content/configurare-path -relativi-log4j的-utilizzando弹簧

更新（2009/08/01） 我把文章翻译成英文： http://www.megadix.it/node/136

仅对 Iker 解决方案发表评论。

ServletContext 是一个很好的解决方案。但我不认为这对维护有好处。大多数时间日志文件都需要保存很长时间。

由于 ServletContext 使文件位于已部署的文件下，因此在重新部署服务器时将删除该文件。我的建议是使用rootPath的父文件夹而不是子文件夹。

如果未在FileAppender的path属性中指定根目录，log4j是否只使用应用程序根目录？所以你应该能够使用：

log4j.appender.file.File =日志/ MyLog.log

自从我完成Java Web开发以来已经有一段时间了，但这似乎是最直观的，也不会与写入$ {catalina.home} / logs目录的其他不幸的命名日志冲突。

作为对 https://stackoverflow.com/a/218037/2279200 的进一步评论 - 这可能会破坏，如果Web应用程序隐含地启动其他ServletContextListener，它可能先前被调用并且已经尝试使用log4j - 在这种情况下，log4j配置将在确定日志根目录的属性设置之前已经被读取和解析=＆gt;日志文件将出现在当前目录下的某个位置（启动tomcat时的当前目录）。

我只能想到以下解决方案来解决这个问题： - 将log4j.properties（或logj4.xml）文件重命名为log4j不会自动读取的内容。 - 在上下文过滤器中，在设置属性后，调用DOM / PropertyConfigurator帮助器类以确保读取log4j - 。{xml，properties} - 重置log4j配置（IIRC有一种方法可以做到这一点）

这是一种蛮力，但认为这是使其不漏水的唯一方法。

如果你正在使用Maven，我有一个很好的解决方案：

编辑pom.xml文件以包含以下行：

<profiles>
    <profile>
        <id>linux</id>
        <activation>
            <os>
                <family>unix</family>
            </os>
        </activation>
        <properties>
            <logDirectory>/var/log/tomcat6</logDirectory>
        </properties>
    </profile>
    <profile>
        <id>windows</id>
        <activation>
            <os>
                <family>windows</family>
            </os>
        </activation>
        <properties>
            <logDirectory>${catalina.home}/logs</logDirectory>
        </properties>
    </profile>
</profiles>

在这里，您可以专门为OS系列定义 logDirectory 属性。

在 log4j.properties 文件中使用已定义的 logDirectory 属性：

log4j.appender.FILE=org.apache.log4j.RollingFileAppender
log4j.appender.FILE.File=${logDirectory}/mylog.log
log4j.appender.FILE.MaxFileSize=30MB
log4j.appender.FILE.MaxBackupIndex=10
log4j.appender.FILE.layout=org.apache.log4j.PatternLayout
log4j.appender.FILE.layout.ConversionPattern=%d{ISO8601} [%x] %-5p [%t] [%c{1}] %m%n

就是这样！

P.S。：我确信这可以通过Ant来实现，但遗憾的是我没有足够的经验。

我的建议是日志文件应始终记录在webApp的根上下文之上，因此，如果我们重新部署webApp，我们不希望覆盖现有的日志文件。

我的解决方案类似于Iker Jimenez的解决方案，但不是使用 System.setProperty（... ）我使用 org.apache.log4j.PropertyConfigurator.configure（Properties）。为此，我还需要log4j无法自己找到它的配置，我手动加载它（Wolfgang Liebich的答案）。

这适用于Jetty和Tomcat，独立或从IDE运行，需要零配置，允许将每个应用程序的日志放在自己的文件夹中，无论容器内有多少个应用程序（ System 的/stackoverflow.com/questions/216781/log4j-configuring-a-web-app-to-use-a-relative-path#comment4207525_218037“>问题解）。这样，人们也可以将log4j配置文件放在Web应用程序内的任何位置（例如，在一个项目中，我们在 WEB-INF / 中包含所有配置文件）。

详细说明：

我在类路径中的 log4j-no-autoload.properties 文件中有我的属性（例如，在我的Maven项目中，它最初位于 src / main / resources 中，获取打包成 WEB-INF / classes ），

它将文件appender配置为例如：

log4j.appender.MyAppFileAppender = org.apache.log4j.FileAppender
log4j.appender.MyAppFileAppender.file = ${webAppRoot}/WEB-INF/logs/my-app.log
...

我有一个像这样的上下文监听器（使用Java 7的“try-with-resource”语法缩短了）：

@WebListener
public class ContextListener implements ServletContextListener {
    @Override
    public void contextInitialized(final ServletContextEvent event) {
        Properties props = new Properties();
        InputStream strm =
            ContextListener.class.getClassLoader()
                .getResourceAsStream("log4j-no-autoload.properties");
        try {
            props.load(strm);
        } catch (IOException propsLoadIOE) {
            throw new Error("can't load logging config file", propsLoadIOE);
        } finally {
            try {
                strm.close();
            } catch (IOException configCloseIOE) {
                throw new Error("error closing logging config file", configCloseIOE);
            }
        }
        props.put("webAppRoot", event.getServletContext().getRealPath("/"));
        PropertyConfigurator.configure(props);
        // from now on, I can use LoggerFactory.getLogger(...)
    }
    ...
}

您可以使用工作目录：

指定日志文件的相对路径

appender.file.fileName = ${sys:user.dir}/log/application.log

这与servlet容器无关，也不需要将自定义变量传递给系统环境。

许可以下： CC-BY-SA 和归因

不隶属于 StackOverflow