三、日志

3.1、日志框架

市面.上的日志框架：

JUL、JCL、boss-loging、logback、log4j、log4j2. slf4j...

日志门面(日志的抽象层)	日志实现
~~jCL (Jakarta CommonsLogging)~~ SLF4j(Simple Logging Facade for Java) ~~jboss-logging~~	Log4jJUL (java.tilgging )Log4j2 Logback

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

日志门面: SLF4J ;

日志实现: Logback ;

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

SpringBoot 选用SLF4j 和 logback ；

3.2、SLF4j的使用

3.2.1、如何在系统中使用SLF4j http://www.slf4j.org

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

给系统里面导入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");
  }
}

图示：

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

3.2.2、遗留问题

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

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

如何让系统中所有的日志都统-到sIf4j；

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

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

3）、我们导入sIf4j其他的实现；

3.3、SpringBoot日志关系

<dependency>
     <groupId>org.springframework.boot</groupId>
     <artifactId>spring-boot-starter</artifactId>
     <version>2.2.5.RELEASE</version>
     <scope>compile</scope>
</dependency>

SpringBoot使用它来做日志功能：

<dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-logging</artifactId>
      <version>2.2.5.RELEASE</version>
      <scope>compile</scope>
</dependency>

底层依赖关系：

总结：

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

2）、SpringBoot也把其他的日志都替换成了slf4j ；

3）、中间替换包；

4）、如果我们要引入其它框架？一定要把这个框架的默认日志依赖移除掉；

spring框架用的是commons-logging;

<!-- 说明：此处引用的为1.5.10中的配置，2.2.5中已不需要排除 -->
<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的方式记录日志,引入其他框架的时候,只需要把这个框架依赖的日志框架排除掉即可;

3.4、日志使用

3.4.1、默认配置

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

    //记录器
    Logger logger = LoggerFactory.getLogger(getClass());
    @Test
    void contextLoads() {
        //日志级别
        //由低到高
        //可以调整输出的日志级别;日志就只会在这个级别及以后的高级别生效
        logger.trace("trace");
        logger.debug("debug");
        //SpirngBoot默认的日志级别是info,没有指定级别的就用SpringBoot默认规定的级别:root 级别
        logger.info("inof");
        logger.warn("waun");
        logger.error("error");
    }

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

SpringBoot默认日志配置

logging.level.com.eppear=trace

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

# 在当前磁盘的根路径下创建spring文件夹和里面的log文件夹；使用 spring.log 作为默认文件
logging.filepath=/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.name	logging.fine.path	例子	描述
（none）	（none）		只在控制台输出
指定文件名	（none）	my.log	输出日志到my.log文件,可以包含相对路径或者绝对路径
（none）	指定目录	/var/log	输出到指定目录的spring.log文件中，目录可以相对位置，也可以是绝对位置

详见官方文档

3.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="dev | staging">
    <!-- configuration to be enabled when the "dev" or "staging" profiles are active -->
    可以指定某段配置只在某个环境下生效（此处配置为只在 dev或者staging 下生效）
</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.xmI作为日志配置文件,还要使用profile功能,会有以下错误:

l no applicable action for [springProfile]

3.5、切换日志框架

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

切换为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>
        <!-- 增加log4j2 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-log4j2</artifactId>
        </dependency>

建议使用SpringBoot推荐配置，不去更改日志框架。

来源：oschina

链接：https://my.oschina.net/6955825/blog/3194788

标签

logback