SpringBoot接口返回结果封装方法实例详解

在SpringBoot中，我们可以使用接口返回结果封装方法来统一处理接口返回结果。本文将详细讲解SpringBoot接口返回结果封装方法实例的完整攻略，并提供两个示例。

1. 接口返回结果封装方法

在SpringBoot中，我们可以使用接口返回结果封装方法来统一处理接口返回结果。以下是接口返回结果封装方法的基本流程：

1. 创建一个名为Result的类，用于封装接口返回结果。

public class Result<T> {

    private int code;
    private String message;
    private T data;

    // 省略getter和setter方法

}

在上面的代码中，我们创建了一个名为Result的类，用于封装接口返回结果。其中，code表示返回码，message表示返回信息，data表示返回数据。

1. 创建一个名为ResultUtil的工具类，用于生成Result对象。

public class ResultUtil {

    public static <T> Result<T> success(T data) {
        Result<T> result = new Result<>();
        result.setCode(0);
        result.setMessage("success");
        result.setData(data);
        return result;
    }

    public static Result<?> error(int code, String message) {
        Result<?> result = new Result<>();
        result.setCode(code);
        result.setMessage(message);
        return result;
    }

}

在上面的代码中，我们创建了一个名为ResultUtil的工具类，用于生成Result对象。其中，success方法用于生成成功的Result对象，error方法用于生成失败的Result对象。

1. 在接口中使用ResultUtil生成Result对象，并返回。

@RestController
public class HelloController {

    @GetMapping("/hello")
    public Result<String> hello() {
        return ResultUtil.success("Hello, World!");
    }

}

在上面的代码中，我们在接口中使用ResultUtil生成Result对象，并返回。

2. 示例1：使用接口返回结果封装方法

以下是一个使用接口返回结果封装方法的示例：

1. 在Idea中，创建一个名为HelloController的控制器，并添加一个名为hello的请求映射。

@RestController
public class HelloController {

    @GetMapping("/hello")
    public Result<String> hello() {
        return ResultUtil.success("Hello, World!");
    }

}

在上面的代码中，我们创建了一个名为HelloController的控制器，并在其中添加了一个名为hello的请求映射。在hello方法中，我们使用ResultUtil生成Result对象，并返回。

1. 在Idea中，启动SpringBoot项目，并访问http://localhost:8080/hello，即可看到以下JSON格式的输出：

{
    "code": 0,
    "message": "success",
    "data": "Hello, World!"
}

3. 示例2：使用接口返回结果封装方法处理异常

以下是一个使用接口返回结果封装方法处理异常的示例：

1. 在Idea中，创建一个名为HelloController的控制器，并添加一个名为hello的请求映射。

@RestController
public class HelloController {

    @GetMapping("/hello")
    public Result<String> hello() {
        try {
            int i = 1 / 0;
        } catch (Exception e) {
            return ResultUtil.error(500, "error");
        }
        return ResultUtil.success("Hello, World!");
    }

}

在上面的代码中，我们创建了一个名为HelloController的控制器，并在其中添加了一个名为hello的请求映射。在hello方法中，我们使用try-catch语句捕获异常，并使用ResultUtil生成Result对象返回。

1. 在Idea中，启动SpringBoot项目，并访问http://localhost:8080/hello，即可看到以下JSON格式的输出：

{
    "code": 500,
    "message": "error"
}

4. 总结

本文详细讲解了SpringBoot接口返回结果封装方法实例的完整攻略，并提供了两个示例。在使用这些技术时，我们应该根据实际需求选择合适的方式，并合理配置返回码、返回信息和返回数据，以便于管理和维护。