Springboot中使用lombok的@Data注解方式

下面是Springboot中使用lombok的@Data注解方式的完整攻略。

什么是Lombok

Lombok是一种能够通过注解生成代码的工具，可以通过少量的注释简化Java类的定义。

在Springboot中，Lombok可以简化一个类中的getter和setter的定义，使得代码更加简洁易读。

在Springboot中使用Lombok的@Data注解

在Springboot中使用Lombok的@Data注解，需要在pom.xml文件中添加lombok依赖：

<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
    <optional>true</optional>
</dependency>

接下来，只需要在Java类上使用@Data注解即可自动生成getter和setter方法，比如：

import lombok.Data;

@Data
public class User {
    private Long id;
    private String name;
    private String email;
}

上述代码使用了@Data注解，自动生成了id、name和email的getter和setter方法。

示例1：使用@Data注解生成NoArgsConstructor和AllArgsConstructor构造方法

除了getter和setter方法之外，Lombok还可以为类生成NoArgsConstructor和AllArgsConstructor构造方法。

@NoArgsConstructor构造方法表示无参构造方法，使用该注解时，自动生成类似于以下代码的构造方法：

public User() {
}

@AllArgsConstructor构造方法表示有参构造方法，使用该注解时，自动生成类似于以下代码的构造方法：

public User(Long id, String name, String email) {
    this.id = id;
    this.name = name;
    this.email = email;
}

例如，在一个DTO对象中，我们希望生成一个无参构造方法和一个包含所有字段的构造方法，可以使用如下代码：

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

@Data
@AllArgsConstructor
@NoArgsConstructor
public class UserDTO {
    private Long id;
    private String name;
    private String email;
}

上述代码使用了@Data、@AllArgsConstructor和@NoArgsConstructor注解，自动生成了getter、setter、无参构造方法和有参构造方法。

示例2：使用@Data注解生成toString方法

Lombok还可以为类自动生成toString方法。

在生成toString方法时，可以使用注解的exclude参数来排除某些字段不展示，也可以使用of属性指定只展示哪些字段。

例如，在一个实体类中，我们希望生成toString方法并排除一些敏感信息字段，可以使用如下代码：

import lombok.Data;
import lombok.ToString;

@Data
@ToString(exclude = {"password", "creditCardNumber"})
public class User {
    private Long id;
    private String name;
    private String email;
    private String password;
    private String creditCardNumber;
}

上述代码使用了@Data和@ToString注解，排除了password和creditCardNumber字段在生成的toString方法中展示。

总结

Springboot中使用Lombok的@Data注解可以简化代码，让代码更加易读。

除了生成getter和setter方法之外，Lombok还可以为类生成构造方法和toString方法等。

在代码中使用Lombok时，需要在pom.xml中添加lombok依赖，并在需要使用注解的类上添加相应的注解即可。