如何使 Jackson 在 getters 引发异常时忽略属性

java jackson

2022-09-04 02:23:22

我有很多来自供应商的类，它们喜欢在属性访问上随机抛出运行时异常。

public Object getSomeProperty() {
    if (!someObscureStateCheck()) {
        throw new IllegalStateExcepion();
    }
    return calculateTheValueOfProperty(someRandomState);
}

我无法更改类，无法添加注释，并且为每个类定义mixin是不现实的，因为堆栈的这一部分经常更改。

如果 Jackson 的 getter 抛出异常，如何使 Jackson 忽略该属性？

答案 1

若要在 Jackson 中执行自定义序列化，可以使用 BeanSerializerModifier 注册一个模块，该模块指定需要进行任何修改。在您的例子中，BeanPropertyWriter.serializeAsField 是负责序列化各个字段的方法，因此您应该创建自己的方法来忽略字段序列化的异常，并向使用 changeProperties 将所有默认实例替换为您自己的实现的模块注册。下面的示例演示：BeanPropertyWriterBeanSerializerModifierBeanPropertyWriter

import com.fasterxml.jackson.core.JsonGenerator;
import com.fasterxml.jackson.databind.*;
import com.fasterxml.jackson.databind.module.SimpleModule;
import com.fasterxml.jackson.databind.ser.*;

import java.io.IOException;
import java.util.List;
import java.util.stream.Collectors;

public class JacksonIgnorePropertySerializationExceptions {

    public static void main(String[] args) throws IOException {
        ObjectMapper mapper = new ObjectMapper();
        mapper.registerModule(new SimpleModule().setSerializerModifier(new BeanSerializerModifier() {
            @Override
            public List<BeanPropertyWriter> changeProperties(SerializationConfig config, BeanDescription beanDesc, List<BeanPropertyWriter> beanProperties) {
                return beanProperties.stream().map(bpw -> new BeanPropertyWriter(bpw) {
                    @Override
                    public void serializeAsField(Object bean, JsonGenerator gen, SerializerProvider prov) throws Exception {
                        try {
                            super.serializeAsField(bean, gen, prov);
                        } catch (Exception e) {
                            System.out.println(String.format("ignoring %s for field '%s' of %s instance", e.getClass().getName(), this.getName(), bean.getClass().getName()));
                        }
                    }
                }).collect(Collectors.toList());
            }
        }));

        mapper.writeValue(System.out, new VendorClass());
    }

    public static class VendorClass {
        public String getNormalProperty() {
            return "this is a normal getter";
        }

        public Object getProblematicProperty() {
            throw new IllegalStateException("this getter throws an exception");
        }

        public String getAnotherNormalProperty() {
            return "this is a another normal getter";
        }
    }
}

上面的代码使用 Jackson 2.7.1 和 Java 1.8 输出以下内容：

ignoring java.lang.reflect.InvocationTargetException for field 'problematicProperty' of JacksonIgnorePropertySerializationExceptions$VendorClass instance
{"normalProperty":"this is a normal getter","anotherNormalProperty":"this is a another normal getter"}

显示，其中抛出一个，将从序列化值中省略。getProblematicPropertyIllegalStateException

答案 2