/*Copyright (C) 2026 the APIJSON group. All rights reserved.
This source code is licensed under the Apache License Version 2.0.*/
package apijson;
import java.util.*;
/**parser for response
* @author Lemon
* @see #getObject
* @see #getList
* @use JSONResponse response = new JSONResponse(json);
* commenntList = response.getList("Comment[]", Comment.class);//not a must
*/
public interface JSONResponse, L extends List> extends JSONMap {
static final String TAG = "JSONResponse";
// 节约性能和å‡å°‘ bugï¼Œé™¤äº†å…³é”®è¯ @key ，一般都符åˆå˜é‡å‘½å规范，ä¸ç¬¦åˆä¹ŸåŽŸæ ·è¿”回便于调试
/**æ ¼å¼åŒ–带 - ä¸æ¨ªçº¿çš„å•è¯
*/
public static boolean IS_FORMAT_HYPHEN = false;
/**æ ¼å¼åŒ–带 _ 下划线的å•è¯
*/
public static boolean IS_FORMAT_UNDERLINE = false;
/**æ ¼å¼åŒ–带 $ 美元符的å•è¯
*/
public static boolean IS_FORMAT_DOLLAR = false;
//default JSONResponse() {
// super();
//}
//default JSONResponse(Object json) {
// this(parseObject(json));
//}
//default JSONResponse(Object json, JSONParser parser) {
// this(parseObject(json, parser));
//}
//default JSONResponse(Map object) {
// super(format(object));
//}
//default JSONResponse(M object, JSONCreator creator) {
// super(format(object, creator));
//}
//状æ€ä¿¡æ¯ï¼ŒéžGET请求获得的信æ¯<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
public static final int CODE_SUCCESS = 200; //æˆåŠŸ
public static final int CODE_UNSUPPORTED_ENCODING = 400; //ç¼–ç 错误
public static final int CODE_ILLEGAL_ACCESS = 401; //æƒé™é”™è¯¯
public static final int CODE_UNSUPPORTED_OPERATION = 403; //ç¦æ¢æ“作
public static final int CODE_NOT_FOUND = 404; //未找到
public static final int CODE_ILLEGAL_ARGUMENT = 406; //å‚数错误
public static final int CODE_NOT_LOGGED_IN = 407; //未登录
public static final int CODE_TIME_OUT = 408; //超时
public static final int CODE_CONFLICT = 409; //é‡å¤ï¼Œå·²å˜åœ¨
public static final int CODE_CONDITION_ERROR = 412; //æ¡ä»¶é”™è¯¯ï¼Œå¦‚密ç 错误
public static final int CODE_UNSUPPORTED_TYPE = 415; //类型错误
public static final int CODE_OUT_OF_RANGE = 416; //超出范围
public static final int CODE_NULL_POINTER = 417; //对象为空
public static final int CODE_SERVER_ERROR = 500; //æœåŠ¡å™¨å†…部错误
public static final String MSG_SUCCEED = "success"; //æˆåŠŸ
public static final String MSG_SERVER_ERROR = "Internal Server Error!"; //æœåŠ¡å™¨å†…部错误
public static String KEY_OK = "ok";
public static String KEY_CODE = "code";
public static String KEY_MSG = "msg";
public static final String KEY_COUNT = "count";
public static final String KEY_TOTAL = "total";
public static final String KEY_INFO = "info"; //详细的分页信æ¯
public static final String KEY_FIRST = "first"; //是å¦ä¸ºé¦–页
public static final String KEY_LAST = "last"; //是å¦ä¸ºå°¾é¡µ
public static final String KEY_MAX = "max"; //最大页ç
public static final String KEY_MORE = "more"; //是å¦æœ‰æ›´å¤š
/**获å–状æ€
* @return
*/
default int getCode() {
try {
return JSON.getIntValue(this, KEY_CODE);
} catch (Exception e) {
//empty
}
return 0;
}
/**获å–状æ€
* @return
*/
public static int getCode(Map reponse) {
try {
return JSON.getIntValue(reponse, KEY_CODE);
} catch (Exception e) {
//empty
}
return 0;
}
/**获å–状æ€æè¿°
* @return
*/
default String getMsg() {
return JSON.getString(this, KEY_MSG);
}
/**获å–状æ€æè¿°
* @param response
* @return
*/
public static String getMsg(Map response) {
return response == null ? null : JSON.getString(response, KEY_MSG);
}
/**获å–id
* @return
*/
default long getId() {
try {
return JSON.getLongValue(this, getIdKey());
} catch (Exception e) {
//empty
}
return 0;
}
/**获å–æ•°é‡
* @return
*/
default int getCount() {
try {
return JSON.getIntValue(this, KEY_COUNT);
} catch (Exception e) {
//empty
}
return 0;
}
/**获å–总数
* @return
*/
default int getTotal() {
try {
return JSON.getIntValue(this, KEY_TOTAL);
} catch (Exception e) {
//empty
}
return 0;
}
/**是å¦æˆåŠŸ
* @return
*/
default boolean isSuccess() {
return isSuccess(getCode());
}
/**是å¦æˆåŠŸ
* @param code
* @return
*/
public static boolean isSuccess(int code) {
return code == CODE_SUCCESS;
}
/**是å¦æˆåŠŸ
* @param response
* @return
*/
public static boolean isSuccess(JSONResponse, ?> response) {
return response != null && response.isSuccess();
}
/**是å¦æˆåŠŸ
* @param response
* @return
*/
public static boolean isSuccess(Map response) {
return response != null && isSuccess(JSON.getIntValue(response, KEY_CODE));
}
/**æ ¡éªŒæœåŠ¡ç«¯æ˜¯å¦å˜åœ¨table
* @return
*/
default boolean isExist() {
return isExist(getCount());
}
/**æ ¡éªŒæœåŠ¡ç«¯æ˜¯å¦å˜åœ¨table
* @param count
* @return
*/
public static boolean isExist(int count) {
return count > 0;
}
/**æ ¡éªŒæœåŠ¡ç«¯æ˜¯å¦å˜åœ¨table
* @param response
* @return
*/
public static boolean isExist(JSONResponse, ?> response) {
return response != null && response.isExist();
}
public static boolean isExist(Map response) {
return response != null && isExist(JSON.getIntValue(response, KEY_COUNT));
}
/**获å–内部的JSONResponse
* @param key
* @return
*/
default JSONResponse getJSONResponse(String key) {
return getObject(key, JSONResponse.class);
}
//cannot get javaBeanDeserizer
// /**获å–内部的JSONResponse
// * @param response
// * @param key
// * @return
// */
// public static JSONResponse getJSONResponse(JSONRequest response, String key) {
// return response == null ? null : response.getObject(key, JSONResponse.class);
// }
//状æ€ä¿¡æ¯ï¼ŒéžGET请求获得的信æ¯>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
/**
* key = clazz.getSimpleName()
* @param clazz
* @return
*/
default T getObject(Class clazz) {
return getObject(clazz == null ? "" : clazz.getSimpleName(), clazz);
}
/**
* @param key
* @param clazz
* @return
*/
default T getObject(String key, Class clazz) {
return getObject(this, key, clazz);
}
/**
* @param object
* @param key
* @param clazz
* @return
*/
public static T getObject(
Map object, String key, Class clazz) {
return toObject(object == null ? null : JSON.get(object, formatObjectKey(key)), clazz);
}
/**
* @param clazz
* @return
*/
default T toObject(Class clazz) {
return toObject(this, clazz);
}
/**
* @param object
* @param clazz
* @return
*/
public static , L extends List> T toObject(
Map object, Class clazz) {
return JSON.parseObject(object, clazz);
}
/**
* arrayObject = this
* @param key
* @return
*/
default List getList(String key) {
return JSON.getList(this, key);
}
/**
* key = KEY_ARRAY
* @param object
* @return
*/
public static List getList(Map object) {
return JSON.getList(object, KEY_ARRAY);
}
/**
* @param object
* @param key
* @param clazz
* @return
*/
public static > List getList(Map object, String key, Class clazz) {
return object == null ? null : JSON.parseArray(JSON.getString(object, formatArrayKey(key)), clazz);
}
/**
* key = KEY_ARRAY
* @return
*/
default > L getArray() {
return getArray(KEY_ARRAY);
}
/**
* @param key
* @return
*/
default > L getArray(String key) {
return getArray(this, key);
}
/**
* @param object
* @return
*/
public static > L getArray(Map object) {
return getArray(object, KEY_ARRAY);
}
/**
* key = KEY_ARRAY
* @param object
* @param key
* @return
*/
public static > L getArray(Map object, String key) {
return object == null ? null : JSON.get(object, formatArrayKey(key));
}
// /**
// * @return
// */
// default JSONRequest format() {
// return format(this);
// }
/**æ ¼å¼åŒ–keyå称
* @param object
* @return
*/
public static , L extends List> M format(final M object) {
//太长查看ä¸æ–¹ä¾¿ï¼Œä¸å¦‚debug Log.i(TAG, "format object = \n" + JSON.toJSONString(object));
if (object == null || object.isEmpty()) {
Log.i(TAG, "format object == null || object.isEmpty() >> return object;");
return object;
}
M formatedObject = JSON.createJSONObject();
Set set = object.keySet();
if (set != null) {
Object value;
for (String key : set) {
value = object.get(key);
if (value instanceof List>) {//JSONList，é历æ¥format内部项
formatedObject.put(formatArrayKey(key), format((L) value));
}
else if (value instanceof Map, ?>) {//JSONRequest，往下一级æå–
formatedObject.put(formatObjectKey(key), format((M) value));
}
else {//其它Object，直接填充
formatedObject.put(formatOtherKey(key), value);
}
}
}
//太长查看ä¸æ–¹ä¾¿ï¼Œä¸å¦‚debug Log.i(TAG, "format return formatedObject = " + JSON.toJSONString(formatedObject));
return formatedObject;
}
/**æ ¼å¼åŒ–keyå称
* @param array
* @return
*/
public static , L extends List> L format(final L array) {
//太长查看ä¸æ–¹ä¾¿ï¼Œä¸å¦‚debug Log.i(TAG, "format array = \n" + JSON.toJSONString(array));
if (array == null || array.isEmpty()) {
Log.i(TAG, "format array == null || array.isEmpty() >> return array;");
return array;
}
L formattedArray = JSON.createJSONArray();
Object value;
for (int i = 0; i < array.size(); i++) {
value = array.get(i);
if (value instanceof List>) {//JSONList，é历æ¥format内部项
formattedArray.add(format((L) value));
}
else if (value instanceof Map, ?>) {//JSONRequest，往下一级æå–
formattedArray.add(format((M) value));
}
else {//其它Object，直接填充
formattedArray.add(value);
}
}
//太长查看ä¸æ–¹ä¾¿ï¼Œä¸å¦‚debug Log.i(TAG, "format return formattedArray = " + JSON.toJSONString(formattedArray));
return formattedArray;
}
/**获å–表å称
* @param fullName name 或 name:alias
* @return name => name; name:alias => alias
*/
public static String getTableName(String fullName) {
//key:alias -> alias; key:alias[] -> alias[]
int index = fullName == null ? -1 : fullName.indexOf(":");
return index < 0 ? fullName : fullName.substring(0, index);
}
/**获å–å˜é‡å
* @param fullName
* @return {@link #formatKey(String, boolean, boolean, boolean, boolean, boolean, Boolean)} formatColon = true, formatAt = true, formatHyphen = true, firstCase = true
*/
public static String getVariableName(String fullName) {
if (JSONMap.isArrayKey(fullName)) {
fullName = StringUtil.addSuffix(fullName.substring(0, fullName.length() - 2), "list");
}
return formatKey(fullName, true, true, true, true, false, true);
}
/**æ ¼å¼åŒ–数组的å称 key[] => keyList; key:alias[] => aliasList; Table-column[] => tableColumnList
* @param key empty ? "list" : key + "List" 且首å—æ¯å°å†™
* @return {@link #formatKey(String, boolean, boolean, boolean, boolean, boolean, Boolean)} formatColon = false, formatAt = true, formatHyphen = true, firstCase = true
*/
public static String formatArrayKey(String key) {
if (JSONMap.isArrayKey(key)) {
key = StringUtil.addSuffix(key.substring(0, key.length() - 2), "list");
}
int index = key == null ? -1 : key.indexOf(":");
if (index >= 0) {
return key.substring(index + 1); //ä¸å¤„ç†è‡ªå®šä¹‰çš„
}
return formatKey(key, false, true, true, IS_FORMAT_UNDERLINE, IS_FORMAT_DOLLAR, false); //节约性能，除了数组对象 Table-column:alias[] ，一般都符åˆå˜é‡å‘½å规范
}
/**æ ¼å¼åŒ–对象的å称 name => name; name:alias => alias
* @param key name 或 name:alias
* @return {@link #formatKey(String, boolean, boolean, boolean, boolean, boolean, Boolean)} formatColon = false, formatAt = true, formatHyphen = false, firstCase = true
*/
public static String formatObjectKey(String key) {
int index = key == null ? -1 : key.indexOf(":");
if (index >= 0) {
return key.substring(index + 1); // ä¸å¤„ç†è‡ªå®šä¹‰çš„
}
return formatKey(key, false, true, IS_FORMAT_HYPHEN, IS_FORMAT_UNDERLINE, IS_FORMAT_DOLLAR, false); //节约性能，除了表对象 Table:alias ，一般都符åˆå˜é‡å‘½å规范
}
/**æ ¼å¼åŒ–普通值的å称 name => name; name:alias => alias
* @param fullName name 或 name:alias
* @return {@link #formatKey(String, boolean, boolean, boolean, boolean, boolean, Boolean)} formatColon = false, formatAt = true, formatHyphen = false, firstCase = false
*/
public static String formatOtherKey(String fullName) {
return formatKey(fullName, false, true, IS_FORMAT_HYPHEN, IS_FORMAT_UNDERLINE, IS_FORMAT_DOLLAR
, IS_FORMAT_HYPHEN || IS_FORMAT_UNDERLINE || IS_FORMAT_DOLLAR ? false : null);
}
/**æ ¼å¼åŒ–å称
* @param fullName name 或 name:alias
* @param formatAt 去除å‰ç¼€ @ ， @a => a
* @param formatColon 去除分隔符 : ， A:b => b
* @param formatHyphen 去除分隔符 - ， A-b-cd-Efg => aBCdEfg
* @param formatUnderline 去除分隔符 _ ， A_b_cd_Efg => aBCdEfg
* @param formatDollar 去除分隔符 $ ， A$b$cd$Efg => aBCdEfg
* @param firstCase 第一个å•è¯é¦–å—æ¯å°å†™ï¼ŒåŽé¢çš„首å—æ¯å¤§å†™ï¼Œ Ab => ab ; A-b-Cd => aBCd
* @return name => name; name:alias => alias
*/
public static String formatKey(String fullName, boolean formatColon, boolean formatAt, boolean formatHyphen
, boolean formatUnderline, boolean formatDollar, Boolean firstCase) {
if (fullName == null) {
Log.w(TAG, "formatKey fullName == null >> return null;");
return null;
}
if (formatColon) {
fullName = formatColon(fullName);
}
if (formatAt) { //关键è¯åªåŽ»æŽ‰å‰ç¼€ï¼Œä¸æ ¼å¼åŒ–å•è¯ï¼Œä¾‹å¦‚ @a-b 返回 a-b ，最åŽä¸ä¼šè°ƒç”¨ setter
fullName = formatAt(fullName);
}
if (formatHyphen && fullName.contains("-")) {
fullName = formatHyphen(fullName, true);
}
if (formatUnderline && fullName.contains("_")) {
fullName = formatUnderline(fullName, true);
}
if (formatDollar && fullName.contains("$")) {
fullName = formatDollar(fullName, true);
}
// 默认ä¸æ ¼å¼åŒ–普通 key:value (value ä¸ä¸º [], {}) çš„ key
return firstCase == null ? fullName : StringUtil.firstCase(fullName, firstCase);
}
/**"@key" => "key"
* @param key
* @return
*/
public static String formatAt(@NotNull String key) {
return key.startsWith("@") ? key.substring(1) : key;
}
/**key:alias => alias
* @param key
* @return
*/
public static String formatColon(@NotNull String key) {
int index = key.indexOf(":");
return index < 0 ? key : key.substring(index + 1);
}
/**A-b-cd-Efg => ABCdEfg
* @param key
* @return
*/
public static String formatHyphen(@NotNull String key) {
return StringUtil.firstCase(formatHyphen(key, true), false);
}
/**A-b-cd-Efg => ABCdEfg
* @param key
* @param firstCase 首å—符的大å°å†™ï¼Œtrue-大写，false-å°å†™ï¼Œnull-ä¸å¤„ç†
* @return
*/
public static String formatHyphen(@NotNull String key, Boolean firstCase) {
return formatHyphen(key, firstCase, false);
}
/**A-b-cd-Efg => ABCdEfg
* @param key
* @param firstCase 首å—符的大å°å†™ï¼Œtrue-大写，false-å°å†™ï¼Œnull-ä¸å¤„ç†
* @param otherCase éžé¦–å—符的大å°å†™ï¼Œtrue-大写，false-å°å†™ï¼Œnull-ä¸å¤„ç†
* @return
*/
public static String formatHyphen(@NotNull String key, Boolean firstCase, Boolean otherCase) {
return formatDivider(key, "-", firstCase, otherCase);
}
/**A_b_cd_Efg => ABCdEfg
* @param key
* @return
*/
public static String formatUnderline(@NotNull String key) {
return StringUtil.firstCase(formatUnderline(key, true), false);
}
/**A_b_cd_Efg => ABCdEfg
* @param key
* @param firstCase 首å—符的大å°å†™ï¼Œtrue-大写，false-å°å†™ï¼Œnull-ä¸å¤„ç†
* @return
*/
public static String formatUnderline(@NotNull String key, Boolean firstCase) {
return formatUnderline(key, firstCase, false);
}
/**A_b_cd_Efg => ABCdEfg
* @param key
* @param firstCase 首å—符的大å°å†™ï¼Œtrue-大写，false-å°å†™ï¼Œnull-ä¸å¤„ç†
* @param otherCase éžé¦–å—符的大å°å†™ï¼Œtrue-大写，false-å°å†™ï¼Œnull-ä¸å¤„ç†
* @return
*/
public static String formatUnderline(@NotNull String key, Boolean firstCase, Boolean otherCase) {
return formatDivider(key, "_", firstCase, otherCase);
}
/**A$b$cd$Efg => ABCdEfg
* @param key
* @return
*/
public static String formatDollar(@NotNull String key) {
return StringUtil.firstCase(formatDollar(key, true), false);
}
/**A$b$cd$Efg => ABCdEfg
* @param key
* @param firstCase 首å—符的大å°å†™ï¼Œtrue-大写，false-å°å†™ï¼Œnull-ä¸å¤„ç†
* @return
*/
public static String formatDollar(@NotNull String key, Boolean firstCase) {
return formatDollar(key, firstCase, false);
}
/**A$b$cd$Efg => ABCdEfg
* @param key
* @param firstCase 首å—符的大å°å†™ï¼Œtrue-大写，false-å°å†™ï¼Œnull-ä¸å¤„ç†
* @param otherCase éžé¦–å—符的大å°å†™ï¼Œtrue-大写，false-å°å†™ï¼Œnull-ä¸å¤„ç†
* @return
*/
public static String formatDollar(@NotNull String key, Boolean firstCase, Boolean otherCase) {
return formatDivider(key, "$", firstCase, otherCase);
}
/**A.b.cd.Efg => ABCdEfg
* @param key
* @return
*/
public static String formatDot(@NotNull String key) {
return StringUtil.firstCase(formatDot(key, true), false);
}
/**A.b.cd.Efg => ABCdEfg
* @param key
* @param firstCase 首å—符的大å°å†™ï¼Œtrue-大写，false-å°å†™ï¼Œnull-ä¸å¤„ç†
* @return
*/
public static String formatDot(@NotNull String key, Boolean firstCase) {
return formatDot(key, firstCase, false);
}
/**A.b.cd.Efg => ABCdEfg
* @param key
* @param firstCase 首å—符的大å°å†™ï¼Œtrue-大写，false-å°å†™ï¼Œnull-ä¸å¤„ç†
* @param otherCase éžé¦–å—符的大å°å†™ï¼Œtrue-大写，false-å°å†™ï¼Œnull-ä¸å¤„ç†
* @return
*/
public static String formatDot(@NotNull String key, Boolean firstCase, Boolean otherCase) {
return formatDivider(key, ".", firstCase, otherCase);
}
/**A/b/cd/Efg => ABCdEfg
* @param key
* @return
*/
public static String formatDivider(@NotNull String key, Boolean firstCase) {
return formatDivider(key, "/", firstCase);
}
/**åŽ»é™¤åˆ†å‰²ç¬¦ï¼Œè¿”å›žé©¼å³°æ ¼å¼
* @param key
* @param divider
* @return
*/
public static String formatDivider(@NotNull String key, @NotNull String divider) {
return StringUtil.firstCase(formatDivider(key, divider, true), false);
}
/**åŽ»é™¤åˆ†å‰²ç¬¦ï¼Œè¿”å›žé©¼å³°æ ¼å¼
* @param key
* @param divider
* @param firstCase 首å—符的大å°å†™ï¼Œtrue-大写，false-å°å†™ï¼Œnull-ä¸å¤„ç†
* @return
*/
public static String formatDivider(@NotNull String key, @NotNull String divider, Boolean firstCase) {
return formatDivider(key, divider, firstCase, false);
}
/**åŽ»é™¤åˆ†å‰²ç¬¦ï¼Œè¿”å›žé©¼å³°æ ¼å¼
* @param key
* @param divider
* @param firstCase 首å—符的大å°å†™ï¼Œtrue-大写，false-å°å†™ï¼Œnull-ä¸å¤„ç†
* @param otherCase éžé¦–å—符的大å°å†™ï¼Œtrue-大写，false-å°å†™ï¼Œnull-ä¸å¤„ç†
* @return
*/
public static String formatDivider(@NotNull String key, @NotNull String divider, Boolean firstCase, Boolean otherCase) {
String[] parts = StringUtil.split(key, divider);
StringBuilder name = new StringBuilder();
for (String part : parts) {
if (otherCase != null) {
part = otherCase ? part.toUpperCase() : part.toLowerCase();
}
if (firstCase != null) {
part = StringUtil.firstCase(part, firstCase);
}
name.append(part);
}
return name.toString();
}
}