Spring Boot与日志

Updated on with 0 views and 0 comments

市面上的日志框架: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 |

左边选一个门面(抽象层)、右边来选一个实现;

日志门面: SLF4J;

日志实现:Logback;

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

SpringBoot 选用 SLF4j 和 logback

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");
  }
}

image.png

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

遗留问题

a(slf4j+logback): Spring(commons-logging)、Hibernate(jboss-logging)、MyBatis、xxxx

统一日志记录,即使是别的框架和我一起统一使用 slf4j 进行输出?

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

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

SpringBoot 的日志关系

SpringBoot 使用它来做日志功能;

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

底层依赖关系

image.png

总结:

  1. 、SpringBoot 底层也是使用 slf4j+logback 的方式进行日志记录
  2. 、SpringBoot 也把其他的日志都替换成了 slf4j;
  3. 、中间替换包?
@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();

image.png

  1. 如果我们要引入其他框架?一定要把这个框架的默认日志依赖移除掉?
Spring 框架用的是 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 的方式记录日志,引入其他框架的时候,只需要把这个框架依赖的日志框架排除掉即可;

日志使用

Spring 默认帮我们配置好了日志

//记录器
Logger logger = LoggerFactory.getLogger(getClass());
@Test
void contextLoads() {
    //日志级别,由低到高trace < debug < info < warn < error
    //可以调整日志的输出级别,就只会输出在此级别以及高级别的日志
    logger.trace("trace");
    logger.debug("debug");
    //spring默认给我们使用的是info级别,没有指定级别的就用SpringBoot默认规定的级别:root级别
    logger.info("info");
    logger.warn("warn");
    logger.error("error");
    System.out.println(person);
}

SpringBoot 修改日志的默认配置

logging.level.com.wu.springbootdemo=trace

#logging.path=
#指定日志输出的文件名,可以指定完整路径,springboot2.2前的是logging.file
#logging.file.name=G:/spring.log
#在当前磁盘的根路径下创建spring文件夹和里面的log文件夹,使用spring.log作为默认文件,springboot2.2前是logging.path
#logging.file.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是换行符

%d{yyyy-MM-dd HH:mm:ss.SSS} [%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 功能(带 Spring 的才能使用高级功能)

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

在主配置文件中要激活该功能
spring.profiles.active=dev

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

no applicable action for [springProfile]

切换到 log4j
<dependency>
   <groupId>org.springframework.boot</groupId>
   <artifactId>spring-boot-starter-web</artifactId>
   <exclusions>
       <!-- 排除两个依赖 -->
       <!-- 要用到log4j,所以要排除logback -->
       <exclusion>
           <artifactId>logback-classic</artifactId>
           <groupId>ch.qos.logback</groupId>
       </exclusion>
       <!-- 这个依赖是将log4j转成其他实现,要用log4j需要去除 -->
       <exclusion>
           <artifactId>log4j-over-slf4j</artifactId>
           <groupId>org.slf4j</groupId>
       </exclusion>
   </exclusions>
</dependency>
<dependency>
   <!-- 导入log4j依赖 -->
   <groupId>org.slf4j</groupId>
   <artifactId>slf4j-log4j12</artifactId>
</dependency>
切换到 log4j2
<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>