Spring||介绍及简单使用lombok

了解lombok

Lombok在官方的介绍是：Lombok是一个Java库，可以自动的插入编辑器并构建工具，病简化java开发，通过添加注解的方式，不需要为类编写getter（）、equals（）方法，同时还可以自动化日志变量

Lombok的安装和配置

• 在pom文件中添加maven依赖

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

• 插件安装

打开idea的设置，点击Plugins，在弹出的窗口中搜索lombok，然后安装即可。

• 解决编译时出错

编译时出错，可能是没有enable注解处理器。设置完成之后程序正常运行。

简单使用lombok

创建一个User依赖类，分不用lombok和使用lombok两种情况讨论

不用lombok时：

import java.io.Serializable;
import java.util.Objects;

public class User1 implements Serializable {
    private int id;
    private String name;
    private String sex;
    private int age;

    public int getId() {
        return id;
    }

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

    public String getName() {
        return name;
    }

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

    public String getSex() {
        return sex;
    }

    public void setSex(String sex) {
        this.sex = sex;
    }

    public int getAge() {
        return age;
    }

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

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

    @Override
    public boolean equals(Object o) {
        if (this == o) return true;
        if (o == null || getClass () != o.getClass ()) return false;
        User1 user1 = (User1) o;
        return id == user1.id &&
                age == user1.age &&
                Objects.equals (name, user1.name) &&
                Objects.equals (sex, user1.sex);
    }

    @Override
    public int hashCode() {
        return Objects.hash (id, name, sex, age);
    }
}

使用lombok后：

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

@Data
public class User1 implements Serializable {
    private int id;
    private String name;
    private String sex;
    private int age;
    
}

常用Lombok注解

• @Setter 注解在类或字段，注解在类时为所有字段生成setter方法，注解在字段上时只为该字段生成setter方法。

• @Getter 使用方法同上，区别在于生成的是getter方法。

• @ToString 注解在类，添加toString方法。

• @EqualsAndHashCode 注解在类，生成hashCode和equals方法。

• @NoArgsConstructor 注解在类，生成无参的构造方法。

• @RequiredArgsConstructor 注解在类，为类中需要特殊处理的字段生成构造方法，比如final和被@NonNull注解的字段。

• @AllArgsConstructor 注解在类，生成包含类中所有字段的构造方法。

• @Data 注解在类，生成setter/getter、equals、canEqual、hashCode、toString方法，如为final属性，则不会为该属性生成setter方法。

• @Slf4j 注解在类，生成log变量，严格意义来说是常量。private static final Logger log = LoggerFactory.getLogger(UserController.class);

Lombok的优缺点

优点：

1. 能通过注解的形式自动生成构造器、getter/setter、equals、hashcode、toString等方法，提高了一定的开发效率

2. 让代码变得简洁，不用过多的去关注相应的方法

3. 属性做修改时也简化了维护为这些属性所生成的getter/setter方法等

 

缺点：

1. 不支持多种参数构造器的重载

2. 虽然省去了手动创建getter/setter方法的麻烦，但大大降低了源代码的可读性和完整性，降低了阅读源代码的舒适度。

 

参考资料：简单使用lombok