我们如何封装这个结果?我们应该注意返回到前端的数据中包含的信息。
一般来说,首先,这次必须有一个code来表示接口的状态。例如,0表示成功,1表示失败,2表示必须传递错误的参数,4表示系统异常,依此类推。这只是一个简单的例子。许多人可能会有疑问。http协议本身已经有了相应的返回代码定义。 例如: 200表示成功, 500表示服务器错误, 404表示找不到页面。
例如,200表示请求成功,但它不能描述请求中的业务结果。 例如,用户名已经存在,事实上,业务并不成功,但http的结果肯定是200, 因此我们需要一个代码来描述我们的业务状态。
除了代码之外,还有一些提示信息,如操作成功、系统异常、用户名已经存在等,所以我们添加了一个message字段。
此外,还有我们的核心数据。例如,我根据id获取数据。此数据的具体内容必须返回到前端,因此必须有数据。此数据使用什么类型?这种类型必须是多样的,所以我们需要使用统一的父类,以便对象可以接收所有类型。当然,我们可以使用一些通用方法来方便操作。
然后还有我们的核心数据。例如,我根据id获取数据。此数据的具体内容必须返回到前端,因此必须有数据。此数据使用什么类型?这种类型必须是多样的,所以我们需要使用统一的父类,以便对象可以接收所有类型。当然,我们可以使用通用方法来方便操作。
主要代码展示:
public class result<t> implements serializable { private static final long serialversionuid = -3960261604608758516l; private int code; private string msg; private t data; public static <t> result<t> success() { return new result<>(); } /** * 成功,默认状态码,返回消息,自定义返回数据 * @param data 自定义返回数据 * @param <t> 返回类泛型,不能为string * @return 通用返回result */ public static <t> result<t> success(t data) { return new result<>(data); } /** * 成功,默认状态码,自定义返回消息,返回数据 * @param msg 自定义返回消息 * @param data 自定义返回数据 * @param <t> 返回类泛型 * @return 通用返回result */ public static <t> result<t> success(string msg, t data) { return new result<>(msg, data); } /** * 成功,默认状态码,自定义返回消息,无返回数据 * * @param msg 自定义返回消息 * @param <t> 返回类泛型 * @return 通用返回result */ public static <t> result<t> success(string msg) { return new result<>(msg); } /** * 失败,默认状态码,返回消息,无返回数据 * @param <t> 返回类泛型 * @return 通用返回result */ public static <t> result<t> error() { return new result<>(resultcode.error); } /** * 失败,默认状态码,自定义返回消息,无返回数据 * @param <t> 返回类泛型 * @return 通用返回result */ public static <t> result<t> error(string msg) { return new result<>(resultcode.error.getcode(), msg); } /** * 失败,自定义状态码,返回消息,无返回数据 * @param code 自定义状态码 * @param msg 自定义返回消息 * @param <t> 返回类泛型 * @return 通用返回result */ public static <t> result<t> error(int code, string msg) { return new result<>(code, msg); } /** * 失败,使用codemsg状态码,返回消息,无返回数据 * @param resultcode codemsg,参数如下: * <p> code 状态码 * <p> msg 返回消息 * @param <t> 返回类泛型 * @return 通用返回result */ public static <t> result<t> error(resultcode resultcode) { return new result<>(resultcode); } /** * 成功构造器,无返回数据 */ private result() { this(resultcode.success); } /** * 成功构造器,自定义返回数据 * @param data 返回数据 */ private result(t data) { this(resultcode.success, data); } /** * 成功构造器,自定义返回消息,无返回数据 * @param msg 返回消息 */ private result(string msg) { this(resultcode.success.getcode(), msg); } /** * 构造器,自定义状态码,返回消息 * @param code 状态码 * @param msg 返回消息 */ private result(int code, string msg) { this.code = code; this.msg = msg; } /** * 成功构造器,自定义返回信息,返回数据 * @param msg 返回信息 * @param data 返回数据 */ private result(string msg, t data) { this(resultcode.success.getcode(), msg, data); } /** * 构造器,自定义状态码,返回消息,返回数据 * @param code 状态码 * @param msg 返回消息 * @param data 返回数据 */ private result(int code, string msg, t data) { this(code, msg); this.data = data; } /** * 构造器,使用codemsg状态码与返回信息,自定义返回数据 * @param resultcode codemsg,参数如下: * <p> code 状态码 * <p> msg 返回消息 * @param data 返回数据 */ private result(resultcode resultcode, t data) { this(resultcode); this.data = data; } /** * 构造器,使用codemsg状态码与返回信息 * @param resultcode codemsg,参数如下: * <p> code 状态码 * <p> msg 返回消息 */ private result(resultcode resultcode) { this(resultcode.getcode(), resultcode.getmsg()); } }
还需要定义几个常见的错误
@builderpublic class resultcode implements serializable { private static final long serialversionuid = -6269841958947880397l; /** 状态码*/ private int code; /**状态信息*/ private string msg; /** 默认成功*/ public final static resultcode success = dispose(resultcodeenum.success); /**默认失败*/ public final static resultcode error = dispose(resultcodeenum.error); /**通用业务异常*/ public final static resultcode biz_error = dispose(resultcodeenum.biz_error); /**文件超出最大限制*/ public final static resultcode file_out_max = dispose(resultcodeenum.file_out_max); /**文件格式不正确*/ public final static resultcode file_format_error = dispose(resultcodeenum.file_format_error); /** 参数错误*/ public final static resultcode param_error = dispose(resultcodeenum.param_error); /**json解析异常*/ public final static resultcode json_format_error = dispose(resultcodeenum.json_format_error); /** sql解析异常*/ public final static resultcode sql_error = dispose(resultcodeenum.sql_error); /**网络超时*/ public final static resultcode network_timeout = dispose(resultcodeenum.network_timeout); /** 未知的接口*/ public final static resultcode unknown_interface = dispose(resultcodeenum.unknown_interface); /**请求方式不支持*/ public final static resultcode req_mode_not_supported = dispose(resultcodeenum.req_mode_not_supported); /**系统异常*/ public final static resultcode sys_error = dispose(resultcodeenum.sys_error); private static resultcode dispose(resultcodeenum codeenum) { return resultcode.builder().code(codeenum.getcode()).msg(codeenum.getmsg()).build(); } public resultcode(int code, string msg) { this.code = code; this.msg = msg; }}
以上就是springboot如何实现统一封装返回前端结果集的详细内容。
