springmvc怎么响应json数据

Spring MVC响应JSON数据的完整指南**

在现代Web开发中，JSON（JavaScript Object Notation）因其轻量级、易解析和跨语言特性，已成为前后端数据交换的主流格式，Spring MVC作为Java EE领域最流行的Web框架之一，提供了便捷的方式将后端Java对象序列化为JSON响应给前端客户端，本文将详细介绍Spring MVC如何响应JSON数据，包括核心配置、常用注解以及实践示例。

核心依赖：Jackson或Gson

要让Spring MVC能够处理JSON数据，我们首先需要在项目中引入JSON处理的库，Spring MVC官方推荐使用Jackson库，它是Spring Boot的默认JSON处理器,你也可以选择Gson或其他库。

以Maven项目为例，添加Jackson核心依赖（通常spring-boot-starter-web已包含）：

<!-- Jackson核心依赖 -->
<dependency>
    <groupId>com.fasterxml.jackson.core</groupId>
    <artifactId>jackson-databind</artifactId>
    <version>2.15.2</version> <!-- 使用最新稳定版本 -->
</dependency>

如果你使用的是Spring Boot，spring-boot-starter-web起步依赖已经自动包含了Jackson相关依赖,无需额外添加。

核心注解：`@ResponseBody`与`@RestController`

Spring MVC提供了两个关键注解来简化JSON响应的实现：

@ResponseBody：
- 作用于方法或方法返回类型上。
- 表示方法的返回结果不是要跳转到某个视图（View），而是直接将返回的数据写入HTTP响应体（Response Body）中。
- Spring MVC会自动将返回的Java对象通过配置的JSON转换器（如Jackson）序列化为JSON字符串。
- 当作用于类上时,表示该类所有方法的返回值都将作为响应体直接返回。
@RestController：
- 这是一个组合注解，相当于@Controller + @ResponseBody。
- 当一个类被@RestController注解标记时，该类中的所有公共方法默认都会将返回值序列化为JSON并写入响应体，无需再为每个方法添加@ResponseBody注解。
- 在现代Spring Boot应用中，@RestController是构建RESTful API最常用的注解。

配置JSON转换器（Spring Boot自动配置）

在传统的Spring MVC应用中，可能需要手动配置MappingJackson2HttpMessageConverter来告诉Spring MVC如何将Java对象转换为JSON，这个转换器负责处理@ResponseBody标注的方法返回值以及@RequestBody标注的请求参数。

但在Spring Boot中，这一切都由自动配置（Auto-configuration）机制完成，Spring Boot会自动检测类路径下的Jackson库，并自动配置好MappingJackson2HttpMessageConverter,开发者无需进行额外配置即可直接使用。

如果你使用的是较老的Spring MVC（非Spring Boot），你需要在Spring配置文件中（如XML或Java Config）手动注册这个转换器：

Java Config方式示例：

@Configuration
@EnableWebMvc
public class WebConfig implements WebMvcConfigurer {
    @Override
    public void configureMessageConverters(List<HttpMessageConverter<?>> converters) {
        MappingJackson2HttpMessageConverter converter = new MappingJackson2HttpMessageConverter();
        converter.setObjectMapper(new ObjectMapper()); // 可以自定义ObjectMapper
        converters.add(converter);
    }
}

实践示例

示例1：使用`@RestController`返回JSON对象

假设我们有一个用户实体类User：

public class User {
    private Long id;
    private String username;
    private String email;
    // 构造方法、getter和setter省略
    // 可以使用Lombok简化
}

创建一个控制器UserController：

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController
@RequestMapping("/api/users")
public class UserController {
    @GetMapping("/1")
    public User getUser() {
        User user = new User();
        user.setId(1L);
        user.setUsername("john_doe");
        user.setEmail("john.doe@example.com");
        return user;
    }
}

启动应用，访问http://localhost:8080/api/users/1,浏览器将返回如下JSON数据：

{
  "id": 1,
  "username": "john_doe",
  "email": "john.doe@example.com"
}

示例2：返回JSON数组

@RestController
@RequestMapping("/api/users")
public class UserController {
    @GetMapping
    public List<User> getAllUsers() {
        List<User> users = new ArrayList<>();
        User user1 = new User(1L, "john_doe", "john.doe@example.com");
        User user2 = new User(2L, "jane_smith", "jane.smith@example.com");
        users.add(user1);
        users.add(user2);
        return users;
    }
}

访问http://localhost:8080/api/users,返回：

[
  {
    "id": 1,
    "username": "john_doe",
    "email": "john.doe@example.com"
  },
  {
    "id": 2,
    "username": "jane_smith",
    "email": "jane.smith@example.com"
  }
]

示例3：使用`@ResponseBody`在`@Controller`中返回JSON

虽然@RestController更常用，但如果你已经有了一个@Controller，并且希望某个方法返回JSON，可以只在该方法上使用@ResponseBody：

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.ResponseBody;
@Controller
public class OldStyleUserController {
    @GetMapping("/api/old/user/1")
    @ResponseBody
    public User getUserAsJson() {
        User user = new User();
        user.setId(1L);
        user.setUsername("old_user");
        user.setEmail("old.user@example.com");
        return user;
    }
}

访问http://localhost:8080/api/old/user/1,同样会返回JSON格式的用户数据。

JSON序列化配置

Jackson提供了丰富的配置选项，可以通过@JsonIgnore、@JsonProperty等注解在模型类上精细控制JSON的生成，也可以通过配置ObjectMapper全局设置。

常用Jackson注解示例：

@JsonIgnore：忽略该字段，不参与JSON序列化和反序列化。

public class User {
    // ... other fields
    @JsonIgnore
    private String password; // 密码不会被序列化返回
}

@JsonProperty("new_name")：指定JSON字段名。

public class User {
    @JsonProperty("user_id")
    private Long id;
    // ... other fields
}

@JsonFormat(shape = JsonFormat.Shape.STRING, pattern = "yyyy-MM-dd HH:mm:ss")：格式化日期。

全局配置ObjectMapper（Spring Boot中可通过@Bean定义）：

@Configuration
public class JacksonConfig {
    @Bean
    public ObjectMapper objectMapper() {
        ObjectMapper mapper = new ObjectMapper();
        // 禁用日期序列化为时间戳
        mapper.disable(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS);
        // 其他配置...
        return mapper;
    }
}

Spring MVC响应JSON数据非常便捷和高效：

依赖：确保引入Jackson库（Spring Boot默认已处理）。
注解：优先使用@RestController标记控制器类，使方法返回值自动序列化为JSON，对于传统@Controller，可在方法上使用@ResponseBody。
配置：Spring Boot自动配置JSON转换器，传统Spring MVC需手动配置MappingJackson2HttpMessageConverter。
控制：利用Jackson提供的注解或配置ObjectMapper来定制JSON序列化行为。