log4j2自定义动态配置日志

Posted 梦江黎

tags:

篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了log4j2自定义动态配置日志相关的知识，希望对你有一定的参考价值。


项目需求

1.平台日志：Spring Boot项目中接入log4j2日志，公共配置作平台日志。
2.业务日志：为了方便定位业务问题自定义动态日志，根据不同业务输出不同名称的日志文件。

思路分析

平台日志

首先配置 pom.xml 文件，将原有的 logback 移除，改用 log4j2

 
   
   
 
    
  
    
    
  
  1. <dependency>
    2. 
  
    
    
  
  2.  <groupId>org.springframework.boot</groupId>
    3. 
  
    
    
  
  3.  <artifactId>spring-boot-starter</artifactId>
    4. 
  
    
    
  
  4.  <exclusions>
    5. 
  
    
    
  
  5.  <exclusion>
    6. 
  
    
    
  
  6.  <groupId>org.springframework.boot</groupId>
    7. 
  
    
    
  
  7.  <artifactId>spring-boot-starter-logging</artifactId>
    8. 
  
    
    
  
  8.  </exclusion>
    9. 
  
    
    
  
  9.  </exclusions>
    10. 
  
    
    
  
  10. </dependency>
    11.

添加 log4j 的包

 
   
   
 
    
  
    
    
  
  1. <dependency>
    2. 
  
    
    
  
  2.  <groupId>org.springframework.boot</groupId>
    3. 
  
    
    
  
  3.  <artifactId>spring-boot-starter-log4j2</artifactId>
    4. 
  
    
    
  
  4. </dependency>
    5.

添加 log4j2.xml 配置文件

 
   
   
 
    
  
    
    
  
  1. <?xml version="1.0" encoding="UTF-8"?>
    2. 
  
    
    
  
  2. <!--日志级别以及优先级排序: OFF > FATAL > ERROR > WARN > INFO > DEBUG > TRACE > ALL -->
    3. 
  
    
    
  
  3. <!--Configuration后面的status，这个用于设置log4j2自身内部的信息输出，可以不设置，当设置成trace时，你会看到log4j2内部各种详细输出-->
    4. 
  
    
    
  
  4. <!--monitorInterval：Log4j能够自动检测修改配置 文件和重新配置本身，设置间隔秒数-->
    5. 
  
    
    
  
  5. <configuration>
    6. 
  
    
    
  
  6.  <!-- 全局参数 -->
    7. 
  
    
    
  
  7.  <properties>
    8. 
  
    
    
  
  8.  <Property name="displayName">platform</Property>
    9. 
  
    
    
  
  9.  <Property name="log_path">logs/${displayName}</Property>
    10. 
  
    
    
  
  10.  <Property name="pattern">%d{yyyy-MM-dd HH:mm:ss,SSS} %-5p %C %c{1}:%L -%m%n</Property>
    11. 
  
    
    
  

    12. 
  
    
    
  
  12.  </properties>
    13. 
  
    
    
  
  13.  <!--先定义所有的appender-->
    14. 
  
    
    
  
  14.  <appenders>
    15. 
  
    
    
  
  15.  <!--这个输出控制台的配置-->
    16. 
  
    
    
  
  16.  <console name="Console" target="SYSTEM_OUT" follow="true">
    17. 
  
    
    
  
  17.  <PatternLayout>
    18. 
  
    
    
  
  18.  <pattern>${pattern}</pattern>
    19. 
  
    
    
  
  19.  </PatternLayout>
    20. 
  
    
    
  
  20.  </console>
    21. 
  
    
    
  
  21.  <!--文件会打印出所有信息，这个log每次运行程序会自动清空，由append属性决定，这个也挺有用的，适合临时测试用-->
    22. 
  
    
    
  
  22.  <File name="log" fileName="logs/platform.log" append="false">
    23. 
  
    
    
  
  23.  <!-- 指定error 级别的日志 -->
    24. 
  
    
    
  
  24.  <ThresholdFilter level="ERROR" onMatch="ACCEPT" onMismatch="DENY"/>
    25. 
  
    
    
  
  25.  <PatternLayout>
    26. 
  
    
    
  
  26.  <pattern>${pattern}</pattern>
    27. 
  
    
    
  
  27.  </PatternLayout>
    28. 
  
    
    
  
  28.  </File>
    29. 
  
    
    
  
  29.  <!-- 这个会打印出所有的info及以下级别的信息，每次大小超过size，则这size大小的日志会自动存入按年份-月份建立的文件夹下面并进行压缩，作为存档-->
    30. 
  
    
    
  
  30.  <RollingFile name="RollingFileInfo" fileName="${log_path}/info.log"
    31. 
  
    
    
  
  31.  filePattern="${log_path}/$${date:yyyy-MM}/info-%d{yyyy-MM-dd}-%i.log">
    32. 
  
    
    
  
  32.  <!--控制台只输出level及以上级别的信息（onMatch），其他的直接拒绝（onMismatch）-->
    33. 
  
    
    
  
  33.  <Filters>
    34. 
  
    
    
  
  34.  <ThresholdFilter level="warn" onMatch="DENY" onMismatch="NEUTRAL"/>
    35. 
  
    
    
  
  35.  <ThresholdFilter level="info" onMatch="ACCEPT" onMismatch="DENY" />
    36. 
  
    
    
  
  36.  </Filters>
    37. 
  
    
    
  
  37.  <PatternLayout>
    38. 
  
    
    
  
  38.  <pattern>${pattern}</pattern>
    39. 
  
    
    
  
  39.  </PatternLayout>
    40. 
  
    
    
  
  40.  <Policies>
    41. 
  
    
    
  
  41.  <TimeBasedTriggeringPolicy/>
    42. 
  
    
    
  
  42.  <SizeBasedTriggeringPolicy size="100 MB"/>
    43. 
  
    
    
  
  43.  </Policies>
    44. 
  
    
    
  
  44.  <DefaultRolloverStrategy max="100000"/>
    45. 
  
    
    
  
  45.  </RollingFile>
    46. 
  
    
    
  
  46.  <!-- <RollingFile name="RollingFileWarn" fileName="${log_path}/warn.log"
    47. 
  
    
    
  
  47.  filePattern="${log_path}/$${date:yyyy-MM}/warn-%d{yyyy-MM-dd}-%i.log">
    48. 
  
    
    
  
  48.  <ThresholdFilter level="warn" onMatch="ACCEPT" onMismatch="DENY"/>
    49. 
  
    
    
  
  49.  <PatternLayout>
    50. 
  
    
    
  
  50.  <pattern>${pattern}</pattern>
    51. 
  
    
    
  
  51.  </PatternLayout>
    52. 
  
    
    
  
  52.  <Policies>
    53. 
  
    
    
  
  53.  <TimeBasedTriggeringPolicy/>
    54. 
  
    
    
  
  54.  <SizeBasedTriggeringPolicy size="100 MB"/>
    55. 
  
    
    
  
  55.  </Policies>
    56. 
  
    
    
  
  56.  &lt;!&ndash; DefaultRolloverStrategy属性如不设置，则默认为最多同一文件夹下7个文件，这里设置了20 &ndash;&gt;
    57. 
  
    
    
  
  57.  <DefaultRolloverStrategy max="20"/>
    58. 
  
    
    
  
  58.  </RollingFile>-->
    59. 
  
    
    
  
  59.  <RollingFile name="RollingFileError" fileName="${log_path}/error.log"
    60. 
  
    
    
  
  60.  filePattern="${log_path}/$${date:yyyy-MM}/error-%d{yyyy-MM-dd}-%i.log">
    61. 
  
    
    
  
  61.  <ThresholdFilter level="error" onMatch="ACCEPT" onMismatch="DENY"/>
    62. 
  
    
    
  
  62.  <PatternLayout>
    63. 
  
    
    
  
  63.  <pattern>${pattern}</pattern>
    64. 
  
    
    
  
  64.  </PatternLayout>
    65. 
  
    
    
  
  65.  <Policies>
    66. 
  
    
    
  
  66.  <TimeBasedTriggeringPolicy/>
    67. 
  
    
    
  
  67.  <SizeBasedTriggeringPolicy size="100 MB"/>
    68. 
  
    
    
  
  68.  </Policies>
    69. 
  
    
    
  
  69.  <DefaultRolloverStrategy max="100000"/>
    70. 
  
    
    
  
  70.  </RollingFile>
    71. 
  
    
    
  
  71.  </appenders>
    72. 
  
    
    
  
  72.  <!--然后定义logger，只有定义了logger并引入的appender，appender才会生效-->
    73. 
  
    
    
  
  73.  <loggers>
    74. 
  
    
    
  
  74.  <!--过滤掉spring的一些无用的DEBUG信息-->
    75. 
  
    
    
  
  75.  <logger name="org.springframework" level="WARN"></logger>
    76. 
  
    
    
  
  76.  <logger name="org.hibernate" level="WARN"/>
    77. 
  
    
    
  
  77.  <!--<logger name="com.lottery" level="DEBUG"></logger>-->
    78. 
  
    
    
  
  78.  <Root level="INFO">
    79. 
  
    
    
  
  79.  <appender-ref ref="Console"/>
    80. 
  
    
    
  
  80.  <appender-ref ref="RollingFileInfo"/>
    81. 
  
    
    
  
  81.  <!--<appender-ref ref="RollingFileWarn"/>-->
    82. 
  
    
    
  
  82.  <appender-ref ref="RollingFileError"/>
    83. 
  
    
    
  
  83.  </Root>
    84. 
  
    
    
  
  84.  </loggers>
    85. 
  
    
    
  
  85. </configuration>
    86.

业务日志

直接贴代码了，根据输入的业务名称参数调用LogUtil工具方法生成不同名称的业务日志。为了规范化和方便管理，我将业务名称参数定义成枚举量，这样添加某业务日志需要去枚举类里面添加。

 
   
   
 
    
  
    
    
  
  1. import com.lottery.enums.BusinessEnum;
    2. 
  
    
    
  
  2. import org.apache.logging.log4j.Level;
    3. 
  
    
    
  
  3. import org.apache.logging.log4j.LogManager;
    4. 
  
    
    
  
  4. import org.apache.logging.log4j.Logger;
    5. 
  
    
    
  
  5. import org.apache.logging.log4j.core.Filter;
    6. 
  
    
    
  
  6. import org.apache.logging.log4j.core.Layout;
    7. 
  
    
    
  
  7. import org.apache.logging.log4j.core.LoggerContext;
    8. 
  
    
    
  
  8. import org.apache.logging.log4j.core.appender.RollingFileAppender;
    9. 
  
    
    
  
  9. import org.apache.logging.log4j.core.appender.rolling.*;
    10. 
  
    
    
  
  10. import org.apache.logging.log4j.core.config.AppenderRef;
    11. 
  
    
    
  
  11. import org.apache.logging.log4j.core.config.Configuration;
    12. 
  
    
    
  
  12. import org.apache.logging.log4j.core.config.LoggerConfig;
    13. 
  
    
    
  
  13. import org.apache.logging.log4j.core.filter.ThresholdFilter;
    14. 
  
    
    
  
  14. import org.apache.logging.log4j.core.layout.PatternLayout;
    15. 
  
    
    
  
  15. import java.io.File;
    16. 
  
    
    
  
  16. import static org.apache.logging.log4j.core.Filter.Result.DENY;
    17. 
  
    
    
  

    18. 
  
    
    
  
  18. public class LogUtil {
    19. 
  
    
    
  
  19.  /**
    20. 
  
    
    
  
  20.  * 日志打印的目录
    21. 
  
    
    
  
  21.  */
    22. 
  
    
    
  
  22.  private static final String datalogDir = "logs" + File.separator + "business";
    23. 
  
    
    
  

    24. 
  
    
    
  
  24.  private static final LoggerContext ctx = (LoggerContext) LogManager.getContext(false);
    25. 
  
    
    
  
  25.  private static final Configuration config = ctx.getConfiguration();
    26. 
  
    
    
  
  26.  private static final String INFO = "info";
    27. 
  
    
    
  
  27.  private static final String ERROR = "error";
    28. 
  
    
    
  

    29. 
  
    
    
  

    30. 
  
    
    
  
  30.  private LogUtil() {
    31. 
  
    
    
  
  31.  }
    32. 
  
    
    
  

    33. 
  
    
    
  
  33.  /**
    34. 
  
    
    
  
  34.  * 启动一个动态的logger
    35. 
  
    
    
  
  35.  */
    36. 
  
    
    
  
  36.  private static void start(String loggerName) {
    37. 
  
    
    
  

    38. 
  
    
    
  
  38.  //创建一个展示的样式：PatternLayout， 还有其他的日志打印样式。
    39. 
  
    
    
  
  39.  Layout layout = PatternLayout.newBuilder()
    40. 
  
    
    
  
  40.  .withConfiguration(config).withPattern("%d{yyyy-MM-dd HH:mm:ss,SSS} %t %-5p %C %c{1}:%L -%m%n").build();
    41. 
  
    
    
  

    42. 
  
    
    
  
  42.  //单个日志文件大小
    43. 
  
    
    
  
  43.  TimeBasedTriggeringPolicy tbtp = TimeBasedTriggeringPolicy.createPolicy(null, null);
    44. 
  
    
    
  
  44.  TriggeringPolicy tp = SizeBasedTriggeringPolicy.createPolicy("100 MB");// 大小分割
    45. 
  
    
    
  
  45.  CompositeTriggeringPolicy policyComposite = CompositeTriggeringPolicy.createPolicy(tbtp, tp);
    46. 
  
    
    
  

    47. 
  
    
    
  
  47.  String loggerDir = datalogDir + File.separator + loggerName;
    48. 
  
    
    
  
  48.  //删除日志的条件
    49. 
  
    
    
  
  49.  /* IfFileName ifFileName = IfFileName.createNameCondition(null, loggerName + "\\.\\d{4}-\\d{2}-\\d{2}.*");
    50. 
  
    
    
  
  50.  IfLastModified ifLastModified = IfLastModified.createAgeCondition(Duration.parse("1d"));
    51. 
  
    
    
  
  51.  DeleteAction deleteAction = DeleteAction.createDeleteAction(
    52. 
  
    
    
  
  52.  loggerDir, false, 1, false, null,
    53. 
  
    
    
  
  53.  new PathCondition[]{ifLastModified, ifFileName}, null, config);
    54. 
  
    
    
  
  54.  Action[] actions = new Action[]{deleteAction};*/
    55. 
  
    
    
  

    56. 
  
    
    
  
  56.  DefaultRolloverStrategy strategy = DefaultRolloverStrategy.createStrategy(
    57. 
  
    
    
  
  57.  "100000", "1", null, null, null, false, config);
    58. 
  
    
    
  
  58.  ThresholdFilter filter = ThresholdFilter.createFilter(Level.INFO, Filter.Result.ACCEPT, DENY);
    59. 
  
    
    
  
  59.  ThresholdFilter denyWarnFilter = ThresholdFilter.createFilter(Level.WARN, DENY, Filter.Result.NEUTRAL);
    60. 
  
    
    
  
  60.  RollingFileAppender appender = RollingFileAppender.newBuilder()
    61. 
  
    
    
  
  61.  .withFilter(filter)
    62. 
  
    
    
  
  62.  .withFilter(denyWarnFilter)
    63. 
  
    
    
  
  63.  .withFileName(loggerDir + "-info.log")
    64. 
  
    
    
  
  64.  .withFilePattern(datalogDir + File.separator + "${date:yyyy-MM}" + File.separator + "info-%d{yyyy-MM-dd}-" + loggerName + ".%i.log")
    65. 
  
    
    
  
  65.  .withAppend(true)
    66. 
  
    
    
  
  66.  .withStrategy(strategy)
    67. 
  
    
    
  
  67.  .withName(loggerName + INFO)
    68. 
  
    
    
  
  68.  .withPolicy(policyComposite)
    69. 
  
    
    
  
  69.  .withLayout(layout)
    70. 
  
    
    
  
  70.  .withConfiguration(config)
    71. 
  
    
    
  
  71.  .build();
    72. 
  
    
    
  
  72.  appender.start();
    73. 
  
    
    
  
  73.  config.addAppender(appender);
    74. 
  
    
    
  
  74.  ThresholdFilter filterError = ThresholdFilter.createFilter(Level.ERROR, Filter.Result.ACCEPT, DENY);
    75. 
  
    
    
  
  75.  RollingFileAppender appenderError = RollingFileAppender.newBuilder()
    76. 
  
    
    
  
  76.  .withFilter(filterError)
    77. 
  
    
    
  
  77.  .withFileName(loggerDir + "-error.log")
    78. 
  
    
    
  
  78.  .withFilePattern(datalogDir + File.separator + "${date:yyyy-MM}" + File.separator + "error-%d{yyyy-MM-dd}-" + loggerName + ".%i.log")
    79. 
  
    
    
  
  79.  .withAppend(true)
    80. 
  
    
    
  
  80.  .withStrategy(strategy)
    81. 
  
    
    
  
  81.  .withName(loggerName + ERROR)
    82. 
  
    
    
  
  82.  .withPolicy(policyComposite)
    83. 
  
    
    
  
  83.  .withLayout(layout)
    84. 
  
    
    
  
  84.  .withConfiguration(config)
    85. 
  
    
    
  
  85.  .build();
    86. 
  
    
    
  
  86.  appenderError.start();
    87. 
  
    
    
  
  87.  config.addAppender(appenderError);
    88. 
  
    
    
  

    89. 
  
    
    
  
  89.  AppenderRef refInfo = AppenderRef.createAppenderRef(loggerName + INFO, null, null);
    90. 
  
    
    
  
  90.  AppenderRef refError = AppenderRef.createAppenderRef(loggerName + ERROR, null, null);
    91. 
  
    
    
  
  91.  AppenderRef[] refs = new AppenderRef[]{refInfo, refError};
    92. 
  
    
    
  
  92.  LoggerConfig loggerConfig = LoggerConfig.createLogger(false,
    93. 
  
    
    
  
  93.  Level.INFO, loggerName, "true", refs, null, config, null);
    94. 
  
    
    
  
  94.  loggerConfig.addAppender(appender, Level.INFO, null);
    95. 
  
    
    
  
  95.  loggerConfig.addAppender(appenderError, Level.ERROR, null);
    96. 
  
    
    
  
  96.  config.addLogger(loggerName, loggerConfig);
    97. 
  
    
    
  
  97.  ctx.updateLoggers();
    98. 
  
    
    
  
  98.  }
    99. 
  
    
    
  

    100. 
  
    
    
  
  100.  /**
    101. 
  
    
    
  
  101.  * 使用完之后记得调用此方法关闭动态创建的logger，避免内存不够用或者文件打开太多
    102. 
  
    
    
  
  102.  */
    103. 
  
    
    
  
  103.  public static void stop(BusinessEnum businessEnum) {
    104. 
  
    
    
  
  104.  String loggerName = businessEnum.getMessage();
    105. 
  
    
    
  
  105.  synchronized (config) {
    106. 
  
    
    
  
  106.  config.getAppender(loggerName + INFO).stop();
    107. 
  
    
    
  
  107.  config.getAppender(loggerName + ERROR).stop();
    108. 
  
    
    
  
  108.  config.getLoggerConfig(loggerName).removeAppender(loggerName + INFO);
    109. 
  
    
    
  
  109.  config.getLoggerConfig(loggerName).removeAppender(loggerName + ERROR);
    110. 
  
    
    
  
  110.  config.removeLogger(loggerName);
    111. 
  
    
    
  
  111.  ctx.updateLoggers();
    112. 
  
    
    
  
  112.  }
    113. 
  
    
    
  
  113.  }
    114. 
  
    
    
  

    115. 
  
    
    
  
  115.  /**
    116. 
  
    
    
  
  116.  * 获取Logger
    117. 
  
    
    
  
  117.  */
    118. 
  
    
    
  
  118.  public static Logger getLogger(BusinessEnum lotteryType) {
    119. 
  
    
    
  
  119.  String loggerName = lotteryType.getMessage();
    120. 
  
    
    
  
  120.  synchronized (config) {
    121. 
  
    
    
  
  121.  if (!config.getLoggers().containsKey(loggerName)) {
    122. 
  
    
    
  
  122.  start(loggerName);
    123. 
  
    
    
  
  123.  }
    124. 
  
    
    
  
  124.  }
    125. 
  
    
    
  
  125.  return LogManager.getLogger(loggerName);
    126. 
  
    
    
  
  126.  }
    127. 
  
    
    
  
  127. }
    128. 
  
    
    
  
  128. // LotteryType 是一个枚举类，用来获取不同名称的日志，做业务分割
    129.

代码动态配置

 
   
   
 
    
  
    
    
  
  1. 1. 系统逻辑日志
    2. 
  
    
    
  
  2.  private static Logger log = LogManager.getLogger(BranchController.class);// 传入类class
    3. 
  
    
    
  

    4. 
  
    
    
  
  4. 2.自定义业务日志
    5. 
  
    
    
  
  5. private static Logger log = LogUtil.getLogger(LotteryType.FIVE);// lottryType为业务名称枚举，根据需求添加
    6.

代码中具体使用

 
   
   
 
    
  
    
    
  
  1. import org.apache.logging.log4j.LogManager;
    2. 
  
    
    
  
  2. import org.apache.logging.log4j.Logger;
    3. 
  
    
    
  

    4. 
  
    
    
  
  4. private static Logger log = LogManager.getLogger(CapitalDetailService.class);
    5. 
  
    
    
  

    6. 
  
    
    
  

    7. 
  
    
    
  
  7. log.info("日志信息") 
    8.

参考资料

 
Log4j2官方文档
http://logging.apache.org/log4j/2.x/manual/architecture.html 
Log4j2官方文档翻译
https://blog.csdn.net/liyiming2017/article/details/82781030 

更多文章


 

长按二维码关注，阅读我的程序员故事

以上是关于log4j2自定义动态配置日志的主要内容，如果未能解决你的问题，请参考以下文章

2019-07-03 log4j2 自定义ElasticSearch Appender

log4j2如何实现日志自脱敏？山人自有妙计！

log4j2自定义Appender（输出到文件/RPC服务中）

Spring Boot + Log4j2 日志框架配置 (Maven)

教你打印自己的日志 -- 如何自定义 log4j2 各组件

利用 Log4j2 异步保存日志到 MongoDB 中