logback的简单使用

曾经终败给现在 2022-11-05 11:59 145阅读 0赞

文章目录

  • 1、前置
  • 2、application.yml配置如下:
  • 3、logback-spring.xml基本配置如下:
  • 4、动态指定日志级别方式A:
  • 5、动态指定日志级别方式B:
  • 6、备注:

1、前置

1、先介绍logback-spring.xml基本配置
2、动态指定日志级别方式A
3、动态指定日志级别方式B
4、个人看法

2、application.yml配置如下:

  1. # logback-spring.xml中会应用以下参数
  2. # 日志保存目录
  3. log_path: ${LOG_PATH:/upload/logs}

3、logback-spring.xml基本配置如下:

在这里插入图片描述

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!-- 日志级别从低到高分为TRACE < DEBUG < INFO < WARN < ERROR < FATAL，如果设置为WARN，则低于WARN的信息都不会输出 -->
  3. <!-- scan:当此属性设置为true时，配置文件如果发生改变，将会被重新加载，默认值为true -->
  4. <!-- scanPeriod:设置监测配置文件是否有修改的时间间隔，如果没有给出时间单位，默认单位是毫秒。当scan为true时，此属性生效。默认的时间间隔为1分钟。 -->
  5. <!-- debug:当此属性设置为true时，将打印出logback内部日志信息，实时查看logback运行状态。默认值为false。 -->
  6. <configuration  scan="true" scanPeriod="10 seconds" debug="false">
  7.     <contextName>logback</contextName>
  8.     <!-- 该 <springProperty> 标签允许我们从Spring(application.yml)中获取属性，以便在Logback中使用。定义变量后，可以使“${ }”来使用变量 -->
  9.     <springProperty scope="context" name="log.path" source="log_path" defaultValue="/logs/chaim"/>
  10.     <!-- property: name的值是变量的名称，value的值时变量定义的值。通过定义的值会被插入到logger上下文中。定义变量后，可以使“${ }”来使用变量。 -->
  11.     <!-- 日志最大的历史 10天 -->
  12.     <property name="maxHistory" value="10" />
  13.     <!--日志文件大小-->
  14.     <property name="maxFileSize" value="10MB" />
  15.     <!--日志文件总大小-->
  16.     <property name="totalSizeCap" value="10GB" />
  18.     <!-- 彩色日志 -->
  19.     <!-- 彩色日志依赖的渲染类 -->
  20.     <conversionRule conversionWord="clr" converterClass="org.springframework.boot.logging.logback.ColorConverter" />
  21.     <conversionRule conversionWord="wex" converterClass="org.springframework.boot.logging.logback.WhitespaceThrowableProxyConverter" />
  22.     <conversionRule conversionWord="wEx" converterClass="org.springframework.boot.logging.logback.ExtendedWhitespaceThrowableProxyConverter" />
  23.     <!-- 彩色日志格式 -->
  24.     <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}}"/>
  27.     <!--输出到控制台-->
  28.     <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
  29. <!--        <!–此日志appender是为开发使用，只配置最底级别，控制台输出的日志级别是大于或等于此级别的日志信息–>-->
  30. <!--        <!–目前从我自己测试来看, 该优先级最高, 我一般不使用这个配置–>-->
  31. <!--        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">-->
  32. <!--            <level>info</level>-->
  33. <!--        </filter>-->
  34.         <encoder>
  35.             <Pattern>${CONSOLE_LOG_PATTERN}</Pattern>
  36.             <!-- 设置字符集 -->
  37.             <charset>UTF-8</charset>
  38.         </encoder>
  39.     </appender>
  41.     <!--输出到文件-->
  42.     <!-- 时间滚动输出 level为 DEBUG 日志 -->
  43.     <appender name="DEBUG_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
  44.         <!-- 正在记录的日志文件的路径及文件名 -->
  45.         <file>${log.path}/log_debug.log</file>
  46.         <!--日志文件输出格式-->
  47.         <encoder>
  48.             <pattern>%d{ yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{ 50} - %msg%n</pattern>
  49.             <charset>UTF-8</charset> <!-- 设置字符集 -->
  50.         </encoder>
  51.         <!-- 日志记录器的滚动策略，按日期，按大小记录 -->
  52.         <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
  53.             <!-- 日志归档 -->
  54.             <fileNamePattern>${log.path}/debug/log-debug-%d{ yyyy-MM-dd}.%i.log</fileNamePattern>
  55.             <maxFileSize>${maxFileSize}</maxFileSize>
  56.             <maxHistory>${maxHistory}}</maxHistory>
  57.             <totalSizeCap>${totalSizeCap}</totalSizeCap>
  58.         </rollingPolicy>
  59.         <!-- 此日志文件只记录debug级别的 -->
  60.         <filter class="ch.qos.logback.classic.filter.LevelFilter">
  61.             <level>DEBUG</level>
  62.             <onMatch>ACCEPT</onMatch>
  63.             <onMismatch>DENY</onMismatch>
  64.         </filter>
  65.     </appender>
  67.     <!-- 时间滚动输出 level为 INFO 日志 -->
  68.     <appender name="INFO_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
  69.         <!-- 正在记录的日志文件的路径及文件名 -->
  70.         <file>${log.path}/log_info.log</file>
  71.         <!--日志文件输出格式-->
  72.         <encoder>
  73.             <pattern>%d{ yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{ 50} - %msg%n</pattern>
  74.             <charset>UTF-8</charset>
  75.         </encoder>
  76.         <!-- 日志记录器的滚动策略，按日期，按大小记录 -->
  77.         <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
  78.             <!-- 每天日志归档路径以及格式 -->
  79.             <fileNamePattern>${log.path}/info/log-info-%d{ yyyy-MM-dd}.%i.log</fileNamePattern>
  80.             <maxFileSize>${maxFileSize}</maxFileSize>
  81.             <maxHistory>${maxHistory}}</maxHistory>
  82.             <totalSizeCap>${totalSizeCap}</totalSizeCap>
  83.         </rollingPolicy>
  84.         <!-- 此日志文件只记录info级别的 -->
  85.         <filter class="ch.qos.logback.classic.filter.LevelFilter">
  86.             <level>INFO</level>
  87.             <onMatch>ACCEPT</onMatch>
  88.             <onMismatch>DENY</onMismatch>
  89.         </filter>
  90.     </appender>
  92.     <!-- 时间滚动输出 level为 WARN 日志 -->
  93.     <appender name="WARN_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
  94.         <!-- 正在记录的日志文件的路径及文件名 -->
  95.         <file>${log.path}/log_warn.log</file>
  96.         <!--日志文件输出格式-->
  97.         <encoder>
  98.             <pattern>%d{ yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{ 50} - %msg%n</pattern>
  99.             <charset>UTF-8</charset> <!-- 此处设置字符集 -->
  100.         </encoder>
  101.         <!-- 日志记录器的滚动策略，按日期，按大小记录 -->
  102.         <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
  103.             <fileNamePattern>${log.path}/warn/log-warn-%d{ yyyy-MM-dd}.%i.log</fileNamePattern>
  104.             <maxFileSize>${maxFileSize}</maxFileSize>
  105.             <maxHistory>${maxHistory}}</maxHistory>
  106.             <totalSizeCap>${totalSizeCap}</totalSizeCap>
  107.         </rollingPolicy>
  108.         <!-- 此日志文件只记录warn级别的 -->
  109.         <filter class="ch.qos.logback.classic.filter.LevelFilter">
  110.             <level>WARN</level>
  111.             <onMatch>ACCEPT</onMatch>
  112.             <onMismatch>DENY</onMismatch>
  113.         </filter>
  114.     </appender>
  116.     <!-- 时间滚动输出 level为 ERROR 日志 -->
  117.     <appender name="ERROR_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
  118.         <!-- 正在记录的日志文件的路径及文件名 -->
  119.         <file>${log.path}/log_error.log</file>
  120.         <!--日志文件输出格式-->
  121.         <encoder>
  122.             <pattern>%d{ yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{ 50} - %msg%n</pattern>
  123.             <charset>UTF-8</charset> <!-- 此处设置字符集 -->
  124.         </encoder>
  125.         <!-- 日志记录器的滚动策略，按日期，按大小记录 -->
  126.         <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
  127.             <fileNamePattern>${log.path}/error/log-error-%d{ yyyy-MM-dd}.%i.log</fileNamePattern>
  128.             <maxFileSize>${maxFileSize}</maxFileSize>
  129.             <maxHistory>${maxHistory}}</maxHistory>
  130.         </rollingPolicy>
  131.         <!-- 此日志文件只记录ERROR级别的 -->
  132.         <filter class="ch.qos.logback.classic.filter.LevelFilter">
  133.             <level>ERROR</level>
  134.             <onMatch>ACCEPT</onMatch>
  135.             <onMismatch>DENY</onMismatch>
  136.         </filter>
  137.     </appender>
  139.     <!--
  140.         <logger>用来设置某一个包或者具体的某一个类的日志打印级别、
  141.         以及指定<appender>。<logger>仅有一个name属性，
  142.         一个可选的level和一个可选的addtivity属性。
  143.         name:用来指定受此logger约束的某一个包或者具体的某一个类。
  144.         level:用来设置打印级别，大小写无关：TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF，还有一个特俗值INHERITED或者同义词NULL，代表强制执行上级的级别。如果未设置此属性，那么当前logger将会继承上级的级别。
  145.         addtivity:是否向上级logger传递打印信息。默认是true。
  146.         列:
  147.         使用mybatis的时候，sql语句是debug下才会打印，而这里我们配置的日志级别是:info，所以想要查看sql语句的话，有以下两种操作：
  148.         第一种修改日志级别为: DEBUG, 这样就会打印sql，不过这样日志那边会出现很多其他消息
  149.         第二种就是单独给dao下目录配置debug模式，代码如下，这样配置sql语句会打印，其他还是正常info级别：
  150.     -->
  151.     <logger name="com.chaim.system.mapper" level="DEBUG"/>
  152. <!--    <logger name="org.springframework.web" level="info"/>-->
  153. <!--    <logger name="org.springframework.scheduling.annotation.ScheduledAnnotationBeanPostProcessor" level="INFO"/>-->
  155.     <!--
  156.         root节点: 必选节点，用来指定最基础的日志输出级别，只有一个level属性
  157.         level:用来设置打印级别，大小写无关：TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF，
  158.         不能设置为INHERITED或者同义词NULL。默认是DEBUG
  159.         可以包含零个或多个元素，标识这个appender将会添加到这个logger。
  160.     -->
  161.     <root level="info">
  162.         <!-- ref关联appender节点的name值 -->
  163.         <appender-ref ref="CONSOLE" />
  164.         <appender-ref ref="DEBUG_FILE" />
  165.         <appender-ref ref="INFO_FILE" />
  166.         <appender-ref ref="WARN_FILE" />
  167.         <appender-ref ref="ERROR_FILE" />
  168.     </root>
  169. </configuration>

找到对应的目录下, 可以看到对应的日志已经被写入文件:
在这里插入图片描述

4、动态指定日志级别方式A:

  1. # application.yml添加一个参数:
  2. # 日志输出级别, true开发模式, false线上环境
  3. log_environment: ${LOG_ENVIRONMENT:true}
  5. # logback-spring.xml添加一个springProperty 标签:
  6. <springProperty scope="context" name="log_environment" source="log_environment" defaultValue="false"/>
  8. # 需依赖包:janino
  9. <dependency>
  10.    <groupId>org.codehaus.janino</groupId>
  11.    <artifactId>janino</artifactId>
  12.    <version>3.1.2</version>
  13. </dependency>

更改上面截图中的第三块:

  1. # 通过 p("log_environment") 来获取log_environment值
  2. # equals contains
  3. <if condition='"true".equals(p("log_environment"))'>
  4.         <then>
  5.             # 当log_environment==true, 指定日志级别:info 控制台输出, 以及对应的文件写入
  6.             <root level="info">
  7.                 <!-- ref关联appender节点的name值 -->
  8.                 <appender-ref ref="CONSOLE" />
  9.                 <appender-ref ref="DEBUG_FILE" />
  10.                 <appender-ref ref="INFO_FILE" />
  11.                 <appender-ref ref="WARN_FILE" />
  12.                 <appender-ref ref="ERROR_FILE" />
  13.             </root>
  14.         </then>
  15.         <else>
  16.             # 当log_environment!=true, 指定日志级别:error 控制台输出, 以及对应的日志级别文件写入
  17.             <root level="error">
  18.                 <appender-ref ref="CONSOLE" />
  19.                 <appender-ref ref="INFO_FILE" />
  20.                 <appender-ref ref="ERROR_FILE" />
  21.             </root>
  22.         </else>
  23.     </if>

关于 if 标签官方文档介绍:
地址:https://logback.qos.ch/manual/configuration.html
在这里插入图片描述

5、动态指定日志级别方式B:

配置环境, 两种方式:

  1. 第一种: 配置pom.xml:
  2. <profiles>
  3.         <profile>
  4.             <!-- 本地开发环境 -->
  5.             <id>dev</id>
  6.             <properties>
  7.                 <profiles.active>dev</profiles.active>
  8.             </properties>
  9.             <activation>
  10.                 <activeByDefault>true</activeByDefault>
  11.             </activation>
  12.         </profile>
  13.         <profile>
  14.             <!-- 线上运行环境 -->
  15.             <id>prod</id>
  16.             <properties>
  17.                 <profiles.active>prod</profiles.active>
  18.             </properties>
  19.         </profile>
  20.     </profiles>
  22. 第二种: 指定当前环境:
  23. # 在application.yml中指定当前环境参数:
  24. spring.profiles.active=dev

更改上面截图中的第三块:

  1. <!-- springProfile获取当前环境, 通过环境进行区分 -->
  2.     <!--开发环境:打印控制台-->
  3.     <springProfile name="dev">
  4.         <root level="info">
  5.             <appender-ref ref="CONSOLE" />
  6.             <appender-ref ref="DEBUG_FILE" />
  7.             <appender-ref ref="INFO_FILE" />
  8.             <appender-ref ref="WARN_FILE" />
  9.             <appender-ref ref="ERROR_FILE" />
  10.         </root>
  11.     </springProfile>
  13.     <!--生产环境:输出到文件-->
  14.     <springProfile name="prod">
  15.         <root level="error">
  16.             <appender-ref ref="CONSOLE" />
  17.             <appender-ref ref="INFO_FILE" />
  18.             <appender-ref ref="ERROR_FILE" />
  19.         </root>
  20.     </springProfile>

6、备注:

1、多测, 多做自测
2、个人推荐使用第5种方式, 通过环境区分, 轻便也简单
3、 以上只是列举了 一些基本的参数, 具体的大家可以借助搜素引擎的力量
4、不足的地方, 还望大家不吝赐教, 多多指正

发表评论

表情：
评论列表 （有 0 条评论，145人围观）

还没有评论，来说两句吧...

相关阅读