lombok几个基本注解的使用及遇到的坑点

最新推荐文章于 2025-05-06 16:31:38 发布

YXWik6

最新推荐文章于 2025-05-06 16:31:38 发布

阅读量1.1k

点赞数 1

CC 4.0 BY-SA版权

本文链接：https://blog.youkuaiyun.com/YXWik/article/details/109471126

本文详细介绍了Lombok插件的安装方法及常用注解的功能，包括@Data、@Setter、@Getter等，并探讨了使用这些注解可能遇到的问题，如equals方法实现不当和封装性破坏等问题。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

安装lombok插件：https://blog.youkuaiyun.com/YXWik/article/details/109379610

常用注解

@Data 注解在类上；提供类所有属性的 getting 和 setting 方法，此外还提供了equals、canEqual、hashCode、toString 方法
@Setter ：注解在属性上；为属性提供 setting 方法
@Getter ：注解在属性上；为属性提供 getting 方法
@Log4j ：注解在类上；为类提供一个属性名为log 的 log4j 日志对象
@NoArgsConstructor ：注解在类上；为类提供一个无参的构造方法
@AllArgsConstructor ：注解在类上；为类提供一个全参的构造方法
@Cleanup : 可以关闭流
@Builder ：被注解的类加个构造者模式
@Synchronized ：加个同步锁
@SneakyThrows : 等同于try/catch 捕获异常
@NonNull : 如果给参数加个这个注解参数为null会抛出空指针异常
@Value : 注解和@Data类似，区别在于它会把所有成员变量默认定义为private final修饰，并且不会生成set方法。

使用中的坑

1.踩过的坑
在使用Lombok过程中，如果对于各种注解的底层原理不理解的话，很容易产生意想不到的结果。
举一个简单的例子，我们知道，当我们使用@Data定义一个类的时候，会自动帮我们生成equals()方法。
但是如果只使用了@Data，而不使用@EqualsAndHashCode(callSuper=true)的话，会默认是@EqualsAndHashCode(callSuper=false),这时候生成的equals()方法只会比较子类的属性，不会考虑从父类继承的属性，无论父类属性访问权限是否开放。
2.破坏封装性
Java的三大特性包括封装性、继承性和多态性。
如果我们在代码中直接使用Lombok，那么他会自动帮我们生成getter、setter 等方法，这就意味着，一个类中的所有参数都自动提供了设置和读取方法。
举个简单的例子，我们定义一个购物车类：

@Data
public class ShoppingCart { 
    //商品数目
    private int itemsCount; 
    //总价格
    private double totalPrice; 
    //商品明细
    private List items = new ArrayList<>();
}

我们知道，购物车中商品数目、商品明细以及总价格三者之前其实是有关联关系的，如果需要修改的话是要一起修改的。

但是，我们使用了Lombok的@Data注解，对于itemsCount 和 totalPrice这两个属性。虽然我们将它们定义成 private 类型，但是提供了 public 的 getter、setter 方法。

外部可以通过 setter 方法随意地修改这两个属性的值。我们可以随意调用 setter 方法，来重新设置 itemsCount、totalPrice 属性的值，这也会导致其跟 items 属性的值不一致。

而面向对象封装的定义是：通过访问权限控制，隐藏内部数据，外部仅能通过类提供的有限的接口访问、修改内部数据。所以，暴露不应该暴露的 setter 方法，明显违反了面向对象的封装特性。
解决办法：
指定为private

@Getter(value = AccessLevel.PRIVATE)
@Setter(value = AccessLevel.PRIVATE)