忽略基于另一个字段值的序列化字段

时间:2019-03-04 18:31:47

标签: java json serialization jackson

我有一个这样的班级:

public class Profile {
        private String firstName;
        private String lastName;
        private String nickName;
        @JsonIgnore
        private boolean isNameSecret;
}

如果firstName的值为lastName,则序列化对象时可以隐藏属性isNameSecrettrue吗?

2 个答案:

答案 0 :(得分:0)

您需要编写自定义序列化程序并实现该逻辑。可能如下所示:

import com.fasterxml.jackson.core.JsonGenerator;
import com.fasterxml.jackson.databind.JsonSerializer;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.SerializationFeature;
import com.fasterxml.jackson.databind.SerializerProvider;
import com.fasterxml.jackson.databind.annotation.JsonSerialize;

import java.io.IOException;

public class ProfileApp {

    public static void main(String[] args) throws Exception {
        ObjectMapper mapper = new ObjectMapper();
        mapper.enable(SerializationFeature.INDENT_OUTPUT);
        System.out.println(mapper.writeValueAsString(new Profile()));
    }
}

class ProfileJsonSerialize extends JsonSerializer<Profile> {

    @Override
    public void serialize(Profile profile, JsonGenerator gen, SerializerProvider serializers) throws IOException {
        gen.writeStartObject();
        if (!profile.isNameSecret()) {
            gen.writeStringField("firstName", profile.getFirstName());
            gen.writeStringField("lastName", profile.getLastName());
        }
        gen.writeStringField("nickName", profile.getNickName());
        gen.writeEndObject();
    }
}

@JsonSerialize(using = ProfileJsonSerialize.class)
class Profile {

    private String firstName = "Rick";
    private String lastName = "Sanchez";
    private String nickName = "Pickle Rick";
    private boolean isNameSecret = true;

    public String getFirstName() {
        return firstName;
    }

    public void setFirstName(String firstName) {
        this.firstName = firstName;
    }

    public String getLastName() {
        return lastName;
    }

    public void setLastName(String lastName) {
        this.lastName = lastName;
    }

    public String getNickName() {
        return nickName;
    }

    public void setNickName(String nickName) {
        this.nickName = nickName;
    }

    public boolean isNameSecret() {
        return isNameSecret;
    }

    public void setNameSecret(boolean nameSecret) {
        isNameSecret = nameSecret;
    }
}

上面的代码显示:

{
  "nickName" : "Pickle Rick"
}

答案 1 :(得分:0)

这可以使用Jackson的Mixin功能来实现。它允许在运行时应用来自外部类的注释。可以通过指定相同的属性名称来完成匹配(也可以使用诸如getter / setter之类的方法名称)

这里是一个根据问题的示例(为简单起见,将实例变量设置为公共),请注意,mixin类仅包含要覆盖的属性。另外,也不需要初始化。

具有相同属性名称和添加注释的mixin类

public class ProfileIgnoreFirstLastName
{
    @JsonIgnore
    public String firstName;
    @JsonIgnore
    public String lastName;
}

有条件应用mixin类的序列化

public static String serializeProfile(Profile profile) throws IOException {
    ObjectMapper mapper = new ObjectMapper();
    if (profile.isNameSecret) {
        mapper.addMixIn(Profile.class, ProfileIgnoreFirstLastName.class);
    }
    return mapper.writeValueAsString(profile);
}

测试方法

public static void main(String[] args) {
    try {
        Profile profile = new Profile();
        profile.isNameSecret = false;
        System.out.println(serializeProfile(profile));
        profile.isNameSecret = true;
        System.out.println(serializeProfile(profile));
    } catch (Exception e) {
        e.printStackTrace();
    }
}

输出

{"firstName":"my first name","lastName":"my last name","nickName":"my nick name"}
{"nickName":"my nick name"}