定义一个统一的响应格式类
创始人
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或者其他任何元数据。在大型项目中,这样的类通常会被定义在共享的库中,以便在不同的服务和模块之间重用。
 

相关内容

热门资讯

第七分钟领会!wepoker怎... 第七分钟领会!wepoker怎么设置盖牌,aapoker辅助是真的吗(透视)必赢教程(的确有挂)we...
黑科技app!wepoke算法... 黑科技app!wepoke算法,德扑之星的发牌是有问题,软件教程(有挂详细)-哔哩哔哩;亲真的是有正...
第十分钟透明挂!wpk辅助器是... 第十分钟透明挂!wpk辅助器是真的吗,uupoker透视(透视)揭秘攻略(新版有挂)亲,关键说明,w...
一分钟了解!德州微扑克辅助神器... 一分钟了解!德州微扑克辅助神器app,微扑克ai辅助器下载,技巧教程(有挂秘笈)-哔哩哔哩;1.德州...
第五分钟了解!hhpoker透... 第五分钟了解!hhpoker透视功能如何下载,拱趴大菠萝开挂方法(透视)新2025教程(证实有挂)1...
辅助黑科技!wepoke用模拟... 辅助黑科技!wepoke用模拟器,德州AI智能辅助机器人,教你攻略(有挂方略)-哔哩哔哩;超受欢迎的...
两分钟发现!wepoker免费... 两分钟发现!wepoker免费脚本弱密码,aapoker脚本怎么用(透视)攻略教程(确实有挂)1、全...
科普常识!微扑克软件的规律,德... 科普常识!微扑克软件的规律,德州之星有辅助挂,必备教程(有挂总结)-哔哩哔哩;大家肯定在之前德州之星...
第7分钟辅助!wepoker免... 第7分钟辅助!wepoker免费脚本咨询,wpk辅助(透视)必胜教程(有挂技术)1、任何wepoke...
推荐几款新版!wepoke有挂... 推荐几款新版!wepoke有挂网上靠谱,aapoker有网页版,教你攻略(有挂方式)-哔哩哔哩;we...