使用 Jackson 进行非对称序列化和反序列化

我正在使用 Jackson 来序列化和反序列化 RESTful API 的数据。我想要一个 REST 资源（/comments），允许发布评论以及获取评论列表。

这是发布内容的（简化的）示例/comments.

{"text":"Text","author":"Paul","email":"[email protected] /cdn-cgi/l/email-protection"}

这是结果GET /comments应该看起来像：

[{"text":"Text","author":"Paul","emailHash":"76w0kjKP9HpsdhBjx895Sg=="}]

由于电子邮件地址不应该对任何人可见，因此我决定在响应中仅返回电子邮件地址的 MD5 哈希值。

我创建了一个简单的 POJO 类Comment具有带有 getter 和 setter 的字段text, author, email, and emailHash.

现在，当我序列化结果时，我得到的结果如下：

[{"text":"Text","author":"Paul","email":null,"emailHash":"76w0kjKP9HpsdhBjx895Sg=="}]

但我真的不喜欢email返回为null这里。它根本不应该被包括在内。

使用注释@JsonIgnore该字段在反序列化时也会忽略它。我是否必须创建两个类CreationComment and ResultComment具有超一流的Comment共享公共字段还是有办法避免创建额外的类？

您根本不必创建 2 个类。使用 Jackson，您可以使用注释在序列化和反序列化期间完全控制属性的行为，@JsonIgnore在 getter 中，您可以防止属性在 Json 响应中序列化并使用@JsonPropertysetter 中的注释将在反序列化期间设置属性。代码如下所示：

import com.fasterxml.jackson.annotation.JsonIgnore;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.databind.ObjectMapper;

public class Comment {

    private String author;

    private String email;

    @JsonIgnore
    public String getEmail() {
        return email;
    }

    @JsonProperty
    public void setEmail(String email) {
        this.email = email;
    }

    public String getAuthor() {
        return author;
    }

    public void setAuthor(String author) {
        this.author = author;
    }

    public static void main(String[] args) {
        ObjectMapper objectMapper = new ObjectMapper();

        Comment comment = new Comment();
        comment.setAuthor("anAuthor");
        comment.setEmail("[email protected] /cdn-cgi/l/email-protection");

        try {
            System.out.println(objectMapper.writeValueAsString(comment));

            String json = "{\"author\":\"anAuthor\",\"email\":\"[email protected] /cdn-cgi/l/email-protection\"}";
            Comment fromJson = objectMapper.readValue(json, Comment.class);

            System.out.println("Result from Json: author= " + fromJson.getAuthor() + ", email= " + fromJson.getEmail());

        } catch (Exception e) {
            e.printStackTrace();
        }

    }
}

运行后的输出main()测试溶液的方法：

{"author":"anAuthor"}

Result from Json: author= anAuthor, email= [email protected] /cdn-cgi/l/email-protection

希望能帮助到你，

何塞·路易斯