【05】SpringBoot热部署与日志

XQ_898878888

已于 2024-06-27 07:27:45 修改

阅读量864

点赞数 27

分类专栏： # SpringBoot 文章标签： spring boot 后端 java

于 2024-05-29 07:26:16 首次发布

本文链接：https://blog.csdn.net/XQ_898878888/article/details/139209664

版权

SpringBoot 专栏收录该内容

9 篇文章 0 订阅

订阅专栏

1、热部署

1.1 引言

为了进一步提高开发效率，SpringBoot为我们提供了全部项目热部署，日后在开发过程中修改了部分代码或者相关配置文件之后，不需要再重启服务使其生效。在项目中开启了全局热部署之后，只需要在修改之后等待几秒钟就可使修改生效。

1.2 开启热部署

1.2.1 引入依赖

 <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-devtools</artifactId>
      <optional>true</optional>
 </dependency>

1.2.2 设置IDEA中的配置

在设置中进行如下配置的勾选（File->Settings->Compiler->Build Project automatically）
(2022.2.1版idea)在File->Settings->Advanced Settings中找到并勾选
Allow auto-make to start even…
旧版idea直接快捷键：Ctrl + Shift + Alt + / ，选择Registry，再找到并勾选compiler.automake.allow.when.app.running

2、日志体系

2.1 日志框架发展史

一开始，日志信息是为了去追踪一些异常信息，但早期只能去catch块中使用sout来实现，这种方式效率很低下且不方便，后来使用logUtil的工具来记录文本到文件中。慢慢的也出现了以下几点问题：
- 随着用户量越来越多，记录在文本中的日志信息越来越多，单个文件越来越大；
- 用户出现异常信息的时候，能不能发邮件来通知；
- 能不能记录日志的时候按等级来区分；
- 能不能IO异步，自由的控制格式；
紧接着，开源的log4j诞生了，受到了广大开发者的欢迎。后来，它被Apache基金会收纳。
后来，JDK官方sun也开发出了一个日志框架 JUL（java.utl.logging），并推出了日志门面JCL（jakarta Commons Logging）,它不能实现日志功能，只支持整合日志；
再后来，又出现了Slf4j的日志门面，它只整合日志而不实现具体的日志功能，需要通过适配器和桥接器来完成；
- 模块1 官方（JCL门面） JUL日志框架 ------（适配器）---->>> 模块2 开源（SLF4J）------（桥接器）–>> 实现log4j的功能

2.2 代码层面的发展史

早期，在日志中使用Apache的log4j框架来输出日志信息：

	import org.apache.log4j.Logger;
	
	Logger logger = Logger.getLogger(Test.class);
	logger.trace("trace");

接着，JDK官方Sun公司出于对log4j的嫉妒，提出了JUL(java.util.logging)日志框架对抗log4j。如果需要将log4j的框架改为使用JUL，就只能一行一行的修改日志代码。

	import java.util.logging.Logger；
	
	Logger loggger = Logger.getLogger(Test.class.getName()); 
	logger.finest("finest");

为了解决日志框架能够被随心所欲的使用，这时候JCL(Jakarta Commons Logging)出现了。JCL 只提供 log 接口，具体的实现则在运行时动态寻找。这样一来组件开发者只需要针对 JCL 接口开发，而调用组件的应用程序则可以在运行时搭配自己喜好的日志实践工具。
JCL可以实现的集成方案如下图所示：
JCL默认的配置：如果能找到Log4j 则默认使用log4j 实现，如果没有则使用jul(jdk自带的) 实现，再没有则使用jcl内部提供的SimpleLog 实现。于是，就出现了如下的代码处理：

	import org.apache.commons.logging.Log;
	import org.apache.commons.logging.LogFactory;
	
	Log log =LogFactory.getLog(Test.class);
	log.trace('trace');

至于这个Log具体的实现类，JCL会在ClassLoader中进行查找。这么做有如下三个缺点：
- 效率较低
- 容易引发混乱
- 在使用了自定义ClassLoader的程序中，使用JCL会引发内存泄露
于是，又诞生了新的日志门面：slf4j。关于slf4j的集成图如下所示：
日志门面接口本身通常并没有实际的日志输出能力，它底层还是需要去调用具体的日志框架API的，也就是实际上它需要跟具体的日志框架结合使用。由于具体日志框架比较多，而且互相也大都不兼容，日志门面接口要想实现与任意日志框架结合可能需要对应的桥接器，上图红框中的组件即是对应的各种桥接器！

	import org.slf4j.Logger;
	import org.slf4j.LoggerFactory;
	
	Logger logger = LoggerFactory.getLogger(Test.class);
	logger.info("info");

转换过程

在代码中，并不会出现具体日志框架的API。应用程序会根据classpath中的桥接器类型，和日志框架类型，判断出logger.info应该以什么框架输出！注意了，如果classpath中不小心引了两个桥接器，那会直接报错的！因此，在阿里的开发手册上才有这么一条：

	强制：应用中不可直接使用日志系统（log4j、logback）中的 API ，而应依赖使用日志框架 SLF4J 中的 API 。使用门面模式的日志框架，有利于维护和各个类的日志处理方式的统一。

2.3 SpringBoot中logback日志集成

依赖图

SpringBoot底层使用 slf4j + logback的方式进行日志记录
- logback-classic：logback的桥接器
SpringBoot也把其他的日志都替换为了slf4j
- log4j-to-slf4j：log4j的适配器
- jul-to-slf4j：jul的适配器
- Spring默认的日志门面是：JCL

2.4 SpringBoot日志使用

2.4.1 声明日志记录器

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

Logger logger = LoggerFactory.getLogger(currentClassName.class);

2.4.2 日志级别

可以设置如下几种日志级别：
- trace：跟踪
  - 描述：最详细的日志级别，仅用于调试和开发过程中。
  - 作用：用于记录程序的详细运行信息，例如方法的入参、出参等。一般情况下，TRACE级别的日志不会被打印到生产环境中。
- debug：调试
  - 描述：这是最详细的日志级别，主要用于开发阶段的调试。当开启DEBUG级别日志时，会记录程序运行过程中的所有详细信息，包括函数调用、变量值变化等。
  - 作用：对于排查代码逻辑问题、了解程序运行流程非常有帮助。但在生产环境中一般不建议长期开启，因为会产生大量的日志数据，影响性能并可能导致存储空间不足。
- info：信息（SpringBoot默认的日志级别）
  - 描述：INFO级别的日志通常用来记录系统运行的关键事件或正常流程信息，例如服务启动、停止、配置加载成功等。
  - 作用：用于了解系统的基本运行状态和关键操作，是日常运维中最常用的一种日志级别。
- warn：警告
  - 描述：WARN级别的日志用于记录可能潜在的问题或者非预期情况，但不影响系统整体运行的情况，比如资源占用过高、请求超时等。
  - 作用：通过监控WARN级别的日志，可以提前发现并预防可能存在的风险，避免小问题逐渐恶化成严重故障。
- error：错误
  - 描述：ERROR级别的日志用于记录系统出现错误或异常情况，如业务处理失败、数据库连接断开等，这些情况可能会导致功能无法正常使用或部分服务中断。
  - 作用：ERROR日志是问题定位的关键线索，一旦发生此类日志，意味着系统出现了严重的故障或错误，需要立即进行排查修复。
- fatal：致命
  - FATAL级别的日志是最严重的等级，表示系统发生了灾难性错误，通常会导致系统崩溃或无法提供服务，如宕机、核心组件失效等。
  - 作用：这类日志对保障系统稳定运行至关重要，一旦出现，应立即触发告警通知，并迅速展开问题应急响应。

在配置文件中设置日志级别：

logging:
  level:
    root: info # 设置所有日志的级别（默认值：info）
    com.trs: trace  # 自定义设置某个包下所有类的日志级别

2.4.3 日志格式

2024-05-27T21:04:10.760+08:00  INFO 16388 --- [springboot_demo] [  restartedMain] .ConditionEvaluationDeltaLoggingListener : Condition evaluation unchanged
2024-05-27T21:04:10.761+08:00 TRACE 16388 --- [springboot_demo] [  restartedMain] com.trs.SpringbootDemoApplication        : 跟踪
2024-05-27T21:04:10.761+08:00 DEBUG 16388 --- [springboot_demo] [  restartedMain] com.trs.SpringbootDemoApplication        : 调试
2024-05-27T21:04:10.761+08:00  INFO 16388 --- [springboot_demo] [  restartedMain] com.trs.SpringbootDemoApplication        : 信息

可以使用logging.pattern.console修改默认的控制的日志格式

  %clr(%d{${LOG_DATEFORMAT_PATTERN:-yyyy-MM-dd HH:mm:ss.SSS}}){faint} %clr(${LOG_LEVEL_PATTERN:-%5p}) %clr(${PID:- }){magenta} %clr(---){faint} %clr([%15.15t]){faint} %clr(%-40.40logger{39}){cyan} %clr(:){faint} %m%n${LOG_EXCEPTION_CONVERSION_WORD:-%wEx}

日志的组成部分：
- 日期和时间
  - %clr(%d{${LOG_DATEFORMAT_PATTERN:-yyyy-MM-dd HH:mm:ss.SSS}}){faint}
  - %clr 当前内容的颜色 {faint}，其他颜色：blue、cyan、faint、green、magenta、red、yellow
  - (%d{${LOG_DATEFORMAT_PATTERN:-yyyy-MM-dd HH:mm:ss.SSS}})，表示括号中要显示的内容。
    - {${LOG_DATEFORMAT_PATTERN:-yyyy-MM-dd HH:mm:ss.SSS}
    - ${v:v0},SpringBoot的占位符 + null条件的表达式（如果v为null，则使用v0的值）
    - LOG_DATEFORMAT_PATTERN: 系统环境变量中的值，SpringBoot底层会根据对应的配置项将值设置到对应的环境变量中，如：LOG_DATEFORMAT_PATTERN=logging.pattern.dateformat 可以在官网4.7章节中看到对应的关系。
    - %d 是logback的日期显示方式
    - -yyyy-MM-dd HH:mm:ss.SSS 日期的格式
- 日志级别
  - %clr(${LOG_LEVEL_PATTERN:-%5p})
  - %clr 日志颜色，会根据不同的日志级别输出对应的颜色
  - LOG_LEVEL_PATTERN：系统变量的值
  - %5 表示当前内容所占字符的长度
  - p 表示输出的日志级别
- 进程ID
  - %clr(${PID:- }){magenta}
  - PID 是系统环境变量中的进程ID（由系统分配，无法指定）
- '- - -'用于区分实际日志消息开始的分隔符
  - %clr(- - -){faint}
- 线程名称
  - 用方括号括起来（对于控制台输出可能会被截断）
- 记录日志的类
- 日志消息
日志文件输出：
- 默认情况下，Spring Boot仅记录到控制台，不写日志文件。如果除了控制台输出外还想写日志文件，则需要在配置文件中设置一个logging.file.name或logging.file.path的属性。
  - logging.file.name
    - 可以只设置文件的名称，如果没有设置路径会默认在项目的相对路径下
    - 可以指定路径 + 文件名：name: D:/mylog.log
  - logging.file.path
    - 不可以指定文件名称，必须要指定一个物理文件夹路径，会默认使用spring.log
日志迭代（轮转）：
- 如果您使用的是Logback，则可以使用application.properties或application.yaml文件微调日志轮播设置。
  
  *logging.logback.rollingpolicy.file-name-pattern=${LOG_FILE}.%d{yyyy-MM-dd}.%i.gz
  - ${LOG_FILE} 对应 logging.file.name的值
  - %d{yyyy-MM-dd} 指定日期格式
  - %i 索引，当文件超出指定大小后按文件索引递增

自定义日志配置文件：

可以通过在类路径中包含适日志配置文件来激活各种日志记录系统。
注意：如果使用自定义日志配置文件会使用springboot中全局配置文件的logging相关配置失效。

下面给出logback的日志配置文件：logback-spring.xml

<?xml version="1.0" encoding="UTF-8"?>
<configuration scan="true">
    <!-- 日志编码 -->
    <property name="CHARSET" value="utf-8"/>
    <!-- 日志记录格式 -->
    <property name="ERROR_PATTERN" value="%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level %logger Line:%-3L-%msg%n" />
    <property name="INFO_PATTERN" value="%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level %logger Line:%-3L-%msg%n" />

    <!--控制台日志输出格式-->
    <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>%d{YYYY-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{36} ---> %msg%n</pattern>
            <charset>UTF-8</charset>
        </encoder>
    </appender>

    <!-- 日志记录器，日期滚动记录 -->
    <appender name="FILEERROR" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 此日志文件只记录error级别的 -->
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>error</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
        <!-- 正在记录的日志文件的路径及文件名 -->
        <file>log/error/log_error.log</file>
        <!-- 日志记录器的滚动策略，按日期，按大小记录 -->
        <rollingPolicy
                class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
            <fileNamePattern>log/error/log-error-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
            <maxFileSize>10MB</maxFileSize>
            <maxHistory>7</maxHistory>
        </rollingPolicy>
        <!-- 追加方式记录日志 -->
        <append>true</append>
        <!-- 日志文件的格式 -->
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <pattern>${ERROR_PATTERN}</pattern>
            <charset>${CHARSET}</charset>
        </encoder>
    </appender>

    <!-- 日志记录器，日期滚动记录 -->
    <appender name="FILEINFO" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 此日志文件只记录info级别的 -->
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>info</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
        <!-- 正在记录的日志文件的路径及文件名 -->
        <file>log/info/log_info.log</file>
        <!-- 日志记录器的滚动策略，按日期，按大小记录 -->
        <rollingPolicy
                class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
            <fileNamePattern>log/info/log-info-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
            <maxFileSize>10MB</maxFileSize>
            <maxHistory>7</maxHistory>
        </rollingPolicy>
        <!-- 追加方式记录日志 -->
        <append>true</append>
        <!-- 日志文件的格式 -->
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <pattern>${ERROR_PATTERN}</pattern>
            <charset>${CHARSET}</charset>
        </encoder>
    </appender>

    <!--设置全局日志级别-->
    <root level="INFO">
        <appender-ref ref="FILEERROR" />
        <appender-ref ref="FILEINFO" />
        <appender-ref ref="CONSOLE" />
    </root>

    <!--设置某个包或者某个类的局部日志级别-->
    <logger name="com.ydr.mapper" level="debug" />

</configuration>

2.4.4 切换日志框架

将logback切换log4j2

（1）将logback的场景启动器排除（slf4j只能运行1个桥接器）

<!--stater-web中自动添加了logback的依赖-->
	<dependency>
	     <groupId>org.springframework.boot</groupId>
	     <artifactId>spring-boot-starter-web</artifactId>
	     <exclusions>
	        <exclusion>
	           <groupId>org.springframework.boot</groupId>
	           <artifactId>spring-boot-starter-logging</artifactId>
	        </exclusion>
	     </exclusions>
	</dependency>

（2）添加log4j2的桥接器

 <!--添加log4j2的桥接器-->
 <dependency>
     <groupId>org.springframework.boot</groupId>
     <artifactId>spring-boot-starter-log4j2</artifactId>
 </dependency>

（3）添加log4j2的配置文件

将logback切换为log4j

（1）排除logback的桥接器

<dependency>
    <!--starter-web里面自动添加starter-logging 也就是logback的依赖-->
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
    <exclusions>
        <exclusion>
            <artifactId>logback-classic</artifactId>
            <groupId>ch.qos.logback</groupId>
        </exclusion>
    </exclusions>
</dependency>

（2）添加log4j的桥接器

<!--log4j的桥接器-->
<dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>slf4j-log4j12</artifactId>
</dependency>

（3）添加log4j的配置文件

log4j.properties

#trace<debug<info<warn<error<fatal
log4j.rootLogger=trace, stdout
log4j.appender.stdout=org.apache.log4j.ConsoleAppender
log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
log4j.appender.stdout.layout.ConversionPattern=%d %p [%c] - %m%n`

XQ_898878888

关注

27
点赞
踩
30

收藏

觉得还不错? 一键收藏
0
评论
【05】SpringBoot热部署与日志

为了进一步提高开发效率，SpringBoot为我们提供了全部项目热部署，日后在开发过程中修改了部分代码或者相关配置文件之后，不需要再重启服务使其生效。在项目中开启了全局热部署之后，只需要在修改之后等待几秒钟就可使修改生效。
复制链接

扫一扫

专栏目录