diff --git a/back/src/main/java/com/utils/R.java b/back/src/main/java/com/utils/R.java index 680b3f86..67ca4ac4 100644 --- a/back/src/main/java/com/utils/R.java +++ b/back/src/main/java/com/utils/R.java @@ -4,23 +4,46 @@ import java.util.HashMap; import java.util.Map; /** - * 返回数据 + * 返回数据类,继承自HashMap,用于封装和返回各种类型的响应数据, + * 通常在Web应用中用于构建API的响应结果。 */ public class R extends HashMap { + // 用于实现序列化版本控制,确保不同版本的类在反序列化时的兼容性 private static final long serialVersionUID = 1L; - + + /** + * 构造函数,初始化一个默认的响应对象,设置默认的状态码为0(通常表示成功)。 + */ public R() { put("code", 0); } - + + /** + * 静态方法,返回一个表示错误的响应对象,默认状态码为500,错误信息为“未知异常,请联系管理员”。 + * + * @return 表示错误的R对象。 + */ public static R error() { return error(500, "未知异常,请联系管理员"); } - + + /** + * 静态方法,返回一个表示错误的响应对象,状态码为500,错误信息为传入的msg。 + * + * @param msg 错误信息。 + * @return 表示错误的R对象。 + */ public static R error(String msg) { return error(500, msg); } - + + /** + * 静态方法,返回一个表示错误的响应对象,状态码为传入的code,错误信息为传入的msg。 + * + * @param code 错误状态码。 + * @param msg 错误信息。 + * @return 表示错误的R对象。 + */ public static R error(int code, String msg) { R r = new R(); r.put("code", code); @@ -28,24 +51,49 @@ public class R extends HashMap { return r; } + /** + * 静态方法,返回一个表示成功的响应对象,包含传入的成功信息msg。 + * + * @param msg 成功信息。 + * @return 表示成功的R对象。 + */ public static R ok(String msg) { R r = new R(); r.put("msg", msg); return r; } - + + /** + * 静态方法,返回一个表示成功的响应对象,将传入的Map中的键值对添加到响应对象中。 + * + * @param map 包含响应数据的Map。 + * @return 表示成功的R对象。 + */ public static R ok(Map map) { R r = new R(); r.putAll(map); return r; } - + + /** + * 静态方法,返回一个表示成功的默认响应对象,只包含默认的状态码0。 + * + * @return 表示成功的R对象。 + */ public static R ok() { return new R(); } + /** + * 重写put方法,将键值对添加到响应对象中,并返回当前对象, + * 方便进行链式调用(例如r.put("key1", value1).put("key2", value2))。 + * + * @param key 键。 + * @param value 值。 + * @return 当前的R对象。 + */ public R put(String key, Object value) { super.put(key, value); return this; } -} +} \ No newline at end of file