汕头企业免费建站,建筑施工特种作业证查询官网,大连开发区做网站的公司,自己制作菜单的app依赖版本 JDK 17 Spring Boot 3.2.0
工程源码#xff1a;Gitee
日志门面和日志实现
日志门面#xff08;如Slf4j#xff09;就是一个标准#xff0c;同JDBC一样来制定“规则”#xff0c;把不同的日志系统的实现进行了具体的抽象化#xff0c;只提供了统一的日志使用接…依赖版本 JDK 17 Spring Boot 3.2.0
工程源码Gitee
日志门面和日志实现
日志门面如Slf4j就是一个标准同JDBC一样来制定“规则”把不同的日志系统的实现进行了具体的抽象化只提供了统一的日志使用接口。而Logback、log4j等具体的日志系统就如同MySQL驱动、PGSQL驱动一样才是日志功能的真正实现。 SpringBoot默认日志框架
SpringBoot使用Slf4j作为日志门面Logback作为默认的日志实现。在SpringBoot的pom.xml中依赖为
dependencygroupIdorg.springframework.boot/groupIdartifactIdspring-boot-starter-logging/artifactId
/dependency此依赖在SpringBoot Starter包中包含所以在SpringBoot项目中导入 spring-boot-starter 后可直接使用
dependenciesdependencygroupIdorg.springframework.boot/groupIdartifactIdspring-boot-starter/artifactId/dependency
/dependencies打印日志
基于LoggerFactory创建日志记录器实例
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;SpringBootApplication
public class LoggingApplication {private static final Logger logger LoggerFactory.getLogger(LoggingApplication.class);public static void main(String[] args) {logger.info(LoggingApplication start...);SpringApplication.run(LoggingApplication.class, args);logger.info(LoggingApplication end...);}
}引入lombok依赖通过注解Slf4j创建日志记录器实例
dependenciesdependencygroupIdorg.springframework.boot/groupIdartifactIdspring-boot-starter/artifactId/dependencydependencygroupIdorg.projectlombok/groupIdartifactIdlombok/artifactId/dependency
/dependenciesimport lombok.extern.slf4j.Slf4j;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;Slf4j
SpringBootApplication
public class LoggingApplication {public static void main(String[] args) {log.info(LoggingApplication start...);SpringApplication.run(LoggingApplication.class, args);log.info(LoggingApplication end...);}
}配置Logback
默认配置
SpringBoot推荐将配置文件名称命名为logback-spring.xml表示这是SpringBoot下Logback专用的配置可以使用SpringBoot 的高级Profile功能它的内容类似于这样
?xml version1.0 encodingUTF-8?
configuration!-- 配置信息 --
/configuration最外层由configuration包裹一旦编写那么就会替换默认的配置所以如果内部什么都不写的话那么会导致我们的SpringBoot项目没有配置任何日志输出方式控制台也不会打印日志。 也可在配置文件中指定要使用的日志配置如application.yml中通过配置 logging.config指定要使用的日志配置。 logging:config: classpath:logback-spring.xml基于SpringBoot默认Logback配置进行定制 SpringBoot 的默认Logback文件可在依赖项中找到。路径为org/springframework/boot/logging/logback/defaults.xml 在配置文件中对默认配置进行引用及编写定制配置覆盖默认配置。
?xml version1.0 encodingUTF-8?
configuration!-- 引用Spring Boot 默认日志配置 --include resourceorg/springframework/boot/logging/logback/defaults.xml/!-- 控制台日志打印格式 --property nameCONSOLE_LOG_PATTERNvalueMyLogPattern %clr(%d{${LOG_DATEFORMAT_PATTERN:-yyyy-MM-dd HH:mm:ss.SSS}}){faint} %clr(${LOG_LEVEL_PATTERN:-%5p}) %clr(${PID:- }){magenta} %clr(---){faint} %clr(${LOGGED_APPLICATION_NAME:-}[%15.15t]){faint} %clr(${LOG_CORRELATION_PATTERN:-}){faint}%clr(%-40.40logger{39}){cyan} %clr(:){faint} %m%n${LOG_EXCEPTION_CONVERSION_WORD:-%wEx}/!-- 日志输出到控制台 --appender nameCONSOLE classch.qos.logback.core.ConsoleAppenderfilter classch.qos.logback.classic.filter.ThresholdFilterlevel${CONSOLE_LOG_THRESHOLD}/level/filterencoderpattern${CONSOLE_LOG_PATTERN}/patterncharset${CONSOLE_LOG_CHARSET}/charset/encoder/appender!-- 指定日志输出级别 --root levelINFOappender-ref refCONSOLE//root
/configuration配置日志信息输出到文件
logback-spring.xml 添加如下内容
?xml version1.0 encodingUTF-8?
configuration!-- 引用Spring Boot 默认日志配置 --include resourceorg/springframework/boot/logging/logback/defaults.xml/!-- 日志文件输出位置 --property nameLOG_PATH value./logs/!-- 日志文件名 --property nameLOG_FILE value${LOG_PATH}/spring-boot.log/!-- 日志输出到文件 --appender nameFILE classch.qos.logback.core.rolling.RollingFileAppenderfilter classch.qos.logback.classic.filter.ThresholdFilterlevel${FILE_LOG_THRESHOLD}/level/filterencoderpattern${FILE_LOG_PATTERN}/patterncharset${FILE_LOG_CHARSET}/charset/encoderfile${LOG_FILE}/filerollingPolicy classch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicyfileNamePattern${LOGBACK_ROLLINGPOLICY_FILE_NAME_PATTERN:-${LOG_FILE}.%d{yyyy-MM-dd}.%i.gz}/fileNamePatterncleanHistoryOnStart${LOGBACK_ROLLINGPOLICY_CLEAN_HISTORY_ON_START:-false}/cleanHistoryOnStartmaxFileSize${LOGBACK_ROLLINGPOLICY_MAX_FILE_SIZE:-10MB}/maxFileSizetotalSizeCap${LOGBACK_ROLLINGPOLICY_TOTAL_SIZE_CAP:-0}/totalSizeCapmaxHistory${LOGBACK_ROLLINGPOLICY_MAX_HISTORY:-7}/maxHistory/rollingPolicy/appender!-- 指定日志输出级别以及启动的Appender --root levelINFOappender-ref refFILE//root
/configurationMDC机制
Slf4j官方解释 MDC全称Mapped Diagnostic Context映射诊断上下文“映射诊断上下文” 本质上是由日志记录框架维护的映射其中应用程序代码提供键值对然后可以由日志记录框架将其插入日志消息中。MDC数据在过滤消息或触发某些操作时也非常有用。 通俗的说就是可以将特定的信息如请求Id链路Id通过MDC机制注入到当前日志线程的上下文中将信息在日志中记录、输出。 MDC的使用
MDC 常用的三个方法
MDC.put(key,value) 注入值MDC.remove(key) 移除指定的MDC注入信息MDC.clear() 移除所有当前线程的MDC注入信息
MDC注入属性配置
在logback-spring.xml文件的输出格式中添加需要注入的KEY信息与代码注入的信息相对应。假定我需要注入当前用户的Id信息且设置key为user-id
代码
import lombok.extern.slf4j.Slf4j;
import org.slf4j.MDC;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;import java.util.UUID;Slf4j
SpringBootApplication
public class LoggingApplication {public static void main(String[] args) {SpringApplication.run(LoggingApplication.class, args);String mdcKey user-id;log.info(Logging before MDC put...);MDC.put(mdcKey, UUID.randomUUID().toString());log.info(Logging after MDC put...);MDC.clear();log.info(Logging after MDC clear...);}
}
logback-spring.xml
?xml version1.0 encodingUTF-8?
configuration!-- 引用Spring Boot 默认日志配置 --include resourceorg/springframework/boot/logging/logback/defaults.xml/!-- 控制台日志打印格式 --property nameCONSOLE_LOG_PATTERNvalue[%X{user-id}] %clr(%d{${LOG_DATEFORMAT_PATTERN:-yyyy-MM-dd HH:mm:ss.SSS}}){faint} %clr(${LOG_LEVEL_PATTERN:-%5p}) %clr(${PID:- }){magenta} %clr(---){faint} %clr(${LOGGED_APPLICATION_NAME:-}[%15.15t]){faint} %clr(${LOG_CORRELATION_PATTERN:-}){faint}%clr(%-40.40logger{39}){cyan} %clr(:){faint} %m%n${LOG_EXCEPTION_CONVERSION_WORD:-%wEx}/!-- 日志输出到控制台 --appender nameCONSOLE classch.qos.logback.core.ConsoleAppenderfilter classch.qos.logback.classic.filter.ThresholdFilterlevel${CONSOLE_LOG_THRESHOLD}/level/filterencoderpattern${CONSOLE_LOG_PATTERN}/patterncharset${CONSOLE_LOG_CHARSET}/charset/encoder/appender!-- 指定日志输出级别 --root levelINFOappender-ref refCONSOLE//root
/configuration使用方式 通过注册拦截器或过滤器在业务开始前获取到相关信息请求Id操作人Id将相关信息通过MDC自动注入到当前线程中实现关键信息记录。在创建子线程时需要通过MDC.getCopyOfContextMap()方法获取到当前线程的MDC注入相关信息传递给子线程才能在子线打印日志信息时获取到父线程MDC的注入信息。 Logback参考配置
?xml version1.0 encodingUTF-8 ?
configuration!-- Spring Boot 默认日志配置 --include resourceorg/springframework/boot/logging/logback/defaults.xml/!-- 日志文件输出位置 --property nameLOG_PATH value./logs/!-- 日志文件名 --property nameLOG_FILE value${LOG_PATH}/spring-boot.log/!-- 归档日志名 --property nameFILE_NAME_PATTERN value${LOG_FILE}-%d{yyyyMMdd}.%i.gz/!-- 在启动时清除历史日志 --property nameLOGBACK_ROLLINGPOLICY_CLEAN_HISTORY_ON_START valuefalse/!-- 单个日志文件最大大小 --property nameLOGBACK_ROLLINGPOLICY_MAX_FILE_SIZE value100MB/!-- 日志总大小 --property nameLOGBACK_ROLLINGPOLICY_TOTAL_SIZE_CAP value0/!-- 日志保留天数 --property nameLOGBACK_ROLLINGPOLICY_MAX_HISTORY value7/!-- 控制台日志编码格式 --property nameCONSOLE_LOG_CHARSET valueUTF-8/!-- 控制台日志打印格式 --property nameCONSOLE_LOG_PATTERNvalue%clr(%d{${LOG_DATEFORMAT_PATTERN:-yyyy-MM-dd HH:mm:ss.SSS}}){faint} [%X{user-id}] [%X{request-id}] [%X{client-ip}] %clr(${LOG_LEVEL_PATTERN:-%5p}) %clr(${PID:- }){magenta} %clr(---){faint} %clr(${LOGGED_APPLICATION_NAME:-}[%15.15t]){faint} %clr(${LOG_CORRELATION_PATTERN:-}){faint}%clr(%-40.40logger{39}){cyan} %clr(:){faint} %m%n${LOG_EXCEPTION_CONVERSION_WORD:-%wEx}/!-- 控制台日志输出级别 --property nameCONSOLE_LOG_THRESHOLD valueINFO/!-- 日志文件输出打印格式 --property nameFILE_LOG_PATTERNvalue%d{${LOG_DATEFORMAT_PATTERN:-yyyy-MM-dd HH:mm:ss.SSS}} [%X{user-id}] [%X{request-id}] [%X{client-ip}] ${LOG_LEVEL_PATTERN:-%5p} ${PID:- } --- ${LOGGED_APPLICATION_NAME:-}[%t] ${LOG_CORRELATION_PATTERN:-}%-40.40logger{39} : %m%n${LOG_EXCEPTION_CONVERSION_WORD:-%wEx}/!-- 日志文件输出编码格式 --property nameFILE_LOG_CHARSET valueUTF-8/!-- 日志文件输出级别 --property nameFILE_LOG_THRESHOLD valueINFO/!-- 日志输出到控制台 --appender nameCONSOLE classch.qos.logback.core.ConsoleAppenderfilter classch.qos.logback.classic.filter.ThresholdFilterlevel${CONSOLE_LOG_THRESHOLD}/level/filterencoderpattern${CONSOLE_LOG_PATTERN}/patterncharset${CONSOLE_LOG_CHARSET}/charset/encoder/appender!-- 日志输出到文件 --appender nameFILE classch.qos.logback.core.rolling.RollingFileAppenderfilter classch.qos.logback.classic.filter.ThresholdFilterlevel${FILE_LOG_THRESHOLD}/level/filter!-- 日志打印配置 --encoderpattern${FILE_LOG_PATTERN}/patterncharset${FILE_LOG_CHARSET}/charset/encoder!-- 日志文件名 --file${LOG_FILE}/file!-- 日志输出配置 --rollingPolicy classch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy!-- 日志归档名 --fileNamePattern${FILE_NAME_PATTERN}/fileNamePattern!-- 在启动时清除日志 --cleanHistoryOnStart${LOGBACK_ROLLINGPOLICY_CLEAN_HISTORY_ON_START}/cleanHistoryOnStart!-- 单个文件大小 --maxFileSize${LOGBACK_ROLLINGPOLICY_MAX_FILE_SIZE}/maxFileSize!-- 日志总大小 --totalSizeCap${LOGBACK_ROLLINGPOLICY_TOTAL_SIZE_CAP}/totalSizeCap!-- 日志保留天数 --maxHistory${LOGBACK_ROLLINGPOLICY_MAX_HISTORY}/maxHistory/rollingPolicy/appender!-- 指定日志输出级别以及启动的Appender --root levelINFOappender-ref refCONSOLE/appender-ref refFILE//root
/configuration
