Spring Boot小记(8)

日志

作者 Wavy Peng 日期 2018-05-04
Spring Boot
Spring Boot小记(8)

日志框架

市面上的日志框架：

JUL(java.util.logging)、JCL(Apache Common Logging)、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

Spring Boot：底层是Spring框架，Spring框架默认是用JCL

spring-boot-starter-logging选用SLF4J和logback

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

日志使用方式图示：

1525437378819

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

遗留问题

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

1、将系统中其他日志框架先排除出去

2、用中间包来替换原有的日志框架

3、导入slf4j其他的实现

日志兼容

Spring Boot日志关系

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

Spring Boot使用它来实现日志功能

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

底层依赖关系

底层依赖关系

总结：

Spring Boot底层也是使用slf4j+logback的方式进行日志记录

Spring Boot也把其他的日志都替换成了slf4j

中间包替换

如果要引入其他框架，一定要把这个框架的默认日志依赖移除掉

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>

日志使用

1、默认配置

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

    //日志的级别
    //由低到高  trace<debug<info<warn<error
    //可以调整输出的日志级别：日志就只会在这个级别及以后的高级别生效
    logger.trace("这是trace日志");
    logger.debug("这是debug日志");
    //Spring Boot默认使用的是info级别以上的
    logger.info("这是info日志");
    logger.warn("这是warn日志");
    logger.error("这是error日志");
}

2、配置参数

logging.file logging.path Example Description
(none) (none) 只在控制台输出
指定文件名 (none) my.log 输出日志到my.log文件
(none) 指定目录 /var/log 输出到指定目录的spring.log文件中

3、输出格式

日志输出格式：
	%d表示日期时间
	%thread表示线程名
	%-5level表示级别从左显示5个字符宽度
	%logger{50}表示logger名字最长50个字符，否则按照句点分割
	%msg表示日志消息
	%n表示换行符
%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n

Spring Boot修改日志的默认配置

logging.level.com.atguigu=trace

# 不指定路径在当前项目下生成spring.log日志
# logging.file=springboot.log
# 可以指定完整的路径
# logging.file=D:/springboot.log

# 在当前磁盘的根目录下创建spring文件夹和里面的log文件夹，使用spring.log作为默认文件
logging.path=/spring/log

# 在控制台输出日志的格式
logging.pattern.console=%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n
# 在指定文件中日志输出的格式
logging.pattern.file=%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n

4、指定配置

给类路径下放上每个日志框架自己的配置文件即可，此时Spring Boot就不使用默认配置的了。

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：日志框架就不直接加载日志的配置项，由Spring Boot加载

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

否则

no application action for [springProfile]
<!-- logback-spring.xml -->
<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>

5、切换日志框架

可以按照slf4j的日志适配图，进行相关的切换。（不推荐）

举例：slf4j + log4j的方式 ↓↓↓

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
    <exclusions>
    	<exclusion>
        	<groupId>logback-classic</groupId>
    		<artifactId>ch.qos.logback</artifactId>
        </exclusion>
        <exclusion>
        	<groupId>log4j-over-slf4j</groupId>
    		<artifactId>org.slf4j</artifactId>
        </exclusion>
    </exclusions>
</dependency>
<dependency>
	<groupId>org.slf4j</groupId>
    <artifactId>slf4j-log4j12</artifactId>
</dependency>
FEATURED TAGS
Spring Boot