主要内容:
- logback的简单配置和使用
- 如何通过程序动态设置log的文件名称(或者说如何在logback的配置文件中使用程序代码中定义的变量)
首先添加logback的依赖:
compile group: 'org.slf4j', name: 'slf4j-api', version: '1.7.21'
compile group: 'ch.qos.logback', name: 'logback-classic', version: '1.1.7'
compile group: 'ch.qos.logback', name: 'logback-core', version: '1.1.7'
- logback-classic.jar (依赖logback-core.jar,如果用maven等能够自动处理依赖的工具可以不用引入core包)
- slf4j-api.jar (如果应用中使用slf4j API而不是logback自身的api才需引入)
配置文件logback.xml
在与java文件夹同一目录下建立resources文件夹,在里面创建logback.xml作为logback的配置文件
<?xml version="1.0" encoding="UTF-8"?>
<configuration>
<!-- 定义日志文件 输入位置${app.workdir}/log -->
<property name="log_dir" value="log" />
<!-- 日志最大的历史 30天 -->
<property name="maxHistory" value="30"/>
<!-- Send debug messages to System.out -->
<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
<!-- By default, encoders are assigned the type ch.qos.logback.classic.encoder.PatternLayoutEncoder -->
<encoder>
<pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{5} - %msg%n</pattern>
</encoder>
</appender>
<!-- Send debug messages to a file at "c:/jcg.log" -->
<appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
<encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
<Pattern>%d{yyyy-MM-dd_HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</Pattern>
</encoder>
<!-- 过滤器,只记录DEBUG级别的日志 -->
<filter class="ch.qos.logback.classic.filter.LevelFilter">
<level>DEBUG</level>
<onMatch>ACCEPT</onMatch>
</filter>
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<!--日志输出位置 可相对、和绝对路径 -->
<fileNamePattern>${log_dir}/%d{yyyy-MM-dd}/${m_job_id}-${business_line}-%d{yyyyMMddHHmmss}.log</fileNamePattern>
<!-- 可选节点,控制保留的归档文件的最大数量,超出数量就删除旧文件假设设置每个月滚动,且<maxHistory>是6,
则只保存最近6个月的文件,删除之前的旧文件。注意,删除旧文件是,那些为了归档而创建的目录也会被删除-->
<maxHistory>${maxHistory}</maxHistory>
</rollingPolicy>
<triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
<MaxFileSize>2MB</MaxFileSize>
</triggeringPolicy>
</appender>
<!-- By default, the level of the root level is set to DEBUG -->
<root level="DEBUG">
<appender-ref ref="STDOUT" />
<appender-ref ref="FILE" />
</root>
</configuration>
最上面的property定义了一些变量,底下可以使用,比如${log_dir}
的内容是log
。
然后设置了一个输出到控制台的appender的格式
然后设置了输出到文件的格式
这里设置的东西相对就多一些:filter
只输出debug级别的日志。rollingPolicy
定义了每一个log的文件名称,以及每一个log文件最大历史。
’triggeringPolicy’定义了单个文件最大为2M。
在java文件中获取log
public class LogUtils {
public static final String TAG_DEVICE_ID = "device_id";
public static final String TAG_BUSINESS_LINE = "business_line";
public static final String TAG_JOB_ID = "m_job_id";
// public static Logger getLoggerByName(String name) {
// return LoggerFactory.getLogger(name);
// }
public Logger getLogger(String deviceId, String businessLine, String jobId) {
System.setProperty(TAG_DEVICE_ID, deviceId);
System.setProperty(TAG_BUSINESS_LINE, businessLine);
System.setProperty(TAG_JOB_ID, jobId==null?"":jobId);
LoggerContext lc = (LoggerContext) LoggerFactory.getILoggerFactory();
ContextInitializer ci = new ContextInitializer(lc);
lc.reset();
try {
ci.autoConfig();
} catch (JoranException e) {
e.printStackTrace();
}
return lc.getLogger(deviceId+"/"+businessLine);
}
}
可以简单的通过LoggerFactory.getLogger(name);来获取到log,从而记录日志
或者麻烦一点用第二种方式去创建log。
如何设置一些变量作为log文件名称?
比如这里
<fileNamePattern>${log_dir}/%d{yyyy-MM-dd}/${m_job_id}-${business_line}-%d{yyyyMMddHHmmss}.log</fileNamePattern>
用到了两个变量”m_job_id”和”business_line”但是并没有在property中定义它,也不是可以直接使用的时间戳。
其实我们在获取logger之前设置了几个systemproperty,而名称就是我们上面用到的”m_job_id”和”business_line”
System.setProperty(TAG_DEVICE_ID, deviceId);
System.setProperty(TAG_BUSINESS_LINE, businessLine);
System.setProperty(TAG_JOB_ID, jobId==null?"":jobId);
这样也可以在配置文件中使用这些变量,从而达到在程序初始化的时候自定log文件名的目的。