Jackson JsonView未指定时如何忽略带注解属性？

针对你遇到的「未指定JsonView时，带@JsonView注解的属性被全部序列化」的问题，这里提供两种符合需求的解决方案：一种是默认忽略带注解的属性，另一种是强制必须指定视图否则报错。

方案一：未指定视图时忽略所有带@JsonView注解的属性 #

Jackson默认规则是：未指定视图时会序列化所有属性，包括带@JsonView的。我们可以通过全局配置反转这个行为，让未指定视图时只序列化不带@JsonView的属性。

代码示例 #

先贴出你的基础代码（视图类和实体类）：

// 视图定义类
public class JsonViews {
    public static class Public {}
    public static class Admin extends Public {}
}

// 实体类
public class MyPojo {
    private String normalField; // 不带@JsonView

    @JsonView(JsonViews.Public.class)
    private String publicField;

    @JsonView(JsonViews.Admin.class)
    private String adminField;

    // 省略getter、setter、构造方法
}

配置自定义ObjectMapper：

ObjectMapper objectMapper = new ObjectMapper();
// 关闭默认视图包含：未指定视图时，忽略所有带@JsonView的属性
objectMapper.disable(MapperFeature.DEFAULT_VIEW_INCLUSION);

验证效果 #

• 无视图序列化：仅输出normalField，带@JsonView的属性被忽略
• 指定JsonViews.Public视图：输出normalField + publicField
• 指定JsonViews.Admin视图：输出normalField + publicField + adminField

方案二：强制必须指定视图，否则序列化抛出异常 #

如果需要更严格的控制——不允许无视图的序列化操作，可以通过自定义属性写入器来拦截并抛出异常。

代码示例 #

先自定义属性写入器修饰器：

public class ViewRequiredBeanPropertyWriterModifier extends BeanPropertyWriterModifier {
    @Override
    public List<BeanPropertyWriter> changeProperties(SerializationConfig config, BeanDescription beanDesc, List<BeanPropertyWriter> beanProperties) {
        // 检查当前是否指定了视图
        boolean hasActiveView = config.getActiveView() != null;
        for (BeanPropertyWriter writer : beanProperties) {
            JsonView jsonView = writer.getAnnotation(JsonView.class);
            // 若属性带@JsonView且未指定视图，替换为抛出异常的写入器
            if (jsonView != null && !hasActiveView) {
                int index = beanProperties.indexOf(writer);
                beanProperties.set(index, new BeanPropertyWriter(writer) {
                    @Override
                    public void serializeAsField(Object bean, JsonGenerator gen, SerializerProvider prov) throws Exception {
                        throw new IllegalStateException("必须指定JsonView才能序列化属性: " + this.getName());
                    }
                });
            }
        }
        return beanProperties;
    }
}

注册到ObjectMapper：

ObjectMapper objectMapper = new ObjectMapper();
// 注册自定义修饰器
objectMapper.setSerializerFactory(
    objectMapper.getSerializerFactory()
        .withSerializerModifier(new ViewRequiredBeanPropertyWriterModifier())
);

验证效果 #

• 无视图序列化：直接抛出IllegalStateException，提示必须指定视图
• 指定任意视图：正常序列化对应属性

注意事项 #

• 方案一的DEFAULT_VIEW_INCLUSION是全局配置，会影响该ObjectMapper所有序列化操作
• 方案二可根据需求调整：比如只针对特定实体类生效（可在changeProperties中判断beanDesc的类型），或者替换异常为自定义提示

内容的提问来源于stack exchange，提问作者Abned