Skip to content

📦 统一响应对象(ResultVo)

📖 功能介绍

TIP

ResultVo 是统一的接口响应封装对象,用于规范化接口返回格式,提供了错误码、消息提示和数据返回等标准化处理。

⚙️ 核心属性

属性类型说明默认值
codeint错误码(0成功,负数失败)0
msgString错误消息null
dataT返回数据null
encryptboolean数据是否加密false
successfulboolean是否成功true

💡 使用示例

1. 成功响应

java
// 无数据返回
ResultVo<Void> result = new ResultVo<>();
return result;

// 返回数据对象
User user = new User();
user.setId(1L);
user.setName("张三");
return new ResultVo<User>().setData(user);

// 方法链式调用
return new ResultVo<User>()
    .setData(user)
    .setMsg("操作成功");

2. 失败响应

java
// 构造方法设置错误信息
ResultVo<Void> result = new ResultVo<>(-1, "系统异常");
return result;

// set方法设置错误信息
return new ResultVo<Void>()
    .setCode(-1)
    .setMsg("参数错误");

3. 加密响应

java
// 返回加密数据
return new ResultVo<String>()
    .setData(encryptedData)
    .setEncrypt(true);

🔧 错误码规范

错误码范围说明示例
0成功操作成功
-1 ~ -1000系统级错误-1: 系统异常
其他值自定义错误-1999: 自定义错误

⚠️ 注意事项

  1. 错误码使用

    • 统一使用负数错误码
    • 遵循错误码分类规范
    • 提供清晰的错误消息
  2. 数据封装

    • 敏感数据脱敏处理
    • 大数据量分页返回
    • 统一日期格式