在SpringBoot中使用lombok的注意事项

Z时代
2024-01-10
分类：IT

Lombok需求

在传统的开发过程中，一个javabean开发非常琐碎和麻烦，如下：


package com.example.entity;
public class User {
    // 用户编号
    private Integer id;
    // 用户昵称
    private String nickname;
    // 用户密码
    private String password;
    // 用户头像
    private String avatar;
    // 用户地址
    private String adddress;
    public User() {
    }
    public User(Integer id, String nickname, String password, String avatar, String adddress) {
        this.id = id;
        this.nickname = nickname;
        this.password = password;
        this.avatar = avatar;
        this.adddress = adddress;
    }
    @Override
    public String toString() {
        return "User{" +
                "id=" + id +
                ", nickname='" + nickname + '\'' +
                ", password='" + password + '\'' +
                ", avatar='" + avatar + '\'' +
                ", adddress='" + adddress + '\'' +
                '}';
    }
    public Integer getId() {
        return id;
    }
    public void setId(Integer id) {
        this.id = id;
    }
    public String getNickname() {
        return nickname;
    }
    public void setNickname(String nickname) {
        this.nickname = nickname;
    }
    public String getPassword() {
        return password;
    }
    public void setPassword(String password) {
        this.password = password;
    }
    public String getAvatar() {
        return avatar;
    }
    public void setAvatar(String avatar) {
        this.avatar = avatar;
    }
    public String getAdddress() {
        return adddress;
    }
    public void setAdddress(String adddress) {
        this.adddress = adddress;
    }
}

你要生成

getter/setter

无参构造函数

有参构造函数

toString

hashcode

等等。

在开发中有一个利器：Lombok 可以解决和优化这个问题。

Lombok的使用

编写pojo时，经常需要编写构造函数和gettersetter方法，属性多的时候，非常浪费时间，使用lombok插件可以解决这个问题

开发工具无论是idea还是eclipse都必须要安装插件

以idea为例如下：

在这里插入图片描述

在项目中依赖Lombok如下


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

简化javabean


package com.example.entity;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
import lombok.ToString;
@Data // getter/setter
@ToString // toString
@AllArgsConstructor // 有参构造函数
@NoArgsConstructor // 无参构造函数
public class User {
    // 用户编号
    private Integer id;
    // 用户昵称
    private String nickname;
    // 用户密码
    private String password;
    // 用户头像
    private String avatar;
    // 用户地址
    private String adddress;    
}

证明lombok在编译以后会自动生成

在这里插入图片描述

Lombok其他的注解

@Data：自动提供getter和setter、hashCode、equals、toString等方法

@Getter：自动提供getter方法

@Setter：自动提供setter方法

@ToString：生成toString方法

@NoArgsConstructor：自动生成无参数构造函数

@AllArgsConstructor：自动生成全参数构造函数

@Builder：可以实现属性连续赋值

@Accessors @Accessors批注用于配置lombok如何生成和查找getter和setter。标注到类上，chain属性设置为true时，类的所有属性的setter方法返回值将为this，用来支持setter方法的链式写法

@Slf4j and @Log4j：自动在bean中提供log变量，在需要打印日志的类中使用，项目中使用slf4j、log4j日志框架

@NonNull：这个注解可以用在成员方法或者构造方法的参数前面，会自动产生一个关于此参数的非空检查，如果参数为空，则抛出一个空指针异常。

@Cleanup：注解用于确保已分配的资源被释放（IO的连接关闭）。

@Synchronized：注解自动添加到同步机制，生成的代码并不是直接锁方法,而是锁代码块，作用范围是方法上。ull ：这个注解可以用在成员方法或者构造方法的参数前面，会自动产生一个关于此参数的非空检查，如果参数为空，则抛出一个空指针异常。

@Cleanup：注解用于确保已分配的资源被释放（IO的连接关闭）。

@Synchronized：注解自动添加到同步机制，生成的代码并不是直接锁方法,而是锁代码块，作用范围是方法上。

@Value注解和@Data类似，区别在于它会把所有成员变量默认定义为private final修饰，并且不会生成set方法。

lombok插件使用和lombok不起作用的解决

idea安装插件

在这里插入图片描述

引入依赖


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

实体类中使用@Data


@Data
public class Employee {
    private Integer id; // id
    private String lastName; // 名字
    private String email; // 邮箱
    private Integer gender; // 性别 1男 0女
    private Integer dId; // 部门id
    }