SpringBoot导学课课件 第3章 Spring Boot日志

第3章SpringBoot日志第3章SpringBoot日志3.1

日志框架3.2

日志使用23.1日志框架3.1.1SpringBoot的日志SpringBoot使用CommonsLogging进行所有内部日志记录，但保留底层日志实现。项目中只要导入spring-boot-starter.jar依赖，就会传递导入spring-boot-starter-logging.jar，从IDEA的Maven面板可以查看依赖关系，如图3-1所示。spring-boot-starter-logging.jar依赖如下三个jar包：logback-classic.jar：它传递依赖于logback-core.jar和slf4j-api.jar。log4j-to-slf4j.jar：它传递依赖于log4j-api.jar和slf4j-api.jar。jul-to-slf4j.jar：它传递依赖于slf4j-api.jar。33.1.1SpringBoot的日志市面上常见的日志框架有很多，比如：SLF4J（SimpleLoggingFacadeforJava）、Log4j、Log4j2、Logback、JakartaCommonLogging（JCL）、java.util.logging（JUL）、jboss-logging等。这些日志框架又可分为日志门面和日志实现，如表3-1所示。左边选一个门面（抽象层），右边来选一个实现。SpringBoot底层是Spring框架，Spring框架默认使用JCL，spring-boot-starter-logging采用了SLF4j+Logback的组合形式，其中SLF4j作为日志门面，Logback作为日志实现，开发者通常不需要直接操作日志实现的API。SpringBoot默认会添加SLF4J依赖（slf4j-api.jar）和Logback依赖（logback-core.jar和slf4j-api.jar）。43.1.1SpringBoot的日志

SpringBoot框架需要整合大量第三方框架，而这些框架的底层可能会使用JCL、Log4j、JUL等日志。从依赖关系中可以看到，log4j-to-slf4j.jar用来将Log4j日志路由到SLF4J，jul-to-slf4j.jar用来将JUL日志路由到SLF4J。SpringBoot日志抽象层的示意如图3-2所示。

SpringBoot能自动适配日志，底层使用slf4j+logback的方式记录日志，引入其他框架的时候，只需要将这个框架依赖的日志框架移除掉，这样即可将底层日志实现改为使用其他框架。53.1.2Logback简介

Logback日志框架是由log4j创始人开发的另一套开源日志组件，是SpringBoot默认选择的日志实现，体系非常强大，提供了logback-core、logback-classic和logback-access三个模块供开发者使用。logback-core：是Logback的基础模块，是其它两个模块的基础模块。

logback-classic：可看成是Log4j的一个改进版本，此外logback-classic完整实现SLF4JAPI使开发者可以在其他日志框架（如Log4j）之间自由切换。logback-access：与Servlet容器（如Tomcat）集成，以提供HTTP访问日志功能。63.2日志使用3.2.1默认日志格式SpringBoot项目启动后，默认看到如图3-3所示的界面。从上图可以看到，Spring的Logo部分是SpringBoot框架自带的，日志格式大致如下：时间日期、日志级别、进程ID、分隔符、线程名称、记录器名称、日志内容。73.2.2日志级别在SpringBoot默认应用日志配置中，只会记录ERROR、WARN和INFO级别的日志消息，当然也可以指定日志级别进行日志输出，如果指定了日志级别，那么只会对应输出高于指定级别的日志信息。SpringBoot中日志级别如下：TRACE<DEBUG<INFO<WARN<ERROR。

下面通过示例来讲解SpringBoot日志的用法。(1)使用SpringInitializr方式创建一个名为chapter03的SpringBoot项目。(2)在项目的测试类Chapter03ApplicationTests中添加日志记录器Logger，并在contextLoads()测试方法中通过Logger调用相应级别的方法，代码如下所示：

运行测试方法contextLoads()，控制台输出的日志信息，如图3-4所示。8@SpringBootTestclassChapter03ApplicationTests{

//日志记录器

Loggerlogger=LoggerFactory.getLogger(getClass());

@Test

voidcontextLoads(){

//日志的级别，由低到高：trace<debug<info<warn<error//可调整输出日志级别；日志就只在这个级别以后的高级别生效

logger.trace("……这是trace日志……");

logger.debug("……这是debug日志……");

//SpringBoot默认给我们使用的是info级别的，没有指定级别的就用SpringBoot默认规定的级别

logger.info("……这是info日志……");

logger.warn("……这是warn日志……");

logger.error("……这是error日志……");}}3.2.2日志级别改变日志的设置级别。可以通过debug=true或trace=true等属性改变整个SpringBoot核心的日志级别；还可通过logging.level.<logger-name>=<level>属性设置指定日志的日志级别，其中<logger-name>代表日志名，通常就是包名或全限定类名，<level>则可以是trace、debug、info、warn和error等级别。

在perties配置文件中，设置日志级别为trace，设置如下：运行测试方法contextLoads()，控制台输出的日志信息，如图3-5所示。9#设置com.yzpc包下的类以trace级别输出.yzpc=trace3.2.3日志文件输出默认情况下，SpringBoot只会将日志消息输出到控制台，并不会将日志写入日志文件。如果要将日志输出到文件，只需在perties文件或application.yml文件内设置如下两个属性之一。

：设置日志文件，这里可以设置文件的绝对路径，也可设置文件的相对路径，如=my.log。logging.file.path：设置日志目录，设置好目录后，会在设置目录文件夹下创建一个spring.log文件，如logging.file.path=/D:/log。

上述两个属性，如只设置一个，SpringBoot应用会默认读取该配置；如果同时设置，只有会生效。103.2.3日志文件输出下面通过示例来讲解SpringBoot的日志文件输出。(1)不指定路径在当前项目根目录下生成日志文件

在chapter03项目的perties配置文件中，设置日志文件的名称，配置如下：

运行测试方法contextLoads()，控制台输出相应日志信息，查看chapter03项目的根目录，可以看到my.log的日志文件，打开my.log即可看到日志信息，如图3-6所示。11#不指定路径在当前项目下生成my.log日志=my.log3.2.3日志文件输出

(2)指定日志文件的输出目录将perties配置文件的的属性行注释掉，添加配置如下：运行测试方法contextLoads()，控制台输出相应日志信息，查看chapter03的根目录，可以看到生成一个SpringLogs的文件夹，里面有日志文件spring.log，如图3-7所示。12#指定日志文件的输出目录，使用spring.log作为默认文件logging.file.path=SpringLogs/3.2.3日志文件输出

(3)自定义路径和文件名生成日志文件

在perties配置文件中，屏蔽或删除logging.file.path属性行，添加的属性行，配置如下：

运行测试方法contextLoads()，控制台输出相应日志信息，查看d:/log/目录，可以看到同样生成了my.log日志文件。13#可以指定完整的路径和文件名生成日志文件=d:/log/my.log3.2.4自定义日志格式将日志输出到文件时，可通过logging.pattern.file属性和logging.pattern.console属性指定日志文件和控制台的输出格式，输出的日志格式如下。说明如下：

%d：表示日期时间。

%thread：表示线程名。

%-5level：表示级别从左显示5个字符宽度。

%logger{50}：表示logger名字最长50个字符，否则按照句点分割。

%msg：表示日志消息。

%n：表示换行符。14%d{yyyy-MM-ddHH:mm:ss.SSS}[%thread]%-5level%logger{50}-%msg%n3.2.4自定义日志格式

在chapter03项目的perties配置文件中，添加如下配置：

运行测试方法contextLoads()，控制台输出日志信息以及日志文件中的信息，如图3-8所示。15#在控制台输出的日志的格式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%n3.2.5基于XML配置日志1．SpringBoot的默认日志实现

在SpringBoot中默认使用Logback日志，如图3-9所示。SpringBoot为Logback提供了一些通用的配置文件，这些文件位于org/springframework/boot/logging/logback/路径下，其中常用的有如下几个：

defaults.xml：提供了转换规则及各种通用配置。

console-appender.xml：定义了一个ConsoleAppender，用于将日志输出到控制台。

file-appender.xml：定义一个RollingFileAppender，用于将日志输出到文件。

SpringBoot通过base.xml配置文件，加载上述的配置文件来实现日志。163.2.5基于XML配置日志2．控制台输出日志

在chapter03项目的src/main/resources目录下创建一个logback-spring.xml文件，注释掉perties文件中的属性值，logback-spring.xml配置文件的设置如下内容。

运行测试方法contextLoads()，控制台输出日志信息，如图3-10所示。17<?xmlversion="1.0"encoding="utf-8"?><configuration>

<!--控制台输出-->

<appendername="STDOUT"class="ch.qos.logback.core.ConsoleAppender">

<encoderclass="ch.qos.logback.classic.encoder.PatternLayoutEncoder">

<!--格式化输出：%date表示日期，%thread表示线程名，%-5level：级别从左显示5个字符宽度，%msg：日志消息，%n是换行符-->

<pattern>%date[%thread]%-5level%logger{50}-%msg%n

</pattern>

<charset>UTF-8</charset>

</encoder>

</appender>

<!--日志输出级别，等同于在配置文件中设置logging.pattern.level-->

<rootlevel="info">

<appender-refref="STDOUT"/>

</root>

<loggername="com.yzpc"level="debug"/>

</configuration>3.2.5基于XML配置日志3．日志文件输出

控制台输出日志文件的形式一般是在开发环境下使用，一般生产环境下需要将日志输出到日志文件进行日志分析，并将日志根据级别输出到不同日志文件中，如果日志文件太大，可以设置日志文件根据大小分隔，配置如下所示。

运行测试方法contextLoads()，在项目所在磁盘的根路径下，可以看到生成一个log文件夹，该文件中有按照日期生成的日志文件。183.2.6使用Log4j2日志实现

如果让SpringBoot底层使用Log4j2，在pom.xml文件中去除Logback依赖库，并添加Log4j2依赖库，依赖修改如下：

这里并没有单独去除Logback依赖库，SpringBoot为Log4j2也提供了对应的Starter，所以可以直接去除SpringBoot默认的日志Strater。添加spring-boot-starter-log4j2.jar依赖，它会传递性添加它所依赖的Log4j2依赖库和SLF4J依赖库，从IntelliJIDEA的Maven面板上可以看到依赖的JAR包，如图3-11所示。

通过上面的配置，将项目的底层日志框架改成了Log4j2，得益于SpringBoot日志的抽象机制。19<dependencies>