SpringBoot基础(三)：Logback日志
SpringBoot基础系列文章
SpringBoot基础(一)：快速入门
SpringBoot基础(二)：配置文件详解
SpringBoot基础(三)：Logback日志
目录
- 一、日志依赖
- 二、日志格式
- 1、记录日志
- 2、默认输出格式
- 3、springboot默认日志配置
- 三、日志级别
- 1、基础设置
- 2、日志分组
- 四、文件输出
- 五、文件归档（按日期和大小）
- 1、文件滚动和归档的属性
- 1.1、 appender
- 1.2、 file
- 1.3、encoder
- 1.4、 rollingPolicy（日志滚动策略）
- 1.5、filter（日志过滤器）
- 2、日志文件打印sql
- 3、logback-spring.xml完整配置文件
一、日志依赖
- 此依赖位于spring-boot-starter-web下的spring-boot-starter内部
org.springframework.boot spring-boot-starter-logging
- 默认使用SLF4J作为日志门面，logback作为日志实现来记录日志
- Logback是由log4j创始人设计的另一个开源日志组件，性能比log4j要好
适配器作用：以后想要换其他日志框架，只要排除掉logback日志实现，导入log4j2或jul的日志实现即可，代码中API还是slf4j不需要修改，只修改maven依赖就改变了日志的底层实现。
二、日志格式
1、记录日志
@Slf4j注解的原理就是在编译后的Class文件的类名下生成private static final Logger log = LoggerFactory.getLogger(XXX.class);，所以这两使用哪个都一样。
@Slf4j @RestController public class HelloLog { // private static final Logger log = LoggerFactory.getLogger(HelloLog.class); @GetMapping("/log") public String log(){ log.error("error信息"); log.warn("warn信息"); log.info("info信息"); log.debug("debug信息"); log.trace("trace信息"); return "log"; } }2、默认输出格式
- 时间和日期：毫秒级精度
- 日志级别： ERROR、WARN、INFO、DEBUG 或 TRACE
- 进程 ID：通过此id可以将当前java进程杀掉（kill -9 ID）
- 线程名称：用[]括起来
- 日志记录器Logger名字：通常是产生日志的类名
- 日志记录的信息
3、springboot默认日志配置
控制台默认输出格式
%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}
- %d{yyyy-MM-dd HH:mm:ss.SSS}：日志时间
- %5p：日志级别，固定宽度5字符默认右对齐
- ${PID:- }：PID表示进程ID，:-表示不存在输出空格
- %15.15t：固定15长度的线程名称，不够左边补空格，超过截取字符串右边内容
- %logger{36}：输出日志器名称(类名)，36表示最多输出36个字符，如果不设置 {36} 则输出全名
- %msg：日志消息内容
- %n：换行符
- %wEx：打印精简的异常堆栈信息
彩色编码输出
例如，要使文本为黄色，可使用以下设置：
%clr(%d{yyyy-MM-dd HH:mm:ss.SSS}){yellow}支持颜色：blue(蓝)、cyan(青)、faint(淡)、green(绿)、magenta(洋红)、red(红)、yellow(黄)
三、日志级别
1、基础设置
- 由低到高：ALL,TRACE, DEBUG, INFO, WARN, ERROR,FATAL,OFF
- ALL：打印所有日志
- TRACE：追踪框架详细流程日志，一般不使用
- DEBUG：开发调试细节日志
- INFO：关键、感兴趣信息日志
- WARN：警告但不是错误的信息日志，比如：版本过时
- ERROR：业务错误日志，比如出现各种异常
- OFF：关闭所有日志记录
- 不指定级别的所有类，都使用root指定的级别作为默认级别
- SpringBoot日志默认级别是INFO
- 如下application.properties配置表示所有未指定日志级别都使用root的warn级别
logging.level.root=warn
2、日志分组
- 支持定义日志记录组，将多个不同的包放到同一个组别中统一管理设置日志级别
logging.group.tomcat=org.apache.catalina,org.apache.coyote,org.apache.tomcat
- 定义完成后，只需一行即可更改组中所有日志记录器的级别
logging.level.tomcat=trace
- SpringBoot预定义两个组
Name Loggers web org.springframework.core.codec, org.springframework.http,org.springframework.web org.springframework.boot.actuate.endpoint.web, org.springframework.boot.web.servlet.ServletContextInitializerBeans
sql org.springframework.jdbc.core, org.hibernate.SQL, org.jooq.tools.LoggerListener 四、文件输出
SpringBoot默认只把日志写在控制台，如果想额外记录到文件，可以在application.properties中添加logging.file.name或者logging.file.path配置项。
logging.file.name logging.file.path 示例 效果 未指定 未指定 仅控制台输出 指定 未指定 my.log 写入指定文件，可以加路径 未指定 指定 /var/log 写入指定目录，文件名为spring.log 指定 指定 以logging.file.name为准 五、文件归档（按日期和大小）
1、文件滚动和归档的属性
- 这里是只过滤日志级别为errer的日志进行归档，下面详细介绍下属性
${log.path}/error.log ${FILE_PATTERN} UTF-8 ${log.path}/error-%d{yyyy-MM-dd}.%i.log 100MB 15 ERROR ACCEPT DENY1.1、 appender
- name="ERROR_FILE"：定义了该appender的名称为ERROR_FILE，可以在或中通过appender-ref引用它，用来将ERROR级别的日志输出到文件
- ：用于将日志写入文件，并根据时间或文件大小进行滚动和归档
1.2、 file
- ${log.path}/error.log：指定日志文件的路径和文件名
1.3、encoder
-
${FILE_PATTERN}：指定日志的输出格式
-
UTF-8：设置日志文件的字符编码为UTF-8
1.4、 rollingPolicy（日志滚动策略）
- ：定义日志文件的滚动策略，按时间和大小进行日志文件的分割和归档
- ${log.path}/error-%d{yyyy-MM-dd}.%i.log：
- 日志文件名的模式为error-YYYY-MM-DD.i.log，表示日志文件按天生成，每天的日志文件以日期命名，且支持每天多个日志文件（如果大小超限），通过%i表示文件的序号
- ：
- 使用SizeAndTimeBasedFNATP（按时间和大小的文件命名和触发策略），确保日志文件在每天生成的基础上，当文件大小超过100MB时会切分日志文件
- 100MB：定义单个日志文件的最大大小为100MB。超过这个大小会创建一个新的日志文件（例如error-2024-10-03.1.log，error-2024-10-03.2.log）
- 15：设置日志保留的历史天数，最多保留15天的日志文件，超过这个天数的日志会被自动删除
1.5、filter（日志过滤器）
- ：使用LevelFilter来过滤日志，只允许指定级别的日志写入文件
- ERROR：表示该appender只接受ERROR级别的日志
- ACCEPT：当日志级别是ERROR时，日志将被接受并写入文件
- DENY：当日志级别不为ERROR时（如info、warn等），日志将被拒绝，不写入文件
2、日志文件打印sql
- 常规设置打印日志，使用StdOutImpl类，打印使用的是System.out，这些日志不会输出到日志文件
mybatis-plus.configuration.log-impl=org.apache.ibatis.logging.stdout.StdOutImpl
- 修改输出工具配置为Slf4jImpl，这里使用Slf4j门面
mybatis-plus.configuration.log-impl=org.apache.ibatis.logging.slf4j.Slf4jImpl
- mapper目录设置为debug模式
logging.level.com.xxx.mapper=debug
3、logback-spring.xml完整配置文件
logback debug ${CONSOLE_LOG_PATTERN} UTF-8 ${log.path}/debug.log ${FILE_PATTERN} UTF-8 ${log.path}/debug-%d{yyyy-MM-dd}.%i.log 100MB 15 debug ACCEPT DENY ${log.path}/info.log ${FILE_PATTERN} UTF-8 ${log.path}/info-%d{yyyy-MM-dd}.%i.log 100MB 15 info ${log.path}/warn.log ${FILE_PATTERN} UTF-8 ${log.path}/warn-%d{yyyy-MM-dd}.%i.log 100MB 15 warn ACCEPT DENY ${log.path}/error.log ${FILE_PATTERN} UTF-8 ${log.path}/error-%d{yyyy-MM-dd}.%i.log 100MB 15 ERROR ACCEPT DENY
- mapper目录设置为debug模式
- 修改输出工具配置为Slf4jImpl，这里使用Slf4j门面
- 常规设置打印日志，使用StdOutImpl类，打印使用的是System.out，这些日志不会输出到日志文件
-
- ${log.path}/error.log：指定日志文件的路径和文件名
- 这里是只过滤日志级别为errer的日志进行归档，下面详细介绍下属性
- SpringBoot预定义两个组
- 定义完成后，只需一行即可更改组中所有日志记录器的级别
- 支持定义日志记录组，将多个不同的包放到同一个组别中统一管理设置日志级别
- 由低到高：ALL,TRACE, DEBUG, INFO, WARN, ERROR,FATAL,OFF
- 此依赖位于spring-boot-starter-web下的spring-boot-starter内部
免责声明：我们致力于保护作者版权，注重分享，被刊用文章因无法核实真实出处，未能及时与作者取得联系，或有版权异议的，请联系管理员，我们会立即处理! 部分文章是来自自研大数据AI进行生成,内容摘自(百度百科,百度知道,头条百科,中国民法典,刑法,牛津词典,新华词典,汉语词典,国家院校,科普平台)等数据,内容仅供学习参考,不准确地方联系删除处理! 图片声明：本站部分配图来自人工智能系统AI生成,觅知网授权图片,PxHere摄影无版权图库和百度，360，搜狗等多加搜索引擎自动关键词搜索配图，如有侵权的图片，请第一时间联系我们。
