如何在API响应中排除属性，却保留其JsonSerialize序列化能力？

不用创建新类，直接借助序列化框架的特性就能解决不同场景下的属性序列化差异问题，以下是几种实用方案：

1. 用Jackson的JsonView实现视图级别的序列化控制 #

这是最常用的方案，通过定义不同视图类标记属性的序列化范围：

• 先定义两个空的视图内部类，无需编写逻辑：

public class SerializationViews {
    // API响应使用的视图，仅包含公开属性
    public static class Public {}
    // 后端存储使用的视图，包含所有属性（继承Public避免重复标记公开属性）
    public static class Internal extends Public {}
}

• 在实体类属性上标记对应视图：

public class User {
    @JsonView(SerializationViews.Public.class)
    private String username;
    
    // 仅后端存储需要序列化，API响应不返回
    @JsonView(SerializationViews.Internal.class)
    private String encryptedPassword;
    
    @JsonView(SerializationViews.Public.class)
    private String email;
}

• 场景适配：
  • API接口：在Controller方法上添加@JsonView(SerializationViews.Public.class)，返回时自动只序列化标记Public视图的属性；
  • 后端存储：序列化时指定Internal视图，即可包含所有属性：

ObjectMapper objectMapper = new ObjectMapper();
String storageJson = objectMapper.writerWithView(SerializationViews.Internal.class)
                                .writeValueAsString(user);

2. 用Jackson的JsonFilter实现动态属性过滤 #

如果需要更灵活的动态排除（比如不同API接口排除不同属性），可以用JsonFilter：

• 在实体类上标记过滤器名称：

@JsonFilter("dynamicPropertyFilter")
public class User {
    private String username;
    private String encryptedPassword;
    private String email;
    private String internalRemark;
}

• 场景适配：
  • API响应时，指定要排除的属性：

ObjectMapper objectMapper = new ObjectMapper();
FilterProvider filterProvider = new SimpleFilterProvider()
    .addFilter("dynamicPropertyFilter", 
        SimpleBeanPropertyFilter.serializeAllExcept("encryptedPassword", "internalRemark"));
String apiJson = objectMapper.writer(filterProvider).writeValueAsString(user);

• 后端存储时，直接使用默认序列化逻辑，不设置过滤器即可包含所有属性：

String storageJson = objectMapper.writeValueAsString(user);

Spring环境下还可以通过配置全局ObjectMapper或AOP统一处理API接口的过滤规则，减少重复代码。

3. 注解组合实现简单场景控制 #

如果某个属性仅在API响应时需要忽略、存储时必须序列化，可结合@JsonIgnore和@JsonProperty的访问控制：

public class User {
    private String username;
    
    // API响应忽略该属性，但后端存储序列化时仍会包含
    @JsonIgnore
    @JsonProperty(access = JsonProperty.Access.READ_WRITE)
    private String encryptedPassword;
}

该方案灵活性不如前两种，适合属性规则固定的简单场景。

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