欢迎光临
我们一直在努力

Spring Boot 手摸手系列-日志框架使用

上一篇文章 Spring Boot 手摸手系列-日志框架 介绍了当下的日志框架,重点介绍了slf4j狸猫换太子。
下面为大家介绍下关于springboot的日志使用。
1、日志级别
由低到高分别为:trace–->debug-–>info-–>warn-–>error
设置日志的级别的初衷就是为了框架可以根据不同级别显示打印不同日志。
例如:springboot 默认的日志级别是info,那么控制台只会输出 info、warn、error这些日志级别大于等于info的日志。

package com.lin.san;
import org.junit.jupiter.api.Test;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.boot.test.context.SpringBootTest;
@SpringBootTest
public class LogTest {
	final Logger log = LoggerFactory.getLogger(LogTest.class);
	@Test
	public void test() {	
		log.trace("这是一个trace日志记录");
		log.debug("这是一个Debug的测试日志记录");
		log.info("这是一个info日志记录");
		log.warn("这是一个warn日志记录");
		log.error("这是一个error日志记录");
	}
}

2、定义日志输出名和输出位置
首先看下springboot官网提供如下的一个表

logging.file.namelogging.file.pathExample 描述(Description)
(none)(none) 仅控制台记录。
特指文档(none)my.log 写入指定的日志文件。名称可以是确切位置,也可以是相对于当前目录的位置
(none)目录/var/log 写入spring.log指定的目录。名称可以是确切位置,也可以是相对于当前目录的位置

logging.file.name 它是让我们写入指定名称的文件中,也可以指定这个文件的目录。
logging.file.path 它执行日志输出文件的目录;通常我们使用的就是这个变量

特别说明一点:这里的目录是/XX,则表示是根目录下这个XX目录。linux下就是/XX/ spring.log ;windows 则是当前这个盘下的根目录。

3、自定义日志输出格式
首先说下日志常见格式,如下:

  • %d: 日期时间
  • %thread或%t: 线程名
  • %-5level或%5p: 级别从左显示5个字符宽
  • %logger{50}: logger名字最长50个字符,否在按照句点分割
  • %msg : 日志消息
  • %n: 换行

官网也同时也很贴心的跟我们说了, Logback 如果要自定义日志格式应该定义什么什么? Log4j2 …;总之先看下表格:

Logging SystemCustomization
Logbacklogback-spring.xmllogback-spring.groovylogback.xml, or logback.groovy
Log4j2log4j2-spring.xml or log4j2.xml
JDK (Java Util Logging)logging.properties

使用不同的日志实现层,直接在resources目录下建立相对应的日志输出文件,日志框架默认就会加载这些文件,根据文件中格式输出日志。
而其实xxx-spring.xml 是由springboot去加载xml,它可以使用日志配置的高级功能:springProfile 这个配置 。 springProfile 就是咱们定义的不同开发环境。
非 xxx-spring.xml ,则是由格式日志框去加载,不会由 springboot 去加载,所以 springProfile 这个配置是无法使用的。
下面就以 logback-spring.xml 来举例使用。

<?xml version="1.0" encoding="UTF-8"?>
<!--
scan:当此属性设置为true时,配置文件如果发生改变,将会被重新加载,默认值为true。
scanPeriod:设置监测配置文件是否有修改的时间间隔,如果没有给出时间单位,默认单位是毫秒当scan为true时,此属性生效。默认的时间间隔为1分钟。
debug:当此属性设置为true时,将打印出logback内部日志信息,实时查看logback运行状态。默认值为false。
-->
<configuration scan="false" scanPeriod="60 seconds" debug="false">
   <!-- 定义日志的根目录 -->
   <property name="LOG_HOME" value="/app/log" />
   <!-- 定义日志文件名称 -->
   <property name="appName" value="linsan-springboot"></property>
   <!-- ch.qos.logback.core.ConsoleAppender 表示控制台输出 -->
   <appender name="stdout" class="ch.qos.logback.core.ConsoleAppender">
       <!--
       	  日志输出格式:
           %d表示日期时间,
           %thread表示线程名,
           %-5level:级别从左显示5个字符宽度
           %logger{50} 表示logger名字最长50个字符,否则按照句点分割。 
           %msg:日志消息,
           %n是换行符
       -->
       <layout class="ch.qos.logback.classic.PatternLayout">
           <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} =||= [%thread] %-5level %logger{50} - %msg%n</pattern>
       </layout>
   </appender>

   <!-- 滚动记录文件,先将日志记录到指定文件,当符合某个条件时,将日志记录到其他文件 -->  
   <appender name="appLogAppender" class="ch.qos.logback.core.rolling.RollingFileAppender">
       <!-- 指定日志文件的名称 -->
       <file>${LOG_HOME}/${appName}.log</file>
       <!--
       当发生滚动时,决定 RollingFileAppender 的行为,涉及文件移动和重命名
       TimeBasedRollingPolicy: 最常用的滚动策略,它根据时间来制定滚动策略,既负责滚动也负责出发滚动。
       -->
       <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
           <!--
           滚动时产生的文件的存放位置及文件名称 %d{yyyy-MM-dd}:按天进行日志滚动 
           %i:当文件大小超过maxFileSize时,按照i进行文件滚动
           -->
           <fileNamePattern>${LOG_HOME}/${appName}-%d{yyyy-MM-dd}-%i.log</fileNamePattern>
           <!-- 
           可选节点,控制保留的归档文件的最大数量,超出数量就删除旧文件。假设设置每天滚动,
           且maxHistory是365,则只保存最近365天的文件,删除之前的旧文件。注意,删除旧文件是,
           那些为了归档而创建的目录也会被删除。
           -->
           <MaxHistory>365</MaxHistory>
           <!-- 
           当日志文件超过maxFileSize指定的大小是,根据上面提到的%i进行日志文件滚动 注意此处配置SizeBasedTriggeringPolicy是无法实现按文件大小进行滚动的,必须配置timeBasedFileNamingAndTriggeringPolicy
           -->
           <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
               <maxFileSize>100MB</maxFileSize>
           </timeBasedFileNamingAndTriggeringPolicy>
       </rollingPolicy>
       <!-- 日志输出格式: -->     
       <layout class="ch.qos.logback.classic.PatternLayout">
           <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [ %thread ] - [ %-5level ] [ %logger{50} : %line ] - %msg%n</pattern>
       </layout>
   </appender>

   <!-- 
       logger主要用于存放日志对象,也可以定义日志类型、级别
       name:表示匹配的logger类型前缀,也就是包的前半部分
       level:要记录的日志级别,包括 TRACE < DEBUG < INFO < WARN < ERROR
       additivity:作用在于children-logger是否使用 rootLogger配置的appender进行输出,
       false:表示只用当前logger的appender-ref,true:
       表示当前logger的appender-ref和rootLogger的appender-ref都有效
   -->
   <!-- logger package-->
   <logger name="com.lin.san" level="info" />
   
   <!-- 
   root与logger是父子关系,没有特别定义则默认为root,任何一个类只会和一个logger对应,
   要么是定义的logger,要么是root,判断的关键在于找到这个logger,然后判断这个logger的appender和level。 
   -->
   <root level="info">
       <appender-ref ref="stdout" />
       <appender-ref ref="appLogAppender" />
   </root>
</configuration> 

将上述 logger package 位置处改成你的包名。
将他丢到 resources 目录下,你会发现你的控制台日志时间处,输出多了 =||= 的符号。

赞(0) 打赏
未经允许不得转载:我的技术分享 » Spring Boot 手摸手系列-日志框架使用
分享到: 更多 (0)

读后有所收获就请文章作者喝杯咖啡吧!

支付宝扫一扫打赏

微信扫一扫打赏