1、日志框架

我们在写代码的时候,难免出现需要记录一下我们代码运行时出现的一下重要数据,出现的错误等等,于是就有大牛专门开发了一些与日志相关的框架,供我们使用
但是技术更新迭代,日志框架有时候不能满足所有的需求,因此出现了和JDBC-数据库驱动一样的统一的日志接口–日志门面(日志的一个抽象层):logging-abstract.jar
我们需要给项目中导入具体的日志实现就行了,我们之前的日志框架都是实现的抽象层

市面上有的日志框架:
JUL、JCL、Jboss-loggin、logback、log4j、log4j2、slf4j…

日志门面(日志的抽象层)

日志实现

JCL(jackarta Commons Logging) SLF4j(Simple Logging Facade for java ) jboss-logging

log4j JUL(java.until.logging) Log4j2 Logback

我们左边选一个门面(抽象层)、右边选一个实现
日志门面:SLF4J
日志实现:Logback

SpringBoot:底层是spring框架,Spring框架默认是用JCL
SpringBoot选用SLF4j 和 logback

2、SLF4j使用

2.1、 如何在系统中使用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");
  }
}

图示其他使用的步骤:

springboot 默认会生成error和info日志文件_spring boot


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

2.2、遗留问题

假设我们的一个项目,需要同时使用到Spring(Commons-logging)、Hibernate(jboss-logging)、MyBatis、xxx等等框架

那么我们需要统一日志,使别的框架和我一起统一的使用slf4j进行输出?

springboot 默认会生成error和info日志文件_日志框架_02


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

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

2.3、SpringBoot的日志关系

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

SpringBoot使用它来做日志功能

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

springboot 默认会生成error和info日志文件_xml_03


总结:

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();

springboot 默认会生成error和info日志文件_xml_04


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

2.4、日志的使用

2.4.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级别的,没有指定级别的就用SpringBoot默认规定的级别;root级别
		logger.info("这是info日志...");
		logger.warn("这是warn日志...");
		logger.error("这是error日志...");
	}

日志的输出格式

日志输出格式:
		%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.level.com.atguigu=trace

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

logging.file

logging.path

Example

Description

(none)

(none)

只在控制台输出

指定文件名

(none)

my.log

输出日志到my.log文件

(none)

指定目录

/var/log

输出到指定目录的 spring.log 文件中

2.4.2 指定配置

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

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

如果使用logback.xml作为日志配置文件,还要使用profile功能,会有以下错误: no applicable action for [springProfile]

2.4.5 切换日志框架

可以按照slf4j的日志适配图,进行相关的切换
slf4j+log4j的方式

<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

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