在 Java DTO 类上使用数据注释

Question

我对使用数据注释到DTO类感到困惑。这是我的示例类。

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

我在网上读到，特别是在DTO类上使用数据注释将允许通过使用生成的设置器来更改字段的值。

我应该删除lombok Data注释吗？并手动实现getter和setter。

谢谢:)

Answer 1

DTO是用来传输数据信息，有些信息其实就是我们不希望用户能够更改或访问，比如用户密码，我们不想在用户看到加密密码的时候传递给前端，或者我们不希望用户在修改密码的同时改变自己的信息， 在此序列化过程中起作用的是 setter 和 getter，以及为所有字段自动生成 getter 和 setter 的数据注释。

比如说

@Data
class User{

private String userName;

private String pwd;
}

这个类将拥有所有的setter和getter。当你转到网上，你会看到

{userName: "123", pwd: "xxx"}

这太可怕了。但是如果你用DTO

class User{

private String userName;

private String pwd;

public String getUserName(){
    return userName;
}
}

他们只看到

{userName: "123"}

Answer 2

注释@Data来自Lombok项目，该项目主要通过注释使用反射。该注释确保生成所有setter、getter、具有所有必需参数的构造函数，并覆盖Object::toString、Object::equals和Object::hashCode方法。

简而言之，这个注释“完成”了一个简单的POJO对象，并生成了所有样板文件，而无需使用IDE。

他们将注释命名为@Data，因为它们支持仅将理解对象作为数据容器的想法。

据我所知，生成只针对缺少的getter/setter（为了简洁起见，让我们谈谈它们）。如您所知，生成的getter/setter是纯格式的：

public int getId() { return this.id; }

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

您可以使用更详细的setter/getter执行验证或任何类似的东西来覆盖生成的验证。您可以使用@Data注释并手动编写您的注释。

Answer 3

我会避免使用DTO的@Data，因为它有太多陷阱。首先，正如您所提到的，它是可变的，而您并不真正需要DTO。尽管它是可变的，但它实现了equals（）和hashCode（），这只会带来麻烦。

您可以将@Value用于不可变DTO。对于传入的DTO，您可能需要将lombok.anyConstructor.addConstructorProperties添加到您的lombok.config，这将允许jackson等库在没有默认构造函数的情况下反序列化到您的POJO。