Lombok使用详解---简化Java开发

目录

1、Lombok介绍

2、安装lombok插件

3、使用lombok开发

4、其他注解

5、注意

---

1、Lombok介绍

Lombok是一种能够帮助我们简化Java开发，减轻代码臃肿的小工具。该工具优点是使用方便，只需要几个注解，就可以帮我们减少很多重复代码。下面先展示一个例子来体验一下Lombok的好处：

常规写法：

import java.util.Objects;

public class User {

    private Long id;

    private String name;

    private Integer age;

    public Long getId() {
        return id;
    }

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

    public String getName() {
        return name;
    }

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

    public Integer getAge() {
        return age;
    }

    public void setAge(Integer age) {
        this.age = age;
    }

    @Override
    public String toString() {
        return "User{" + "id=" + id + ", name='" + name + '\'' + ", age=" + age + '}';
    }

    @Override
    public boolean equals(Object o) {

        if (this == o) {
            return true;
        }
        if (!(o instanceof User)) {
            return false;
        }
        User user = (User)o;
        return Objects.equals(getId(), user.getId()) && Objects.equals(getName(), user.getName()) &&
                Objects.equals(getAge(), user.getAge());
    }

    @Override
    public int hashCode() {

        return Objects.hash(getId(), getName(), getAge());
    }
}

Lombok写法：

import lombok.Data;
import java.io.Serializable;

@Data
public class User {

    private Long id;

    private String name;

    private Integer age;
}

虽然上面两部分的代码量相差很多，但是这两部分是完全等价的。是不是觉得很神奇，接下来将会介绍如何使用Lombok来简化开发。

2、安装lombok插件

使用lombok需要安装所需的插件，下面介绍IntelliJ IDEA插件安装流程（其他软件安装方法地址：https://www.projectlombok.org/setup/overview）：

2.1、菜单栏File > Settings > Plugins > Browse repositories

 2.2、搜索 Lombok Plugin 安装后，重启IDEA即可生效

3、使用lombok开发

3.1、在pom.xml中添加lombok依赖

	<dependency>
		<groupId>org.projectlombok</groupId>
		<artifactId>lombok</artifactId>
		<version>1.18.4</version>
		<scope>provided</scope>
	</dependency>

3.2、编写实体类，使用@Data注解。如果使用@Data，在编译时，会自动给实体类添加set/get方法，toString方法，equals方法，hashCode方法，不带参数的构造方法。

import lombok.Data;
import java.io.Serializable;

@Data
public class User {

    private Long id;

    private String name;

    private Integer age;
}

3.3、测试@Data作用

    @Test
    public void testUser() {

        User user = new User();
        user.setId(1L);
        user.setName("czz");
        user.setAge(22);
        System.err.println(user.toString());
    }

4、其他注解

就像上面例子所展示的，通过注解，我们可以在一定程度上减少我们的代码量。除了@Data，lombok还有其他好用的注解：

val : 最终局部变量
@NonNull : 让你不在担忧并且爱上NullPointerException
@CleanUp : 自动资源管理：不用再在finally中添加资源的close方法
@Setter/@Getter : 自动生成set和get方法
@ToString : 自动生成toString方法
@EqualsAndHashcode : 从对象的字段中生成hashCode和equals的实现
@NoArgsConstructor/@RequiredArgsConstructor/@AllArgsConstructor ：自动生成无参/部分参/全参构造方法
@Data : 自动生成set/get方法，toString方法，equals方法，hashCode方法，不带参数的构造方法
@Value : 用于注解final类
@Builder : 产生复杂的构建器api类
@SneakyThrows : 异常处理（谨慎使用）
@Synchronized : 同步方法安全的转化
@Getter(lazy=true) :
@Log : 支持各种logger对象，使用时用对应的注解，如：@Log4j

具体详情可以参考lombok的官方实例：https://www.projectlombok.org/features/all

5、注意

@Data注解推荐在Bean或者Entity 类上使用，同时，如果继承一个被lombok注解的类，子类不会继承lombok的注解（例如继承一个@Data的类，子类的还要添加@Data注解，才会自动生成各种方法）