四、SpringBoot之日志使用原理

版权声明:本文为博主原创文章,未经博主允许不得转载。 https://blog.csdn.net/qq_29479041/article/details/82863022

目录

一、日志框架

1、市面上的日志框架;

2、日志框架的选择

二、SLF4j使用原理

1、如何在系统中使用SLF4j

2、遗留问题

三、SpringBoot日志关系

四、日志使用;

1、默认配置

2、指定配置

五、切换日志框架


一、日志框架

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

2、日志框架的选择

日志门面(抽象层): SLF4J;

日志实现:Logback;

SpringBoot底层是Spring框架,Spring框架默认是用JCL;

SpringBoot选用 SLF4j和logback;

二、SLF4j使用原理

1、如何在系统中使用SLF4j

slf4j官网

以后开发的时候,日志记录方法的调用,不应该来直接调用日志的实现类,而是调用日志抽象层里面的方法;

给系统里面导入slf4j的jar和 logback的实现jar

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以后,配置文件还是使用日志实现框架自己本身的配置文件;

2、遗留问题

开发一个项目日志使用(slf4j+logback),但是这个项目要依赖很多不同的框架,比如:Spring(commons-logging)、Hibernate(jboss-logging)、MyBatis等等,每一个框架使用的日志框架又各不相同,这个时候该怎么办呢?

统一日志记录,所有框架一起统一使用slf4j进行输出。

如何让系统中所有的日志都统一到slf4j;

  • 1.将系统中其他日志框架先排除出去;
  • 2.用中间包来替换原有的日志框架;
  • 3.我们导入slf4j其他的实现

图示:

三、SpringBoot日志关系

springBoot依赖spring-boot-starter;

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

spring-boot-starter依赖spring-boot-starter-logging,SpringBoot使用它来做日志功能;

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

底层依赖关系;

总结:

  • SpringBoot底层也是使用slf4j+logback的方式进行日志记录
  • ​SpringBoot也把其他的日志都替换成了slf4j;
  • 中间替换包偷梁换柱将其他日志转换为slf4j;
@SuppressWarnings("rawtypes")
public abstract class LogFactory {

    static String UNSUPPORTED_OPERATION_IN_JCL_OVER_SLF4J = "http://www.slf4j.org/codes.html#unsupported_operation_in_jcl_over_slf4j";

    static LogFactory logFactory = new SLF4JLogFactory();

  • ​如果我们要引入其他框架,一定要把这个框架的默认日志依赖移除掉;

​ Spring框架用的是commons-logging,SpringBoot要排除commons-logging;

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

SpringBoot能自动适配所有的日志,而且底层使用slf4j+logback的方式记录日志,引入其他框架的时候,只需要把这个框架依赖的日志框架排除掉即可;

四、日志使用;

1、默认配置

SpringBoot默认帮我们配置好了日志,测试一下:

    //记录器
    Logger logger = LoggerFactory.getLogger(getClass());
    @Test
    public void contextLoads() {
        //System.out.println();

        //日志的级别;
        //由低到高  trace<debug<info<warn<error
        //可以调整输出的日志级别;日志就只会在这个级别以以后的高级别生效
        logger.trace("这是trace日志...");
        logger.debug("这是debug日志...");
        //SpringBoot默认给我们使用的是info级别的,所以只会输出info级别及以后级别,没有指定级别的就用SpringBoot默认规定的级别;root级别
        //我们可以在配置文件中指定级别:logging.level.com.atguigu=trace
        logger.info("这是info日志...");
        logger.warn("这是warn日志...");
        logger.error("这是error日志...");
    }

SpringBoot修改日志的默认配置:

# 指定日志级别,默认是info级别
logging.level.com.atguigu=trace

# 不指定路径在当前项目下生成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


# 日志输出格式:
# %d表示日期时间,
# %thread表示线程名,
# %-5level:级别从左显示5个字符宽度
# %logger{50} 表示logger名字最长50个字符,否则按照句点分割。 
# %msg:日志消息,
%n是换行符
logging.file logging.path Example Description
(none) (none)   只在控制台输出
指定文件名 (none) my.log 输出日志到my.log文件
(none) 指定目录 /var/log 输出到指定目录的 spring.log 文件中

在这个jar包里有SpringBoot的默认配置

2、指定配置

给类路径下放上每个日志框架自己的配置文件即可;SpringBoot就不使用他默认配置的了。

Logging System Customization(自己的配置文件名称)
Logback logback-spring.xmllogback-spring.groovylogback.xml or logback.groovy
Log4j2 log4j2-spring.xml or log4j2.xml
JDK (Java Util Logging) logging.properties

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">
        <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]

五、切换日志框架

可以按照slf4j的日志适配图,进行相关的切换;

面向slf4j编程,但是要用log4j实现,slf4j+log4j的方式;

<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-web</artifactId>
  <!-- 排除logback依赖包,和把log4j替换成slf4j的依赖包-->
  <exclusions>
    <exclusion>
      <artifactId>logback-classic</artifactId>
      <groupId>ch.qos.logback</groupId>
    </exclusion>
    <exclusion>
      <artifactId>log4j-over-slf4j</artifactId>
      <groupId>org.slf4j</groupId>
    </exclusion>
  </exclusions>
</dependency>
 <!-- 导入slf4j替换成log4j的依赖包-->
<dependency>
  <groupId>org.slf4j</groupId>
  <artifactId>slf4j-log4j12</artifactId>
</dependency>

或者这样做切换为log4j2:

   <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-web</artifactId>
      <exclusions>
         <!-- 排除 spring-boot-starter-logging -->
         <exclusion>
            <artifactId>spring-boot-starter-logging</artifactId>
            <groupId>org.springframework.boot</groupId>
         </exclusion>
      </exclusions>
   </dependency>
    <!-- 导入 spring-boot-starter-log4j2 -->
   <dependency>
     <groupId>org.springframework.boot</groupId>
     <artifactId>spring-boot-starter-log4j2</artifactId>
  </dependency>

猜你喜欢

转载自blog.csdn.net/qq_29479041/article/details/82863022
今日推荐