Result类(返回类)

Java自定义响应结果类ReturnResult使用Lombok注解
该文章展示了一个使用Lombok库的@Data注解创建的Java类ReturnResult,用于构建统一的API响应。类包含了状态码(code),消息(msg)和数据(data)字段,并提供了多个静态工厂方法来方便创建成功或错误的响应实例。
import lombok.Data;

/**
 * 自定义响应结构
 */
@Data
public class ReturnResult<T> {

    private int code;
    private String msg;
    private T data;

    public static <T> ReturnResult<T> success() {
        ReturnResult result = new ReturnResult<T>();
        result.setCode(200);
        result.setMsg("成功");
        return result;
    }

    public static <T> ReturnResult<T> success(T data) {
        ReturnResult result = new ReturnResult<T>(data);
        result.setCode(200);
        result.setMsg("成功");
        return result;
    }


    public static <T> ReturnResult<T> error() {
        ReturnResult result = new ReturnResult<T>();
        result.setCode(2000);
        result.setMsg("服务端异常");
        return result;
    }

    public static <T> ReturnResult<T> error(String msg) {
        ReturnResult result = new ReturnResult<T>(msg);
        result.setCode(2000);
        return result;
    }

    public static <T> ReturnResult<T> error(Integer code, String msg) {
        return new ReturnResult<T>(code, msg);
    }

    public static <T> ReturnResult<T> error(Integer code, String msg, T data) {
        return new ReturnResult<T>(code, msg, data);
    }


    private ReturnResult() {
    }

    private ReturnResult(String msg) {
        this.msg = msg;
        this.data = null;
    }

    private ReturnResult(T data) {
        this.data = data;
    }

    private ReturnResult(Integer code, String msg) {
        this.code = code;
        this.msg = msg;
        this.data = null;
    }

    private ReturnResult(Integer code, String msg, T data) {
        this.code = code;
        this.msg = msg;
        this.data = data;
    }
}

### 定义通用的结果返回 为了确保API响应的一致性和易于解析,定义一个统一的`Result`作为所有API调用的标准返回格式是一个良好的实践。这不仅提高了客户端处理服务器端数据的能力,而且简化了错误管理和状态报告。 #### Python (基于Django) 在Python中特别是当使用Django框架时,可以通过创建一个简单的字典来构建这个模式,或者更进一步地通过序列化器(Serializer)实现更为复杂的数据验证和转换逻辑[^1]。下面展示了一种基本的方式: ```python class Result(object): def __init__(self, success=True, message="Operation successful", data=None): self.success = success self.message = message self.data = data if data is not None else {} def to_dict(self): return { 'success': self.success, 'message': self.message, 'data': self.data } ``` 此方法允许快速实例化带有默认成功消息的对象,并能够轻松添加任意形式的有效负载至`data`字段内。对于失败的情况,则只需更改`success`参数为False并提供相应的错误描述即可。 此外,在实际应用中可能还需要考虑HTTP状态码的支持以及异常捕获机制的设计,以便更好地适应RESTful API的需求。例如可以在视图函数里这样使用上述`Result`对象: ```python from django.http import JsonResponse def some_view(request): try: # 假设这里有一些业务逻辑... result = Result(data={"key": "value"}) except Exception as e: result = Result(success=False, message=str(e)) return JsonResponse(result.to_dict()) ``` 这种方法有助于保持整个系统的稳定运行,同时也让前端开发者更容易理解和集成后端服务接口。
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
红包 添加红包
表情包 插入表情
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

ahwangzc

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值