SpringBoot学习笔记——(二)日志

最新推荐文章于 2023-04-06 14:50:13 发布

巧笑情兮_美目盼兮

最新推荐文章于 2023-04-06 14:50:13 发布

阅读量312

点赞数

分类专栏： SpringBoot 文章标签： SpringBoot 日志

本文链接：https://blog.csdn.net/ITITII/article/details/83310163

版权

SpringBoot 专栏收录该内容

5 篇文章 1 订阅

订阅专栏

1. 日志框架

1.1 市面上主流的日志框架

市面上的日志框架：JUL、JCL、Jboss-logging、logback、log4j、log4j2、slf4j….

日志门面（日志的抽象层）	日志实现
~~JCL（Jakarta Commons Logging）~~、SLF4j（Simple Logging Facade for Java）、~~jboss-logging~~	Log4j、JUL（java.util.logging）、Log4j2、 Logback

SpringBoot：底层是Spring框架，Spring框架默认是用JCL；SpringBoot选用 SLF4j和logback；

1.2 SLF4J使用

关于SLF4J如何使用可以参考官方文档：SLF4J介绍

以后开发的时候，日志记录方法的调用，不应该来直接调用日志的实现类，而是调用日志抽象层里面的方法；给系统里面导入slf4j的jar和 logback的实现jar:

使用SLF4J的简单例子：

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
public class HelloWorld {
public static void main(String[] args) {
    Logger logger = LoggerFactory.getLogger(HelloWorld.class);
    logger.info("Hello World"); 
    }
}

下图是SLF4J抽象接口(也就是日志门面)整合其他日志实现的框架所需的依赖和使用原理：

每一个日志的实现框架都有自己的配置文件。使用slf4j以后，配置文件还是做成日志实现框架自己本身的配置文件；

1.3 遗留问题

假如，我自己开发的系统使用的日志框架是slf4j+logback。但是我们导入的spring框架底层使用的是commons-logging框架，导入的Hibernate使用的是jboss-logging日志框架等等。那么，我们如何让整个系统统一使用slf4j统一进行日志输出呢？

下图是官方提供的解决方案：

对上图中统一使用log-back日志输出整个系统的日志来做介绍：

首先第一步：把使用了commons-logging的日志框架替换为jcl-over-slf4j.jar、log4j替换为log4j-over-slf4j.jar、将logging替换为jul-to-slf4j.jar
第二步：引入slf4j日志门面框架:slf4j-api.jar
第三步：引用logback日志实现框加：logback-classic.jar和logback-core.jar

1.4 springboot日志关系

通过查看springboot依赖关系的源码可以发现：新建的一个springboot的web应用里面依赖了一个日志启动器的jar：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring‐boot‐starter‐logging</artifactId>
</dependency>

对springboot1.x日志依赖进行截图：

下面就给出springboot依赖日志的配置：

<dependencies>
    <dependency>
      <groupId>ch.qos.logback</groupId>
      <artifactId>logback-classic</artifactId>
      <version>1.2.3</version>
      <scope>compile</scope>
    </dependency>
    <dependency>
      <groupId>org.apache.logging.log4j</groupId>
      <artifactId>log4j-to-slf4j</artifactId>
      <version>2.10.0</version>
      <scope>compile</scope>
    </dependency>
    <dependency>
      <groupId>org.slf4j</groupId>
      <artifactId>jul-to-slf4j</artifactId>
      <version>1.7.25</version>
      <scope>compile</scope>
    </dependency>
  </dependencies>

总结：

1. SpringBoot底层也是使用slf4j+logback的方式进行日志记录
1. SpringBoot也把其他的日志都替换成了slf4j；
  
  注意：由于SpringBoot已经给我们提供了对所有日志的依赖。当我们向项目中依赖其他框架的时候一定要注意提出日志；这里就通过spring提出日志做演示：

<dependency>
    <groupId>org.springframework</groupId>
    <artifactId>spring‐core</artifactId>
    <exclusions>
        <exclusion>
            <groupId>commons‐logging</groupId>
            <artifactId>commons‐logging</artifactId>
        </exclusion>
    </exclusions>
</dependency>

1.5 使用日志

1.5.1 默认配置

SpringBoot已经帮我们对做了一些日志相关的自动配置；下面我们就在测试类中使用一下日志：

@RunWith(SpringRunner.class)
@SpringBootTest
public class SpringBootDemo06LoggingApplicationTests {

    Logger logger = LoggerFactory.getLogger(this.getClass());
    @Test
    public void contextLoads() {
        logger.trace("这是trace日志");
        logger.debug("这是debug日志");
        logger.info("这是info日志");
        logger.warn("这是warn日志");
        logger.error("这是error日志");
    }
}

运行结果：

2018-10-16 20:28:51.122  INFO 9416 --- [           main] .SpringBootDemo06LoggingApplicationTests : 这是info日志
2018-10-16 20:28:51.122  WARN 9416 --- [           main] .SpringBootDemo06LoggingApplicationTests : 这是warn日志
2018-10-16 20:28:51.122 ERROR 9416 --- [           main] .SpringBootDemo06LoggingApplicationTests : 这是error日志

通过控制台的打印信息，我们发现springboot应用值给我们输出了root级别的日志；这就证明springboot给我们进行了关于日志相关的默认配置

那么SpringBoot到底给我们做了哪些默认的配置呢？我们就一起去跟进springboot日志配置的配置文件瞧一瞧：**springboot日志的默认配置文件在spring-boot的一个jar包中的org.springframework.boot.logging.logback包下有一个base.xml配合文件：

base.xml:

?xml version="1.0" encoding="UTF-8"?>
<!--
Base logback configuration provided for compatibility with Spring Boot 1.1
-->
<included>
    <!--引入springboot的默认配置-->
	<include resource="org/springframework/boot/logging/logback/defaults.xml" />
	<!--springboot日志输出文件的位置-->
	<property name="LOG_FILE" value="${LOG_FILE:-${LOG_PATH:-${LOG_TEMP:-${java.io.tmpdir:-/tmp}}}/spring.log}"/>
	<!--输出到控制台的配置-->
	<include resource="org/springframework/boot/logging/logback/console-appender.xml" />
	<!--输出到文件中的配置-->
	<include resource="org/springframework/boot/logging/logback/file-appender.xml" />
	<!--默认配置了日志级别为info级别-->
	<root level="INFO"> 
		<appender-ref ref="CONSOLE" />
		<appender-ref ref="FILE" />
	</root>
</included>

defaults.xml：

<included>
	<conversionRule conversionWord="clr" converterClass="org.springframework.boot.logging.logback.ColorConverter" />
	<conversionRule conversionWord="wex" converterClass="org.springframework.boot.logging.logback.WhitespaceThrowableProxyConverter" />
	<conversionRule conversionWord="wEx" converterClass="org.springframework.boot.logging.logback.ExtendedWhitespaceThrowableProxyConverter" />
	<!--默认配置了日志输出到控制台的格式-->
	<property name="CONSOLE_LOG_PATTERN" value="${CONSOLE_LOG_PATTERN:-%clr(%d{${LOG_DATEFORMAT_PATTERN:-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}}"/>
	<!--默认配置了日志输出到文件中的格式-->
	<property name="FILE_LOG_PATTERN" value="${FILE_LOG_PATTERN:-%d{${LOG_DATEFORMAT_PATTERN:-yyyy-MM-dd HH:mm:ss.SSS}} ${LOG_LEVEL_PATTERN:-%5p} ${PID:- } --- [%t] %-40.40logger{39} : %m%n${LOG_EXCEPTION_CONVERSION_WORD:-%wEx}}"/>

	<logger name="org.apache.catalina.startup.DigesterFactory" level="ERROR"/>
	<logger name="org.apache.catalina.util.LifecycleBase" level="ERROR"/>
	<logger name="org.apache.coyote.http11.Http11NioProtocol" level="WARN"/>
	<logger name="org.apache.sshd.common.util.SecurityUtils" level="WARN"/>
	<logger name="org.apache.tomcat.util.net.NioSelectorPool" level="WARN"/>
	<logger name="org.eclipse.jetty.util.component.AbstractLifeCycle" level="ERROR"/>
	<logger name="org.hibernate.validator.internal.util.Version" level="WARN"/>
</included>

console-appender.xml：

<included>
	<appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
		<encoder>
			<pattern>${CONSOLE_LOG_PATTERN}</pattern>
		</encoder>
	</appender>
</included>

file-appender.xml:

<included>
	<appender name="FILE"
		class="ch.qos.logback.core.rolling.RollingFileAppender">
		<encoder>
			<pattern>${FILE_LOG_PATTERN}</pattern>
		</encoder>
		<file>${LOG_FILE}</file>
		<rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
			<fileNamePattern>${LOG_FILE}.%d{yyyy-MM-dd}.%i.gz</fileNamePattern>
			<maxFileSize>${LOG_FILE_MAX_SIZE:-10MB}</maxFileSize>
			<maxHistory>${LOG_FILE_MAX_HISTORY:-0}</maxHistory>
		</rollingPolicy>
	</appender>
</included>

1.5.2 用户自定义日志配置文件

关于用户自定义日志配置文件的详情：可以参考官方springboot用户手册的日志章节；

这里就给出一部分笔记：

**如果用户需要自己定义日志配置文件，可以直接在类路径下放上每个日志框架自己配置文件即可；这样springboot就不会使用默认配置啦。**关于每个哪个日志框架使用什么样的命名配置文件可以参看下表：

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

如果在类路径直接放一个logback.xml名字日志配置文件：在应用启动的时候会直接被logback日志框架加载，而不会被springboot加载。因此，就不能使用springboot提供相关日志的高级配置。如果使用logback-spring.xml的日志配置文件就能被springboot识别，就可以在该配置文件中使用springboot提供的高级配置。

关于springboot提供的高级配置举一例：

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

这里提供一个关于springboot配置logback的日志配置文件：

<?xml version="1.0" encoding="UTF-8"?>
<configuration debug="false">
    <!--定义日志文件的存储地址 勿在 LogBack 的配置中使用相对路径-->
    <property name="LOG_HOME" value="/test/log" />
    <!-- 控制台输出 -->
    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <!--格式化输出：%d表示日期，%thread表示线程名，%-5level：级别从左显示5个字符宽度%msg：日志消息，%n是换行符-->
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
        </encoder>
    </appender>
    <!-- 按照每天生成日志文件 -->
    <appender name="FILE"  class="ch.qos.logback.core.rolling.RollingFileAppender">
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!--日志文件输出的文件名-->
            <FileNamePattern>${LOG_HOME}/TestWeb.log.%d{yyyy-MM-dd}.log</FileNamePattern>
            <!--日志文件保留天数-->
            <MaxHistory>30</MaxHistory>
        </rollingPolicy>
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <!--格式化输出：%d表示日期，%thread表示线程名，%-5level：级别从左显示5个字符宽度%msg：日志消息，%n是换行符-->
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
        </encoder>
        <!--日志文件最大的大小-->
        <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
            <MaxFileSize>10MB</MaxFileSize>
        </triggeringPolicy>
    </appender>
    <!-- show parameters for hibernate sql 专为 Hibernate 定制 -->
    <logger name="org.hibernate.type.descriptor.sql.BasicBinder"  level="TRACE" />
    <logger name="org.hibernate.type.descriptor.sql.BasicExtractor"  level="DEBUG" />
    <logger name="org.hibernate.SQL" level="DEBUG" />
    <logger name="org.hibernate.engine.QueryParameters" level="DEBUG" />
    <logger name="org.hibernate.engine.query.HQLQueryPlan" level="DEBUG" />

    <!--myibatis log configure-->
    <logger name="com.apache.ibatis" level="TRACE"/>
    <logger name="java.sql.Connection" level="DEBUG"/>
    <logger name="java.sql.Statement" level="DEBUG"/>
    <logger name="java.sql.PreparedStatement" level="DEBUG"/>

    <!-- 日志输出级别 -->
    <root level="INFO">
        <appender-ref ref="STDOUT" />
        <appender-ref ref="FILE" />
    </root>
    <!--日志异步到数据库 -->
    <!--<appender name="DB" class="ch.qos.logback.classic.db.DBAppender">-->
        <!--&lt;!&ndash;日志异步到数据库 &ndash;&gt;-->
        <!--<connectionSource class="ch.qos.logback.core.db.DriverManagerConnectionSource">-->
            <!--&lt;!&ndash;连接池 &ndash;&gt;-->
            <!--<dataSource class="com.mchange.v2.c3p0.ComboPooledDataSource">-->
                <!--<driverClass>com.mysql.jdbc.Driver</driverClass>-->
                <!--<url>jdbc:mysql://127.0.0.1:3306/databaseName</url>-->
                <!--<user>root</user>-->
                <!--<password>root</password>-->
            <!--</dataSource>-->
        <!--</connectionSource>-->
    <!--</appender>-->
</configuration>