SpringBoot+Lombok+Logback实现日志

LombokLogback实现日志功能一、Lombok 详解Lombok 是一款 Java 开发工具库核心目标是通过注解简化 Java 类的模板代码如 getter/setter、构造方法、日志对象等减少冗余代码提升开发效率。它的原理是在编译阶段而非运行时动态生成字节码因此不影响程序运行性能。1. 核心优势消除模板代码无需手动编写getXxx()、setXxx()、toString()等重复代码代码更简洁专注业务逻辑类结构更清晰低侵入性仅在编译期生效运行时无额外依赖scopeprovided。2. 前置配置必做1引入依赖Maven!-- Lombok 核心依赖 --dependencygroupIdorg.projectlombok/groupIdartifactIdlombok/artifactIdversion1.18.30/versionscopeprovided/scope/dependency2IDE 安装插件IntelliJ IDEASettings → Plugins → 搜索 Lombok → 安装并重启 IDEEclipseMarketplace → 搜索 Lombok → 安装需确保 eclipse.ini 配置 Lombok 路径。插件作用让 IDE 识别 Lombok 注解生成的代码避免 “找不到方法 / 变量” 的语法提示不装插件不影响编译但开发体验差。安装成功如图3. Lombok 常用注解注解作用Data组合注解包含 GetterSetterToStringEqualsAndHashCodeRequiredArgsConstructorGetter/Setter为字段生成 getter/setter 方法可加在类上所有字段或单个字段上ToString生成 toString() 方法可通过 exclude 排除指定字段EqualsAndHashCode生成 equals() 和 hashCode() 方法NoArgsConstructor生成无参构造方法AllArgsConstructor生成全参构造方法RequiredArgsConstructor为 final 或 NonNull 字段生成构造方法Builder实现建造者模式支持链式调用创建对象NonNull字段非空校验赋值为 null 时抛出 NullPointerExceptionCleanup自动关闭资源如 IO 流、连接替代 try-finallyValue不可变对象相当于final类DataSneakyThrows隐藏异常捕获(简化try-catch)Synchronized安全的同步锁替代 synchronized 关键字Slf4j生成 SLF4J 日志对象 log(本文主要内容)4. 示例1. 基础核心注解实体类高频1Getter/Setter生成 getter/setter 方法importlombok.Getter;importlombok.Setter;// 类级别为所有字段生成 getter/setterGetterSetterpublicclassGetterSetterDemo{privateLongid;privateStringname;// 字段级别仅为该字段生成优先级高于类级别GetterprivateIntegerage;publicstaticvoidmain(String[]args){GetterSetterDemodemonewGetterSetterDemo();demo.setId(1L);// Setter 生成demo.setName(张三);// Setter 生成System.out.println(demo.getId());// Getter 生成System.out.println(demo.getAge());// 字段级别 Getter 生成}}2ToString生成 toString () 方法importlombok.ToString;ToString(excludeage,// 排除指定字段,多个字段使用{age,name}includeFieldNamestrue// 是否显示字段名默认true)publicclassToStringDemo{privateLongid;privateStringname;privateIntegerage;publicstaticvoidmain(String[]args){ToStringDemodemonewToStringDemo();demo.id1L;demo.name李四;demo.age20;// 输出ToStringDemo(id1, name李四)排除了ageSystem.out.println(demo.toString());}}3EqualsAndHashCode生成 equals ()/hashCode ()importlombok.EqualsAndHashCode;EqualsAndHashCode(of{id,name},// 仅基于指定字段生成避免父类字段干扰callSuperfalse// 是否包含父类字段默认false)publicclassEqualsHashCodeDemo{privateLongid;privateStringname;privateIntegerage;publicstaticvoidmain(String[]args){EqualsHashCodeDemod1newEqualsHashCodeDemo();d1.id1L;d1.name王五;d1.age20;EqualsHashCodeDemod2newEqualsHashCodeDemo();d2.id1L;d2.name王五;d2.age30;// 输出 true仅比较id和nameSystem.out.println(d1.equals(d2));System.out.println(d1.hashCode()d2.hashCode());// true}}4Data组合注解GetterSetterToStringEqualsAndHashCodeRequiredArgsConstructorimportlombok.Data;Data// 一站式生成核心方法无需单独加其他注解publicclassDataDemo{privateLongid;privateStringname;privatefinalIntegertype1;// final字段会被RequiredArgsConstructor包含publicstaticvoidmain(String[]args){DataDemodemonewDataDemo(1);// RequiredArgsConstructor 生成仅final字段demo.setId(100L);demo.setName(赵六);// 输出DataDemo(id100, name赵六, type1)System.out.println(demo);}}5构造方法注解NoArgsConstructor/AllArgsConstructor/RequiredArgsConstructorimportlombok.AllArgsConstructor;importlombok.NoArgsConstructor;importlombok.RequiredArgsConstructor;NoArgsConstructor// 无参构造AllArgsConstructor// 全参构造RequiredArgsConstructor// 为final/NonNull字段生成构造publicclassConstructorDemo{privateLongid;NonNullprivateStringname;// 非空字段privatefinalIntegerstatus0;// final字段publicstaticvoidmain(String[]args){ConstructorDemod1newConstructorDemo();// NoArgsConstructorConstructorDemod2newConstructorDemo(1L,钱七,1);// AllArgsConstructorConstructorDemod3newConstructorDemo(孙八);// RequiredArgsConstructor仅name}}2. 进阶注解1Builder建造者模式链式创建对象importlombok.Builder;importlombok.Data;DataBuilder// 生成建造者方法publicclassBuilderDemo{privateLongid;privateStringname;privateIntegerage;publicstaticvoidmain(String[]args){// 链式调用创建对象无需手动setBuilderDemodemoBuilderDemo.builder().id(1L).name(周九).age(25).build();System.out.println(demo);// BuilderDemo(id1, name周九, age25)}}2NonNull非空校验importlombok.NonNull;publicclassNonNullDemo{privateStringname;publicvoidsetName(NonNullStringname){this.namename;}publicstaticvoidmain(String[]args){NonNullDemodemonewNonNullDemo();// 传入null会抛出NullPointerExceptionLombok自动生成校验demo.setName(null);}}3Cleanup自动关闭资源importlombok.Cleanup;importjava.io.FileInputStream;importjava.io.IOException;publicclassCleanupDemo{publicstaticvoidmain(String[]args){try{CleanupFileInputStreamisnewFileInputStream(test.txt);System.out.println(文件字节数is.available());}catch(IOExceptione){e.printStackTrace();}// 自动关闭is}}4Value不可变对象替代 final Dataimportlombok.Value;Value// 等价于final类 所有字段final Getter ToString EqualsAndHashCode AllArgsConstructorpublicclassValueDemo{Longid;Stringname;Integerage;publicstaticvoidmain(String[]args){ValueDemodemonewValueDemo(1L,吴十,30);// demo.setId(2L); // 编译报错无setter方法不可变System.out.println(demo.getId());// 仅能读取}}5SneakyThrows隐藏异常捕获简化 try-catchimportlombok.SneakyThrows;importjava.io.FileInputStream;publicclassSneakyThrowsDemo{// 自动捕获Checked异常无需手动try-catch或throws声明SneakyThrowspublicstaticvoidreadFile(){FileInputStreamisnewFileInputStream(test.txt);System.out.println(is.available());}publicstaticvoidmain(String[]args){readFile();// 无需处理IOException}}5Synchronized安全的同步锁替代 synchronized 关键字importlombok.Synchronized;publicclassSynchronizedDemo{privatefinalObjectlocknewObject();// 等价于 synchronized(this)Synchronizedpublicvoidmethod1(){System.out.println(方法1同步执行);}// 指定锁对象等价于 synchronized(lock)Synchronized(lock)publicvoidmethod2(){System.out.println(方法2同步执行);}publicstaticvoidmain(String[]args){SynchronizedDemodemonewSynchronizedDemo();newThread(demo::method1).start();newThread(demo::method2).start();}}是不是发现少了个Slf4j 这里留到最后单独讲解使用因为这是本文的核心内容Slf4j 注解详解Slf4j 是 Lombok 框架提供的一个注解核心作用是自动为类生成日志对象无需手动编写 private static final Logger log LoggerFactory.getLogger(XXX.class); 这类重复代码简化日志开发。1前置条件1、Slf4j 是 Lombok 框架提供的一个注解,所以需要导入Lombok依赖以及安装插件(已满足)2、SLF4J Logback 为例主流组合,Logback为SpringBoot默认依赖的日志框架所以需要引入SpringBoot依赖在引入后会自动引入对应版本的依赖2基础使用importlombok.extern.slf4j.Slf4j;// 注解加在类上自动生成 log 日志对象Slf4jpublicclassUserService{publicvoidaddUser(Stringusername){// 直接使用自动生成的 log 对象打印日志log.info(开始添加用户用户名{},username);// 信息级日志支持占位符try{// 业务逻辑log.debug(用户添加中用户名{},username);// 调试级日志开发环境用}catch(Exceptione){// 错误级日志传入异常对象自动打印堆栈信息log.error(添加用户失败用户名{},username,e);}}publicstaticvoidmain(String[]args){newUserService().addUser(张三);}}3核心逻辑说明Slf4j 会在编译阶段为类生成如下代码无需手动写privatestaticfinalorg.slf4j.Loggerlogorg.slf4j.LoggerFactory.getLogger(UserService.class);日志级别从低到高trace debug info warn error可通过配置文件如 logback.xml控制输出级别。占位符 {} 是 SLF4J 的特性避免手动拼接字符串如 log.info(“用户名” username)提升性能和可读性。4日志输入格式Spring Boot 默认使用 Logback 作为日志框架因此配置主要围绕 Logback 展开。日志格式的核心要素包括时间戳%d日志级别%level线程名%thread类 / 方法名%logger/%M日志内容%msg换行%n方案 1通过 application.yml/properties 快速修改简单场景适合只需要微调默认格式的场景无需编写 XML 配置直接在 Spring Boot 核心配置文件中设置。示例application.yml 配置# application.ymllogging:# 全局日志级别可针对特定包单独设置level:root:INFO# 根日志级别com.example.demo:DEBUG# 自定义包的日志级别# 控制台输出格式pattern:console:%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n# 文件输出格式如果开启了文件日志file:%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n# 可选开启日志文件输出指定路径和大小file:name:./logs/demo.log# 日志文件路径logback:rollingpolicy:max-file-size:10MB# 单个日志文件最大大小max-history:7# 日志文件保留天数格式参数解释参数含义%d{yyyy-MM-dd HH:mm:ss.SSS}时间戳精确到毫秒[%thread]线程名方括号是自定义格式可去掉%-5level日志级别-5 表示左对齐占 5 个字符如 INFO、DEBUG%logger{50}类名 / Logger 名称{50} 表示最长显示 50 个字符超出会截断%msg日志内容业务代码中 log.info(“xxx”) 里的内容%n换行符保证每条日志单独一行方案 2通过 logback-spring.xml 自定义复杂场景如果需要更精细的控制比如不同日志级别用不同颜色、分模块输出、自定义过滤器推荐使用 Logback 专属配置文件。步骤 1创建配置文件在 src/main/resources 下新建 logback-spring.xmlSpring Boot 会自动识别这个文件名。步骤 2完整配置示例含彩色输出 多文件拆分?xml version1.0 encodingUTF-8?configurationscantruescanPeriod30 seconds!-- 基础配置定义变量方便复用 --propertynameLOG_PATTERNvalue%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n/propertynameLOG_PATHvalue./logs/!-- 日志文件根路径 --!-- 1. 控制台输出 Appender支持彩色 --appendernameCONSOLEclassch.qos.logback.core.ConsoleAppenderencoderclassch.qos.logback.classic.encoder.PatternLayoutEncoder!-- 开启彩色输出仅控制台生效 --withJansitrue/withJansi!-- 日志格式复用上面定义的变量 --pattern${LOG_PATTERN}/patterncharsetUTF-8/charset/encoder/appender!-- 2. 文件输出 Appender滚动日志避免单个文件过大 --appendernameFILEclassch.qos.logback.core.rolling.RollingFileAppender!-- 日志文件路径 --file${LOG_PATH}/demo.log/file!-- 滚动策略按大小日期拆分 --rollingPolicyclassch.qos.logback.core.rolling.TimeBasedRollingPolicy!-- 拆分后的日志文件名demo-2024-03-13.log --fileNamePattern${LOG_PATH}/demo-%d{yyyy-MM-dd}.log/fileNamePattern!-- 单个文件最大大小 --maxFileSize10MB/maxFileSize!-- 日志保留天数 --maxHistory7/maxHistory!-- 总日志大小上限超出会删除旧文件 --totalSizeCap100MB/totalSizeCap/rollingPolicyencoderclassch.qos.logback.classic.encoder.PatternLayoutEncoderpattern${LOG_PATTERN}/patterncharsetUTF-8/charset/encoder/appender!-- 3. 针对特定包的日志配置比如DAO层单独输出 --loggernamecom.example.demo.mapperlevelDEBUGadditivityfalseappender-refrefCONSOLE/appender-refrefFILE//logger!-- 4. 根日志配置 --rootlevelINFOappender-refrefCONSOLE/appender-refrefFILE//root/configuration关键配置解释彩色输出true 开启后控制台日志会按级别显示不同颜色INFO 绿色、ERROR 红色、WARN 黄色需确保 IDE 控制台支持 ANSI 颜色IDEA 默认支持。additivity“false”避免特定包的日志被重复输出到根日志比如 mapper 层的日志只输出一次。滚动策略TimeBasedRollingPolicy 实现「按日期 大小」拆分日志防止日志文件过大。