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 对象。

有道智云AI开放平台

有道智云AI开放平台

116

查看详情

因此，只需在控制器类上添加 @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 的默认库。

   <dependency>
       <groupId>org.springframework.boot</groupId>
       <artifactId>spring-boot-starter-web</artifactId>
   </dependency>

   登录后复制
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 服务。

以上就是Spring Boot 2.7: 简化控制器 JSON 交互配置的最佳实践的详细内容，更多请关注php中文网其它相关文章！