Spring Boot定义统一默认返回结果体

在Spring Boot中,您可以使用统一的返回结果体来定义默认的返回结果。这样可以确保在处理请求时,无论成功还是失败,都能返回一致的格式化响应。

首先,创建一个通用的响应类,用于封装返回的数据和状态信息。

public class ApiResponse<T> {
    private int status;
    private String message;
    private T data;

    // 构造方法和Getter/Setter方法省略

    // 添加静态方法,用于创建成功的响应
    public static <T> ApiResponse<T> success(T data) {
        return new ApiResponse<>(200, "Success", data);
    }

    // 添加静态方法,用于创建失败的响应
    public static <T> ApiResponse<T> error(int status, String message) {
        return new ApiResponse<>(status, message, null);
    }
}

在上述示例中,`ApiResponse`类定义了一个状态码(`status`)、消息(`message`)和数据(`data`)的通用响应结构。它还提供了静态方法`success`和`error`,用于创建成功和失败的响应对象。

接下来,在您的控制器方法中,使用`ApiResponse`作为返回类型,并根据业务逻辑返回相应的结果。

@RestController
@RequestMapping("/api")
public class MyController {

    @GetMapping("/data")
    public ApiResponse<String> getData() {
        // 假设这里是获取数据的业务逻辑
        String data = "Hello, World!";
        return ApiResponse.success(data);
    }

    @GetMapping("/error")
    public ApiResponse<String> throwError() {
        // 假设这里是处理异常的业务逻辑
        int status = 500;
        String message = "An error occurred";
        return ApiResponse.error(status, message);
    }
}


```

在上述示例中,`getData`方法返回一个成功的响应,其中包含一个字符串数据。`throwError`方法返回一个失败的响应,其中包含一个自定义的错误状态码和错误消息。

通过使用`ApiResponse`作为返回类型,您可以确保在处理请求时,无论成功还是失败,都能返回一致的格式化响应,以便客户端能够正确解析和处理。

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 1
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值