如何在RESTful WS中按条件隐藏字段？Report类多版本输出

这问题我之前帮不少开发者捋过思路——核心就是要在不干扰Report类其他业务场景的前提下，给REST接口输出做差异化的字段过滤对吧？给你几个实用的方案，按需pick就行：

这是最稳妥、最常用的方案，核心思路是把业务实体和接口输出模型完全分离。你不用修改原有的Report类，只需要创建两个专门用于输出的DTO类：

• FullReportDTO：包含Report的所有属性，对应完整版本输出
• LiteReportDTO：只保留核心属性，对应精简版本输出

举个代码示例：

// 原Report实体类，保持原样，完全不受REST输出逻辑影响
public class Report {
    private Long id;
    private String coreField1;
    private String coreField2;
    private String detailField1;
    private String detailField2;
    
    // 标准的getter、setter，其他业务场景该怎么用怎么用
}

// 精简版输出DTO
public class LiteReportDTO {
    private Long id;
    private String coreField1;
    private String coreField2;

    // 从Report实体转换的构造器
    public LiteReportDTO(Report report) {
        this.id = report.getId();
        this.coreField1 = report.getCoreField1();
        this.coreField2 = report.getCoreField2();
    }
}

// 完整版输出DTO
public class FullReportDTO {
    private Long id;
    private String coreField1;
    private String coreField2;
    private String detailField1;
    private String detailField2;

    public FullReportDTO(Report report) {
        this.id = report.getId();
        this.coreField1 = report.getCoreField1();
        this.coreField2 = report.getCoreField2();
        this.detailField1 = report.getDetailField1();
        this.detailField2 = report.getDetailField2();
    }
}

然后在REST接口里返回对应的DTO即可：

@GetMapping("/reports/{id}/full")
public FullReportDTO getFullReport(@PathVariable Long id) {
    Report report = reportService.getById(id);
    return new FullReportDTO(report);
}

@GetMapping("/reports/{id}/lite")
public LiteReportDTO getLiteReport(@PathVariable Long id) {
    Report report = reportService.getById(id);
    return new LiteReportDTO(report);
}

这个方案的优势是类型安全、完全解耦，原Report类的任何业务使用场景都不会受影响；缺点是需要额外维护DTO类，如果实体字段更新，要同步调整DTO。

如果你的REST框架用的是Jackson（比如Spring Boot默认），可以用@JsonView注解实现条件序列化，不用额外创建DTO。

第一步，先定义两个视图接口，标记不同的输出级别：

public class ReportViews {
    // 精简视图：核心字段
    public interface Lite {}
    // 完整视图：继承精简视图，包含所有字段
    public interface Full extends Lite {}
}

然后在Report实体的字段上标注对应的视图：

public class Report {
    @JsonView(ReportViews.Lite.class)
    private Long id;
    
    @JsonView(ReportViews.Lite.class)
    private String coreField1;
    
    @JsonView(ReportViews.Lite.class)
    private String coreField2;
    
    @JsonView(ReportViews.Full.class)
    private String detailField1;
    
    @JsonView(ReportViews.Full.class)
    private String detailField2;
    
    // getter、setter不变
}

最后在REST接口方法上指定要使用的视图：

@GetMapping("/reports/{id}/full")
@JsonView(ReportViews.Full.class)
public Report getFullReport(@PathVariable Long id) {
    return reportService.getById(id);
}

@GetMapping("/reports/{id}/lite")
@JsonView(ReportViews.Lite.class)
public Report getLiteReport(@PathVariable Long id) {
    return reportService.getById(id);
}

这个方案的好处是不用维护额外的类，代码更简洁；唯一需要注意的是，如果其他业务场景需要序列化Report的所有字段，只要在对应的序列化逻辑中指定ReportViews.Full视图即可，不会影响原有功能。

如果需要更动态的控制（比如根据请求参数决定返回哪些字段），可以用Jackson的FilterProvider结合Spring的MappingJacksonValue实现：

首先在Report类上标注一个过滤器名称：

@JsonFilter("reportFilter")
public class Report {
    // 字段、getter、setter不变
}

然后在REST接口里根据请求参数动态设置过滤规则：

@GetMapping("/reports/{id}")
public MappingJacksonValue getReport(@PathVariable Long id, 
                                     @RequestParam(required = false, defaultValue = "full") String mode) {
    Report report = reportService.getById(id);
    MappingJacksonValue mappingJacksonValue = new MappingJacksonValue(report);
    SimpleFilterProvider filterProvider = new SimpleFilterProvider();

    if ("lite".equals(mode)) {
        // 只保留核心字段
        filterProvider.addFilter("reportFilter", 
            SimpleBeanPropertyFilter.filterOutAllExcept("id", "coreField1", "coreField2"));
    } else {
        // 序列化所有字段
        filterProvider.addFilter("reportFilter", 
            SimpleBeanPropertyFilter.serializeAllExcept());
    }

    mappingJacksonValue.setFilters(filterProvider);
    return mappingJacksonValue;
}

这个方案灵活性拉满，甚至可以让前端指定要返回的字段列表，但代码相对复杂一点，适合有特殊定制需求的场景。

• 优先推荐DTO方案：最稳妥，完全解耦，不会给后续维护埋坑
• 如果不想写DTO，选Jackson视图注解：代码简洁，适合大多数JSON序列化的REST场景
• 动态过滤适合需要灵活定制输出的特殊场景

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