目录

springboot与日志

日志框架

市场上存在非常多的日志框架。JUL(java.util.logging),JCL(Apache Commons Logging),Log4j,Log4j2,Logback、SLF4j、jboss-logging等。 Spring Boot在框架内容部使用JCL,spring-boot-starter-logging采用了 slf4j+logback的形式,Spring Boot也能自动适配(jul、log4j2、logback) 并 简化配置

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

日志门面: SLF4J;日志实现:Logback;

SpringBoot:底层是Spring框架,Spring框架默认是用JCL(5以前,5以后使用log4j2);

SpringBoot默认选用 SLF4j和logback

self4j的使用

如何在系统中使用SLF4j

如何在系统中使用SLF4j

selft4j官网

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

http://img.cana.space/picStore/20201021234809.png

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

遗留问题

系统中使用slf4j+logback,引用的各个框架使用的日志实现不同,例如Spring(commons-logging)、Hibernate(jboss-logging)、MyBatis、xxxx

统一日志记录,即使别的框架和当前系统统一使用slf4j进行输出

参考官网:http://www.slf4j.org/legacy.html

http://img.cana.space/picStore/20201021235216.png

操作步骤:

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

注解@Slf4j的使用

如果不想每次都写private final Logger logger = LoggerFactory.getLogger(当前类名.class); 可以用注解@Slf4j;

前提:需要加入lombok依赖

springboot日志关系

在idea中查看pom文件,使用Diagrams查看依赖视图及操作依赖(eg:exclude)

http://img.cana.space/picStore/20201021235549.png

由依赖视图可知:

  1. SpringBoot底层也是使用slf4j+logback的方式进行日志记录

  2. SpringBoot也使用了中间转换包把其他的日志都替换成了slf4j;

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

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    
    <dependency>
             <groupId>org.springframework</groupId>
             <artifactId>spring-core</artifactId>
             <exclusions>
                 <exclusion>
                     <groupId>commons-logging</groupId>
                     <artifactId>commons-logging</artifactId>
                 </exclusion>
             </exclusions>
         </dependency>
    

日志的使用

默认配置

SpringBoot默认帮我们配置好了日志;

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
server.port=8081

logging.level.com.atguigu=trace

# By default, log output is only written to the console. If a log file is required, the
# {@code logging.file.path} and {@code logging.file.name} properties can be used.
logging.file.path=/tmp/com.eh/eden/springboot
# 经测试logging.file.path和logging.file.name共同使用只会在项目根目录下创建指定名称的日志文件,
# 不加logging.file.name会在指定路径下生成默认名称的日志文件,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

指定配置

参考官网

给类路径下放上每个日志框架自己的配置文件即可;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

logback.xml:直接就被日志框架识别了;

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

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

eg:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
<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>
          <!--如果是非dev环境则使用如下格式打印日志-->
            <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的方式;

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-web</artifactId>
  <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>

<dependency>
  <groupId>org.slf4j</groupId>
  <artifactId>slf4j-log4j12</artifactId>
</dependency>

启动器实现日志框架切换

切换为log4j2

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
   <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
            <exclusions>
                <exclusion>
                    <artifactId>spring-boot-starter-logging</artifactId>
                    <groupId>org.springframework.boot</groupId>
                </exclusion>
            </exclusions>
        </dependency>

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