一. 工程pom依赖

springboot工程默认依赖 slf4j，logback 日志框架，如果使用lombok，依赖：

  1. <dependency>
  2.             <groupId>org.springframework.boot</groupId>
  3.             <artifactId>spring-boot-starter-web</artifactId>
  4. </dependency>
  6. <dependency>
  7.             <groupId>org.projectlombok</groupId>
  8.             <artifactId>lombok</artifactId>
  9.             <optional>true</optional>
  10. </dependency>

二. 配置

1. application.yml

  1. logging:
  2.   # 日志配置文件
  3.   config: classpath:logback-spring.xml
  4.   level:
  5.     # 日志打印sql语句
  6.     dao: debug
  7.     org:
  8.       mybatis: debug

2. logback-spring.xml

使用，修改变量 log.path /name

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!-- 日志级别从低到高分为TRACE < DEBUG < INFO < WARN < ERROR < FATAL，如果设置为WARN，则低于WARN的信息都不会输出 -->
  3. <!-- scan:当此属性设置为true时，配置文档如果发生改变，将会被重新加载，默认值为true -->
  4. <!-- scanPeriod:设置监测配置文档是否有修改的时间间隔，如果没有给出时间单位，默认单位是毫秒。
  5.                  当scan为true时，此属性生效。默认的时间间隔为1分钟。 -->
  6. <!-- debug:当此属性设置为true时，将打印出logback内部日志信息，实时查看logback运行状态。默认值为false。 -->
  7. <configuration  scan="true" scanPeriod="10 seconds">
  8.     <contextName>logback</contextName>
  10.     <!-- name的值是变量的名称，value的值时变量定义的值。通过定义的值会被插入到logger上下文中。定义后，可以使“${}”来使用变量。 -->
  11.     <property name="log.path" value="D:/logs/log" />
  12.     <property name="log.name" value="demo" />
  14.     <!--0. 日志格式和颜色渲染 -->
  15.     <!-- 彩色日志依赖的渲染类 -->
  16.     <conversionRule conversionWord="clr" converterClass="org.springframework.boot.logging.logback.ColorConverter" />
  17.     <conversionRule conversionWord="wex" converterClass="org.springframework.boot.logging.logback.WhitespaceThrowableProxyConverter" />
  18.     <conversionRule conversionWord="wEx" converterClass="org.springframework.boot.logging.logback.ExtendedWhitespaceThrowableProxyConverter" />
  19.     <!-- 彩色日志格式 -->
  20.     <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}}"/>
  22.     <!--1. 输出到控制台-->
  23.     <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
  24.         <!--此日志appender是为开发使用，只配置最底级别，控制台输出的日志级别是大于或等于此级别的日志信息-->
  25.         <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
  26.             <level>debug</level>
  27.         </filter>
  28.         <encoder>
  29.             <Pattern>${CONSOLE_LOG_PATTERN}</Pattern>
  30.             <!-- 设置字符集 -->
  31.             <charset>UTF-8</charset>
  32.         </encoder>
  33.     </appender>
  35.     <!--2. 输出到文档-->
  36.     <!-- 2.1 level为 DEBUG 日志，时间滚动输出  -->
  37.     <appender name="DEBUG_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
  38.         <!-- 正在记录的日志文档的路径及文档名 -->
  39.         <file>${log.path}/${log.name}_debug.log</file>
  40.         <!--日志文档输出格式-->
  41.         <encoder>
  42.             <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
  43.             <charset>UTF-8</charset> <!-- 设置字符集 -->
  44.         </encoder>
  45.         <!-- 日志记录器的滚动策略，按日期，按大小记录 -->
  46.         <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
  47.             <!-- 日志归档 -->
  48.             <fileNamePattern>${log.path}/${log.name}-debug-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
  49.             <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
  50.                 <maxFileSize>100MB</maxFileSize>
  51.             </timeBasedFileNamingAndTriggeringPolicy>
  52.             <!--日志文档保留天数-->
  53.             <maxHistory>15</maxHistory>
  54.         </rollingPolicy>
  55.         <!-- 此日志文档只记录debug级别的 -->
  56.         <filter class="ch.qos.logback.classic.filter.LevelFilter">
  57.             <level>debug</level>
  58.             <onMatch>ACCEPT</onMatch>
  59.             <onMismatch>DENY</onMismatch>
  60.         </filter>
  61.     </appender>
  63.     <!-- 2.2 level为 INFO 日志，时间滚动输出  -->
  64.     <appender name="INFO_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
  65.         <!-- 正在记录的日志文档的路径及文档名 -->
  66.         <file>${log.path}/${log.name}_info.log</file>
  67.         <!--日志文档输出格式-->
  68.         <encoder>
  69.             <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
  70.             <charset>UTF-8</charset>
  71.         </encoder>
  72.         <!-- 日志记录器的滚动策略，按日期，按大小记录 -->
  73.         <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
  74.             <!-- 每天日志归档路径以及格式 -->
  75.             <fileNamePattern>${log.path}/${log.name}-info-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
  76.             <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
  77.                 <maxFileSize>100MB</maxFileSize>
  78.             </timeBasedFileNamingAndTriggeringPolicy>
  79.             <!--日志文档保留天数-->
  80.             <maxHistory>15</maxHistory>
  81.         </rollingPolicy>
  82.         <!-- 此日志文档只记录info级别的 -->
  83.         <filter class="ch.qos.logback.classic.filter.LevelFilter">
  84.             <level>info</level>
  85.             <onMatch>ACCEPT</onMatch>
  86.             <onMismatch>DENY</onMismatch>
  87.         </filter>
  88.     </appender>
  90.     <!-- 2.3 level为 WARN 日志，时间滚动输出  -->
  91.     <appender name="WARN_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
  92.         <!-- 正在记录的日志文档的路径及文档名 -->
  93.         <file>${log.path}/${log.name}_warn.log</file>
  94.         <!--日志文档输出格式-->
  95.         <encoder>
  96.             <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
  97.             <charset>UTF-8</charset> <!-- 此处设置字符集 -->
  98.         </encoder>
  99.         <!-- 日志记录器的滚动策略，按日期，按大小记录 -->
  100.         <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
  101.             <fileNamePattern>${log.path}/${log.name}-warn-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
  102.             <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
  103.                 <maxFileSize>100MB</maxFileSize>
  104.             </timeBasedFileNamingAndTriggeringPolicy>
  105.             <!--日志文档保留天数-->
  106.             <maxHistory>15</maxHistory>
  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.     <!-- 2.4 level为 ERROR 日志，时间滚动输出  -->
  117.     <appender name="ERROR_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
  118.         <!-- 正在记录的日志文档的路径及文档名 -->
  119.         <file>${log.path}/${log.name}_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.TimeBasedRollingPolicy">
  127.             <fileNamePattern>${log.path}/${log.name}-error-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
  128.             <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
  129.                 <maxFileSize>100MB</maxFileSize>
  130.             </timeBasedFileNamingAndTriggeringPolicy>
  131.             <!--日志文档保留天数-->
  132.             <maxHistory>15</maxHistory>
  133.         </rollingPolicy>
  134.         <!-- 此日志文档只记录ERROR级别的 -->
  135.         <filter class="ch.qos.logback.classic.filter.LevelFilter">
  136.             <level>ERROR</level>
  137.             <onMatch>ACCEPT</onMatch>
  138.             <onMismatch>DENY</onMismatch>
  139.         </filter>
  140.     </appender>
  142.     <!--
  143.         <logger>用来设置某一个包或者具体的某一个类的日志打印级别、
  144.         以及指定<appender>。<logger>仅有一个name属性，
  145.         一个可选的level和一个可选的addtivity属性。
  146.         name:用来指定受此logger约束的某一个包或者具体的某一个类。
  147.         level:用来设置打印级别，大小写无关：TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF，
  148.               还有一个特俗值INHERITED或者同义词NULL，代表强制执行上级的级别。
  149.               如果未设置此属性，那么当前logger将会继承上级的级别。
  150.         addtivity:是否向上级logger传递打印信息。默认是true。
  151.         <logger name="org.springframework.web" level="info"/>
  152.         <logger name="org.springframework.scheduling.annotation.ScheduledAnnotationBeanPostProcessor" level="INFO"/>
  153.     -->
  155.     <!--
  156.         使用mybatis的时候，sql语句是debug下才会打印，而这里我们只配置了info，所以想要查看sql语句的话，有以下两种操作：
  157.         第一种把<root level="info">改成<root level="DEBUG">这样就会打印sql，不过这样日志那边会出现很多其他消息
  158.         第二种就是单独给dao下目录配置debug模式，代码如下，这样配置sql语句会打印，其他还是正常info级别：
  159.         【logging.level.org.mybatis=debug logging.level.dao=debug】
  160.      -->
  162.     <!--
  163.         root节点是必选节点，用来指定最基础的日志输出级别，只有一个level属性
  164.         level:用来设置打印级别，大小写无关：TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF，
  165.         不能设置为INHERITED或者同义词NULL。默认是DEBUG
  166.         可以包含零个或多个元素，标识这个appender将会添加到这个logger。
  167.     -->
  169.     <!-- 4. 最终的策略，application.yml 使用 dev & prod 对应配置 -->
  170.     <!-- 4.1 开发环境:打印控制台-->
  171.     <springProfile name="dev">
  172.         <root level="info">
  173.             <appender-ref ref="CONSOLE" />
  174.         </root>
  175.     </springProfile>
  177.     <!-- 4.2 生产环境:输出到文档
  178.     <springProfile name="prod">
  179.         <root level="info">
  180.             <appender-ref ref="DEBUG_FILE" />
  181.             <appender-ref ref="INFO_FILE" />
  182.             <appender-ref ref="ERROR_FILE" />
  183.             <appender-ref ref="WARN_FILE" />
  184.         </root>
  185.     </springProfile> -->
  187. </configuration>

三. 使用

  1. application.yml 使用哪个环境的配置文件，则使用不同的日志级别配置

  2. 通过工厂引入日志

    1. Logger logger = LoggerFactory.getLogger(getClass());

    3.通过 lombok 引入，类增加注解，直接 log.info().

    1. @Slf4j
    2. public class TestServiceImpl implements TestService {
    4.      // 日志级别由低到高  ·{} 占位符方式·
    5.      log.info("info级别日志");
    6.      log.debug("debug级别日志");
    7.      log.warn("warn{}","级别日志");
    8.      log.error("error级别日志");