SpringBoot 日志的简单使用

日志的简单使用

1.1 默认配置

SpringBoot默认帮我们配置好了日志（使用slf4j作为日志门面，logback为日志框架）；

打开pom.xml，找到spring-boot-starter-web一栏，鼠标右击，Diagrams - Show Dependcies即可查看依赖关系

我们会发现，其实在引入web的时候，日志已经被引入进来了

默认配置可以从External Library栏找到：

@RunWith(SpringRunner.class)
@SpringBootTest
public class Demo3ApplicationTests {
    
    //此处的getClass()其实可有可无，但是为了方便定位日志是从哪个类输出的，还是最好带上
    Logger logger = LoggerFactory.getLogger(getClass());

    @Test
    public void contextLoads() {
        logger.trace("===== trace... =====");
        logger.debug("===== debug... =====");
        logger.info("===== info... =====");
        logger.warn("===== warn... =====");
        logger.error("===== error... =====");
    }

}

• 日志的级别为：trace < debug < info < warn < error

• SpringBoot的日志级别默认为 info，也就是说只有info及比info级别高的日志才会输出。

在默认配置下，运行以上代码输出日志如下：

2020-01-18 22:36:27.191  INFO 10660 --- [           main] com.example.demo3.Demo3ApplicationTests  : ===== info... =====
2020-01-18 22:36:27.192  WARN 10660 --- [           main] com.example.demo3.Demo3ApplicationTests  : ===== warn... =====
2020-01-18 22:36:27.192 ERROR 10660 --- [           main] com.example.demo3.Demo3ApplicationTests  : ===== error... =====

可以看出日志输出了时间、日志级别、线程、类名、日志信息五项内容

1.2 指定配置

日志输出的格式、输出方式（控制台、文件）等都可以通过指定配置文件的形式配置

1.2.1 日志输出格式

使用logging.pattern.console或logging.pattern.file指定，其格式如下：

日志输出格式：
%d表示日期时间，
%thread表示线程名，
%-5level：级别从左显示5个字符宽度
%logger{50} 表示logger名字最长50个字符，否则按照句点分割。 
%msg：日志消息，
%n是换行符
-->
%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n

#  在控制台输出的日志的格式
logging.pattern.console=%d{yyyy-MM-dd} [%thread] %-5level %logger{50} - %msg%n
# 指定文件中日志输出的格式
logging.pattern.file=%d{yyyy-MM-dd} === [%thread] === %-5level === %logger{50} ==== %msg%n

1.2.2 日志存储位置

在logging.path和logging.file两者都没有指定的情况下，日志将会输出在控制台，其他情况下输出至文件，如下表：

logging.file	logging.path	Example	Description
(none)	(none)		只在控制台输出
指定文件名	(none)	my.log	输出日志到my.log文件
(none)	指定目录	/var/log	输出到指定目录的 spring.log 文件中

• logging.path该属性用来配置日志文件的路径

• logging.file 该属性用来配置日志文件名，如果该属性不配置，默认文件名为spring.log

1.2.3 日志显示级别

全局：

logging.level.root=warn

指定包下：

logging.level.包名=warn

SpringBoot修改日志的默认配置

logging.level.com.atguigu=trace

#logging.path=
# 不指定路径在当前项目下生成springboot.log日志
# 可以指定完整的路径；
#logging.file=G:/springboot.log

# 在当前磁盘的根路径下创建spring文件夹和里面的log文件夹；使用 spring.log 作为默认文件
logging.path=/spring/log

#  在控制台输出的日志的格式
logging.pattern.console=%d{yyyy-MM-dd} [%thread] %-5level %logger{50} - %msg%n
# 指定文件中日志输出的格式
logging.pattern.file=%d{yyyy-MM-dd} === [%thread] === %-5level === %logger{50} ==== %msg%n

1.2.4 使用配置文件

给类路径下(src/main/resources)放上每个日志框架自己的配置文件即可；在使用配置文件后，SpringBoot就不使用他默认配置的了。

Logging System	Customization
Logback	logback-spring.xml, logback-spring.groovy, logback.xml or logback.groovy
Log4j2	log4j2-spring.xml or log4j2.xml
JDK (Java Util Logging)	logging.properties

官方推荐使用带有spring后缀名的格式，带spring后缀后可以使用Profile功能，根据不同的环境使用不同的配置。

• logback.xml：直接就被日志框架识别了；

• logback-spring.xml：日志框架就不直接加载日志的配置项，由SpringBoot解析日志配置，可以使用SpringBoot的高级Profile功能

<springProfile name="staging">
    <!-- configuration to be enabled when the "staging" profile is active -->
  	可以指定某段配置只在某个环境下生效
</springProfile>

如：

<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">
            <springProfile name="dev">
                <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} ----> [%thread] ---> %-5level %logger{50} - %msg%n</pattern>
            </springProfile>
            <springProfile name="!dev">
                <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} ==== [%thread] ==== %-5level %logger{50} - %msg%n</pattern>
            </springProfile>
        </layout>
    </appender>

如果使用logback.xml作为日志配置文件，还要使用profile功能，会有以下错误

no applicable action for [springProfile]

SpringBoot2.1.12 日志官方文档