Lombok的介绍与使用

Lombok是啥？

一个java库，一个构建工具。通过简单的注解来实现精简代码，消除冗长代码和提高开发效率的目的。

为啥要使用Lombok

大家在写bug的时候，肯定和很多的实体打过交道，然后我们要写getter()、setter()、toString()等等。

不，我们不用写，不管是idea还是eclipse都有快捷键给我们生成getter()、setter()。所以我们还是能很快的开发。

可是还是有下面的一些问题：

• 众多的getter()、setter()，占据整个类，影响代码的可读性。如果我们开发将字段穿插在 getter()、setter()之间呢？

public class User {
    /** id */
    private Long id;

    public Long getId() {
        return id;
    }

    public void setId(Long id) {
        this.id = id;
    }

    /** 姓名 */
    private String name;

    public void setName(String name) {
        this.name = name;
    }

    public String getName() {
        return name;
    }
}

上面和下面的，很明显下面的更直观，一目了然

public class User {
    /** id */
    private Long id;

    /** 姓名 */
    private String name;
}

• 我们新增一个字段，那么我们就要新增对应的 getter()、setter()，修改 toString() 等等；
• 我们删除一个字段，要把对应的getter()、setter()删除，修改toString()等等；
• 我们修改一个字段的类型，比如 Integer 修改成 String。那我们要删除 getter()、setter() 先，然后生成getter()、setter()，再修改 toString()等等。
• 如果一个实体有很多的属性字段，那么修改其中一个，定位不容易。
• 如果我们想用流式风格创建对象，又要写一堆代码。
• 如果我们想生成带所有参数的构造器，又如何？

Lombok能解决上面所有的问题，只需要几个注解即可。

Lombok安装

IntelliJ IDEA

• Lombok插件安装

File → Settings... → Plugins → Browse repositories → 搜索Lombok → 安装插件 。

具体可参考下图：

install_1.png install_2.png

安装完毕，重启idea，那我们就安装好Lombok插件了

• 引入jar包

插件安装完毕，我们只要在对应的项目中引入jar包，就可以愉快的开发了。

<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
    <version>1.18.2</version>
</dependency>

Lombok注解

@Data

这个注解会帮我们生成getter、setter、equals、hashCode、toString等方法。可以说很强大了。

image.png

@Getter、@Setter

这两个注解就是分别生成我们的getter和setter。可以放在类或者属性上

• 放在类上，所有属性都生成getter和setter
• 放在属性上，只有对应的属性生成getter和setter

@ToString

在类上使用，生成toString()方法。

• @ToString(of = {"id", "name"})
  指定包含的属性

• @ToString(exclude = {"id", "name"})
  指定排除的属性

• @ToString(callSuper = true)
  输出父类的属性

@EqualsAndHashCode

在类上使用，生成equals和hashcode方法

@Slf4j

我们开发的时候，很多时候都是要记录日志的，便于以后的问题排查。经常要写类似于下面的代码。

private static final Logger log = LoggerFactory.getLogger(User.class);

@Slf4j帮我们自动生成这行代码。在类上使用

@NoArgsConstructor

生成无参构造器

@AllArgsConstructor

生成带所有属性的构造器，不生成默认的无参构造器

@Builder

用于类上，生成流式API。当我们创建新的对象时，会使我们的代码更优雅。

User user = new User();
user.setId(1L);
user.setName("roach");
user.setGender(1);
user.setBirthday(new Date());
user.setAge(18);

// 流式方式设置属性值
User user1 = User.builder()
        .id(1L)
        .name("roach")
        .gender(1)
        .birthday(new Date())
        .age(18)
    .build();