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

相关内容

热门资讯

第6分钟晓得!安装不了wepo... 第6分钟晓得!安装不了wepoker,wepoker好友助力码(透视)详细教程(有挂技术)1、很好的...
终于清楚!德州辅助神器wpk,... 终于清楚!德州辅助神器wpk,wepokeai插件,扑克教程(了解有挂)-哔哩哔哩;德州辅助神器wp...
1分钟透视!wepoker脚本... 1分钟透视!wepoker脚本下载,pokemmo脚本辅助器(透视)安装教程(有挂方法)1、任何po...
推荐十款!德州之星外挂购买渠道... 推荐十款!德州之星外挂购买渠道,wopoker系统机制,系统教程(竟然有挂)-哔哩哔哩;德州之星外挂...
第一分钟体悟!pokemmo手... 第一分钟体悟!pokemmo手机版脚本,wepoker脚本(透视)透牌教程(有挂方法)1)pokem...
教学盘点!wpk发牌可以这离谱... 教学盘点!wpk发牌可以这离谱,德州透视辅助,介绍教程(有挂讲解)-哔哩哔哩;一、wpk发牌可以这离...
第4分钟辅助挂!拱趴大菠萝挂怎... 第4分钟辅助挂!拱趴大菠萝挂怎么安装,竞技联盟破解版最新版(透视)实用技巧(有挂分享)1、用户打开应...
一分钟教你!微扑克wpk真的有... 一分钟教你!微扑克wpk真的有辅助,aapoker俱乐部后台可以操作,揭秘攻略(有挂详情)-哔哩哔哩...
两分钟掌握!佛手在线大菠萝技巧... 两分钟掌握!佛手在线大菠萝技巧,竞技联盟辅助插件(透视)安装教程(有挂总结)1、佛手在线大菠萝技巧a...
大家学习交流!红龙扑克机制,w... 《大家学习交流!红龙扑克机制,wpk辅助器小程序,详细教程(有挂透视)-哔哩哔哩》 wpk辅助器小程...