SpringBoot——日志

最新推荐文章于 2023-03-31 14:20:42 发布

WYFVV

最新推荐文章于 2023-03-31 14:20:42 发布

阅读量702

点赞数 1

分类专栏： SpringBoot

本文链接：https://blog.csdn.net/WYFVV/article/details/106683574

版权

SpringBoot 专栏收录该内容

11 篇文章 0 订阅

订阅专栏

1.日志框架

在项目的开发中，日志是必不可少的一个记录事件的组件，所以也会在相应的项目中实现和构建我们所需要的日志框架。

市面上的日志框架：JUL，JCL，Jboss-logging，logback,log4j,log4j2,slf4j...。

日志门面（日志的抽象层）	日志实现
JCL，SLF4J，jbossing-logging	log4j,jul,log4j2,logback

左边选择一个门面（抽象层），右边选择一个实现。

SpringBoot：底层是Spring框架，Spring框架默认使用JCL。SpringBoot选择使用slf4j和logback。

1.1 slf4j

slf4j是对所有日志框架制定的一种规范，标准，接口，并不是一个框架的具体的实现，因为接口并不能独立使用，需要和具体的日志框架实现配合使用（如log4j,logback）。

为什么需要日志接口，直接使用具体的实现不就行了？

接口用于定制规范，可以有多个实现，使用时是面向接口的（导入的包都是slf4j的包而不是某个日志框架中的包），即直接和接口交互，不直接使用实现，所以可以任意更换实现而不用更改代码中的日志相关代码。

1.2 log4j

log4j是Apache实现的一个开源日志组件。通过使用log4j,我们可以控制日志信息输出的目的地是控制台、文件、GUI组件、甚至是套接口服务器、NT的事件记录器、UNIX Syslog守护进程等；可以控制每一条日志的输出格式；通过定义每一条日志信息的级别，可以更加细致地控制日志的输出过程。这些可以通过一个配置文件来灵活的进行配置，而不需要修改应用的代码。

1.3 logback

logback是由log4j的作者设计完成的，拥有更好的特性，用来取代log4j的一个日志框架，是slf4j的原生实现，所以logback与slf4j的结合是最好的。

选择logback的理由：

logback比log4j要快大约10倍，而且消耗更少的内存
logback能够优雅地从I/O异常中恢复，从而不用重新启动应用程序来恢复logger
logback能够根据配置文件中设置的上限值，自动删除旧的的日志文件
logback能够自动压缩日志文件
...

1.4 log4j2

log4j2是log4j 1.x和logback的改进版本，据说采用了一些新技术（无锁异步，等等），使得日志的吞吐量、性能比lo4j 1.x提高10倍，并解决一些死锁的bug,而且配置更加简单灵活。

SpringBoot1.4 以及之后的版本已经不支持log4j,log4j也已经很久没有更新，现在已经有很多其他的日至框架对log4j进行了改良，例如slf4j、logback等。那为什么还需要log4j2呢？

插件式结构
配置文件优化。在配置文件中可以引用属性，还可以直接替代或传递到组件。而且支持JSON格式的配置文件。不像其他的日志框架，它在重新配置的时候不会丢失之前的日志文件。
Java 5的并发性。log4j2利用并发性的支持，尽可能地执行最低层次的加锁。解决了在log4j 1.x周静存留的死锁问题。
异步logger

2.日志框架的使用

2.1 slf4j的使用 https://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");
}
}

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

如果a(slf4j+logback)：Spring（commons-logging），Hibernate（jboss-logging）,Mybatis，xxx统一日志记录，即使是别的框架和a一起统一使用slg4j进行输出？

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

将系统的其他日志框架先排除出去（依赖的exclusion属性）
将中间包替换原有的日志框架（例如jcl-core-slf4j.jar来替换commons logging的jar）
导入slf4j其他的实现

3.SpringBoot的日志关系

SpringBoot使用它来做日志功能：

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

底层依赖关系

总结：

SpringBoot底层也是使用slf4j+logback的方式进行日志记录
SpringBoot也是把其他的日志替换成slf4j
中间替换包

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

如果引入其他框架，一定要把这个框架的默认依赖移除掉（这个取决SpringBoot的版本，例如SpringBoot 2.2.6版本就没有去除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默认帮我们配置好了日志：

/*
SpringBoot的单元测试
可以在测试期间很方便的类似编码一样进行自动注入等容器的功能
 */
@RunWith(SpringRunner.class)
@SpringBootTest
public class DemoApplicationTests {
    //记录器
    Logger logger=LoggerFactory.getLogger(getClass());

    @Test
   public void contextLoads() {
        //日志的级别
        //由低到高：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修改日志的默认配置（在application.properties中进行更改）：

logging.level.com.test=trace
#不指定路径在当前项目生成springboot.log日志
#可以指定完整的路径
#logging.file.name=/springboot.log
#在当前磁盘下的根路径下创建Spring文件夹和里面的log文件夹；使用spring.log作为默认文件
logging.file.path=/spring/log

#在控制台输出的日志的格式
logging.pattern.console=
#指定文件中的输出的格式
logging.pattern.file=

4.2 指定配置

给类路径下放上每个日志框架自己的配置文件，SpringBoot就不适用默认配置的。

Logging System	Customization
Logback	logback-spring.xml，logback-spring.groovy，logback.xml，logback.groovy
Log4j2	log4j2-spring.xml，log4j2.xml
JDK（Java Util Logging）	logging.properties

logback.xml：直接就被日志框架识别了

logback-spring.xml：日志框架就不直接加载日志的配置项，由SpringBoot解析日志配置，可以使用SpringBoot的高级Profile功能。

  <springProfile name="dev">
           可以指定某段配置只在某个环境下生效
   </springProfile>

如下面的logback-spring.xml文件：

<?xml version="1.0" encoding="UTF-8"?>
<!--
scan：当此属性设置为true时，配置文件如果发生改变，将会被重新加载，默认值为true。
scanPeriod：设置监测配置文件是否有修改的时间间隔，如果没有给出时间单位，默认单位是毫秒当scan为true时，此属性生效。默认的时间间隔为1分钟。
debug：当此属性设置为true时，将打印出logback内部日志信息，实时查看logback运行状态。默认值为false。
-->
<configuration scan="false" scanPeriod="60 seconds" debug="false">
    <!-- 定义日志的根目录 -->
    <property name="LOG_HOME" value="/app/log" />
    <!-- 定义日志文件名称 -->
    <property name="appName" value="atguigu-springboot"></property>
    <!-- ch.qos.logback.core.ConsoleAppender 表示控制台输出 -->
    <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>

    <!-- 滚动记录文件，先将日志记录到指定文件，当符合某个条件时，将日志记录到其他文件 -->  
    <appender name="appLogAppender" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 指定日志文件的名称 -->
        <file>${LOG_HOME}/${appName}.log</file>
        <!--
        当发生滚动时，决定 RollingFileAppender 的行为，涉及文件移动和重命名
        TimeBasedRollingPolicy： 最常用的滚动策略，它根据时间来制定滚动策略，既负责滚动也负责出发滚动。
        -->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!--
            滚动时产生的文件的存放位置及文件名称 %d{yyyy-MM-dd}：按天进行日志滚动 
            %i：当文件大小超过maxFileSize时，按照i进行文件滚动
            -->
            <fileNamePattern>${LOG_HOME}/${appName}-%d{yyyy-MM-dd}-%i.log</fileNamePattern>
            <!-- 
            可选节点，控制保留的归档文件的最大数量，超出数量就删除旧文件。假设设置每天滚动，
            且maxHistory是365，则只保存最近365天的文件，删除之前的旧文件。注意，删除旧文件是，
            那些为了归档而创建的目录也会被删除。
            -->
            <MaxHistory>365</MaxHistory>
            <!-- 
            当日志文件超过maxFileSize指定的大小是，根据上面提到的%i进行日志文件滚动 注意此处配置SizeBasedTriggeringPolicy是无法实现按文件大小进行滚动的，必须配置timeBasedFileNamingAndTriggeringPolicy
            -->
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <maxFileSize>100MB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
        </rollingPolicy>
        <!-- 日志输出格式： -->     
        <layout class="ch.qos.logback.classic.PatternLayout">
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [ %thread ] - [ %-5level ] [ %logger{50} : %line ] - %msg%n</pattern>
        </layout>
    </appender>

    <!-- 
		logger主要用于存放日志对象，也可以定义日志类型、级别
		name：表示匹配的logger类型前缀，也就是包的前半部分
		level：要记录的日志级别，包括 TRACE < DEBUG < INFO < WARN < ERROR
		additivity：作用在于children-logger是否使用 rootLogger配置的appender进行输出，
		false：表示只用当前logger的appender-ref，true：
		表示当前logger的appender-ref和rootLogger的appender-ref都有效
    -->
    <!-- hibernate logger -->
    <logger name="com.atguigu" level="debug" />
    <!-- Spring framework logger -->
    <logger name="org.springframework" level="debug" additivity="false"></logger>



    <!-- 
    root与logger是父子关系，没有特别定义则默认为root，任何一个类只会和一个logger对应，
    要么是定义的logger，要么是root，判断的关键在于找到这个logger，然后判断这个logger的appender和level。 
    -->
    <root level="info">
        <appender-ref ref="stdout" />
        <appender-ref ref="appLogAppender" />
    </root>
</configuration>

如果使用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>

WYFVV

关注

1
点赞
踩
0

收藏

觉得还不错? 一键收藏
2
评论
SpringBoot——日志

1.日志框架在项目的开发中，日志是必不可少的一个记录事件的组件，所以也会在相应的项目中实现和构建我们所需要的日志框架。市面上的日志框架：JUL，JCL，Jboss-logging，logback,log4j,log4j2,slf4j...。日志门面（日志的抽象层）日志实现 JCL，SLF4J，jbossing-logging log4j,jul,log4j2,logback 左边选择一个门面（抽象层），右边选择一个实现。SpringBoot：底层是Spring框架，Sp
复制链接

扫一扫