定义一个统一的响应格式类
创始人
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辅助工具(透视)原来存在有挂,必赢方法(有挂内置)-哔哩哔哩1、游戏颠覆性...
透视存在!wepoker到底有... 透视存在!wepoker到底有没有透视,wepoker辅助脚本,妙计教程(有挂教学)-哔哩哔哩1、游...
两分钟解密!德州真人透视脚本(... 两分钟解密!德州真人透视脚本(透视)本来真的有挂,教你教程(有人有挂)-哔哩哔哩一、德州真人透视脚本...
透视有挂!wepoker开脚本... 透视有挂!wepoker开脚本视频(透视)原来是真的挂,介绍教程(有挂中牌率)-哔哩哔哩1、让任何用...
透视辅助!wepoker游戏安... 透视辅助!wepoker游戏安装教程,wepoker破解是真的还是假的,方式教程(有挂技巧)-哔哩哔...
1分钟分享!pokemmo脚本... 1分钟分享!pokemmo脚本(透视)其实是有挂,总结教程(真是有挂)-哔哩哔哩1、首先打开poke...
透视好友!德普之星辅助软件,德... 透视好友!德普之星辅助软件,德普辅助软件,项目教程(有挂规律)-哔哩哔哩1、完成德普之星辅助软件的残...
透视安装!德普之星透视辅助软件... 透视安装!德普之星透视辅助软件是真的吗(透视)竟然真的有挂,2025教程(有挂开挂)-哔哩哔哩;1)...
透视最新!大菠萝免费辅助器(透... 透视最新!大菠萝免费辅助器(透视)原来真的是有挂,详细教程(有挂开发)-哔哩哔哩1、大菠萝免费辅助器...
第8分钟解迷!wepoker辅... 第8分钟解迷!wepoker辅助器安装包定制(透视)本来有挂,教你攻略(有挂透视)-哔哩哔哩1、下载...