在 Java 中序列化选择性类变量

Question

我需要根据条件序列化一些字段。

例如，我有以下课程。

public class ClassExample
{
  private String id;
  private String type;
  private String string_1;
  private String string_2;
}

因此，假设 type 可以接收两个值，'type_1' 或 'type_2' 并且 string_1 和 string_2 将始终为 null（它们将被另一个应用程序更改）。

我想用 Jackson 序列化它，我想：

1) 如果是type_1，则string_1会出现在JSON中，而string_2不会出现。

2) 如果是type_2，则string_2 会出现在JSON 中，而string_1 不会出现。

有没有办法做到这一点？

提前致谢

Answer 1

一个字段依赖于另一个字段的可空性可能表明您应该将您的类分成 2 个。您可以将这个类替换为 2 个类，而不是一个具有 2 个可能值的类，而其中没有任何类型字段。 因此不需要自定义序列化程序。

Answer 2

据我了解，您希望序列化符合条件的类字段。 有多种方法可以解决这个问题，因为您想要不使用自定义序列化程序的解决方案，这里有一个解决方案：-

该方案基于Jackson的FilterProvider。

建议：-

1. 使用自定义序列化器，如果您有非常严格的限制，请使用提到的解决方案
2. 请将类型设为 Enum，并根据类型操作相应地进行不同的实现。

如果您能详细说明您的用例，我可以推荐一个更好的解决方案。

解决方案：-

import com.fasterxml.jackson.annotation.JsonFilter;
import com.fasterxml.jackson.core.JsonGenerator;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.SerializerProvider;
import com.fasterxml.jackson.databind.ser.BeanPropertyWriter;
import com.fasterxml.jackson.databind.ser.FilterProvider;
import com.fasterxml.jackson.databind.ser.PropertyFilter;
import com.fasterxml.jackson.databind.ser.PropertyWriter;
import com.fasterxml.jackson.databind.ser.impl.SimpleBeanPropertyFilter;
import com.fasterxml.jackson.databind.ser.impl.SimpleFilterProvider;
import lombok.AllArgsConstructor;
import lombok.Getter;
import lombok.Setter;
import lombok.extern.slf4j.Slf4j;

@Getter
@Setter
@Slf4j
@AllArgsConstructor
@JsonFilter("myFilter")
public class ClassExample {
    private String id;
    private String type;
    private String string_1;
    private String string_2;
    private static final ObjectMapper om = new ObjectMapper();
    private static final PropertyFilter theFilter = new SimpleBeanPropertyFilter() {
        @Override
        public void serializeAsField(Object pojo, JsonGenerator jgen,
                                     SerializerProvider provider, PropertyWriter writer)
                throws Exception {
            if (include(writer)) {
                if (!(writer.getName().equals("string_1") || writer.getName().equals("string_2"))) {
                    writer.serializeAsField(pojo, jgen, provider);
                    return;
                }

                String type = ((ClassExample) pojo).getType();
                if ("type_1".equals(type) && (writer.getName().equals("string_1"))) {
                    writer.serializeAsField(pojo, jgen, provider);
                } else if ("type_2".equals(type) && (writer.getName().equals("string_2"))) {
                    writer.serializeAsField(pojo, jgen, provider);
                }

            } else if (!jgen.canOmitFields()) { // since 2.3
                writer.serializeAsOmittedField(pojo, jgen, provider);
            }
        }

        @Override
        protected boolean include(BeanPropertyWriter writer) {
            return true;
        }

        @Override
        protected boolean include(PropertyWriter writer) {
            return true;
        }
    };

    public String toString() {
        try {

            FilterProvider filters = new SimpleFilterProvider().addFilter("myFilter", theFilter);
            return om.writer(filters).writeValueAsString(this);
        } catch (Exception e) {
            log.error("error while serialisation", e);
            return "";
        }
    }

    public static void main(String[] args) {
        System.out.println(new ClassExample("123", "type_1", "1", "2"));
    }
}

输出：

If type is type_1 then {"id":"123","type":"type_1","string_1":"1"}
If type if type_2 then {"id":"123","type":"type_2","string_2":"2"}