使用 Lombok log 管理项目日志

2021年03月11日 19:57 · 阅读(1163) ·

开发环境

名称 版本
操作系统 Windows 10 X64
JDK JDK1.8（jdk-8u151-windows-x64）
IntelliJ IDEA IntelliJ IDEA 2018.3
Maven Maven 3.6.0
lombok 1.18.8

相关内容

IntelliJ IDEA 2018.3 安装 Lombok 插件

引用 lombok 使用 log 提示找不到符号

项目结构

pom.xml 引用

  1. <dependencies>
  2.     <dependency>
  3.         <groupId>org.projectlombok</groupId>
  4.         <artifactId>lombok</artifactId>
  5.         <version>1.18.8</version>
  6.     </dependency>
  7. </dependencies>

application.yml

  1. logging:
  2.   config: classpath:logback-dev.xml

logback-dev.xml

  1. <!-- Logback configuration. See http://logback.qos.ch/manual/index.html -->
  2. <configuration scan="true" scanPeriod="10 seconds">
  3.     <!--继承spring boot提供的logback配置-->
  4.     <!--<include resource="org/springframework/boot/logging/logback/base.xml" />-->
  6.     <!--设置系统日志目录-->
  7.     <property name="APP_DIR" value="demo-eureka" />
  9.     <!-- 彩色日志 -->
  10.     <!-- 彩色日志依赖的渲染类 -->
  11.     <conversionRule conversionWord="clr" converterClass="org.springframework.boot.logging.logback.ColorConverter" />
  12.     <conversionRule conversionWord="wex" converterClass="org.springframework.boot.logging.logback.WhitespaceThrowableProxyConverter" />
  13.     <conversionRule conversionWord="wEx" converterClass="org.springframework.boot.logging.logback.ExtendedWhitespaceThrowableProxyConverter" />
  14.     <!-- 彩色日志格式 -->
  15.     <property name="CONSOLE_LOG_PATTERN" value="${CONSOLE_LOG_PATTERN:-%clr(%d{yyyy-MM-dd HH:mm:ss.SSS}){faint} %clr(${LOG_LEVEL_PATTERN:-%5p}) %clr(${PID:- }){magenta} %clr(---){faint} %clr([%15.15t]){faint} %clr(%-40.40logger{39}){cyan} %clr(:){faint} %m%n${LOG_EXCEPTION_CONVERSION_WORD:-%wEx}}"/>
  17.     <!-- 控制台输出 -->
  18.     <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
  19.         <encoder>
  20.             <Pattern>${CONSOLE_LOG_PATTERN}</Pattern>
  21.             <charset>UTF-8</charset> <!-- 此处设置字符集 -->
  22.         </encoder>
  23.         <!--此日志appender是为开发使用，只配置最底级别，控制台输出的日志级别是大于或等于此级别的日志信息-->
  24.         <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
  25.             <level>info</level>
  26.         </filter>
  27.     </appender>
  30.     <!-- 时间滚动输出 level为 DEBUG 日志 -->
  31.     <appender name="DEBUG_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
  32.         <!-- 正在记录的日志文件的路径及文件名 -->
  33.         <file>${LOG_PATH}/log_debug.log</file>
  34.         <!--日志文件输出格式-->
  35.         <encoder>
  36.             <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
  37.             <charset>UTF-8</charset> <!-- 此处设置字符集 -->
  38.         </encoder>
  39.         <!-- 日志记录器的滚动策略，按日期，按大小记录 -->
  40.         <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
  41.             <!--
  42.                 归档的日志文件的路径，例如今天是2017-04-26日志，当前写的日志文件路径为file节点指定，可以将此文件与file指定文件路径设置为不同路径，从而将当前日志文件或归档日志文件置不同的目录。
  43.                 而2017-04-26的日志文件在由fileNamePattern指定。%d{yyyy-MM-dd}指定日期格式，%i指定索引
  44.             -->
  45.             <fileNamePattern>${LOG_PATH}/debug/log-debug-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
  46.             <!--
  47.                 除按日志记录之外，还配置了日志文件不能超过500M，若超过500M，日志文件会以索引0开始，
  48.                 命名日志文件，例如log-error-2017-04-26.0.log
  49.             -->
  50.             <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
  51.                 <maxFileSize>500MB</maxFileSize>
  52.             </timeBasedFileNamingAndTriggeringPolicy>
  53.             <!--日志文件保留天数-->
  54.             <maxHistory>30</maxHistory>
  55.         </rollingPolicy>
  56.         <!-- 此日志文件只记录debug级别的 -->
  57.         <filter class="ch.qos.logback.classic.filter.LevelFilter">
  58.             <level>debug</level>
  59.             <onMatch>ACCEPT</onMatch>
  60.             <onMismatch>DENY</onMismatch>
  61.         </filter>
  62.     </appender>
  65.     <!-- 时间滚动输出 level为 INFO 日志 -->
  66.     <appender name="INFO_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
  67.         <!-- 正在记录的日志文件的路径及文件名 -->
  68.         <file>${LOG_PATH}/log_info.log</file>
  69.         <!--日志文件输出格式-->
  70.         <encoder>
  71.             <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
  72.             <charset>UTF-8</charset> <!-- 此处设置字符集 -->
  73.         </encoder>
  74.         <!-- 日志记录器的滚动策略，按日期，按大小记录 -->
  75.         <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
  76.             <!--
  77.                 归档的日志文件的路径，例如今天是2017-04-26日志，当前写的日志文件路径为file节点指定，可以将此文件与file指定文件路径设置为不同路径，从而将当前日志文件或归档日志文件置不同的目录。
  78.                 而2017-04-26的日志文件在由fileNamePattern指定。%d{yyyy-MM-dd}指定日期格式，%i指定索引
  79.             -->
  80.             <fileNamePattern>${LOG_PATH}/info/log-info-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
  81.             <!--
  82.                 除按日志记录之外，还配置了日志文件不能超过500M，若超过500M，日志文件会以索引0开始，
  83.                 命名日志文件，例如log-error-2017-04-26.0.log
  84.             -->
  85.             <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
  86.                 <maxFileSize>500MB</maxFileSize>
  87.             </timeBasedFileNamingAndTriggeringPolicy>
  88.             <!--日志文件保留天数-->
  89.             <maxHistory>30</maxHistory>
  90.         </rollingPolicy>
  91.         <!-- 此日志文件只记录info级别的 -->
  92.         <filter class="ch.qos.logback.classic.filter.LevelFilter">
  93.             <level>info</level>
  94.             <onMatch>ACCEPT</onMatch>
  95.             <onMismatch>DENY</onMismatch>
  96.         </filter>
  97.     </appender>
  100.     <!-- 时间滚动输出 level为 WARN 日志 -->
  101.     <appender name="WARN_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
  102.         <!-- 正在记录的日志文件的路径及文件名 -->
  103.         <file>${LOG_PATH}/log_warn.log</file>
  104.         <!--日志文件输出格式-->
  105.         <encoder>
  106.             <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
  107.             <charset>UTF-8</charset> <!-- 此处设置字符集 -->
  108.         </encoder>
  109.         <!-- 日志记录器的滚动策略，按日期，按大小记录 -->
  110.         <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
  111.             <!--
  112.                 归档的日志文件的路径，例如今天是2017-04-26日志，当前写的日志文件路径为file节点指定，可以将此文件与file指定文件路径设置为不同路径，从而将当前日志文件或归档日志文件置不同的目录。
  113.                 而2017-04-26的日志文件在由fileNamePattern指定。%d{yyyy-MM-dd}指定日期格式，%i指定索引
  114.             -->
  115.             <fileNamePattern>${LOG_PATH}/warn/log-warn-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
  116.             <!--
  117.                 除按日志记录之外，还配置了日志文件不能超过500M，若超过500M，日志文件会以索引0开始，
  118.                 命名日志文件，例如log-error-2017-04-26.0.log
  119.             -->
  120.             <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
  121.                 <maxFileSize>500MB</maxFileSize>
  122.             </timeBasedFileNamingAndTriggeringPolicy>
  123.             <!--日志文件保留天数-->
  124.             <maxHistory>30</maxHistory>
  125.         </rollingPolicy>
  126.         <!-- 此日志文件只记录warn级别的 -->
  127.         <filter class="ch.qos.logback.classic.filter.LevelFilter">
  128.             <level>warn</level>
  129.             <onMatch>ACCEPT</onMatch>
  130.             <onMismatch>DENY</onMismatch>
  131.         </filter>
  132.     </appender>
  135.     <!-- 时间滚动输出 level为 ERROR 日志 -->
  136.     <appender name="ERROR_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
  137.         <!-- 正在记录的日志文件的路径及文件名 -->
  138.         <file>${LOG_PATH}/log_error.log</file>
  139.         <!--日志文件输出格式-->
  140.         <encoder>
  141.             <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
  142.             <charset>UTF-8</charset> <!-- 此处设置字符集 -->
  143.         </encoder>
  144.         <!-- 日志记录器的滚动策略，按日期，按大小记录 -->
  145.         <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
  146.             <!--
  147.                 归档的日志文件的路径，例如今天是2017-04-26日志，当前写的日志文件路径为file节点指定，可以将此文件与file指定文件路径设置为不同路径，从而将当前日志文件或归档日志文件置不同的目录。
  148.                 而2017-04-26的日志文件在由fileNamePattern指定。%d{yyyy-MM-dd}指定日期格式，%i指定索引
  149.             -->
  150.             <fileNamePattern>${LOG_PATH}/error/log-error-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
  151.             <!--
  152.                 除按日志记录之外，还配置了日志文件不能超过500M，若超过500M，日志文件会以索引0开始，
  153.                 命名日志文件，例如log-error-2017-04-26.0.log
  154.             -->
  155.             <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
  156.                 <maxFileSize>500MB</maxFileSize>
  157.             </timeBasedFileNamingAndTriggeringPolicy>
  158.             <!--日志文件保留天数-->
  159.             <maxHistory>30</maxHistory>
  160.         </rollingPolicy>
  161.         <!-- 此日志文件只记录ERROR级别的 -->
  162.         <filter class="ch.qos.logback.classic.filter.LevelFilter">
  163.             <level>error</level>
  164.             <onMatch>ACCEPT</onMatch>
  165.             <onMismatch>DENY</onMismatch>
  166.         </filter>
  167.     </appender>
  169.     <logger name="org.springframework.web" level="info"/>
  170.     <logger name="org.springframework.scheduling.annotation.ScheduledAnnotationBeanPostProcessor" level="INFO"/>
  171.     <!--name的属性值一定要是当前工程的java代码的完整目录,因为mybatis打印的日志级别是debug级别的，因此需要配置debug级别日志扫描的目录-->
  172.     <logger name="com.demo.eureka" level="debug"/>
  174.     <!--开发环境:打印控制台-->
  175.     <!--<springProfile name="dev">-->
  176.     <root level="info">
  177.         <appender-ref ref="CONSOLE" />
  178.         <appender-ref ref="DEBUG_FILE" />
  179.         <appender-ref ref="INFO_FILE" />
  180.         <appender-ref ref="WARN_FILE" />
  181.         <appender-ref ref="ERROR_FILE" />
  182.     </root>
  183.     <!--</springProfile>-->
  185.     <!--测试环境:打印控制台和输出到文件-->
  186.     <springProfile name="test">
  187.         <root level="info">
  188.             <appender-ref ref="CONSOLE" />
  189.             <appender-ref ref="INFO_FILE" />
  190.             <appender-ref ref="WARN_FILE" />
  191.             <appender-ref ref="ERROR_FILE" />
  192.         </root>
  193.     </springProfile>
  195.     <!--生产环境:输出到文件-->
  196.     <springProfile name="prod">
  197.         <root level="info">
  198.             <appender-ref ref="DEBUG_FILE" />
  199.             <appender-ref ref="INFO_FILE" />
  200.             <appender-ref ref="ERROR_FILE" />
  201.         </root>
  202.     </springProfile>
  204. </configuration>

测试

  1. public static void main(String[] args) {
  2.     log.info("普通日志");
  3.     log.warn("警告日志");
  4.     log.error("错误日志");
  5. }

控制台打印

1.默认的情况

会在代码所在的目录 LOG_PATH_IS_UNDEFINED 下生成下面的日志

log_info.log

  1. 2021-03-11 19:36:34.186 [Thread-25] INFO  com.demo.eureka.EurekaStateChangeListener - 普通日志

log_warn.log

  1. 2021-03-11 19:36:34.187 [Thread-25] WARN  com.demo.eureka.EurekaStateChangeListener - 警告日志

log_error.log

  1. 2021-03-11 19:36:34.187 [Thread-25] ERROR com.demo.eureka.EurekaStateChangeListener - 错误日志

2.设置日志路径的情况

application.yml

  1. logging:
  2.   config: classpath:logback-dev.xml
  3.   path: /data/DATA_DIR/logs/demo/demo-eureka

运行程序，会在指定目录生成日志文件