Spring Boot 中如何基于不同控制器返回同一 POJO 的差异化字段

老涛酱_4087

老涛酱_4087

2026-03-20

622人浏览

原创

本文介绍在 spring boot 中复用同一个 dto 类时,如何通过 jackson 注解动态控制 json 序列化字段,实现不同控制器接口按需返回不同属性,兼顾灵活性与 api 精简性。

本文介绍在 spring boot 中复用同一个 dto 类时,如何通过 jackson 注解动态控制 json 序列化字段,实现不同控制器接口按需返回不同属性,兼顾灵活性与 api 精简性。

在实际开发中,我们常希望复用已有的数据传输对象(如 EmailTemplateDto),但不同业务场景(如列表查询 vs 详情获取)对响应字段的需求各不相同:ControllerA 只需 id、emailTitle、emailBody;ControllerB 则只需 emailBody 和 correspondingApi。若强行使用同一 DTO 返回全部字段,不仅增加网络开销,还可能暴露敏感或冗余信息。

此时,无需为每个接口新建 DTO,而是借助 Jackson 提供的序列化视图(@JsonView)机制,实现“一套类、多套输出”。

✅ 推荐方案:使用 @JsonView 实现字段级控制

首先定义视图接口(仅作标记用途,无方法):

public class EmailTemplateViews {
    public static class Summary {}
    public static class Detail {}
}

然后在 DTO 中按需标注字段:

@Data
public class EmailTemplateDto {

    @JsonView({EmailTemplateViews.Summary.class, EmailTemplateViews.Detail.class})
    private Long id;

    @JsonView(EmailTemplateViews.Summary.class)
    private String emailTitle;

    @JsonView({EmailTemplateViews.Summary.class, EmailTemplateViews.Detail.class})
    private String emailBody;

    @JsonView(EmailTemplateViews.Detail.class)
    private String correspondingApi;
}

最后,在 Controller 方法上指定对应视图:

@RestController
@RequestMapping("/email/template")
public class MailController {

    @Autowired
    private IEmailTemplateService emailTemplateService;

    // ControllerA:返回摘要视图(id + emailTitle + emailBody)
    @GetMapping
    @JsonView(EmailTemplateViews.Summary.class)
    public ResponseEntity<list>> getAllEmailTemplates() {
        return ResponseEntity.ok(emailTemplateService.getAllEmailTemplates());
    }

    // ControllerB:返回详情视图(emailBody + correspondingApi)
    @GetMapping("/{id}")
    @JsonView(EmailTemplateViews.Detail.class)
    public ResponseEntity<emailtemplatedto> getEmailTemplateById(@PathVariable Long id) {
        return ResponseEntity.ok(emailTemplateService.getEmailTemplateById(id));
    }
}</emailtemplatedto></list>

✅ 注意:@JsonView 需作用于处理方法(而非 @ResponseBody 或 ResponseEntity 内部),且 Spring Boot 2.6+ 默认启用该功能,无需额外配置。

⚠️ 其他可行方式与权衡建议

  • @JsonIgnore 动态条件:可通过 @JsonIgnore(condition = "...") 结合 SpEL 控制,但可读性差、维护成本高,不推荐用于多场景。
  • DTO 分层设计:如 EmailTemplateSummaryDto / EmailTemplateDetailDto,语义清晰、类型安全,适合大型项目或强契约约束场景。
  • 前端裁剪:虽技术上可行(后端全量返回,前端自行过滤),但违背 REST 原则,浪费带宽,且不利于缓存与调试。

✅ 总结

  • 同一 POJO 完全可以支持差异化 JSON 输出,核心在于合理运用 @JsonView;
  • 视图机制使序列化逻辑与业务逻辑解耦,既保持 DTO 复用性,又保障接口精简性;
  • 对于字段差异大、职责边界清晰的场景,仍建议拆分专用 DTO —— “复用”不应以牺牲可维护性为代价。

遵循“按需暴露、显式声明、最小交付”原则,才能在灵活性与健壮性之间取得最佳平衡。

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
java
java

Java是一个通用术语,用于表示Java软件及其组件,包括“Java运行时环境 (JRE)”、“Java虚拟机 (JVM)”以及“插件”。php中文网还为大家带了Java相关下载资源、相关课程以及相关文章等内容,供大家免费下载使用。

2023.06.15

12097

6

java正则表达式语法
java正则表达式语法

java正则表达式语法是一种模式匹配工具,它非常有用,可以在处理文本和字符串时快速地查找、替换、验证和提取特定的模式和数据。本专题提供java正则表达式语法的相关文章、下载和专题,供大家免费下载体验。

2023.07.05

9182

9

java自学难吗
java自学难吗

Java自学并不难。Java语言相对于其他一些编程语言而言,有着较为简洁和易读的语法,本专题为大家提供java自学难吗相关的文章,大家可以免费体验。

2023.07.31

7852

8

java配置jdk环境变量
java配置jdk环境变量

Java是一种广泛使用的高级编程语言,用于开发各种类型的应用程序。为了能够在计算机上正确运行和编译Java代码,需要正确配置Java Development Kit(JDK)环境变量。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.08.01

1284

3

java保留两位小数
java保留两位小数

Java是一种广泛应用于编程领域的高级编程语言。在Java中,保留两位小数是指在进行数值计算或输出时,限制小数部分只有两位有效数字,并将多余的位数进行四舍五入或截取。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.08.02

1028

3

java基本数据类型
java基本数据类型

java基本数据类型有:1、byte;2、short;3、int;4、long;5、float;6、double;7、char;8、boolean。本专题为大家提供java基本数据类型的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.02

1536

5

java有什么用
java有什么用

java可以开发应用程序、移动应用、Web应用、企业级应用、嵌入式系统等方面。本专题为大家提供java有什么用的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.02

3169

5

java在线网站
java在线网站

Java在线网站是指提供Java编程学习、实践和交流平台的网络服务。近年来,随着Java语言在软件开发领域的广泛应用,越来越多的人对Java编程感兴趣,并希望能够通过在线网站来学习和提高自己的Java编程技能。php中文网给大家带来了相关的视频、教程以及文章,欢迎大家前来学习阅读和下载。

2023.08.03

20411

3

配置java环境变量
配置java环境变量

配置Java环境变量是为了让操作系统能够识别和使用Java的相关命令和功能。本专题为大家提供配置java环境变量相关文章,帮助大家解决问题。

2023.08.03

1395

8

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
热门推荐
/
最新课程
phpStudy极速入门视频教程
phpStudy极速入门视频教程

共6课时 | 54.7万人学习

独孤九贱(4)_PHP视频教程
独孤九贱(4)_PHP视频教程

共89课时 | 134.1万人学习