带有Jackson的不可变Lombok注释类

Question

创建类的首选方法是什么

• 不可变
• 可以使用Jackson进行序列化/反序列化
• 可读性强，样板文件水平低

最好是，我希望这样的东西能起作用：

@Data(onConstructor = @__(@JsonCreator))

然后将所有字段设置为private final。然而，这甚至不能编译（我不知道为什么）。使用

@AllArgsConstructor(onConstructor = @__(@JsonCreator))

将编译，但仅生成

InvalidDefinitionException: No serializer found for class

Answer 1

您可以使用Lombok的@Builder注释为您的不可变POJO类生成构建器。但是让Jackson的反序列化可以使用Lombok生成的构建器有些棘手。

• 您需要用@JsonDeserialize（builder=…）注释POJO类，以告诉Jackson要使用哪一个构建器类
• 您需要用@JsonPOJOBuilder（withPrefix=“”）注释构建器类，以告诉Jackson其setter方法不是以开头

例：

不可变的POJO类:

@Data
@Builder(builderClassName = "PointBuilder")
@JsonDeserialize(builder = Point.PointBuilder.class)
public class Point {

    private final int x;

    private final int y;

    @JsonPOJOBuilder(withPrefix = "")
    public static class PointBuilder {
        // Lombok will add constructor, setters, build method
    }
}

这是一个JUnit测试来验证序列化/反序列化：

public class PointTest extends Assert {

    private ObjectMapper objectMapper = new ObjectMapper();

    @Test
    public void testSerialize() throws IOException {
        Point point = new Point(10, 20);
        String json = objectMapper.writeValueAsString(point);
        assertEquals("{\"x\":10,\"y\":20}", json);
    }

    @Test
    public void testDeserialize() throws IOException {
        String json = "{\"x\":10,\"y\":20}";
        Point point = objectMapper.readValue(json, Point.class);
        assertEquals(new Point(10, 20), point);
    }
}

Answer 2

截至2020年10月15日(Lombok v1.18.16)，您应该能够简单地使用< code>@Jacksonized注释。

@Jacksonized @Builder
@JsonIgnoreProperties(ignoreUnknown = true)
public class JacksonExample {
  private List<Foo> foos;
}

如链接文档中所述，此注释:

• 将杰克逊配置为使用生成器进行反序列化，
• 将特定于字段的配置从带注释的类向下复制到生成的构建器（例如@JsonIgnoreProperties），以及
• 将构建器方法（例如，构建器（）.with字段（字段）与构建器字段（字段）中使用的杰克逊前缀与龙目岛中配置的前缀对齐。

Answer 3

添加构造函数属性：

• 在适当的位置创建一个龙目岛配置文件，其行为：龙目岛.any结构商.add结构商属性 = true
• 将龙目岛@Value注释添加到类中以使其不可变

然后，Jackson的序列化和反序列化工作正常。

此方法：

< li >符合标准 < li >与上一个顶级答案相比，样板内容较少 < li >适用于v 1 . 16 . 20(2018年1月9日)及更高版本

编辑：2020-08-16

< li >注意:将< code>@Builder与< code>@Value一起使用会导致此解决方案失败。(感谢下面@guilherme-blanco的评论。)但是，如果您还添加了例如< code>@AllArgsConstructor，它仍然会按预期工作。

编辑： 2021-08-19

< li >注意:当您添加或更改< code>lombok.config文件时，更改不会生效，除非您执行重建(先清理后构建)。我已经被这个抓了好几次了。 < li> @Jacksonized批注解决方案是为批注的特定类实现所需结果的另一种方法。然而，我个人倾向于不需要记住注释每个用于反序列化的类。使用< code>lombok.config可以消除这种开销。