直接使用sl4j的注解接口使用不同的日志工具。

spring - log4j

maven依赖

  1. <dependency>
  2.     <groupId>org.slf4j</groupId>
  3.     <artifactId>slf4j-log4j12</artifactId>
  4.     <version>1.7.21</version>
  5. </dependency>

配置

log4j.properties

  1. log4j.rootLogger=DEBUG,console,dailyFile
  3. # 控制台(console)
  4. log4j.appender.console=org.apache.log4j.ConsoleAppender
  5. log4j.appender.console.Threshold=DEBUG
  6. log4j.appender.console.ImmediateFlush=true
  7. log4j.appender.console.Target=System.err
  8. log4j.appender.console.layout=org.apache.log4j.PatternLayout
  9. log4j.appender.console.layout.ConversionPattern=%d{yyyyMMdd HH:mm:ss} [%p] %c.%M %m%n
  11. # 日志文件按天保存，不删除
  12. log4j.appender.dailyFile=org.apache.log4j.DailyRollingFileAppender
  13. log4j.appender.dailyFile.Threshold=DEBUG
  14. log4j.appender.dailyFile.ImmediateFlush=true
  15. log4j.appender.dailyFile.Append=true
  16. log4j.appender.dailyFile.File=file.log
  17. log4j.appender.dailyFile.DatePattern='.'yyyy-MM-dd
  18. log4j.appender.dailyFile.layout=org.apache.log4j.PatternLayout
  19. log4j.appender.dailyFile.layout.ConversionPattern=%d{yyyyMMdd HH:mm:ss} [%p] %c.%M %m%n
  21. # 日志文件保存到一个文件，不常用
  22. log4j.appender.logFile=org.apache.log4j.FileAppender
  23. log4j.appender.logFile.Threshold=DEBUG
  24. log4j.appender.logFile.ImmediateFlush=true
  25. log4j.appender.logFile.Append=true
  26. log4j.appender.logFile.File=D:/logs/log.log4j
  27. log4j.appender.logFile.layout=org.apache.log4j.PatternLayout
  28. log4j.appender.logFile.layout.ConversionPattern=%d{yyyyMMdd HH:mm:ss} [%p] %c.%M %m%n

使用

  1. Logger logger = LoggerFactory.getLogger(LogTest.class);
  3. logger.debug("123");
  5. # 效果：
  6. 20190622 16:11:42 [DEBUG] LogTest.main 123

自定义append

对于某些不重要的日志，我们可以设置保留最近一周，我们需要自定义一个方法，改进如下：

  1. package util;
  3. import org.apache.log4j.FileAppender;
  4. import org.apache.log4j.Layout;
  5. import org.apache.log4j.helpers.LogLog;
  6. import org.apache.log4j.spi.LoggingEvent;
  8. import java.io.File;
  9. import java.io.IOException;
  10. import java.text.SimpleDateFormat;
  11. import java.util.ArrayList;
  12. import java.util.Calendar;
  13. import java.util.Date;
  14. import java.util.List;
  16. /**
  17.  * @Description
  18.  * @Author 田云
  19.  * @Date 2019/6/22 16:03
  20.  * @Version 1.0
  21.  */
  22. public class CustomLogAppender extends FileAppender {
  24.     /** 不允许改写的datepattern */
  25.     private static final String datePattern = "'.'yyyy-MM-dd";
  26.     /** 最多文件增长个数 */
  27.     private int maxBackupIndex = 2;
  28.     /** 文件名+上次最后更新时间 */
  29.     private String scheduledFilename;
  31.     /**
  32.      * The next time we estimate a rollover should occur.
  33.      */
  34.     private long nextCheck = System.currentTimeMillis() - 1;
  36.     Date now = new Date();
  37.     SimpleDateFormat sdf;
  39.     /**
  40.      * The default constructor does nothing.
  41.      */
  42.     public CustomLogAppender() {
  43.     }
  45.     /**
  46.      * 改造过的构造器
  47.      */
  48.     public CustomLogAppender(Layout layout, String filename, int maxBackupIndex) throws IOException {
  49.         super(layout, filename, true);
  50.         this.maxBackupIndex = maxBackupIndex;
  51.         activateOptions();
  52.     }
  54.     /** * 初始化本Appender对象的时候调用一次 */
  55.     @Override
  56.     public void activateOptions() {
  57.         super.activateOptions();
  58.         if (fileName != null) {
  59.             // perf.log now.setTime(System.currentTimeMillis());
  60.             sdf = new SimpleDateFormat(datePattern);
  61.             File file = new File(fileName);
  62.             // 获取最后更新时间拼成的文件名
  63.             scheduledFilename = fileName + sdf.format(new Date(file.lastModified()));
  64.         } else {
  65.             LogLog.error("File is not set for appender [" + name + "].");
  66.         } if (maxBackupIndex <= 0) {
  67.             LogLog.error("maxBackupIndex reset to default value[2],orignal value is:" + maxBackupIndex);
  68.             maxBackupIndex = 2;
  69.         }
  70.     }
  72.     /**
  73.      * 滚动文件的函数:<br>
  74.      * 1. 对文件名带的时间戳进行比较, 确定是否更新<br>
  75.      * 2. if需要更新, 当前文件rename到文件名+日期, 重新开始写文件<br>
  76.      * 3. 针对配置的maxBackupIndex,删除过期的文件
  77.      */
  78.     void rollOver() throws IOException {
  79.         String datedFilename = fileName + sdf.format(now);
  80.         // 如果上次写的日期跟当前日期相同，不需要换文件
  81.         if (scheduledFilename.equals(datedFilename)) {
  82.             return;
  83.         }
  84.         // close current file, and rename it to datedFilename
  85.         this.closeFile();
  86.         File target = new File(scheduledFilename);
  87.         if (target.exists()) {
  88.             try {
  89.                 target.delete();
  90.             } catch (SecurityException e) {
  91.                 e.printStackTrace();
  92.             }
  93.         }
  95.         File file = new File(fileName);
  96.         boolean result = file.renameTo(target);
  97.         if (result) {
  98.             LogLog.debug(fileName + " -> " + scheduledFilename);
  99.         } else {
  100.             LogLog.error("Failed to rename [" + fileName + "] to [" + scheduledFilename + "].");
  101.         }
  103.         // 删除过期文件
  104.         if (maxBackupIndex > 0) {
  105.             File folder = new File(file.getParent());
  106.             List<String> maxBackupIndexDates = getMaxBackupIndexDates();
  107.             for (File ff : folder.listFiles()) {
  108.                 // 遍历目录，将日期不在备份范围内的日志删掉
  109.                 if (ff.getName().startsWith(file.getName()) && !ff.getName().equals(file.getName())) {
  110.                     // 获取文件名带的日期时间戳
  111.                     String markedDate = ff.getName().substring( file.getName().length());
  112.                     if (!maxBackupIndexDates.contains(markedDate)) {
  113.                         result = ff.delete();
  114.                     }
  115.                     if (result) {
  116.                         LogLog.debug(ff.getName() + " -> deleted ");
  117.                     } else {
  118.                         LogLog.error("Failed to deleted old DayRollingFileAppender file :" + ff.getName());
  119.                     }
  120.                 }
  121.             }
  122.         }
  124.         try {
  125.             // This will also close the file. This is OK since multiple
  126.             // close operations are safe.
  127.             this.setFile(fileName, false, this.bufferedIO, this.bufferSize);
  128.         } catch (IOException e) {
  129.             errorHandler.error("setFile(" + fileName + ", false) call failed.");
  130.         }
  132.         scheduledFilename = datedFilename;
  133.         // 更新最后更新日期戳
  134.     }
  136.     /**
  137.      * Actual writing occurs here.
  138.      * 这个方法是写操作真正的执行过程.
  139.      */
  140.     @Override
  141.     protected void subAppend(LoggingEvent event) {
  143.         long n = System.currentTimeMillis();
  144.         if (n >= nextCheck) {
  146.             // 在每次写操作前判断一下是否需要滚动文件
  147.             now.setTime(n);
  148.             nextCheck = getNextDayCheckPoint(now);
  149.             try {
  150.                 rollOver();
  151.             } catch (IOException ioe) {
  152.                 LogLog.error("rollOver() failed.", ioe);
  153.             }
  154.         } super.subAppend(event);
  155.     }
  157.     /**
  158.      * 获取下一天的时间变更点
  159.      *
  160.      * @param now
  161.      * @return
  162.      */
  163.     long getNextDayCheckPoint(Date now) {
  165.         Calendar calendar = Calendar.getInstance();
  166.         calendar.setTime(now);
  167.         calendar.set(Calendar.HOUR_OF_DAY, 0);
  168.         calendar.set(Calendar.MINUTE, 0);
  169.         calendar.set(Calendar.SECOND, 0);
  170.         calendar.set(Calendar.MILLISECOND, 0);// 注意MILLISECOND,毫秒也要置0.。。否则错了也找不出来的 calendar.add(Calendar.DATE, 1);
  171.         return calendar.getTimeInMillis();
  172.     }
  174.     /**
  175.      * 根据maxBackupIndex配置的备份文件个数，获取要保留log文件的日期范围集合
  176.      * @return list<'fileName+yyyy-MM-dd'>
  177.      */
  178.     List<String> getMaxBackupIndexDates() {
  180.         List<String> result = new ArrayList<String>();
  181.         if (maxBackupIndex > 0) {
  182.             for (int i = 1; i <= maxBackupIndex; i++) {
  183.                 Calendar calendar = Calendar.getInstance();
  184.                 calendar.setTime(now);
  185.                 calendar.set(Calendar.HOUR_OF_DAY, 0);
  186.                 calendar.set(Calendar.MINUTE, 0);
  187.                 calendar.set(Calendar.SECOND, 0);
  188.                 calendar.set(Calendar.MILLISECOND, 0);
  190.                 // 注意MILLISECOND,毫秒也要置0...否则错了也找不出来的
  191.                 calendar.add(Calendar.DATE, -i);
  192.                 result.add(sdf.format(calendar.getTime()));
  193.             }
  194.         }
  196.         return result;
  197.     }
  199.     public int getMaxBackupIndex() {
  200.         return maxBackupIndex;
  201.     }
  202.     public void setMaxBackupIndex(int maxBackupIndex) {
  203.         this.maxBackupIndex = maxBackupIndex;
  204.     }
  205.     public String getDatePattern() {
  206.         return datePattern;
  207.     }
  208. }

自定义的配置

  1. # 按天存储，保存7天(日志文件不需要全部保留的情况）
  2. log4j.appender.customer=util.CustomLogAppender
  3. log4j.appender.customer.File=file.log
  4. log4j.appender.customer.maxBackupIndex=7
  5. log4j.appender.customer.layout=org.apache.log4j.PatternLayout
  6. log4j.appender.customer.layout.ConversionPattern=%d{yyyyMMdd HH:mm:ss} [%p] %c.%M %m%n

springboot - logback

1、引用，web的引用里面已经引入了。

2、配置文件

logback-spring.xml

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <configuration scan="true" scanPeriod="60 seconds" debug="false">
  4.     <contextName>logback</contextName>
  5.     <property name="logback.logdir" value="./log/"/>
  6.     <property name="logback.appname" value="java"/>
  8.     <!--输出到控制台 ConsoleAppender-->
  9.     <appender name="console" class="ch.qos.logback.core.ConsoleAppender">
  10.         <!--展示格式 layout-->
  11.         <layout class="ch.qos.logback.classic.PatternLayout">
  12.             <pattern>%d [%thread] %-5level %logger{36} %line : %msg%n</pattern>
  13.         </layout>
  14.     </appender>
  16.     <appender name="fileInfoLog" class="ch.qos.logback.core.rolling.RollingFileAppender">
  17.         <!--如果只是想要 Info 级别的日志，只是过滤 info 还是会输出 Error 日志，因为 Error 的级别高，
  18.         所以我们使用下面的策略，可以避免输出 Error 的日志-->
  19.         <filter class="ch.qos.logback.classic.filter.LevelFilter">
  20.             <!--过滤 Error-->
  21.             <level>ERROR</level>
  22.             <!--匹配到就禁止-->
  23.             <onMatch>DENY</onMatch>
  24.             <!--没有匹配到就允许-->
  25.             <onMismatch>ACCEPT</onMismatch>
  26.         </filter>
  27.         <!--日志名称，如果没有File 属性，那么只会使用FileNamePattern的文件路径规则
  28.             如果同时有<File>和<FileNamePattern>，那么当天日志是<File>，明天会自动把今天
  29.             的日志改名为今天的日期。即，<File> 的日志都是当天的。
  30.         -->
  31.         <File>${logback.logdir}/info.${logback.appname}.log</File>
  32.         <!--滚动策略，按照时间滚动 TimeBasedRollingPolicy-->
  33.         <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
  34.             <!--文件路径,定义了日志的切分方式——把每一天的日志归档到一个文件中,以防止日志填满整个磁盘空间-->
  35.             <FileNamePattern>${logback.logdir}/info.${logback.appname}.%d{yyyy-MM-dd}.log</FileNamePattern>
  36.             <!--只保留最近90天的日志-->
  37.             <maxHistory>90</maxHistory>
  38.             <!--用来指定日志文件的上限大小，那么到了这个值，就会删除旧的日志-->
  39.             <!--<totalSizeCap>1GB</totalSizeCap>-->
  40.         </rollingPolicy>
  41.         <!--日志输出编码格式化-->
  42.         <encoder>
  43.             <charset>UTF-8</charset>
  44.             <pattern>%d [%thread] %-5level %logger{36} %line : %msg%n</pattern>
  45.         </encoder>
  46.     </appender>
  48.     <appender name="fileErrorLog" class="ch.qos.logback.core.rolling.RollingFileAppender">
  49.         <!--如果只是想要 Error 级别的日志，那么需要过滤一下，默认是 info 级别的，ThresholdFilter-->
  50.         <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
  51.             <level>Error</level>
  52.         </filter>
  53.         <!--日志名称，如果没有File 属性，那么只会使用FileNamePattern的文件路径规则
  54.             如果同时有<File>和<FileNamePattern>，那么当天日志是<File>，明天会自动把今天
  55.             的日志改名为今天的日期。即，<File> 的日志都是当天的。
  56.         -->
  57.         <File>${logback.logdir}/error.${logback.appname}.log</File>
  58.         <!--滚动策略，按照时间滚动 TimeBasedRollingPolicy-->
  59.         <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
  60.             <!--文件路径,定义了日志的切分方式——把每一天的日志归档到一个文件中,以防止日志填满整个磁盘空间-->
  61.             <FileNamePattern>${logback.logdir}/error.${logback.appname}.%d{yyyy-MM-dd}.log</FileNamePattern>
  62.             <!--只保留最近90天的日志-->
  63.             <maxHistory>90</maxHistory>
  64.             <!--用来指定日志文件的上限大小，那么到了这个值，就会删除旧的日志-->
  65.             <!--<totalSizeCap>1GB</totalSizeCap>-->
  66.         </rollingPolicy>
  67.         <!--日志输出编码格式化-->
  68.         <encoder>
  69.             <charset>UTF-8</charset>
  70.             <pattern>%d [%thread] %-5level %logger{36} %line : %msg%n</pattern>
  71.         </encoder>
  72.     </appender>
  74.     <!--指定最基础的日志输出级别-->
  75.     <root level="INFO">
  76.         <!--appender将会添加到这个loger-->
  77.         <appender-ref ref="console"/>
  78.         <appender-ref ref="fileInfoLog"/>
  79.         <appender-ref ref="fileErrorLog"/>
  80.     </root>
  82. </configuration>

3、使用

  1. @Slf4j
  2. public class LogServiceImpl implements LogService {
  3.     public PageResult<LogModel> query(LogModelVO logModelVO) {
  4.         log.info("123")
  5.     }
  6. }

springboot - log4j2

推荐
引用

  1.         <!--log4j2 依赖-->
  2.         <dependency>
  3.             <groupId>org.springframework.boot</groupId>
  4.             <artifactId>spring-boot-starter-log4j2</artifactId>
  5.         </dependency>
  6.         <!--异步日志依赖-->
  7.         <dependency>
  8.             <groupId>com.lmax</groupId>
  9.             <artifactId>disruptor</artifactId>
  10.             <version>3.3.7</version>
  11.         </dependency>

log4j2.xml

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!--日志级别以及优先级排序: OFF > FATAL > ERROR > WARN > INFO > DEBUG > TRACE > ALL -->
  3. <!--Configuration后面的status，这个用于设置log4j2自身内部的信息输出，可以不设置，当设置成trace时，你会看到log4j2内部各种详细输出-->
  4. <!--monitorInterval：Log4j能够自动检测修改配置 文件和重新配置本身，设置间隔秒数-->
  5. <configuration status="WARN" monitorInterval="30">
  6.     <properties>
  7.         <property name="logDir" value="log"/>
  8.     </properties>
  9.     <!--先定义所有的appender-->
  10.     <appenders>
  11.         <!--这个输出控制台的配置-->
  12.         <console name="Console" target="SYSTEM_OUT">
  13.             <!--输出日志的格式-->
  14.             <PatternLayout pattern="[%d{HH:mm:ss:SSS}] [%p] - %l - %m%n"/>
  15.         </console>
  16.         <!--文件会打印出所有信息，这个log每次运行程序会自动清空，由append属性决定，这个也挺有用的，适合临时测试用-->
  17.         <File name="log" fileName="${logDir}/test.log" append="false">
  18.             <PatternLayout pattern="%d{HH:mm:ss.SSS} %-5level %class{36} %L %M - %msg%xEx%n"/>
  19.         </File>
  20.         <!-- 这个会打印出所有的info及以下级别的信息，每次大小超过size，则这size大小的日志会自动存入按年份-月份建立的文件夹下面并进行压缩，作为存档-->
  21.         <RollingRandomAccessFile name="RollingFileInfo" fileName="${logDir}/info.log"
  22.                      filePattern="${logDir}/$${date:yyyy-MM}/info-%d{yyyy-MM-dd}-%i.log"
  23.                                  immediateFlush="false">
  24.             <!--控制台只输出level及以上级别的信息（onMatch），其他的直接拒绝（onMismatch）-->
  25.             <ThresholdFilter level="info" onMatch="ACCEPT" onMismatch="DENY"/>
  26.             <PatternLayout pattern="[%d{HH:mm:ss:SSS}] [%p] - %l - %m%n"/>
  27.             <Policies>
  28.                 <TimeBasedTriggeringPolicy/>
  29.                 <SizeBasedTriggeringPolicy size="500 MB"/>
  30.             </Policies>
  31.         </RollingRandomAccessFile>
  32.         <RollingRandomAccessFile name="RollingFileWarn" fileName="${logDir}/warn.log"
  33.                      filePattern="${logDir}/$${date:yyyy-MM}/warn-%d{yyyy-MM-dd}-%i.log"
  34.                                  immediateFlush="false">
  35.             <ThresholdFilter level="warn" onMatch="ACCEPT" onMismatch="DENY"/>
  36.             <PatternLayout pattern="[%d{HH:mm:ss:SSS}] [%p] - %l - %m%n"/>
  37.             <Policies>
  38.                 <TimeBasedTriggeringPolicy/>
  39.                 <SizeBasedTriggeringPolicy size="500 MB"/>
  40.             </Policies>
  41.             <!-- DefaultRolloverStrategy属性如不设置，则默认为最多同一文件夹下7个文件，这里设置了20 -->
  42.             <DefaultRolloverStrategy max="20"/>
  43.         </RollingRandomAccessFile>
  44.         <RollingRandomAccessFile name="RollingFileError" fileName="${logDir}/error.log"
  45.                      filePattern="${logDir}/$${date:yyyy-MM}/error-%d{yyyy-MM-dd}-%i.log"
  46.                                  immediateFlush="false">
  47.             <ThresholdFilter level="error" onMatch="ACCEPT" onMismatch="DENY"/>
  48.             <PatternLayout pattern="[%d{HH:mm:ss:SSS}] [%p] - %l - %m%n"/>
  49.             <Policies>
  50.                 <TimeBasedTriggeringPolicy/>
  51.                 <SizeBasedTriggeringPolicy size="500 MB"/>
  52.             </Policies>
  53.         </RollingRandomAccessFile>
  54.     </appenders>
  55.     <!--然后定义logger，只有定义了logger并引入的appender，appender才会生效-->
  56.     <loggers>
  57.         <!--过滤掉spring和mybatis的一些无用的DEBUG信息-->
  58.         <logger name="org.springframework" level="INFO"/>
  59.         <logger name="org.mybatis" level="INFO"/>
  60.         <root level="all" includeLocation="true">
  61.             <appender-ref ref="Console"/>
  62.             <appender-ref ref="RollingFileInfo"/>
  63.             <appender-ref ref="RollingFileWarn"/>
  64.             <appender-ref ref="RollingFileError"/>
  65.         </root>
  66.     </loggers>
  67. </configuration>

启动函数

  1. system.setProperty("Log4jContextSelector", "org.apache.logging.log4j.core.async.AsyncLoggerContextSelector");

然后直接使用sl4j即可。

自定义输出目录

参考：https://giraffetree.me/2019/12/06/log4j2-slf4j-routing/

  • 配置 ```xml <?xml version=”1.0” encoding=”UTF-8”?>

  2. 测试
  3. ```bash
  4. import lombok.extern.slf4j.Slf4j;
  5. import org.apache.logging.log4j.ThreadContext;
  6. import org.slf4j.Marker;
  7. import org.slf4j.MarkerFactory;
  9. import java.util.concurrent.ThreadLocalRandom;
  11. /** * @author GiraffeTree * @date 2019/12/5 */
  12. @Slf4j
  13. public class Log4j2Test {
  15.     private final static Marker BOY = MarkerFactory.getMarker("boy");
  16.     private final static Marker GIRL = MarkerFactory.getMarker("girl");
  17.     private final static Marker OTHER = MarkerFactory.getMarker("other");
  19.     public static void main(String[] args) {
  21.         testRouting(1000, 3);
  23.     }
  25.     public static void addRandomLog() {
  26.         int num = ThreadLocalRandom.current().nextInt(0, 1000);
  27.         if (num < 950) {
  28.             ThreadContext.put("logFileName", "David");
  29.             log.info("current: {}", num);
  30.         } else {
  31.             log.error("current: {}", num);
  32.         }
  33.     }
  35.     public static void testRouting(int loopCount, int userSize) {
  36.         long l1 = System.currentTimeMillis();
  37.         int count = loopCount;
  38.         while (count > 0) {
  39.             writeMultipleUsersLog(userSize);
  40.             count--;
  41.         }
  43.         long l2 = System.currentTimeMillis();
  44.         System.out.println(String.format("size:%d loopCount:%d cost: %dms", userSize, loopCount, l2 - l1));
  45.     }
  47.     public static void writeMultipleUsersLog(int size) {
  48.         for (int i = 0; i < size; i++) {
  49.             String userName = "user" + i;
  50.             ThreadContext.put("logFileName", userName);
  51.             int num = ThreadLocalRandom.current().nextInt(0, 1200);
  52.             if (num < 500) {
  53.                 log.info(BOY, "current: {}", num);
  54.             } else if (num < 1000) {
  55.                 log.info(GIRL, "current: {}", num);
  56.             } else {
  57.                 log.info(OTHER, "current: {}", num);
  58.             }
  59.         }
  60.     }
  62. }