spring mvc json入参(Spring MVC JSON入参解析及应用)

Spring MVC JSON入参解析及应用

什么是Spring MVC JSON入参

Spring MVC是一款非常流行的Java Web框架，它支持多种入参方式，包括表单提交、URL参数、HTTP头等等。其中，JSON入参是一种非常常见的入参方式，它可以将前端传递过来的JSON字符串解析成Java对象，从而方便后端进行处理。

Spring MVC JSON入参的使用场景

JSON入参通常用于前后端分离的Web应用中，前端通过AJAX请求向后端发送JSON数据，后端通过解析JSON数据进行业务处理，并将处理结果以JSON格式返回给前端。这种方式可以大大提高Web应用的响应速度和用户体验。

如何实现Spring MVC JSON入参

实现Spring MVC JSON入参非常简单，只需要在Controller方法中添加@RequestBody注解即可。例如：

@RequestMapping(value = "/user", method = RequestMethod.POST)
@ResponseBody
public User addUser(@RequestBody User user) {
    // 处理用户数据
    return user;

这里的@RequestBody注解表示将请求体中的JSON数据解析成User对象，并将其作为方法参数传递给addUser方法。

如何处理Spring MVC JSON入参中的复杂对象

当JSON数据中包含复杂对象时，我们可以使用Jackson库将其解析成Java对象。例如：

@RequestMapping(value = "/order", method = RequestMethod.POST)
@ResponseBody
public Order addOrder(@RequestBody String json) throws IOException {
    ObjectMapper mapper = new ObjectMapper();
    Order order = mapper.readValue(json, Order.class);
    // 处理订单数据
    return order;

这里的ObjectMapper是Jackson库中的一个核心类，它可以将JSON字符串解析成Java对象。在这个例子中，我们将请求体中的JSON数据解析成Order对象。

如何处理Spring MVC JSON入参中的数组

当JSON数据中包含数组时，我们可以使用@RequestBody注解配合List类型的参数进行处理。例如：

@RequestMapping(value = "/batch", method = RequestMethod.POST)
@ResponseBody
public List<User> batchAddUser(@RequestBody List<User> users) {
    // 处理用户数据
    return users;

这里的List<User>表示将请求体中的JSON数组解析成User对象的List集合，并将其作为方法参数传递给batchAddUser方法。

如何处理Spring MVC JSON入参中的嵌套对象

当JSON数据中包含嵌套对象时，我们可以使用Jackson库中的@JsonCreator注解和@JsonProperty注解进行处理。例如：

public class Order {
    private String orderId;
    private User user;
    @JsonCreator
    public Order(@JsonProperty("orderId") String orderId, @JsonProperty("user") User user) {
        this.orderId = orderId;
        this.user = user;
    }
    // getters and setters
@RequestMapping(value = "/order", method = RequestMethod.POST)
@ResponseBody
public Order addOrder(@RequestBody String json) throws IOException {
    ObjectMapper mapper = new ObjectMapper();
    Order order = mapper.readValue(json, Order.class);
    // 处理订单数据
    return order;

这里的@JsonCreator注解表示使用构造函数创建Order对象，@JsonProperty注解表示将JSON数据中的属性映射到Java对象的属性中。

如何处理Spring MVC JSON入参中的日期格式

当JSON数据中包含日期格式时，我们可以使用Jackson库中的@JsonFormat注解进行处理。例如：

public class User {
    private String userId;
    @JsonFormat(pattern="yyyy-MM-dd")
    private Date birthday;
    // getters and setters
@RequestMapping(value = "/user", method = RequestMethod.POST)
@ResponseBody
public User addUser(@RequestBody User user) {
    // 处理用户数据
    return user;

这里的@JsonFormat注解表示将JSON数据中的日期字符串解析成Java的Date对象，并指定日期格式为yyyy-MM-dd。

如何处理Spring MVC JSON入参中的枚举类型

当JSON数据中包含枚举类型时，我们可以使用Jackson库中的@JsonCreator注解和@JsonValue注解进行处理。例如：

public enum Gender {
    MALE("M"), FEMALE("F");
    private String code;
    Gender(String code) {
        this.code = code;
    }
    @JsonValue
    public String getCode() {
        return code;
    }
    @JsonCreator
    public static Gender fromCode(String code) {
        for (Gender gender : Gender.values()) {
            if (gender.getCode().equals(code)) {
                return gender;
            }
        }
        throw new IllegalArgumentException("Invalid Gender code: " + code);
    }
public class User {
    private String userId;
    private Gender gender;
    // getters and setters
@RequestMapping(value = "/user", method = RequestMethod.POST)
@ResponseBody
public User addUser(@RequestBody User user) {
    // 处理用户数据
    return user;

这里的@JsonValue注解表示将枚举类型转换成JSON字符串时使用code属性作为值，@JsonCreator注解表示将JSON字符串转换成枚举类型时使用fromCode方法进行解析。

如何处理Spring MVC JSON入参中的空值

当JSON数据中包含空值时，我们可以使用Jackson库中的@JsonInclude注解进行处理。例如：

@JsonInclude(JsonInclude.Include.NON_NULL)
public class User {
    private String userId;
    private String name;
    // getters and setters
@RequestMapping(value = "/user", method = RequestMethod.POST)
@ResponseBody
public User addUser(@RequestBody User user) {
    // 处理用户数据
    return user;

这里的@JsonInclude注解表示将Java对象转换成JSON字符串时忽略空值属性。

如何处理Spring MVC JSON入参中的非法数据

当JSON数据中包含非法数据时，我们可以使用Spring MVC中的@Valid注解和Hibernate Validator库进行处理。例如：

public class User {
    @NotNull(message = "userId不能为空")
    private String userId;
    @Size(min = 2, max = 20, message = "name长度必须在2到20之间")
    private String name;
    // getters and setters
@RequestMapping(value = "/user", method = RequestMethod.POST)
@ResponseBody
public User addUser(@Valid @RequestBody User user, BindingResult result) {
    if (result.hasErrors()) {
        // 处理错误信息
    }
    // 处理用户数据
    return user;

这里的@Valid注解表示对User对象进行校验，@NotNull和@Size注解表示对userId和name属性进行非空和长度校验。如果校验失败，会将错误信息存储在BindingResult对象中。

Spring MVC JSON入参是一种非常常见的入参方式，它可以方便地处理前后端分离的Web应用。如何实现Spring MVC JSON入参以及如何处理其中的复杂对象、数组、嵌套对象、日期格式、枚举类型、空值和非法数据。希望对大家有所帮助。