定义一个统一的响应格式类
创始人
2024-11-11 18:08:25
0

在实际开发中,确实很常见需要定义一个统一的响应格式,用于封装 API 接口的返回结果。以下是一个简单的 Java 类示例,用于作为 API 响应的通用格式:

```java
public class ApiResponse {
    private int code;    // 状态码
    private String message; // 消息描述
    private T data;     // 返回的数据,泛型支持返回不同类型的数据

    // 构造函数
    public ApiResponse(int code, String message, T data) {
        this.code = code;
        this.message = message;
        this.data = data;
    }

    // 无参构造函数,可能需要序列化工具链的无参构造函数
    public ApiResponse() {
    }

    // getter 和 setter 方法
    public int getCode() {
        return code;
    }

    public void setCode(int code) {
        this.code = code;
    }

    public String getMessage() {
        return message;
    }

    public void setMessage(String message) {
        this.message = message;
    }

    public T getData() {
        return data;
    }

    public void setData(T data) {
        this.data = data;
    }

    // 根据需要可以添加其他方法,例如用于成功的响应或错误响应的静态方法
    public static ApiResponse success(U data) {
        return new ApiResponse<>(200, "Success", data);
    }

    public static ApiResponse failure(String message) {
        return new ApiResponse<>(500, message, null);
    }
}
```

这个 `ApiResponse` 类是一个泛型类,可以用于封装任何类型的返回数据。它包含状态码、消息和数据三个属性。你可以定义静态方法来创建成功或失败的响应实例。

使用示例:

```java
// 创建成功的响应
ApiResponse successResponse = ApiResponse.success(myPojoObject);

// 创建失败的响应
ApiResponse failureResponse = ApiResponse.failure("Something went wrong");
```

在 Controller 中返回响应:

```java
@RestController
public class MyController {

    @GetMapping("/my-endpoint")
    public ApiResponse getMyData() {
        try {
            MyPojo myPojo = myService.fetchData();
            return ApiResponse.success(myPojo);
        } catch (Exception e) {
            return ApiResponse.failure("Error fetching data");
        }
    }
}
```

这个类可以根据你的具体需求进行扩展,例如添加时间戳、请求ID或者其他任何元数据。在大型项目中,这样的类通常会被定义在共享的库中,以便在不同的服务和模块之间重用。
 

相关内容

热门资讯

透视了解(AAPOKeR)aa... 透视了解(AAPOKeR)aapoker俱乐部(透视)总是是真的有挂(详细辅助教你攻略)1.aapo...
透视线上!德扑之星有作弊,(智... 透视线上!德扑之星有作弊,(智星德州)真是是真的有挂(详细辅助wpk教程)在进入德扑之星有作弊辅助挂...
透视脚本(微扑克)微扑克ai辅... 透视脚本(微扑克)微扑克ai辅助器苹果版(透视)详细辅助解密教程(其实是真的有挂)1、起透看视 微扑...
透视工具(aapokER)aa... 透视工具(aapokER)aapoker俱乐部(透视)竟然是真的有挂(详细辅助2025新版教程);1...
透视软件!德扑之星辅助器购买,... 透视软件!德扑之星辅助器购买,(德州俱乐部)本来真的是有挂(详细辅助wepoke教程);1、德扑之星...
透视最新(Wpk)微扑克游戏辅... 透视最新(Wpk)微扑克游戏辅助器(透视)详细辅助安装教程(一直真的是有挂);小薇(透视辅助)致您一...
透视ai代打(aapoker)... 透视ai代打(aapoker)aapoker发牌机制(透视)切实真的是有挂(详细辅助2025教程);...
透视肯定!德扑ai智能,(nz... 透视肯定!德扑ai智能,(nzt德州)总是有挂(详细辅助切实教程)1、完成德扑ai智能的残局,帮助玩...
透视插件(wPK)wpk透视辅... 透视插件(wPK)wpk透视辅助(透视)详细辅助必赢教程(总是真的有挂)1、首先打开wpk透视辅助最...
透视黑科技(aapokeR)a... 透视黑科技(aapokeR)aapoker透视辅助(透视)竟然存在有挂(详细辅助2025版教程)1)...