0

0

Spring Boot 2.7: 简化控制器 JSON 交互配置的最佳实践

花韻仙語

花韻仙語

发布时间:2025-11-23 20:40:02

|

511人浏览过

|

来源于php中文网

原创

Spring Boot 2.7: 简化控制器 JSON 交互配置的最佳实践

在 spring boot 应用中,为确保所有控制器默认以 json 格式生产和消费数据,无需在每个方法或类上重复使用 `@requestmapping` 注解的 `consumes` 和 `produces` 属性。核心解决方案是利用 spring mvc 提供的 `@restcontroller` 注解,它能自动配置 json 序列化和反序列化行为,大幅简化代码并提升开发效率。

Spring Boot 控制器默认 JSON 行为配置

在 Spring Boot 2.7 及更高版本中,以及之前的许多版本中,实现所有控制器默认处理 JSON 数据交互的核心机制在于 Spring MVC 的 @RestController 注解。当开发 RESTful API 时,我们经常需要确保客户端发送的请求体是 JSON 格式,并且服务器返回的响应体也是 JSON 格式。

传统做法的问题

在没有特定配置的情况下,开发者可能会在每个控制器类或方法上重复添加如下注解:

@RequestMapping(consumes = MediaType.APPLICATION_JSON_VALUE, produces = MediaType.APPLICATION_JSON_VALUE)

这种做法虽然有效,但会导致代码冗余,尤其是在大型项目中,维护成本会显著增加。

解决方案:使用 @RestController 注解

Spring Framework 提供了一个便捷的组合注解 @RestController,它实际上是 @Controller 和 @ResponseBody 的组合。

  • @Controller: 标记一个类为 Spring MVC 控制器。
  • @ResponseBody: 告诉 Spring MVC 将方法的返回值直接绑定到 Web 响应体。当 jackson-databind 库(Spring Boot Web Starter 默认包含)存在于类路径中时,@ResponseBody 会自动通过 MappingJackson2HttpMessageConverter 将 Java 对象序列化为 JSON 格式,并设置 Content-Type 为 application/json。

对于请求体(consumes),当控制器方法参数使用 @RequestBody 注解时,MappingJackson2HttpMessageConverter 也会自动负责将传入的 JSON 请求体反序列化为对应的 Java 对象。

Prisms AI
Prisms AI

无代码构建AI应用的平台

下载

因此,只需在控制器类上添加 @RestController 注解,即可实现默认的 JSON 生产和消费行为,无需额外的 @RequestMapping 属性配置。

示例代码

以下是一个使用 @RestController 注解的控制器示例,它将自动处理 JSON 请求和响应:

package com.example.demo.controller;

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RestController;

// 标记为 REST 控制器,自动处理 JSON 序列化和反序列化
@RestController 
public class MyRestController {

    // 假设有一个简单的 DTO
    public static class User {
        private String username;
        private String email;

        // Getters and Setters
        public String getUsername() { return username; }
        public void setUsername(String username) { this.username = username; }
        public String getEmail() { return email; }
        public void setEmail(String email) { this.email = email; }
    }

    /**
     * 处理 GET 请求,返回 JSON 格式的用户信息
     * 默认 produces = application/json
     */
    @GetMapping("/users/current")
    public User getCurrentUser() {
        User user = new User();
        user.setUsername("john.doe");
        user.setEmail("john.doe@example.com");
        return user; // Spring Boot 会自动将其序列化为 JSON
    }

    /**
     * 处理 POST 请求,接收 JSON 格式的用户信息
     * 默认 consumes = application/json
     */
    @PostMapping("/users")
    public String createUser(@RequestBody User newUser) {
        // 在这里处理 newUser 对象,例如保存到数据库
        System.out.println("Received user: " + newUser.getUsername() + ", " + newUser.getEmail());
        return "User created successfully: " + newUser.getUsername(); // 返回字符串,Spring Boot 仍会以 JSON 形式返回
    }
}

在上述示例中,getCurrentUser() 方法的返回值 User 对象会被自动转换为 JSON 响应,而 createUser() 方法的 @RequestBody User newUser 参数会自动将 JSON 请求体反序列化为 User 对象。整个过程无需显式声明 consumes 或 produces 为 MediaType.APPLICATION_JSON_VALUE。

注意事项与总结

  1. 依赖管理: 确保你的 Spring Boot 项目中包含了 spring-boot-starter-web 依赖。这个 starter 会自动引入 jackson-databind,它是 Spring Boot 处理 JSON 的默认库。
    
        org.springframework.boot
        spring-boot-starter-web
    
  2. 内容协商: @RestController 结合 Jackson 库提供了强大的 JSON 处理能力。如果你的应用需要支持除了 JSON 之外的其他媒体类型(如 XML),Spring MVC 的内容协商机制仍然会起作用。但对于专注于 JSON 的 RESTful API,@RestController 是最简洁高效的选择。
  3. 异常处理: 当 JSON 序列化或反序列化发生错误时,Spring Boot 会自动提供默认的错误响应。为了更好的用户体验,可以结合 @ControllerAdvice 和 @ExceptionHandler 进行全局的异常处理。
  4. 代码整洁性: 使用 @RestController 大大减少了样板代码,使控制器逻辑更加清晰,提高了代码的可读性和可维护性。

通过采纳 @RestController 注解,开发者可以专注于业务逻辑的实现,而将繁琐的 JSON 格式处理工作交给 Spring Boot 自动完成,从而构建出更简洁、高效的 RESTful 服务。

相关专题

更多
java
java

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

831

2023.06.15

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

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

737

2023.07.05

java自学难吗
java自学难吗

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

733

2023.07.31

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

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

397

2023.08.01

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

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

398

2023.08.02

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

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

446

2023.08.02

java有什么用
java有什么用

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

430

2023.08.02

java在线网站
java在线网站

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

16925

2023.08.03

PHP 表单处理与文件上传安全实战
PHP 表单处理与文件上传安全实战

本专题聚焦 PHP 在表单处理与文件上传场景中的实战与安全问题,系统讲解表单数据获取与校验、XSS 与 CSRF 防护、文件类型与大小限制、上传目录安全配置、恶意文件识别以及常见安全漏洞的防范策略。通过贴近真实业务的案例,帮助学习者掌握 安全、规范地处理用户输入与文件上传的完整开发流程。

1

2026.01.13

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Kotlin 教程
Kotlin 教程

共23课时 | 2.4万人学习

C# 教程
C# 教程

共94课时 | 6.5万人学习

Java 教程
Java 教程

共578课时 | 45.2万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号