2.1 日志框架

最新推荐文章于 2025-01-22 18:00:00 发布

原创最新推荐文章于 2025-01-22 18:00:00 发布 · 125 阅读

0 ·

CC 4.0 BY-SA版权

文章标签：

#SpringBoot日志

本文深入探讨了日志框架如SLF4j、Logback、Log4j2等在Java项目中的应用，特别关注SpringBoot环境下日志的配置与使用。讲解了如何统一不同框架的日志输出，通过示例展示了日志级别设置及日志文件的格式化。

二.日志

2.1 日志框架

JUL、JCL、Jboos-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日志框架

2.2 SLF4j使用

1.如何在系统中使用SLF4j

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

给系统里面导入slf4j的jar和logback的实现

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class HelloWorld {
  public static void main(String[] args) {
    Logger logger = LoggerFactory.getLogger(HelloWorld.class);  //在本类当中获取logger对象
    logger.info("Hello World");   //使用logger对象进行信息写入
  }
}

如果要使用log4j 则需要slf4j-log412.jar 转换包进行转换。

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

2.3 遗留问题

a. (slf4):Spring(commons-logging) Hibernate(jboss-logging) mybatis.xxxx

同意日志记录，即便是别的框架统一使用slf4j进行使用

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-63xGd80B-1575380351479)(http://www.slf4j.org/images/legacy.png)]

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

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

（用新的日志jar 替换别的框架的jar包，并导入slf4-api.jar则可以将别的框架的日志jar替换为slf4j

springboot项目日志依赖

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

springboot使用它来做日志功能：

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

springboot sfl4j支持

<dependency>
      <groupId>org.slf4j</groupId>
      <artifactId>slf4j-api</artifactId>
      <version>1.7.25</version>
      <scope>compile</scope>
    </dependency>

log4j-to-slf4j 日志转化包

<dependency>
      <groupId>org.apache.logging.log4j</groupId>
      <artifactId>log4j-to-slf4j</artifactId>
      <version>2.12.1</version>
      <scope>compile</scope>
    </dependency>

jul-to-slf4j 日志转化包

 <dependency>
      <groupId>org.slf4j</groupId>
      <artifactId>jul-to-slf4j</artifactId>
      <version>1.7.29</version>
      <scope>compile</scope>
    </dependency>

logback日志包

<dependency>
      <groupId>ch.qos.logback</groupId>
      <artifactId>logback-classic</artifactId>
      <version>1.2.3</version>
      <scope>compile</scope>
    </dependency>

总结：1. springboot底层使用slf4j与logback进行日志记录

2.Springboot也把其他的日志都替换成了slf4j

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

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

springboot能自动适配所有的日志，底层使用slf4j+logback的方式记录日志，引入其他框架的时候，只需要把这个框架依赖的日志框架排除掉。

2.4 日志使用

2.4.1 默认配置

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

@SpringBootTest
class SpringbootSlf4jApplicationTests {
    //日志记录器
    Logger logger=LoggerFactory.getLogger(getClass());
    @Test
    void contextLoads() {
            //日志级别;由低到高trace>debug>info>warn>error
            //可以调整日志输出级别,日志只在这个级别或更高级别生效
            logger.trace("这是trace日志");
            logger.debug("这是debug日志");
            //spring默认级别是info级别,没有指定级别的就使用spring默认级别：root级别
            logger.info("这是自定义info信息");
            logger.warn("这是warn信息");
            logger.error("这是错误日志信息");
    }

}

logging.level.com.openlab=trace
#logging.file.path=
#不指定路径在当前项目下生成springboot.log文件  可以指定完整路径进行日志生成
#logging.file.name=springboot.log
#在当前磁盘根目录下创建spring文件夹和里面的log文件家;使用spring.log作为默认文件
logging.file.path=/home/wang/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

日志输出格式：

  %d         表示日期时间
  %thread        表示线程名,
  % -5level       级别从左显示5个字符宽度
  %logger{50} 表示logger名字最长50个自负，否则按照句点分割。
  %msg  日志信息
  %n        是换行符

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`

spring推荐将日志文件添加spring后缀 logback-spring.xml;

如果使用后缀则日志框架就不直接加载日志的配置项，由springBoot进行开发环境识别，比如dev prod ，并对日志进行识别。

<springProfile name="staging">
    <!-- configuration to be enabled when the "staging" profile is active -->
</springProfile>

**logback.xml;直接被日志框架识别;

2.5 日志框架切换

slf4j -->log4j; 先移除slf4j依赖包，然后添加log4j配置文件。并添加log4j.jar