SpringBoot处理JSON数据方法详解

下面就是关于“SpringBoot处理JSON数据方法详解”的完整攻略。

1.概述

在SpringBoot中，我们通常需要使用JSON来传递数据，处理JSON数据是非常常见的操作。 SpringBoot提供了多种方式来处理JSON数据，包括：

• 使用SpringMVC默认的jackson插件
• 使用GSON插件
• 使用FastJson插件

这三种方式中，SpringMVC默认的jackson插件是最为常用的方式，它可以自动将Java对象序列化为JSON数据，并能够将JSON数据反序列化为Java对象，而无需手动处理。下面，我们就来一一讲解这三种方式。

2.使用SpringMVC默认的jackson插件

2.1 序列化Java对象为JSON数据

2.1.1 直接返回Java对象

在Controller中，我们可以直接将Java对象返回给前端，SpringBoot自动将其序列化为JSON数据。如下所示：

@RestController
@RequestMapping(value = "/user")
public class UserController {
    @GetMapping(value = "/{id}")
    public User getUser(@PathVariable("id") Integer id){
        User user = new User();
        user.setId(id);
        user.setUsername("Tom");
        user.setPassword("123456");
        return user;
    }
}

上述代码中，我们创建了一个User对象，并将其返回给前端，SpringBoot自动将其序列化为了JSON数据。如果我们使用客户端工具发起请求，返回的数据如下所示：

{
    "id": 1,
    "username": "Tom",
    "password": "123456"
}

2.1.2 使用ResponseEntity返回Java对象

我们也可以使用ResponseEntity来返回Java对象，这样可以更加灵活地控制返回的HTTP状态码、响应头等信息。如下所示：

@RestController
@RequestMapping(value = "/user")
public class UserController {
    @GetMapping(value = "/{id}")
    public ResponseEntity<User> getUser(@PathVariable("id") Integer id){
        User user = new User();
        user.setId(id);
        user.setUsername("Tom");
        user.setPassword("123456");
        return ResponseEntity.ok(user);
    }
}

上述代码中，我们返回了一个ResponseEntity实例，并通过该实例设置了HTTP状态码为200。同样，客户端工具发起请求，返回的数据如下所示：

{
    "id": 1,
    "username": "Tom",
    "password": "123456"
}

2.2 反序列化JSON数据为Java对象

在SpringBoot中，我们可以通过@RequestParam注解或@RequestBody注解将JSON数据传递给后台。其中@RequestParam注解通常用于传递简单的数据类型，而@RequestBody注解则用于传递复杂的数据类型，例如Java对象。

2.2.1 使用@RequestParam注解

使用@RequestParam注解，我们可以将JSON数据中的键值对映射到Java对象的属性中。如下所示：

@RestController
@RequestMapping(value = "/user")
public class UserController {
    @PostMapping(value = "/add")
    public String addUser(@RequestParam("id") Integer id,
                          @RequestParam("username") String username,
                          @RequestParam("password") String password){
        User user = new User();
        user.setId(id);
        user.setUsername(username);
        user.setPassword(password);
        return "添加用户成功";
    }
}

上述代码中，我们在方法中使用了@RequestParam注解，将JSON数据中的id、username、password三个键值对映射到了Java对象的属性中。客户端工具发起请求，例如下面这个请求：

{
    "id": 1,
    "username": "Tom",
    "password": "123456"
}

则后台会将其反序列化为User对象，并输出“添加用户成功”。

2.2.2 使用@RequestBody注解

使用@RequestBody注解，则可以将整个JSON数据反序列化为Java对象。如下所示：

@RestController
@RequestMapping(value = "/user")
public class UserController {
    @PostMapping(value = "/add")
    public String addUser(@RequestBody User user){
        return "添加用户成功";
    }
}

上述代码中，我们使用@RequestBody注解将整个JSON数据反序列化为User对象。客户端工具发起请求，例如下面这个请求：

{
    "id": 1,
    "username": "Tom",
    "password": "123456"
}

则后台会将其反序列化为User对象，并输出“添加用户成功”。

3.使用GSON插件

GSON是一款Google提供的用于处理JSON数据的插件，使用起来也非常方便。我们只需要在pom.xml文件中添加以下依赖即可使用：

<dependency>
    <groupId>com.google.code.gson</groupId>
    <artifactId>gson</artifactId>
    <version>2.8.5</version>
</dependency>

3.1 序列化Java对象为JSON数据

在使用GSON处理JSON数据时，我们通常需要通过Gson对象的toJson()方法将Java对象序列化为JSON数据。如下所示：

@RestController
@RequestMapping(value = "/user")
public class UserController {
    @GetMapping(value = "/{id}")
    public String getUser(@PathVariable("id") Integer id){
        User user = new User();
        user.setId(id);
        user.setUsername("Tom");
        user.setPassword("123456");
        Gson gson = new Gson();
        return gson.toJson(user);
    }
}

上述代码中，我们创建了一个Gson对象，并将其使用toJson()方法将Java对象序列化为JSON数据。客户端工具发起请求，返回的数据如下所示：

{
    "id": 1,
    "username": "Tom",
    "password": "123456"
}

3.2 反序列化JSON数据为Java对象

在使用GSON处理JSON数据时，我们通常需要通过Gson对象的fromJson()方法将JSON数据反序列化为Java对象。如下所示：

@RestController
@RequestMapping(value = "/user")
public class UserController {
    @PostMapping(value = "/add")
    public String addUser(@RequestBody String json){
        Gson gson = new Gson();
        User user = gson.fromJson(json, User.class);
        return "添加用户成功";
    }
}

上述代码中，我们从请求的Body中获取JSON数据，并将其通过Gson对象的fromJson()方法反序列化为User对象。客户端工具发起请求，例如下面这个请求：

{
    "id": 1,
    "username": "Tom",
    "password": "123456"
}

则后台会将其反序列化为User对象，并输出“添加用户成功”。

4.使用FastJson插件

FastJson是阿里巴巴提供的用于处理JSON数据的插件，同样支持序列化和反序列化操作。我们只需要在pom.xml文件中添加以下依赖即可使用：

<dependency>
    <groupId>com.alibaba</groupId>
    <artifactId>fastjson</artifactId>
    <version>1.2.47</version>
</dependency>

4.1 序列化Java对象为JSON数据

在使用FastJson处理JSON数据时，我们需要使用JSON.toJSONString()方法将Java对象序列化为JSON数据。如下所示：

@RestController
@RequestMapping(value = "/user")
public class UserController {
    @GetMapping(value = "/{id}")
    public String getUser(@PathVariable("id") Integer id){
        User user = new User();
        user.setId(id);
        user.setUsername("Tom");
        user.setPassword("123456");
        return JSON.toJSONString(user);
    }
}

上述代码中，我们使用JSON对象的toJSONString()方法将Java对象序列化为JSON数据。客户端工具发起请求，返回的数据如下所示：

{
    "id": 1,
    "username": "Tom",
    "password": "123456"
}

4.2 反序列化JSON数据为Java对象

在使用FastJson处理JSON数据时，我们需要使用JSON.parseObject()方法将JSON数据反序列化为Java对象。如下所示：

@RestController
@RequestMapping(value = "/user")
public class UserController {
    @PostMapping(value = "/add")
    public String addUser(@RequestBody String json){
        User user = JSON.parseObject(json, User.class);
        return "添加用户成功";
    }
}

上述代码中，我们使用JSON对象的parseObject()方法将JSON数据反序列化为User对象。客户端工具发起请求，例如下面这个请求：

{
    "id": 1,
    "username": "Tom",
    "password": "123456"
}

则后台会将其反序列化为User对象，并输出“添加用户成功”。

5.小结

本文详细讲解了使用SpringMVC默认的jackson插件、GSON插件和FastJson插件处理JSON数据的方法，并给出了相应的示例代码。