Json 返回数据格式的那些事儿，揭秘 Spring Boot 的奥秘

2023-08-21 05:40:57

Spring Boot 中 Json 数据返回格式：掌控数据交互

统一的 Json 结构：让数据返回更统一、更优雅

在 Spring Boot 中，为了让 Json 数据返回更加统一和优雅，我们可以定义一个统一的 Json 结构，其中包含数据、状态码和提示信息。例如，我们可以定义如下结构：

public class JsonResponse<T> {

    private Integer code;

    private String message;

    private T data;

    // 省略 getter 和 setter 方法
}

这样，我们就可以在不同的场景中使用这个统一的结构来返回 Json 数据，从而保证返回数据的格式一致性，提高代码的可读性和可维护性。

泛型的力量：让 Json 数据返回更加灵活

为了让 Json 数据返回更加灵活，Spring Boot 采用了泛型来定义统一的 Json 结构。这样，我们就可以在定义 Json 结构时指定数据的类型，从而让 Json 数据返回更加灵活。例如，我们可以定义一个通用的 Json 结构，其中数据类型为 Object，这样我们就可以在不同的场景中返回不同类型的数据。

public class GenericJsonResponse {

    private Integer code;

    private String message;

    private Object data;

    // 省略 getter 和 setter 方法
}

除了定义通用的 Json 结构，我们还可以定义自定义的 Json 结构，其中数据类型为我们自己定义的类型。这样，我们就可以在不同的场景中返回更加符合业务需求的数据。

默认的返回结构：让 Json 数据返回更加简单

Spring Boot 提供了一个默认的返回结构，其中包含数据、状态码和提示信息。这个默认的返回结构可以满足大多数场景的需求，如果我们没有特殊的需求，可以直接使用这个默认的返回结构。这样，我们可以更加快速地实现 Json 数据的返回，提高开发效率。

@RestController
public class DefaultJsonController {

    @GetMapping("/default")
    public JsonResponse<String> defaultJson() {
        return JsonResponse.success("Hello, Spring Boot!");
    }
}

用户指定的返回结构：让 Json 数据返回更加个性化

除了默认的返回结构，Spring Boot 还允许用户指定返回结构。这样，用户就可以根据自己的需要定义返回数据的格式，从而满足个性化需求。例如，我们可以定义一个自定义的 Json 结构，其中包含更多的数据字段，以便在需要时返回更多的数据。

@RestController
public class CustomJsonController {

    @GetMapping("/custom")
    public CustomJsonResponse customJson() {
        return CustomJsonResponse.success(new CustomData("Hello, Spring Boot!", 200));
    }
}

public class CustomJsonResponse {

    private Integer code;

    private String message;

    private CustomData data;

    // 省略 getter 和 setter 方法
}

public class CustomData {

    private String name;

    private Integer age;

    // 省略 getter 和 setter 方法
}