Spring MVC返回JSON数据

2024 年 03 月 20 日

64 次浏览

2616字数

在当今的Web开发过程中，JSON已经成为前后端数据交换的首选格式之一。Spring MVC框架提供了简便的方式来支持JSON数据的接收和响应，让开发人员能够轻松实现RESTful服务。在Spring MVC中返回JSON数据，通常采用以下几种方式。

使用 `@ResponseBody`

在Spring MVC中，@ResponseBody注解告诉框架不要将方法的返回值作为视图名称解析，而是直接将返回值写入到响应体中。如果返回的是一个对象或集合，Spring将自动将其转换为JSON格式。

@RestController
public class UserController {

    @GetMapping("/user")
    @ResponseBody
    public User getUser() {
        User user = new User();
        user.setId(1);
        user.setName("张三");
        user.setEmail("zhangsan@example.com");
        return user;
    }
}

在这个例子中，getUser方法返回一个 User对象，由于 @ResponseBody的作用，Spring会自动使用Jackson或Gson等库将 User对象转换成JSON格式的字符串。

使用 `@RestController`

自Spring 4.0起，@RestController注解被引入，它等同于 @Controller加上每个方法上的 @ResponseBody。如果控制器中所有的方法都返回类似JSON这种的数据，可以选择将 @Controller换成 @RestController以简化配置。

@RestController
public class UserController {

    @GetMapping("/user")
    public User getUser() {
        // 方法实现同上
    }
}

配置消息转换器

当Spring MVC调用方法并使用 @ResponseBody注解时，它会遍历已配置的 HttpMessageConverter列表，寻找能够处理方法返回类型的转换器。你可以按需添加或覆盖默认的消息转换器。

在 spring-mvc.xml配置文件（或通过等价的Java配置）中，可以像以下这样配置 MappingJackson2HttpMessageConverter：

<beans>
    <mvc:annotation-driven>
        <mvc:message-converters>
            <bean class="org.springframework.http.converter.json.MappingJackson2HttpMessageConverter">
                <property name="supportedMediaTypes" value="application/json"/>
            </bean>
        </mvc:message-converters>
    </mvc:annotation-driven>
</beans>

处理异常

当返回JSON数据时，有时也需要处理异常。可以使用 @ExceptionHandler注解创建局部的异常处理器，或者使用 @ControllerAdvice创建全局的异常处理器。

@RestController
public class UserController {

    @GetMapping("/user")
    public User getUser() {
        // 方法实现同上
    }

    @ExceptionHandler(UserNotFoundException.class)
    public ResponseEntity<String> handleUserNotFoundException(UserNotFoundException ex) {
        return ResponseEntity.status(HttpStatus.NOT_FOUND).body(ex.getMessage());
    }
}

在这个例子中，如果在获取用户信息时触发了 UserNotFoundException异常，将会调用 handleUserNotFoundException方法来处理。

综上所述，Spring MVC提供了灵活、强大的方式来支持返回JSON数据，从直接使用 @ResponseBody及 @RestController注解，到通过配置消息转换器和异常处理器，开发人员可以根据具体需求选择合适的实现方式。