Spring Boot 如何为不同接口端点定制返回字段并隐藏指定数据
同实体不同接口返回差异化字段的实现方案
该需求具备成熟的技术实现路径,生产环境中常用的落地方案有三种,可根据项目的架构规范选择:
方案一:使用Jackson原生@JsonView注解实现
这是同实体多序列化粒度场景下的最适配方案,不需要重复编写冗余的返回类,操作步骤如下:
- 定义标记不同序列化粒度的视图接口,仅作为标识使用,不需要实现任何逻辑:
public class SerializeViews { // 基础视图:定义两个接口都需要返回的字段范围 public static class BasicView {} // 全量视图:继承基础视图,额外扩展仅全量接口需要返回的字段 public static class FullView extends BasicView {} } - 在业务模型的字段上标注对应的视图范围,假设3个字段中需要在/e2接口隐藏
field3:public class DemoModel { // 两个接口都需要返回的字段 @JsonView(SerializeViews.BasicView.class) private String field1; @JsonView(SerializeViews.BasicView.class) private String field2; // 仅/e1接口需要返回的字段 @JsonView(SerializeViews.FullView.class) private String field3; // 省略构造方法、getter/setter } - 在控制器的接口上指定对应的序列化视图:
@RestController public class DemoController { // /e1接口使用全量视图,会返回所有标注了基础视图、全量视图的字段,即3个字段全量返回 @GetMapping("/e1") @JsonView(SerializeViews.FullView.class) public DemoModel getFullModel() { return demoService.getModel(); } // /e2接口使用基础视图,只会返回标注了基础视图的字段,自动隐藏field3 @GetMapping("/e2") @JsonView(SerializeViews.BasicView.class) public DemoModel getLimitedModel() { return demoService.getModel(); } }
方案二:针对不同接口定义独立返回DTO
这是架构管控最严格的通用方案,完全解耦数据库实体和接口返回结构,从根源上避免内部字段意外泄露,操作步骤如下:
- 针对两个接口的返回要求分别定义独立的返回类:
// /e1接口使用的全量返回DTO public record FullModelDto(String field1, String field2, String field3) {} // /e2接口使用的精简返回DTO public record LimitedModelDto(String field1, String field2) {} - 在控制器中将查询到的业务实体属性拷贝到对应DTO后返回:
这种方案不受序列化框架限制,哪怕后续更换JSON处理工具也不会影响接口结构,适合对接口契约稳定性要求高的项目。@RestController public class DemoController { @GetMapping("/e1") public FullModelDto getFullModel() { DemoModel model = demoService.getModel(); return new FullModelDto(model.getField1(), model.getField2(), model.getField3()); } @GetMapping("/e2") public LimitedModelDto getLimitedModel() { DemoModel model = demoService.getModel(); return new LimitedModelDto(model.getField1(), model.getField2()); } }
方案三:使用Jackson动态字段过滤器实现
如果不想改动现有实体结构,可以通过Jackson的过滤组件在序列化阶段动态排除不需要的字段,适合临时调整返回结构的场景:
- 在实体类上开启自定义过滤标记:
@JsonFilter("customFieldFilter") public class DemoModel { private String field1; private String field2; private String field3; // 省略getter/setter } - 在/e2接口的返回值构建阶段,指定需要排除的字段:
@GetMapping("/e2") public MappingJacksonValue getLimitedModel() { DemoModel model = demoService.getModel(); // 构建过滤规则,序列化时排除field3 SimpleFilterProvider filterProvider = new SimpleFilterProvider() .addFilter("customFieldFilter", SimpleBeanPropertyFilter.serializeAllExcept("field3")); MappingJacksonValue wrapper = new MappingJacksonValue(model); wrapper.setFilters(filterProvider); return wrapper; }
内容的提问来源于stack exchange,提问作者Neeraj M
相关产品推荐
相关产品推荐

