Lombok 介绍+使用

最新推荐文章于 2022-12-23 12:14:36 发布

原创最新推荐文章于 2022-12-23 12:14:36 发布 · 3.6w 阅读

1 ·

CC 4.0 BY-SA版权

文章标签：

#工具/插件

Java工具/插件类专栏收录该内容

4 篇文章

订阅专栏

Lombok是一款能够显著减少Java代码中重复性工作，如getter、setter等方法的自动生成工具。它通过注解方式在编译时插入代码，提高了开发效率并保持代码简洁。本文介绍了Lombok的安装、使用方法及优缺点。

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

Lombok能以简单的注解形式来简化java代码，提高开发人员的开发效率。例如开发中经常需要写的javabean，都需要花时间去添加相应的getter/setter，也许还要去写构造器、equals等方法，而且需要维护，当属性多时会出现大量的getter/setter方法，这些显得很冗长也没有太多技术含量，一旦修改属性，就容易出现忘记修改对应方法的失误。

Lombok能通过注解的方式，在编译时自动为属性生成构造器、getter/setter、equals、hashcode、toString方法。出现的神奇就是在源码中没有getter和setter方法，但是在编译生成的字节码文件中有getter和setter方法。这样就省去了手动重建这些代码的麻烦，使代码看起来更简洁些。

Lombok的使用跟引用jar包一样，可以在官网（https://projectlombok.org/download）下载jar包，也可以使用maven添加依赖：

  <!-- lombok -->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>1.16.12</version>
        </dependency>

Lombok的使用很简单，直接在类上注解例如：@Getter @Setter 这两个注解会生成类的get，set 方法：

/**
 * @Auther: Summer
 * @Date: 2019-01-06 18:09
 * @Description: 
 * @versions:1.0
 */
@Getter     //依据注解声明get方法
@Setter     //依据注解声明set方法
@ToString   //依据注解声明toString方法
public class DeptParam {
    private Integer id;

    private  String name;
    
    private  Integer parentId;
    
    private  String remark;
}

@Data注解在类上，会为类的所有属性自动生成setter/getter、equals、canEqual、hashCode、toString方法，如为final属性，则不会为该属性生成setter方法。官方实例如下：

import lombok.AccessLevel;
import lombok.Setter;
import lombok.Data;
import lombok.ToString;

@Data public class DataExample {
  private final String name;
  @Setter(AccessLevel.PACKAGE) private int age;
  private double score;
  private String[] tags;
  
  @ToString(includeFieldNames=true)
  @Data(staticConstructor="of")
  public static class Exercise<T> {
    private final String name;
    private final T value;
  }
}

Lombok的优缺点

优点：

能通过注解的形式自动生成构造器、getter/setter、equals、hashcode、toString等方法，提高了一定的开发效率
让代码变得简洁，不用过多的去关注相应的方法
属性做修改时，也简化了维护为这些属性所生成的getter/setter方法等

缺点：

不支持多种参数构造器的重载
虽然省去了手动创建getter/setter方法的麻烦，但大大降低了源代码的可读性和完整性，降低了阅读源代码的舒适度

注意:

如果使用@Data（相当于@Getter @Setter @RequiredArgsConstructor @ToString @EqualsAndHashCode这5个注解的合集）需配合@EqualsAndHashCode(callSuper=true)注解使用，因为

当使用@Data注解时，则有了@EqualsAndHashCode注解，那么就会在此类中存在equals(Object other) 和 hashCode()方法，且不会使用父类的属性，这就导致了可能的问题。
比如，有多个类有相同的部分属性，把它们定义到父类中，恰好id（数据库主键）也在父类中，那么就会存在部分对象在比较时，它们并不相等，却因为lombok自动生成的equals(Object other) 和 hashCode()方法判定为相等，从而导致出错。

修复此问题的方法很简单：
1. 使用@Getter @Setter @ToString代替@Data并且自定义equals(Object other) 和 hashCode()方法，比如有些类只需要判断主键id是否相等即足矣。
2. 或者使用在使用@Data时同时加上@EqualsAndHashCode(callSuper=true)注解。