SpringBoot日志使用分析

最新推荐文章于 2023-03-26 21:15:49 发布

爞笑

最新推荐文章于 2023-03-26 21:15:49 发布

阅读量653

点赞数 1

分类专栏： SpringBoot 文章标签： spring boot java log4j2

本文链接：https://blog.csdn.net/qq_38763540/article/details/105371641

版权

SpringBoot 专栏收录该内容

11 篇文章 0 订阅

订阅专栏

1.日志框架

问题引述：

小张；开发一个大型系统；
1、System.out.println("")；将关键数据打印在控制台；每次都打印在控制台？去掉？写在一个文件？
2、框架来记录系统的一些运行时信息；日志框架； zhanglogging.jar；
3、高大上的几个功能？异步模式？自动归档？xxxx？ zhanglogging-good.jar？
4、将以前框架卸下来？换上新的框架，重新修改之前相关的API；zhanglogging-prefect.jar；
5、JDBC---数据库驱动；

结论：

写了一个统一的接口层；日志门面（日志的一个抽象层）；logging-abstract.jar；

给项目中导入具体的日志实现就行了；我们之前的日志框架都是实现的抽象层；

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

JCL（Jakarta Commons Logging）Apache公司提供的框架，最后一次更新是2014年
jboss-logging 适用场景较少

所以一般选用slf4作为日志抽象层，Log4j与Logback这三者出自同一作者，后者作为日志的实现，但是logf4存在性能问题，所以优先考虑Logback

JUL（java.util.logging）是java自带的日志实现，是后面加上的，一般使用也不会选这个
Log4j2 Logback 是Apache公司借log4j之名开发的日志框架，虽然设计的很好，但是由于适配问题，应用暂时不多

经过优劣对比，左边选一个门面（抽象层）、右边来选一个实现；
日志门面： SLF4J；
日志实现：Logback；

SpringBoot：底层是Spring框架，Spring框架默认是用JCL；‘
SpringBoot选用 SLF4j和logback；

2.SLF4j使用

2.1如何在系统中使用SLF4j

官网地址：http://www.slf4j.org/manual.html

以后在开发的时候，日志记录方法的调用，不应该来直接调用日志的实现类，而是调用日志抽象层里面的方法；给系统里面导入slf4j的jar和 logback的实现jar

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

如果希望将logback-classic用作基础日志记录框架，则需要做的就是在pom.xml文件中将“ ch.qos.logback：logback-classic”声明为依赖项，如下所示。除了logback-classic-1.2.3.jar之外，这还将把slf4j-api-1.7.25.jar以及logback-core-1.1.11.jar放入您的项目中

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

2.2 遗留问题

假设：a（slf4j+logback）项目技术架构: Spring（commons-logging）、Hibernate（jboss-logging）、MyBatis、xxxx

可以假设Spring日志记录使用的是commons-logging，Hibernate使用的是jboss-logging，这样的话commons-logging和jboss-logging都需要配置日志输出，这样的话不利于开发，那么就需要统一日志记录，即使是别的框架也统一使用slf4j进行输出

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

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

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>

底层依赖关系

总结：

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

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的方式记录日志，引入其他框架的时候，只需要把这个框架依赖的日志框架排除掉即可；

4.日志使用

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 文件中

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]

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>

使用SpringBoot2.3.x以上版本的日志遇到的坑：

坑一：使用.yml格式文件修改日志原配置
logging:
  root:
    level: trace
  pattern:
    console: %d{yyyy-MM-dd} [%thread] %-5level %logger{50} - %msg%n
    file: %d{yyyy-MM-dd} === [%thread] === %-5level === %logger{50} ==== %msg%n
  file:
    path: /spring/log
报错：无法识别“%”
Caused by: while scanning for the next token
found character '%' that cannot start any token. (Do not use % for indentation)
 in 'reader', line 5, column 14:
        console: %d{yyyy-MM-dd} [%thread] %-5leve ... 
                 ^
解决方法：

坑二：配置日志输出类型
logging:
  level: trace
报错：
Caused by: org.springframework.core.convert.ConverterNotFoundException: No converter found capable of converting from type [java.lang.String] to type [java.util.Map<java.lang.String, org.springframework.boot.logging.LogLevel>]
解决方法：

坑三：配置日志文件的输出位置

这个坑比较特别，就是我想把我的日志文件输出到当前项目的目录下，按照网上说的那些配置都不成功，很多次都看不到日志文件输出，我用的是2.1.6版本的，其他版本的可以参考。下面的是我的配置方式

拓展

修改SpringBoot（2.3.1）默认日志配置

配置格式	作用
logging.file.name	可以指定日志输出的路径和以及log日志文件的文件名，与logging.file.path不可以同时生效
logging.file.path	只可以指定log日志的输出路径, 不能指定log文件的文件名, 使用缺省值spring.log
logging.level.root	指定根日志记录级别, 即全局，级别有：debug、trace、info、error、warn
logging.level.(你需要指定的包)	如：com.dxj.controller: trace，指定项目中某个包下的日志记录级别
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'，指定日志输出到文件中的格式

爞笑

关注

1
点赞
踩
3

收藏

觉得还不错? 一键收藏
0
评论
SpringBoot日志使用分析

1.日志框架问题引述：小张；开发一个大型系统；1、System.out.println("")；将关键数据打印在控制台；每次都打印在控制台？去掉？写在一个文件？2、框架来记录系统的一些运行时信息；日志框架； zhanglogging.jar；3、高大上的几个功能？异步模式？自动归档？xxxx？ zhanglogging-good.jar？4、将以前框架卸下来？换上新的框架，重新...
复制链接

扫一扫