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

相关内容

热门资讯

解迷一下!德友汇辅助器,家乡大... 解迷一下!德友汇辅助器,家乡大二辅助免费,原来有挂(哔哩哔哩)1、这是跨平台的家乡大二辅助轻量版有透...
揭露一下!斗棋bug,盛世辅助... 揭露一下!斗棋bug,盛世辅助器,竟然真的有挂(哔哩哔哩)1、让任何用户在无需盛世辅助器安装教程第三...
专业一下!互游辅助,三江互娱辅... 专业一下!互游辅助,三江互娱辅助,真是是有挂(哔哩哔哩)1、进入到互游辅助是否有挂之后,能看到左侧胜...
解密一下!胡乐麻将辅助器,广西... 解密一下!胡乐麻将辅助器,广西老友玩有破解视频,一直是有挂(哔哩哔哩)1、解密一下!胡乐麻将辅助器,...
辅助一下!闲来辅助神器下载,八... 辅助一下!闲来辅助神器下载,八闽掌上辅助软件,总是存在有挂(哔哩哔哩)闲来辅助神器下载破解侠是真的助...
推荐一下!天天挂机辅助工具,福... 推荐一下!天天挂机辅助工具,福建天天开心辅助真是性,好像存在有挂(哔哩哔哩)1.天天挂机辅助工具 选...
关于一下!决战辅助软件,九九山... 关于一下!决战辅助软件,九九山城万州版脚本,好像真的是有挂(哔哩哔哩)1、九九山城万州版脚本脚本辅助...
总结一下!小程序四川血战辅助,... 总结一下!小程序四川血战辅助,天酷辅助器,好像真的有挂(哔哩哔哩)1、小程序四川血战辅助脚本辅助下载...
教你一下!多乐辅助下载够机,胡... 教你一下!多乐辅助下载够机,胡易决胜麻架辅助,确实有挂(哔哩哔哩)1、超多福利:超高返利,海量正版游...
详细一下!小程序牵手跑得有辅助... 详细一下!小程序牵手跑得有辅助器,牛总管一定要牛辅助,本来真的有挂(哔哩哔哩)1、很好的工具软件,可...