springmvc怎么用json数据

SpringMVC中如何使用JSON数据进行前后端交互

在现代Web开发中，JSON（JavaScript Object Notation）因其轻量级、易解析的特性，已成为前后端数据交互的主流格式，SpringMVC作为Java EE领域最流行的MVC框架，提供了对JSON数据的原生支持，简化了后端接口与前端页面的数据传输，本文将详细介绍SpringMVC中使用JSON数据的完整流程，包括环境配置、请求接收、响应返回及常见问题处理。

环境准备：添加JSON依赖

要在SpringMVC中使用JSON数据，首先需要引入处理JSON的核心库，SpringMVC通常通过Jackson库（官方推荐）或Gson、Fastjson等第三方库实现JSON转换，以Jackson为例，在Maven项目的pom.xml中添加以下依赖：

<!-- Jackson核心依赖 -->
<dependency>
    <groupId>com.fasterxml.jackson.core</groupId>
    <artifactId>jackson-databind</artifactId>
    <version>2.13.0</version> <!-- 可根据需要调整版本 -->
</dependency>
<!-- Jackson注解支持（可选，用于自定义序列化/反序列化） -->
<dependency>
    <groupId>com.fasterxml.jackson.core</groupId>
    <artifactId>jackson-annotations</artifactId>
    <version>2.13.0</version>
</dependency>

如果使用Spring Boot，spring-boot-starter-web依赖已默认包含Jackson,无需额外添加。

配置SpringMVC支持JSON

传统SpringMVC项目配置

在传统的SpringMVC项目中，需通过<mvc:annotation-driven>标签开启注解驱动，并配置MessageConverter（消息转换器）以支持JSON处理，在spring-mvc.xml配置文件中添加：

<!-- 开启注解驱动，自动配置消息转换器 -->
<mvc:annotation-driven/>
<!-- 可选：手动配置HttpMessageConverter（默认已包含Jackson的MappingJackson2HttpMessageConverter） -->
<mvc:annotation-driven>
    <mvc:message-converters>
        <bean class="org.springframework.http.converter.json.MappingJackson2HttpMessageConverter">
            <property name="supportedMediaTypes">
                <list>
                    <value>application/json</value> <!-- 设置支持的JSON媒体类型 -->
                </list>
            </property>
        </bean>
    </mvc:message-converters>
</mvc:annotation-driven>

Spring Boot项目配置

Spring Boot通过自动配置简化了JSON处理，默认已配置好MappingJackson2HttpMessageConverter，无需手动配置，只需确保项目中存在Jackson依赖即可。

接收前端JSON请求数据

前端通过POST请求向SpringMVC后端传递JSON数据时，后端需通过@RequestBody注解将请求体中的JSON字符串自动绑定到Java对象。

定义接收JSON的实体类

首先创建一个与JSON字段对应的Java实体类（POJO），确保字段名、类型与JSON数据一致：

public class User {
    private String username;
    private Integer age;
    private String email;
    // 必须提供无参构造方法（Jackson反序列化时需要）
    public User() {}
    // getter和setter方法
    public String getUsername() {
        return username;
    }
    public void setUsername(String username) {
        this.username = username;
    }
    public Integer getAge() {
        return age;
    }
    public void setAge(Integer age) {
        this.age = age;
    }
    public String getEmail() {
        return email;
    }
    public void setEmail(String email) {
        this.email = email;
    }
    @Override
    public String toString() {
        return "User{" +
                "username='" + username + '\'' +
                ", age=" + age +
                ", email='" + email + '\'' +
                '}';
    }
}

编写Controller接收JSON数据

在Controller方法中，使用@RequestBody注解将HTTP请求体中的JSON数据转换为Java对象：

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.ResponseBody;
@Controller
public class UserController {
    @PostMapping("/user")
    @ResponseBody // 表示直接返回响应体（不跳转视图）
    public String addUser(@RequestBody User user) {
        // 处理接收到的User对象
        System.out.println("接收到用户数据：" + user);
        return "用户添加成功：" + user.getUsername();
    }
}

说明：

• @RequestBody注解作用于方法参数，表示将HTTP请求体（request body）的内容绑定到参数对象，SpringMVC通过HttpMessageConverter（如MappingJackson2HttpMessageConverter）将JSON字符串反序列化为Java对象。
• @ResponseBody注解作用于方法，表示方法的返回值直接作为HTTP响应体返回（默认为text/plain类型，若返回对象则会被转换为JSON）。

前端发送JSON请求示例（使用jQuery AJAX）

前端可通过AJAX向/user接口发送JSON数据：

$.ajax({
    url: "/user",
    type: "POST",
    contentType: "application/json", // 指定请求内容类型为JSON
    data: JSON.stringify({
        username: "张三",
        age: 25,
        email: "zhangsan@example.com"
    }),
    success: function(response) {
        alert(response); // 弹出："用户添加成功：张三"
    },
    error: function(error) {
        console.error("请求失败：" + error);
    }
});

返回JSON数据给前端

SpringMVC支持多种方式向前端返回JSON数据，最常用的是通过@ResponseBody注解或@RestController注解。

使用@ResponseBody注解

在Controller方法上添加@ResponseBody,返回的对象会被自动转换为JSON字符串：

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController // @RestController = @Controller + @ResponseBody（推荐使用）
public class UserController {
    @GetMapping("/user/1")
    public User getUser() {
        User user = new User();
        user.setUsername("李四");
        user.setAge(30);
        user.setEmail("lisi@example.com");
        return user; // 返回User对象，会被Jackson转换为JSON
    }
}

访问结果：
发送GET请求到/user/1,响应体为JSON字符串：

{
    "username": "李四",
    "age": 30,
    "email": "lisi@example.com"
}

使用@RestController注解

@RestController是SpringMVC提供的复合注解，相当于@Controller和@ResponseBody的组合，标注在类上表示该Controller的所有方法都会返回JSON数据（无需再写@ResponseBody）：

import org.springframework.web.bind.annotation.*;
@RestController
@RequestMapping("/api/users") // 类级别路径映射
public class UserController {
    @GetMapping("/{id}")
    public User getUserById(@PathVariable Integer id) {
        // 模拟根据ID查询用户
        User user = new User();
        user.setUsername("王五");
        user.setAge(28);
        user.setEmail("wangwu@example.com");
        return user;
    }
    @PostMapping
    public User createUser(@RequestBody User user) {
        // 模拟创建用户
        System.out.println("创建用户：" + user);
        return user; // 返回创建后的用户信息（实际项目中可能返回ID等）
    }
}

JSON数据处理的进阶配置

自定义JSON序列化/反序列化

通过Jackson的注解可以自定义JSON字段的名称、格式,或忽略某些字段：

import com.fasterxml.jackson.annotation.*;
@JsonInclude(JsonInclude.Include.NON_NULL) // 忽略null字段
public class User {
    @JsonProperty("name") // 将JSON字段名映射为"name"
    private String username;
    @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss") // 日期格式化
    private Date createTime;
    @JsonIgnore // 忽略该字段，不参与JSON序列化/反序列化
    private String password;
    // getter和setter...
}

全局日期格式化

在Spring Boot中，可通过application.properties或application.yml配置全局日期格式：

# Jackson全局日期格式
spring.jackson.date-format=yyyy-MM-dd HH:mm:ss
spring.jackson.time-zone=GMT+8

处理JSON集合数据

若需返回List或Map等集合类型,SpringMVC会自动将其转换为JSON数组或对象：

@GetMapping("/users")
public List<User> getAllUsers() {
    List<User> users = new ArrayList<>();
    users.add(new User("张三", 25, "zhangsan@example.com"));
    users.add(new User("李四", 30, "lisi@example.com"));
    return users;
}

访问结果：

[
    {
        "username": "张三",
        "age": 25