如何使用 lombok 使 DTO 中的字段可选？

Question

所以我有一个像这样的 DTO，

@NoArgsConstructor
@AllArgsConstructor
@Getter
@Setter
@Builder
@ToString
@JsonIgnoreProperties(ignoreUnknown=true)
public class PersonDTO {
  private String name;
  private String address;
  private String phone;
  private String other;
}

我将以下有效负载传递给外部 API

{
    "name": "John",
    "phone": "123",
    "address": "abc"
}

这向我抛出了 500 个内部错误：

HttpClientErrorException$NotFound: 404: "{<EOL> "status": "Error", <EOL> "message": "Error validating JSON. Error: - Invalid type Null, expected String."}"

如果我在 DTO 中注释掉other属性，那么我将成功获得 200 响应。 我认为@JsonIgnoreProperties注释应该忽略不存在的属性，但似乎不起作用。

Answer 1

您正在使用 lombok 的@NoArgsConstructor和@AllArgsConstructor 。 所以你必须使用其中一个。 如果您不想要一个全参数构造函数，则必须实现自己的。

@NoArgsConstructor
@Getter
@Setter
@Builder
@ToString
@JsonIgnoreProperties(ignoreUnknown=true)
public class PersonDTO {
  private String name;
  private String address;
  private String phone;
  private String other;

  public PersonDTO(String name, String address, String phone) {
    super(name, address, phone, "");
  }

  public PersonDTO(String name, String address, String phone, String other) {
    this.name = name;
    this.address = address;
    this.phone = phone;
    this.other = other
  }

}

或者，如果您可以控制并且这是一个 Spring Boot 应用程序，您可以尝试在控制器中使用required=false ，这样您就可以继续使用全 arg 构造函数。

public PersonDTO getPerson(
      @PathVariable(value = "name") String name,
      @PathVariable(value = "address") String address
      @PathVariable(value = "phone") String phone
      @PathVariable(value = "other", required = false) String other) { 

 ....

}

Answer 2

该错误表明他们无法将Null解析为String 。 这是一个非常有趣的错误，首先愚弄了我。 您的带有其他字段null的 json 对象可能如下所示：

{
    "name": "John",
    "phone": "123",
    "address": "abc"
}

所以不知何故，这个 API 不能只用引号括住null并告诉你它无法解析它。

因此，我想您需要将other的值设置为空字符串：

@NoArgsConstructor
@AllArgsConstructor
@Getter
@Setter
@Builder
@ToString
@JsonIgnoreProperties(ignoreUnknown=true)
public class PersonDTO {
  private String name;
  private String address;
  private String phone;
  private String other = ""; //empty because external api can't handle null
}

Answer 3

如果属性可以为空，那么您可以使用@JsonInclude(Include.NON_NULL) 。 这将允许在属性中设置空值。 我猜，默认情况下它不允许空值。

Answer 4

正如您在评论中所说，添加@JsonInclude(JsonInclude.Include.NON_NULL)是解决方案。 此注释告诉序列化程序忽略为空的字段。 如果您不添加此内容，则有效负载将如下所示：

{
    "name": "John",
    "phone": "123",
    "address": "abc",
    "other": null
}