Java 配置log4j日志文件路径 (附-获取当前类路径的多种操作)

Java 项目中少不了要和log4j等日志框架打交道, 开发环境和生产环境下日志文件的输出路径总是不一致, 设置为绝对路径的方式缺少了灵活性, 每次变更项目路径都要修改文件, 目前想到的最佳实现方式是: 根据项目位置自动加载并配置文件路径.

本文借鉴 Tomcat 的配置方式 “${catalina.home}/logs/catalina.out”, 通过相对路径的方式设置日志的输出路径, 有其他解决方案的小伙伴, 请直接评论区交流哦😯

# 设置要输出的日志的级别 - 注意: properties文件中的注释信息只能处于行首, 不要跟在行尾log4j.rootLogger=INFO,stdout,logfile### 输出到控制台, Java程序运行时的标准输出信息log4j.appender.stdout=org.apache.log4j.ConsoleAppenderlog4j.appender.stdout.Target=System.outlog4j.appender.stdout.layout=org.apache.log4j.PatternLayout# 2019-05-25 19:09:46log4j.appender.stdout.layout.ConversionPattern=%-d{yyyy-MM-dd HH:mm:ss} [%t] [%c] [%p] - %m%n### 输出到日志文件# 按天滚动生成, 不支持MaxFileSize, 而RollingFileAppender支持log4j.appender.logfile=org.apache.log4j.DailyRollingFileAppender# 项目的logs目录下# log4j.appender.logfile.File=${base.dir}/logs/elastic-server.loglog4j.appender.logfile.Append=true# 输出INFO及以上的日志, 按日期滚动就无须配置单个日志文件的最大体积了log4j.appender.logfile.Threshold=INFO# log4j.appender.logfile.MaxFileSize=100MBlog4j.appender.logfile.layout=org.apache.log4j.PatternLayoutlog4j.appender.logfile.layout.ConversionPattern=%-d{yyyy-MM-dd HH:mm:ss} [%t] [%c] [%p] - %m%n3 彻底解决痛点

3.1 单独的Java程序包 (非Java Web项目)

单独的Java程序包, 需要通过命令java -jar或java -cp的方式启动;

我们可以在启动命令中加入系统运行时变量, 在log4j加载配置文件之前通过System.getProperties('path')读取此变量, 即可实现灵活加载当前路径.

(1) 启动脚本设置:

假设当前项目的目录结构为:

/Projects/KafkaConsumer丨 bin 项目的启动脚本丨 conf 项目的配置文件丨 lib 项目的其他依赖包丨 bogs 项目的日志输出路径

启动脚本位于bin目录下, 内容示例如下:

# 获取当前脚本所处的目录, 然后进入其上级目录, 最后pwd输出该目录, 最终的结果是/Project/KafkaConsumerbase_dir=$(cd `dirname $0`; cd ..; pwd)# 获取Java运行程序的位置, 并指定主类java_bin=$(which java)main_class='org.shoufeng.elastic.ConsumerMain'# 通过-cp、扩展CLASSPATH、指定主类的方式启动项目, # 并通过“-D”的方式向此程序的运行时环境中设置当前项目的路径,# 即可在程序中通过System.getProperty('base.dir')获取此路径 nohup ${java_bin} -Dbase.dir=${base_dir} -cp ${CLASSPATH}:${base_dir}/conf:${base_dir}/lib/* ${main_class} >> /dev/null &

(2) Java程序读取变量:

实log4j的FileAppender本身支持动态设置文件路径, 如:

log4j.appender.logfile.File=${base.log}/logs/app.log

其中“${base.log}”是一个变量, 会被System Property中的base.log的值代替, 代码中的使用方式为:

public static void main(String[] args) { // 获取系统运行时变量中的日志文件的输出路径 // 此变量需要在启动命令中通过-D的方式设置 String baseDir = System.getProperty('base.dir'); if (baseDir == null) { // 开发环境中使用 baseDir = System.getProperty('user.dir'); System.setProperty('base.dir', baseDir); } log.info('==== 系统运行路径: ' + System.getProperty('base.dir') + ' ===='); // 其他处理逻辑......}

需要注意的是, 这种方式设置的环境变量只在当前Java进程(也就是当前项目)中有效, 并不会影响到其他项目.

3.2 Web项目

如果是Web项目, 可通过修改Web容器的环境变量方式实现. 以 Tomcat 为例:

# log4j的配置文件支持服务器的vm环境变量, 格式类似${catalina.home} log4j.appender.R=org.apache.log4j.RollingFileAppender log4j.appender.R.File=${catalina.home}/logs/logs_tomcat.log log4j.appender.R.MaxFileSize=100MB

${catalina.home}是在${tomcat_home}/bin/catalina.sh中通过-D参数设置的:

-Dcatalina.home='$CATALINA_HOME'

基于这个思路, 我们也可以向Web容器的VM参数中设置一个参数, 比如-Dmylog.home='/Project/logs', 创建日志对象时即可使用.

public static void main(String[] args) { // 获取 class 文件的绝对路径, 定位到具体的包名, 结果如: // /Projects/KafkaConsumer/target/classes/org/shoufeng/consumer/ System.out.println(KafkaConsumer.class.getResource('')); // 获取 class 文件的绝对路径, 如: /Projects/KafkaConsumer/target/classes/, // 如果在bin目录下通过java -jar等命令启动时, 结果就是 /Projects/KafkaConsumer/bin/ System.out.println(ClassLoader.getSystemResource('')); System.out.println(KafkaConsumer.class.getResource('/')); System.out.println(KafkaConsumer.class.getClassLoader().getResource('')); System.out.println(Thread.currentThread().getContextClassLoader().getResource('')); // 说明: 上述4种用法的返回结果类型都是URL, 其toString()返回的内容以'file:'开头, 可通过“.toString().substring(5)”去除 // 推荐: 使用“.getPath()”就可以直接获取到路径 // 获取工程的绝对路径, 如: /Projects/KafkaConsumer, // 若在bin中通过java -jar等命令启动, 路径就变成了: /Projects/KafkaConsumer/bin System.out.println(System.getProperty('user.dir'));}

补充知识：在web中使用log4j时，配置日志文件的存放位置

废话不多说，直接上代码。

log4j.properties配置如下

log4j.rootLogger = info,out1,out2log4j.appender.out1=org.apache.log4j.FileAppenderlog4j.appender.out1.File=test.loglog4j.appender.out1.layout=org.apache.log4j.PatternLayoutlog4j.appender.out1.layout.ConversionPattern=%d %-5p - %m at %l%nlog4j.appender.out2=org.apache.log4j.ConsoleAppenderlog4j.appender.out2.layout=org.apache.log4j.PatternLayoutlog4j.appender.out2.layout.ConversionPattern=%d %-5p - %m at %l%n

问题一：这个test.log文件会存放在哪呢？

经测试发现，test.log这个相对路径相对的是user.dir系统参数的值。

假如我的tomcat的安装路径为D:apache-tomcat-6.0.16，则user.dir=D:apache-tomcat-6.0.16bin，当不确定时，我们可以用System.getProperties()将所有的系统参数在jsp中打印出来。

问题二：

如果我们将test.log改为绝对路径/test.log，这个test.log文件又会存放在哪呢？

经测试发现，/test.log这个绝对路径的根路径是user.dir系统参数的根路径，即test.log会存放在D:test.log。

补充：

我们在log4j.properties文件中还可以通过${系统参数}的方式来指明日志文件存放路径。

如

log4j.appender.out1.File=${user.dir}/logs/test.log

以上这篇Java 配置log4j日志文件路径 (附-获取当前类路径的多种操作)就是小编分享给大家的全部内容了，希望能给大家一个参考，也希望大家多多支持好吧啦网。