logback系列之三:输出日志到文件(滚动)
logback系列之三:输出日志到文件(滚动)
小代码2016 发表于2年前
logback系列之三:输出日志到文件(滚动)
  • 发表于 2年前
  • 阅读 314
  • 收藏 0
  • 点赞 1
  • 评论 0

标题:腾讯云 新注册用户域名抢购1元起>>>   

实际生产中,每天都有大量的日志生成,单个文件(FileAppender)已经不能满足要求,RollingFileAppender继承了FileAppender,并提供了更多的功能: 
  • 每天生成一个日志文件
  • 将前一天的日志重命名为包含日期的格式
  • 根据需要,删除过期历史日志

配置  

logback系列之二:输出日志到文件 类似,改动的地方: 

1. logback[-test].xml文件:  
Java代码   收藏代码
  1. <appender name="rollingAppender" class="ch.qos.logback.core.rolling.RollingFileAppender">  
  2.     <file>/logs/heuristic.log</file>  
  3.     <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">  
  4.         <fileNamePattern>/logs/heuristic-%d{yyyy-MM-dd}.log</fileNamePattern>  
  5.         <maxHistory>30</maxHistory>  
  6.     </rollingPolicy>  
  7.     <encoder><!-- 必须指定,否则不会往文件输出内容 -->  
  8.         <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{5} - %msg%n</pattern>  
  9.     </encoder>  
  10.     <append>false</append>  
  11.     <prudent>false</prudent>  
  12. </appender>  
  13.   
  14. <root level="DEBUG">  
  15.     <appender-ref ref="rollingAppender" />  
  16. </root>  


调用测试类的方法,生成heuristic-2013-11-16.log文件。 


源码分析  

a. 如果指定了file属性,当天的文件名为file属性值(/logs/heuristic.log):  

ch.qos.logback.core.rolling.RollingFileAppender类  
Java代码   收藏代码
  1. public void start() {  
  2.     ...  
  3.     currentlyActiveFile = new File(getFile()); // 获取日志文件名  
  4. }  
  5.   
  6. public String getFile() {  
  7.     return rollingPolicy.getActiveFileName(); // 从滚动策略获取  
  8. }  


上面logback[-test].xml的rollingPolicy配置为 
ch.qos.logback.core.rolling.TimeBasedRollingPolicy类  

看下实现: 
Java代码   收藏代码
  1. public String getActiveFileName() {  
  2.   String parentsRawFileProperty = getParentsRawFileProperty();  
  3.   if (parentsRawFileProperty != null) { // logback.xml指定了file属性  
  4.     return parentsRawFileProperty; // 使用file值  
  5.   } else {  
  6.     return timeBasedFileNamingAndTriggeringPolicy  
  7.         .getCurrentPeriodsFileNameWithoutCompressionSuffix();  
  8.   }  
  9. }  
  10.   
  11. public String getParentsRawFileProperty() {  
  12.   return parent.rawFileProperty();  
  13. }  


ch.qos.logback.core.FileAppender类  
Java代码   收藏代码
  1. final public String rawFileProperty() {  
  2.   return fileName;  
  3. }  


b必须指定TriggeringPolicy<E>和RollingPolicy,否则不会打印日志:  

看下 
ch.qos.logback.core.rolling.RollingFileAppender类 : 
Java代码   收藏代码
  1. public void start() {  
  2.   if (triggeringPolicy == null) {  
  3.     addWarn("No TriggeringPolicy was set for the RollingFileAppender named "  
  4.         + getName());  
  5.     addWarn("For more information, please visit "+CODES_URL+"#rfa_no_tp");  
  6.     return;  
  7.   }  
  8.   
  9.   if (rollingPolicy == null) {  
  10.     addError("No RollingPolicy was set for the RollingFileAppender named "  
  11.         + getName());  
  12.     addError("For more information, please visit "+CODES_URL+"rfa_no_rp");  
  13.     return;  
  14.   }  

TimeBasedRollingPolicy类实现了上面的两个接口,triggeringPolicy和rollingPolicy都指向TimeBasedRollingPolicy的实例对象。 


c. 如果file指定,前一天的文件名改为fileNamePattern的值(/logs/heuristic-2013-11-15.log)。  

通过设置TimeBasedRollingPolicy的 maxHistory属性 ,可以控制已产生日志的数量。如果maxHistory设置为30,那么超过30天的log文件会被自动删除,这是通过RollingFileAppender的 rollover() 方法来实现的。 

该方法会调用 
ch.qos.logback.core.rolling.TimeBasedRollingPolicy类  
的rollover方法: 
Java代码   收藏代码
  1. public void rollover() throws RolloverFailure {  
  2.   // 当此方法调用时,假定前一天日志文件已经关闭  
  3.   String elapsedPeriodsFileName = timeBasedFileNamingAndTriggeringPolicy  
  4.       .getElapsedPeriodsFileName();  
  5.   
  6.   String elpasedPeriodStem = FileFilterUtil.afterLastSlash(elapsedPeriodsFileName);  
  7.   
  8.   if (compressionMode == CompressionMode.NONE) {  
  9.     if (getParentsRawFileProperty() != null) {  
  10.       renameUtil.rename(getParentsRawFileProperty(), elapsedPeriodsFileName); // file指定,重命名为fileNamePattern格式。如果目标文件存在,则重命名失败  
  11.     } // else { nothing to do if CompressionMode == NONE and parentsRawFileProperty == null }  
  12.   } else {  
  13.     if (getParentsRawFileProperty() == null) {  
  14.       future = asyncCompress(elapsedPeriodsFileName, elapsedPeriodsFileName, elpasedPeriodStem); // file未指定,异步压缩  
  15.     } else {  
  16.       future = renamedRawAndAsyncCompress(elapsedPeriodsFileName, elpasedPeriodStem); // file指定,重命名并异步压缩  
  17.     }  
  18.   }  
  19.   
  20.   if (archiveRemover != null) {  
  21.     archiveRemover.clean(new Date(timeBasedFileNamingAndTriggeringPolicy.getCurrentTime())); // 删除历史日志  
  22.   }  
  23. }  


默认的archiveRemover为 ch.qos.logback.core.rolling.helper.DefaultArchiveRemover抽象类 : 
Java代码   收藏代码
  1. public void clean(Date now) {  
  2.   long nowInMillis = now.getTime();  
  3.   int periodsElapsed = computeElapsedPeriodsSinceLastClean(nowInMillis);  
  4.   lastHeartBeat = nowInMillis;  
  5.   if (periodsElapsed > 1) {  
  6.     addInfo("periodsElapsed = " + periodsElapsed);  
  7.   }  
  8.   // 从待删除日志的终止日期开始,每次回退一天,删除过期日志  
  9.   for (int i = 0; i < periodsElapsed; i++) {  
  10.     cleanByPeriodOffset(now, periodOffsetForDeletionTarget - i);  
  11.   }  
  12. }  
  13.   
  14. public void setMaxHistory(int maxHistory) {  
  15.   // 待删除日志的终止日期:回退(maxHistory+1)天  
  16.   this.periodOffsetForDeletionTarget = -maxHistory - 1;  
  17. }  


cleanByPeriodOffset为抽象方法,这里交由 
ch.qos.logback.core.rolling.helper.TimeBasedArchiveRemover子类 实现: 
Java代码   收藏代码
  1. protected void cleanByPeriodOffset(Date now, int periodOffset) {  
  2.   Date date2delete = rc.getRelativeDate(now, periodOffset); // 计算需要删除日志的日期  
  3.   String filename = fileNamePattern.convert(date2delete);  
  4.   File file2Delete = new File(filename);  
  5.   if (file2Delete.exists() && file2Delete.isFile()) {  
  6.     file2Delete.delete(); // 删除文件  
  7.     addInfo("deleting " + file2Delete);  
  8.     if (parentClean) {  
  9.       removeFolderIfEmpty(file2Delete.getParentFile());  
  10.     }  
  11.   }  
  12. }  


d. 如果要启用压缩,需要将fileNamePattern的后缀名设置为压缩格式,如:/logs/heuristic-%d{yyyy-MM-dd}.zip。  

看下 ch.qos.logback.core.rolling.RollingPolicyBase类 相关的代码: 
Java代码   收藏代码
  1. protected void determineCompressionMode() {  
  2.   if (fileNamePatternStr.endsWith(".gz")) {  
  3.     addInfo("Will use gz compression");  
  4.     compressionMode = CompressionMode.GZ;  
  5.   } else if (fileNamePatternStr.endsWith(".zip")) {  
  6.     addInfo("Will use zip compression");  
  7.     compressionMode = CompressionMode.ZIP;  
  8.   } else { // 如果后缀名不是.gz或.zip,不会启用压缩  
  9.     addInfo("No compression will be used");  
  10.     compressionMode = CompressionMode.NONE;  
  11.   }  
  12. }  


e. RollingFileAppender保证append的值为true,这样当天先写入的日志内容就不会丢失  

ch.qos.logback.core.rolling.RollingFileAppender类 的start()方法: 
Java代码   收藏代码
  1. if (!append) { // append为false时  
  2.   addWarn("Append mode is mandatory for RollingFileAppender");  
  3.   append = true// 改成true  
  4. }  


fprudent模式不支持file设定;如果启用了压缩,logback将不会记录日志  

ch.qos.logback.core.rolling.RollingFileAppender类  
的start()方法: 
Java代码   收藏代码
  1. if (isPrudent()) { // 安全模式,但效率低  
  2.   if (rawFileProperty() != null) {  
  3.     addWarn("Setting \"File\" property to null on account of prudent mode");  
  4.     setFile(null); // 取消file属性设置  
  5.   }  
  6.   if (rollingPolicy.getCompressionMode() != CompressionMode.NONE) { // 启用了压缩  
  7.     addError("Compression is not supported in prudent mode. Aborting");  
  8.     return// 返回,不会进行后面的记录日志操作  
  9.   }  
  10. }  
共有 人打赏支持
粉丝 34
博文 311
码字总数 153495
×
小代码2016
如果觉得我的文章对您有用,请随意打赏。您的支持将鼓励我继续创作!
* 金额(元)
¥1 ¥5 ¥10 ¥20 其他金额
打赏人
留言
* 支付类型
微信扫码支付
打赏金额:
已支付成功
打赏金额: