【代码规范系列】统一响应结果封装
约 591 字大约 2 分钟
方向代码规范统一封装
2025-08-23
分析
1). 刚才我们执行查询部门操作,查询返回的结果是一个List<Dept> ,原始代码及响应给前端的结果如下:

2). 如果我们还要实现一个需求,根据ID查询部门名称,原始代码及响应给前端的结果如下:

3). 如果我们还要实现一个需求,根据ID查询部门数据,原始代码及响应给前端的结果如下:

大家会发现,上述的每一个需求,我们都实现了。
但是呢,所有的Controller的方法的返回值是各式各样的,什么样的都有,响应的结果,也是各式各样。
如果做一个大型项目,要实现的需求、功能非常多,如果按照这种方案来,最终就会造成项目不便管理、难以维护。
而为了解决这个问题,我们就需要统一响应结果。 也就是说,无论什么实现什么功能,最终响应给前端的格式应该是统一的 。

前端:只需要按照统一格式的返回结果进行解析(仅一种解析方案),就可以拿到数据。
统一的返回结果使用类来描述,在这个结果中包含:
响应状态码:当前请求是成功,还是失败
状态码信息:给页面的提示信息
返回的数据:给前端响应的数据(字符串、对象、集合)
定义在一个实体类Result来包含以上信息。代码如下:
import lombok.Data;
import java.io.Serializable;
/**
* 后端统一返回结果
*/
@Data
public class Result {
private Integer code; //编码:1成功,0和其它数字为失败
private String msg; //错误信息
private Object data; //数据
public static Result success() {
Result result = new Result();
result.code = 1;
return result;
}
public static Result success(Object object) {
Result result = new Result();
result.data = object;
result.code = 1;
return result;
}
public static Result error(String msg) {
Result result = new Result();
result.msg = msg;
result.code = 0;
return result;
}
}