Lombok 之 Log

本文介绍Lombok中用于简化日志记录的注解,包括@CommonsLog、@Log、@Log4j等,并通过示例展示了如何使用这些注解来替代传统日志初始化代码。

LomBok 的相关目录已经整理出来,希望大家可以根据需求自助学习,好工具要大家分享:

@Cleanup     

@Getter, @Setter

@ToString

@EqualsAndHashCode

@Constructor

@Data & @Value

@SneakyThrows

@Synchronized

@Getter(lazy=true)

@Log

 

这是本系列最后一个annotation了,也是Lombok里面最好用的一个了,我们每天写项目都会有很多日志需要记录,很多人都写过这样的代码:

private static final org.apache.commons.logging.Log log = org.apache.commons.logging.LogFactory.getLog(LogExample.class);

 

Lombok的方便不是说说而已的,哪里有重复,哪里就有Lombok(YY的 :) ),Lombok封装了许多主流的Log库,提供了一系列关于Log 的annotation。下面就是所有的annotation会代表哪些特定的类 :

 

@CommonsLog
Creates private static final org.apache.commons.logging.Log log = org.apache.commons.logging.LogFactory.getLog(LogExample.class);
@Log
Creates private static final java.util.logging.Logger log = java.util.logging.Logger.getLogger(LogExample.class.getName());
@Log4j
Creates private static final org.apache.log4j.Logger log = org.apache.log4j.Logger.getLogger(LogExample.class);
@Log4j2
Creates private static final org.apache.logging.log4j.Logger log = org.apache.logging.log4j.LogManager.getLogger(LogExample.class);
@Slf4j
Creates private static final org.slf4j.Logger log = org.slf4j.LoggerFactory.getLogger(LogExample.class);
@XSlf4j
Creates private static final org.slf4j.ext.XLogger log = org.slf4j.ext.XLoggerFactory.getXLogger(LogExample.class);

 

就用其中的几个举个例子吧:

 import lombok.extern.java.Log;
 import lombok.extern.slf4j.Slf4j;
 
 @Log
 public class LogExample {
   
   public static void main(String... args) {
     log.error("Something's wrong here");
   }
 }
 
 @Slf4j
 public class LogExampleOther {
   
   public static void main(String... args) {
     log.error("Something else is wrong here");
   }
 }
 
 @CommonsLog(topic="CounterLog")
 public class LogExampleCategory {
 
   public static void main(String... args) {
     log.error("Calling the 'CounterLog' with a message");
   }
 }

 

翻译一下,代码如下:

public class LogExample {
  private static final java.util.logging.Logger log = java.util.logging.Logger.getLogger(LogExample.class.getName());
  
  public static void main(String... args) {
    log.error("Something's wrong here");
  }
}

public class LogExampleOther {
  private static final org.slf4j.Logger log = org.slf4j.LoggerFactory.getLogger(LogExampleOther.class);
  
  public static void main(String... args) {
    log.error("Something else is wrong here");
  }
}

public class LogExampleCategory {
  private static final org.apache.commons.logging.Log log = org.apache.commons.logging.LogFactory.getLog("CounterLog");

  public static void main(String... args) {
    log.error("Calling the 'CounterLog' with a message");
  }
}

 

想必不用多说了,例子一看就懂了,唠叨一句就是annotation提供一个topic选项,可以定制化getLog方法的参数。 为什么没提供backlog呢? 一直用backlog啊

<think>好的,用户想知道如何在Java中使用Lombok的@Log注解进行日志记录。首先,我需要回忆Lombok的相关知识,特别是日志注解的使用方法。 Lombok提供多种@Log注解,比如@Log、@Log4j、@Slf4j等,每个对应不同的日志框架。用户需要先确定他们使用的日志框架,比如Java Util Logging、Log4j、SLF4J等,然后选择对应的注解。 接下来,步骤应该是:添加Lombok依赖,导入对应的注解,然后在类上使用注解,之后直接使用log变量记录日志。需要给出具体的代码示例,比如使用@Log4j或@Slf4j的情况,并说明如何配置依赖,特别是Maven项目中的pom.xml配置。 另外,用户可能遇到的问题包括依赖未正确添加、注解不支持当前的日志框架,或者需要自定义日志名称。这时候需要提到如何通过lombok.config进行配置,或者使用@CustomLog来自定义。同时,要注意IDE是否需要安装Lombok插件,否则代码可能无法正确编译。 还需要提醒用户不同的注解对应不同的日志库,例如@Log4j需要Log4j的库,而@Slf4j需要SLF4J的实现。如果用户使用了错误的注解,可能会导致NoClassDefFoundError,这时候需要检查依赖是否正确。 最后,生成相关问题,帮助用户进一步了解,比如不同日志注解的区别、配置自定义日志名称的方法,或者解决常见问题如依赖缺失等。</think>在Java中使用Lombok的@Log系列注解可以简化日志组件的声明,具体步骤如下: 1. **添加Lombok依赖** 在Maven项目中需添加以下依赖(版本号根据需求调整): ```xml <dependency> <groupId>org.projectlombok</groupId> <artifactId>lombok</artifactId> <version>1.18.30</version> <scope>provided</scope> </dependency> ```[^3] 2. **选择对应的日志注解** Lombok提供多种日志注解适配不同框架: ```java @Log // Java Util Logging(JDK原生) public class ClassA {} @Log4j // Apache Log4j 1.x public class ClassB {} @Slf4j // SLF4J(需具体实现如Logback) public class ClassC {} ``` 3. **直接使用log变量** 注解会自动生成名为`log`的静态日志对象: ```java @Slf4j public class PaymentService { public void process() { log.debug("Payment processing started"); log.info("Payment completed: {}", transactionId); } } ``` **特殊配置示例**: - 自定义日志名称:使用`topic`属性 ```java @Slf4j(topic = "NETWORK_LOGGER") public class NetworkClient { void connect() { NETWORK_LOGGER.info("Establishing connection"); } } ``` - 兼容新版本日志框架:对于Log4j 2.x可使用: ```java @CustomLog(topic = "security") public class AuthService { void authenticate() { security.info("Authentication attempt detected"); } } ``` **注意要点**: 1. 需确保目标日志框架的依赖已正确添加 2. 在IDE中需要安装Lombok插件以避免编译错误 3. 日志级别控制仍需通过日志框架配置文件实现
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
红包 添加红包
表情包 插入表情
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值