为什么在使用Lombok@数据时，我的基于字段的Jackson混音会中断？

Question

我有一个同时使用Jackson和Lombok的项目。它正在使用两者的当前最新版本（Jackson 2.12.2

import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.json.JsonMapper;

public class IssueDemonstration {
    public static void main(String[] args) throws JsonProcessingException {
        JsonMapper jsonMapper = JsonMapper.builder().build();
        JsonMapper mixinMapper = JsonMapper.builder()
                .addMixIn(Example.class, ExampleMixin.class).build();

        String json = "{\"value\": \"Some Value\"}";
        System.out.println(
                "Default: " + jsonMapper.readValue(json, Example.class).getValue());
        System.out.println(
                "Mixin: " + mixinMapper.readValue(json, Example.class).getValue());
    }

    private static class Example {
        @JsonProperty(access = JsonProperty.Access.READ_ONLY)
        private String value;

        public String getValue() {
            return value;
        }

        public void setValue(String value) {
            this.value = value;
        }
    }

    private abstract static class ExampleMixin {
        @JsonProperty(access = JsonProperty.Access.READ_WRITE)
        private String value;
    }
}

上述代码给出了预期结果：

Default: null
Mixin: Some Value

但是，如果我更改示例以使用Lombok的@Data自动生成getter

@Data
private static class Example {
    @JsonProperty(access = JsonProperty.Access.READ_ONLY)
    private String value;
}

输出：

Default: null
Mixin: null

当我切换到使用数据时，为什么这不起作用？我在Jackson的数据或Getter和Setter文档中没有看到任何东西表明这应该以这种方式进行。

Answer 1

Lombok@Data等效于@Getter@Setter@必需ArgsConstructor@ToString@EqualsAndHashCode。

默认构造函数没有参数，lombok@Data有参数。您需要添加@noargsconstuctor。

    @Data
    @NoArgsConstructor
    private static class Example {
        @JsonProperty(access = JsonProperty.Access.READ_ONLY)
        private String value;
    }

    @Data
    @NoArgsConstructor
    private abstract static class ExampleMixin {
        @JsonProperty(access = JsonProperty.Access.READ_WRITE)
        private String value;
    }

Answer 2

问题是Lombok正在将Jackson@JsonProperty注释复制到生成的setter。在Jackson中，访问器方法上的注释优先于字段上的相同注释。因此，示例类中getValue（）方法上的注释正在覆盖的value字段上的注释。

这可以通过多种方式修复。可以手动或使用@Setter注释混音字段来更改混音以具有Jackson注释的setter（从而触发Lombok setter的覆盖）：

private interface ExampleMixin {
    @JsonProperty(access = JsonProperty.Access.READ_WRITE)
    void setValue(String value);
}

private abstract static class ExampleMixin {
    @Setter
    @JsonProperty(access = JsonProperty.Access.READ_WRITE)
    private String value;
}

或者，可以将反序列化类更改为除了带注释的字段之外还为其创建了一个未注释的手动设置器，从而防止Lombok创建带注释的设置器：

@Data
private static class Example {
    @JsonProperty(access = JsonProperty.Access.READ_ONLY)
    private String value;

    public void setValue(String value) {
        this.value = value;
    }
}

整个情况的一个棘手之处是，将Jackson注释复制到setter的事实在Lombok中没有记录。留档提到可空性注释被复制，但没有提到复制的Jackson注释：

龙目岛。copyableAnnotations=[完全限定类型的列表]（默认值：空列表）Lombok将把这些注释中的任何一个从字段复制到setter参数和getter方法。请注意，lombok附带了一组“开箱即用”的注释，这些注释都是可复制的：所有流行的可空/非空注释。

关于可空性的各种著名注释，如org。日食jdt。注释。非null会自动复制到正确的位置（getters的方法，setters的参数）。您可以指定应始终通过lombok配置键复制的其他注释。可复制批注。

然而，查看Lombok源代码会发现复制的Jackson注释：

COPY_TO_SETTER_ANNOTATIONS = Collections.unmodifiableList(Arrays.asList(new String[] {
    "com.fasterxml.jackson.annotation.JacksonInject",
    "com.fasterxml.jackson.annotation.JsonAlias",
    "com.fasterxml.jackson.annotation.JsonFormat",
    "com.fasterxml.jackson.annotation.JsonIgnore",
    "com.fasterxml.jackson.annotation.JsonIgnoreProperties",
    "com.fasterxml.jackson.annotation.JsonProperty",
    "com.fasterxml.jackson.annotation.JsonSetter",
    "com.fasterxml.jackson.annotation.JsonSubTypes",
    "com.fasterxml.jackson.annotation.JsonTypeInfo",
    "com.fasterxml.jackson.annotation.JsonView",
    "com.fasterxml.jackson.databind.annotation.JsonDeserialize",
    "com.fasterxml.jackson.dataformat.xml.annotation.JacksonXmlProperty",
}));

mixin现场问题，包括缺乏文档，在Lombok问题跟踪程序中被捕获为问题#2769。