diff --git a/.github/ISSUE_TEMPLATE/--bug.md b/.github/ISSUE_TEMPLATE/--bug.md deleted file mode 100755 index 6e545c22d..000000000 --- a/.github/ISSUE_TEMPLATE/--bug.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -name: 提交问题 -about: Create a report to help us improve - ---- - -**环境信息** - - 系统: - - JDK: - - 数据库: - - APIJSON: - -**问题描述** - - - -**错误信息** - - \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/--custom.md b/.github/ISSUE_TEMPLATE/--custom.md deleted file mode 100755 index 5a47bb25e..000000000 --- a/.github/ISSUE_TEMPLATE/--custom.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -name: 其它反馈 -about: Describe this issue template's purpose here. - ---- - - diff --git a/.github/ISSUE_TEMPLATE/--feature_request.md b/.github/ISSUE_TEMPLATE/--feature_request.md deleted file mode 100755 index f8c0c4c7d..000000000 --- a/.github/ISSUE_TEMPLATE/--feature_request.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -name: 功能改进 -about: Suggest an idea for this project - ---- - -**具体说下** -希望改进...希望做成...希望新增... - -**为什么** -说明它在哪些情况下会带来哪些效果。 diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 000000000..f0d9515f5 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,83 @@ +name: Bug Report/报告 bug +description: "Create a report to help us improve, please read FAQ first./帮助我们更好地改进项目，但请先阅读常见问题与提问前必看，不要提已有的重复问题！" +title: "[Bug] " +labels: [kind/bug] +body: +- type: markdown + attributes: + value: "如果你已经知道问题所在、怎么解决，请直接 提交 Pull Request 为社区做贡献，非常感谢。\n开发者也是人，也需要工作、休息、恋爱、陪伴家人、走亲会友等，也有心情不好和身体病痛，\n往往没有额外的时间精力顾及一些小问题，请理解和支持，开源要大家参与贡献才会更美好~\n少数个人的热情终有被耗尽的一天，只有大家共同建设和繁荣社区，才能让开源可持续发展！ " + +- type: input + attributes: + label: APIJSON Version/APIJSON 版本号 + placeholder: | + e.g./例如 5.4.0 ，如果不是最新版请用最新版，复现问题再来，原则上不更新旧版，而是只维护一个最新版 + + validations: + required: true + +- type: input + attributes: + label: Database Type & Version/数据库类型及版本号 + placeholder: | + e.g./例如 MySQL 5.7.34 + + validations: + required: true + +- type: textarea + attributes: + label: Environment/环境信息 + description: | + e.g./例如： + - **JDK/基础库**: 1.8.0_17 + - **OS/系统**: MacOS Monterey 12.6 (21G115) M1 + value: | + - JDK/基础库: + - OS/系统: + render: markdown + + validations: + required: true + +- type: input + attributes: + label: APIAuto Screenshots/APIAuto 请求与结果完整截屏 + description: "Upload by copy and paste image file or url./复制图片文件或 URL 再粘贴到输入框(用 APIAuto 能静态检查出很多问题，甚至还有修复建议，不用浪费你我的时间)\n https://github.com/TommyLemon/APIAuto " + value: + + validations: + required: true + +- type: textarea + attributes: + label: Current Behavior/问题描述 + description: "A concise description of what you're experiencing. Must contains screenshots./\n\n**提 bug 请发请求和响应的【完整截屏】，没图的自行解决！\n开发者有限的时间和精力主要放在【维护项目源码和文档】上！\n【描述不详细】 或 【文档/常见问题 已有答案】 的问题可能会被忽略！！\n【态度 不文明/不友善】的可能会被拉黑，问题也可能不予解答！！！**\n\n请求参数 JSON 中表名、字段名、关键词及对应的值都是大小写敏感、逗号敏感、分号敏感、空格敏感、换行敏感，\n大部分情况都不允许空格和换行，表名以大写字母开头，不要想当然，请严格按照 设计规范 来调用 API \n https://github.com/Tencent/APIJSON/issues/181 " + render: markdown + + validations: + required: true + +- type: textarea + attributes: + label: Expected Behavior/期望结果 + description: A concise description of what you expected to happen./具体描述你期望返回什么样的结果或者达到什么样的效果？ + render: markdown + + validations: + required: false + + +- type: textarea + attributes: + label: Any additional comments?/其它补充说明？ + description: | + e.g. some background/context of how you ran into this bug./例如：一些背景或上下文信息，包括复现步骤、相关日志等 + render: markdown + + validations: + required: false + +- type: markdown + attributes: + value: "Please follow the rules to fulfil all required inputs. You can add screenshots by comment after submit this issue./\n请按要求填写所有必填项，未填完将提交不了！\n如果随意填写敷衍了事，将直接关闭 issue，问题不会得到解答！\n可以提交后再通过回复评论来补充上传截屏图片(复制粘贴文件)。\n如果是网页 bug 等与你无关的原因导致提交不了，可以改为填问卷：\n https://wj.qq.com/s2/10971431/2a09 " diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000..3ba13e0ce --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1 @@ +blank_issues_enabled: false diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 000000000..6f14d47b3 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,17 @@ +name: Feature Request/期望新增功能 +description: Request a new feature/期望新增什么样的功能或特性，或者做哪些方面的改进？ +title: "[Feature] " +labels: [kind/feature] +body: +- type: textarea + attributes: + label: Description + description: | + Please describe what this feature does./具体描述下是什么样的功能或特性，以及你为什么想要它，用在什么场景，碰到了什么痛点，有什么解决思路，尝试过哪些，效果怎样？ + + validations: + required: true + +- type: markdown + attributes: + value: 推荐去建议收集箱提问，也方便 统一检索和管理、投票决定优先级、更新处理进度 等： https://github.com/Tencent/APIJSON/issues/37 diff --git a/.github/ISSUE_TEMPLATE/other_issues.yml b/.github/ISSUE_TEMPLATE/other_issues.yml new file mode 100644 index 000000000..9f9a6d0ea --- /dev/null +++ b/.github/ISSUE_TEMPLATE/other_issues.yml @@ -0,0 +1,16 @@ +name: Other Issues/其它反馈 +description: For questions, suggestions, improvements and others./问题(非 bug)、建议(非新增功能) 或 其它 +title: "[xxx] " +body: +- type: textarea + attributes: + label: Description + description: | + Please describe the issue./请具体描述，包括是什么、为什么、如何做 + + validations: + required: true + +- type: markdown + attributes: + value: "Bug 反馈请使用正确的模板，用错模板将直接关闭 issue，不予解答：\n https://github.com/Tencent/APIJSON/issues/new?assignees=&labels=kind%2Fbug&template=bug_report.yml&title=%5BBug%5D+ \n有建议请去建议收集箱提问，也方便 统一检索和管理、投票决定优先级、更新处理进度 等：\n https://github.com/Tencent/APIJSON/issues/37 " diff --git a/.gitignore b/.gitignore index 204504dc5..a06bbd0a8 100644 --- a/.gitignore +++ b/.gitignore @@ -34,3 +34,5 @@ build/ ### VS Code ### .vscode/ +APIJSONORM/bin +*.DS_Store diff --git a/APIJSONORM/README.md b/APIJSONORM/README.md index 7e0850527..0cb431e27 100644 --- a/APIJSONORM/README.md +++ b/APIJSONORM/README.md @@ -1,4 +1,4 @@ -# APIJSONORM [![](https://jitpack.io/v/Tencent/APIJSON.svg)](https://jitpack.io/#Tencent/APIJSON) +# APIJSONORM [![](https://jitpack.io/v/Tencent/APIJSON.svg)](https://jitpack.io/#Tencent/APIJSON) [Ask DeepWiki.com](https://deepwiki.com/Tencent/APIJSON) 腾讯 [APIJSON](https://github.com/Tencent/APIJSON) ORM 库，可通过 Maven, Gradle 等远程依赖。
Tencent [APIJSON](https://github.com/Tencent/APIJSON) ORM library for remote dependencies with Maven, Gradle, etc. @@ -25,7 +25,6 @@ Tencent [APIJSON](https://github.com/Tencent/APIJSON) ORM library for remote dep ``` -


@@ -49,3 +48,18 @@ Tencent [APIJSON](https://github.com/Tencent/APIJSON) ORM library for remote dep implementation 'com.github.Tencent:APIJSON:latest' } ``` + +
+
+ +### FASTJSON 2 +#### Code +https://github.com/Tencent/APIJSON/tree/fastjson2 + +#### Maven +https://mvnrepository.com/artifact/com.github.linushp/zikai-apijson/1.0 + +
+ +### Unit Test +http://apijson.cn/unit diff --git a/APIJSONORM/pom.xml b/APIJSONORM/pom.xml old mode 100755 new mode 100644 index 6802c6753..bd340fa5f --- a/APIJSONORM/pom.xml +++ b/APIJSONORM/pom.xml @@ -3,9 +3,9 @@ xsi:schemaLocation="http://maven.apache.org/POM/4.0.0%20http://maven.apache.org/xsd/maven-4.0.0.xsd"> 4.0.0 - apijson.orm - apijson-orm - 4.5.1 + com.github.Tencent + APIJSON + 8.0.2 jar APIJSONORM @@ -15,20 +15,12 @@ UTF-8 UTF-8 1.8 + UTF-8 + 1.8 + 1.8 - - - com.alibaba - fastjson - 1.2.74 - - - javax.activation - activation - 1.1.1 - @@ -36,11 +28,26 @@ org.apache.maven.plugins maven-compiler-plugin + 3.12.1 1.8 1.8 + + + org.apache.maven.plugins + maven-source-plugin + 3.2.1 + + + package + + jar-no-fork + + + + diff --git a/APIJSONORM/src/main/java/apijson/JSON.java b/APIJSONORM/src/main/java/apijson/JSON.java index 28c124cab..0a14e0420 100755 --- a/APIJSONORM/src/main/java/apijson/JSON.java +++ b/APIJSONORM/src/main/java/apijson/JSON.java @@ -1,288 +1,691 @@ -/*Copyright (C) 2020 THL A29 Limited, a Tencent company. All rights reserved. +/*Copyright (C) 2020 Tencent. All rights reserved. This source code is licensed under the Apache License Version 2.0.*/ package apijson; -import com.alibaba.fastjson.JSONArray; -import com.alibaba.fastjson.JSONObject; -import com.alibaba.fastjson.parser.Feature; -import com.alibaba.fastjson.serializer.SerializerFeature; - +import java.util.Collection; +import java.util.LinkedHashMap; import java.util.List; +import java.util.Map; -/**阿里FastJSON封装类 防止解析时异常 +/**JSON工具类 防止解析时异常 * @author Lemon */ public class JSON { - private static final String TAG = "JSON"; - /**判断json格式是否正确 - * @param s - * @return - */ - public static boolean isJsonCorrect(String s) { - //太长 Log.i(TAG, "isJsonCorrect <<<< " + s + " >>>>>>>"); - if (s == null - // || s.equals("[]") - // || s.equals("{}") - || s.equals("") - || s.equals("[null]") - || s.equals("{null}") - || s.equals("null")) { - return false; - } - return true; + static final String TAG = "JSON"; + + public static JSONParser, ? extends List> DEFAULT_JSON_PARSER; + + static { + //DEFAULT_JSON_PARSER = new JSONParser, List>() { + // + // @Override + // public LinkedHashMap createJSONObject() { + // throw new UnsupportedOperationException(); + // } + // + // @Override + // public List createJSONArray() { + // throw new UnsupportedOperationException(); + // } + // + // @Override + // public String toJSONString(Object obj, boolean format) { + // throw new UnsupportedOperationException(); + // } + // + // @Override + // public Object parse(Object json) { + // throw new UnsupportedOperationException(); + // } + // + // @Override + // public LinkedHashMap parseObject(Object json) { + // throw new UnsupportedOperationException(); + // } + // + // @Override + // public T parseObject(Object json, Class clazz) { + // throw new UnsupportedOperationException(); + // } + // + // @Override + // public List parseArray(Object json) { + // throw new UnsupportedOperationException(); + // } + // + // @Override + // public List parseArray(Object json, Class clazz) { + // throw new UnsupportedOperationException(); + // } + // + //}; + } - /**获取有效的json - * @param s - * @return - */ - public static String getCorrectJson(String s) { - return getCorrectJson(s, false); +// public static JSONCreator, ? extends List> DEFAULT_JSON_CREATOR = DEFAULT_JSON_PARSER; +// public static > M newObj() { +// return createJSONObject(); +// } +// public static > M newObj(String key, Object value) { +// return createJSONObject(key, value); +// } +// public static > M newObj(Map map) { +// return createJSONObject(map); +// } + + public static > M createJSONObject() { + return (M) DEFAULT_JSON_PARSER.createJSONObject(); } - /**获取有效的json - * @param s - * @param isArray - * @return - */ - public static String getCorrectJson(String s, boolean isArray) { - s = StringUtil.getTrimedString(s); - // if (isArray) { - // while (s.startsWith("\"")) { - // s = s.substring(1); - // } - // while (s.endsWith("\"")) { - // s = s.substring(0, s.length() - 1); - // } - // } - return s;//isJsonCorrect(s) ? s : null; + public static > M createJSONObject(String key, Object value) { + return (M) DEFAULT_JSON_PARSER.createJSONObject(key, value); + } + public static > M createJSONObject(Map map) { + return (M) DEFAULT_JSON_PARSER.createJSONObject(map); + } + + //public static > L newArr() { + // return createJSONArray(); + //} + //public static > L newArr(Object obj) { + // return createJSONArray(obj); + //} + //public static > L newArr(List list) { + // return createJSONArray(list); + //} + + public static > L createJSONArray() { + return (L) DEFAULT_JSON_PARSER.createJSONArray(); + } + public static > L createJSONArray(Object obj) { + return (L) DEFAULT_JSON_PARSER.createJSONArray(obj); + } + public static > L createJSONArray(Collection list) { + return (L) DEFAULT_JSON_PARSER.createJSONArray(list); + } + + public static Object parse(Object json) { + return DEFAULT_JSON_PARSER.parse(json); + } + + + public static > M parseObject(Object json) { + String s = toJSONString(json); + if (StringUtil.isEmpty(s, true)) { + return null; + } + + return (M) DEFAULT_JSON_PARSER.parseObject(s); + } + + public static T parseObject(Object json, Class clazz) { + String s = toJSONString(json); + if (StringUtil.isEmpty(s, true)) { + return null; + } + + return DEFAULT_JSON_PARSER.parseObject(s, clazz); } /** * @param json * @return */ - public static Object parse(Object obj) { - int features = com.alibaba.fastjson.JSON.DEFAULT_PARSER_FEATURE; - features |= Feature.OrderedField.getMask(); + public static > L parseArray(Object json) { + String s = toJSONString(json); + if (StringUtil.isEmpty(s, true)) { + return null; + } + try { - return com.alibaba.fastjson.JSON.parse(obj instanceof String ? (String) obj : toJSONString(obj), features); + L arr = (L) DEFAULT_JSON_PARSER.parseArray(s); + return arr; } catch (Exception e) { - Log.i(TAG, "parse catch \n" + e.getMessage()); + Log.i(TAG, "parseArray catch \n" + e.getMessage()); } return null; } - /**obj转JSONObject - * @param json - * @return - */ - public static JSONObject parseObject(Object obj) { - if (obj instanceof JSONObject) { - return (JSONObject) obj; + + public static List parseArray(Object json, Class clazz) { + String s = toJSONString(json); + if (StringUtil.isEmpty(s, true)) { + return null; } - return parseObject(toJSONString(obj)); - } - /**json转JSONObject - * @param json - * @return - */ - public static JSONObject parseObject(String json) { - int features = com.alibaba.fastjson.JSON.DEFAULT_PARSER_FEATURE; - features |= Feature.OrderedField.getMask(); - return parseObject(json, features); - } - /**json转JSONObject - * @param json - * @param features - * @return - */ - public static JSONObject parseObject(String json, int features) { + try { - return com.alibaba.fastjson.JSON.parseObject(getCorrectJson(json), JSONObject.class, features); + return DEFAULT_JSON_PARSER.parseArray(s, clazz); } catch (Exception e) { - Log.i(TAG, "parseObject catch \n" + e.getMessage()); + Log.i(TAG, "parseArray catch \n" + e.getMessage()); } return null; } - /**JSONObject转实体类 - * @param object - * @param clazz + /** + * @param obj * @return */ - public static T parseObject(JSONObject object, Class clazz) { - return parseObject(toJSONString(object), clazz); + public static String format(Object obj) { + return toJSONString(obj, true); } - /**json转实体类 - * @param json - * @param clazz + /** + * @param obj * @return */ - public static T parseObject(String json, Class clazz) { - if (clazz == null) { - Log.e(TAG, "parseObject clazz == null >> return null;"); - } else { - try { - int features = com.alibaba.fastjson.JSON.DEFAULT_PARSER_FEATURE; - features |= Feature.OrderedField.getMask(); - return com.alibaba.fastjson.JSON.parseObject(getCorrectJson(json), clazz, features); - } catch (Exception e) { - Log.i(TAG, "parseObject catch \n" + e.getMessage()); - } + public static String toJSONString(Object obj) { + return toJSONString(obj, false); + } + public static String toJSONString(Object obj, boolean format) { + if (obj == null) { + return null; } - return null; + + if (obj instanceof String) { + return (String) obj; + } + + //if (obj instanceof Map) { + // // Simple JSON object format + // StringBuilder sb = new StringBuilder("{"); + // @SuppressWarnings("unchecked") + // Map map = (Map) obj; + // boolean first = true; + // for (Map.Entry entry : map.entrySet()) { + // if (! first) { + // sb.append(","); + // } + // + // first = false; + // sb.append("\"").append(entry.getKey()).append("\":"); + // Object value = entry.getValue(); + // if (value instanceof String) { + // sb.append("\"").append(value).append("\""); + // } else { + // sb.append(toJSONString(value)); + // } + // } + // sb.append("}"); + // return sb.toString(); + //} + // + //if (obj instanceof List) { + // StringBuilder sb = new StringBuilder("["); + // @SuppressWarnings("unchecked") + // List list = (List) obj; + // boolean first = true; + // for (Object item : list) { + // if (! first) { + // sb.append(","); + // } + // first = false; + // if (item instanceof String) { + // sb.append("\"").append(item).append("\""); + // } else { + // sb.append(toJSONString(item)); + // } + // } + // sb.append("]"); + // return sb.toString(); + //} + + return DEFAULT_JSON_PARSER.toJSONString(obj, format); } - /**list转JSONArray - * @param list + + /**判断是否为JSONObject或JSONArray的isXxx方法名 + * @param key * @return */ - public static JSONArray parseArray(List list) { - return new JSONArray(list); + public static boolean isJSONType(String key) { + return key != null && key.startsWith("is") && key.length() > 2 && key.contains("JSON"); } - /**obj转JSONArray - * @param obj - * @return + + public static boolean isBoolOrNumOrStr(Object obj) { + return obj instanceof Boolean || obj instanceof Number || obj instanceof String; + } + + /** + * Get a value from a Map and convert to the specified type + * @param map Source map + * @param key The key + * @param Target type + * @return The converted value + */ + @SuppressWarnings("unchecked") + public static T get(Map map, String key) { + return map == null || key == null ? null : (T) map.get(key); + } + + /** + * Get a value from a Map and convert to the specified type + * @param map Source map + * @param key The key + * @param Target type + * @return The converted value + */ + @SuppressWarnings("unchecked") + public static > M getJSONObject(Map map, String key) { + Object obj = get(map, key); + return (M) obj; + } + + /** + * Get a value from a Map and convert to the specified type + * @param map Source map + * @param key The key + * @param Target type + * @return The converted value */ - public static JSONArray parseArray(Object obj) { - if (obj instanceof JSONArray) { - return (JSONArray) obj; + @SuppressWarnings("unchecked") + public static > L getJSONArray(Map map, String key) { + Object obj = get(map, key); + return (L) obj; + } + + /** + * Get a value from a Map and convert to the specified type + * @param list Source map + * @param index The key + * @param Target type + * @return The converted value + */ + @SuppressWarnings("unchecked") + public static T get(List list, int index) { + return list == null || index < 0 || index >= list.size() ? null : (T) list.get(index); + } + + @SuppressWarnings("unchecked") + public static > M getJSONObject(List list, int index) { + Object obj = get(list, index); + return (M) obj; + } + + @SuppressWarnings("unchecked") + public static > L getJSONArray(List list, int index) { + Object obj = get(list, index); + return (L) obj; + } + +// /** +// * Get a value from a Map and convert to the specified type +// * @param map Source map +// * @param key The key +// * @param Target type +// * @return The converted value +// */ +// @SuppressWarnings("unchecked") +// public static T get(List list, int index) { +// return list == null || index < 0 || index >= list.size() ? null : list.get(index); +// } + + /** + * Get a Map value from a Map + * @param map Source map + * @param key The key + * @return The Map value + * @throws IllegalArgumentException If value is not a Map and cannot be converted + */ + @SuppressWarnings("unchecked") + public static Map getMap(Map map, String key) throws IllegalArgumentException { + Object value = map == null || key == null ? null : map.get(key); + if (value == null) { + return null; + } + + if (value instanceof Map) { + return (Map) value; } - return parseArray(toJSONString(obj)); + + throw new IllegalArgumentException("Value for key '" + key + "' is not a Map: " + value.getClass().getName()); } - /**json转JSONArray - * @param json - * @return + + /** + * Get a List value from a Map + * @param map Source map + * @param key The key + * @return The List value + * @throws IllegalArgumentException If value is not a List and cannot be converted */ - public static JSONArray parseArray(String json) { - try { - return com.alibaba.fastjson.JSON.parseArray(getCorrectJson(json, true)); - } catch (Exception e) { - Log.i(TAG, "parseArray catch \n" + e.getMessage()); + @SuppressWarnings("unchecked") + public static List getList(Map map, String key) throws IllegalArgumentException { + Object value = map == null || key == null ? null : map.get(key); + if (value == null) { + return null; } - return null; + + if (value instanceof List) { + return (List) value; + } + + throw new IllegalArgumentException("Value for key '" + key + "' is not a List: " + value.getClass().getName()); } - /**JSONArray转实体类列表 - * @param array - * @param clazz - * @return + + /** + * Get an int value from a Map + * @param map Source map + * @param key The key + * @return The int value + * @throws IllegalArgumentException If value cannot be converted to int */ - public static List parseArray(JSONArray array, Class clazz) { - return parseArray(toJSONString(array), clazz); + public static Integer getInteger(Map map, String key) throws IllegalArgumentException { + Object value = map == null || key == null ? null : map.get(key); + if (value == null) { + return null; + } + + if (value instanceof Number) { + return ((Number) value).intValue(); + } + + if (value instanceof String) { + try { + return Integer.parseInt((String) value); + } catch (NumberFormatException e) { + throw new IllegalArgumentException("Cannot convert String value '" + value + "' to int: " + e.getMessage()); + } + } + + throw new IllegalArgumentException("Cannot convert value of type " + value.getClass().getName() + " to int"); } - /**json转实体类列表 - * @param json - * @param clazz - * @return + + /** + * Get an int value from a Map + * @param map Source map + * @param key The key + * @return The int value + * @throws IllegalArgumentException If value cannot be converted to int */ - public static List parseArray(String json, Class clazz) { - if (clazz == null) { - Log.e(TAG, "parseArray clazz == null >> return null;"); - } else { + public static int getIntValue(Map map, String key) throws IllegalArgumentException { + Object value = map == null || key == null ? null : map.get(key); + if (value == null) { + return 0; + } + + if (value instanceof Number) { + return ((Number) value).intValue(); + } + + if (value instanceof String) { try { - return com.alibaba.fastjson.JSON.parseArray(getCorrectJson(json, true), clazz); - } catch (Exception e) { - Log.i(TAG, "parseArray catch \n" + e.getMessage()); + return Integer.parseInt((String) value); + } catch (NumberFormatException e) { + throw new IllegalArgumentException("Cannot convert String value '" + value + "' to int: " + e.getMessage()); } } - return null; + + throw new IllegalArgumentException("Cannot convert value of type " + value.getClass().getName() + " to int"); } - /**实体类转json - * @param obj - * @return + /** + * Get an int value from a Map + * @param map Source map + * @param key The key + * @return The int value + * @throws IllegalArgumentException If value cannot be converted to int */ - public static String toJSONString(Object obj) { - if (obj instanceof String) { - return (String) obj; + public static Long getLong(Map map, String key) throws IllegalArgumentException { + Object value = map == null || key == null ? null : map.get(key); + if (value == null) { + return null; } - try { - return com.alibaba.fastjson.JSON.toJSONString(obj); - } catch (Exception e) { - Log.e(TAG, "toJSONString catch \n" + e.getMessage()); + + if (value instanceof Number) { + return ((Number) value).longValue(); } - return null; + + if (value instanceof String) { + try { + return Long.parseLong((String) value); + } catch (NumberFormatException e) { + throw new IllegalArgumentException("Cannot convert String value '" + value + "' to int: " + e.getMessage()); + } + } + + throw new IllegalArgumentException("Cannot convert value of type " + value.getClass().getName() + " to int"); } - /**实体类转json - * @param obj - * @param features - * @return + /** + * Get a long value from a Map + * @param map Source map + * @param key The key + * @return The long value + * @throws IllegalArgumentException If value cannot be converted to long */ - public static String toJSONString(Object obj, SerializerFeature... features) { - if (obj instanceof String) { - return (String) obj; + public static long getLongValue(Map map, String key) throws IllegalArgumentException { + Object value = map == null || key == null ? null : map.get(key); + if (value == null) { + return 0; } - try { - return com.alibaba.fastjson.JSON.toJSONString(obj, features); - } catch (Exception e) { - Log.e(TAG, "parseArray catch \n" + e.getMessage()); + + if (value instanceof Number) { + return ((Number) value).longValue(); } - return null; + + if (value instanceof String) { + try { + return Long.parseLong((String) value); + } catch (NumberFormatException e) { + throw new IllegalArgumentException("Cannot convert String value '" + value + "' to long: " + e.getMessage()); + } + } + + throw new IllegalArgumentException("Cannot convert value of type " + value.getClass().getName() + " to long"); } - /**格式化，显示更好看 - * @param json - * @return + /** + * Get a double value from a Map + * @param map Source map + * @param key The key + * @return The double value + * @throws IllegalArgumentException If value cannot be converted to double */ - public static String format(String json) { - return format(parse(json)); + public static Float getFloat(Map map, String key) throws IllegalArgumentException { + Object value = map == null || key == null ? null : map.get(key); + if (value == null) { + return null; + } + + if (value instanceof Number) { + return ((Number) value).floatValue(); + } + + if (value instanceof String) { + try { + return Float.parseFloat((String) value); + } catch (NumberFormatException e) { + throw new IllegalArgumentException("Cannot convert String value '" + value + "' to double: " + e.getMessage()); + } + } + + throw new IllegalArgumentException("Cannot convert value of type " + value.getClass().getName() + " to double"); } - /**格式化，显示更好看 - * @param object - * @return + + /** + * Get a double value from a Map + * @param map Source map + * @param key The key + * @return The double value + * @throws IllegalArgumentException If value cannot be converted to double */ - public static String format(Object object) { - return toJSONString(object, SerializerFeature.PrettyFormat); + public static float getFloatValue(Map map, String key) throws IllegalArgumentException { + Object value = map == null || key == null ? null : map.get(key); + if (value == null) { + return 0; + } + + if (value instanceof Number) { + return ((Number) value).floatValue(); + } + + if (value instanceof String) { + try { + return Float.parseFloat((String) value); + } catch (NumberFormatException e) { + throw new IllegalArgumentException("Cannot convert String value '" + value + "' to double: " + e.getMessage()); + } + } + + throw new IllegalArgumentException("Cannot convert value of type " + value.getClass().getName() + " to double"); } - /**判断是否为JSONObject - * @param obj instanceof String ? parseObject - * @return + + /** + * Get a double value from a Map + * @param map Source map + * @param key The key + * @return The double value + * @throws IllegalArgumentException If value cannot be converted to double */ - public static boolean isJSONObject(Object obj) { - if (obj instanceof JSONObject) { - return true; + public static Double getDouble(Map map, String key) throws IllegalArgumentException { + Object value = map == null || key == null ? null : map.get(key); + if (value == null) { + return null; } - if (obj instanceof String) { + + if (value instanceof Number) { + return ((Number) value).doubleValue(); + } + + if (value instanceof String) { try { - JSONObject json = parseObject((String) obj); - return json != null && json.isEmpty() == false; - } catch (Exception e) { - Log.e(TAG, "isJSONObject catch \n" + e.getMessage()); + return Double.parseDouble((String) value); + } catch (NumberFormatException e) { + throw new IllegalArgumentException("Cannot convert String value '" + value + "' to double: " + e.getMessage()); } } - return false; + throw new IllegalArgumentException("Cannot convert value of type " + value.getClass().getName() + " to double"); } - /**判断是否为JSONArray - * @param obj instanceof String ? parseArray - * @return + + /** + * Get a double value from a Map + * @param map Source map + * @param key The key + * @return The double value + * @throws IllegalArgumentException If value cannot be converted to double */ - public static boolean isJSONArray(Object obj) { - if (obj instanceof JSONArray) { - return true; + public static double getDoubleValue(Map map, String key) throws IllegalArgumentException { + Object value = map == null || key == null ? null : map.get(key); + if (value == null) { + return 0; } - if (obj instanceof String) { + + if (value instanceof Number) { + return ((Number) value).doubleValue(); + } + + if (value instanceof String) { try { - JSONArray json = parseArray((String) obj); - return json != null && json.isEmpty() == false; - } catch (Exception e) { - Log.e(TAG, "isJSONArray catch \n" + e.getMessage()); + return Double.parseDouble((String) value); + } catch (NumberFormatException e) { + throw new IllegalArgumentException("Cannot convert String value '" + value + "' to double: " + e.getMessage()); } } - return false; + throw new IllegalArgumentException("Cannot convert value of type " + value.getClass().getName() + " to double"); } - /**判断是否为 Boolean,Number,String 中的一种 - * @param obj - * @return + + /** + * Get a boolean value from a Map + * @param map Source map + * @param key The key + * @return The boolean value + * @throws IllegalArgumentException If value cannot be converted to boolean */ - public static boolean isBooleanOrNumberOrString(Object obj) { - return obj instanceof Boolean || obj instanceof Number || obj instanceof String; + public static Boolean getBoolean(Map map, String key) throws IllegalArgumentException { + Object value = map == null || key == null ? null : map.get(key); + if (value == null) { + return null; + } + + if (value instanceof Boolean) { + return (Boolean) value; + } + + if (value instanceof String) { + String str = ((String) value).toLowerCase(); + if (str.equals("true") || str.equals("false")) { + return Boolean.parseBoolean(str); + } + throw new IllegalArgumentException("Cannot convert String value '" + value + "' to boolean"); + } + + if (value instanceof Number) { + int intValue = ((Number) value).intValue(); + if (intValue == 0 || intValue == 1) { + return intValue != 0; + } + throw new IllegalArgumentException("Cannot convert Number value '" + value + "' to boolean. Only 0 and 1 are supported."); + } + + throw new IllegalArgumentException("Cannot convert value of type " + value.getClass().getName() + " to boolean"); + } + + /** + * Get a boolean value from a Map + * @param map Source map + * @param key The key + * @return The boolean value + * @throws IllegalArgumentException If value cannot be converted to boolean + */ + public static boolean getBooleanValue(Map map, String key) throws IllegalArgumentException { + Object value = map == null || key == null ? null : map.get(key); + if (value == null) { + return false; + } + + if (value instanceof Boolean) { + return (Boolean) value; + } + + if (value instanceof String) { + String str = ((String) value).toLowerCase(); + if (str.equals("true") || str.equals("false")) { + return Boolean.parseBoolean(str); + } + throw new IllegalArgumentException("Cannot convert String value '" + value + "' to boolean"); + } + + if (value instanceof Number) { + int intValue = ((Number) value).intValue(); + if (intValue == 0 || intValue == 1) { + return intValue != 0; + } + throw new IllegalArgumentException("Cannot convert Number value '" + value + "' to boolean. Only 0 and 1 are supported."); + } + + throw new IllegalArgumentException("Cannot convert value of type " + value.getClass().getName() + " to boolean"); + } + + /** + * Get a string value from a Map + * @param map Source map + * @param key The key + * @return The string value + */ + public static String getString(Map map, String key) { + Object value = map == null || key == null ? null : map.get(key); + if (value == null) { + return null; + } + + return value.toString(); + } + + + public static Object getFromObjOrArr(Object parent, String k) { + if (parent instanceof Map) { + return ((Map) parent).get(k); + } + + if (parent instanceof List) { + int j = Integer.valueOf(k); + return ((List) parent).get(j); + } + + return null; } } diff --git a/APIJSONORM/src/main/java/apijson/JSONCreator.java b/APIJSONORM/src/main/java/apijson/JSONCreator.java new file mode 100755 index 000000000..df0d9066a --- /dev/null +++ b/APIJSONORM/src/main/java/apijson/JSONCreator.java @@ -0,0 +1,54 @@ +/*Copyright (C) 2020 Tencent. All rights reserved. + +This source code is licensed under the Apache License Version 2.0.*/ + + +package apijson; + +import java.util.Collection; +import java.util.List; +import java.util.Map; + +/**JSON相关创建器 + * @author Lemon + */ +public interface JSONCreator, L extends List> { + + @NotNull + M createJSONObject(); + + @NotNull + default M createJSONObject(String key, Object value) { + M obj = createJSONObject(); + obj.put(key, value); + return obj; + } + + @NotNull + default M createJSONObject(Map map) { + M obj = createJSONObject(); + if (map != null && ! map.isEmpty()) { + obj.putAll(map); + } + return obj; + } + + @NotNull + L createJSONArray(); + + @NotNull + default L createJSONArray(Object obj){ + L arr = createJSONArray(); + arr.add(obj); + return arr; + } + + @NotNull + default L createJSONArray(Collection list){ + L arr = createJSONArray(); + if (list != null && ! list.isEmpty()) { + arr.addAll(list); + } + return arr; + } +} diff --git a/APIJSONORM/src/main/java/apijson/JSONList.java b/APIJSONORM/src/main/java/apijson/JSONList.java new file mode 100644 index 000000000..092bf9f39 --- /dev/null +++ b/APIJSONORM/src/main/java/apijson/JSONList.java @@ -0,0 +1,312 @@ +/*Copyright (C) 2020 Tencent. All rights reserved. + +This source code is licensed under the Apache License Version 2.0.*/ + +package apijson; + +import java.util.*; + +/** + * Custom JSONList implementation based on ArrayList to replace com.alibaba.fastjson.JSONList + * Maintains same API as fastjson but uses standard Java List implementation + * @author Lemon + */ +public interface JSONList, L extends List> extends List { + public static final String TAG = "JSONList"; + + ///** + // * Create an empty JSONList + // */ + //default JSONList() { + // super(); + //} + // + //private int initialCapacity = 10; + ///** + // * Create a JSONList with initial capacity + // * @param initialCapacity the initial capacity + // */ + //default JSONList(int initialCapacity) { + // super(initialCapacity); + //} + // + ///** + // * Create a JSONList from a Collection + // * @param collection the collection to copy from + // */ + //default JSONList(Collection collection) { + // super(collection); + //} + // + ///** + // * Create a JSONList from a JSON string + // * @param json JSON string + // */ + //default JSONList(String json) { + // this(); + // List list = JSON.parseArray(json); + // if (list != null) { + // addAll(list); + // } + //} + // + /** + * Get a JSONMap at the specified index + * @param index the index + * @return the JSONMap or null if not a JSONMap + */ + default M getJSONObject(int index) { + if (index < 0 || index >= size()) { + return null; + } + + Object obj = get(index); + if (obj instanceof Map) { + return JSON.createJSONObject((Map) obj); + } + + return null; + } + + /** + * Get a JSONList at the specified index + * @param index the index + * @return the JSONList or null if not a JSONList + */ + default L getJSONArray(int index) { + if (index < 0 || index >= size()) { + return null; + } + + Object obj = get(index); + if (obj instanceof List) { + return JSON.createJSONArray((List) obj); + } + + return null; + } + + /** + * Get a boolean value at the specified index + * @param index the index + * @return the boolean value or false if not found + */ + default boolean getBooleanValue(int index) { + if (index < 0 || index >= size()) { + return false; + } + + Object obj = get(index); + if (obj instanceof Boolean) { + return (Boolean) obj; + } else if (obj instanceof Number) { + return ((Number) obj).intValue() != 0; + } else if (obj instanceof String) { + return Boolean.parseBoolean((String) obj); + } + + return false; + } + + /** + * Get an integer value at the specified index + * @param index the index + * @return the integer value or 0 if not found + */ + default int getIntValue(int index) { + if (index < 0 || index >= size()) { + return 0; + } + + Object obj = get(index); + if (obj instanceof Number) { + return ((Number) obj).intValue(); + } else if (obj instanceof String) { + try { + return Integer.parseInt((String) obj); + } catch (NumberFormatException e) { + // Ignore + } + } + return 0; + } + + /** + * Get a long value at the specified index + * @param index the index + * @return the long value or 0 if not found + */ + default long getLongValue(int index) { + if (index < 0 || index >= size()) { + return 0L; + } + + Object obj = get(index); + if (obj instanceof Number) { + return ((Number) obj).longValue(); + } else if (obj instanceof String) { + try { + return Long.parseLong((String) obj); + } catch (NumberFormatException e) { + // Ignore + } + } + return 0L; + } + + /** + * Get a double value at the specified index + * @param index the index + * @return the double value or 0 if not found + */ + default double getDoubleValue(int index) { + if (index < 0 || index >= size()) { + return 0.0; + } + + Object obj = get(index); + if (obj instanceof Number) { + return ((Number) obj).doubleValue(); + } else if (obj instanceof String) { + try { + return Double.parseDouble((String) obj); + } catch (NumberFormatException e) { + // Ignore + } + } + return 0.0; + } + + /** + * Get a string value at the specified index + * @param index the index + * @return the string value or null if not found + */ + default String getString(int index) { + if (index < 0 || index >= size()) { + return null; + } + + Object obj = get(index); + return obj != null ? obj.toString() : null; + } + + + default String toJSONString() { + return JSON.toJSONString(this); + } + + //@Override + //default boolean containsAll(Collection c) { + // if (c == null || c.isEmpty()) { + // return true; + // } + // return super.containsAll(c); + //} + // + //@Override + //default boolean addAll(Collection c) { + // if (c == null || c.isEmpty()) { + // return true; + // } + // return super.addAll(c); + //} + // + //@Override + //default boolean addAll(int index, Collection c) { + // if (c == null || c.isEmpty()) { + // return true; + // } + // + // int sz = size(); + // if (index < 0 || index >= sz) { + // index += sz; + // } + // + // return super.addAll(index, c); + //} + // + //@Override + //default boolean removeAll(Collection c) { + // if (c == null || c.isEmpty()) { + // return true; + // } + // return super.removeAll(c); + //} + // + //@Override + //default boolean retainAll(Collection c) { + // if (c == null || c.isEmpty()) { + // return true; + // } + // return super.retainAll(c); + //} + // + // + //@Override + //default Object get(int index) { + // int sz = size(); + // if (index < 0 || index >= sz) { + // index += sz; + // } + // + // return super.get(index); + //} + // + //@Override + //default Object set(int index, Object element) { + // int sz = size(); + // if (index < 0 || index >= sz) { + // index += sz; + // } + // + // return super.set(index, element); + //} + // + //@Override + //default void add(int index, Object element) { + // int sz = size(); + // if (index < 0 || index >= sz) { + // index += sz; + // } + // + // super.add(index, element); + //} + // + //@Override + //default Object remove(int index) { + // int sz = size(); + // if (index < 0 && index >= -sz) { + // index += sz; + // } + // if (index < 0 || index >= sz) { + // return null; + // } + // + // return super.remove(index); + //} + // + //@Override + //default ListIterator listIterator(int index) { + // int sz = size(); + // if (index < 0 && index >= -sz) { + // index += sz; + // } + // + // return super.listIterator(index); + //} + // + //@Override + //default List subList(int fromIndex, int toIndex) { + // int sz = size(); + // if (fromIndex < 0 && fromIndex >= -sz) { + // fromIndex += sz; + // } + // if (toIndex < 0 && toIndex >= -sz) { + // toIndex += sz; + // } + // + // return super.subList(fromIndex, toIndex); + //} + +} \ No newline at end of file diff --git a/APIJSONORM/src/main/java/apijson/JSONMap.java b/APIJSONORM/src/main/java/apijson/JSONMap.java new file mode 100755 index 000000000..29d88f756 --- /dev/null +++ b/APIJSONORM/src/main/java/apijson/JSONMap.java @@ -0,0 +1,810 @@ +/*Copyright (C) 2020 Tencent. All rights reserved. + +This source code is licensed under the Apache License Version 2.0.*/ + + +package apijson; + +import java.util.*; + + +/**use this class instead of com.alibaba.fastjson.JSONMap + * @author Lemon + * @see #put + * @see #puts + * @see #putsAll + */ +//default class JSONMap extends LinkedHashMap { +public interface JSONMap, L extends List> extends Map { + static final String TAG = "JSONMap"; + + // 只能是 static public Map map = new LinkedHashMap<>(); + + ///**ordered + // */ + //default JSONMap() { + // super(); + //} + ///**transfer Object to JSONMap + // * @param object + // * @see {@link #JSONMap(Object)} + // */ + //default JSONMap(Object object) { + // this(); + // if (object instanceof Map) { + // @SuppressWarnings("unchecked") + // Map map = (Map) object; + // putAll(map); + // } else if (object != null) { + // String json = JSON.toJSONString(object); + // if (json != null) { + // Map map = JSON.parseObject(json); + // if (map != null) { + // putAll(map); + // } + // } + // } + //} + ///**parse JSONMap with JSON String + // * @param json + // * @see {@link #JSONMap(String)} + // */ + //default JSONMap(String json) { + // this(); + // Map map = JSON.parseObject(json); + // if (map != null) { + // putAll(map); + // } + //} + ///**transfer com.alibaba.fastjson.JSONMap to JSONMap + // * @param object + // * @see {@link #putsAll(Map)} + // */ + //default JSONMap(Map object) { + // this(); + // putsAll(object); + //} + + //public static JSONMap valueOf(Object obj) { + // JSONMap req = new JSONMap() {}; + // Map m = JSON.parseObject(obj); + // if (m != null && ! m.isEmpty()) { + // req.map.putAll(m); + // } + // return req; + //} + + //judge <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< + String KEY_ARRAY = "[]"; + + /**判断是否为Array的key + * @param key + * @return + */ + public static boolean isArrayKey(String key) { + return key != null && key.endsWith(KEY_ARRAY); + } + /**判断是否为对应Table的key + * @param key + * @return + */ + public static boolean isTableKey(String key) { + return StringUtil.isBigName(key); + } + /**判断是否为对应Table数组的 key + * @param key + * @return + */ + public static boolean isTableArray(String key) { + return isArrayKey(key) && isTableKey(key.substring(0, key.length() - KEY_ARRAY.length())); + } + //judge >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>> + + + //JSONObject内关键词 key <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< + + + public static String KEY_ID = "id"; + public static String KEY_ID_IN = KEY_ID + "{}"; + public static String KEY_USER_ID = "userId"; + public static String KEY_USER_ID_IN = KEY_USER_ID + "{}"; + + /**set "id":id in Table layer + * @param id + * @return + */ + default JSONMap setId(Long id) { + return puts(KEY_ID, id); + } + /**set "id{}":[] in Table layer + * @param list + * @return + */ + default JSONMap setIdIn(List list) { + return puts(KEY_ID_IN, list); + } + + /**set "userId":userId in Table layer + * @param id + * @return + */ + default JSONMap setUserId(Long id) { + return puts(KEY_USER_ID, id); + } + /**set "userId{}":[] in Table layer + * @param list + * @return + */ + default JSONMap setUserIdIn(List list) { + return puts(KEY_USER_ID_IN, list); + } + + + int CACHE_ALL = 0; + int CACHE_ROM = 1; + int CACHE_RAM = 2; + + String CACHE_ALL_STRING = "ALL"; + String CACHE_ROM_STRING = "ROM"; + String CACHE_RAM_STRING = "RAM"; + + + //@key关键字都放这个类 <<<<<<<<<<<<<<<<<<<<<< + String KEY_TRY = "@try"; //尝试，忽略异常 + String KEY_CATCH = "@catch"; //TODO 捕捉到异常后，处理方式 null-不处理；DEFAULT-返回默认值；ORIGIN-返回请求里的原始值 + String KEY_DROP = "@drop"; //丢弃，不返回，TODO 应该通过 fastjson 的 ignore 之类的机制来处理，避免导致下面的对象也不返回 + // String KEY_KEEP = "@keep"; //一定会返回，为 null 或 空对象时，会使用默认值(非空)，解决其它对象因为不关联的第一个对为空导致也不返回 + String KEY_DEFULT = "@default"; //TODO 自定义默认值 { "@default":true }，@default 可完全替代 @keep + String KEY_NULL = "@null"; //值为 null 的键值对 "@null":"tag,pictureList"，允许 is NULL 条件判断， SET tag = NULL 修改值为 NULL 等 + String KEY_CAST = "@cast"; //类型转换 cast(date AS DATE) + + String KEY_ROLE = "@role"; //角色，拥有对某些数据的某些操作的权限 + String KEY_DATABASE = "@database"; //数据库类型，默认为MySQL + String KEY_DATASOURCE = "@datasource"; //数据源 + String KEY_NAMESPACE = "@namespace"; //命名空间，Table 在非默认 namespace 内时需要声明 + String KEY_CATALOG = "@catalog"; //目录，Table 在非默认 catalog 内时需要声明 + String KEY_SCHEMA = "@schema"; //数据库，Table 在非默认 schema 内时需要声明 + String KEY_EXPLAIN = "@explain"; //分析 true/false + String KEY_CACHE = "@cache"; //缓存 RAM/ROM/ALL + String KEY_COLUMN = "@column"; //查询的Table字段或SQL函数 + String KEY_FROM = "@from"; //FROM语句 + String KEY_COMBINE = "@combine"; //条件组合，每个条件key前面可以放&,|,!逻辑关系 "id!{},&sex,!name&$" + String KEY_GROUP = "@group"; //分组方式 + String KEY_HAVING = "@having"; //聚合函数条件，一般和@group一起用 + String KEY_HAVING_AND = "@having&"; //聚合函数条件，一般和@group一起用 + String KEY_SAMPLE = "@sample"; //取样方式 + String KEY_LATEST = "@latest"; //最近方式 + String KEY_PARTITION = "@partition"; //分区方式 + String KEY_FILL = "@fill"; //填充方式 + String KEY_ORDER = "@order"; //排序方式 + String KEY_KEY = "@key"; // key 映射，year:left(date,4);name_tag:(name,tag) + String KEY_RAW = "@raw"; // 自定义原始 SQL 片段 + String KEY_JSON = "@json"; //SQL Server 把字段转为 JSON 输出 + String KEY_METHOD = "@method"; // json 对象配置操作方法 + String KEY_GET = "@get"; // json 对象配置操作方法 + String KEY_GETS = "@gets"; // json 对象配置操作方法 + String KEY_HEAD = "@head"; // json 对象配置操作方法 + String KEY_HEADS = "@heads"; // json 对象配置操作方法 + String KEY_POST = "@post"; // json 对象配置操作方法 + String KEY_PUT = "@put"; // json 对象配置操作方法 + String KEY_DELETE = "@delete"; // json 对象配置操作方法 + + List TABLE_KEY_LIST = new ArrayList<>(Arrays.asList( + KEY_ROLE, + KEY_DATABASE, + KEY_DATASOURCE, + KEY_NAMESPACE, + KEY_CATALOG, + KEY_SCHEMA, + KEY_EXPLAIN, + KEY_CACHE, + KEY_COLUMN, + KEY_FROM, + KEY_NULL, + KEY_CAST, + KEY_COMBINE, + KEY_GROUP, + KEY_HAVING, + KEY_HAVING_AND, + KEY_SAMPLE, + KEY_LATEST, + KEY_PARTITION, + KEY_FILL, + KEY_ORDER, + KEY_KEY, + KEY_RAW, + KEY_JSON, + KEY_METHOD, + KEY_GET, + KEY_GETS, + KEY_HEAD, + KEY_HEADS, + KEY_POST, + KEY_PUT, + KEY_DELETE + )); + + //@key关键字都放这个类 >>>>>>>>>>>>>>>>>>>>>> + + + /**set try, ignore exceptions + * @param tri + * @return this + */ + default JSONMap setTry(Boolean tri) { + return puts(KEY_TRY, tri); + } + + /**set catch + * @param isCatch + * @return this + */ + default JSONMap setCatch(String isCatch) { + return puts(KEY_CATCH, isCatch); + } + /**set drop, data dropped will not return + * @param drop + * @return this + */ + default JSONMap setDrop(Boolean drop) { + return puts(KEY_DROP, drop); + } + + /**set if has default + * @param hasDefault + * @return this + */ + default JSONMap setDefault(Boolean hasDefault) { + return puts(KEY_DEFULT, hasDefault); + } + + + /**set role of request sender + * @param role + * @return this + */ + default JSONMap setRole(String role) { + return puts(KEY_ROLE, role); + } + /**set database where table was puts + * @param database + * @return this + */ + default JSONMap setDatabase(String database) { + return puts(KEY_DATABASE, database); + } + /**set datasource where table was puts + * @param datasource + * @return this + */ + default JSONMap setDatasource(String datasource) { + return puts(KEY_DATASOURCE, datasource); + } + /**set namespace where table was puts + * @param namespace + * @return this + */ + default JSONMap setNamespace(String namespace) { + return puts(KEY_NAMESPACE, namespace); + } + /**set catalog where table was puts + * @param catalog + * @return this + */ + default JSONMap setCatalog(String catalog) { + return puts(KEY_CATALOG, catalog); + } + /**set schema where table was puts + * @param schema + * @return this + */ + default JSONMap setSchema(String schema) { + return puts(KEY_SCHEMA, schema); + } + /**set if return explain informations + * @param explain + * @return + */ + default JSONMap setExplain(Boolean explain) { + return puts(KEY_EXPLAIN, explain); + } + /**set cache type + * @param cache + * @return + * @see {@link #CACHE_ALL} + * @see {@link #CACHE_RAM} + * @see {@link #CACHE_ROM} + */ + default JSONMap setCache(Integer cache) { + return puts(KEY_CACHE, cache); + } + /**set cache type + * @param cache + * @return + * @see {@link #CACHE_ALL_STRING} + * @see {@link #CACHE_RAM_STRING} + * @see {@link #CACHE_ROM_STRING} + */ + default JSONMap setCache(String cache) { + return puts(KEY_CACHE, cache); + } + + /**set keys need to be returned + * @param keys key0, key1, key2 ... + * @return {@link #setColumn(String)} + */ + default JSONMap setColumn(String... keys) { + return setColumn(StringUtil.get(keys, true)); + } + /**set keys need to be returned + * @param keys "key0,key1,key2..." + * @return + */ + default JSONMap setColumn(String keys) { + return puts(KEY_COLUMN, keys); + } + + /**set keys whose value is null + * @param keys key0, key1, key2 ... + * @return {@link #setNull(String)} + */ + default JSONMap setNull(String... keys) { + return setNull(StringUtil.get(keys, true)); + } + /**set keys whose value is null + * @param keys "key0,key1,key2..." + * @return + */ + default JSONMap setNull(String keys) { + return puts(KEY_NULL, keys); + } + + /**set keys and types whose value should be cast to type, cast(value AS DATE) + * @param keyTypes key0:type0, key1:type1, key2:type2 ... + * @return {@link #setCast(String)} + */ + default JSONMap setCast(String... keyTypes) { + return setCast(StringUtil.get(keyTypes, true)); + } + /**set keys and types whose value should be cast to type, cast(value AS DATE) + * @param keyTypes "key0:type0,key1:type1,key2:type2..." + * @return + */ + default JSONMap setCast(String keyTypes) { + return puts(KEY_CAST, keyTypes); + } + + /**set combination of keys for conditions + * @param keys key0,&key1,|key2,!key3 ... TODO or key0> | (key1{} & !key2)... + * @return {@link #setColumn(String)} + */ + default JSONMap setCombine(String... keys) { + return setCombine(StringUtil.get(keys, true)); + } + /**set combination of keys for conditions + * @param keys key0,&key1,|key2,!key3 ... TODO or key0> | (key1{} & !key2)... + * @return + */ + default JSONMap setCombine(String keys) { + return puts(KEY_COMBINE, keys); + } + + /**set keys for group by + * @param keys key0, key1, key2 ... + * @return {@link #setGroup(String)} + */ + default JSONMap setGroup(String... keys) { + return setGroup(StringUtil.get(keys, true)); + } + /**set keys for group by + * @param keys "key0,key1,key2..." + * @return + */ + default JSONMap setGroup(String keys) { + return puts(KEY_GROUP, keys); + } + + /**set keys for having + * @param keys count(key0) > 1, sum(key1) <= 5, function2(key2) ? value2 ... + * @return {@link #setHaving(String)} + */ + default JSONMap setHaving(String... keys) { + return setHaving(StringUtil.get(keys, true)); + } + /**set keys for having + * @param keys "key0,key1,key2..." + * @return + */ + default JSONMap setHaving(String keys) { + return setHaving(keys, false); + } + /**set keys for having + * @param keys "key0,key1,key2..." + * @return + */ + default JSONMap setHaving(String keys, boolean isAnd) { + return puts(isAnd ? KEY_HAVING_AND : KEY_HAVING, keys); + } + + /**set keys for sample by + * @param keys key0, key1, key2 ... + * @return {@link #setSample(String)} + */ + default JSONMap setSample(String... keys) { + return setSample(StringUtil.get(keys, true)); + } + /**set keys for sample by + * @param keys "key0,key1,key2..." + * @return + */ + default JSONMap setSample(String keys) { + return puts(KEY_SAMPLE, keys); + } + + /**set keys for latest on + * @param keys key0, key1, key2 ... + * @return {@link #setLatest(String)} + */ + default JSONMap setLatest(String... keys) { + return setLatest(StringUtil.get(keys, true)); + } + /**set keys for latest on + * @param keys "key0,key1,key2..." + * @return + */ + default JSONMap setLatest(String keys) { + return puts(KEY_LATEST, keys); + } + + /**set keys for partition by + * @param keys key0, key1, key2 ... + * @return {@link #setPartition(String)} + */ + default JSONMap setPartition(String... keys) { + return setPartition(StringUtil.get(keys, true)); + } + /**set keys for partition by + * @param keys key0, key1, key2 ... + * @return + */ + default JSONMap setPartition(String keys) { + return puts(KEY_PARTITION, keys); + } + + /**set keys for fill(key): fill(null), fill(linear), fill(prev) + * @param keys key0, key1, key2 ... + * @return {@link #setFill(String)} + */ + default JSONMap setFill(String... keys) { + return setFill(StringUtil.get(keys, true)); + } + /**set keys for fill(key): fill(null), fill(linear), fill(prev) + * @param keys key0, key1, key2 ... + * @return + */ + default JSONMap setFill(String keys) { + return puts(KEY_FILL, keys); + } + + /**set keys for order by + * @param keys key0, key1+, key2- ... + * @return {@link #setOrder(String)} + */ + default JSONMap setOrder(String... keys) { + return setOrder(StringUtil.get(keys, true)); + } + /**set keys for order by + * @param keys "key0,key1+,key2-..." + * @return + */ + default JSONMap setOrder(String keys) { + return puts(KEY_ORDER, keys); + } + + /**set key map + * @param keyMap "name_tag:(name,tag);year:left(date,1,5)..." + * @return + */ + default JSONMap setKey(String keyMap) { + return puts(KEY_KEY, keyMap); + } + + /**set keys to raw + * @param keys "key0,key1,key2..." + * @return + */ + default JSONMap setRaw(String keys) { + return puts(KEY_RAW, keys); + } + + /**set keys to cast to json + * @param keys "key0,key1,key2..." + * @return + */ + default JSONMap setJson(String keys) { + return puts(KEY_JSON, keys); + } + + //JSONObject内关键词 key >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>> + + + + //Request <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< + + + /** + * @param key + * @param keys path = keys[0] + "/" + keys[1] + "/" + keys[2] + ... + * @return {@link #puts(String, Object)} + */ + default JSONMap putsPath(String key, String... keys) { + return puts(key+"@", StringUtil.get(keys, "/")); + } + + /** + * @param key + * @param isNull + * @return {@link #puts(String, Object)} + */ + default JSONMap putsNull(String key, boolean isNull) { + return puts(key+"{}", SQL.isNull(isNull)); + } + /** + * trim = false + * @param key + * @param isEmpty + * @return {@link #putsEmpty(String, boolean, boolean)} + */ + default JSONMap putsEmpty(String key, boolean isEmpty) { + return putsEmpty(key, isEmpty, false); + } + /** + * @param key + * @param isEmpty + * @return {@link #puts(String, Object)} + */ + default JSONMap putsEmpty(String key, boolean isEmpty, boolean trim) { + return puts(key+"{}", SQL.isEmpty(key, isEmpty, trim)); + } + /** + * @param key + * @param compare <=0, >5 ... + * @return {@link #puts(String, Object)} + */ + default JSONMap putsLength(String key, String compare) { + return puts(key+"{}", SQL.length(key) + compare); + } + /** + * @param key + * @param compare <=, > ... + * @param value 1, 5, 3.14, -99 ... + * @return {@link #puts(String, Object)} + */ + default JSONMap putsLength(String key, String compare, Object value) { + return puts(key+"["+(StringUtil.isEmpty(compare) || "=".equals(compare) ? "" : ("!=".equals(compare) ? "!" : compare)), value); + } + /** + * @param key + * @param compare <=0, >5 ... + * @return {@link #puts(String, Object)} + */ + default JSONMap putsJSONLength(String key, String compare) { + return puts(key+"{}", SQL.json_length(key) + compare); + } + /** + * @param key + * @param compare <=0, >5 ... + * @return {@link #puts(String, Object)} + */ + default JSONMap putsJSONLength(String key, String compare, Object value) { + return puts(key + "{" + (StringUtil.isEmpty(compare) || "=".equals(compare) ? "" : ("!=".equals(compare) ? "!" : compare)), value); + } + + /**设置搜索 + * type = SEARCH_TYPE_CONTAIN_FULL + * @param key + * @param value + * @return {@link #putsSearch(String, String, int)} + */ + default JSONMap putsSearch(String key, String value) { + return putsSearch(key, value, SQL.SEARCH_TYPE_CONTAIN_FULL); + } + /**设置搜索 + * @param key + * @param value + * @param type + * @return {@link #puts(String, Object)} + */ + default JSONMap putsSearch(String key, String value, int type) { + return puts(key+"$", SQL.search(value, type)); + } + + //Request >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>> + + /**put and return this + * @param value must be annotated by {@link MethodAccess} + * @return {@link #puts(String, Object)} + */ + default JSONMap puts(Object value) { + put(value); + return this; + } + /**put and return this + * @param key + * @param value + * @return this + */ + default JSONMap puts(String key, Object value) { + put(key, value); + return this; + } + + /**put and return value + * @param value must be annotated by {@link MethodAccess} + */ + default Object put(Object value) { + Class clazz = value.getClass(); //should not return null + if (clazz.getAnnotation(MethodAccess.class) == null) { + throw new IllegalArgumentException("puts StringUtil.isEmpty(key, true)" + + " clazz.getAnnotation(MethodAccess.class) == null" + + " \n key为空时仅支持 类型被@MethodAccess注解 的value !!!" + + " \n 如果一定要这么用，请对 " + clazz.getName() + " 注解！" + + " \n 如果是类似 key[]:{} 结构的请求，建议用 putsAll(...) ！"); + } + return put(clazz.getSimpleName(), value); + } + + /**puts key-value in object into this + * @param map + * @return this + */ + default JSONMap putsAll(Map map) { + putAll(map); + return this; + } + + + /** + * Get a boolean value from the JSONMap + * @param key the key + * @return the boolean value or false if not found + */ + default boolean getBooleanValue(String key) { + return JSON.getBooleanValue(this, key); + } + + /** + * Get an integer value from the JSONMap + * @param key the key + * @return the integer value or 0 if not found + */ + default int getIntValue(String key) { + return JSON.getIntValue(this, key); + } + + /** + * Get a long value from the JSONMap + * @param key the key + * @return the long value or 0 if not found + */ + default long getLongValue(String key) { + return JSON.getLongValue(this, key); + } + + /** + * Get a double value from the JSONMap + * @param key the key + * @return the double value or 0 if not found + */ + default double getDoubleValue(String key) { + return JSON.getDoubleValue(this, key); + } + + /** + * Get a string value from the JSONMap + * @param key the key + * @return the string value or null if not found + */ + default String getString(String key) { + Object value = get(key); + return value != null ? value.toString() : null; + } + + /** + * Get a JSONMap value from the JSONMap + * @param key the key + * @return the JSONMap value or null if not found + */ + default M getJSONObject(String key) { + Map map = JSON.getMap(this, key); + return map != null ? JSON.createJSONObject(map) : null; + } + + /** + * Get a JSONList value from the JSONMap + * @param key the key + * @return the JSONList value or null if not found + */ + default L getJSONArray(String key) { + List list = JSON.getList(this, key); + return list != null ? JSON.createJSONArray(list) : null; + } + + @Override + default void putAll(Map map) { + Set> set = map == null ? null : map.entrySet(); + if (set != null || set.isEmpty()) { + return; + } + + for (Map.Entry entry : set) { + put(entry.getKey(), entry.getValue()); + } + } + + default String toJSONString() { + return JSON.toJSONString(this); + } + + //@Override + //default int size() { + // return map.size(); + //} + // + //@Override + //default boolean isEmpty() { + // return map.isEmpty(); + //} + // + //@Override + //default boolean containsKey(Object key) { + // return map.containsKey(key); + //} + // + //@Override + //default boolean containsValue(Object value) { + // return map.containsValue(value); + //} + // + //@Override + //default Object get(Object key) { + // return map.get(key); + //} + // + //@Override + //default Object put(String key, Object value) { + // return map.put(key, value); + //} + // + //@Override + //default Object remove(Object key) { + // return map.remove(key); + //} + + + //@Override + //default void clear() { + // map.clear(); + //} + // + //@Override + //default Set keySet() { + // return map.keySet(); + //} + // + //@Override + //default Collection values() { + // return map.values(); + //} + // + //@Override + //default Set> entrySet() { + // return map.entrySet(); + //} + + //@Override + //default String toString() { + // return JSON.toJSONString(this); + //} + +} diff --git a/APIJSONORM/src/main/java/apijson/JSONObject.java b/APIJSONORM/src/main/java/apijson/JSONObject.java deleted file mode 100755 index 75ca4256d..000000000 --- a/APIJSONORM/src/main/java/apijson/JSONObject.java +++ /dev/null @@ -1,498 +0,0 @@ -/*Copyright (C) 2020 THL A29 Limited, a Tencent company. All rights reserved. - -This source code is licensed under the Apache License Version 2.0.*/ - - -package apijson; - -import java.util.ArrayList; -import java.util.List; -import java.util.Map; - -/**use this class instead of com.alibaba.fastjson.JSONObject - * @author Lemon - * @see #put - * @see #puts - * @see #putsAll - */ -public class JSONObject extends com.alibaba.fastjson.JSONObject { - private static final long serialVersionUID = 1L; - - private static final String TAG = "JSONObject"; - - - /**ordered - */ - public JSONObject() { - super(true); - } - /**transfer Object to JSONObject - * @param object - * @see {@link #JSONObject(Object)} - */ - public JSONObject(Object object) { - this(toJSONString(object)); - } - /**parse JSONObject with JSON String - * @param json - * @see {@link #JSONObject(String)} - */ - public JSONObject(String json) { - this(parseObject(json)); - } - /**transfer com.alibaba.fastjson.JSONObject to JSONObject - * @param object - * @see {@link #putsAll(Map)} - */ - public JSONObject(com.alibaba.fastjson.JSONObject object) { - this(); - putsAll(object); - } - - - - - //judge <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< - public static final String KEY_ARRAY = "[]"; - - /**判断是否为Array的key - * @param key - * @return - */ - public static boolean isArrayKey(String key) { - return key != null && key.endsWith(KEY_ARRAY); - } - /**判断是否为对应Table的key - * @param key - * @return - */ - public static boolean isTableKey(String key) { - return StringUtil.isBigName(key); - } - /**判断是否为对应Table数组的 key - * @param key - * @return - */ - public static boolean isTableArray(String key) { - return isArrayKey(key) && isTableKey(key.substring(0, key.length() - KEY_ARRAY.length())); - } - //judge >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>> - - - //JSONObject内关键词 key <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< - - - public static String KEY_ID = "id"; - public static String KEY_ID_IN = KEY_ID + "{}"; - public static String KEY_USER_ID = "userId"; - public static String KEY_USER_ID_IN = KEY_USER_ID + "{}"; - - /**set "id":id in Table layer - * @param id - * @return - */ - public JSONObject setId(Long id) { - return puts(KEY_ID, id); - } - /**set "id{}":[] in Table layer - * @param list - * @return - */ - public JSONObject setIdIn(List list) { - return puts(KEY_ID_IN, list); - } - - /**set "userId":userId in Table layer - * @param id - * @return - */ - public JSONObject setUserId(Long id) { - return puts(KEY_USER_ID, id); - } - /**set "userId{}":[] in Table layer - * @param list - * @return - */ - public JSONObject setUserIdIn(List list) { - return puts(KEY_USER_ID_IN, list); - } - - - public static final int CACHE_ALL = 0; - public static final int CACHE_ROM = 1; - public static final int CACHE_RAM = 2; - - public static final String CACHE_ALL_STRING = "ALL"; - public static final String CACHE_ROM_STRING = "ROM"; - public static final String CACHE_RAM_STRING = "RAM"; - - - //@key关键字都放这个类 <<<<<<<<<<<<<<<<<<<<<< - public static final String KEY_TRY = "@try"; //尝试，忽略异常 - public static final String KEY_CATCH = "@catch"; //TODO 捕捉到异常后，处理方式 null-不处理；DEFAULT-返回默认值；ORIGIN-返回请求里的原始值 - public static final String KEY_DROP = "@drop"; //丢弃，不返回，TODO 应该通过 fastjson 的 ignore 之类的机制来处理，避免导致下面的对象也不返回 - // public static final String KEY_KEEP = "@keep"; //一定会返回，为 null 或 空对象时，会使用默认值(非空)，解决其它对象因为不关联的第一个对为空导致也不返回 - public static final String KEY_DEFULT = "@default"; //TODO 自定义默认值 { "@default":true }，@default 可完全替代 @keep - - public static final String KEY_ROLE = "@role"; //角色，拥有对某些数据的某些操作的权限 - public static final String KEY_DATABASE = "@database"; //数据库类型，默认为MySQL - public static final String KEY_EXPLAIN = "@explain"; //分析 true/false - public static final String KEY_CACHE = "@cache"; //缓存 RAM/ROM/ALL - public static final String KEY_SCHEMA = "@schema"; //数据库，Table在非默认schema内时需要声明 - public static final String KEY_COLUMN = "@column"; //查询的Table字段或SQL函数 - public static final String KEY_FROM = "@from"; //FROM语句 - public static final String KEY_COMBINE = "@combine"; //条件组合，每个条件key前面可以放&,|,!逻辑关系 "id!{},&sex,!name&$" - public static final String KEY_GROUP = "@group"; //分组方式 - public static final String KEY_HAVING = "@having"; //聚合函数条件，一般和@group一起用 - public static final String KEY_ORDER = "@order"; //排序方式 - public static final String KEY_RAW = "@raw"; // 自定义原始 SQL 片段 - public static final String KEY_JSON = "@json"; //SQL Server 把字段转为 JSON 输出 - - public static final List TABLE_KEY_LIST; - static { - TABLE_KEY_LIST = new ArrayList(); - TABLE_KEY_LIST.add(KEY_ROLE); - TABLE_KEY_LIST.add(KEY_DATABASE); - TABLE_KEY_LIST.add(KEY_EXPLAIN); - TABLE_KEY_LIST.add(KEY_CACHE); - TABLE_KEY_LIST.add(KEY_SCHEMA); - TABLE_KEY_LIST.add(KEY_COLUMN); - TABLE_KEY_LIST.add(KEY_FROM); - TABLE_KEY_LIST.add(KEY_COMBINE); - TABLE_KEY_LIST.add(KEY_GROUP); - TABLE_KEY_LIST.add(KEY_HAVING); - TABLE_KEY_LIST.add(KEY_ORDER); - TABLE_KEY_LIST.add(KEY_RAW); - TABLE_KEY_LIST.add(KEY_JSON); - } - - //@key关键字都放这个类 >>>>>>>>>>>>>>>>>>>>>> - - - /**set try, ignore exceptions - * @param tri - * @return this - */ - public JSONObject setTry(Boolean tri) { - return puts(KEY_TRY, tri); - } - - /**set catch - * @param isCatch - * @return this - */ - public JSONObject setCatch(String isCatch) { - return puts(KEY_CATCH, isCatch); - } - /**set drop, data dropped will not return - * @param drop - * @return this - */ - public JSONObject setDrop(Boolean drop) { - return puts(KEY_DROP, drop); - } - - /**set if has default - * @param hasDefault - * @return this - */ - public JSONObject setDefault(Boolean hasDefault) { - return puts(KEY_DEFULT, hasDefault); - } - - - /**set role of request sender - * @param role - * @return this - */ - public JSONObject setRole(String role) { - return puts(KEY_ROLE, role); - } - /**set database where table was puts - * @param database - * @return this - */ - public JSONObject setDatabase(String database) { - return puts(KEY_DATABASE, database); - } - /**set if return explain informations - * @param explain - * @return - */ - public JSONObject setExplain(Boolean explain) { - return puts(KEY_EXPLAIN, explain); - } - /**set cache type - * @param cache - * @return - * @see {@link #CACHE_ALL} - * @see {@link #CACHE_RAM} - * @see {@link #CACHE_ROM} - */ - public JSONObject setCache(Integer cache) { - return puts(KEY_CACHE, cache); - } - /**set cache type - * @param cache - * @return - * @see {@link #CACHE_ALL_STRING} - * @see {@link #CACHE_RAM_STRING} - * @see {@link #CACHE_ROM_STRING} - */ - public JSONObject setCache(String cache) { - return puts(KEY_CACHE, cache); - } - /**set schema where table was puts - * @param schema - * @return this - */ - public JSONObject setSchema(String schema) { - return puts(KEY_SCHEMA, schema); - } - - /**set keys need to be returned - * @param keys key0, key1, key2 ... - * @return {@link #setColumn(String)} - */ - public JSONObject setColumn(String... keys) { - return setColumn(StringUtil.getString(keys, true)); - } - /**set keys need to be returned - * @param keys "key0,key1,key2..." - * @return - */ - public JSONObject setColumn(String keys) { - return puts(KEY_COLUMN, keys); - } - - /**set combination of keys for conditions - * @param keys key0,&key1,|key2,!kye3 ... - * @return {@link #setColumn(String)} - */ - public JSONObject setCombine(String... keys) { - return setCombine(StringUtil.getString(keys, true)); - } - /**set combination of keys for conditions - * @param keys key0,&key1,|key2,!kye3 ... - * @return - */ - public JSONObject setCombine(String keys) { - return puts(KEY_COMBINE, keys); - } - - /**set keys for group by - * @param keys key0, key1, key2 ... - * @return {@link #setGroup(String)} - */ - public JSONObject setGroup(String... keys) { - return setGroup(StringUtil.getString(keys, true)); - } - /**set keys for group by - * @param keys "key0,key1,key2..." - * @return - */ - public JSONObject setGroup(String keys) { - return puts(KEY_GROUP, keys); - } - - /**set keys for having - * @param keys count(key0) > 1, sum(key1) <= 5, function2(key2) ? value2 ... - * @return {@link #setHaving(String)} - */ - public JSONObject setHaving(String... keys) { - return setHaving(StringUtil.getString(keys, true)); - } - /**set keys for having - * @param keys "key0,key1,key2..." - * @return - */ - public JSONObject setHaving(String keys) { - return puts(KEY_HAVING, keys); - } - - /**set keys for order by - * @param keys key0, key1+, key2- ... - * @return {@link #setOrder(String)} - */ - public JSONObject setOrder(String... keys) { - return setOrder(StringUtil.getString(keys, true)); - } - /**set keys for order by - * @param keys "key0,key1+,key2-..." - * @return - */ - public JSONObject setOrder(String keys) { - return puts(KEY_ORDER, keys); - } - - /**set keys to raw - * @param keys "key0,key1,key2..." - * @return - */ - public JSONObject setRaw(String keys) { - return puts(KEY_RAW, keys); - } - - /**set keys to cast to json - * @param keys "key0,key1,key2..." - * @return - */ - public JSONObject setJson(String keys) { - return puts(KEY_JSON, keys); - } - - /**用 setJson 替代。 - * set keys to cast to json - * @param keys "key0,key1,key2..." - * @return - * @see #{@link #setJson(String)} - */ - @Deprecated - public JSONObject setJSON(String keys) { - return puts(KEY_JSON, keys); - } - - - //JSONObject内关键词 key >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>> - - - - //Request <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< - - - /** - * @param key - * @param keys path = keys[0] + "/" + keys[1] + "/" + keys[2] + ... - * @return {@link #puts(String, Object)} - */ - public JSONObject putsPath(String key, String... keys) { - return puts(key+"@", StringUtil.getString(keys, "/")); - } - - /** - * @param key - * @param isNull - * @return {@link #puts(String, Object)} - */ - public JSONObject putsNull(String key, boolean isNull) { - return puts(key+"{}", SQL.isNull(isNull)); - } - /** - * trim = false - * @param key - * @param isEmpty - * @return {@link #putsEmpty(String, boolean, boolean)} - */ - public JSONObject putsEmpty(String key, boolean isEmpty) { - return putsEmpty(key, isEmpty, false); - } - /** - * @param key - * @param isEmpty - * @return {@link #puts(String, Object)} - */ - public JSONObject putsEmpty(String key, boolean isEmpty, boolean trim) { - return puts(key+"{}", SQL.isEmpty(key, isEmpty, trim)); - } - /** - * @param key - * @param compare <=0, >5 ... - * @return {@link #puts(String, Object)} - */ - public JSONObject putsLength(String key, String compare) { - return puts(key+"{}", SQL.length(key) + compare); - } - - /**设置搜索 - * type = SEARCH_TYPE_CONTAIN_FULL - * @param key - * @param value - * @return {@link #putsSearch(String, String, int)} - */ - public JSONObject putsSearch(String key, String value) { - return putsSearch(key, value, SQL.SEARCH_TYPE_CONTAIN_FULL); - } - /**设置搜索 - * @param key - * @param value - * @param type - * @return {@link #puts(String, Object)} - */ - public JSONObject putsSearch(String key, String value, int type) { - return puts(key+"$", SQL.search(value, type)); - } - - //Request >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>> - - - - /**puts key-value in object into this - * @param map - * @return this - */ - public JSONObject putsAll(Map map) { - putAll(map); - return this; - } - @Override - public void putAll(Map map) { - if (map != null && map.isEmpty() == false) { - super.putAll(map); - } - } - - - - /**put and return this - * @param value must be annotated by {@link MethodAccess} - * @return {@link #puts(String, Object)} - */ - public JSONObject puts(Object value) { - return puts(null, value); - } - /**put and return this - * @param key - * @param value - * @return this - * @see {@link #put(String, Object)} - */ - public JSONObject puts(String key, Object value) { - put(key, value); - return this; - } - - /**put and return value - * @param value must be annotated by {@link MethodAccess} - * @return {@link #put(String, Object)} - */ - public Object put(Object value) { - return put(null, value); - } - /**put and return value - * @param key StringUtil.isEmpty(key, true) ? key = value.getClass().getSimpleName(); - * @param value - * @return value - */ - @Override - public Object put(String key, Object value) { - if (value == null) { - Log.e(TAG, "put value == null >> return null;"); - return null; - } - if (StringUtil.isEmpty(key, true)) { - Class clazz = value.getClass(); //should not return null - if (clazz.getAnnotation(MethodAccess.class) == null) { - throw new IllegalArgumentException("puts StringUtil.isEmpty(key, true)" + - " clazz.getAnnotation(MethodAccess.class) == null" + - " \n key为空时仅支持 类型被@MethodAccess注解 的value !!!" + - " \n 如果一定要这么用，请对 " + clazz.getName() + " 注解！" + - " \n 如果是类似 key[]:{} 结构的请求，建议用 putsAll(...) ！"); - } - key = value.getClass().getSimpleName(); - } - return super.put(key, value); - } - - - -} diff --git a/APIJSONORM/src/main/java/apijson/JSONParser.java b/APIJSONORM/src/main/java/apijson/JSONParser.java new file mode 100755 index 000000000..7c38a39df --- /dev/null +++ b/APIJSONORM/src/main/java/apijson/JSONParser.java @@ -0,0 +1,33 @@ +/*Copyright (C) 2020 Tencent. All rights reserved. + +This source code is licensed under the Apache License Version 2.0.*/ + + +package apijson; + +import java.util.List; +import java.util.Map; + +/**JSON 相关解析器 + * @author Lemon + */ +public interface JSONParser, L extends List> extends JSONCreator { + + Object parse(Object json); + + M parseObject(Object json); + + T parseObject(Object json, Class clazz); + + L parseArray(Object json); + + List parseArray(Object json, Class clazz); + + default String format(Object obj) { + return toJSONString(obj, true); + } + default String toJSONString(Object obj) { + return toJSONString(obj, false); + } + String toJSONString(Object obj, boolean format); +} diff --git a/APIJSONORM/src/main/java/apijson/JSONRequest.java b/APIJSONORM/src/main/java/apijson/JSONRequest.java index 5b49f608e..c74dfe349 100755 --- a/APIJSONORM/src/main/java/apijson/JSONRequest.java +++ b/APIJSONORM/src/main/java/apijson/JSONRequest.java @@ -1,4 +1,4 @@ -/*Copyright (C) 2020 THL A29 Limited, a Tencent company. All rights reserved. +/*Copyright (C) 2020 Tencent. All rights reserved. This source code is licensed under the Apache License Version 2.0.*/ @@ -6,42 +6,50 @@ package apijson; import java.util.ArrayList; +import java.util.Arrays; import java.util.List; import java.util.Map; +import static apijson.StringUtil.PATTERN_ALPHA_BIG; + /**wrapper for request * @author Lemon * @see #puts * @see #toArray - * @use JSONRequest request = new JSONRequest(...); + * @use JSONRequest request = JSON.createJSONObject(...); *
request.puts(...);//not a must *
request.toArray(...);//not a must */ -public class JSONRequest extends JSONObject { - private static final long serialVersionUID = 1L; - - public JSONRequest() { - super(); - } - /** - * @param object must be annotated by {@link MethodAccess} - * @see {@link #JSONRequest(String, Object)} - */ - public JSONRequest(Object object) { - this(null, object); - } - /** - * @param name - * @param object - * @see {@link #puts(String, Object)} - */ - public JSONRequest(String name, Object object) { - this(); - puts(name, object); - } - +public interface JSONRequest, L extends List> extends JSONMap { + //default JSONRequest() { + // super(); + //} + ///** + // * @param object must be annotated by {@link MethodAccess} + // * @see {@link #JSONRequest(String, Object)} + // */ + //default JSONRequest(Object object) { + // this(null, object); + //} + ///** + // * @param name + // * @param object + // * @see {@link #puts(String, Object)} + // */ + //default JSONRequest(String name, Object object) { + // this(); + // puts(name, object); + //} + //public static JSONRequest valueOf(Object obj) { + // JSONRequest req = new JSONRequest() {}; + // Map m = JSON.parseObject(obj); + // if (m != null && ! m.isEmpty()) { + // req.map.putAll(m); + // } + // return req; + //} public static final String KEY_TAG = "tag";//只在最外层，最外层用JSONRequest public static final String KEY_VERSION = "version";//只在最外层，最外层用JSONRequest @@ -52,23 +60,25 @@ public JSONRequest(String name, Object object) { * @param tag * @return */ - public JSONRequest setTag(String tag) { + default JSONRequest setTag(String tag) { return puts(KEY_TAG, tag); } + /**set "version":version in outermost layer * for target version of request * @param version * @return */ - public JSONRequest setVersion(Integer version) { + default JSONRequest setVersion(Integer version) { return puts(KEY_VERSION, version); } + /**set "format":format in outermost layer * for format APIJSON special keys to normal keys of response * @param format * @return */ - public JSONRequest setFormat(Boolean format) { + default JSONRequest setFormat(Boolean format) { return puts(KEY_FORMAT, format); } @@ -78,31 +88,25 @@ public JSONRequest setFormat(Boolean format) { public static final int QUERY_TABLE = 0; public static final int QUERY_TOTAL = 1; public static final int QUERY_ALL = 2; - + public static final String QUERY_TABLE_STRING = "TABLE"; public static final String QUERY_TOTAL_STRING = "TOTAL"; public static final String QUERY_ALL_STRING = "ALL"; public static final String SUBQUERY_RANGE_ALL = "ALL"; public static final String SUBQUERY_RANGE_ANY = "ANY"; - + public static final String KEY_QUERY = "query"; + public static final String KEY_COMPAT = "compat"; public static final String KEY_COUNT = "count"; public static final String KEY_PAGE = "page"; public static final String KEY_JOIN = "join"; public static final String KEY_SUBQUERY_RANGE = "range"; public static final String KEY_SUBQUERY_FROM = "from"; - public static final List ARRAY_KEY_LIST; - static { - ARRAY_KEY_LIST = new ArrayList(); - ARRAY_KEY_LIST.add(KEY_QUERY); - ARRAY_KEY_LIST.add(KEY_COUNT); - ARRAY_KEY_LIST.add(KEY_PAGE); - ARRAY_KEY_LIST.add(KEY_JOIN); - ARRAY_KEY_LIST.add(KEY_SUBQUERY_RANGE); - ARRAY_KEY_LIST.add(KEY_SUBQUERY_FROM); - } + public static final List ARRAY_KEY_LIST = new ArrayList<>(Arrays.asList( + KEY_QUERY, KEY_COMPAT ,KEY_COUNT, KEY_PAGE, KEY_JOIN, KEY_SUBQUERY_RANGE, KEY_SUBQUERY_FROM + )); /**set what to query in Array layer * @param query what need to query, Table,total,ALL? @@ -111,87 +115,161 @@ public JSONRequest setFormat(Boolean format) { * @see {@link #QUERY_TOTAL} * @see {@link #QUERY_ALL} */ - public JSONRequest setQuery(int query) { + default JSONRequest setQuery(int query) { return puts(KEY_QUERY, query); } + /**set maximum count of Tables to query in Array layer * @param count <= 0 || >= max ? max : count * @return */ - public JSONRequest setCount(int count) { + default JSONRequest setCount(int count) { return puts(KEY_COUNT, count); } + /**set page of Tables to query in Array layer * @param page <= 0 ? 0 : page * @return */ - public JSONRequest setPage(int page) { + default JSONRequest setPage(int page) { return puts(KEY_PAGE, page); } - + /**set joins of Main Table and it's Vice Tables in Array layer * @param joins "@/User/id@", "&/User/id@,>/Comment/momentId@" ... * @return */ - public JSONRequest setJoin(String... joins) { - return puts(KEY_JOIN, StringUtil.getString(joins)); + default JSONRequest setJoin(String... joins) { + return setJson(this, StringUtil.get(joins)); } - + + public static > M setJson(M m, String... joins) { + m.put(KEY_JOIN, StringUtil.get(joins)); + return m; + } + /**set range for Subquery * @param range * @return * @see {@link #SUBQUERY_RANGE_ALL} * @see {@link #SUBQUERY_RANGE_ANY} */ - public JSONRequest setSubqueryRange(String range) { + default JSONRequest setSubqueryRange(String range) { return puts(KEY_SUBQUERY_RANGE, range); } - + /**set from for Subquery - * @param range + * @param from * @return */ - public JSONRequest setSubqueryFrom(String from) { + default JSONRequest setSubqueryFrom(String from) { return puts(KEY_SUBQUERY_FROM, from); } - - //array object >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>> + //array object >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>> - /**create a parent JSONObject named KEY_ARRAY + /**create a parent JSONMap named KEY_ARRAY * @param count * @param page * @return {@link #toArray(int, int)} */ - public JSONRequest toArray(int count, int page) { + default M toArray(int count, int page) { return toArray(count, page, null); } - /**create a parent JSONObject named name+KEY_ARRAY. + + /**create a parent JSONMap named name+KEY_ARRAY. * @param count * @param page * @param name * @return {name+KEY_ARRAY : this}. if needs to be put, use {@link #putsAll(Map)} instead */ - public JSONRequest toArray(int count, int page, String name) { - return new JSONRequest(StringUtil.getString(name) + KEY_ARRAY, this.setCount(count).setPage(page)); + default M toArray(int count, int page, String name) { + return JSON.createJSONObject(StringUtil.get(name) + KEY_ARRAY, this.setCount(count).setPage(page)); } @Override - public JSONObject putsAll(Map map) { - super.putsAll(map); + default JSONRequest putsAll(Map map) { + putAll(map); return this; } @Override - public JSONRequest puts(Object value) { - return puts(null, value); + default JSONRequest puts(Object value) { + put(value); + return this; } + @Override - public JSONRequest puts(String key, Object value) { - super.puts(key, value); + default JSONRequest puts(String key, Object value) { + put(key, value); return this; } + + /**ABCdEfg => upper ? A-B-CD-EFG : a-b-cd-efg + * @param key + * @return + */ + public static String recoverHyphen(@NotNull String key, Boolean upper) { + return recoverDivider(key, "-", upper); + } + + /**ABCdEfg => upper ? A_B_CD_EFG : a_b_cd_efg + * @param key + * @return + */ + public static String recoverUnderline(@NotNull String key, Boolean upper) { + return recoverDivider(key, "_", upper); + } + + /**ABCdEfg => upper ? A$B$CD$EFG : a$b$cd$efg + * @param key + * @return + */ + public static String recoverDollar(@NotNull String key, Boolean upper) { + return recoverDivider(key, "$", upper); + } + + /**ABCdEfg => upper ? A.B.CD.EFG : a.b.cd.efg + * @param key + * @return + */ + public static String recoverDot(@NotNull String key, Boolean upper) { + return recoverDivider(key, ".", upper); + } + + /**ABCdEfg => upper ? A_B_CD_EFG : a/b/cd/efg + * @param key + * @return + */ + public static String recoverDivider(@NotNull String key, Boolean upper) { + return recoverDivider(key, "/", upper); + } + + /**驼峰格式转为带分隔符的全大写或全小写格式 + * @param key + * @param divider + * @param upper + * @return + */ + public static String recoverDivider(@NotNull String key, @NotNull String divider, Boolean upper) { + StringBuilder name = new StringBuilder(); + char[] cs = key.toCharArray(); + int len = key.length(); + for (int i = 0; i < len; i++) { + String s = key.substring(i, i + 1); + if (i > 0 && PATTERN_ALPHA_BIG.matcher(s).matches()) { + name.append(divider); + } + if (upper != null) { + s = upper ? s.toUpperCase() : s.toLowerCase(); + } + name.append(s); + } + return name.toString(); + } + + } diff --git a/APIJSONORM/src/main/java/apijson/JSONResponse.java b/APIJSONORM/src/main/java/apijson/JSONResponse.java index 5cc3a0b6e..c39aa1ace 100755 --- a/APIJSONORM/src/main/java/apijson/JSONResponse.java +++ b/APIJSONORM/src/main/java/apijson/JSONResponse.java @@ -1,15 +1,11 @@ -/*Copyright (C) 2020 THL A29 Limited, a Tencent company. All rights reserved. +/*Copyright (C) 2020 Tencent. All rights reserved. This source code is licensed under the Apache License Version 2.0.*/ package apijson; -import java.util.List; -import java.util.Set; - -import com.alibaba.fastjson.JSONArray; -import com.alibaba.fastjson.JSONObject; +import java.util.*; /**parser for response * @author Lemon @@ -19,20 +15,36 @@ *
User user = response.getObject(User.class);//not a must *
List commenntList = response.getList("Comment[]", Comment.class);//not a must */ -public class JSONResponse extends apijson.JSONObject { - private static final long serialVersionUID = 1L; +public interface JSONResponse, L extends List> extends JSONMap { + static final String TAG = "JSONResponse"; - private 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; - public JSONResponse() { - super(); - } - public JSONResponse(String json) { - this(parseObject(json)); - } - public JSONResponse(JSONObject object) { - super(format(object)); - } + + //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请求获得的信息<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< @@ -56,9 +68,9 @@ public JSONResponse(JSONObject object) { public static final String MSG_SERVER_ERROR = "Internal Server Error!"; //服务器内部错误 - public static final String KEY_OK = "ok"; - public static final String KEY_CODE = "code"; - public static final String KEY_MSG = "msg"; + 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"; //详细的分页信息 @@ -70,9 +82,9 @@ public JSONResponse(JSONObject object) { /**获取状态 * @return */ - public int getCode() { + default int getCode() { try { - return getIntValue(KEY_CODE); + return JSON.getIntValue(this, KEY_CODE); } catch (Exception e) { //empty } @@ -81,9 +93,9 @@ public int getCode() { /**获取状态 * @return */ - public static int getCode(JSONObject reponse) { + public static int getCode(Map reponse) { try { - return reponse.getIntValue(KEY_CODE); + return JSON.getIntValue(reponse, KEY_CODE); } catch (Exception e) { //empty } @@ -92,22 +104,22 @@ public static int getCode(JSONObject reponse) { /**获取状态描述 * @return */ - public String getMsg() { - return getString(KEY_MSG); + default String getMsg() { + return JSON.getString(this, KEY_MSG); } /**获取状态描述 - * @param reponse + * @param response * @return */ - public static String getMsg(JSONObject reponse) { - return reponse == null ? null : reponse.getString(KEY_MSG); + public static String getMsg(Map response) { + return response == null ? null : JSON.getString(response, KEY_MSG); } /**获取id * @return */ - public long getId() { + default long getId() { try { - return getLongValue(KEY_ID); + return JSON.getLongValue(this, KEY_ID); } catch (Exception e) { //empty } @@ -116,9 +128,9 @@ public long getId() { /**获取数量 * @return */ - public int getCount() { + default int getCount() { try { - return getIntValue(KEY_COUNT); + return JSON.getIntValue(this, KEY_COUNT); } catch (Exception e) { //empty } @@ -127,9 +139,9 @@ public int getCount() { /**获取总数 * @return */ - public int getTotal() { + default int getTotal() { try { - return getIntValue(KEY_TOTAL); + return JSON.getIntValue(this, KEY_TOTAL); } catch (Exception e) { //empty } @@ -140,7 +152,7 @@ public int getTotal() { /**是否成功 * @return */ - public boolean isSuccess() { + default boolean isSuccess() { return isSuccess(getCode()); } /**是否成功 @@ -154,21 +166,21 @@ public static boolean isSuccess(int code) { * @param response * @return */ - public static boolean isSuccess(JSONResponse response) { + public static boolean isSuccess(JSONResponse response) { return response != null && response.isSuccess(); } /**是否成功 * @param response * @return */ - public static boolean isSuccess(JSONObject response) { - return response != null && isSuccess(response.getIntValue(KEY_CODE)); - } + public static boolean isSuccess(Map response) { + return response != null && isSuccess(JSON.getIntValue(response, KEY_CODE)); + } /**校验服务端是否存在table * @return */ - public boolean isExist() { + default boolean isExist() { return isExist(getCount()); } /**校验服务端是否存在table @@ -182,39 +194,39 @@ public static boolean isExist(int count) { * @param response * @return */ - public static boolean isExist(JSONResponse response) { + 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 */ - public JSONResponse getJSONResponse(String key) { + default JSONResponse getJSONResponse(String key) { return getObject(key, JSONResponse.class); } + //cannot get javaBeanDeserizer // /**获取内部的JSONResponse // * @param response // * @param key // * @return // */ - // public static JSONResponse getJSONResponse(JSONObject response, String key) { + // public static JSONResponse getJSONResponse(JSONRequest response, String key) { // return response == null ? null : response.getObject(key, JSONResponse.class); // } //状态信息，非GET请求获得的信息>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>> - - - - /** * key = clazz.getSimpleName() * @param clazz * @return */ - public T getObject(Class clazz) { + default T getObject(Class clazz) { return getObject(clazz == null ? "" : clazz.getSimpleName(), clazz); } /** @@ -222,7 +234,7 @@ public T getObject(Class clazz) { * @param clazz * @return */ - public T getObject(String key, Class clazz) { + default T getObject(String key, Class clazz) { return getObject(this, key, clazz); } /** @@ -231,55 +243,47 @@ public T getObject(String key, Class clazz) { * @param clazz * @return */ - public static T getObject(JSONObject object, String key, Class clazz) { - return toObject(object == null ? null : object.getJSONObject(formatObjectKey(key)), clazz); + public static T getObject( + Map object, String key, Class clazz) { + return toObject(object == null ? null : JSON.get(object, formatObjectKey(key)), clazz); } /** * @param clazz * @return */ - public T toObject(Class clazz) { + default T toObject(Class clazz) { return toObject(this, clazz); } + /** * @param object * @param clazz * @return */ - public static T toObject(JSONObject object, Class clazz) { - return JSON.parseObject(JSON.toJSONString(object), clazz); + public static , L extends List> T toObject( + Map object, Class clazz) { + return JSON.parseObject(object, clazz); } - - /** - * key = KEY_ARRAY - * @param clazz - * @return - */ - public List getList(Class clazz) { - return getList(KEY_ARRAY, clazz); - } /** * arrayObject = this * @param key - * @param clazz * @return */ - public List getList(String key, Class clazz) { - return getList(this, key, clazz); + default List getList(String key) { + return JSON.getList(this, key); } /** * key = KEY_ARRAY * @param object - * @param clazz * @return */ - public static List getList(JSONObject object, Class clazz) { - return getList(object, KEY_ARRAY, clazz); + public static List getList(Map object) { + return JSON.getList(object, KEY_ARRAY); } /** * @param object @@ -287,29 +291,29 @@ public static List getList(JSONObject object, Class clazz) { * @param clazz * @return */ - public static List getList(JSONObject object, String key, Class clazz) { - return object == null ? null : JSON.parseArray(object.getString(formatArrayKey(key)), clazz); + 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 */ - public JSONArray getArray() { + default > L getArray() { return getArray(KEY_ARRAY); } /** * @param key * @return */ - public JSONArray getArray(String key) { + default > L getArray(String key) { return getArray(this, key); } /** * @param object * @return */ - public static JSONArray getArray(JSONObject object) { + public static > L getArray(Map object) { return getArray(object, KEY_ARRAY); } /** @@ -318,28 +322,29 @@ public static JSONArray getArray(JSONObject object) { * @param key * @return */ - public static JSONArray getArray(JSONObject object, String key) { - return object == null ? null : object.getJSONArray(formatArrayKey(key)); + public static > L getArray(Map object, String key) { + return object == null ? null : JSON.get(object, formatArrayKey(key)); } // /** // * @return // */ - // public JSONObject format() { + // default JSONRequest format() { // return format(this); // } /**格式化key名称 * @param object * @return */ - public static JSONObject format(final JSONObject object) { + 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; } - JSONObject formatedObject = new JSONObject(true); + + M formatedObject = JSON.createJSONObject(); Set set = object.keySet(); if (set != null) { @@ -348,11 +353,11 @@ public static JSONObject format(final JSONObject object) { for (String key : set) { value = object.get(key); - if (value instanceof JSONArray) {//JSONArray，遍历来format内部项 - formatedObject.put(formatArrayKey(key), format((JSONArray) value)); + if (value instanceof List) {//JSONList，遍历来format内部项 + formatedObject.put(formatArrayKey(key), format((L) value)); } - else if (value instanceof JSONObject) {//JSONObject，往下一级提取 - formatedObject.put(formatObjectKey(key), format((JSONObject) value)); + else if (value instanceof Map) {//JSONRequest，往下一级提取 + formatedObject.put(formatObjectKey(key), format((M) value)); } else {//其它Object，直接填充 formatedObject.put(formatOtherKey(key), value); @@ -368,30 +373,30 @@ else if (value instanceof JSONObject) {//JSONObject，往下一级提取 * @param array * @return */ - public static JSONArray format(final JSONArray array) { + 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; } - JSONArray formatedArray = new JSONArray(); + L formattedArray = JSON.createJSONArray(); Object value; for (int i = 0; i < array.size(); i++) { value = array.get(i); - if (value instanceof JSONArray) {//JSONArray，遍历来format内部项 - formatedArray.add(format((JSONArray) value)); + if (value instanceof List) {//JSONList，遍历来format内部项 + formattedArray.add(format((L) value)); } - else if (value instanceof JSONObject) {//JSONObject，往下一级提取 - formatedArray.add(format((JSONObject) value)); + else if (value instanceof Map) {//JSONRequest，往下一级提取 + formattedArray.add(format((M) value)); } else {//其它Object，直接填充 - formatedArray.add(value); + formattedArray.add(value); } } - //太长查看不方便，不如debug Log.i(TAG, "format return formatedArray = " + JSON.toJSONString(formatedArray)); - return formatedArray; + //太长查看不方便，不如debug Log.i(TAG, "format return formattedArray = " + JSON.toJSONString(formattedArray)); + return formattedArray; } @@ -407,21 +412,21 @@ public static String getTableName(String fullName) { /**获取变量名 * @param fullName - * @return {@link #formatKey(String, boolean, boolean, boolean, boolean)} formatColon = true, formatAt = true, formatHyphen = true, firstCase = true + * @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 (isArrayKey(fullName)) { + if (JSONMap.isArrayKey(fullName)) { fullName = StringUtil.addSuffix(fullName.substring(0, fullName.length() - 2), "list"); } - return formatKey(fullName, true, true, true, true); + 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)} formatColon = false, formatAt = true, formatHyphen = true, firstCase = true + * @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 (isArrayKey(key)) { + if (JSONMap.isArrayKey(key)) { key = StringUtil.addSuffix(key.substring(0, key.length() - 2), "list"); } int index = key == null ? -1 : key.indexOf(":"); @@ -429,28 +434,29 @@ public static String formatArrayKey(String key) { return key.substring(index + 1); //不处理自定义的 } - return formatKey(key, false, true, true, true); //节约性能，除了数组对象 Table-column:alias[] ，一般都符合变量命名规范 + 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)} formatColon = false, formatAt = true, formatHyphen = false, firstCase = true + * @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 key.substring(index + 1); // 不处理自定义的 } - return formatKey(key, false, true, false, true); //节约性能，除了表对象 Table:alias ，一般都符合变量命名规范 + 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)} formatColon = false, formatAt = true, formatHyphen = false, firstCase = false + * @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, false, false); //节约性能，除了关键词 @key ，一般都符合变量命名规范，不符合也原样返回便于调试 + 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); } @@ -459,10 +465,13 @@ public static String formatOtherKey(String fullName) { * @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 firstCase) { + 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; @@ -474,11 +483,18 @@ public static String formatKey(String fullName, boolean formatColon, boolean for if (formatAt) { //关键词只去掉前缀，不格式化单词，例如 @a-b 返回 a-b ，最后不会调用 setter fullName = formatAt(fullName); } - if (formatHyphen) { - fullName = formatHyphen(fullName, firstCase); + if (formatHyphen && fullName.contains("-")) { + fullName = formatHyphen(fullName, true); + } + if (formatUnderline && fullName.contains("_")) { + fullName = formatUnderline(fullName, true); + } + if (formatDollar && fullName.contains("$")) { + fullName = formatDollar(fullName, true); } - return firstCase ? StringUtil.firstCase(fullName) : fullName; //不格式化普通 key:value (value 不为 [], {}) 的 key + // 默认不格式化普通 key:value (value 不为 [], {}) 的 key + return firstCase == null ? fullName : StringUtil.firstCase(fullName, firstCase); } /**"@key" => "key" @@ -488,6 +504,7 @@ public static String formatKey(String fullName, boolean formatColon, boolean for public static String formatAt(@NotNull String key) { return key.startsWith("@") ? key.substring(1) : key; } + /**key:alias => alias * @param key * @return @@ -501,25 +518,148 @@ public static String formatColon(@NotNull String key) { * @param key * @return */ - public static String formatHyphen(@NotNull String key, boolean firstCase) { - boolean first = true; - int index; + 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); + } - String name = ""; - String part; - do { - index = key.indexOf("-"); - part = index < 0 ? key : key.substring(0, index); + /**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); + } - name += firstCase && first == false ? StringUtil.firstCase(part, true) : part; - key = key.substring(index + 1); + /**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); + } - first = false; - } - while (index >= 0); + /**A/b/cd/Efg => ABCdEfg + * @param key + * @return + */ + public static String formatDivider(@NotNull String key, Boolean firstCase) { + return formatDivider(key, "/", firstCase); + } - return name; + /**去除分割符，返回驼峰格式 + * @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(); + } } diff --git a/APIJSONORM/src/main/java/apijson/Log.java b/APIJSONORM/src/main/java/apijson/Log.java index d37691f8e..ba1a03bd5 100755 --- a/APIJSONORM/src/main/java/apijson/Log.java +++ b/APIJSONORM/src/main/java/apijson/Log.java @@ -1,34 +1,97 @@ -/*Copyright (C) 2020 THL A29 Limited, a Tencent company. All rights reserved. +/*Copyright (C) 2020 Tencent. All rights reserved. This source code is licensed under the Apache License Version 2.0.*/ package apijson; +import java.text.SimpleDateFormat; + /**测试用Log * @modifier Lemon */ public class Log { public static boolean DEBUG = true; - + + public static final String VERSION = "8.0.2"; + public static final String KEY_SYSTEM_INFO_DIVIDER = "\n---|-----APIJSON SYSTEM INFO-----|---\n"; + + public static final String OS_NAME; + public static final String OS_VERSION; + public static final String OS_ARCH; + public static final String JAVA_VERSION; + static { + OS_NAME = System.getProperty("os.name"); + OS_VERSION = System.getProperty("os.version"); + OS_ARCH = System.getProperty("os.arch"); + JAVA_VERSION = System.getProperty("java.version"); + } + + + //默认的时间格式 + public static SimpleDateFormat DATE_FORMAT = new SimpleDateFormat("yyyy-MM-dd hh:mm:ss.SSS"); + + /** + * modify date format + * @param dateFormatString + */ + public static void setDateFormat(String dateFormatString) { + DATE_FORMAT = new SimpleDateFormat(dateFormatString); + } + + /** + * log info by level tag and msg + * @param TAG + * @param msg + * @param level + */ + public static void logInfo(String TAG, String msg, String level){ + if(level.equals("DEBUG") || level .equals("ERROR") ||level.equals("WARN")){ + System.err.println(DATE_FORMAT.format(System.currentTimeMillis()) + ": " + TAG + "." + level + ": " + msg); + } + else if(level.equals("VERBOSE") || level .equals("INFO") ){ + System.out.println(DATE_FORMAT.format(System.currentTimeMillis()) + ": " + TAG + "." + level + ": " + msg); + } + } + + /** * @param TAG * @param msg */ public static void d(String TAG, String msg) { if (DEBUG) { - System.err.println(TAG + ".DEBUG: " + msg); + logInfo(TAG,msg,"DEBUG"); } } + /** + * Forced debug + * @param TAG tag + * @param msg debug messages + */ + public static void fd(String TAG, String msg) { + logInfo(TAG,msg,"DEBUG"); + } + + /** + * Generate separation line + * @param pre prefix + * @param symbol used for generating separation line + * @param post postfix + */ + public static void sl(String pre,char symbol ,String post) { + System.err.println(pre+new String(new char[48]).replace('\u0000', symbol)+post); + } + /** * @param TAG * @param msg */ public static void v(String TAG, String msg) { if (DEBUG) { - System.out.println(TAG + ".VERBOSE: " + msg); + logInfo(TAG,msg,"VERBOSE"); } } @@ -38,7 +101,7 @@ public static void v(String TAG, String msg) { */ public static void i(String TAG, String msg) { if (DEBUG) { - System.out.println(TAG + ".INFO: " + msg); + logInfo(TAG,msg,"INFO"); } } @@ -48,7 +111,7 @@ public static void i(String TAG, String msg) { */ public static void e(String TAG, String msg) { if (DEBUG) { - System.err.println(TAG + ".ERROR: " + msg); + logInfo(TAG,msg,"ERROR"); } } @@ -58,7 +121,7 @@ public static void e(String TAG, String msg) { */ public static void w(String TAG, String msg) { if (DEBUG) { - System.err.println(TAG + ".WARN: " + msg); + logInfo(TAG,msg,"WARN"); } } diff --git a/APIJSONORM/src/main/java/apijson/MethodAccess.java b/APIJSONORM/src/main/java/apijson/MethodAccess.java index 3eff1ae3d..1804f7a7b 100755 --- a/APIJSONORM/src/main/java/apijson/MethodAccess.java +++ b/APIJSONORM/src/main/java/apijson/MethodAccess.java @@ -1,4 +1,4 @@ -/*Copyright (C) 2020 THL A29 Limited, a Tencent company. All rights reserved. +/*Copyright (C) 2020 Tencent. All rights reserved. This source code is licensed under the Apache License Version 2.0.*/ @@ -10,12 +10,12 @@ import java.lang.annotation.Retention; import java.lang.annotation.Target; -import static apijson.RequestRole.ADMIN; -import static apijson.RequestRole.CIRCLE; -import static apijson.RequestRole.CONTACT; -import static apijson.RequestRole.LOGIN; -import static apijson.RequestRole.OWNER; -import static apijson.RequestRole.UNKNOWN; +import static apijson.orm.AbstractVerifier.ADMIN; +import static apijson.orm.AbstractVerifier.CIRCLE; +import static apijson.orm.AbstractVerifier.CONTACT; +import static apijson.orm.AbstractVerifier.LOGIN; +import static apijson.orm.AbstractVerifier.OWNER; +import static apijson.orm.AbstractVerifier.UNKNOWN; import static java.lang.annotation.ElementType.TYPE; import static java.lang.annotation.RetentionPolicy.RUNTIME; @@ -31,36 +31,36 @@ /**@see {@link RequestMethod#GET} * @return 该请求方法允许的角色 default {UNKNOWN, LOGIN, CONTACT, CIRCLE, OWNER, ADMIN}; */ - RequestRole[] GET() default {UNKNOWN, LOGIN, CONTACT, CIRCLE, OWNER, ADMIN}; + String[] GET() default {UNKNOWN, LOGIN, CONTACT, CIRCLE, OWNER, ADMIN}; /**@see {@link RequestMethod#HEAD} * @return 该请求方法允许的角色 default {UNKNOWN, LOGIN, CONTACT, CIRCLE, OWNER, ADMIN}; */ - RequestRole[] HEAD() default {UNKNOWN, LOGIN, CONTACT, CIRCLE, OWNER, ADMIN}; + String[] HEAD() default {UNKNOWN, LOGIN, CONTACT, CIRCLE, OWNER, ADMIN}; /**@see {@link RequestMethod#GETS} * @return 该请求方法允许的角色 default {LOGIN, CONTACT, CIRCLE, OWNER, ADMIN}; */ - RequestRole[] GETS() default {LOGIN, CONTACT, CIRCLE, OWNER, ADMIN}; + String[] GETS() default {LOGIN, CONTACT, CIRCLE, OWNER, ADMIN}; /**@see {@link RequestMethod#HEADS} * @return 该请求方法允许的角色 default {LOGIN, CONTACT, CIRCLE, OWNER, ADMIN}; */ - RequestRole[] HEADS() default {LOGIN, CONTACT, CIRCLE, OWNER, ADMIN}; + String[] HEADS() default {LOGIN, CONTACT, CIRCLE, OWNER, ADMIN}; /**@see {@link RequestMethod#POST} * @return 该请求方法允许的角色 default {LOGIN, ADMIN}; */ - RequestRole[] POST() default {OWNER, ADMIN}; + String[] POST() default {OWNER, ADMIN}; /**@see {@link RequestMethod#PUT} * @return 该请求方法允许的角色 default {OWNER, ADMIN}; */ - RequestRole[] PUT() default {OWNER, ADMIN}; + String[] PUT() default {OWNER, ADMIN}; /**@see {@link RequestMethod#DELETE} * @return 该请求方法允许的角色 default {OWNER, ADMIN}; */ - RequestRole[] DELETE() default {OWNER, ADMIN}; + String[] DELETE() default {OWNER, ADMIN}; } diff --git a/APIJSONORM/src/main/java/apijson/NotNull.java b/APIJSONORM/src/main/java/apijson/NotNull.java index d10a93691..1265ccac7 100755 --- a/APIJSONORM/src/main/java/apijson/NotNull.java +++ b/APIJSONORM/src/main/java/apijson/NotNull.java @@ -1,4 +1,4 @@ -/*Copyright (C) 2020 THL A29 Limited, a Tencent company. All rights reserved. +/*Copyright (C) 2020 Tencent. All rights reserved. This source code is licensed under the Apache License Version 2.0.*/ diff --git a/APIJSONORM/src/main/java/apijson/RequestMethod.java b/APIJSONORM/src/main/java/apijson/RequestMethod.java index e196e4dc0..27e4cab64 100755 --- a/APIJSONORM/src/main/java/apijson/RequestMethod.java +++ b/APIJSONORM/src/main/java/apijson/RequestMethod.java @@ -1,10 +1,13 @@ -/*Copyright (C) 2020 THL A29 Limited, a Tencent company. All rights reserved. +/*Copyright (C) 2020 Tencent. All rights reserved. This source code is licensed under the Apache License Version 2.0.*/ package apijson; +import java.util.Arrays; +import java.util.List; + /**请求方法，对应org.springframework.web.bind.annotation.RequestMethod，多出GETS,HEADS方法 * @author Lemon */ @@ -43,17 +46,25 @@ public enum RequestMethod { /** * 删除数据 */ - DELETE; - + DELETE, + + /** + * json 包含多条语句，支持增删改查、函数调用 + */ + CRUD; + public static final RequestMethod[] ALL = new RequestMethod[]{ GET, HEAD, GETS, HEADS, POST, PUT, DELETE, CRUD }; + public static final List ALL_NAME_LIST = Arrays.asList( + GET.name(), HEAD.name(), GETS.name(), HEADS.name(), POST.name(), PUT.name(), DELETE.name(), CRUD.name() + ); + /**是否为GET请求方法 * @param method * @param containPrivate 包含私密(非明文)获取方法GETS * @return */ public static boolean isGetMethod(RequestMethod method, boolean containPrivate) { - boolean is = method == null || method == GET; - return containPrivate == false ? is : is || method == GETS; + return method == null || method == GET || (containPrivate && method == GETS); } /**是否为HEAD请求方法 @@ -62,8 +73,7 @@ public static boolean isGetMethod(RequestMethod method, boolean containPrivate) * @return */ public static boolean isHeadMethod(RequestMethod method, boolean containPrivate) { - boolean is = method == HEAD; - return containPrivate == false ? is : is || method == HEADS; + return method == HEAD || (containPrivate && method == HEADS); } /**是否为查询的请求方法 @@ -73,6 +83,14 @@ public static boolean isHeadMethod(RequestMethod method, boolean containPrivate) public static boolean isQueryMethod(RequestMethod method) { return isGetMethod(method, true) || isHeadMethod(method, true); } + + /**是否为更新(增删改)的请求方法 + * @param method + * @return 读操作(GET型或HEAD型) - false, 写操作(POST,PUT,DELETE) - true + */ + public static boolean isUpdateMethod(RequestMethod method) { + return ! isQueryMethod(method); + } /**是否为开放(不限制请求的结构或内容；明文，浏览器能直接访问及查看)的请求方法 * @param method @@ -82,6 +100,14 @@ public static boolean isPublicMethod(RequestMethod method) { return method == null || method == GET || method == HEAD; } + /**是否为私有(限制请求的结构或内容)的请求方法 + * @param method + * @return + */ + public static boolean isPrivateMethod(RequestMethod method) { + return ! isPublicMethod(method); + } + public static String getName(RequestMethod method) { return method == null ? GET.name() : method.name(); } diff --git a/APIJSONORM/src/main/java/apijson/RequestRole.java b/APIJSONORM/src/main/java/apijson/RequestRole.java deleted file mode 100755 index d1d00b18b..000000000 --- a/APIJSONORM/src/main/java/apijson/RequestRole.java +++ /dev/null @@ -1,60 +0,0 @@ -/*Copyright (C) 2020 THL A29 Limited, a Tencent company. All rights reserved. - -This source code is licensed under the Apache License Version 2.0.*/ - - -package apijson; - -/**来访的用户角色 - * @author Lemon - */ -public enum RequestRole { - - /**未登录，不明身份的用户 - */ - UNKNOWN, - - /**已登录的用户 - */ - LOGIN, - - /**联系人，必须已登录 - */ - CONTACT, - - /**圈子成员(CONTACT + OWNER)，必须已登录 - */ - CIRCLE, - - /**拥有者，必须已登录 - */ - OWNER, - - /**管理员，必须已登录 - */ - ADMIN; - - //似乎不管怎么做，外部引用后都是空值。并且如果在注解内的位置不是最前的，还会导致被注解的类在其它类中import报错。 - //虽然直接打印显示正常，但被@MethodAccess内RequestRole[] GET()等方法引用后获取的是空值 - // public static final RequestRole[] ALL = {RequestRole.UNKNOWN};//values();//所有 - // public static final RequestRole[] HIGHS;//高级 - // static { - // HIGHS = new RequestRole[] {OWNER, ADMIN}; - // } - - public static final String[] NAMES = { - UNKNOWN.name(), LOGIN.name(), CONTACT.name(), CIRCLE.name(), OWNER.name(), ADMIN.name() - }; - - public static RequestRole get(String name) throws Exception { - if (name == null) { - return null; - } - try { //Enum.valueOf只要找不到对应的值就会抛异常 - return RequestRole.valueOf(name); - } catch (Exception e) { - throw new IllegalArgumentException("角色 " + name + " 不存在！只能是[" + StringUtil.getString(NAMES) + "]中的一种！", e); - } - } - -} diff --git a/APIJSONORM/src/main/java/apijson/SQL.java b/APIJSONORM/src/main/java/apijson/SQL.java index ce55eab29..868f0d2aa 100755 --- a/APIJSONORM/src/main/java/apijson/SQL.java +++ b/APIJSONORM/src/main/java/apijson/SQL.java @@ -1,4 +1,4 @@ -/*Copyright (C) 2020 THL A29 Limited, a Tencent company. All rights reserved. +/*Copyright (C) 2020 Tencent. All rights reserved. This source code is licensed under the Apache License Version 2.0.*/ @@ -10,13 +10,18 @@ */ public class SQL { + public static final String JOIN = " JOIN "; + public static final String ON = " ON "; public static final String OR = " OR "; public static final String AND = " AND "; public static final String NOT = " NOT "; public static final String AS = " AS "; - public static final String IS = " is "; - public static final String NULL = " null "; - + public static final String IS = " IS "; + public static final String NULL = " NULL "; + public static final String IS_NOT = " IS NOT "; + public static final String IS_NULL = " IS NULL "; + public static final String IS_NOT_NULL = " IS NOT NULL "; + //括号必须紧跟函数名！ count (...) 报错！ public static final String COUNT = "count"; public static final String SUM = "sum"; @@ -111,6 +116,13 @@ public static String lengthCompare(String s, String compare) { public static String length(String s) { return "length(" + s + ")"; } + /** + * @param s 因为POWER(x,y)等函数含有不只一个key，所以需要客户端添加进去，服务端检测到条件中有'('和')'时就不转换，直接当SQL语句查询 + * @return "json_length(" + s + ")" + */ + public static String json_length(String s) { + return "json_length(" + s + ")"; + } /** * @param s 因为POWER(x,y)等函数含有不只一个key，所以需要客户端添加进去，服务端检测到条件中有'('和')'时就不转换，直接当SQL语句查询 * @return "char_length(" + s + ")" @@ -186,7 +198,7 @@ public static String indexOf(String s, String c) { public static String replace(String s, String c1, String c2) { return "replace(" + s + ", " + c1 + ", " + c2 + ")"; } - + /** * @param s1 * @param s2 @@ -220,17 +232,17 @@ public static String toLowerCase(String s) { return "lower(" + s + ")"; } - - + + //column and function<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< - + /**字段 * @param column * @return column.isEmpty() ? "*" : column; */ public static String column(String column) { - column = StringUtil.getTrimedString(column); + column = StringUtil.trim(column); return column.isEmpty() ? "*" : column; } /**有别名的字段 @@ -240,15 +252,16 @@ public static String column(String column) { public static String columnAs(String column) { return count(column) + AS; } - + /**函数 * @param column if (StringUtil.isEmpty(column, true) || column.contains(",")) -> column = null; * @return " " + fun + "(" + {@link #column(String)} + ") "; */ public static String function(String fun, String column) { - if (StringUtil.isEmpty(column, true) || column.contains(",")) { - column = null; //解决 count(id,name) 这种多个字段导致的SQL异常 - } + // 支持 fun(col1,col2..) + // if (StringUtil.isEmpty(column, true) || column.contains(",")) { + // column = null; //解决 count(id,name) 这种多个字段导致的SQL异常 + // } return " " + fun + "(" + column(column) + ") "; } /**有别名的函数 @@ -258,7 +271,7 @@ public static String function(String fun, String column) { public static String functionAs(String fun, String column) { return function(fun, column) + AS + fun + " "; } - + /**计数 * column = null * @return {@link #count(String)} @@ -308,9 +321,9 @@ public static String avg(String column) { } //column and function>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>> - - - + + + //search<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< public static final int SEARCH_TYPE_CONTAIN_FULL = 0; @@ -383,7 +396,16 @@ public static String search(String s, int type, boolean ignoreCase) { return "%" + s + "%"; } } - + //search>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>> + + public static boolean isBooleanOrNumber(String type) { + type = StringUtil.toUpperCase(type, true); + return type.isEmpty() || (type.endsWith("INT") && type.endsWith("POINT") == false) + || type.endsWith("BOOLEAN") || type.endsWith("ENUM") + || type.endsWith("FLOAT") || type.endsWith("DOUBLE") || type.endsWith("DECIMAL"); + } + + } diff --git a/APIJSONORM/src/main/java/apijson/StringUtil.java b/APIJSONORM/src/main/java/apijson/StringUtil.java index 7f8fa831c..179161005 100755 --- a/APIJSONORM/src/main/java/apijson/StringUtil.java +++ b/APIJSONORM/src/main/java/apijson/StringUtil.java @@ -1,4 +1,4 @@ -/*Copyright (C) 2020 THL A29 Limited, a Tencent company. All rights reserved. +/*Copyright (C) 2020 Tencent. All rights reserved. This source code is licensed under the Apache License Version 2.0.*/ @@ -8,6 +8,7 @@ import java.io.File; import java.math.BigDecimal; import java.text.DecimalFormat; +import java.util.Objects; import java.util.regex.Pattern; /**通用字符串(String)相关类,为null时返回"" @@ -52,169 +53,317 @@ public StringUtil() { public static final String YUAN = "元"; - private static String currentString = ""; - /**获取刚传入处理后的string + private static String current = ""; + /**获取刚传入处理后的 string + * @must 上个影响 current 的方法 和 这个方法都应该在同一线程中，否则返回值可能不对 + * @return + */ + public static String cur() { + return get(current); + } + + /**FIXME 改用 cur * @must 上个影响currentString的方法 和 这个方法都应该在同一线程中，否则返回值可能不对 * @return */ + @Deprecated public static String getCurrentString() { - return currentString == null ? "" : currentString; + return cur(); } //获取string,为null时返回"" <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< /**获取string,为null则返回"" + * @param obj + * @return + */ + public static String get(Object obj) { + return obj == null ? "" : obj.toString(); + } + /**获取string,为null则返回"" + * @param s + * @return + */ + public static String get(String s) { + return s == null ? "" : s; + } + /**获取string,为null则返回"" + * ignoreEmptyItem = false; + * split = "," + * @param arr + * @return {@link #get(Object[], boolean)} + */ + public static String get(Object[] arr) { + return get(arr, false); + } + /**获取string,为null则返回"" + * split = "," + * @param arr + * @param ignoreEmptyItem + * @return {@link #get(Object[], boolean)} + */ + public static String get(Object[] arr, boolean ignoreEmptyItem) { + return get(arr, null, ignoreEmptyItem); + } + /**获取string,为null则返回"" + * ignoreEmptyItem = false; + * @param arr + * @param split + * @return {@link #get(Object[], String, boolean)} + */ + public static String get(Object[] arr, String split) { + return get(arr, split, false); + } + //CS304 Issue link: https://github.com/Tencent/APIJSON/issues/182 + /**获取string,为null则返回"" + * @param arr -the str arr given + * @param split -the token used to split + * @param ignoreEmptyItem -whether to ignore empty item or not + * @return {@link #get(Object[], String, boolean)} + *

Here we replace the simple "+" way of concatenating with Stringbuilder 's append

+ */ + public static String get(Object[] arr, String split, boolean ignoreEmptyItem) { + StringBuilder s = new StringBuilder(""); + if (arr != null) { + if (split == null) { + split = ","; + } + for (int i = 0; i < arr.length; i++) { + if (ignoreEmptyItem && isEmpty(arr[i], true)) { + continue; + } + s.append(((i > 0 ? split : "") + arr[i])); + } + } + return get(s.toString()); + } + + /**FIXME 用 get 替代 * @param object * @return */ + @Deprecated public static String getString(Object object) { return object == null ? "" : object.toString(); } - /**获取string,为null则返回"" + /**FIXME 用 get 替代 * @param cs * @return */ + @Deprecated public static String getString(CharSequence cs) { return cs == null ? "" : cs.toString(); } - /**获取string,为null则返回"" + /**FIXME 用 get 替代 * @param s * @return */ + @Deprecated public static String getString(String s) { return s == null ? "" : s; } - /**获取string,为null则返回"" + /**FIXME 用 get 替代 * ignoreEmptyItem = false; * split = "," * @param array - * @return {@link #getString(Object[], boolean)} + * @return {@link #get(Object[], boolean)} */ + @Deprecated public static String getString(Object[] array) { - return getString(array, false); + return get(array, false); } - /**获取string,为null则返回"" + /**FIXME 用 get 替代 * split = "," * @param array * @param ignoreEmptyItem - * @return {@link #getString(Object[], boolean)} + * @return {@link #get(Object[], boolean)} */ + @Deprecated public static String getString(Object[] array, boolean ignoreEmptyItem) { - return getString(array, null, ignoreEmptyItem); + return get(array, null, ignoreEmptyItem); } - /**获取string,为null则返回"" + /**FIXME 用 get 替代 * ignoreEmptyItem = false; * @param array * @param split - * @return {@link #getString(Object[], String, boolean)} + * @return {@link #get(Object[], String, boolean)} */ + @Deprecated public static String getString(Object[] array, String split) { - return getString(array, split, false); + return get(array, split, false); } - /**获取string,为null则返回"" - * @param array - * @param split - * @param ignoreEmptyItem - * @return + //CS304 Issue link: https://github.com/Tencent/APIJSON/issues/182 + /**FIXME 用 get 替代 + * @param array -the str array given + * @param split -the token used to split + * @param ignoreEmptyItem -whether to ignore empty item or not + * @return {@link #get(Object[], String, boolean)} + *

Here we replace the simple "+" way of concatenating with Stringbuilder 's append

*/ + @Deprecated public static String getString(Object[] array, String split, boolean ignoreEmptyItem) { - String s = ""; - if (array != null) { - if (split == null) { - split = ","; - } - for (int i = 0; i < array.length; i++) { - if (ignoreEmptyItem && isEmpty(array[i], true)) { - continue; - } - s += ((i > 0 ? split : "") + array[i]); - } - } - return getString(s); + return get(array, split, ignoreEmptyItem); } //获取string,为null时返回"" >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>> //获取去掉前后空格后的string<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< - /**获取去掉前后空格后的string,为null则返回"" + * @param obj + * @return + */ + public static String trim(Object obj) { + return trim(get(obj)); + } + /**获取去掉前后空格后的string,为null则返回"" + * @param cs + * @return + */ + public static String trim(CharSequence cs) { + return trim(get(cs)); + } + /**获取去掉前后空格后的string,为null则返回"" + * @param s + * @return + */ + public static String trim(String s) { + return get(s).trim(); + } + + + /**FIXME 用 trim 替代 * @param object * @return */ + @Deprecated public static String getTrimedString(Object object) { - return getTrimedString(getString(object)); + return trim(object); } - /**获取去掉前后空格后的string,为null则返回"" + /**FIXME 用 trim 替代 * @param cs * @return */ + @Deprecated public static String getTrimedString(CharSequence cs) { - return getTrimedString(getString(cs)); + return trim(cs); } - /**获取去掉前后空格后的string,为null则返回"" + /**FIXME 用 trim 替代 * @param s * @return */ + @Deprecated public static String getTrimedString(String s) { - return getString(s).trim(); + return trim(s); } //获取去掉前后空格后的string>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>> //获取去掉所有空格后的string <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< - /**获取去掉所有空格后的string,为null则返回"" + * @param obj + * @return + */ + public static String noBlank(Object obj) { + return noBlank(get(obj)); + } + /**获取去掉所有空格后的string,为null则返回"" + * @param cs + * @return + */ + public static String noBlank(CharSequence cs) { + return noBlank(get(cs)); + } + /**获取去掉所有空格后的string,为null则返回"" + * @param s + * @return + */ + public static String noBlank(String s) { + return get(s).replaceAll("\\s", ""); + } + + /**FIXME 用 noBlank 替代 * @param object * @return */ + @Deprecated public static String getNoBlankString(Object object) { - return getNoBlankString(getString(object)); + return noBlank(object); } - /**获取去掉所有空格后的string,为null则返回"" + /**FIXME 用 noBlank 替代 * @param cs * @return */ + @Deprecated public static String getNoBlankString(CharSequence cs) { - return getNoBlankString(getString(cs)); + return noBlank(cs); } - /**获取去掉所有空格后的string,为null则返回"" + /**FIXME 用 noBlank 替代 * @param s * @return */ + @Deprecated public static String getNoBlankString(String s) { - return getString(s).replaceAll("\\s", ""); + return noBlank(s); } //获取去掉所有空格后的string >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>> //获取string的长度<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< - /**获取string的长度,为null则返回0 * @param object * @param trim * @return */ - public static int getLength(Object object, boolean trim) { - return getLength(getString(object), trim); + public static int length(Object object, boolean trim) { + return length(get(object), trim); } /**获取string的长度,为null则返回0 * @param cs * @param trim * @return */ - public static int getLength(CharSequence cs, boolean trim) { - return getLength(getString(cs), trim); + public static int length(CharSequence cs, boolean trim) { + return length(get(cs), trim); } /**获取string的长度,为null则返回0 * @param s * @param trim * @return */ + public static int length(String s, boolean trim) { + s = trim ? trim(s) : s; + return get(s).length(); + } + + + /**FIXME 用 length 替代 + * @param object + * @param trim + * @return + */ + @Deprecated + public static int getLength(Object object, boolean trim) { + return length(object, trim); + } + /**FIXME 用 length 替代 + * @param cs + * @param trim + * @return + */ + @Deprecated + public static int getLength(CharSequence cs, boolean trim) { + return length(cs, trim); + } + /**FIXME 用 length 替代 + * @param s + * @param trim + * @return + */ + @Deprecated public static int getLength(String s, boolean trim) { - s = trim ? getTrimedString(s) : s; - return getString(s).length(); + return length(s, trim); } //获取string的长度>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>> @@ -222,13 +371,27 @@ public static int getLength(String s, boolean trim) { //判断字符是否为空 <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< + /**判断字符是否为空 trim = true + * @param obj + * @return + */ + public static boolean isEmpty(Object obj) { + return isEmpty(obj, true); + } /**判断字符是否为空 - * @param object + * @param obj * @param trim * @return */ - public static boolean isEmpty(Object object, boolean trim) { - return isEmpty(getString(object), trim); + public static boolean isEmpty(Object obj, boolean trim) { + return isEmpty(get(obj), trim); + } + /**判断字符是否为空 trim = true + * @param cs + * @return + */ + public static boolean isEmpty(CharSequence cs) { + return isEmpty(cs, true); } /**判断字符是否为空 * @param cs @@ -236,7 +399,14 @@ public static boolean isEmpty(Object object, boolean trim) { * @return */ public static boolean isEmpty(CharSequence cs, boolean trim) { - return isEmpty(getString(cs), trim); + return isEmpty(get(cs), trim); + } + /**判断字符是否为空 trim = true + * @param s + * @return + */ + public static boolean isEmpty(String s) { + return isEmpty(s, true); } /**判断字符是否为空 * @param s @@ -244,7 +414,7 @@ public static boolean isEmpty(CharSequence cs, boolean trim) { * @return */ public static boolean isEmpty(String s, boolean trim) { - // Log.i(TAG, "getTrimedString s = " + s); + // Log.i(TAG, "isEmpty s = " + s); if (s == null) { return true; } @@ -255,7 +425,7 @@ public static boolean isEmpty(String s, boolean trim) { return true; } - currentString = s; + current = s; return false; } @@ -264,13 +434,27 @@ public static boolean isEmpty(String s, boolean trim) { //判断字符是否非空 <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< + /**判断字符是否非空 trim = true + * @param obj + * @return + */ + public static boolean isNotEmpty(Object obj) { + return ! isEmpty(obj); + } /**判断字符是否非空 - * @param object + * @param obj * @param trim * @return */ - public static boolean isNotEmpty(Object object, boolean trim) { - return isNotEmpty(getString(object), trim); + public static boolean isNotEmpty(Object obj, boolean trim) { + return ! isEmpty(obj, trim); + } + /**判断字符是否非空 trim = true + * @param cs + * @return + */ + public static boolean isNotEmpty(CharSequence cs) { + return ! isEmpty(cs); } /**判断字符是否非空 * @param cs @@ -278,7 +462,14 @@ public static boolean isNotEmpty(Object object, boolean trim) { * @return */ public static boolean isNotEmpty(CharSequence cs, boolean trim) { - return isNotEmpty(getString(cs), trim); + return ! isEmpty(cs, trim); + } + /**判断字符是否非空 trim = true + * @param s + * @return + */ + public static boolean isNotEmpty(String s) { + return ! isEmpty(s); } /**判断字符是否非空 * @param s @@ -298,21 +489,26 @@ public static boolean isNotEmpty(String s, boolean trim) { public static final Pattern PATTERN_PHONE; public static final Pattern PATTERN_EMAIL; public static final Pattern PATTERN_ID_CARD; + public static final Pattern PATTERN_NUM_OR_ALPHA; public static final Pattern PATTERN_ALPHA; public static final Pattern PATTERN_PASSWORD; //TODO public static final Pattern PATTERN_NAME; public static final Pattern PATTERN_ALPHA_BIG; public static final Pattern PATTERN_ALPHA_SMALL; + public static final Pattern PATTERN_BRANCH_URL; static { PATTERN_NUMBER = Pattern.compile("^[0-9]+$"); + PATTERN_NUM_OR_ALPHA = Pattern.compile("^[0-9a-zA-Z_.:]+$"); PATTERN_ALPHA = Pattern.compile("^[a-zA-Z]+$"); PATTERN_ALPHA_BIG = Pattern.compile("^[A-Z]+$"); PATTERN_ALPHA_SMALL = Pattern.compile("^[a-z]+$"); - PATTERN_NAME = Pattern.compile("^[0-9a-zA-Z_]+$");//已用55个中英字符测试通过 - PATTERN_PHONE = Pattern.compile("^((13[0-9])|(15[^4,\\D])|(18[0-2,5-9])|(17[0-9]))\\d{8}$"); + PATTERN_NAME = Pattern.compile("^[0-9a-zA-Z_.:]+$");//已用55个中英字符测试通过 + //newest phone regex expression reference https://github.com/VincentSit/ChinaMobilePhoneNumberRegex + PATTERN_PHONE = Pattern.compile("^1(?:3\\d{3}|5[^4\\D]\\d{2}|8\\d{3}|7(?:[0-35-9]\\d{2}|4(?:0\\d|1[0-2]|9\\d))|9[0-35-9]\\d{2}|6[2567]\\d{2}|4(?:(?:10|4[01])\\d{3}|[68]\\d{4}|[579]\\d{2}))\\d{6}$"); PATTERN_EMAIL = Pattern.compile("^([a-zA-Z0-9_\\-\\.]+)@((\\[[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}\\.)|(([a-zA-Z0-9\\-]+\\.)+))([a-zA-Z]{2,4}|[0-9]{1,3})(\\]?)$"); PATTERN_ID_CARD = Pattern.compile("(^[1-9]\\d{5}(18|19|([23]\\d))\\d{2}((0[1-9])|(10|11|12))(([0-2][1-9])|10|20|30|31)\\d{3}[0-9Xx]$)|(^[1-9]\\d{5}\\d{2}((0[1-9])|(10|11|12))(([0-2][1-9])|10|20|30|31)\\d{2}$)"); PATTERN_PASSWORD = Pattern.compile("^[0-9a-zA-Z]+$"); + PATTERN_BRANCH_URL = Pattern.compile("^[0-9a-zA-Z-_/]+$"); } /**判断手机格式是否正确 @@ -324,7 +520,7 @@ public static boolean isPhone(String phone) { return false; } - currentString = phone; + current = phone; return PATTERN_PHONE.matcher(phone).matches(); } /**判断手机格式是否正确 @@ -332,25 +528,25 @@ public static boolean isPhone(String phone) { * @return */ public static boolean isPassword(String s) { - return getLength(s, false) >= 6 && PATTERN_PASSWORD.matcher(s).matches(); + return length(s, false) >= 6 && PATTERN_PASSWORD.matcher(s).matches(); } /**判断是否全是数字密码 * @param s * @return */ public static boolean isNumberPassword(String s) { - return getLength(s, false) == 6 && isNumer(s); + return length(s, false) == 6 && isNumber(s); } /**判断email格式是否正确 * @param email * @return */ public static boolean isEmail(String email) { - if (isNotEmpty(email, true) == false) { + if (isEmpty(email, true)) { return false; } - currentString = email; + current = email; return PATTERN_EMAIL.matcher(email).matches(); } @@ -360,18 +556,18 @@ public static boolean isEmail(String email) { * @return */ public static boolean isVerify(String s) { - return getLength(s, false) >= 4 && isNumer(s); + return length(s, false) >= 4 && isNumber(s); } /**判断是否全是数字 * @param s * @return */ - public static boolean isNumer(String s) { - if (isNotEmpty(s, true) == false) { + public static boolean isNumber(String s) { + if (isEmpty(s, true)) { return false; } - currentString = s; + current = s; return PATTERN_NUMBER.matcher(s).matches(); } /**判断是否全是字母 @@ -383,7 +579,7 @@ public static boolean isAlpha(String s) { return false; } - currentString = s; + current = s; return PATTERN_ALPHA.matcher(s).matches(); } /**判断是否全是数字或字母 @@ -391,7 +587,20 @@ public static boolean isAlpha(String s) { * @return */ public static boolean isNumberOrAlpha(String s) { - return isNumer(s) || isAlpha(s); + return isNumber(s) || isAlpha(s); + } + + /**判断是否全是数字或字母 + * @param s + * @return + */ + public static boolean isCombineOfNumOrAlpha(String s) { + if (isEmpty(s, true)) { + return false; + } + + current = s; + return PATTERN_NUM_OR_ALPHA.matcher(s).matches(); } /**判断是否为代码名称，只能包含字母，数字或下划线 @@ -399,29 +608,36 @@ public static boolean isNumberOrAlpha(String s) { * @return */ public static boolean isName(String s) { - return s != null && PATTERN_NAME.matcher(s).matches(); + if (s == null || s.isEmpty()) { + return false; + } + + String first = s.substring(0, 1); + if ("_".equals(first) == false && PATTERN_ALPHA.matcher(first).matches() == false) { + return false; + } + + return s.length() <= 1 ? true : PATTERN_NAME.matcher(s.substring(1)).matches(); } /**判断是否为首字母大写的代码名称 * @param s * @return */ public static boolean isBigName(String s) { - s = getString(s); - if (s.isEmpty() || PATTERN_ALPHA_BIG.matcher(s.substring(0, 1)).matches() == false) { + if (s == null || s.isEmpty() || PATTERN_ALPHA_BIG.matcher(s.substring(0, 1)).matches() == false) { return false; } - return s.length() <= 1 ? true : isName(s.substring(1)); + return s.length() <= 1 ? true : PATTERN_NAME.matcher(s.substring(1)).matches(); } /**判断是否为首字母小写的代码名称 * @param s * @return */ public static boolean isSmallName(String s) { - s = getString(s); - if (s.isEmpty() || PATTERN_ALPHA_SMALL.matcher(s.substring(0, 1)).matches() == false) { + if (s == null || s.isEmpty() || PATTERN_ALPHA_SMALL.matcher(s.substring(0, 1)).matches() == false) { return false; } - return s.length() <= 1 ? true : isName(s.substring(1)); + return s.length() <= 1 ? true : PATTERN_NAME.matcher(s.substring(1)).matches(); } @@ -430,17 +646,17 @@ public static boolean isSmallName(String s) { * @return */ public static boolean isIDCard(String number) { - if (isNumberOrAlpha(number) == false) { + if (isCombineOfNumOrAlpha(number) == false) { return false; } - number = getString(number); + number = get(number); if (number.length() == 15) { Log.i(TAG, "isIDCard number.length() == 15 old IDCard"); - currentString = number; + current = number; return true; } if (number.length() == 18) { - currentString = number; + current = number; return true; } @@ -450,8 +666,6 @@ public static boolean isIDCard(String number) { public static final String HTTP = "http"; public static final String URL_PREFIX = "http://"; public static final String URL_PREFIXs = "https://"; - public static final String URL_STAFFIX = URL_PREFIX; - public static final String URL_STAFFIXs = URL_PREFIXs; /**判断字符类型是否是网址 * @param url * @return @@ -459,14 +673,24 @@ public static boolean isIDCard(String number) { public static boolean isUrl(String url) { if (isNotEmpty(url, true) == false) { return false; - } else if (! url.startsWith(URL_PREFIX) && ! url.startsWith(URL_PREFIXs)) { + } + if (! url.startsWith(URL_PREFIX) && ! url.startsWith(URL_PREFIXs)) { return false; } - currentString = url; + current = url; return true; } + public static boolean isBranchUrl(String branchUrl) { + if (isEmpty(branchUrl, false)) { + return false; + } + + return PATTERN_BRANCH_URL.matcher(branchUrl).matches(); + } + + public static final String FILE_PATH_PREFIX = "file://"; /**判断文件路径是否存在 * @param path @@ -499,7 +723,7 @@ public static boolean isFilePath(String path) { return false; } - currentString = path; + current = path; return true; } @@ -514,14 +738,14 @@ public static boolean isFilePath(String path) { * @return */ public static String getNumber(Object object) { - return getNumber(getString(object)); + return getNumber(get(object)); } /**去掉string内所有非数字类型字符 * @param cs * @return */ public static String getNumber(CharSequence cs) { - return getNumber(getString(cs)); + return getNumber(get(cs)); } /**去掉string内所有非数字类型字符 * @param s @@ -530,30 +754,32 @@ public static String getNumber(CharSequence cs) { public static String getNumber(String s) { return getNumber(s, false); } + + //CS304 Issue link: https://github.com/Tencent/APIJSON/issues/182 /**去掉string内所有非数字类型字符 - * @param s + * @param s -string passed in * @param onlyStart 中间有非数字时只获取前面的数字 - * @return + * @return limit String + *

Here we replace the simple "+" way of concatenating with Stringbuilder 's append

*/ public static String getNumber(String s, boolean onlyStart) { - if (isNotEmpty(s, true) == false) { + if (isEmpty(s, true)) { return ""; } - String numberString = ""; + StringBuilder numberString = new StringBuilder(""); String single; for (int i = 0; i < s.length(); i++) { single = s.substring(i, i + 1); - if (isNumer(single)) { - numberString += single; + if (isNumber(single)) { + numberString.append(single); } else { if (onlyStart) { - return numberString; + return numberString.toString(); } } } - - return numberString; + return numberString.toString(); } //提取特殊字符>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>> @@ -589,7 +815,7 @@ public static String getCorrectPhone(String phone) { return ""; } - phone = getNoBlankString(phone); + phone = noBlank(phone); phone = phone.replaceAll("-", ""); if (phone.startsWith("+86")) { phone = phone.substring(3); @@ -607,7 +833,7 @@ public static String getCorrectEmail(String email) { return ""; } - email = getNoBlankString(email); + email = noBlank(email); if (isEmail(email) == false && ! email.endsWith(".com")) { email += ".com"; } @@ -632,10 +858,12 @@ public static String getCorrectEmail(String email) { public static String getPrice(String price) { return getPrice(price, PRICE_FORMAT_DEFAULT); } + //CS304 Issue link: https://github.com/Tencent/APIJSON/issues/182 /**获取价格，保留两位小数 - * @param price + * @param price -price passed in * @param formatType 添加单位（元） - * @return + * @return limit String + *

Here we replace the simple "+" way of concatenating with Stringbuilder 's append

*/ public static String getPrice(String price, int formatType) { if (isNotEmpty(price, true) == false) { @@ -643,14 +871,16 @@ public static String getPrice(String price, int formatType) { } //单独写到getCorrectPrice? <<<<<<<<<<<<<<<<<<<<<< - String correctPrice = ""; + String correctPrice; + StringBuilder correctPriceBuilder = new StringBuilder(""); String s; for (int i = 0; i < price.length(); i++) { s = price.substring(i, i + 1); - if (".".equals(s) || isNumer(s)) { - correctPrice += s; + if (".".equals(s) || isNumber(s)) { + correctPriceBuilder.append(s); } } + correctPrice = correctPriceBuilder.toString(); //单独写到getCorrectPrice? >>>>>>>>>>>>>>>>>>>>>> Log.i(TAG, "getPrice <<<<<<<<<<<<<<<<<< correctPrice = " + correctPrice); @@ -709,7 +939,29 @@ public static String getPrice(double price, int formatType) { } } + public static String join(String[] arr) { + return join(arr); + } + /** 数组以指定分隔s拼接 + * @param arr + * @param s + * @return + */ + public static String join(String[] arr, String s) { + if (s == null) { + s = ","; + } + + StringBuilder sb = new StringBuilder(); + for (int i = 0; i < arr.length; i++) { + sb.append(arr[i]); + if (i < arr.length-1) { + sb.append(s); + } + } + return sb.toString(); + } /**分割路径 * @param path * @return @@ -751,7 +1003,7 @@ public static String[] split(String s, boolean trim) { * @return */ public static String[] split(String s, String split, boolean trim) { - s = getString(s); + s = get(s); if (s.isEmpty()) { return null; } @@ -775,7 +1027,7 @@ public static String[] split(String s, String split, boolean trim) { * @return key + suffix，第一个字母小写 */ public static String addSuffix(String key, String suffix) { - key = getNoBlankString(key); + key = noBlank(key); if (key.isEmpty()) { return firstCase(suffix); } @@ -793,7 +1045,7 @@ public static String firstCase(String key) { * @return */ public static String firstCase(String key, boolean upper) { - key = getString(key); + key = get(key); if (key.isEmpty()) { return ""; } @@ -817,7 +1069,7 @@ public static String toUpperCase(String s) { * @return */ public static String toUpperCase(String s, boolean trim) { - s = trim ? getTrimedString(s) : getString(s); + s = trim ? trim(s) : get(s); return s.toUpperCase(); } /**全部小写 @@ -832,7 +1084,7 @@ public static String toLowerCase(String s) { * @return */ public static String toLowerCase(String s, boolean trim) { - s = trim ? getTrimedString(s) : getString(s); + s = trim ? trim(s) : get(s); return s.toLowerCase(); } @@ -861,4 +1113,18 @@ public static String concat(String left, String right, String split, boolean tri //校正（自动补全等）字符串>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>> + + public static boolean equals(Object s1, Object s2) { + return Objects.equals(s1, s2); + } + public static boolean equalsIgnoreCase(String s1, String s2) { + if (s1 == s2) { + return true; + } + if (s1 == null || s2 == null) { + return false; + } + return s1.equalsIgnoreCase(s2); + } + } diff --git a/APIJSONORM/src/main/java/apijson/orm/AbstractFunctionParser.java b/APIJSONORM/src/main/java/apijson/orm/AbstractFunctionParser.java index d712b15f5..42831775b 100755 --- a/APIJSONORM/src/main/java/apijson/orm/AbstractFunctionParser.java +++ b/APIJSONORM/src/main/java/apijson/orm/AbstractFunctionParser.java @@ -1,184 +1,452 @@ -/*Copyright (C) 2020 THL A29 Limited, a Tencent company. All rights reserved. +/*Copyright (C) 2020 Tencent. All rights reserved. This source code is licensed under the Apache License Version 2.0.*/ package apijson.orm; -import java.lang.reflect.InvocationTargetException; -import java.util.Arrays; -import java.util.HashMap; -import java.util.List; -import java.util.Map; - -import javax.activation.UnsupportedDataTypeException; +import apijson.*; +import apijson.orm.exception.UnsupportedDataTypeException; +import apijson.orm.script.ScriptExecutor; -import com.alibaba.fastjson.JSONArray; -import com.alibaba.fastjson.JSONObject; +import java.lang.invoke.WrongMethodTypeException; +import java.lang.reflect.InvocationTargetException; +import java.lang.reflect.Method; +import java.math.BigDecimal; +import java.util.*; -import apijson.NotNull; -import apijson.RequestMethod; -import apijson.StringUtil; +import static apijson.orm.AbstractSQLConfig.PATTERN_SCHEMA; /**可远程调用的函数类 * @author Lemon */ -public class AbstractFunctionParser implements FunctionParser { - // private static final String TAG = "AbstractFunctionParser"; - - // +public abstract class AbstractFunctionParser, L extends List> + implements FunctionParser { + private static final String TAG = "AbstractFunctionParser"; + + /**是否解析参数 key 的对应的值，不用手动编码 curObj.getString(key) + */ + public static boolean IS_PARSE_ARG_VALUE = false; + + /**开启支持远程函数 + */ + public static boolean ENABLE_REMOTE_FUNCTION = true; + /**开启支持远程函数中的 JavaScript 脚本形式 + */ + public static boolean ENABLE_SCRIPT_FUNCTION = true; + + // // > - public static final Map FUNCTION_MAP; + public static Map, ? extends List>> SCRIPT_EXECUTOR_MAP; + public static Map> FUNCTION_MAP; + static { FUNCTION_MAP = new HashMap<>(); + SCRIPT_EXECUTOR_MAP = new HashMap<>(); } + private Parser parser; private RequestMethod method; private String tag; private int version; - private JSONObject request; + private String key; + private String parentPath; + private String currentName; + private M request; + private M current; + public AbstractFunctionParser() { this(null, null, 0, null); } - public AbstractFunctionParser(RequestMethod method, String tag, int version, @NotNull JSONObject request) { + + public AbstractFunctionParser(RequestMethod method, String tag, int version, @NotNull M request) { setMethod(method == null ? RequestMethod.GET : method); setTag(tag); setVersion(version); setRequest(request); } + @NotNull + @Override + public Parser getParser() { + return parser; + } + + @Override + public AbstractFunctionParser setParser(Parser parser) { + this.parser = parser; + return this; + } + + @NotNull @Override public RequestMethod getMethod() { - return method; + return method == null ? RequestMethod.GET : method; } + @Override - public AbstractFunctionParser setMethod(RequestMethod method) { + public AbstractFunctionParser setMethod(RequestMethod method) { this.method = method; return this; } + @Override public String getTag() { return tag; } + @Override - public AbstractFunctionParser setTag(String tag) { + public AbstractFunctionParser setTag(String tag) { this.tag = tag; return this; } + @Override public int getVersion() { return version; } + @Override - public AbstractFunctionParser setVersion(int version) { + public AbstractFunctionParser setVersion(int version) { this.version = version; return this; } - - private String key; + @Override public String getKey() { return key; } + @Override - public AbstractFunctionParser setKey(String key) { + public AbstractFunctionParser setKey(String key) { this.key = key; return this; } - - private String parentPath; + @Override public String getParentPath() { return parentPath; } + @Override - public AbstractFunctionParser setParentPath(String parentPath) { + public AbstractFunctionParser setParentPath(String parentPath) { this.parentPath = parentPath; return this; } - private String currentName; + @Override public String getCurrentName() { return currentName; } + @Override - public AbstractFunctionParser setCurrentName(String currentName) { + public AbstractFunctionParser setCurrentName(String currentName) { this.currentName = currentName; return this; } - + @NotNull @Override - public JSONObject getRequest() { + public M getRequest() { return request; } + @Override - public AbstractFunctionParser setRequest(@NotNull JSONObject request) { + public AbstractFunctionParser setRequest(@NotNull M request) { this.request = request; return this; } - - private JSONObject currentObject; - @NotNull + + @NotNull @Override - public JSONObject getCurrentObject() { - return currentObject; + public M getCurrentObject() { + return current; } + @Override - public AbstractFunctionParser setCurrentObject(@NotNull JSONObject currentObject) { - this.currentObject = currentObject; + public AbstractFunctionParser setCurrentObject(@NotNull M current) { + this.current = current; return this; } + /**根据路径取 Boolean 值 + * @param path + * @return + */ + public Boolean getArgBool(String path) { + return getArgVal(path, Boolean.class); + } + + /**根据路径取 Integer 值 + * @param path + * @return + */ + public Integer getArgInt(String path) { + return getArgVal(path, Integer.class); + } + + /**根据路径取 Long 值 + * @param path + * @return + */ + public Long getArgLong(String path) { + return getArgVal(path, Long.class); + } + + /**根据路径取 Float 值 + * @param path + * @return + */ + public Float getArgFloat(String path) { + return getArgVal(path, Float.class); + } + + /**根据路径取 Double 值 + * @param path + * @return + */ + public Double getArgDouble(String path) { + return getArgVal(path, Double.class); + } + + /**根据路径取 Number 值 + * @param path + * @return + */ + public Number getArgNum(String path) { + return getArgVal(path, Number.class); + } + + /**根据路径取 BigDecimal 值 + * @param path + * @return + */ + public BigDecimal getArgDecimal(String path) { + return getArgVal(path, BigDecimal.class); + } + + /**根据路径取 String 值 + * @param path + * @return + */ + public String getArgStr(String path) { + Object obj = getArgVal(path); + return JSON.toJSONString(obj); + } + + /**根据路径取 JSONMap 值 + * @param path + * @return + */ + public Map getArgObj(String path) { + return getArgVal(path, Map.class); + } + + /**根据路径取 JSONList 值 + * @param path + * @return + */ + public List getArgArr(String path) { + return getArgVal(path, List.class); + } + + /**根据路径取 List 值 + * @param path + * @return + */ + public List getArgList(String path) { + return getArgList(path, null); + } + + /**根据路径取 List 值 + * @param path + * @return + */ + public List getArgList(String path, Class clazz) { + String s = getArgStr(path); + return JSON.parseArray(s, clazz); + } + + /**根据路径取值 + * @param path + * @return + * @param + */ + public T getArgVal(String path) { + return getArgVal(path, null); // 误判概率很小 false); + } + /**根据路径取值 + * @param path + * @param clazz + * @return + * @param + */ + public T getArgVal(String path, Class clazz) { + return getArgVal(getCurrentObject(), path, clazz, true); + } + /**根据路径取值 + * @param path + * @param clazz + * @param tryAll false-仅当前对象，true-本次请求的全局对象以及 Parser 缓存值 + * @return + * @param + */ + public T getArgVal(@NotNull M req, String path, Class clazz, boolean tryAll) { + T val = getArgValue(req, path, clazz); + if (tryAll == false || val != null) { + return val; + } + + Parser p = getParser(); + String targetPath = AbstractParser.getValuePath(getParentPath(), path); + return p == null ? null : (T) p.getValueByPath(targetPath); + } + /**根据路径从对象 obj 中取值 + * @param obj + * @param path + * @return + * @param + */ + public static T getArgVal(Map obj, String path) { + return getArgValue(obj, path, null); + } + + public static T getArgValue(Map obj, String path, Class clazz) { + Object v = AbstractParser.getValue(obj, StringUtil.splitPath(path)); + + if (clazz == null) { + return (T) v; + } + + // Simple type conversion + try { + if (v == null) { + return null; + } + if (clazz.isInstance(v)) { + return (T) v; + } + if (clazz == String.class) { + return (T) String.valueOf(v); + } + if (clazz == Boolean.class || clazz == boolean.class) { + return (T) Boolean.valueOf(String.valueOf(v)); + } + if (clazz == Integer.class || clazz == int.class) { + return (T) Integer.valueOf(String.valueOf(v)); + } + if (clazz == Long.class || clazz == long.class) { + return (T) Long.valueOf(String.valueOf(v)); + } + if (clazz == Double.class || clazz == double.class) { + return (T) Double.valueOf(String.valueOf(v)); + } + if (clazz == Float.class || clazz == float.class) { + return (T) Float.valueOf(String.valueOf(v)); + } + if (Map.class.isAssignableFrom(clazz)) { + if (v instanceof Map) { + return (T) v; + } + return (T) JSON.parseObject(v); + } + if (List.class.isAssignableFrom(clazz)) { + if (v instanceof List) { + return (T) v; + } + return (T) JSON.parseArray(v); + } + // Fallback to string conversion + return (T) v; + } catch (Exception e) { + return null; + } + } + /**反射调用 * @param function 例如get(object,key)，参数只允许引用，不能直接传值 - * @param currentObject 不作为第一个参数，就不能远程调用invoke，避免死循环 - * @return {@link #invoke(AbstractFunctionParser, String, JSONObject)} + * @param current 不作为第一个参数，就不能远程调用invoke，避免死循环 + * @return {@link #invoke(String, M, boolean)} */ @Override - public Object invoke(@NotNull String function, @NotNull JSONObject currentObject) throws Exception { - return invoke(this, function, currentObject); + public Object invoke(@NotNull String function, @NotNull M current) throws Exception { + return invoke(function, current, false); } - /**反射调用 - * @param parser - * @param request - * @param function 例如get(Map:map,key)，参数只允许引用，不能直接传值 - * @return {@link #invoke(AbstractFunctionParser, String, Class[], Object[])} + * @param function 例如get(object,key)，参数只允许引用，不能直接传值 + * @param current 不作为第一个参数，就不能远程调用invoke，避免死循环 + * @param containRaw 包含原始 SQL 片段 + * @return {@link #invoke(AbstractFunctionParser, String, M, boolean)} */ - public static Object invoke(@NotNull AbstractFunctionParser parser, @NotNull String function, @NotNull JSONObject currentObject) throws Exception { + @Override + public Object invoke(@NotNull String function, @NotNull M current, boolean containRaw) throws Exception { + if (StringUtil.isEmpty(function, true)) { + throw new IllegalArgumentException("字符 " + function + " 不合法！"); + } - FunctionBean fb = parseFunction(function, currentObject, false); + return invoke(this, function, current, containRaw); + } - JSONObject row = FUNCTION_MAP.get(fb.getMethod()); + /**反射调用 + * @param parser + * @param function 例如get(Map:map,key)，参数只允许引用，不能直接传值 + * @param current + * @return {@link #invoke(AbstractFunctionParser, String, Class[], Object[])} + */ + @SuppressWarnings({"unchecked", "rawtypes"}) + public static , L extends List> Object invoke( + @NotNull AbstractFunctionParser parser, @NotNull String function + , @NotNull Map current, boolean containRaw) throws Exception { + if (ENABLE_REMOTE_FUNCTION == false) { + throw new UnsupportedOperationException("AbstractFunctionParser.ENABLE_REMOTE_FUNCTION" + + " == false 时不支持远程函数！如需支持则设置 AbstractFunctionParser.ENABLE_REMOTE_FUNCTION = true ！"); + } + + FunctionBean fb = parseFunction(function, current, false, containRaw); + + Map row = FUNCTION_MAP.get(fb.getMethod()); //FIXME fb.getSchema() + "." + fb.getMethod() if (row == null) { throw new UnsupportedOperationException("不允许调用远程函数 " + fb.getMethod() + " !"); } - int v = row.getIntValue("version"); - if (parser.getVersion() < v) { - throw new UnsupportedOperationException("不允许 version = " + parser.getVersion() + " 的请求调用远程函数 " + fb.getMethod() + " ! 必须满足 version >= " + v + " !"); + String language = (String) row.get("language"); + String lang = "java".equalsIgnoreCase(language) ? null : language; + + if (ENABLE_SCRIPT_FUNCTION == false && lang != null) { + throw new UnsupportedOperationException("language = " + language + " 不合法！AbstractFunctionParser.ENABLE_SCRIPT_FUNCTION" + + " == false 时不支持远程函数中的脚本形式！如需支持则设置 AbstractFunctionParser.ENABLE_SCRIPT_FUNCTION = true ！"); + } + + if (lang != null && SCRIPT_EXECUTOR_MAP.get(lang) == null) { + throw new ClassNotFoundException("找不到脚本语言 " + lang + " 对应的执行引擎！请先依赖相关库并在后端 APIJSONFunctionParser 中注册！"); + } + + int version = row.get("version") != null ? Integer.parseInt(row.get("version").toString()) : 0; + if (parser.getVersion() < version) { + throw new UnsupportedOperationException("不允许 version = " + parser.getVersion() + " 的请求调用远程函数 " + fb.getMethod() + " ! 必须满足 version >= " + version + " !"); } - String t = row.getString("tag"); - if (t != null && t.equals(parser.getTag()) == false) { - throw new UnsupportedOperationException("不允许 tag = " + parser.getTag() + " 的请求调用远程函数 " + fb.getMethod() + " ! 必须满足 tag = " + t + " !"); + String tag = (String) row.get("tag"); // TODO 改为 tags，类似 methods 支持多个 tag。或者干脆不要？因为目前非开放请求全都只能后端指定 + if (tag != null && tag.equals(parser.getTag()) == false) { + throw new UnsupportedOperationException("不允许 tag = " + parser.getTag() + " 的请求调用远程函数 " + fb.getMethod() + " ! 必须满足 tag = " + tag + " !"); } - String[] methods = StringUtil.split(row.getString("methods")); + String[] methods = StringUtil.split((String) row.get("methods")); List ml = methods == null || methods.length <= 0 ? null : Arrays.asList(methods); if (ml != null && ml.contains(parser.getMethod().toString()) == false) { - throw new UnsupportedOperationException("不允许 method = " + parser.getMethod() + " 的请求调用远程函数 " + fb.getMethod() + " ! 必须满足 method 在 " + methods + "内 !"); + throw new UnsupportedOperationException("不允许 method = " + parser.getMethod() + " 的请求调用远程函数 " + fb.getMethod() + " ! 必须满足 method 在 " + Arrays.toString(methods) + "内 !"); } try { - return invoke(parser, fb.getMethod(), fb.getTypes(), fb.getValues()); - } catch (Exception e) { + return invoke(parser, fb.getMethod(), fb.getTypes(), fb.getValues(), (String) row.get("returnType"), current, SCRIPT_EXECUTOR_MAP.get(lang)); + } + catch (Exception e) { if (e instanceof NoSuchMethodException) { - throw new IllegalArgumentException("字符 " + function + " 对应的远程函数 " + getFunction(fb.getMethod(), fb.getKeys()) + " 不在后端工程的DemoFunction内！" + throw new IllegalArgumentException("字符 " + function + " 对应的远程函数 " + getFunction(fb.getMethod(), fb.getKeys()) + + " 不在后端 " + parser.getClass().getName() + " 内，也不在父类中！如果需要则先新增对应方法！" + "\n请检查函数名和参数数量是否与已定义的函数一致！" + "\n且必须为 function(key0,key1,...) 这种单函数格式！" - + "\nfunction必须符合Java函数命名，key是用于在request内取值的键！" - + "\n调用时不要有空格！"); + + "\nfunction 必须符合 Java 函数命名，key 是用于在 curObj 内取值的键！" + + "\n调用时不要有空格！" + (Log.DEBUG ? e.getMessage() : "")); } if (e instanceof InvocationTargetException) { Throwable te = ((InvocationTargetException) e).getTargetException(); @@ -186,57 +454,173 @@ public static Object invoke(@NotNull AbstractFunctionParser parser, @NotNull Str throw te instanceof Exception ? (Exception) te : new Exception(te.getMessage()); } throw new IllegalArgumentException("字符 " + function + " 对应的远程函数传参类型错误！" - + "\n请检查 key:value 中value的类型是否满足已定义的函数 " + getFunction(fb.getMethod(), fb.getKeys()) + " 的要求！"); + + "\n请检查 key:value 中value的类型是否满足已定义的函数 " + getFunction(fb.getMethod(), fb.getKeys()) + " 的要求！" + + (Log.DEBUG ? e.getMessage() : "")); } throw e; } } - + /**反射调用 - * @param methodName - * @param parameterTypes - * @param args - * @return - */ - public static Object invoke(@NotNull AbstractFunctionParser parser, @NotNull String methodName, @NotNull Class[] parameterTypes, @NotNull Object[] args) throws Exception { - return parser.getClass().getMethod(methodName, parameterTypes).invoke(parser, args); + * @param parser + * @param methodName + * @param parameterTypes + * @param args + * @return {@link #invoke(AbstractFunctionParser, String, Class[], Object[])} + * @throws Exception + */ + @SuppressWarnings({"unchecked", "rawtypes"}) + public static , L extends List> Object invoke( + @NotNull AbstractFunctionParser parser, @NotNull String methodName + , @NotNull Class[] parameterTypes, @NotNull Object[] args) throws Exception { + return invoke(parser, methodName, parameterTypes, args, null, null, null); + } + /**反射调用 + * @param parser + * @param methodName + * @param parameterTypes + * @param args + * @param returnType + * @param current + * @param scriptExecutor + * @return + * @throws Exception + */ + @SuppressWarnings({"unchecked", "rawtypes"}) + public static , L extends List> Object invoke( + @NotNull AbstractFunctionParser parser, @NotNull String methodName + , @NotNull Class[] parameterTypes, @NotNull Object[] args, String returnType + , Map current, ScriptExecutor scriptExecutor) throws Exception { + if (scriptExecutor != null) { + return invokeScript(parser, methodName, parameterTypes, args, returnType, current, scriptExecutor); + } + + Class cls = parser.getClass(); + Method m = cls.getMethod(methodName, parameterTypes); // 不用判空，拿不到就会抛异常 + + if (Log.DEBUG) { + String rt = Log.DEBUG && m.getReturnType() != null ? m.getReturnType().getSimpleName() : null; + + if ("void".equals(rt)) { + rt = null; + } + if ("void".equals(returnType)) { + returnType = null; + } + + if (rt != returnType && (rt == null || rt.equals(returnType) == false)) { + throw new WrongMethodTypeException("远程函数 " + methodName + " 的实际返回值类型 " + rt + " 与 Function 表中的配置的 " + returnType + " 不匹配！"); + } + } + + return m.invoke(parser, args); } - /**解析函数 - * @param function - * @param request - * @param isSQLFunction - * @return - * @throws Exception - */ + /**Java 调用 JavaScript 函数 + * @param parser + * @param methodName + * @param parameterTypes + * @param args + * @param returnType + * @param current + * @return + * @throws Exception + */ + @SuppressWarnings({"unchecked", "rawtypes"}) + public static , L extends List> Object invokeScript( + @NotNull AbstractFunctionParser parser, @NotNull String methodName + , @NotNull Class[] parameterTypes, @NotNull Object[] args, String returnType + , Map current, ScriptExecutor scriptExecutor) throws Exception { + Object result = scriptExecutor.execute(parser, current, methodName, args); + if (Log.DEBUG && result != null) { + Class rt = result.getClass(); // 作为远程函数的 js 类型应该只有 JSON 的几种类型 + String fullReturnType = (StringUtil.isSmallName(returnType) + ? returnType : (returnType.startsWith("JSON") ? "com.alibaba.fastjson." : "java.lang.") + returnType); + + if ((rt == null && returnType != null) || (rt != null && returnType == null)) { + throw new WrongMethodTypeException("远程函数 " + methodName + " 的实际返回值类型 " + + (rt == null ? null : rt.getName()) + " 与 Function 表中的配置的 " + fullReturnType + " 不匹配！"); + } + + Class cls; + try { + cls = Class.forName(fullReturnType); + } + catch (Exception e) { + throw new WrongMethodTypeException("远程函数 " + methodName + " 在 Function 表中的配置的类型 " + + returnType + " 对应的 " + fullReturnType + " 错误！在 Java 中 Class.forName 找不到这个类型！"); + } + + if (cls.isAssignableFrom(rt) == false) { + throw new WrongMethodTypeException("远程函数 " + methodName + " 的实际返回值类型 " + + (rt == null ? null : rt.getName()) + " 与 Function 表中的配置的 " + + returnType + " 对应的 " + fullReturnType + " 不匹配！"); + } + } + + Log.d(TAG, "invokeScript " + methodName + "(..) >> result = " + result); + return result; + } + + + /**解析函数 + * @param function + * @param request + * @param isSQLFunction + * @return + * @throws Exception + */ @NotNull - public static FunctionBean parseFunction(@NotNull String function, @NotNull JSONObject request, boolean isSQLFunction) throws Exception { + public static FunctionBean parseFunction(@NotNull String function, @NotNull Map request, boolean isSQLFunction) throws Exception { + return parseFunction(function, request, isSQLFunction, false); + } + /**解析函数，自动解析的值类型只支持 Boolean, Number, String, Map, List + * @param function + * @param request + * @param isSQLFunction + * @param containRaw + * @return + * @throws Exception + */ + public static FunctionBean parseFunction(@NotNull String function, @NotNull Map request, boolean isSQLFunction, boolean containRaw) throws Exception { int start = function.indexOf("("); int end = function.lastIndexOf(")"); String method = (start <= 0 || end != function.length() - 1) ? null : function.substring(0, start); - if (StringUtil.isEmpty(method, true)) { - throw new IllegalArgumentException("字符 " + function + " 不合法！函数的名称 function 不能为空，" - + "且必须为 function(key0,key1,...) 这种单函数格式！" + + int dotInd = method == null ? -1 : method.indexOf("."); + String schema = dotInd < 0 ? null : method.substring(0, dotInd); + method = dotInd < 0 ? method : method.substring(dotInd + 1); + + if (StringUtil.isName(method) == false) { + throw new IllegalArgumentException("字符 " + method + " 不合法！函数的名称 function 不能为空且必须符合方法命名规范！" + + "总体必须为 function(key0,key1,...) 这种单函数格式！" + "\nfunction必须符合 " + (isSQLFunction ? "SQL 函数/SQL 存储过程" : "Java 函数") + " 命名，key 是用于在 request 内取值的键！"); } + if (isSQLFunction != true && schema != null) { // StringUtil.isNotEmpty(schema, false)) { + throw new IllegalArgumentException("字符 " + schema + " 不合法！远程函数不允许指定类名！" + + "且必须为 function(key0,key1,...) 这种单函数格式！" + + "\nfunction必须符合 " + (isSQLFunction ? "SQL 函数/SQL 存储过程" : "Java 函数") + " 命名，key 是用于在 request 内取值的键！"); + } + if (schema != null) { // StringUtil.isName(schema) == false) { + schema = extractSchema(schema, null); + } String[] keys = StringUtil.split(function.substring(start + 1, end)); - int length = keys == null ? 0 : keys.length; Class[] types; Object[] values; - if (isSQLFunction) { + if (isSQLFunction || IS_PARSE_ARG_VALUE) { types = new Class[length]; values = new Object[length]; //碰到null就挂了！！！Number还得各种转换不灵活！不如直接传request和对应的key到函数里，函数内实现时自己 getLongValue,getJSONObject ... Object v; for (int i = 0; i < length; i++) { - v = values[i] = request.get(keys[i]); + v = values[i] = getArgValue(request, keys[i], containRaw); // request.get(keys[i]); if (v == null) { types[i] = Object.class; values[i] = null; @@ -244,31 +628,39 @@ public static FunctionBean parseFunction(@NotNull String function, @NotNull JSON } if (v instanceof Boolean) { - types[i] = Boolean.class; //只支持JSON的几种类型 - } + types[i] = Boolean.class; //只支持JSON的几种类型 + } // 怎么都有 bug，如果是引用的值，很多情况下无法指定 // 用 1L 指定为 Long ？ 其它的默认按长度分配为 Integer 或 Long？ + //else if (v instanceof Long || v instanceof Integer || v instanceof Short) { + // types[i] = Long.class; + //} else if (v instanceof Number) { types[i] = Number.class; } else if (v instanceof String) { types[i] = String.class; } - else if (v instanceof JSONObject) { // Map) { - types[i] = JSONObject.class; - //性能比较差 values[i] = request.getJSONObject(keys[i]); + else if (v instanceof Map) { // 泛型兼容？ // JSONMap + types[i] = Map.class; + //性能比较差 + //values[i] = TypeUtils.cast(v, Map.class, ParserConfig.getGlobalInstance()); } - else if (v instanceof JSONArray) { // Collection) { - types[i] = JSONArray.class; - //性能比较差 values[i] = request.getJSONArray(keys[i]); + else if (v instanceof Collection) { // 泛型兼容？ // JSONList + types[i] = List.class; + //性能比较差 + List list = new ArrayList<>((Collection) v); + values[i] = list; // TypeUtils.cast(v, List.class, ParserConfig.getGlobalInstance()); } - else { //FIXME 碰到null就挂了！！！ - throw new UnsupportedDataTypeException(keys[i] + ":value 中value不合法！远程函数 key():" + function + " 中的arg对应的值类型" - + "只能是 [Boolean, Number, String, JSONObject, JSONArray] 中的一种！"); + else { + throw new UnsupportedDataTypeException(keys[i] + ":value 中value不合法！远程函数 key():" + + function + " 中的 arg 对应的值类型只能是 [Boolean, Number, String, JSONMap, JSONList] 中的一种！"); } } } else { + Class cls = JSON.createJSONObject().getClass(); types = new Class[length + 1]; - types[0] = JSONObject.class; + //types[0] = Object.class; // 泛型擦除 JSON.JSON_OBJECT_CLASS; + types[0] = cls; values = new Object[length + 1]; values[0] = request; @@ -281,6 +673,7 @@ else if (v instanceof JSONArray) { // Collection) { FunctionBean fb = new FunctionBean(); fb.setFunction(function); + fb.setSchema(schema); fb.setMethod(method); fb.setKeys(keys); fb.setTypes(types); @@ -289,6 +682,44 @@ else if (v instanceof JSONArray) { // Collection) { return fb; } + public static void verifySchema(String sch, String table) { + extractSchema(sch, table); + } + + public static String extractSchema(String sch, String table) { + if (StringUtil.isEmpty(sch)) { + return sch; + } + + if (table == null) { + table = "Table"; + } + + int ind = sch.indexOf("`"); + if (ind > 0) { + throw new IllegalArgumentException(table + ": { @key(): value } 对应存储过程 value 中字符 " + + sch + " 不合法！`schema` 当有 ` 包裹时一定是首尾各一个，不能多也不能少！"); + } + + if (ind == 0) { + sch = sch.substring(1); + if (sch.indexOf("`") != sch.length() - 1) { + throw new IllegalArgumentException(table + ": { @key(): value } 对应存储过程 value 中字符 `" + + sch + " 不合法！`schema` 当有 ` 包裹时一定是首尾各一个，不能多也不能少！"); + } + + sch = sch.substring(0, sch.length() - 1); + } + + if (PATTERN_SCHEMA.matcher(sch).matches() == false || sch.contains("--")) { + throw new IllegalArgumentException(table + ": { @key(): value } 对应存储过程 value 中字符 " + + sch + " 不合法！schema.function(arg) 中 schema 必须符合 数据库名/模式名 的命名规则！" + + "一般只能传英文字母、数字、下划线！不允许 -- 等可能导致 SQL 注入的符号！"); + } + + return sch; + } + /** * @param method @@ -296,7 +727,7 @@ else if (v instanceof JSONArray) { // Collection) { * @return */ public static String getFunction(String method, String[] keys) { - String f = method + "(JSONObject request"; + String f = method + "(JSONMap request"; if (keys != null) { for (int i = 0; i < keys.length; i++) { @@ -309,9 +740,67 @@ public static String getFunction(String method, String[] keys) { return f; } + public static T getArgValue(@NotNull Map current, String keyOrValue) { + return getArgValue(current, keyOrValue, false); + } + public static T getArgValue(@NotNull Map current, String keyOrValue, boolean containRaw) { + if (keyOrValue == null) { + return null; + } + + + if (keyOrValue.endsWith("`") && keyOrValue.substring(1).indexOf("`") == keyOrValue.length() - 2) { + return (T) current.get(keyOrValue.substring(1, keyOrValue.length() - 1)); + } + + if (keyOrValue.endsWith("'") && keyOrValue.substring(1).indexOf("'") == keyOrValue.length() - 2) { + return (T) keyOrValue.substring(1, keyOrValue.length() - 1); + } + + // 传参加上 @raw:"key()" 避免意外情况 + Object val = containRaw ? AbstractSQLConfig.RAW_MAP.get(keyOrValue) : null; + if (val != null) { + return (T) ("".equals(val) ? keyOrValue : val); + } + + if (StringUtil.isName(keyOrValue.startsWith("@") ? keyOrValue.substring(1) : keyOrValue)) { + return (T) current.get(keyOrValue); + } + + if ("true".equals(keyOrValue)) { + return (T) Boolean.TRUE; + } + if ("false".equals(keyOrValue)) { + return (T) Boolean.FALSE; + } + + // 性能更好，但居然非法格式也不报错 + //try { + // val = Boolean.valueOf(keyOrValue); // parseJSON(keyOrValue); + // return (T) val; + //} + //catch (Throwable e) { + // Log.d(TAG, "getArgValue try {\n" + + // " val = Boolean.valueOf(keyOrValue);" + + // "} catch (Throwable e) = " + e.getMessage()); + //} + + try { + val = Double.valueOf(keyOrValue); // parseJSON(keyOrValue); + return (T) val; + } + catch (Throwable e) { + Log.d(TAG, "getArgValue try {\n" + + " val = Double.valueOf(keyOrValue);" + + "} catch (Throwable e) = " + e.getMessage()); + } + + return (T) current.get(keyOrValue); + } public static class FunctionBean { private String function; + private String schema; private String method; private String[] keys; private Class[] types; @@ -324,7 +813,14 @@ public void setFunction(String function) { this.function = function; } - public String getMethod() { + public String getSchema() { + return schema; + } + public void setSchema(String schema) { + this.schema = schema; + } + + public String getMethod() { return method; } public void setMethod(String method) { @@ -366,6 +862,8 @@ public String toFunctionCallString(boolean useValue) { * @return */ public String toFunctionCallString(boolean useValue, String quote) { + //String sch = getSchema(); + //String s = (StringUtil.isEmpty(sch) ? "" : sch + ".") + getMethod() + "("; String s = getMethod() + "("; Object[] args = useValue ? getValues() : getKeys(); @@ -386,4 +884,81 @@ public String toFunctionCallString(boolean useValue, String quote) { } + /** + * 获取JSON对象 + * @param TODO + * @param req + * @param key + * @param clazz + * @return + * @throws Exception + */ + public V getArgVal(@NotNull M req, String key, Class clazz) throws Exception { + // Convert to JSONMap for backward compatibility, replace with proper implementation later + return getArgVal(req, key, clazz, false); + } + + /** + * 获取参数值 + * @param key + * @param clazz 如果有clazz就返回对应的类型，否则返回原始类型 + * @param defaultValue + * @return + * @throws Exception + */ + public V getArgVal(String key, Class clazz, boolean defaultValue) throws Exception { + Object obj = parser != null && JSONMap.isArrayKey(key) ? AbstractParser.getValue(request, key.split("\\,")) : request.get(key); + + if (clazz == null) { + return (V) obj; + } + + // Replace TypeUtils with appropriate casting method + try { + if (obj == null) { + return null; + } + if (clazz.isInstance(obj)) { + return (V) obj; + } + if (clazz == String.class) { + return (V) String.valueOf(obj); + } + if (clazz == Boolean.class || clazz == boolean.class) { + return (V) Boolean.valueOf(String.valueOf(obj)); + } + if (clazz == Integer.class || clazz == int.class) { + return (V) Integer.valueOf(String.valueOf(obj)); + } + if (clazz == Long.class || clazz == long.class) { + return (V) Long.valueOf(String.valueOf(obj)); + } + if (clazz == Double.class || clazz == double.class) { + return (V) Double.valueOf(String.valueOf(obj)); + } + if (clazz == Float.class || clazz == float.class) { + return (V) Float.valueOf(String.valueOf(obj)); + } + if (Map.class.isAssignableFrom(clazz)) { + if (obj instanceof Map) { + return (V) obj; + } + return (V) JSON.parseObject(obj); + } + if (List.class.isAssignableFrom(clazz)) { + if (obj instanceof List) { + return (V) obj; + } + return (V) JSON.parseArray(obj); + } + // Fallback to string conversion + return (V) obj; + } catch (Exception e) { + if (defaultValue) { + return null; + } + throw e; + } + } + } \ No newline at end of file diff --git a/APIJSONORM/src/main/java/apijson/orm/AbstractObjectParser.java b/APIJSONORM/src/main/java/apijson/orm/AbstractObjectParser.java index f33534d19..4d56499a0 100755 --- a/APIJSONORM/src/main/java/apijson/orm/AbstractObjectParser.java +++ b/APIJSONORM/src/main/java/apijson/orm/AbstractObjectParser.java @@ -1,70 +1,60 @@ -/*Copyright (C) 2020 THL A29 Limited, a Tencent company. All rights reserved. +/*Copyright (C) 2020 Tencent. All rights reserved. This source code is licensed under the Apache License Version 2.0.*/ package apijson.orm; -import static apijson.JSONObject.KEY_COMBINE; -import static apijson.JSONObject.KEY_DROP; -import static apijson.JSONObject.KEY_TRY; -import static apijson.RequestMethod.POST; -import static apijson.RequestMethod.PUT; -import static apijson.orm.SQLConfig.TYPE_ITEM; - -import java.rmi.ServerException; -import java.util.ArrayList; -import java.util.Arrays; -import java.util.LinkedHashMap; -import java.util.LinkedHashSet; -import java.util.List; -import java.util.Map; -import java.util.Map.Entry; -import java.util.Set; - -import javax.activation.UnsupportedDataTypeException; - -import com.alibaba.fastjson.JSON; -import com.alibaba.fastjson.JSONArray; -import com.alibaba.fastjson.JSONObject; - -import apijson.JSONResponse; -import apijson.Log; -import apijson.NotNull; -import apijson.RequestMethod; -import apijson.StringUtil; +import apijson.*; import apijson.orm.AbstractFunctionParser.FunctionBean; import apijson.orm.exception.ConflictException; +import apijson.orm.exception.CommonException; import apijson.orm.exception.NotExistException; +import apijson.orm.exception.UnsupportedDataTypeException; +import java.rmi.ServerException; +import java.util.*; +import java.util.Map.Entry; + +import static apijson.JSON.*; +import static apijson.JSONMap.KEY_COMBINE; +import static apijson.JSONMap.KEY_DROP; +import static apijson.JSONMap.KEY_TRY; +import static apijson.JSONRequest.*; +import static apijson.RequestMethod.POST; +import static apijson.RequestMethod.PUT; +import static apijson.orm.SQLConfig.TYPE_ITEM; +import static apijson.RequestMethod.GET; /**简化Parser，getObject和getArray(getArrayConfig)都能用 * @author Lemon */ -public abstract class AbstractObjectParser implements ObjectParser { +public abstract class AbstractObjectParser, L extends List> + implements ObjectParser { private static final String TAG = "AbstractObjectParser"; @NotNull - protected AbstractParser parser; - public AbstractObjectParser setParser(AbstractParser parser) { - this.parser = parser; + protected AbstractParser parser; + @Override + public AbstractParser getParser() { + return parser; + } + @Override + public AbstractObjectParser setParser(Parser parser) { + this.parser = (AbstractParser) parser; return this; } - - protected JSONObject request;//不用final是为了recycle + protected M request;//不用final是为了recycle protected String parentPath;//不用final是为了recycle - protected SQLConfig arrayConfig;//不用final是为了recycle + protected SQLConfig arrayConfig;//不用final是为了recycle protected boolean isSubquery; protected final int type; - protected final List joinList; + protected final String arrayTable; + protected final List> joinList; protected final boolean isTable; - protected final String path; - protected final String name; - protected final String table; - protected final String alias; - + protected final boolean isArrayMainTable; protected final boolean tri; /** @@ -73,29 +63,25 @@ public AbstractObjectParser setParser(AbstractParser parser) { protected final boolean drop; /**for single object - * @param parentPath - * @param request - * @param name - * @throws Exception */ - public AbstractObjectParser(@NotNull JSONObject request, String parentPath, String name, SQLConfig arrayConfig, boolean isSubquery) throws Exception { + public AbstractObjectParser(@NotNull M request, String parentPath, SQLConfig arrayConfig + , boolean isSubquery, boolean isTable, boolean isArrayMainTable) throws Exception { if (request == null) { - throw new IllegalArgumentException(TAG + ".ObjectParser request == null!!!"); + throw new IllegalArgumentException(TAG + ".ObjectParser request == null!!!"); } this.request = request; this.parentPath = parentPath; + this.arrayConfig = arrayConfig; this.isSubquery = isSubquery; this.type = arrayConfig == null ? 0 : arrayConfig.getType(); + this.arrayTable = arrayConfig == null ? null : arrayConfig.getTable(); this.joinList = arrayConfig == null ? null : arrayConfig.getJoinList(); - this.name = name; - this.path = AbstractParser.getAbsPath(parentPath, name); - apijson.orm.Entry entry = Pair.parseEntry(name, true); - this.table = entry.getKey(); - this.alias = entry.getValue(); - this.isTable = apijson.JSONObject.isTableKey(table); + this.isTable = isTable; // apijson.JSONMap.isTableKey(table); + this.isArrayMainTable = isArrayMainTable; // isSubquery == false && this.isTable && this.type == SQLConfig.TYPE_ITEM_CHILD_0 && RequestMethod.isGetMethod(method, true); + // this.isReuse = isReuse; // isArrayMainTable && arrayConfig != null && arrayConfig.getPosition() > 0; this.objectCount = 0; this.arrayCount = 0; @@ -106,16 +92,50 @@ public AbstractObjectParser(@NotNull JSONObject request, String parentPath, Stri this.drop = false; } else { - this.tri = request.getBooleanValue(KEY_TRY); - this.drop = request.getBooleanValue(KEY_DROP); + this.tri = getBooleanValue(request, KEY_TRY); + this.drop = getBooleanValue(request, KEY_DROP); request.remove(KEY_TRY); request.remove(KEY_DROP); } + if (isTable) { + String raw = getString(request, JSONMap.KEY_RAW); + String[] rks = StringUtil.split(raw); + rawKeyList = rks == null || rks.length <= 0 ? null : Arrays.asList(rks); + } + } - Log.d(TAG, "AbstractObjectParser table = " + table + "; isTable = " + isTable); - Log.d(TAG, "AbstractObjectParser isEmpty = " + isEmpty + "; tri = " + tri + "; drop = " + drop); + @Override + public String getParentPath() { + return parentPath; + } + + @Override + public AbstractObjectParser setParentPath(String parentPath) { + this.parentPath = parentPath; + return this; + } + + protected M cache; + @Override + public M getCache() { + return cache; + } + + @Override + public AbstractObjectParser setCache(M cache) { + this.cache = cache; + return this; + } + + protected int position; + public int getPosition() { + return position; + } + public AbstractObjectParser setPosition(int position) { + this.position = position; + return this; } @@ -135,10 +155,15 @@ public boolean isBreakParse() { return breakParse || isInvalidate(); } + protected String name; + protected String table; + protected String alias; + protected boolean isReuse; + protected String path; - protected JSONObject response; - protected JSONObject sqlRequest; - protected JSONObject sqlReponse; + protected M response; + protected M sqlRequest; + protected M sqlResponse; /** * 自定义关键词 */ @@ -154,128 +179,197 @@ public boolean isBreakParse() { /** * 子对象 */ - protected Map childMap; + protected Map childMap; private int objectCount; private int arrayCount; + + private List rawKeyList; /**解析成员 * response重新赋值 * @return null or this * @throws Exception */ @Override - public AbstractObjectParser parse() throws Exception { + public AbstractObjectParser parse(String name, boolean isReuse) throws Exception { if (isInvalidate() == false) { + this.isReuse = isReuse; + this.name = name; + this.path = AbstractParser.getAbsPath(parentPath, name); + + apijson.orm.Entry tentry = Pair.parseEntry(name, true); + this.table = tentry.getKey(); + this.alias = tentry.getValue(); + + Log.d(TAG, "AbstractObjectParser parentPath = " + parentPath + "; name = " + name + "; table = " + table + "; alias = " + alias); + Log.d(TAG, "AbstractObjectParser type = " + type + "; isTable = " + isTable + "; isArrayMainTable = " + isArrayMainTable); + Log.d(TAG, "AbstractObjectParser isEmpty = " + request.isEmpty() + "; tri = " + tri + "; drop = " + drop); + breakParse = false; - response = new JSONObject(true);//must init + response = JSON.createJSONObject(); // must init + sqlResponse = null; // must init - sqlRequest = new JSONObject(true);//must init + if (isReuse == false) { + sqlRequest = JSON.createJSONObject(); // must init - sqlReponse = null;//must init - customMap = null;//must init - functionMap = null;//must init - childMap = null;//must init + customMap = null; // must init + functionMap = null; // must init + childMap = null; // must init - Set> set = new LinkedHashSet>(request.entrySet()); - if (set != null && set.isEmpty() == false) {//判断换取少几个变量的初始化是否值得？ - if (isTable) {//非Table下必须保证原有顺序！否则 count,page 会丢, total@:"/[]/total" 会在[]:{}前执行！ - customMap = new LinkedHashMap(); - childMap = new LinkedHashMap(); - } - functionMap = new LinkedHashMap>();//必须执行 - - - //条件<<<<<<<<<<<<<<<<<<< - List whereList = null; - if (method == PUT) { //这里只有PUTArray需要处理 || method == DELETE) { - String[] combine = StringUtil.split(request.getString(KEY_COMBINE)); - if (combine != null) { - String w; - for (int i = 0; i < combine.length; i++) { //去除 &,|,! 前缀 - w = combine[i]; - if (w != null && (w.startsWith("&") || w.startsWith("|") || w.startsWith("!"))) { - combine[i] = w.substring(1); + Set> set = request.isEmpty() ? null : new LinkedHashSet<>(request.entrySet()); + if (set != null && set.isEmpty() == false) { // 判断换取少几个变量的初始化是否值得？ + if (isTable) { // 非Table下必须保证原有顺序！否则 count,page 会丢, total@:"/[]/total" 会在[]:{}前执行！ + customMap = new LinkedHashMap(); + childMap = new LinkedHashMap(); + } + functionMap = new LinkedHashMap>();//必须执行 + + // 条件 <<<<<<<<<<<<<<<<<<< + List whereList = null; + if (method == PUT) { // 这里只有PUTArray需要处理 || method == DELETE) { + String[] combine = StringUtil.split(getString(request, KEY_COMBINE)); + if (combine != null) { + String w; + for (int i = 0; i < combine.length; i++) { // 去除 &,|,! 前缀 + w = combine[i]; + if (w != null && (w.startsWith("&") || w.startsWith("|") || w.startsWith("!"))) { + combine[i] = w.substring(1); + } } } + // Arrays.asList() 返回值不支持 add 方法！ + whereList = new ArrayList(Arrays.asList(combine != null ? combine : new String[]{})); + whereList.add(JSONMap.KEY_ID); + whereList.add(JSONMap.KEY_ID_IN); + // whereList.add(apijson.JSONMap.KEY_USER_ID); + // whereList.add(apijson.JSONMap.KEY_USER_ID_IN); } - //Arrays.asList()返回值不支持add方法！ - whereList = new ArrayList(Arrays.asList(combine != null ? combine : new String[]{})); - whereList.add(apijson.JSONRequest.KEY_ID); - whereList.add(apijson.JSONRequest.KEY_ID_IN); - } - //条件>>>>>>>>>>>>>>>>>>> + // 条件>>>>>>>>>>>>>>>>>>> - String key; - Object value; - int index = 0; + int index = 0; + // hasOtherKeyNotFun = false; + M viceItem = null; - for (Entry entry : set) { - if (isBreakParse()) { - break; - } + for (Entry entry : set) { + if (isBreakParse()) { + break; + } - value = entry.getValue(); - if (value == null) { - continue; - } - key = entry.getKey(); + // key 可能为 JSONList，需要进行手动转换（fastjson 为低版本时允许自动转换，如 1.2.21） + // 例如 request json为 "{[]:{"page": 2, "table1":{}}}" + Object field = entry == null ? null : entry.getKey(); + String key = field instanceof Map ? toJSONString(field) : field.toString(); + Object value = key == null ? null : entry.getValue(); + if (value == null) { + continue; + } - try { - if (key.startsWith("@") || key.endsWith("@")) { - if (onParse(key, value) == false) { - invalidate(); - } + // 处理url crud, 将crud 转换为真实method + RequestMethod _method = this.parser.getRealMethod(method, key, value); + // 没有执行校验流程的情况,比如url head, sql@子查询, sql@ method=GET + + Object obj = key.endsWith("@") ? request.get(key) : null; + if (obj instanceof Map) { + ((Map) obj).put(JSONMap.KEY_METHOD, GET); } - else if (value instanceof JSONObject) { // JSONObject，往下一级提取 - if (childMap != null) { // 添加到childMap，最后再解析 - childMap.put(key, (JSONObject)value); + + try { + boolean startsWithAt = key.startsWith("@"); + // if (startsWithAt || (key.endsWith("()") == false)) { + // hasOtherKeyNotFun = true; + // } + + if (startsWithAt || key.endsWith("@") || (key.endsWith("<>") && value instanceof Map)) { + if (onParse(key, value) == false) { + invalidate(); + } } - else { // 直接解析并替换原来的，[]:{} 内必须直接解析，否则会因为丢掉count等属性，并且total@:"/[]/total"必须在[]:{} 后！ - response.put(key, onChildParse(index, key, (JSONObject)value)); - index ++; + else if (value instanceof Map) { // JSONRequest，往下一级提取 + if (childMap != null) { // 添加到childMap，最后再解析 + childMap.put(key, (M) value); + } + else { // 直接解析并替换原来的，[]:{} 内必须直接解析，否则会因为丢掉count等属性，并且total@:"/[]/total"必须在[]:{} 后！ + Object cache = index <= 0 || type != TYPE_ITEM || viceItem == null ? null : JSON.get(viceItem, key); + Object result = onChildParse(index, key, (M) value, cache); + if (index <= 0 && type == TYPE_ITEM) { + M mainItem = (M) result; + viceItem = result == null ? null : (M) mainItem.remove(AbstractSQLExecutor.KEY_VICE_ITEM); + } + + response.put(key, result); + index ++; + } } - } - else if ((method == POST || method == PUT) && value instanceof JSONArray - && JSONRequest.isTableArray(key)) { // JSONArray，批量新增或修改，往下一级提取 - onTableArrayParse(key, (JSONArray) value); - } - else if (method == PUT && value instanceof JSONArray - && (whereList == null || whereList.contains(key) == false)) { // PUT JSONArray - onPUTArrayParse(key, (JSONArray) value); - } - else { // JSONArray或其它Object，直接填充 - if (onParse(key, value) == false) { - invalidate(); + else if ((_method == POST || _method == PUT) && value instanceof List + && JSONMap.isTableArray(key)) { // L，批量新增或修改，往下一级提取 + onTableArrayParse(key, (L) value); } + else if (_method == PUT && value instanceof List && (whereList == null || whereList.contains(key) == false) + && StringUtil.isName(key.replaceFirst("[+-]$", ""))) { // PUT L + onPUTArrayParse(key, (L) value); + } + else { // L 或其它 Object，直接填充 + if (onParse(key, value) == false) { + invalidate(); + } + } + } catch (Exception e) { + if (tri == false) { + throw CommonException.wrap(e, sqlConfig); // 不忽略错误，抛异常 + } + invalidate(); // 忽略错误，还原request } - } catch (Exception e) { - if (tri == false) { - throw e; // 不忽略错误，抛异常 - } - invalidate(); // 忽略错误，还原request } + } - // 非Table内的函数会被滞后在onChildParse后调用！ onFunctionResponse("-"); - } + if (isTable) { + // parser.onVerifyRole 已处理 globalRole - if (isTable) { - if (sqlRequest.get(JSONRequest.KEY_DATABASE) == null && parser.getGlobleDatabase() != null) { - sqlRequest.put(JSONRequest.KEY_DATABASE, parser.getGlobleDatabase()); - } - if (sqlRequest.get(JSONRequest.KEY_SCHEMA) == null && parser.getGlobleSchema() != null) { - sqlRequest.put(JSONRequest.KEY_SCHEMA, parser.getGlobleSchema()); - } - if (isSubquery == false) { //解决 SQL 语法报错，子查询不能 EXPLAIN - if (sqlRequest.get(JSONRequest.KEY_EXPLAIN) == null && parser.getGlobleExplain() != null) { - sqlRequest.put(JSONRequest.KEY_EXPLAIN, parser.getGlobleExplain()); + String db = parser.getGlobalDatabase(); + if (db != null) { + sqlRequest.putIfAbsent(JSONMap.KEY_DATABASE, db); } - if (sqlRequest.get(JSONRequest.KEY_CACHE) == null && parser.getGlobleCache() != null) { - sqlRequest.put(JSONRequest.KEY_CACHE, parser.getGlobleCache()); + + String ds = parser.getGlobalDatasource(); + if (ds != null) { + sqlRequest.putIfAbsent(JSONMap.KEY_DATASOURCE, ds); + } + + String ns = parser.getGlobalNamespace(); + if (ns != null) { + sqlRequest.putIfAbsent(JSONMap.KEY_NAMESPACE, ns); + } + + String cl = parser.getGlobalCatalog(); + if (cl != null) { + sqlRequest.putIfAbsent(JSONMap.KEY_CATALOG, cl); + } + + String sch = parser.getGlobalSchema(); + if (sch != null) { + sqlRequest.putIfAbsent(JSONMap.KEY_SCHEMA, sch); + } + + if (isSubquery == false) { // 解决 SQL 语法报错，子查询不能 EXPLAIN + Boolean exp = parser.getGlobalExplain(); + if (sch != null) { + sqlRequest.putIfAbsent(JSONMap.KEY_EXPLAIN, exp); + } + + String cache = parser.getGlobalCache(); + if (cache != null) { + sqlRequest.putIfAbsent(JSONMap.KEY_CACHE, cache); + } } } } + + if (isTable) { // 非Table内的函数会被滞后在onChildParse后调用 + onFunctionResponse("-"); + } + } if (isInvalidate()) { @@ -289,40 +383,56 @@ else if (method == PUT && value instanceof JSONArray + //private boolean hasOtherKeyNotFun = false; - /**解析普通成员 + /**解析普通成员 * @param key * @param value * @return whether parse succeed */ @Override public boolean onParse(@NotNull String key, @NotNull Object value) throws Exception { - if (key.endsWith("@")) {//StringUtil.isPath((String) value)) { - - if (value instanceof JSONObject) { // SQL 子查询对象，JSONObject -> SQLConfig.getSQL - String replaceKey = key.substring(0, key.length() - 1);//key{}@ getRealKey - - JSONObject subquery = (JSONObject) value; - String range = subquery.getString(JSONRequest.KEY_SUBQUERY_RANGE); - if (range != null && JSONRequest.SUBQUERY_RANGE_ALL.equals(range) == false && JSONRequest.SUBQUERY_RANGE_ANY.equals(range) == false) { - throw new IllegalArgumentException("子查询 " + path + "/" + key + ":{ range:value } 中 value 只能为 [" + JSONRequest.SUBQUERY_RANGE_ALL + ", " + JSONRequest.SUBQUERY_RANGE_ANY + "] 中的一个！"); + if (key.endsWith("@")) { // StringUtil.isPath((String) value)) { + // [] 内主表 position > 0 时，用来生成 SQLConfig 的键值对全都忽略，不解析 + if (value instanceof Map) { // key{}@ getRealKey, SQL 子查询对象，JSONRequest -> SQLConfig.getSQL + String replaceKey = key.substring(0, key.length() - 1); + + M subquery = (M) value; + String range = getString(subquery, KEY_SUBQUERY_RANGE); + if (range != null && SUBQUERY_RANGE_ALL.equals(range) == false && SUBQUERY_RANGE_ANY.equals(range) == false) { + throw new IllegalArgumentException("子查询 " + path + "/" + key + ":{ range:value } 中 value 只能为 [" + + SUBQUERY_RANGE_ALL + ", " + SUBQUERY_RANGE_ANY + "] 中的一个！"); } + L arr = parser.onArrayParse(subquery, path, key, true, null); - JSONArray arr = parser.onArrayParse(subquery, path, key, true); - - JSONObject obj = arr == null || arr.isEmpty() ? null : arr.getJSONObject(0); + M obj = arr == null || arr.isEmpty() ? null : JSON.get(arr, 0); if (obj == null) { throw new Exception("服务器内部错误，解析子查询 " + path + "/" + key + ":{ } 为 Subquery 对象失败！"); } - String from = subquery.getString(JSONRequest.KEY_SUBQUERY_FROM); - JSONObject arrObj = from == null ? null : obj.getJSONObject(from); + String from = getString(subquery, apijson.JSONRequest.KEY_SUBQUERY_FROM); + boolean isEmpty = StringUtil.isEmpty(from); + M arrObj = isEmpty ? null : JSON.get(obj, from); + if (isEmpty) { + Set> set = obj.entrySet(); + for (Entry e : set) { + String k = e == null ? null : e.getKey(); + Object v = k == null ? null : e.getValue(); + if (v instanceof Map && JSONMap.isTableKey(k)) { + from = k; + arrObj = (M) v; + break; + } + } + } + if (arrObj == null) { - throw new IllegalArgumentException("子查询 " + path + "/" + key + ":{ from:value } 中 value 对应的主表对象 " + from + ":{} 不存在！"); + throw new IllegalArgumentException("子查询 " + path + "/" + + key + ":{ from:value } 中 value 对应的主表对象 " + from + ":{} 不存在！"); } - // - SQLConfig cfg = (SQLConfig) arrObj.get(AbstractParser.KEY_CONFIG); + + SQLConfig cfg = (SQLConfig) arrObj.get(AbstractParser.KEY_CONFIG); if (cfg == null) { throw new NotExistException(TAG + ".onParse cfg == null"); } @@ -342,42 +452,58 @@ public boolean onParse(@NotNull String key, @NotNull Object value) throws Except parser.putQueryResult(AbstractParser.getAbsPath(path, key), s); //字符串引用保证不了安全性 parser.getSQL(cfg)); } - else if (value instanceof String) { // 引用赋值路径 + else if (value instanceof String) { // //key{}@ getRealKey, 引用赋值路径 + String replaceKey = key.substring(0, key.length() - 1); - // System.out.println("getObject key.endsWith(@) >> parseRelation = " + parseRelation); - String replaceKey = key.substring(0, key.length() - 1);//key{}@ getRealKey - String targetPath = AbstractParser.getValuePath(type == TYPE_ITEM - ? path : parentPath, new String((String) value)); + // System.out.println("getObject key.endsWith(@) >> parseRelation = " + parseRelation); + String targetPath = AbstractParser.getValuePath(type == TYPE_ITEM ? path : parentPath, (String) value); - //先尝试获取，尽量保留缺省依赖路径，这样就不需要担心路径改变 + // 先尝试获取，尽量保留缺省依赖路径，这样就不需要担心路径改变 Object target = onReferenceParse(targetPath); Log.i(TAG, "onParse targetPath = " + targetPath + "; target = " + target); - if (target == null) {//String#equals(null)会出错 + if (target == null) { // String#equals(null)会出错 Log.d(TAG, "onParse target == null >> return true;"); - return true; - } - if (target instanceof Map) { //target可能是从requestObject里取出的 {} - if (isTable || targetPath.endsWith("[]/" + JSONResponse.KEY_INFO) == false) { - Log.d(TAG, "onParse target instanceof Map >> return false;"); - return false; //FIXME 这个判断现在来看是否还有必要？为啥不允许为 JSONObject ？以前可能因为防止二次遍历再解析，现在只有一次遍历 + + if (Log.DEBUG) { + parser.putWarnIfNeed(AbstractParser.KEY_REF, path + "/" + key + ": " + targetPath + " 引用赋值获取路径对应的值为 null！请检查路径是否错误！"); } - } - if (targetPath.equals(target)) {//必须valuePath和保证getValueByPath传进去的一致！ - Log.d(TAG, "onParse targetPath.equals(target) >>"); - //非查询关键词 @key 不影响查询，直接跳过 - if (isTable && (key.startsWith("@") == false || JSONRequest.TABLE_KEY_LIST.contains(key))) { + // 非查询关键词 @key 不影响查询，直接跳过 + if (isTable && (key.startsWith("@") == false || JSONMap.TABLE_KEY_LIST.contains(key))) { Log.e(TAG, "onParse isTable && (key.startsWith(@) == false" - + " || JSONRequest.TABLE_KEY_LIST.contains(key)) >> return null;"); - return false;//获取不到就不用再做无效的query了。不考虑 Table:{Table:{}}嵌套 - } else { - Log.d(TAG, "onParse isTable(table) == false >> return true;"); - return true;//舍去，对Table无影响 + + " || apijson.JSONMap.TABLE_KEY_LIST.contains(key)) >> return null;"); + // FIXME getCache() != null 时 return true，解决 RIGHT/OUTER/FOREIGN JOIN 主表无数据导致副表数据也不返回 + return false; // 获取不到就不用再做无效的 query 了。不考虑 Table:{Table:{}} 嵌套 } - } - //直接替换原来的key@:path为key:target + Log.d(TAG, "onParse isTable(table) == false >> return true;"); + return true; // 舍去，对Table无影响 + } + +// if (target instanceof Map) { // target 可能是从 requestObject 里取出的 {} +// if (isTable || targetPath.endsWith("[]/" + JSONResponse.KEY_INFO) == false) { +// Log.d(TAG, "onParse target instanceof Map >> return false;"); +// return false; // FIXME 这个判断现在来看是否还有必要？为啥不允许为 JSONRequest ？以前可能因为防止二次遍历再解析，现在只有一次遍历 +// } +// } +// +// // FIXME 这个判断现在来看是否还有必要？为啥不允许为 JSONRequest ？以前可能因为防止二次遍历再解析，现在只有一次遍历 +// if (targetPath.equals(target)) { // 必须 valuePath 和保证 getValueByPath 传进去的一致！ +// Log.d(TAG, "onParse targetPath.equals(target) >>"); +// +// //非查询关键词 @key 不影响查询，直接跳过 +// if (isTable && (key.startsWith("@") == false || apijson.JSONMap.TABLE_KEY_LIST.contains(key))) { +// Log.e(TAG, "onParse isTable && (key.startsWith(@) == false" +// + " || apijson.JSONMap.TABLE_KEY_LIST.contains(key)) >> return null;"); +// return false;//获取不到就不用再做无效的query了。不考虑 Table:{Table:{}}嵌套 +// } else { +// Log.d(TAG, "onParse isTable(table) == false >> return true;"); +// return true;//舍去，对Table无影响 +// } +// } + + // 直接替换原来的 key@: path 为 key: target Log.i(TAG, "onParse >> key = replaceKey; value = target;"); key = replaceKey; value = target; @@ -386,7 +512,6 @@ else if (value instanceof String) { // 引用赋值路径 else { throw new IllegalArgumentException(path + "/" + key + ":value 中 value 必须为 依赖路径String 或 SQL子查询JSONObject ！"); } - } if (key.endsWith("()")) { @@ -397,21 +522,24 @@ else if (value instanceof String) { // 引用赋值路径 String k = key.substring(0, key.length() - 2); String type; //远程函数比较少用，一般一个Table:{}内用到也就一两个，所以这里用 "-","0","+" 更直观，转用 -1,0,1 对性能提升不大。 - if (k.endsWith("-")) { //不能封装到functionMap后批量执行，否则会导致非Table内的 key-():function() 在onChildParse后执行！ + boolean isMinus = k.endsWith("-"); + boolean isPlus = isMinus == false && k.endsWith("+"); + if (isMinus) { //不能封装到functionMap后批量执行，否则会导致非Table内的 key-():function() 在onChildParse后执行！ type = "-"; k = k.substring(0, k.length() - 1); - - parseFunction(k, (String) value, parentPath, name, request); + } + else if (isPlus) { + type = "+"; + k = k.substring(0, k.length() - 1); } else { - if (k.endsWith("+")) { - type = "+"; - k = k.substring(0, k.length() - 1); - } - else { - type = "0"; - } + type = "0"; + } + if (isPlus == false && isTable == false) { + parseFunction(key, k, (String) value, this.type == TYPE_ITEM ? path : parentPath, name, request, isMinus); + } + else { //远程函数比较少用，一般一个Table:{}内用到也就一两个，所以这里循环里new出来对性能影响不大。 Map map = functionMap.get(type); if (map == null) { @@ -422,8 +550,8 @@ else if (value instanceof String) { // 引用赋值路径 functionMap.put(type, map); } } - else if (isTable && key.startsWith("@") && JSONRequest.TABLE_KEY_LIST.contains(key) == false) { - customMap.put(key, value); + else if (isTable && key.startsWith("@") && JSONMap.TABLE_KEY_LIST.contains(key) == false) { + customMap.put(key, value); } else { sqlRequest.put(key, value); @@ -435,21 +563,22 @@ else if (isTable && key.startsWith("@") && JSONRequest.TABLE_KEY_LIST.contains(k /** + * @param index * @param key * @param value - * @param isFirst + * @param cache * @return * @throws Exception */ @Override - public JSON onChildParse(int index, String key, JSONObject value) throws Exception { + public Object onChildParse(int index, String key, M value, Object cache) throws Exception { boolean isFirst = index <= 0; boolean isMain = isFirst && type == TYPE_ITEM; - JSON child; + Object child; boolean isEmpty; - if (apijson.JSONObject.isArrayKey(key)) {//APIJSON Array + if (JSONMap.isArrayKey(key)) { // APIJSON Array if (isMain) { throw new IllegalArgumentException(parentPath + "/" + key + ":{} 不合法！" + "数组 []:{} 中第一个 key:{} 必须是主表 TableKey:{} ！不能为 arrayKey[]:{} ！"); @@ -459,21 +588,40 @@ public JSON onChildParse(int index, String key, JSONObject value) throws Excepti arrayCount ++; int maxArrayCount = parser.getMaxArrayCount(); if (arrayCount > maxArrayCount) { - throw new IllegalArgumentException(path + " 内截至 " + key + ":{} 时数组对象 key[]:{} 的数量达到 " + arrayCount + " 已超限，必须在 0-" + maxArrayCount + " 内 !"); + throw new IllegalArgumentException(path + " 内截至 " + key + ":{} 时数组对象 key[]:{} " + + "的数量达到 " + arrayCount + " 已超限，必须在 0-" + maxArrayCount + " 内 !"); } } - child = parser.onArrayParse(value, path, key, isSubquery); - isEmpty = child == null || ((JSONArray) child).isEmpty(); + String query = getString(value, KEY_QUERY); + child = parser.onArrayParse(value, path, key, isSubquery, cache instanceof List ? (L) cache : null); + isEmpty = child == null || ((List) child).isEmpty(); + + if ("2".equals(query) || "ALL".equals(query)) { // 不判断 isEmpty，因为分页数据可能只是某页没有 + String totalKey = JSONResponse.formatArrayKey(key) + "Total"; + String infoKey = JSONResponse.formatArrayKey(key) + "Info"; + if ((request.containsKey(totalKey) || request.containsKey(infoKey) + || request.containsKey(totalKey + "@") || request.containsKey(infoKey + "@")) == false) { + // onParse("total@", "/" + key + "/total"); + // onParse(infoKey + "@", "/" + key + "/info"); + // 替换为以下性能更好、对流程干扰最小的方式： + + String keyPath = AbstractParser.getValuePath(type == TYPE_ITEM ? path : parentPath, "/" + key); + String totalPath = keyPath + "/total"; + String infoPath = keyPath + "/info"; + response.put(totalKey, onReferenceParse(totalPath)); + response.put(infoKey, onReferenceParse(infoPath)); + } + } } else { //APIJSON Object - boolean isTableKey = JSONRequest.isTableKey(Pair.parseEntry(key, true).getKey()); + boolean isTableKey = JSONMap.isTableKey(Pair.parseEntry(key, true).getKey()); if (type == TYPE_ITEM && isTableKey == false) { throw new IllegalArgumentException(parentPath + "/" + key + ":{} 不合法！" + "数组 []:{} 中每个 key:{} 都必须是表 TableKey:{} 或 数组 arrayKey[]:{} ！"); } - if ( //避免使用 "test":{"Test":{}} 绕过限制，实现查询爆炸 isTableKey && + if ( //避免使用 "test":{"Test":{}} 绕过限制，实现查询爆炸 isTableKey && (arrayConfig == null || arrayConfig.getPosition() == 0)) { objectCount ++; int maxObjectCount = parser.getMaxObjectCount(); @@ -483,29 +631,31 @@ public JSON onChildParse(int index, String key, JSONObject value) throws Excepti } } - child = parser.onObjectParse(value, path, key, isMain ? arrayConfig.setType(SQLConfig.TYPE_ITEM_CHILD_0) : null, isSubquery); + child = parser.onObjectParse(value, path, key, isMain ? arrayConfig.setType(SQLConfig.TYPE_ITEM_CHILD_0) : null + , isSubquery, cache instanceof Map ? (M) cache : null); - isEmpty = child == null || ((JSONObject) child).isEmpty(); + isEmpty = child == null || ((Map) child).isEmpty(); if (isFirst && isEmpty) { invalidate(); } } - Log.i(TAG, "onChildParse ObjectParser.onParse key = " + key + "; child = " + child); +// Log.i(TAG, "onChildParse ObjectParser.onParse key = " + key + "; child = " + child); - return isEmpty ? null : child;//只添加! isChildEmpty的值，可能数据库返回数据不够count + return isEmpty ? null : child; // 只添加! isChildEmpty的值，可能数据库返回数据不够count } + //TODO 改用 MySQL json_add,json_remove,json_contains 等函数！不过就没有具体报错了，或许可以新增功能符，或者直接调 SQL 函数 - //TODO 改用 MySQL json_add,json_remove,json_contains 等函数！ /**PUT key:[] * @param key * @param array * @throws Exception */ @Override - public void onPUTArrayParse(@NotNull String key, @NotNull JSONArray array) throws Exception { + public void onPUTArrayParse(@NotNull String key, @NotNull L array) throws Exception { if (isTable == false || array.isEmpty()) { + sqlRequest.put(key, array); Log.e(TAG, "onPUTArrayParse isTable == false || array == null || array.isEmpty() >> return;"); return; } @@ -516,117 +666,278 @@ public void onPUTArrayParse(@NotNull String key, @NotNull JSONArray array) throw } else if (key.endsWith("-")) {//remove putType = 2; } else {//replace - // throw new IllegalAccessException("PUT " + path + ", PUT Array不允许 " + key + - // " 这种没有 + 或 - 结尾的key！不允许整个替换掉原来的Array！"); + sqlRequest.put(key, array); + return; } - String realKey = AbstractSQLConfig.getRealKey(method, key, false, false); + String realKey = AbstractSQLConfig.gainRealKey(method, key, false, false); //GET > add all 或 remove all > PUT > remove key //GET <<<<<<<<<<<<<<<<<<<<<<<<< - JSONObject rq = new JSONObject(); - rq.put(JSONRequest.KEY_ID, request.get(JSONRequest.KEY_ID)); - rq.put(JSONRequest.KEY_COLUMN, realKey); - JSONObject rp = parseResponse(RequestMethod.GET, table, null, rq, null, false); + M rq = JSON.createJSONObject(); + rq.put(JSONMap.KEY_ID, request.get(JSONMap.KEY_ID)); + rq.put(JSONMap.KEY_COLUMN, realKey); + M rp = parseResponse(RequestMethod.GET, table, null, rq, null, false); //GET >>>>>>>>>>>>>>>>>>>>>>>>> //add all 或 remove all <<<<<<<<<<<<<<<<<<<<<<<<< - JSONArray targetArray = rp == null ? null : rp.getJSONArray(realKey); - if (targetArray == null) { - targetArray = new JSONArray(); + Object target = rp == null ? null : rp.get(realKey); + if (target instanceof String) { + try { + target = JSON.parse(target); + } catch (Throwable e) { + if (Log.DEBUG) { + Log.e(TAG, "try {\n" + + "\t\t\t\ttarget = parseJSON((String) target);\n" + + "\t\t\t}\n" + + "\t\t\tcatch (Throwable e) = " + e.getMessage()); + } + } + } + + if (apijson.JSON.isBoolOrNumOrStr(target)) { + throw new NullPointerException("PUT " + path + ", " + realKey + " 类型为 " + target.getClass().getSimpleName() + "，" + + "不支持 Boolean, String, Number 等类型字段使用 'key+': [] 或 'key-': [] ！" + + "对应字段在数据库的值必须为 L, JSONRequest 中的一种！" + + "值为 JSONRequest 类型时传参必须是 'key+': [{'key': value, 'key2': value2}] 或 'key-': ['key', 'key2'] ！" + ); + } + + boolean isAdd = putType == 1; + + Collection targetArray = target instanceof Collection ? (Collection) target : null; + Map targetObj = target instanceof Map ? (Map) target : null; + + if (targetArray == null && targetObj == null) { + if (isAdd == false) { + throw new NullPointerException("PUT " + path + ", " + realKey + (target == null ? " 值为 null，不支持移除！" + : " 类型为 " + target.getClass().getSimpleName() + "，不支持这样移除！") + + "对应字段在数据库的值必须为 L, JSONRequest 中的一种，且 key- 移除时，本身的值不能为 null！" + + "值为 JSONRequest 类型时传参必须是 'key+': [{'key': value, 'key2': value2}] 或 'key-': ['key', 'key2'] ！" + ); + } + + targetArray = JSON.createJSONArray(); } - for (Object obj : array) { + + for (int i = 0; i < array.size(); i++) { + Object obj = array.get(i); if (obj == null) { continue; } - if (putType == 1) { - if (targetArray.contains(obj)) { - throw new ConflictException("PUT " + path + ", " + realKey + ":" + obj + " 已存在！"); + + if (isAdd) { + if (targetArray != null) { + if (targetArray.contains(obj)) { + throw new ConflictException("PUT " + path + ", " + key + "/" + i + " 已存在！"); + } + targetArray.add(obj); + } else { + if (obj != null && obj instanceof Map == false) { + throw new ConflictException("PUT " + path + ", " + key + "/" + i + " 必须为 JSONRequest {} ！"); + } + targetObj.putAll((Map) obj); } - targetArray.add(obj); - } else if (putType == 2) { - if (targetArray.contains(obj) == false) { - throw new NullPointerException("PUT " + path + ", " + realKey + ":" + obj + " 不存在！"); + } else { + if (targetArray != null) { + if (targetArray.contains(obj) == false) { + throw new NullPointerException("PUT " + path + ", " + key + "/" + i + " 不存在！"); + } + targetArray.remove(obj); + } else { + if (obj instanceof String == false) { + throw new ConflictException("PUT " + path + ", " + key + "/" + i + " 必须为 String 类型 ！"); + } + if (targetObj.containsKey(obj) == false) { + throw new NullPointerException("PUT " + path + ", " + key + "/" + i + " 不存在！"); + } + targetObj.remove(obj); } - targetArray.remove(obj); } } //add all 或 remove all >>>>>>>>>>>>>>>>>>>>>>>>> //PUT <<<<<<<<<<<<<<<<<<<<<<<<< - sqlRequest.put(realKey, targetArray); + sqlRequest.put(realKey, targetArray != null ? targetArray : JSON.toJSONString(targetObj)); // FIXME, SerializerFeature.WriteMapNullValue)); //PUT >>>>>>>>>>>>>>>>>>>>>>>>> } @Override - public void onTableArrayParse(String key, JSONArray value) throws Exception { - String childKey = key.substring(0, key.length() - JSONRequest.KEY_ARRAY.length()); - JSONArray valueArray = (JSONArray) value; + public void onTableArrayParse(String key, L valueArray) throws Exception { + String childKey = key.substring(0, key.length() - JSONMap.KEY_ARRAY.length()); int allCount = 0; - JSONArray ids = new JSONArray(); + L ids = JSON.createJSONArray(); int version = parser.getVersion(); int maxUpdateCount = parser.getMaxUpdateCount(); - String idKey = parser.createSQLConfig().getIdKey(); //Table[]: [{}] arrayConfig 为 null + SQLConfig cfg = null; // 不能污染当前的配置 getSQLConfig(); + if (cfg == null) { // TODO 每次都创建成本比较高，是否新增 defaultInstance 或者 configInstance 用来专门 getIdKey 等？ + cfg = parser.createSQLConfig(); + } + + String idKey = cfg.getIdKey(); //Table[]: [{}] arrayConfig 为 null boolean isNeedVerifyContent = parser.isNeedVerifyContent(); - + + cfg.setTable(childKey); // Request 表 structure 中配置 "ALLOW_PARTIAL_UPDATE_FAILED": "Table[],key[],key:alias[]" 自动配置 + boolean allowPartialFailed = cfg.allowPartialUpdateFailed(); + L failedIds = allowPartialFailed ? JSON.createJSONArray() : null; + + int firstFailIndex = -1; + M firstFailReq = null; + Throwable firstFailThrow = null; for (int i = 0; i < valueArray.size(); i++) { //只要有一条失败，则抛出异常，全部失败 //TODO 改成一条多 VALUES 的 SQL 性能更高，报错也更会更好处理，更人性化 - JSONObject item; + M item; try { - item = valueArray.getJSONObject(i); + item = JSON.get(valueArray, i); + if (item == null) { + throw new NullPointerException(); + } } catch (Exception e) { - throw new UnsupportedDataTypeException("批量新增/修改失败！" + key + "/" + i + ":value 中value不合法！类型必须是 OBJECT ，结构为 {} !"); - } - JSONRequest req = new JSONRequest(childKey, item); - - //parser.getMaxSQLCount() ? 可能恶意调用接口，把数据库拖死 - JSONObject result = (JSONObject) onChildParse(0, "" + i, isNeedVerifyContent == false ? req : parser.parseCorrectRequest(method, childKey, version, "", req, maxUpdateCount, parser)); - result = result.getJSONObject(childKey); - // - boolean success = JSONResponse.isSuccess(result); - int count = result == null ? null : result.getIntValue(JSONResponse.KEY_COUNT); - - if (success == false || count != 1) { //如果 code = 200 但 count != 1，不能算成功，掩盖了错误不好排查问题 - throw new ServerException("批量新增/修改失败！" + key + "/" + i + "：" + (success ? "成功但 count != 1 ！" : (result == null ? "null" : result.getString(JSONResponse.KEY_MSG)))); + throw new UnsupportedDataTypeException( + "批量新增/修改失败！" + key + "/" + i + ":value 中value不合法！类型必须是 OBJECT ，结构为 {} !" + ); } - allCount += count; - ids.add(result.get(idKey)); + Object id = item.get(idKey); + M req = JSON.createJSONObject(childKey, item); + + M result = null; + try { + if (isNeedVerifyContent) { + req = parser.parseCorrectRequest(method, childKey, version, "", req, maxUpdateCount, parser); + } + //parser.getMaxSQLCount() ? 可能恶意调用接口，把数据库拖死 + result = (M) onChildParse(0, "" + i, req, null); + } + catch (Exception e) { + if (allowPartialFailed == false) { + throw e; + } + + if (firstFailThrow == null) { + firstFailThrow = e; + firstFailReq = JSON.get(valueArray, i); // item + } + } + + result = result == null ? null : JSON.get(result, childKey); + + boolean success = JSONResponse.isSuccess(result); + int count = result == null ? 0 : getIntValue(result, JSONResponse.KEY_COUNT); + if (id == null && result != null) { + id = result.get(idKey); + } + + if (success == false || count != 1) { //如果 code = 200 但 count != 1，不能算成功，掩盖了错误不好排查问题 + if (allowPartialFailed) { + failedIds.add(id); + if (firstFailIndex < 0) { + firstFailIndex = i; + } + } + else { + throw new ServerException( + "批量新增/修改失败！" + key + "/" + i + "：" + (success ? "成功但 count != 1 ！" + : (result == null ? "null" : getString(result, JSONResponse.KEY_MSG)) + )); + } + } + + allCount += 1; // 加了 allowPartialFailed 后 count 可能为 0 allCount += count; + ids.add(id); } - JSONObject allResult = AbstractParser.newSuccessResult(); - allResult.put(JSONResponse.KEY_COUNT, allCount); - allResult.put(idKey + "[]", ids); + int failedCount = failedIds == null ? 0 : failedIds.size(); + if (failedCount > 0 && failedCount >= allCount) { + throw new ServerException("批量新增/修改 " + key + ":[] 中 " + allCount + " 个子项全部失败！" + + "第 " + firstFailIndex + " 项失败原因：" + (firstFailThrow == null ? "" : firstFailThrow.getMessage())); + } + + M allResult = getParser().newSuccessResult(); + if (failedCount > 0) { + allResult.put("failedCount", failedCount); + allResult.put("failedIdList", failedIds); + + M failObj = JSON.createJSONObject(); + failObj.put("index", firstFailIndex); + failObj.put(childKey, firstFailReq); + + if (firstFailThrow instanceof CommonException && firstFailThrow.getCause() != null) { + firstFailThrow = firstFailThrow.getCause(); + } + M obj = firstFailThrow == null ? failObj : getParser().extendErrorResult(failObj, firstFailThrow, parser.isRoot()); + if (Log.DEBUG && firstFailThrow != null) { + obj.put("trace:throw", firstFailThrow.getClass().getName()); + obj.put("trace:stack", firstFailThrow.getStackTrace()); + } + + allResult.put("firstFailed", obj); + } + allResult.put(JSONResponse.KEY_COUNT, allCount); + allResult.put(idKey + "[]", ids); response.put(childKey, allResult); //不按原样返回，避免数据量过大 } @Override - public JSONObject parseResponse(RequestMethod method, String table, String alias, JSONObject request, List joinList, boolean isProcedure) throws Exception { - SQLConfig config = newSQLConfig(method, table, alias, request, joinList, isProcedure); + public M parseResponse(RequestMethod method, String table, String alias + , M request, List> joinList, boolean isProcedure) throws Exception { + SQLConfig config = newSQLConfig(method, table, alias, request, joinList, isProcedure) + .setParser(getParser()) + .setObjectParser(this); return parseResponse(config, isProcedure); } @Override - public JSONObject parseResponse(SQLConfig config, boolean isProcedure) throws Exception { + public M parseResponse(SQLConfig config, boolean isProcedure) throws Exception { + parser = getParser(); if (parser.getSQLExecutor() == null) { parser.createSQLExecutor(); } + if (config.gainParser() == null) { + config.setParser(parser); + } return parser.getSQLExecutor().execute(config, isProcedure); } @Override - public SQLConfig newSQLConfig(boolean isProcedure) throws Exception { - return newSQLConfig(method, table, alias, sqlRequest, joinList, isProcedure); + public SQLConfig newSQLConfig(boolean isProcedure) throws Exception { + String raw = Log.DEBUG == false || sqlRequest == null ? null : getString(sqlRequest, JSONMap.KEY_RAW); + String[] keys = raw == null ? null : StringUtil.split(raw); + if (keys != null && keys.length > 0) { + boolean allow = AbstractSQLConfig.ALLOW_MISSING_KEY_4_COMBINE; + + for (String key : keys) { + if (sqlRequest.get(key) != null) { + continue; + } + + String msg = "@raw:value 的 value 中 " + key + " 不合法！对应的 " + + key + ": value 在当前对象 " + name + " 不存在或 value = null，无法有效转为原始 SQL 片段！"; + + if (allow == false) { + throw new UnsupportedOperationException(msg); + } + + if (parser instanceof AbstractParser) { + ((AbstractParser) parser).putWarnIfNeed(JSONMap.KEY_RAW, msg); + } + break; + } + } + + return newSQLConfig(method, table, alias, sqlRequest, joinList, isProcedure) + .setParser(parser) + .setObjectParser(this); } /**SQL 配置，for single object @@ -634,26 +945,28 @@ public SQLConfig newSQLConfig(boolean isProcedure) throws Exception { * @throws Exception */ @Override - public AbstractObjectParser setSQLConfig() throws Exception { - return setSQLConfig(1, 0, 0); + public AbstractObjectParser setSQLConfig() throws Exception { + return setSQLConfig(RequestMethod.isQueryMethod(method) ? 1 : 0, 0, 0); } @Override - public AbstractObjectParser setSQLConfig(int count, int page, int position) throws Exception { - if (isTable == false) { - return this; + public AbstractObjectParser setSQLConfig(int count, int page, int position) throws Exception { + if (isTable == false || isReuse) { + return setPosition(position); } if (sqlConfig == null) { try { sqlConfig = newSQLConfig(false); } - catch (NotExistException e) { - e.printStackTrace(); - return this; + catch (Exception e) { + if (e instanceof NotExistException || (e instanceof CommonException && e.getCause() instanceof NotExistException)) { + return this; + } + throw e; } } - sqlConfig.setCount(count).setPage(page).setPosition(position); + sqlConfig.setCount(sqlConfig.getCount() <= 0 ? count : sqlConfig.getCount()).setPage(page).setPosition(position); parser.onVerifyRole(sqlConfig); @@ -663,43 +976,47 @@ public AbstractObjectParser setSQLConfig(int count, int page, int position) thro - protected SQLConfig sqlConfig = null;//array item复用 + protected SQLConfig sqlConfig = null;//array item复用 /**SQL查询，for array item - * @param count - * @param page - * @param position * @return this * @throws Exception */ @Override - public AbstractObjectParser executeSQL() throws Exception { + public AbstractObjectParser executeSQL() throws Exception { //执行SQL操作数据库 if (isTable == false) {//提高性能 - sqlReponse = new JSONObject(sqlRequest); - } else { - try { - sqlReponse = onSQLExecute(); - } - catch (NotExistException e) { - // Log.e(TAG, "getObject try { response = getSQLObject(config2); } catch (Exception e) {"); - // if (e instanceof NotExistException) {//非严重异常，有时候只是数据不存在 - // // e.printStackTrace(); - sqlReponse = null;//内部吃掉异常，put到最外层 - // requestObject.put(JSONResponse.KEY_MSG - // , StringUtil.getString(requestObject.get(JSONResponse.KEY_MSG) - // + "; query " + path + " cath NotExistException:" - // + newErrorResult(e).getString(JSONResponse.KEY_MSG))); - // } else { - // throw e; - // } - } - - if (drop) {//丢弃Table，只为了向下提供条件 - sqlReponse = null; - } + sqlResponse = JSON.createJSONObject(); + sqlResponse.putAll(sqlRequest); } - - return this; + else { + try { + sqlResponse = onSQLExecute(); + } + catch (Exception e) { + if (e instanceof NotExistException || (e instanceof CommonException && e.getCause() instanceof NotExistException)) { + // Log.e(TAG, "getObject try { response = getSQLObject(config2); } catch (Exception e) {"); + // if (e instanceof NotExistException) {//非严重异常，有时候只是数据不存在 + // // e.printStackTrace(); + sqlResponse = null;//内部吃掉异常，put到最外层 + // requestObject.put(JSONResponse.KEY_MSG + // , StringUtil.getString(requestObject.get(JSONResponse.KEY_MSG) + // + "; query " + path + " cath NotExistException:" + // + newErrorResult(e).getString(JSONResponse.KEY_MSG))); + // } else { + // throw e; + // } + } + else { + throw e; + } + } + } + + if (drop) {//丢弃Table，只为了向下提供条件 + sqlResponse = null; + } + + return this; } /** @@ -707,13 +1024,13 @@ public AbstractObjectParser executeSQL() throws Exception { * @throws Exception */ @Override - public JSONObject response() throws Exception { - if (sqlReponse == null || sqlReponse.isEmpty()) { + public M response() throws Exception { + if (sqlResponse == null || sqlResponse.isEmpty()) { if (isTable) {//Table自身都获取不到值，则里面的Child都无意义，不需要再解析 return null; // response; } } else { - response.putAll(sqlReponse); + response.putAll(sqlResponse); } @@ -742,50 +1059,78 @@ public void onFunctionResponse(String type) throws Exception { //解析函数function Set> functionSet = map == null ? null : map.entrySet(); if (functionSet != null && functionSet.isEmpty() == false) { - // JSONObject json = "-".equals(type) ? request : response; // key-():function 是实时执行，而不是在这里批量执行 + boolean isMinus = "-".equals(type); + M json = isMinus ? sqlRequest : response; // key-():function 是实时执行，而不是在这里批量执行 for (Entry entry : functionSet) { - - // parseFunction(json, entry.getKey(), entry.getValue()); - parseFunction(entry.getKey(), entry.getValue(), parentPath, name, response); + parseFunction(entry.getKey(), entry.getKey(), entry.getValue(), this.type == TYPE_ITEM ? path : parentPath, name, json, isMinus); } } } - public void parseFunction(String key, String value, String parentPath, String currentName, JSONObject currentObject) throws Exception { + + //public void parseFunction(String key, String value, String parentPath, String currentName, JSONRequest currentObject) throws Exception { + // parseFunction(key, value, parentPath, currentName, currentObject, false); + //} + public void parseFunction(String rawKey, String key, String value, String parentPath + , String currentName, M currentObject, boolean isMinus) throws Exception { Object result; - if (key.startsWith("@")) { - FunctionBean fb = AbstractFunctionParser.parseFunction(value, currentObject, true); + boolean containRaw = rawKeyList != null && rawKeyList.contains(rawKey); - SQLConfig config = newSQLConfig(true); + boolean isProcedure = key.startsWith("@"); + if (isProcedure) { + FunctionBean fb = AbstractFunctionParser.parseFunction(value, currentObject, true, containRaw); + + SQLConfig config = newSQLConfig(true); + String sch = fb.getSchema(); + if (StringUtil.isNotEmpty(sch, true)) { + config.setSchema(sch); + } config.setProcedure(fb.toFunctionCallString(true)); result = parseResponse(config, true); key = key.substring(1); } else { - result = parser.onFunctionParse(key, value, parentPath, currentName, currentObject); + result = parser.onFunctionParse(key, value, parentPath, currentName, currentObject, containRaw); } - if (result != null) { - String k = AbstractSQLConfig.getRealKey(method, key, false, false); + String k = AbstractSQLConfig.gainRealKey(method, key, false, false); - response.put(k, result); - parser.putQueryResult(AbstractParser.getAbsPath(path, k), result); - } + if (isProcedure == false && isMinus) { + if (result != null) { + sqlRequest.put(k, result); + } else { + sqlRequest.remove(k); + } + } + + if (result != null) { + response.put(k, result); + } else { + response.remove(k); + } + + parser.putQueryResult(AbstractParser.getAbsPath(path, k), result); } @Override public void onChildResponse() throws Exception { //把isTable时取出去child解析后重新添加回来 - Set> set = childMap == null ? null : childMap.entrySet(); + Set> set = childMap == null ? null : childMap.entrySet(); if (set != null) { int index = 0; - for (Entry entry : set) { - if (entry != null) { - response.put(entry.getKey(), onChildParse(index, entry.getKey(), entry.getValue())); - index ++; + for (Entry entry : set) { + Object child = entry == null ? null : onChildParse(index, entry.getKey(), entry.getValue(), null); + if (child == null + || (child instanceof Map && ((M) child).isEmpty()) + || (child instanceof List && ((L) child).isEmpty()) + ) { + continue; } + + response.put(entry.getKey(), child); + index ++; } } } @@ -797,12 +1142,68 @@ public Object onReferenceParse(@NotNull String path) { return parser.getValueByPath(path); } + @SuppressWarnings("unchecked") @Override - public JSONObject onSQLExecute() throws Exception { - JSONObject result = parser.executeSQL(sqlConfig, isSubquery); - if (isSubquery == false && result != null) { - parser.putQueryResult(path, result);//解决获取关联数据时requestObject里不存在需要的关联数据 + public M onSQLExecute() throws Exception { + int position = getPosition(); + + M result = getCache(); + if (result != null) { + parser.putQueryResult(path, result); } + else if (isArrayMainTable && position > 0) { // 数组主表使用专门的缓存数据 + result = parser.getArrayMainCacheItem(parentPath.substring(0, parentPath.lastIndexOf("[]") + 2), position); + } + else { + result = parser.executeSQL(sqlConfig, isSubquery); + + boolean isSimpleArray = false; + // 提取并缓存数组主表的列表数据 + List rawList = result == null ? null : (List) result.remove(AbstractSQLExecutor.KEY_RAW_LIST); + + if (isArrayMainTable && position == 0 && rawList != null) { + + isSimpleArray = (functionMap == null || functionMap.isEmpty()) + && (customMap == null || customMap.isEmpty()) + && (childMap == null || childMap.isEmpty()) + && (table.equals(arrayTable)); + + // APP JOIN 副表时副表返回了这个字段 rawList = (List) result.remove(AbstractSQLExecutor.KEY_RAW_LIST); + String arrayPath = parentPath.substring(0, parentPath.lastIndexOf("[]") + 2); + + if (isSimpleArray) { + parser.putQueryResult(arrayPath, rawList); // 从数组外部引用该数组内值需要 + } else { + long startTime = System.currentTimeMillis(); + + for (int i = 1; i < rawList.size(); i++) { // 从 1 开始，0 已经处理过 + M obj = rawList.get(i); + + if (obj != null) { + // obj.remove(AbstractSQLExecutor.KEY_VICE_ITEM); + parser.putQueryResult(arrayPath + "/" + i + "/" + name, obj); // 解决获取关联数据时requestObject里不存在需要的关联数据 + } + } + + long endTime = System.currentTimeMillis(); // 3ms - 8ms + Log.e(TAG, "\n onSQLExecute <<<<<<<<<<<<<<<<<<<<<<<<<<<<" + + "\n for (int i = 1; i < list.size(); i++) startTime = " + startTime + + "; endTime = " + endTime + "; duration = " + (endTime - startTime) + + "\n >>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n "); + } + + parser.putArrayMainCache(arrayPath, rawList); + } + + if (isSubquery == false && result != null) { + parser.putQueryResult(path, result); // 解决获取关联数据时requestObject里不存在需要的关联数据 + + if (isSimpleArray) { // FIXME 改为从缓存获取，而不是 result 查 + result.put(AbstractSQLExecutor.KEY_RAW_LIST, rawList); + } + } + } + return result; } @@ -840,7 +1241,7 @@ public void recycle() { request = null; response = null; sqlRequest = null; - sqlReponse = null; + sqlResponse = null; functionMap = null; customMap = null; @@ -849,16 +1250,13 @@ public void recycle() { - - - protected RequestMethod method; @Override - public AbstractObjectParser setMethod(RequestMethod method) { + public AbstractObjectParser setMethod(RequestMethod method) { if (this.method != method) { this.method = method; sqlConfig = null; - //TODO ? sqlReponse = null; + //TODO ? sqlResponse = null; } return this; } @@ -868,8 +1266,6 @@ public RequestMethod getMethod() { } - - @Override public boolean isTable() { return isTable; @@ -886,28 +1282,28 @@ public String getTable() { public String getAlias() { return alias; } + @Override - public SQLConfig getArrayConfig() { + public SQLConfig getArrayConfig() { return arrayConfig; } - @Override - public SQLConfig getSQLConfig() { + public SQLConfig getSQLConfig() { return sqlConfig; } @Override - public JSONObject getResponse() { + public M getResponse() { return response; } @Override - public JSONObject getSqlRequest() { + public M getSQLRequest() { return sqlRequest; } @Override - public JSONObject getSqlReponse() { - return sqlReponse; + public M getSQLResponse() { + return sqlResponse; } @Override @@ -919,9 +1315,8 @@ public Map> getFunctionMap() { return functionMap; } @Override - public Map getChildMap() { + public Map getChildMap() { return childMap; } - } diff --git a/APIJSONORM/src/main/java/apijson/orm/AbstractParser.java b/APIJSONORM/src/main/java/apijson/orm/AbstractParser.java index 3168cf856..cd0b2c7b8 100755 --- a/APIJSONORM/src/main/java/apijson/orm/AbstractParser.java +++ b/APIJSONORM/src/main/java/apijson/orm/AbstractParser.java @@ -1,54 +1,126 @@ -/*Copyright (C) 2020 THL A29 Limited, a Tencent company. All rights reserved. +/*Copyright (C) 2020 Tencent. All rights reserved. This source code is licensed under the Apache License Version 2.0.*/ package apijson.orm; -import static apijson.JSONObject.KEY_EXPLAIN; -import static apijson.RequestMethod.GET; +import apijson.*; +import apijson.orm.exception.ConflictException; import java.io.UnsupportedEncodingException; +import java.lang.management.ManagementFactory; +import java.net.InetAddress; +import java.net.URLDecoder; +import java.net.URLEncoder; import java.sql.Connection; import java.sql.SQLException; import java.sql.Savepoint; -import java.util.ArrayList; -import java.util.Arrays; -import java.util.Comparator; -import java.util.HashMap; -import java.util.LinkedHashSet; -import java.util.List; -import java.util.Map; +import java.util.*; import java.util.Map.Entry; -import java.util.Set; -import java.util.SortedMap; -import java.util.TreeMap; -import java.util.concurrent.TimeoutException; - -import javax.activation.UnsupportedDataTypeException; - -import com.alibaba.fastjson.JSONArray; -import com.alibaba.fastjson.JSONObject; - -import apijson.JSON; -import apijson.JSONResponse; -import apijson.Log; -import apijson.NotNull; -import apijson.RequestMethod; -import apijson.RequestRole; -import apijson.StringUtil; -import apijson.orm.exception.ConditionErrorException; -import apijson.orm.exception.ConflictException; -import apijson.orm.exception.NotExistException; -import apijson.orm.exception.NotLoggedInException; -import apijson.orm.exception.OutOfRangeException; -/**parser for parsing request to JSONObject +import javax.management.MBeanServer; +import javax.management.ObjectName; +import javax.management.Query; + + +import apijson.orm.exception.CommonException; +import apijson.orm.exception.UnsupportedDataTypeException; + +import static apijson.JSON.*; +import static apijson.JSONMap.*; +import static apijson.JSONRequest.*; +import static apijson.RequestMethod.CRUD; +import static apijson.RequestMethod.GET; + +/**Parser for parsing request to JSONRequest * @author Lemon */ -public abstract class AbstractParser implements Parser, ParserCreator, VerifierCreator, SQLCreator { +public abstract class AbstractParser, L extends List> + implements Parser { protected static final String TAG = "AbstractParser"; + /** + * JSON 对象、数组对应的数据源、版本、角色、method等 + */ + protected Map> keyObjectAttributesMap = new HashMap<>(); + /** + * 可以通过切换该变量来控制是否打印关键的接口请求内容。保守起见，该值默认为false。 + * 与 {@link Log#DEBUG} 任何一个为 true 都会打印关键的接口请求内容。 + */ + public static boolean IS_PRINT_REQUEST_STRING_LOG = false; + + /** + * 打印大数据量日志的标识。线上环境比较敏感，可以通过切换该变量来控制异常栈抛出、错误日志打印。保守起见，该值默认为false。 + * 与 {@link Log#DEBUG} 任何一个为 true 都会打印关键的接口请求及响应信息。 + */ + public static boolean IS_PRINT_BIG_LOG = false; + + /** + * 可以通过切换该变量来控制是否打印关键的接口请求结束时间。保守起见，该值默认为false。 + * 与 {@link Log#DEBUG} 任何一个为 true 都会打印关键的接口请求结束时间。 + */ + public static boolean IS_PRINT_REQUEST_ENDTIME_LOG = false; + + /** + * 可以通过切换该变量来控制返回 trace:stack 字段，如果是 gson 则不设置为 false，避免序列化报错。 + * 与 {@link Log#DEBUG} 任何一个为 true 返回 trace:stack 字段。 + */ + public static boolean IS_RETURN_STACK_TRACE = true; + + + /** + * 分页页码是否从 1 开始，默认为从 0 开始 + */ + public static boolean IS_START_FROM_1 = false; + public static int MAX_QUERY_PAGE = 100; + public static int DEFAULT_QUERY_COUNT = 10; + public static int MAX_QUERY_COUNT = 100; + public static int MAX_UPDATE_COUNT = 10; + public static int MAX_SQL_COUNT = 200; + public static int MAX_OBJECT_COUNT = 5; + public static int MAX_ARRAY_COUNT = 5; + public static int MAX_QUERY_DEPTH = 5; + + public boolean isStartFrom1() { + return IS_START_FROM_1; + } + @Override + public int getMinQueryPage() { + return isStartFrom1() ? 1 : 0; + } + @Override + public int getMaxQueryPage() { + return MAX_QUERY_PAGE; + } + @Override + public int getDefaultQueryCount() { + return DEFAULT_QUERY_COUNT; + } + @Override + public int getMaxQueryCount() { + return MAX_QUERY_COUNT; + } + @Override + public int getMaxUpdateCount() { + return MAX_UPDATE_COUNT; + } + @Override + public int getMaxSQLCount() { + return MAX_SQL_COUNT; + } + @Override + public int getMaxObjectCount() { + return MAX_OBJECT_COUNT; + } + @Override + public int getMaxArrayCount() { + return MAX_ARRAY_COUNT; + } + @Override + public int getMaxQueryDepth() { + return MAX_QUERY_DEPTH; + } /** * method = null @@ -57,13 +129,16 @@ public AbstractParser() { this(null); } /**needVerify = true - * @param requestMethod null ? requestMethod = GET + * @param method null ? requestMethod = GET */ public AbstractParser(RequestMethod method) { - this(method, true); + super(); + setMethod(method); + setNeedVerifyRole(AbstractVerifier.ENABLE_VERIFY_ROLE); + setNeedVerifyContent(AbstractVerifier.ENABLE_VERIFY_CONTENT); } /** - * @param requestMethod null ? requestMethod = GET + * @param method null ? requestMethod = GET * @param needVerify 仅限于为服务端提供方法免验证特权，普通请求不要设置为 false ！ 如果对应Table有权限也建议用默认值 true，保持和客户端权限一致 */ public AbstractParser(RequestMethod method, boolean needVerify) { @@ -72,6 +147,67 @@ public AbstractParser(RequestMethod method, boolean needVerify) { setNeedVerify(needVerify); } + protected boolean isRoot = true; + public boolean isRoot() { + return isRoot; + } + public AbstractParser setRoot(boolean isRoot) { + this.isRoot = isRoot; + return this; + } + + public static final String KEY_REF = "Reference"; + + /**警告信息 + * Map<"Reference", "引用赋值获取路径 /Comment/userId 对应的值为 null！"> + */ + protected Map warnMap = new LinkedHashMap<>(); + public String getWarn(String type) { + return warnMap == null ? null : warnMap.get(type); + } + public AbstractParser putWarnIfNeed(String type, String warn) { + if (Log.DEBUG) { + String w = getWarn(type); + if (StringUtil.isEmpty(w, true)) { + putWarn(type, warn); + } + } + return this; + } + public AbstractParser putWarn(String type, String warn) { + if (warnMap == null) { + warnMap = new LinkedHashMap<>(); + } + warnMap.put(type, warn); + return this; + } + /**获取警告信息 + * @return + */ + public String getWarnString() { + Set> set = warnMap == null ? null : warnMap.entrySet(); + if (set == null || set.isEmpty()) { + return null; + } + + StringBuilder sb = new StringBuilder(); + for (Entry e : set) { + String k = e == null ? null : e.getKey(); + String v = k == null ? null : e.getValue(); + if (StringUtil.isEmpty(v, true)) { + continue; + } + + if (StringUtil.isNotEmpty(k, true)) { + sb.append("[" + k + "]: "); + } + sb.append(v + "; "); + } + + return sb.toString(); + } + + @NotNull protected Visitor visitor; @NotNull @@ -94,7 +230,7 @@ public List getContactIdList() { return visitor; } @Override - public AbstractParser setVisitor(@NotNull Visitor visitor) { + public AbstractParser setVisitor(@NotNull Visitor visitor) { this.visitor = visitor; return this; } @@ -107,7 +243,7 @@ public RequestMethod getMethod() { } @NotNull @Override - public AbstractParser setMethod(RequestMethod method) { + public AbstractParser setMethod(RequestMethod method) { this.requestMethod = method == null ? GET : method; this.transactionIsolation = RequestMethod.isQueryMethod(method) ? Connection.TRANSACTION_NONE : Connection.TRANSACTION_REPEATABLE_READ; return this; @@ -119,7 +255,7 @@ public int getVersion() { return version; } @Override - public AbstractParser setVersion(int version) { + public AbstractParser setVersion(int version) { this.version = version; return this; } @@ -130,79 +266,120 @@ public String getTag() { return tag; } @Override - public AbstractParser setTag(String tag) { + public AbstractParser setTag(String tag) { this.tag = tag; return this; } - protected JSONObject requestObject; + protected String requestURL; + public String getRequestURL() { + return requestURL; + } + public AbstractParser setRequestURL(String requestURL) { + this.requestURL = requestURL; + return this; + } + + protected M requestObject; @Override - public JSONObject getRequest() { + public M getRequest() { return requestObject; } @Override - public AbstractParser setRequest(JSONObject request) { + public AbstractParser setRequest(M request) { this.requestObject = request; return this; } - protected Boolean globleFormat; - public AbstractParser setGlobleFormat(Boolean globleFormat) { - this.globleFormat = globleFormat; + protected Boolean globalFormat; + public AbstractParser setGlobalFormat(Boolean globalFormat) { + this.globalFormat = globalFormat; return this; } @Override - public Boolean getGlobleFormat() { - return globleFormat; + public Boolean getGlobalFormat() { + return globalFormat; } - protected RequestRole globleRole; - public AbstractParser setGlobleRole(RequestRole globleRole) { - this.globleRole = globleRole; + protected String globalRole; + public AbstractParser setGlobalRole(String globalRole) { + this.globalRole = globalRole; return this; } @Override - public RequestRole getGlobleRole() { - return globleRole; + public String getGlobalRole() { + return globalRole; } - protected String globleDatabase; - public AbstractParser setGlobleDatabase(String globleDatabase) { - this.globleDatabase = globleDatabase; + protected String globalDatabase; + public AbstractParser setGlobalDatabase(String globalDatabase) { + this.globalDatabase = globalDatabase; return this; } @Override - public String getGlobleDatabase() { - return globleDatabase; + public String getGlobalDatabase() { + return globalDatabase; } - protected String globleSchema; - public AbstractParser setGlobleSchema(String globleSchema) { - this.globleSchema = globleSchema; + + protected String globalDatasource; + @Override + public String getGlobalDatasource() { + return globalDatasource; + } + public AbstractParser setGlobalDatasource(String globalDatasource) { + this.globalDatasource = globalDatasource; + return this; + } + + protected String globalNamespace; + public AbstractParser setGlobalNamespace(String globalNamespace) { + this.globalNamespace = globalNamespace; + return this; + } + @Override + public String getGlobalNamespace() { + return globalNamespace; + } + + protected String globalCatalog; + public AbstractParser setGlobalCatalog(String globalCatalog) { + this.globalCatalog = globalCatalog; + return this; + } + @Override + public String getGlobalCatalog() { + return globalCatalog; + } + + protected String globalSchema; + public AbstractParser setGlobalSchema(String globalSchema) { + this.globalSchema = globalSchema; return this; } @Override - public String getGlobleSchema() { - return globleSchema; + public String getGlobalSchema() { + return globalSchema; } - protected Boolean globleExplain; - public AbstractParser setGlobleExplain(Boolean globleExplain) { - this.globleExplain = globleExplain; + + protected Boolean globalExplain; + public AbstractParser setGlobalExplain(Boolean globalExplain) { + this.globalExplain = globalExplain; return this; } @Override - public Boolean getGlobleExplain() { - return globleExplain; + public Boolean getGlobalExplain() { + return globalExplain; } - protected String globleCache; - public AbstractParser setGlobleCache(String globleCache) { - this.globleCache = globleCache; + protected String globalCache; + public AbstractParser setGlobalCache(String globalCache) { + this.globalCache = globalCache; return this; } @Override - public String getGlobleCache() { - return globleCache; + public String getGlobalCache() { + return globalCache; } @Override - public AbstractParser setNeedVerify(boolean needVerify) { + public AbstractParser setNeedVerify(boolean needVerify) { setNeedVerifyLogin(needVerify); setNeedVerifyRole(needVerify); setNeedVerifyContent(needVerify); @@ -215,7 +392,7 @@ public boolean isNeedVerifyLogin() { return needVerifyLogin; } @Override - public AbstractParser setNeedVerifyLogin(boolean needVerifyLogin) { + public AbstractParser setNeedVerifyLogin(boolean needVerifyLogin) { this.needVerifyLogin = needVerifyLogin; return this; } @@ -225,7 +402,7 @@ public boolean isNeedVerifyRole() { return needVerifyRole; } @Override - public AbstractParser setNeedVerifyRole(boolean needVerifyRole) { + public AbstractParser setNeedVerifyRole(boolean needVerifyRole) { this.needVerifyRole = needVerifyRole; return this; } @@ -235,34 +412,47 @@ public boolean isNeedVerifyContent() { return needVerifyContent; } @Override - public AbstractParser setNeedVerifyContent(boolean needVerifyContent) { + public AbstractParser setNeedVerifyContent(boolean needVerifyContent) { this.needVerifyContent = needVerifyContent; return this; } - - - - - protected SQLExecutor sqlExecutor; - protected Verifier verifier; + protected SQLExecutor sqlExecutor; + protected Verifier verifier; protected Map queryResultMap;//path-result @Override - public SQLExecutor getSQLExecutor() { + public SQLExecutor getSQLExecutor() { if (sqlExecutor == null) { sqlExecutor = createSQLExecutor(); } + sqlExecutor.setParser(this); return sqlExecutor; } @Override - public Verifier getVerifier() { + public Verifier getVerifier() { if (verifier == null) { verifier = createVerifier().setVisitor(getVisitor()); } + verifier.setParser(this); return verifier; } + /**解析请求JSONObject + * @param request => URLDecoder.decode(request, UTF_8); + * @return + * @throws Exception + */ + public static > M parseRequest(String request) throws Exception { + try { + M req = JSON.parseObject(request); + Objects.requireNonNull(req); + return req; + } catch (Throwable e) { + throw new UnsupportedEncodingException("JSON格式不合法！" + e.getMessage() + "! " + request); + } + } + /**解析请求json并获取对应结果 * @param request * @return @@ -277,7 +467,7 @@ public String parse(String request) { */ @NotNull @Override - public String parse(JSONObject request) { + public String parse(M request) { return JSON.toJSONString(parseResponse(request)); } @@ -287,20 +477,24 @@ public String parse(JSONObject request) { */ @NotNull @Override - public JSONObject parseResponse(String request) { + public M parseResponse(String request) { Log.d(TAG, "\n\n\n\n<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<\n" + requestMethod + "/parseResponse request = \n" + request + "\n\n"); try { - requestObject = parseRequest(request); + requestObject = JSON.parseObject(request); + if (requestObject == null) { + throw new UnsupportedEncodingException("JSON格式不合法！"); + } } catch (Exception e) { - return newErrorResult(e); + return newErrorResult(e, isRoot); } return parseResponse(requestObject); } private int queryDepth; + private long executedSQLDuration; /**解析请求json并获取对应结果 * @param request @@ -308,12 +502,30 @@ public JSONObject parseResponse(String request) { */ @NotNull @Override - public JSONObject parseResponse(JSONObject request) { + public M parseResponse(M request) { long startTime = System.currentTimeMillis(); Log.d(TAG, "parseResponse startTime = " + startTime + "<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<\n\n\n "); requestObject = request; + try { + setGlobalFormat(getBoolean(requestObject, KEY_FORMAT)); + requestObject.remove(KEY_FORMAT); + } catch (Exception e) { + return extendErrorResult(requestObject, e, requestMethod, getRequestURL(), isRoot); + } + + try { + setVersion(getIntValue(requestObject, KEY_VERSION)); + requestObject.remove(KEY_VERSION); + + if (getMethod() != RequestMethod.CRUD) { + setTag(getString(requestObject, KEY_TAG)); + requestObject.remove(KEY_TAG); + } + } catch (Exception e) { + return extendErrorResult(requestObject, e, requestMethod, getRequestURL(), isRoot); + } verifier = createVerifier().setVisitor(getVisitor()); @@ -326,47 +538,54 @@ public JSONObject parseResponse(JSONObject request) { onVerifyContent(); } } catch (Exception e) { - return extendErrorResult(requestObject, e); + return extendErrorResult(requestObject, e, requestMethod, getRequestURL(), isRoot); } } //必须在parseCorrectRequest后面，因为parseCorrectRequest可能会添加 @role - if (isNeedVerifyRole() && globleRole == null) { + if (isNeedVerifyRole() && globalRole == null) { try { - setGlobleRole(RequestRole.get(requestObject.getString(JSONRequest.KEY_ROLE))); - requestObject.remove(JSONRequest.KEY_ROLE); + setGlobalRole(getString(requestObject, KEY_ROLE)); + requestObject.remove(KEY_ROLE); } catch (Exception e) { - return extendErrorResult(requestObject, e); + return extendErrorResult(requestObject, e, requestMethod, getRequestURL(), isRoot); } } try { - setGlobleFormat(requestObject.getBoolean(JSONRequest.KEY_FORMAT)); - setGlobleDatabase(requestObject.getString(JSONRequest.KEY_DATABASE)); - setGlobleSchema(requestObject.getString(JSONRequest.KEY_SCHEMA)); - setGlobleExplain(requestObject.getBoolean(JSONRequest.KEY_EXPLAIN)); - setGlobleCache(requestObject.getString(JSONRequest.KEY_CACHE)); - - requestObject.remove(JSONRequest.KEY_FORMAT); - requestObject.remove(JSONRequest.KEY_DATABASE); - requestObject.remove(JSONRequest.KEY_SCHEMA); - requestObject.remove(JSONRequest.KEY_EXPLAIN); - requestObject.remove(JSONRequest.KEY_CACHE); + setGlobalDatabase(getString(requestObject, KEY_DATABASE)); + setGlobalDatasource(getString(requestObject, KEY_DATASOURCE)); + setGlobalNamespace(getString(requestObject, KEY_NAMESPACE)); + setGlobalCatalog(getString(requestObject, KEY_CATALOG)); + setGlobalSchema(getString(requestObject, KEY_SCHEMA)); + + setGlobalExplain(getBoolean(requestObject, KEY_EXPLAIN)); + setGlobalCache(getString(requestObject, KEY_CACHE)); + + requestObject.remove(KEY_DATABASE); + requestObject.remove(KEY_DATASOURCE); + requestObject.remove(KEY_NAMESPACE); + requestObject.remove(KEY_CATALOG); + requestObject.remove(KEY_SCHEMA); + + requestObject.remove(KEY_EXPLAIN); + requestObject.remove(KEY_CACHE); } catch (Exception e) { - return extendErrorResult(requestObject, e); + return extendErrorResult(requestObject, e, requestMethod, getRequestURL(), isRoot); } final String requestString = JSON.toJSONString(request);//request传进去解析后已经变了 - queryResultMap = new HashMap(); Exception error = null; - sqlExecutor = createSQLExecutor(); + sqlExecutor = getSQLExecutor(); onBegin(); try { queryDepth = 0; - requestObject = onObjectParse(request, null, null, null, false); + executedSQLDuration = 0; + + requestObject = onObjectParse(request, null, null, null, false, null); onCommit(); } @@ -377,36 +596,68 @@ public JSONObject parseResponse(JSONObject request) { onRollback(); } - requestObject = error == null ? extendSuccessResult(requestObject) : extendErrorResult(requestObject, error); + String warn = Log.DEBUG == false || error != null ? null : getWarnString(); + + requestObject = error == null ? extendSuccessResult(requestObject, warn, isRoot) : extendErrorResult(requestObject, error, requestMethod, getRequestURL(), isRoot); + + // FIXME 暂时先直接移除，后续排查是在哪里 put 进来 + requestObject.remove(KEY_DATABASE); + requestObject.remove(KEY_DATASOURCE); + requestObject.remove(KEY_NAMESPACE); + requestObject.remove(KEY_CATALOG); + requestObject.remove(KEY_SCHEMA); - JSONObject res = (globleFormat != null && globleFormat) && JSONResponse.isSuccess(requestObject) ? new JSONResponse(requestObject) : requestObject; + M res = (globalFormat != null && globalFormat) && JSONResponse.isSuccess(requestObject) ? JSONResponse.format(requestObject) : requestObject; long endTime = System.currentTimeMillis(); long duration = endTime - startTime; - if (Log.DEBUG) { //用 | 替代 /，避免 APIJSON ORM，APIAuto 等解析路径错误 - requestObject.put("sql:generate|cache|execute|maxExecute", getSQLExecutor().getGeneratedSQLCount() + "|" + getSQLExecutor().getCachedSQLCount() + "|" + getSQLExecutor().getExecutedSQLCount() + "|" + getMaxSQLCount()); - requestObject.put("depth:count|max", queryDepth + "|" + getMaxQueryDepth()); - requestObject.put("time:start|duration|end", startTime + "|" + duration + "|" + endTime); + res.putIfAbsent("time", endTime); + if (Log.DEBUG) { + sqlExecutor = getSQLExecutor(); + res.put("sql:generate|cache|execute|maxExecute", sqlExecutor.getGeneratedSQLCount() + "|" + sqlExecutor.getCachedSQLCount() + "|" + sqlExecutor.getExecutedSQLCount() + "|" + getMaxSQLCount()); + res.put("depth:count|max", queryDepth + "|" + getMaxQueryDepth()); + + executedSQLDuration += sqlExecutor.getExecutedSQLDuration() + sqlExecutor.getSqlResultDuration(); + long parseDuration = duration - executedSQLDuration; + res.put("time:start|duration|end|parse|sql", startTime + "|" + duration + "|" + endTime + "|" + parseDuration + "|" + executedSQLDuration); + if (error != null) { - requestObject.put("throw", error.getClass().getName()); - requestObject.put("trace", error.getStackTrace()); + // String msg = error.getMessage(); + // if (msg != null && msg.contains(Log.KEY_SYSTEM_INFO_DIVIDER)) { + // } + Throwable t = error instanceof CommonException && error.getCause() != null ? error.getCause() : error; + res.put("trace:throw", t.getClass().getName()); + + if (IS_RETURN_STACK_TRACE) { + L list = JSON.createJSONArray(); + + StackTraceElement[] traces = t.getStackTrace(); + if (traces != null) { // && traces.length > 0) { + for (StackTraceElement trace : traces) { + list.add(trace == null ? null : trace.toString()); + } + } + + res.put("trace:stack", list); + } } } onClose(); - //会不会导致原来的session = null？ session = null; - - if (Log.DEBUG) { - Log.d(TAG, "\n\n\n\n<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<\n " - + requestMethod + "/parseResponse request = \n" + requestString + "\n\n"); - - Log.d(TAG, "parseResponse return response = \n" + JSON.toJSONString(requestObject) - + "\n >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>> \n\n\n"); + // CS304 Issue link: https://github.com/Tencent/APIJSON/issues/232 + if (IS_PRINT_REQUEST_STRING_LOG || Log.DEBUG || error != null) { + Log.sl("\n\n\n", '<', ""); + Log.fd(TAG, requestMethod + "/parseResponse request = \n" + requestString + "\n\n"); + } + if (IS_PRINT_BIG_LOG || Log.DEBUG || error != null) { // 日志仅存服务器，所以不太敏感，而且这些日志虽然量大但非常重要，对排查 bug 很关键 + Log.fd(TAG, requestMethod + "/parseResponse return response = \n" + JSON.toJSONString(requestObject) + "\n\n"); + } + if (IS_PRINT_REQUEST_ENDTIME_LOG || Log.DEBUG || error != null) { + Log.fd(TAG, requestMethod + "/parseResponse endTime = " + endTime + "; duration = " + duration); + Log.sl("", '>', "\n\n\n"); } - Log.d(TAG, "parseResponse endTime = " + endTime + "; duration = " + duration - + ">>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n\n\n"); return res; } @@ -426,17 +677,17 @@ public void onVerifyContent() throws Exception { * @throws Exception */ @Override - public void onVerifyRole(@NotNull SQLConfig config) throws Exception { + public void onVerifyRole(@NotNull SQLConfig config) throws Exception { if (Log.DEBUG) { Log.i(TAG, "onVerifyRole config = " + JSON.toJSONString(config)); } if (isNeedVerifyRole()) { if (config.getRole() == null) { - if (globleRole != null) { - config.setRole(globleRole); + if (globalRole != null) { + config.setRole(globalRole); } else { - config.setRole(getVisitor().getId() == null ? RequestRole.UNKNOWN : RequestRole.LOGIN); + config.setRole(getVisitor().getId() == null ? AbstractVerifier.UNKNOWN : AbstractVerifier.LOGIN); } } getVerifier().verifyAccess(config); @@ -445,227 +696,356 @@ public void onVerifyRole(@NotNull SQLConfig config) throws Exception { } - /**解析请求JSONObject - * @param request => URLDecoder.decode(request, UTF_8); - * @return - * @throws Exception - */ - @NotNull - public static JSONObject parseRequest(String request) throws Exception { - JSONObject obj = JSON.parseObject(request); - if (obj == null) { - throw new UnsupportedEncodingException("JSON格式不合法！"); - } - return obj; - } - @Override - public JSONObject parseCorrectRequest(RequestMethod method, String tag, int version, String name, @NotNull JSONObject request - , int maxUpdateCount, SQLCreator creator) throws Exception { - + public M parseCorrectRequest(RequestMethod method, String tag, int version, String name, @NotNull M request + , int maxUpdateCount, SQLCreator creator) throws Exception { + if (RequestMethod.isPublicMethod(method)) { return request;//需要指定JSON结构的get请求可以改为post请求。一般只有对安全性要求高的才会指定，而这种情况用明文的GET方式几乎肯定不安全 } - if (StringUtil.isEmpty(tag, true)) { - throw new IllegalArgumentException("请在最外层传 tag ！一般是 Table 名，例如 \"tag\": \"User\" "); - } + return batchVerify(method, tag, version, name, request, maxUpdateCount, creator); + } - //获取指定的JSON结构 <<<<<<<<<<<< - JSONObject object = null; - String error = ""; - try { - object = getStructure("Request", method.name(), tag, version); - } catch (Exception e) { - error = e.getMessage(); - } - if (object == null) { //empty表示随意操作 || object.isEmpty()) { - throw new UnsupportedOperationException("找不到 version: " + version + ", method: " + method.name() + ", tag: " + tag + " 对应的 structure ！" - + "非开放请求必须是后端 Request 表中校验规则允许的操作！\n " + error + "\n如果需要则在 Request 表中新增配置！"); + /**自动根据 tag 是否为 TableKey 及是否被包含在 object 内来决定是否包装一层，改为 { tag: object, "tag": tag } + * @param object + * @param tag + * @return + */ + public M wrapRequest(RequestMethod method, String tag, M object, boolean isStructure) { + boolean putTag = ! isStructure; + + if (object == null || object.containsKey(tag)) { //tag 是 Table 名或 Table[] + if (putTag) { + if (object == null) { + object = JSON.createJSONObject(); + } + object.put(KEY_TAG, tag); + } + return object; } - JSONObject target = object; - if (object.containsKey(tag) == false) { //tag 是 Table 名或 Table[] - - boolean isArrayKey = tag.endsWith(":[]"); // JSONRequest.isArrayKey(tag); - String key = isArrayKey ? tag.substring(0, tag.length() - 3) : tag; - - if (apijson.JSONObject.isTableKey(key)) { - if (isArrayKey) { //自动为 tag = Comment:[] 的 { ... } 新增键值对 "Comment[]":[] 为 { "Comment[]":[], ... } - target.put(key + "[]", new JSONArray()); + boolean isDiffArrayKey = tag.endsWith(":[]"); + boolean isArrayKey = isDiffArrayKey || isArrayKey(tag); + String key = isArrayKey ? tag.substring(0, tag.length() - (isDiffArrayKey ? 3 : 2)) : tag; + + M target = object; + if (isTableKey(key)) { + if (isDiffArrayKey) { //自动为 tag = Comment:[] 的 { ... } 新增键值对为 { "Comment[]":[], "TYPE": { "Comment[]": "OBJECT[]" } ... } + if (isStructure && (method == RequestMethod.POST || method == RequestMethod.PUT)) { + String arrKey = key + "[]"; + + if (target.containsKey(arrKey) == false) { + target.put(arrKey, JSON.createJSONArray()); + } + + try { + Map type = JSON.get(target, Operation.TYPE.name()); + if (type == null || (type.containsKey(arrKey) == false)) { + if (type == null) { + type = new LinkedHashMap(); + } + + type.put(arrKey, "OBJECT[]"); + target.put(Operation.TYPE.name(), type); + } + } + catch (Throwable e) { + Log.w(TAG, "wrapRequest try { Map type = target.getJSONObject(Operation.TYPE.name()); } catch (Exception e) = " + e.getMessage()); + } } - else { //自动为 tag = Comment 的 { ... } 包一层为 { "Comment": { ... } } - target = new JSONObject(true); + } + else { //自动为 tag = Comment 的 { ... } 包一层为 { "Comment": { ... } } + if (isArrayKey == false || RequestMethod.isGetMethod(method, true)) { + target = JSON.createJSONObject(); target.put(tag, object); } + else if (target.containsKey(key) == false) { + target = JSON.createJSONObject(); + target.put(key, object); + } } } - - //获取指定的JSON结构 >>>>>>>>>>>>>> - - //JSONObject clone 浅拷贝没用，Structure.parse 会导致 structure 里面被清空，第二次从缓存里取到的就是 {} - return getVerifier().verifyRequest(method, name, target, request, maxUpdateCount, getGlobleDatabase(), getGlobleSchema(), creator); + if (putTag) { + target.put(KEY_TAG, tag); + } + + return target; } - - + + /**新建带状态内容的JSONObject * @param code * @param msg * @return */ - public static JSONObject newResult(int code, String msg) { - return extendResult(null, code, msg); + public M newResult(int code, String msg) { + return newResult(code, msg, null); + } + + /** + * 添加JSONObject的状态内容，一般用于错误提示结果 + * + * @param code + * @param msg + * @param warn + * @return + */ + public M newResult(int code, String msg, String warn) { + return newResult(code, msg, warn, false); + } + + /** + * 新建带状态内容的JSONObject + * + * @param code + * @param msg + * @param warn + * @param isRoot + * @return + */ + public M newResult(int code, String msg, String warn, boolean isRoot) { + return extendResult(null, code, msg, warn, isRoot); } - /**添加JSONObject的状态内容，一般用于错误提示结果 + + /** + * 添加JSONObject的状态内容，一般用于错误提示结果 + * * @param object * @param code * @param msg * @return */ - public static JSONObject extendResult(JSONObject object, int code, String msg) { + public M extendResult(M object, int code, String msg, String warn, boolean isRoot) { + int index = Log.DEBUG == false || isRoot == false || msg == null ? -1 : msg.lastIndexOf(Log.KEY_SYSTEM_INFO_DIVIDER); + String debug = Log.DEBUG == false || isRoot == false ? null : (index >= 0 ? msg.substring(index + Log.KEY_SYSTEM_INFO_DIVIDER.length()).trim() + : " \n提 bug 请发请求和响应的【完整截屏】，没图的自行解决！" + + " \n开发者有限的时间和精力主要放在【维护项目源码和文档】上！" + + " \n【描述不详细】 或 【文档/常见问题 已有答案】 的问题可能会被忽略！！" + + " \n【态度 不文明/不友善】的可能会被踢出群，问题也可能不予解答！！！" + + " \n\n **环境信息** " + + " \n系统: " + Log.OS_NAME + " " + Log.OS_VERSION + + " \n数据库: DEFAULT_DATABASE = " + AbstractSQLConfig.DEFAULT_DATABASE + + " \nJDK: " + Log.JAVA_VERSION + " " + Log.OS_ARCH + + " \nAPIJSON: " + Log.VERSION + + " \n \n【常见问题】：https://github.com/Tencent/APIJSON/issues/36" + + " \n【通用文档】：https://github.com/Tencent/APIJSON/blob/master/Document.md" + + " \n【视频教程】：https://search.bilibili.com/all?keyword=APIJSON"); + + msg = index >= 0 ? msg.substring(0, index) : msg; + if (object == null) { - object = new JSONObject(true); + object = JSON.createJSONObject(); } - if (object.containsKey(JSONResponse.KEY_OK) == false) { + + if (object.get(JSONResponse.KEY_OK) == null) { object.put(JSONResponse.KEY_OK, JSONResponse.isSuccess(code)); } - if (object.containsKey(JSONResponse.KEY_CODE) == false) { + if (object.get(JSONResponse.KEY_CODE) == null) { object.put(JSONResponse.KEY_CODE, code); } - - String m = StringUtil.getString(object.getString(JSONResponse.KEY_MSG)); + + String m = StringUtil.get(getString(object, JSONResponse.KEY_MSG)); if (m.isEmpty() == false) { - msg = m + " ;\n " + StringUtil.getString(msg); + msg = m + " ;\n " + StringUtil.get(msg); } + object.put(JSONResponse.KEY_MSG, msg); + if (debug != null) { + if (StringUtil.isNotEmpty(warn, true)) { + debug += "\n 【警告】：" + warn; + } + object.put("debug:info|help", debug); + } + return object; } - /**添加请求成功的状态内容 + /** + * 添加请求成功的状态内容 + * * @param object * @return */ - public static JSONObject extendSuccessResult(JSONObject object) { - return extendResult(object, JSONResponse.CODE_SUCCESS, JSONResponse.MSG_SUCCEED); + public M extendSuccessResult(M object) { + return extendSuccessResult(object, false); } - /**获取请求成功的状态内容 - * @return - */ - public static JSONObject newSuccessResult() { - return newResult(JSONResponse.CODE_SUCCESS, JSONResponse.MSG_SUCCEED); + + public M extendSuccessResult(M object, boolean isRoot) { + return extendSuccessResult(object, null, isRoot); } + /**添加请求成功的状态内容 * @param object + * @param isRoot * @return */ - public static JSONObject extendErrorResult(JSONObject object, Exception e) { - JSONObject error = newErrorResult(e); - return extendResult(object, error.getIntValue(JSONResponse.KEY_CODE), error.getString(JSONResponse.KEY_MSG)); + public M extendSuccessResult(M object, String warn, boolean isRoot) { + return extendResult(object, JSONResponse.CODE_SUCCESS, JSONResponse.MSG_SUCCEED, warn, isRoot); } - /**新建错误状态内容 - * @param e + + /**获取请求成功的状态内容 * @return */ - public static JSONObject newErrorResult(Exception e) { - if (e != null) { - e.printStackTrace(); - - int code; - if (e instanceof UnsupportedEncodingException) { - code = JSONResponse.CODE_UNSUPPORTED_ENCODING; - } - else if (e instanceof IllegalAccessException) { - code = JSONResponse.CODE_ILLEGAL_ACCESS; - } - else if (e instanceof UnsupportedOperationException) { - code = JSONResponse.CODE_UNSUPPORTED_OPERATION; - } - else if (e instanceof NotExistException) { - code = JSONResponse.CODE_NOT_FOUND; - } - else if (e instanceof IllegalArgumentException) { - code = JSONResponse.CODE_ILLEGAL_ARGUMENT; - } - else if (e instanceof NotLoggedInException) { - code = JSONResponse.CODE_NOT_LOGGED_IN; - } - else if (e instanceof TimeoutException) { - code = JSONResponse.CODE_TIME_OUT; - } - else if (e instanceof ConflictException) { - code = JSONResponse.CODE_CONFLICT; - } - else if (e instanceof ConditionErrorException) { - code = JSONResponse.CODE_CONDITION_ERROR; - } - else if (e instanceof UnsupportedDataTypeException) { - code = JSONResponse.CODE_UNSUPPORTED_TYPE; - } - else if (e instanceof OutOfRangeException) { - code = JSONResponse.CODE_OUT_OF_RANGE; - } - else if (e instanceof NullPointerException) { - code = JSONResponse.CODE_NULL_POINTER; - } - else { - code = JSONResponse.CODE_SERVER_ERROR; - } - - return newResult(code, e.getMessage()); - } - - return newResult(JSONResponse.CODE_SERVER_ERROR, JSONResponse.MSG_SERVER_ERROR); + public M newSuccessResult() { + return newSuccessResult(null); } - - - - //TODO 启动时一次性加载Request所有内容，作为初始化。 - /**获取正确的请求，非GET请求必须是服务器指定的 - * @param method - * @param request + /**获取请求成功的状态内容 + * @param warn * @return - * @throws Exception */ - @Override - public JSONObject parseCorrectRequest() throws Exception { - setTag(requestObject.getString(JSONRequest.KEY_TAG)); - setVersion(requestObject.getIntValue(JSONRequest.KEY_VERSION)); - requestObject.remove(JSONRequest.KEY_TAG); - requestObject.remove(JSONRequest.KEY_VERSION); - return parseCorrectRequest(requestMethod, tag, version, "", requestObject, getMaxUpdateCount(), this); + public M newSuccessResult(String warn) { + return newSuccessResult(warn, false); } - - //TODO 优化性能！ - /**获取正确的返回结果 - * @param method - * @param response + /**获取请求成功的状态内容 + * @param warn + * @param isRoot * @return - * @throws Exception */ - @Override - public JSONObject parseCorrectResponse(String table, JSONObject response) throws Exception { - // Log.d(TAG, "getCorrectResponse method = " + method + "; table = " + table); - // if (response == null || response.isEmpty()) {//避免无效空result:{}添加内容后变有效 - // Log.e(TAG, "getCorrectResponse response == null || response.isEmpty() >> return response;"); - return response; - // } - // - // JSONObject target = apijson.JSONObject.isTableKey(table) == false - // ? new JSONObject() : getStructure(method, "Response", "model", table); - // - // return MethodStructure.parseResponse(method, table, target, response, new OnParseCallback() { - // - // @Override - // protected JSONObject onParseJSONObject(String key, JSONObject tobj, JSONObject robj) throws Exception { - // return getCorrectResponse(method, key, robj); - // } - // }); + public M newSuccessResult(String warn, boolean isRoot) { + return newResult(JSONResponse.CODE_SUCCESS, JSONResponse.MSG_SUCCEED, warn, isRoot); } + /**添加请求成功的状态内容 + * @param object + * @param e + * @return + */ + public M extendErrorResult(M object, Throwable e) { + return extendErrorResult(object, e, false); + } + /**添加请求成功的状态内容 + * @param object + * @param e + * @param isRoot + * @return + */ + public M extendErrorResult(M object, Throwable e, boolean isRoot) { + return extendErrorResult(object, e, null, null, isRoot); + } + /**添加请求成功的状态内容 + * @param object + * @return + */ + public M extendErrorResult(M object, Throwable e, RequestMethod requestMethod, String url, boolean isRoot) { + String msg = CommonException.getMsg(e); + + if (Log.DEBUG && isRoot) { + try { + boolean isCommon = e instanceof CommonException; + String env = isCommon ? ((CommonException) e).getEnvironment() : null; + if (StringUtil.isEmpty(env)) { + //int index = msg.lastIndexOf(Log.KEY_SYSTEM_INFO_DIVIDER); + //env = index >= 0 ? msg.substring(index + Log.KEY_SYSTEM_INFO_DIVIDER.length()).trim() + env = " \n **环境信息** " + + " \n 系统: " + Log.OS_NAME + " " + Log.OS_VERSION + + " \n 数据库: " + + " \n JDK: " + Log.JAVA_VERSION + " " + Log.OS_ARCH + + " \n APIJSON: " + Log.VERSION; + + //msg = index < 0 ? msg : msg.substring(0, index).trim(); + } + + String encodedMsg = URLEncoder.encode(msg, "UTF-8"); + + if (StringUtil.isEmpty(url, true)) { + String host = "localhost"; + try { + host = InetAddress.getLocalHost().getHostAddress(); + } catch (Throwable e2) {} + + String port = "8080"; + try { + MBeanServer beanServer = ManagementFactory.getPlatformMBeanServer(); + + Set objectNames = beanServer.queryNames( + new ObjectName("*:type=Connector,*"), + Query.match(Query.attr("protocol"), Query.value("HTTP/1.1")) + ); + String p = objectNames.iterator().next().getKeyProperty("port"); + port = StringUtil.isEmpty(p, true) ? port : p; + } catch (Throwable e2) {} + + url = "http://" + host + ":" + port + "/" + (requestMethod == null ? RequestMethod.GET : requestMethod).name().toLowerCase(); + } + + String req = JSON.toJSONString(object); + try { + req = URLEncoder.encode(req, "UTF-8"); + } catch (Throwable e2) {} + + Throwable t = isCommon ? e.getCause() : e; + boolean isSQLException = t instanceof SQLException; // SQL 报错一般都是通用问题，优先搜索引擎 + String apiatuoAndGitHubLink = "\n\n【APIAuto】： \n http://apijson.cn/api?type=JSON&url=" + URLEncoder.encode(url, "UTF-8") + "&json=" + req + + " \n\n【GitHub】： \n https://www.google.com/search?q=site%3Agithub.com%2FTencent%2FAPIJSON+++" + encodedMsg; + + msg += Log.KEY_SYSTEM_INFO_DIVIDER + " 浏览器打开以下链接查看解答" + + (isSQLException ? "" : apiatuoAndGitHubLink) + // GitHub Issue 搜索貌似是精准包含，不易找到答案 + " \n\nGitHub： \n https://github.com/Tencent/APIJSON/issues?q=is%3Aissue+" + encodedMsg + + " \n\n【Google】：\n https://www.google.com/search?q=" + encodedMsg + + " \n\n【百度】：\n https://www.baidu.com/s?ie=UTF-8&wd=" + encodedMsg + + (isSQLException ? apiatuoAndGitHubLink : "") + + " \n\n都没找到答案？打开这个链接 \n https://github.com/Tencent/APIJSON/issues/new?assignees=&labels=&template=--bug.md " + + " \n然后提交问题，推荐用以下模板修改，注意要换行保持清晰可读。" + + " \n【标题】：" + msg + + " \n【内容】：" + env + "\n\n**问题描述**\n" + msg + + " \n\n" + + " \n\nPOST " + url + + " \n发送请求 Request JSON：\n ```js" + + " \n 请填写，例如 { \"Users\":{} }" + + " \n```" + + " \n\n返回结果 Response JSON：\n ```js" + + " \n 请填写，例如 { \"Users\": {}, \"code\": 401, \"msg\": \"Users 不允许 UNKNOWN 用户的 GET 请求！\" }" + + " \n```"; + } catch (Throwable e2) {} + } + + int code = CommonException.getCode(e); + return extendResult(object, code, msg, null, isRoot); + } + + /**新建错误状态内容 + * @param e + * @return + */ + public M newErrorResult(Exception e) { + return newErrorResult(e, false); + } + /**新建错误状态内容 + * @param e + * @param isRoot + * @return + */ + public M newErrorResult(Exception e, boolean isRoot) { + if (e != null) { + // if (Log.DEBUG) { + e.printStackTrace(); + // } + + String msg = CommonException.getMsg(e); + int code = CommonException.getCode(e); + + return newResult(code, msg, null, isRoot); + } + + return newResult(JSONResponse.CODE_SERVER_ERROR, JSONResponse.MSG_SERVER_ERROR, null, isRoot); + } + + + /**获取正确的请求，非GET请求必须是服务器指定的 + * @return + * @throws Exception + */ + @Override + public M parseCorrectRequest() throws Exception { + return parseCorrectRequest(requestMethod, tag, version, "", requestObject, getMaxUpdateCount(), this); + } + + /**获取Request或Response内指定JSON结构 * @param table * @param method @@ -675,19 +1055,18 @@ public JSONObject parseCorrectResponse(String table, JSONObject response) throws * @throws Exception */ @Override - public JSONObject getStructure(@NotNull String table, String method, String tag, int version) throws Exception { - // TODO 目前只使用 Request 而不使用 Response，所以这里写死用 REQUEST_MAP，以后可能 Response 表也会与 Request 表合并，用字段来区分 + public M getStructure(@NotNull String table, String method, String tag, int version) throws Exception { String cacheKey = AbstractVerifier.getCacheKeyForRequest(method, tag); - SortedMap versionedMap = AbstractVerifier.REQUEST_MAP.get(cacheKey); - - JSONObject result = versionedMap == null ? null : versionedMap.get(Integer.valueOf(version)); + SortedMap> versionedMap = (SortedMap>) AbstractVerifier.REQUEST_MAP.get(cacheKey); + + Map result = versionedMap == null ? null : versionedMap.get(Integer.valueOf(version)); if (result == null) { // version <= 0 时使用最新，version > 0 时使用 > version 的最接近版本（最小版本） - Set> set = versionedMap == null ? null : versionedMap.entrySet(); - + Set>> set = versionedMap == null ? null : versionedMap.entrySet(); + if (set != null && set.isEmpty() == false) { - Entry maxEntry = null; - - for (Entry entry : set) { + Entry> maxEntry = null; + + for (Entry> entry : set) { if (entry == null || entry.getKey() == null || entry.getValue() == null) { continue; } @@ -700,71 +1079,76 @@ public JSONObject getStructure(@NotNull String table, String method, String tag, if (entry.getKey() < version) { break; } - + maxEntry = entry; } - + result = maxEntry == null ? null : maxEntry.getValue(); } - + if (result != null) { // 加快下次查询，查到值的话组合情况其实是有限的，不属于恶意请求 if (versionedMap == null) { versionedMap = new TreeMap<>((o1, o2) -> { return o2 == null ? -1 : o2.compareTo(o1); // 降序 }); } - + versionedMap.put(Integer.valueOf(version), result); AbstractVerifier.REQUEST_MAP.put(cacheKey, versionedMap); } } - + if (result == null) { - if (AbstractVerifier.REQUEST_MAP.isEmpty() == false) { + if (Log.DEBUG == false && AbstractVerifier.REQUEST_MAP.isEmpty() == false) { return null; // 已使用 REQUEST_MAP 缓存全部，但没查到 } - - //获取指定的JSON结构 <<<<<<<<<<<<<< - SQLConfig config = createSQLConfig().setMethod(GET).setTable(table); + + // 获取指定的JSON结构 <<<<<<<<<<<<<< + SQLConfig config = createSQLConfig().setMethod(GET).setTable(table); + config.setParser(this); config.setPrepared(false); config.setColumn(Arrays.asList("structure")); Map where = new HashMap(); where.put("method", method); - where.put(JSONRequest.KEY_TAG, tag); - + where.put(KEY_TAG, tag); + if (version > 0) { - where.put(JSONRequest.KEY_VERSION + "{}", ">=" + version); + where.put(KEY_VERSION + ">=", version); } config.setWhere(where); - config.setOrder(JSONRequest.KEY_VERSION + (version > 0 ? "+" : "-")); + config.setOrder(KEY_VERSION + (version > 0 ? "+" : "-")); config.setCount(1); - //too many connections error: 不try-catch，可以让客户端看到是服务器内部异常 + // too many connections error: 不try-catch，可以让客户端看到是服务器内部异常 result = getSQLExecutor().execute(config, false); - + // version, method, tag 组合情况太多了，JDK 里又没有 LRUCache，所以要么启动时一次性缓存全部后面只用缓存，要么每次都查数据库 // versionedMap.put(Integer.valueOf(version), result); // AbstractVerifier.REQUEST_MAP.put(cacheKey, versionedMap); } - - return getJSONObject(result, "structure"); //解决返回值套了一层 "structure":{} + + return JSON.get(result, "structure"); //解决返回值套了一层 "structure":{} } - // protected SQLConfig itemConfig; + protected Map> arrayObjectParserCacheMap = new HashMap<>(); + + // protected SQLConfig itemConfig; /**获取单个对象，该对象处于parentObject内 - * @param parentPath parentObject的路径 - * @param name parentObject的key - * @param request parentObject的value - * @param config for array item + * @param request parentObject 的 value + * @param parentPath parentObject 的路径 + * @param name parentObject 的 key + * @param arrayConfig config for array item + * @param isSubquery 是否为子查询 + * @param cache SQL 结果缓存 * @return - * @throws Exception + * @throws Exception */ @Override - public JSONObject onObjectParse(final JSONObject request - , String parentPath, String name, final SQLConfig arrayConfig, boolean isSubquery) throws Exception { + public M onObjectParse(final M request, String parentPath, String name + , final SQLConfig arrayConfig, boolean isSubquery, M cache) throws Exception { if (Log.DEBUG) { Log.i(TAG, "\ngetObject: parentPath = " + parentPath @@ -775,9 +1159,10 @@ public JSONObject onObjectParse(final JSONObject request } int type = arrayConfig == null ? 0 : arrayConfig.getType(); + int position = arrayConfig == null ? 0 : arrayConfig.getPosition(); String[] arr = StringUtil.split(parentPath, "/"); - if (arrayConfig == null || arrayConfig.getPosition() == 0) { + if (position == 0) { int d = arr == null ? 1 : arr.length + 1; if (queryDepth < d) { queryDepth = d; @@ -788,29 +1173,79 @@ public JSONObject onObjectParse(final JSONObject request } } - ObjectParser op = createObjectParser(request, parentPath, name, arrayConfig, isSubquery).parse(); + apijson.orm.Entry entry = Pair.parseEntry(name, true); + String table = entry.getKey(); //Comment + // String alias = entry.getValue(); //to + + boolean isTable = isTableKey(table); + boolean isArrayMainTable = isSubquery == false && isTable && type == SQLConfig.TYPE_ITEM_CHILD_0 && arrayConfig != null && RequestMethod.isGetMethod(arrayConfig.getMethod(), true); + boolean isReuse = isArrayMainTable && position > 0; + + ObjectParser op = null; + if (isReuse) { // 数组主表使用专门的缓存数据 + op = arrayObjectParserCacheMap.get(parentPath.substring(0, parentPath.lastIndexOf("[]") + 2)); + op.setParentPath(parentPath); + } + + if (op == null) { + op = createObjectParser(request, parentPath, arrayConfig, isSubquery, isTable, isArrayMainTable); + } + // 对象 - 设置 method + setOpMethod(request, op, name); + + op.setCache(cache); + op = op.parse(name, isReuse); + M response = null; + if (op != null) {//SQL查询结果为空时，functionMap和customMap没有意义 - JSONObject response = null; - if (op != null) {//TODO SQL查询结果为空时，functionMap和customMap还有没有意义？ - if (arrayConfig == null) {//Common + if (arrayConfig == null) { //Common response = op.setSQLConfig().executeSQL().response(); } else {//Array Item Child int query = arrayConfig.getQuery(); //total 这里不能用arrayConfig.getType()，因为在createObjectParser.onChildParse传到onObjectParse时已被改掉 - if (type == SQLConfig.TYPE_ITEM_CHILD_0 && query != JSONRequest.QUERY_TABLE - && arrayConfig.getPosition() == 0) { - JSONObject rp = op.setMethod(RequestMethod.HEAD).setSQLConfig().executeSQL().getSqlReponse(); + if (type == SQLConfig.TYPE_ITEM_CHILD_0 && query != apijson.JSONRequest.QUERY_TABLE && position == 0) { + + //TODO 应在这里判断 @column 中是否有聚合函数，而不是 AbstractSQLConfig.getColumnString + + Map rp; + Boolean compat = arrayConfig.getCompat(); + if (compat != null && compat) { + // 解决对聚合函数字段通过 query:2 分页查总数返回值错误 + // 这里可能改变了内部的一些数据，下方通过 arrayConfig 还原 + SQLConfig cfg = op.setSQLConfig(0, 0, 0).getSQLConfig(); + boolean isExplain = cfg.isExplain(); + cfg.setExplain(false); + + Subquery subqy = new Subquery(); + subqy.setFrom(cfg.getTable()); + subqy.setConfig(cfg); + + SQLConfig countSQLCfg = createSQLConfig(); + countSQLCfg.setColumn(Arrays.asList("count(*):count")); + countSQLCfg.setFrom(subqy); + + rp = executeSQL(countSQLCfg, false); + + cfg.setExplain(isExplain); + } + else { + // 对聚合函数字段通过 query:2 分页查总数返回值错误 + RequestMethod method = op.getMethod(); + rp = op.setMethod(RequestMethod.HEAD).setSQLConfig().executeSQL().getSQLResponse(); + op.setMethod(method); + } + if (rp != null) { int index = parentPath.lastIndexOf("]/"); if (index >= 0) { - int total = rp.getIntValue(JSONResponse.KEY_COUNT); - + int total = getIntValue(rp, JSONResponse.KEY_COUNT); + String pathPrefix = parentPath.substring(0, index) + "]/"; putQueryResult(pathPrefix + JSONResponse.KEY_TOTAL, total); - + //详细的分页信息，主要为 PC 端提供 int count = arrayConfig.getCount(); int page = arrayConfig.getPage(); @@ -818,19 +1253,29 @@ public JSONObject onObjectParse(final JSONObject request if (max < 0) { max = 0; } - - JSONObject pagination = new JSONObject(true); + int min = getMinQueryPage(); + + page += min; + max += min; + + M pagination = JSON.createJSONObject(); + Object explain = rp.get(JSONResponse.KEY_EXPLAIN); + if (explain instanceof Map) { + pagination.put(JSONResponse.KEY_EXPLAIN, explain); + } + pagination.put(JSONResponse.KEY_TOTAL, total); - pagination.put(JSONRequest.KEY_COUNT, count); - pagination.put(JSONRequest.KEY_PAGE, page); + pagination.put(apijson.JSONRequest.KEY_COUNT, count); + pagination.put(apijson.JSONRequest.KEY_PAGE, page); pagination.put(JSONResponse.KEY_MAX, max); pagination.put(JSONResponse.KEY_MORE, page < max); - pagination.put(JSONResponse.KEY_FIRST, page == 0); + pagination.put(JSONResponse.KEY_FIRST, page == min); pagination.put(JSONResponse.KEY_LAST, page == max); + putQueryResult(pathPrefix + JSONResponse.KEY_INFO, pagination); - if (total <= count*page) { - query = JSONRequest.QUERY_TOTAL;//数量不够了，不再往后查询 + if (total <= count*(page - min)) { + query = apijson.JSONRequest.QUERY_TOTAL;//数量不够了，不再往后查询 } } } @@ -839,18 +1284,25 @@ public JSONObject onObjectParse(final JSONObject request } //Table - if (query == JSONRequest.QUERY_TOTAL) { + if (query == apijson.JSONRequest.QUERY_TOTAL) { response = null;//不再往后查询 } else { response = op - .setSQLConfig(arrayConfig.getCount(), arrayConfig.getPage(), arrayConfig.getPosition()) + .setSQLConfig(arrayConfig.getCount(), arrayConfig.getPage(), position) .executeSQL() .response(); // itemConfig = op.getConfig(); } } - op.recycle(); + if (isArrayMainTable) { + if (position == 0) { // 提取并缓存数组主表的列表数据 + arrayObjectParserCacheMap.put(parentPath.substring(0, parentPath.lastIndexOf("[]") + 2), op); + } + } + // else { + // op.recycle(); + // } op = null; } @@ -858,61 +1310,68 @@ public JSONObject onObjectParse(final JSONObject request } /**获取对象数组，该对象数组处于parentObject内 + * @param request parentObject的value * @param parentPath parentObject的路径 * @param name parentObject的key - * @param request parentObject的value - * @return + * @param isSubquery 是否为子查询 + * @param cache SQL 结果缓存 + * @return * @throws Exception */ @Override - public JSONArray onArrayParse(JSONObject request, String parentPath, String name, boolean isSubquery) throws Exception { + public L onArrayParse(M request, String parentPath, String name, boolean isSubquery, L cache) throws Exception { if (Log.DEBUG) { Log.i(TAG, "\n\n\n onArrayParse parentPath = " + parentPath + "; name = " + name + "; request = " + JSON.toJSONString(request)); } //不能允许GETS，否则会被通过"[]":{"@role":"ADMIN"},"Table":{},"tag":"Table"绕过权限并能批量查询 - if (isSubquery == false && RequestMethod.isGetMethod(requestMethod, false) == false) { - throw new UnsupportedOperationException("key[]:{}只支持GET方法！不允许传 " + name + ":{} ！"); + RequestMethod _method = request.get(KEY_METHOD) == null ? requestMethod : RequestMethod.valueOf(getString(request, KEY_METHOD)); + if (isSubquery == false && RequestMethod.isGetMethod(_method, true) == false) { + throw new UnsupportedOperationException("key[]:{} 只支持 GET, GETS 方法！其它方法不允许传 " + name + ":{} 等这种 key[]:{} 格式！"); } - if (request == null || request.isEmpty()) {//jsonKey-jsonValue条件 + if (request == null || request.isEmpty()) { // jsonKey-jsonValue 条件 return null; } String path = getAbsPath(parentPath, name); //不能改变，因为后面可能继续用到，导致1以上都改变 []:{0:{Comment[]:{0:{Comment:{}},1:{...},...}},1:{...},...} - final String query = request.getString(JSONRequest.KEY_QUERY); - final Integer count = request.getInteger(JSONRequest.KEY_COUNT); //TODO 如果不想用默认数量可以改成 getIntValue(JSONRequest.KEY_COUNT); - final int page = request.getIntValue(JSONRequest.KEY_PAGE); - final Object join = request.get(JSONRequest.KEY_JOIN); + final String query = getString(request, apijson.JSONRequest.KEY_QUERY); + final Boolean compat = getBoolean(request, apijson.JSONRequest.KEY_COMPAT); + final Integer count = getInteger(request, apijson.JSONRequest.KEY_COUNT); //TODO 如果不想用默认数量可以改成 getIntValue(apijson.JSONRequest.KEY_COUNT); + final Integer page = getInteger(request, apijson.JSONRequest.KEY_PAGE); + final Object join = request.get(apijson.JSONRequest.KEY_JOIN); int query2; if (query == null) { - query2 = JSONRequest.QUERY_TABLE; + query2 = apijson.JSONRequest.QUERY_TABLE; } else { switch (query) { case "0": - case JSONRequest.QUERY_TABLE_STRING: - query2 = JSONRequest.QUERY_TABLE; + case apijson.JSONRequest.QUERY_TABLE_STRING: + query2 = apijson.JSONRequest.QUERY_TABLE; break; case "1": - case JSONRequest.QUERY_TOTAL_STRING: - query2 = JSONRequest.QUERY_TOTAL; + case apijson.JSONRequest.QUERY_TOTAL_STRING: + query2 = apijson.JSONRequest.QUERY_TOTAL; break; case "2": - case JSONRequest.QUERY_ALL_STRING: - query2 = JSONRequest.QUERY_ALL; + case apijson.JSONRequest.QUERY_ALL_STRING: + query2 = apijson.JSONRequest.QUERY_ALL; break; default: - throw new IllegalArgumentException(path + "/" + JSONRequest.KEY_QUERY + ":value 中 value 的值不合法！必须在 [0,1,2] 或 [TABLE, TOTAL, ALL] 内 !"); + throw new IllegalArgumentException(path + "/" + apijson.JSONRequest.KEY_QUERY + ":value 中 value 的值不合法！必须在 [0, 1, 2] 或 [TABLE, TOTAL, ALL] 内 !"); } } + int minPage = getMinQueryPage(); // 兼容各种传 0 或 null/undefined 自动转 0 导致的问题 + int page2 = page == null || page == 0 ? 0 : page - minPage; + int maxPage = getMaxQueryPage(); - if (page < 0 || page > maxPage) { - throw new IllegalArgumentException(path + "/" + JSONRequest.KEY_PAGE + ":value 中 value 的值不合法！必须在 0-" + maxPage + " 内 !"); + if (page2 < 0 || page2 > maxPage) { + throw new IllegalArgumentException(path + "/" + apijson.JSONRequest.KEY_PAGE + ":value 中 value 的值不合法！必须在 " + minPage + "-" + maxPage + " 内 !"); } //不用total限制数量了，只用中断机制，total只在query = 1,2的时候才获取 @@ -920,60 +1379,97 @@ public JSONArray onArrayParse(JSONObject request, String parentPath, String name int max = isSubquery ? count2 : getMaxQueryCount(); if (count2 < 0 || count2 > max) { - throw new IllegalArgumentException(path + "/" + JSONRequest.KEY_COUNT + ":value 中 value 的值不合法！必须在 0-" + max + " 内 !"); + throw new IllegalArgumentException(path + "/" + apijson.JSONRequest.KEY_COUNT + ":value 中 value 的值不合法！必须在 0-" + max + " 内 !"); } - request.remove(JSONRequest.KEY_QUERY); - request.remove(JSONRequest.KEY_COUNT); - request.remove(JSONRequest.KEY_PAGE); - request.remove(JSONRequest.KEY_JOIN); + request.remove(apijson.JSONRequest.KEY_QUERY); + request.remove(apijson.JSONRequest.KEY_COMPAT); + request.remove(apijson.JSONRequest.KEY_COUNT); + request.remove(apijson.JSONRequest.KEY_PAGE); + request.remove(apijson.JSONRequest.KEY_JOIN); Log.d(TAG, "onArrayParse query = " + query + "; count = " + count + "; page = " + page + "; join = " + join); - if (request.isEmpty()) {//如果条件成立，说明所有的 parentPath/name:request 中request都无效！！！ + if (request.isEmpty()) { // 如果条件成立，说明所有的 parentPath/name:request 中request都无效！！！ 后续都不执行，没必要还原数组关键词浪费性能 Log.e(TAG, "onArrayParse request.isEmpty() >> return null;"); return null; } + L response = null; + try { + int size = count2 == 0 ? max : count2; //count为每页数量，size为第page页实际数量，max(size) = count + Log.d(TAG, "onArrayParse size = " + size + "; page = " + page2); - int size = count2 == 0 ? max : count2;//count为每页数量，size为第page页实际数量，max(size) = count - Log.d(TAG, "onArrayParse size = " + size + "; page = " + page); + //key[]:{Table:{}}中key equals Table时 提取Table + int index = isSubquery || name == null ? -1 : name.lastIndexOf("[]"); + String childPath = index <= 0 ? null : Pair.parseEntry(name.substring(0, index), true).getKey(); // Table-key1-key2... + + String arrTableKey = null; + //判断第一个key，即Table是否存在，如果存在就提取 + String[] childKeys = StringUtil.split(childPath, "-", false); + if (childKeys == null || childKeys.length <= 0 || request.containsKey(childKeys[0]) == false) { + childKeys = null; + } + else if (childKeys.length == 1 && isTableKey(childKeys[0])) { // 可能无需提取，直接返回 rawList 即可 + arrTableKey = childKeys[0]; + } - //key[]:{Table:{}}中key equals Table时 提取Table - int index = isSubquery || name == null ? -1 : name.lastIndexOf("[]"); - String childPath = index <= 0 ? null : Pair.parseEntry(name.substring(0, index), true).getKey(); // Table-key1-key2... - //判断第一个key，即Table是否存在，如果存在就提取 - String[] childKeys = StringUtil.split(childPath, "-", false); - if (childKeys == null || childKeys.length <= 0 || request.containsKey(childKeys[0]) == false) { - childKeys = null; - } + //Table<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< + List> joinList = onJoinParse(join, request); + SQLConfig config = createSQLConfig() + .setMethod(requestMethod) + .setCount(size) + .setPage(page2) + .setQuery(query2) + .setCompat(compat) + .setTable(arrTableKey) + .setJoinList(joinList); - //Table<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< - JSONArray response = new JSONArray(); - SQLConfig config = createSQLConfig() - .setMethod(requestMethod) - .setCount(size) - .setPage(page) - .setQuery(query2) - .setJoinList(onJoinParse(join, request)); + Map parent; - JSONObject parent; - //生成size个 - for (int i = 0; i < (isSubquery ? 1 : size); i++) { - parent = onObjectParse(request, isSubquery ? parentPath : path, isSubquery ? name : "" + i, config.setType(SQLConfig.TYPE_ITEM).setPosition(i), isSubquery); - if (parent == null || parent.isEmpty()) { - break; + boolean isExtract = true; + + response = JSON.createJSONArray(); + //生成size个 + for (int i = 0; i < (isSubquery ? 1 : size); i++) { + parent = onObjectParse(request, isSubquery ? parentPath : path, isSubquery ? name : "" + i, config.setType(SQLConfig.TYPE_ITEM).setPosition(i), isSubquery, null); + if (parent == null || parent.isEmpty()) { + break; + } + + long startTime = System.currentTimeMillis(); + + /* 这里优化了 Table[]: { Table:{} } 这种情况下的性能 + * 如果把 List> 改成 L 来减少以下 addAll 一次复制，则会导致 AbstractSQLExecutor 等其它很多地方 get 要改为 getJSONObject， + * 修改类型会导致不兼容旧版依赖 ORM 的项目，而且整体上性能只有特殊情况下性能提升，其它非特殊情况下因为多出很多 instanceof Map 的判断而降低了性能。 + */ + Map fo = i != 0 || arrTableKey == null ? null : JSON.get(parent, arrTableKey); + @SuppressWarnings("unchecked") + List> list = fo == null ? null : (List>) fo.remove(AbstractSQLExecutor.KEY_RAW_LIST); + + if (list != null && list.isEmpty() == false && (joinList == null || joinList.isEmpty())) { + isExtract = false; + + list.set(0, fo); // 不知道为啥第 0 项也加了 @RAW@LIST + response.addAll(list); // List> cannot match List response = JSON.createJSONArray(list); + + long endTime = System.currentTimeMillis(); // 0ms + Log.d(TAG, "\n onArrayParse <<<<<<<<<<<<<<<<<<<<<<<<<<<<\n for (int i = 0; i < (isSubquery ? 1 : size); i++) " + + " startTime = " + startTime + "; endTime = " + endTime + "; duration = " + (endTime - startTime) + "\n >>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n"); + break; + } + + //key[]:{Table:{}}中key equals Table时 提取Table + response.add(getValue(parent, childKeys)); //null有意义 } - //key[]:{Table:{}}中key equals Table时 提取Table - response.add(getValue(parent, childKeys)); //null有意义 - } - //Table>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>> + + //Table>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>> - /* - * 支持引用取值后的数组 + /* + * 支持引用取值后的数组 { "User-id[]": { "User": { @@ -986,18 +1482,28 @@ public JSONArray onArrayParse(JSONObject request, String parentPath, String name } } } - */ - Object fo = childKeys == null || response.isEmpty() ? null : response.get(0); - if (fo instanceof Boolean || fo instanceof Number || fo instanceof String) { //[{}] 和 [[]] 都没意义 - putQueryResult(path, response); - } + */ + if (isExtract) { + long startTime = System.currentTimeMillis(); + Object fo = childKeys == null || response.isEmpty() ? null : response.get(0); + if (fo instanceof Boolean || fo instanceof Number || fo instanceof String) { //[{}] 和 [[]] 都没意义 + putQueryResult(path, response); + } + + long endTime = System.currentTimeMillis(); + Log.d(TAG, "\n onArrayParse <<<<<<<<<<<<<<<<<<<<<<<<<<<<\n isExtract >> putQueryResult " + + " startTime = " + startTime + "; endTime = " + endTime + "; duration = " + (endTime - startTime) + "\n >>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n"); + } - //后面还可能用到，要还原 - request.put(JSONRequest.KEY_QUERY, query); - request.put(JSONRequest.KEY_COUNT, count); - request.put(JSONRequest.KEY_PAGE, page); - request.put(JSONRequest.KEY_JOIN, join); + } finally { + //后面还可能用到，要还原 + request.put(apijson.JSONRequest.KEY_QUERY, query); + request.put(apijson.JSONRequest.KEY_COMPAT, compat); + request.put(apijson.JSONRequest.KEY_COUNT, count); + request.put(apijson.JSONRequest.KEY_PAGE, page); + request.put(apijson.JSONRequest.KEY_JOIN, join); + } if (Log.DEBUG) { Log.i(TAG, "onArrayParse return response = \n" + JSON.toJSONString(response) + "\n>>>>>>>>>>>>>>>\n\n\n"); @@ -1005,65 +1511,112 @@ public JSONArray onArrayParse(JSONObject request, String parentPath, String name return response; } - /**多表同时筛选 - * @param join "&/User/id@, JOIN_COPY_KEY_LIST; + static { // TODO 不全 + JOIN_COPY_KEY_LIST = new ArrayList(); + JOIN_COPY_KEY_LIST.add(KEY_ROLE); + JOIN_COPY_KEY_LIST.add(KEY_DATABASE); + JOIN_COPY_KEY_LIST.add(KEY_NAMESPACE); + JOIN_COPY_KEY_LIST.add(KEY_CATALOG); + JOIN_COPY_KEY_LIST.add(KEY_SCHEMA); + JOIN_COPY_KEY_LIST.add(KEY_DATASOURCE); + JOIN_COPY_KEY_LIST.add(KEY_COLUMN); + JOIN_COPY_KEY_LIST.add(KEY_NULL); + JOIN_COPY_KEY_LIST.add(KEY_CAST); + JOIN_COPY_KEY_LIST.add(KEY_COMBINE); + JOIN_COPY_KEY_LIST.add(KEY_GROUP); + JOIN_COPY_KEY_LIST.add(KEY_HAVING); + JOIN_COPY_KEY_LIST.add(KEY_HAVING_AND); + JOIN_COPY_KEY_LIST.add(KEY_SAMPLE); + JOIN_COPY_KEY_LIST.add(KEY_LATEST); + JOIN_COPY_KEY_LIST.add(KEY_PARTITION); + JOIN_COPY_KEY_LIST.add(KEY_FILL); + JOIN_COPY_KEY_LIST.add(KEY_ORDER); + JOIN_COPY_KEY_LIST.add(KEY_KEY); + JOIN_COPY_KEY_LIST.add(KEY_RAW); + } + + /**JOIN 多表同时筛选 + * @param join "&/User,0"} * @param request - * @return - * @throws Exception + * @return + * @throws Exception */ - private List onJoinParse(Object join, JSONObject request) throws Exception { - JSONObject joinMap = null; + private List> onJoinParse(Object join, M request) throws Exception { + Map joinMap = null; - if (join instanceof JSONObject) { - joinMap = (JSONObject) join; + if (join instanceof Map) { + joinMap = (M) join; } else if (join instanceof String) { String[] sArr = request == null || request.isEmpty() ? null : StringUtil.split((String) join); if (sArr != null && sArr.length > 0) { - joinMap = new JSONObject(true); //注意：这里必须要保证join连接顺序，保证后边遍历是按照join参数的顺序生成的SQL + joinMap = new LinkedHashMap(); //注意：这里必须要保证join连接顺序，保证后边遍历是按照join参数的顺序生成的SQL for (int i = 0; i < sArr.length; i++) { - joinMap.put(sArr[i], new JSONObject()); + joinMap.put(sArr[i], new LinkedHashMap()); } } } else if (join != null){ - throw new UnsupportedDataTypeException(TAG + ".onJoinParse join 只能是 String 或 JSONObject 类型！"); + throw new UnsupportedDataTypeException(TAG + ".onJoinParse join 只能是 String 或 Map 类型！"); } - Set> set = joinMap == null ? null : joinMap.entrySet(); - if (set == null || set.isEmpty()) { - Log.e(TAG, "doJoin set == null || set.isEmpty() >> return null;"); + List> slashKeys = new ArrayList<>(); + List> nonSlashKeys = new ArrayList<>(); + Set> entries = joinMap == null ? null : joinMap.entrySet(); + + if (entries == null || entries.isEmpty()) { + Log.e(TAG, "onJoinParse set == null || set.isEmpty() >> return null;"); return null; } + for (Entry e : entries) { + String path = e.getKey(); + if (path != null && path.indexOf("/") > 0) { + slashKeys.add(e); // 以 / 开头的 key，例如 whereJoinMap = new LinkedHashMap<>(); + for (Entry e : nonSlashKeys) { + String tableKey = e.getKey(); // 如 "Location_info" + Object tableObj = e.getValue(); // value 是 Map + if (request.containsKey(tableKey)) { + whereJoinMap.put(tableKey, tableObj); + } else { + Log.w(TAG, "跳过 join 中 key = " + tableKey + "，因为它不在 request 中"); + } + } - List joinList = new ArrayList<>(); + Set> set = joinMap == null ? null : new LinkedHashSet<>(slashKeys); - JSONObject tableObj; - String targetPath; + if (set == null || set.isEmpty()) { + Log.e(TAG, "onJoinParse set == null || set.isEmpty() >> return null;"); + return null; + } - JSONObject targetObj; - String targetTable; - String targetKey; + List> joinList = new ArrayList<>(); - String path; + for (Entry e : set) { // { &/User:{}, onList = new ArrayList<>(); - for (Entry e : set) {//User/id@ - if (e.getValue() instanceof JSONObject == false) { - throw new IllegalArgumentException(JSONRequest.KEY_JOIN + ":value 中value不合法！" + if (outer instanceof Map == false) { + throw new IllegalArgumentException(apijson.JSONRequest.KEY_JOIN + ":value 中value不合法！" + "必须为 &/Table0/key0, ( ) <> () * // if (StringUtil.isEmpty(joinType, true)) { @@ -1071,194 +1624,310 @@ else if (join != null){ // } path = path.substring(index + 1); - index = path.indexOf("/"); - String tableKey = index < 0 ? null : path.substring(0, index); //User:owner + index = path.lastIndexOf("/"); + String tableKey = index < 0 ? path : path.substring(0, index); // User:owner + int index2 = tableKey.lastIndexOf("/"); + String arrKey = index2 < 0 ? null : tableKey.substring(0, index2); + if (arrKey != null && isArrayKey(arrKey) == false) { + throw new IllegalArgumentException(apijson.JSONRequest.KEY_JOIN + ":'" + e.getKey() + "' 对应的 " + arrKey + " 不是合法的数组 key[] ！" + + "@ APP JOIN 最多允许跨 1 层，只能是子数组，且数组对象中不能有 join: value 键值对！"); + } + + tableKey = index2 < 0 ? tableKey : tableKey.substring(index2+1); + apijson.orm.Entry entry = Pair.parseEntry(tableKey, true); - String table = entry.getKey(); //User - String alias = entry.getValue(); //owner - String key = StringUtil.isEmpty(table, true) ? null : path.substring(index + 1);//id@ - if (StringUtil.isEmpty(key, true)) { - throw new IllegalArgumentException(JSONRequest.KEY_JOIN + ":value 中value不合法！" - + "必须为 &/Table0/key0, 格式！" + e2.getMessage()); + } + + if (arrKey != null) { + if (parentPathObj.get(apijson.JSONRequest.KEY_JOIN) != null) { + throw new IllegalArgumentException(apijson.JSONRequest.KEY_JOIN + ":'" + e.getKey() + "' 对应的 " + arrKey + ":{ join: value } 中 value 不合法！" + + "@ APP JOIN 最多允许跨 1 层，只能是子数组，且数组对象中不能有 join: value 键值对！"); + } + + Integer subPage = getInteger(parentPathObj, apijson.JSONRequest.KEY_PAGE); + if (subPage != null && subPage != 0) { + throw new IllegalArgumentException(apijson.JSONRequest.KEY_JOIN + ":'" + e.getKey() + "' 对应的 " + arrKey + ":{ page: value } 中 value 不合法！" + + "@ APP JOIN 最多允许跨 1 层，只能是子数组，且数组对象中 page 值只能为 null 或 0 ！"); + } } - //取出引用赋值路径targetPath对应的Table和key - index = targetPath.lastIndexOf("/"); - targetKey = index < 0 ? null : targetPath.substring(index + 1); - if (StringUtil.isEmpty(targetKey, true)) { - throw new IllegalArgumentException("/" + path + ":'/targetTable/targetKey' 中targetKey不能为空！"); + boolean isAppJoin = "@".equals(joinType); + + M refObj = JSON.createJSONObject(); + + String key = index < 0 ? null : path.substring(index + 1); // id@ + if (key != null) { // 指定某个 key 为 JOIN ON 条件 + if (key.indexOf("@") != key.length() - 1) { + throw new IllegalArgumentException(apijson.JSONRequest.KEY_JOIN + ":" + e.getKey() + " 中 " + key + " 不合法！" + + "必须为 &/Table0,> tableSet = tableObj.entrySet(); + // 取出所有 join 条件 + M requestObj = JSON.createJSONObject(); // (Map) obj.clone(); + + boolean matchSingle = false; + for (Entry tableEntry : tableSet) { + String k = tableEntry.getKey(); + Object v = k == null ? null : tableEntry.getValue(); + if (v == null) { + continue; + } + + matchSingle = matchSingle == false && k.equals(key); + if (matchSingle) { + continue; + } + + if (k.length() > 1 && k.indexOf("@") == k.length() - 1 && v instanceof String) { + String sv = (String) v; + int ind = sv.endsWith("@") ? -1 : sv.indexOf("/"); + if (ind == 0 && key == null) { // 指定了某个就只允许一个 ON 条件 + String p = sv.substring(1); + int ind2 = p.indexOf("/"); + String tk = ind2 < 0 ? null : p.substring(0, ind2); + + apijson.orm.Entry te = tk == null || p.substring(ind2 + 1).indexOf("/") >= 0 ? null : Pair.parseEntry(tk, true); + + if (te != null && isTableKey(te.getKey()) && request.get(tk) instanceof Map) { + if (isAppJoin) { + if (refObj.size() >= 1) { + throw new IllegalArgumentException(apijson.JSONRequest.KEY_JOIN + ":" + e.getKey() + " 中 " + k + " 不合法！" + + "@ APP JOIN 必须有且只有一个引用赋值键值对！"); + } + + if (StringUtil.isName(k.substring(0, k.length() - 1)) == false) { + throw new IllegalArgumentException(apijson.JSONRequest.KEY_JOIN + ":'" + e.getKey() + "' 中 " + k + " 不合法 ！" + + "@ APP JOIN 只允许 key@:/Table/refKey 这种 = 等价连接！"); + } + } + + refObj.put(k, v); + continue; + } + } + + Object rv = getValueByPath(sv); + if (rv != null && rv.equals(sv) == false) { + requestObj.put(k.substring(0, k.length() - 1), rv); + continue; + } + + throw new UnsupportedOperationException(table + "/" + k + " 不合法！" + apijson.JSONRequest.KEY_JOIN + " 关联的 Table 中，" + + "join: ?/Table/key 时只能有 1 个 key@:value；join: ?/Table 时所有 key@:value 要么是符合 join 格式，要么能直接解析成具体值！"); // TODO 支持 join on + } + + if (k.startsWith("@")) { + if (JOIN_COPY_KEY_LIST.contains(k)) { + requestObj.put(k, v); // 保留 + } + } + else { + if (k.endsWith("@")) { + throw new UnsupportedOperationException(table + "/" + k + " 不合法！" + apijson.JSONRequest.KEY_JOIN + " 关联的 Table 中，" + + "join: ?/Table/key 时只能有 1 个 key@:value；join: ?/Table 时所有 key@:value 要么是符合 join 格式，要么能直接解析成具体值！"); // TODO 支持 join on + } + + if (k.contains("()") == false) { // 不需要远程函数 + requestObj.put(k, v); // 保留 + } + } + } - //对引用的JSONObject添加条件 - targetObj = request.getJSONObject(targetTable); - if (targetObj == null) { - throw new IllegalArgumentException(targetTable + "." + targetKey - + ":'/targetTable/targetKey' 中路径对应的对象不存在！"); + Set> refSet = refObj.entrySet(); + if (refSet.isEmpty() && "*".equals(joinType) == false) { + throw new IllegalArgumentException(apijson.JSONRequest.KEY_JOIN + ":value 中 value 的 alias 值 " + alias + " 不合法！" + + "必须为 &/Table0, j = new Join<>(); + j.setPath(e.getKey()); j.setJoinType(joinType); j.setTable(table); j.setAlias(alias); - j.setTargetName(targetTable); - j.setTargetKey(targetKey); - j.setKeyAndType(key); - j.setRequest(getJoinObject(table, tableObj, key)); - j.setOuter((JSONObject) e.getValue()); - joinList.add(j); + M outerObj = (M) JSON.createJSONObject((Map) outer); + j.setOn(outerObj); + j.setRequest(requestObj); - // onList.add(table + "." + key + " = " + targetTable + "." + targetKey); // ON User.id = Moment.userId + if (whereJoinMap.containsKey(table)) { + Object rawOuter = whereJoinMap.get(table); + M outerObj1 = (M) JSON.createJSONObject((Map) rawOuter); + j.setOuter(outerObj1); + } - } + if (arrKey != null) { + Integer count = getInteger(parentPathObj, apijson.JSONRequest.KEY_COUNT); + j.setCount(count == null ? getDefaultQueryCount() : count); + } + List onList = new ArrayList<>(); + for (Entry refEntry : refSet) { + String originKey = refEntry.getKey(); - //拼接多个 SQLConfig 的SQL语句，然后执行，再把结果分别缓存(Moment, User等)到 SQLExecutor 的 cacheMap - // AbstractSQLConfig config0 = null; - // String sql = "SELECT " + config0.getColumnString() + " FROM " + config0.getTable() + " INNER JOIN " + targetTable + " ON " - // + onList.get(0) + config0.getGroupString() + config0.getHavingString() + config0.getOrderString(); + String targetPath = (String) refEntry.getValue(); + if (StringUtil.isEmpty(targetPath, true)) { + throw new IllegalArgumentException(e.getKey() + ":value 中 value 值 " + targetPath + " 不合法！必须为引用赋值的路径 '/targetTable/targetKey' ！"); + } + // 取出引用赋值路径 targetPath 对应的 Table 和 key + index = targetPath.lastIndexOf("/"); + String targetKey = index < 0 ? null : targetPath.substring(index + 1); + if (StringUtil.isName(targetKey) == false) { + throw new IllegalArgumentException(e.getKey() + ":'/targetTable/targetKey' 中 targetKey 值 " + targetKey + " 不合法！必须满足英文单词变量名格式！"); + } - return joinList; - } + targetPath = targetPath.substring(0, index); + index = targetPath.lastIndexOf("/"); + String targetTableKey = index < 0 ? targetPath : targetPath.substring(index + 1); + // 主表允许别名 + apijson.orm.Entry targetEntry = Pair.parseEntry(targetTableKey, true); + String targetTable = targetEntry.getKey(); //User + if (StringUtil.isName(targetTable) == false) { + throw new IllegalArgumentException(e.getKey() + ":'/targetTable/targetKey' 中 targetTable 值 " + targetTable + " 不合法！必须满足大写字母开头的表对象英文单词 key 格式！"); + } + String targetAlias = targetEntry.getValue(); //owner + if (StringUtil.isNotEmpty(targetAlias, true) && StringUtil.isName(targetAlias) == false) { + throw new IllegalArgumentException(e.getKey() + ":'/targetTable:targetAlias/targetKey' 中 targetAlias 值 " + targetAlias + " 不合法！必须满足英文单词变量名格式！"); + } - private static final List JOIN_COPY_KEY_LIST; - static {//TODO 不全 - JOIN_COPY_KEY_LIST = new ArrayList(); - JOIN_COPY_KEY_LIST.add(JSONRequest.KEY_DATABASE); - JOIN_COPY_KEY_LIST.add(JSONRequest.KEY_SCHEMA); - JOIN_COPY_KEY_LIST.add(JSONRequest.KEY_COLUMN); - JOIN_COPY_KEY_LIST.add(JSONRequest.KEY_COMBINE); - JOIN_COPY_KEY_LIST.add(JSONRequest.KEY_GROUP); - JOIN_COPY_KEY_LIST.add(JSONRequest.KEY_HAVING); - JOIN_COPY_KEY_LIST.add(JSONRequest.KEY_ORDER); - } + //targetTable = targetTableKey; // 主表允许别名 + if (StringUtil.isName(targetTable) == false) { + throw new IllegalArgumentException(e.getKey() + ":'/targetTable/targetKey' 中 targetTable 值 " + targetTable + " 不合法！必须满足大写字母开头的表对象英文单词 key 格式！"); + } - /** - * 取指定json对象的id集合 - * @param table - * @param key - * @param obj - * @param targetKey - * @return null ? 全部 : 有限的数组 - */ - private JSONObject getJoinObject(String table, JSONObject obj, String key) { - if (obj == null || obj.isEmpty()) { - Log.e(TAG, "getIdList obj == null || obj.isEmpty() >> return null;"); - return null; - } - if (StringUtil.isEmpty(key, true)) { - Log.e(TAG, "getIdList StringUtil.isEmpty(key, true) >> return null;"); - return null; - } + //对引用的JSONObject添加条件 + Map targetObj; + try { + targetObj = JSON.get(request, targetTableKey); + } + catch (Exception e2) { + throw new IllegalArgumentException(e.getKey() + ":'/targetTable/targetKey' 中路径对应的 '" + targetTableKey + "':value 中 value 类型不合法！必须是 {} 这种 Map 格式！" + e2.getMessage()); + } - //取出所有join条件 - JSONObject requestObj = new JSONObject(true);//(JSONObject) obj.clone();// - Set set = new LinkedHashSet<>(obj.keySet()); - for (String k : set) { - if (StringUtil.isEmpty(k, true)) { - continue; - } + if (targetObj == null) { + throw new IllegalArgumentException(e.getKey() + ":'/targetTable/targetKey' 中路径对应的对象 '" + targetTableKey + "':{} 不存在或值为 null ！必须是 {} 这种 Map 格式！"); + } - if (k.startsWith("@")) { - if (JOIN_COPY_KEY_LIST.contains(k)) { - requestObj.put(k, obj.get(k)); //保留 + Join.On on = new Join.On(); + on.setKeyAndType(j.getJoinType(), j.getTable(), originKey); + if (StringUtil.isName(on.getKey()) == false) { + throw new IllegalArgumentException(apijson.JSONRequest.KEY_JOIN + ":value 中 value 的 key@ 中 key 值 " + on.getKey() + " 不合法！必须满足英文单词变量名格式！"); } + + on.setOriginKey(originKey); + on.setOriginValue((String) refEntry.getValue()); + on.setTargetTableKey(targetTableKey); + on.setTargetTable(targetTable); + on.setTargetAlias(targetAlias); + on.setTargetKey(targetKey); + + onList.add(on); } - else { - if (k.endsWith("@")) { - if (k.equals(key)) { - continue; - } - throw new UnsupportedOperationException(table + "." + k + " 不合法！" + JSONRequest.KEY_JOIN - + " 关联的Table中只能有1个 key@:value ！"); - } - if (k.contains("()") == false) { //不需要远程函数 - // requestObj.put(k, obj.remove(k)); //remove是为了避免重复查询副表 - requestObj.put(k, obj.get(k)); //remove是为了避免重复查询副表 - } + j.setOnList(onList); + + joinList.add(j); + // onList.add(table + "." + key + " = " + targetTable + "." + targetKey); // ON User.id = Moment.userId + + // 保证和 SQLExcecutor 缓存的 Config 里 where 顺序一致，生成的 SQL 也就一致 <<<<<<<<< + // AbstractSQLConfig.newSQLConfig 中强制把 id, id{}, userId, userId{} 放到了最前面 tableObj.put(key, tableObj.remove(key)); + + if (refObj.size() != tableObj.size()) { // 把 key 强制放最前，AbstractSQLExcecutor 中 config.putWhere 也是放尽可能最前 + refObj.putAll(tableObj); + parentPathObj.put(tableKey, refObj); + +// tableObj.clear(); +// tableObj.putAll(refObj); } + // 保证和 SQLExcecutor 缓存的 Config 里 where 顺序一致，生成的 SQL 也就一致 >>>>>>>>> } + //拼接多个 SQLConfig 的SQL语句，然后执行，再把结果分别缓存(Moment, User等)到 SQLExecutor 的 cacheMap + // AbstractSQLConfig config0 = null; + // String sql = "SELECT " + config0.getColumnString() + " FROM " + config0.getTable() + " INNER JOIN " + targetTable + " ON " + // + onList.get(0) + config0.getGroupString() + config0.getHavingString() + config0.getOrderString(); - return requestObj; - } - - @Override - public int getDefaultQueryCount() { - return DEFAULT_QUERY_COUNT; - } - @Override - public int getMaxQueryPage() { - return MAX_QUERY_PAGE; - } - @Override - public int getMaxQueryCount() { - return MAX_QUERY_COUNT; - } - @Override - public int getMaxUpdateCount() { - return MAX_UPDATE_COUNT; - } - @Override - public int getMaxSQLCount() { - return MAX_SQL_COUNT; - } - @Override - public int getMaxObjectCount() { - return MAX_OBJECT_COUNT; - } - @Override - public int getMaxArrayCount() { - return MAX_ARRAY_COUNT; - } - @Override - public int getMaxQueryDepth() { - return MAX_QUERY_DEPTH; + return joinList; } - /**根据路径取值 * @param parent * @param pathKeys * @return */ - protected static Object getValue(JSONObject parent, String[] pathKeys) { - if (parent == null || pathKeys == null || pathKeys.length <= 0) { + public static V getValue(Object parent, String[] pathKeys) { + int len = parent == null || pathKeys == null ? 0 : pathKeys.length; + if (len <= 0) { Log.w(TAG, "getChild parent == null || pathKeys == null || pathKeys.length <= 0 >> return parent;"); - return parent; + return (V) parent; } - //逐层到达child的直接容器JSONObject parent - final int last = pathKeys.length - 1; - for (int i = 0; i < last; i++) {//一步一步到达指定位置 - if (parent == null) {//不存在或路径错误(中间的key对应value不是JSONObject) + // 逐层到达child的直接容器JSONObject parent + Object v = parent; + for (int i = 0; i < len; i++) { // 一步一步到达指定位置 + if (v == null) { // 不存在或路径错误(中间的key对应value不是JSONObject) break; } - parent = getJSONObject(parent, pathKeys[i]); + + String k = getDecodedKey(pathKeys[i]); + try { + v = getFromObjOrArr(v, k); + } catch (Throwable e) { + if (IS_PRINT_BIG_LOG) { + e.printStackTrace(); + } + v = null; + } } - return parent == null ? null : parent.get(pathKeys[last]); + return (V) v; } @@ -1283,8 +1952,8 @@ public static String getValuePath(String parentPath, String valuePath) { */ public static String getAbsPath(String path, String name) { Log.i(TAG, "getPath path = " + path + "; name = " + name + " <<<<<<<<<<<<<"); - path = StringUtil.getString(path); - name = StringUtil.getString(name); + path = StringUtil.get(path); + name = StringUtil.get(name); if (StringUtil.isNotEmpty(path, false)) { if (StringUtil.isNotEmpty(name, false)) { path += ((name.startsWith("/") ? "" : "/") + name); @@ -1320,12 +1989,12 @@ public static String replaceArrayChildPath(String parentPath, String valuePath) pos = ps[i+1].contains("/") == false ? ps[i+1] : ps[i+1].substring(0, ps[i+1].indexOf("/")); if ( - //StringUtil.isNumer(pos) && + //StringUtil.isNumer(pos) && vs[i+1].startsWith(pos + "/") == false) { vs[i+1] = pos + "/" + vs[i+1]; } } - return StringUtil.getString(vs, "]/"); + return StringUtil.get(vs, "]/"); } } return valuePath; @@ -1338,16 +2007,18 @@ public static String replaceArrayChildPath(String parentPath, String valuePath) * @param result 需要被关联的object */ @Override - public synchronized void putQueryResult(String path, Object result) { + public void putQueryResult(String path, Object result) { Log.i(TAG, "\n putQueryResult valuePath = " + path + "; result = " + result + "\n <<<<<<<<<<<<<<<<<<<<<<<"); // if (queryResultMap.containsKey(valuePath)) {//只保存被关联的value Log.d(TAG, "putQueryResult queryResultMap.containsKey(valuePath) >> queryResultMap.put(path, result);"); queryResultMap.put(path, result); // } } + //CS304 Issue link: https://github.com/Tencent/APIJSON/issues/48 /**根据路径获取值 - * @param valuePath + * @param valuePath -the path need to get value * @return parent == null ? valuePath : parent.get(keys[keys.length - 1]) + *

use entrySet+getValue() to replace keySet+get() to enhance efficiency

*/ @Override public Object getValueByPath(String valuePath) { @@ -1362,16 +2033,16 @@ public Object getValueByPath(String valuePath) { } //取出key被valuePath包含的result，再从里面获取key对应的value - Set set = queryResultMap.keySet(); - JSONObject parent = null; + Object parent = null; String[] keys = null; - for (String path : set) { + for (Entry entry : queryResultMap.entrySet()){ + String path = entry.getKey(); if (valuePath.startsWith(path + "/")) { try { - parent = (JSONObject) queryResultMap.get(path); + parent = entry.getValue(); } catch (Exception e) { - Log.e(TAG, "getValueByPath try { parent = (JSONObject) queryResultMap.get(path); } catch { " - + "\n parent not instanceof JSONObject!"); + Log.e(TAG, "getValueByPath try { parent = (Map) queryResultMap.get(path); } catch { " + + "\n parent not instanceof Map!"); parent = null; } if (parent != null) { @@ -1381,103 +2052,109 @@ public Object getValueByPath(String valuePath) { } } - //逐层到达targetKey的直接容器JSONObject parent - if (keys != null && keys.length > 1) { - for (int i = 0; i < keys.length - 1; i++) {//一步一步到达指定位置parentPath - if (parent == null) {//不存在或路径错误(中间的key对应value不是JSONObject) - break; - } - parent = getJSONObject(parent, keys[i]); - } - } - - if (parent != null) { - Log.i(TAG, "getValueByPath >> get from queryResultMap >> return parent.get(keys[keys.length - 1]);"); - target = parent.get(keys[keys.length - 1]); //值为null应该报错NotExistExeption，一般都是id关联，不可为null，否则可能绕过安全机制 - if (target != null) { - Log.i(TAG, "getValueByPath >> getValue >> return target = " + target); - return target; - } + target = getValue(parent, keys); // 逐层到达targetKey的直接容器JSONObject parent + if (target == null) { //从requestObject中取值 + target = getValue(requestObject, StringUtil.splitPath(valuePath)); } + Log.i(TAG, "getValueByPath >> getValue >> return target = " + target); + return target; + } - //从requestObject中取值 - target = getValue(requestObject, StringUtil.splitPath(valuePath)); - if (target != null) { - Log.i(TAG, "getValueByPath >> getValue >> return target = " + target); - return target; + /**解码 引用赋值 路径中的 key，支持把 URL encode 后的值，转为 decode 后的原始值，例如 %2Fuser%2Flist -> /user/list ; %7B%7D -> [] + * @param key + * @return + */ + public static String getDecodedKey(String key) { + try { + return URLDecoder.decode(key, StringUtil.UTF_8); + } catch (Throwable e) { + return key; } - - Log.i(TAG, "getValueByPath return valuePath;"); - return valuePath; } //依赖引用关系 >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>> + public static final String KEY_CONFIG = "config"; + public static final String KEY_SQL = "sql"; - public static JSONObject getJSONObject(JSONObject object, String key) { - try { - return object.getJSONObject(key); - } catch (Exception e) { - Log.i(TAG, "getJSONObject try { return object.getJSONObject(key);" - + " } catch (Exception e) { \n" + e.getMessage()); - } - return null; + protected Map> arrayMainCacheMap = new HashMap<>(); + public void putArrayMainCache(String arrayPath, List mainTableDataList) { + arrayMainCacheMap.put(arrayPath, mainTableDataList); + } + public List getArrayMainCache(String arrayPath) { + return arrayMainCacheMap.get(arrayPath); + } + public M getArrayMainCacheItem(String arrayPath, int position) { + List list = getArrayMainCache(arrayPath); + return list == null || position >= list.size() ? null : list.get(position); } - public static final String KEY_CONFIG = "config"; - /**执行 SQL 并返回 JSONObject + /**执行 SQL 并返回 Map * @param config * @return * @throws Exception */ @Override - public JSONObject executeSQL(SQLConfig config, boolean isSubquery) throws Exception { + public M executeSQL(SQLConfig config, boolean isSubquery) throws Exception { if (config == null) { Log.d(TAG, "executeSQL config == null >> return null;"); return null; } + config.setParser(this); + config.setVersion(getVersion()); + config.setTag(getTag()); + if (isSubquery) { - JSONObject sqlObj = new JSONObject(true); + M sqlObj = JSON.createJSONObject(); sqlObj.put(KEY_CONFIG, config); return sqlObj;//容易丢失信息 JSON.parseObject(config); } try { + M result; + boolean explain = config.isExplain(); - JSONObject result; - if (explain) { //如果先执行 explain，则 execute 会死循环，所以只能先执行非 explain + if (explain) { + //如果先执行 explain，则 execute 会死循环，所以只能先执行非 explain config.setExplain(false); //对下面 config.getSQL(false); 生效 - JSONObject res = getSQLExecutor().execute(config, false); + M res = getSQLExecutor().execute(config, false); - config.setExplain(explain); - JSONObject explainResult = config.isMain() && config.getPosition() != 0 ? null : getSQLExecutor().execute(config, false); + //如果是查询方法，才能执行explain + if (RequestMethod.isQueryMethod(config.getMethod()) && config.isElasticsearch() == false){ + config.setExplain(explain); + Map explainResult = config.isMain() && config.getPosition() != 0 ? null : getSQLExecutor().execute(config, false); - if (explainResult == null) { - result = res; + if (explainResult == null) { + result = res; + } + else { + result = JSON.createJSONObject(); + result.put(KEY_EXPLAIN, explainResult); + result.putAll(res); + } } - else { - result = new JSONObject(true); - result.put(KEY_EXPLAIN, explainResult); + else {//如果是更新请求，不执行explain，但可以返回sql + result = JSON.createJSONObject(); + result.put(KEY_SQL, config.gainSQL(false)); result.putAll(res); } } else { result = getSQLExecutor().execute(config, false); + // FIXME 改为直接在 sqlExecutor 内加好，最后 Parser 取结果，可以解决并发执行导致内部计算出错 +// executedSQLDuration += sqlExecutor.getExecutedSQLDuration() + sqlExecutor.getSqlResultDuration(); } - return parseCorrectResponse(config.getTable(), result); + return result; } catch (Exception e) { - if (Log.DEBUG == false && e instanceof SQLException) { - throw new SQLException("数据库驱动执行异常SQLException，非 Log.DEBUG 模式下不显示详情，避免泄漏真实模式名、表名等隐私信息", e); - } - throw e; + throw CommonException.wrap(e, config); } finally { if (config.getPosition() == 0 && config.limitSQLCount()) { @@ -1506,7 +2183,7 @@ public void setTransactionIsolation(int transactionIsolation) { @Override public void begin(int transactionIsolation) { Log.d("\n\n" + TAG, "<<<<<<<<<<<<<<<<<<<<<<< begin transactionIsolation = " + transactionIsolation + " >>>>>>>>>>>>>>>>>>>>>>> \n\n"); - getSQLExecutor().setTransactionIsolation(transactionIsolation); //不知道 connection 什么时候创建，不能在这里准确控制，getSqlExecutor().begin(transactionIsolation); + getSQLExecutor().setTransactionIsolation(transactionIsolation); // 不知道 connection 什么时候创建，不能在这里准确控制，getSqlExecutor().begin(transactionIsolation); } @Override public void rollback() throws SQLException { @@ -1543,7 +2220,9 @@ protected void onBegin() { */ protected void onCommit() { // Log.d(TAG, "onCommit >>"); - if (RequestMethod.isQueryMethod(requestMethod)) { + // this.sqlExecutor.getTransactionIsolation() 只有json第一次执行才会设置, get请求=0 + if (RequestMethod.isQueryMethod(requestMethod) + && getSQLExecutor().getTransactionIsolation() == Connection.TRANSACTION_NONE) { return; } @@ -1589,4 +2268,327 @@ protected void onClose() { queryResultMap = null; } + private void setOpMethod(Map request, ObjectParser op, String key) { + String _method = key == null ? null : getString(request, KEY_METHOD); + if (_method != null) { + RequestMethod method = RequestMethod.valueOf(_method); // 必须精准匹配，避免缓存命中率低 + this.setMethod(method); + op.setMethod(method); + } + } + + protected M getRequestStructure(RequestMethod method, String tag, int version) throws Exception { + // 获取指定的JSON结构 <<<<<<<<<<<< + M object = null; + String error = ""; + try { + object = getStructure("Request", method.name(), tag, version); + } catch (Exception e) { + error = e.getMessage(); + } + if (object == null) { // empty表示随意操作 || object.isEmpty()) { + throw new UnsupportedOperationException("找不到 version: " + version + ", method: " + method.name() + ", tag: " + tag + " 对应的 structure ！" + "非开放请求必须是后端 Request 表中校验规则允许的操作！\n " + error + "\n如果需要则在 Request 表中新增配置！"); + } + + return object; + } + + public static final Map KEY_METHOD_ENUM_MAP; + static { + KEY_METHOD_ENUM_MAP = new LinkedHashMap<>(); + KEY_METHOD_ENUM_MAP.put(KEY_GET, RequestMethod.GET); + KEY_METHOD_ENUM_MAP.put(KEY_GETS, RequestMethod.GETS); + KEY_METHOD_ENUM_MAP.put(KEY_HEAD, RequestMethod.HEAD); + KEY_METHOD_ENUM_MAP.put(KEY_HEADS, RequestMethod.HEADS); + KEY_METHOD_ENUM_MAP.put(KEY_POST, RequestMethod.POST); + KEY_METHOD_ENUM_MAP.put(KEY_PUT, RequestMethod.PUT); + KEY_METHOD_ENUM_MAP.put(KEY_DELETE, RequestMethod.DELETE); + } + + protected M batchVerify(RequestMethod method, String tag, int version, String name, @NotNull M request, int maxUpdateCount, SQLCreator creator) throws Exception { + M correctRequest = JSON.createJSONObject(); + List removeTmpKeys = new ArrayList<>(); // 请求json里面的临时变量,不需要带入后面的业务中,比如 @post、@get等 + + Set reqSet = request == null ? null : request.keySet(); + if (reqSet == null || request.isEmpty()) { + throw new IllegalArgumentException("JSON 对象格式不正确 ！正确示例例如 \"User\": {}"); + } + + for (String key : reqSet) { + // key 重复直接抛错(xxx:alias, xxx:alias[]) + if (correctRequest.containsKey(key) || correctRequest.containsKey(key + KEY_ARRAY)) { + throw new IllegalArgumentException("对象名重复,请添加别名区分 ! 重复对象名为: " + key); + } + + boolean isPost = KEY_POST.equals(key); + // @post、@get 等 RequestMethod + try { + RequestMethod keyMethod = isPost ? RequestMethod.POST : KEY_METHOD_ENUM_MAP.get(key); + if (keyMethod != null) { + // 如果不匹配,异常不处理即可 + removeTmpKeys.add(key); + + Object val = request.get(key); + Map obj = val instanceof Map ? JSON.get(request, key) : null; + if (obj == null) { + if (val instanceof String) { + String[] tbls = StringUtil.split((String) val); + if (tbls != null && tbls.length > 0) { + obj = new LinkedHashMap(); + for (int i = 0; i < tbls.length; i++) { + String tbl = tbls[i]; + if (obj.containsKey(tbl)) { + throw new ConflictException(key + ": value 中 " + tbl + " 已经存在，不能重复！"); + } + + obj.put(tbl, isPost && isTableArray(tbl) + ? tbl.substring(0, tbl.length() - 2) + ":[]" : ""); + } + } + } + else { + throw new IllegalArgumentException(key + ": value 中 value 类型错误，只能是 String 或 Map {} ！"); + } + } + + Set> set = obj == null ? new HashSet<>() : obj.entrySet(); + + for (Entry objEntry : set) { + String objKey = objEntry == null ? null : objEntry.getKey(); + if (objKey == null) { + continue; + } + + Map objAttrMap = new HashMap<>(); + objAttrMap.put(KEY_METHOD, keyMethod); + keyObjectAttributesMap.put(objKey, objAttrMap); + + Object objVal = objEntry.getValue(); + Map objAttrJson = objVal instanceof Map ? JSON.getMap(obj, objKey) : null; + if (objAttrJson == null) { + if (objVal instanceof String) { + objAttrMap.put(KEY_TAG, "".equals(objVal) ? objKey : objVal); + } + else { + throw new IllegalArgumentException(key + ": { " + objKey + ": value 中 value 类型错误，只能是 String 或 Map {} ！"); + } + } + else { + Set> objSet = objAttrJson.entrySet(); + + boolean hasTag = false; + for (Entry entry : objSet) { + String objAttrKey = entry == null ? null : entry.getKey(); + if (objAttrKey == null) { + continue; + } + + switch (objAttrKey) { + case KEY_DATASOURCE: + case KEY_SCHEMA: + case KEY_DATABASE: + case KEY_VERSION: + case KEY_ROLE: + objAttrMap.put(objAttrKey, entry.getValue()); + break; + case KEY_TAG: + hasTag = true; + objAttrMap.put(objAttrKey, entry.getValue()); + break; + default: + break; + } + } + + if (hasTag == false) { + objAttrMap.put(KEY_TAG, isPost && isTableArray(objKey) + ? objKey.substring(0, objKey.length() - 2) + ":[]" : objKey); + } + } + } + continue; + } + + // 1、非crud,对于没有显式声明操作方法的，直接用 URL(/get, /post 等) 对应的默认操作方法 + // 2、crud, 没有声明就用 GET + // 3、兼容 sql@ Map,设置 GET方法 + // 将method 设置到每个object, op执行会解析 + Object obj = request.get(key); + + if (obj instanceof Map) { + Map attrMap = keyObjectAttributesMap.get(key); + + if (attrMap == null) { + // 数组会解析为对象进行校验,做一下兼容 + if (keyObjectAttributesMap.get(key + KEY_ARRAY) == null) { + if (method == RequestMethod.CRUD || key.endsWith("@")) { + ((Map) obj).put(KEY_METHOD, GET); + Map objAttrMap = new HashMap<>(); + objAttrMap.put(KEY_METHOD, GET); + keyObjectAttributesMap.put(key, objAttrMap); + } else { + ((Map) obj).put(KEY_METHOD, method); + Map objAttrMap = new HashMap<>(); + objAttrMap.put(KEY_METHOD, method); + keyObjectAttributesMap.put(key, objAttrMap); + } + } else { + setRequestAttribute(key, true, KEY_METHOD, request); + setRequestAttribute(key, true, KEY_DATASOURCE, request); + setRequestAttribute(key, true, KEY_SCHEMA, request); + setRequestAttribute(key, true, KEY_DATABASE, request); + setRequestAttribute(key, true, KEY_VERSION, request); + setRequestAttribute(key, true, KEY_ROLE, request); + } + } else { + setRequestAttribute(key, false, KEY_METHOD, request); + setRequestAttribute(key, false, KEY_DATASOURCE, request); + setRequestAttribute(key, false, KEY_SCHEMA, request); + setRequestAttribute(key, false, KEY_DATABASE, request); + setRequestAttribute(key, false, KEY_VERSION, request); + setRequestAttribute(key, false, KEY_ROLE, request); + } + } + + if (key.startsWith("@") || key.endsWith("@")) { + correctRequest.put(key, obj); + continue; + } + + if (obj instanceof Map || obj instanceof List) { + RequestMethod _method; + if (obj instanceof Map) { + Map tblObj = JSON.getMap(request, key); + String mn = tblObj == null ? null : getString(tblObj, KEY_METHOD); + _method = mn == null ? null : RequestMethod.valueOf(mn); + String combine = _method == null ? null : getString(tblObj, KEY_COMBINE); + if (combine != null && RequestMethod.isPublicMethod(_method) == false) { + throw new IllegalArgumentException(key + ":{} 里的 @combine:value 不合法！开放请求 GET、HEAD 才允许传 @combine:value !"); + } + } else { + Map attrMap = keyObjectAttributesMap.get(key); + + if (attrMap == null) { + if (method == RequestMethod.CRUD) { + _method = GET; + Map objAttrMap = new HashMap<>(); + objAttrMap.put(KEY_METHOD, GET); + keyObjectAttributesMap.put(key, objAttrMap); + } else { + _method = method; + Map objAttrMap = new HashMap<>(); + objAttrMap.put(KEY_METHOD, method); + keyObjectAttributesMap.put(key, objAttrMap); + } + } else { + _method = (RequestMethod) attrMap.get(KEY_METHOD); + } + } + + // 非 CRUD 方法，都只能和 URL method 完全一致，避免意料之外的安全风险。 + if (method != RequestMethod.CRUD && _method != method) { + throw new IllegalArgumentException("不支持在 " + method + " 中 " + _method + " ！"); + } + + // get请求不校验 + if (RequestMethod.isPublicMethod(_method)) { + correctRequest.put(key, obj); + continue; + } + + if (tag != null && ! tag.contains(":")) { + M object = getRequestStructure(_method, tag, version); + M ret = objectVerify(_method, tag, version, name, request, maxUpdateCount, creator, object); + correctRequest.putAll(ret); + break; + } + + String _tag = buildTag(request, key, method, tag); + M object = getRequestStructure(_method, _tag, version); + if (method == RequestMethod.CRUD && StringUtil.isEmpty(tag, true)) { + M requestItem = JSON.createJSONObject(); + requestItem.put(key, obj); + Map ret = objectVerify(_method, _tag, version, name, requestItem, maxUpdateCount, creator, object); + correctRequest.put(key, ret.get(key)); + } else { + return objectVerify(_method, _tag, version, name, request, maxUpdateCount, creator, object); + } + } else { + correctRequest.put(key, obj); + } + } catch (Exception e) { + e.printStackTrace(); + throw new Exception(e); // 包装一层只是为了打印日志？看起来没必要 + } + } + + // 这里是 requestObject ref request 的引用, 删除不需要的临时变量 + for (String removeKey : removeTmpKeys) { + request.remove(removeKey); + } + + return correctRequest; + } + + public static > E getEnum(final Class enumClass, final String enumName, final E defaultEnum) { + if (enumName == null) { + return defaultEnum; + } + try { + return Enum.valueOf(enumClass, enumName); + } catch (final IllegalArgumentException ex) { + return defaultEnum; + } + } + + protected void setRequestAttribute(String key, boolean isArray, String attrKey, @NotNull Map request) { + Map attrMap = keyObjectAttributesMap.get(isArray ? key + KEY_ARRAY : key); + Object attrVal = attrMap == null ? null : attrMap.get(attrKey); + Map obj = attrVal == null ? null : JSON.get(request, key); + + if (obj != null && obj.get(attrKey) == null) { + // 如果对象内部已经包含该属性,不覆盖 + obj.put(attrKey, attrVal); + } + } + + protected String buildTag(Map request, String key, RequestMethod method, String tag) { + if (method == RequestMethod.CRUD) { + Map attrMap = keyObjectAttributesMap.get(key); + Object _tag = attrMap == null ? null : attrMap.get(KEY_TAG); + return _tag != null ? _tag.toString() : StringUtil.isEmpty(tag) ? key : tag; + } else { + if (StringUtil.isEmpty(tag, true)) { + throw new IllegalArgumentException("请在最外层传 tag ！一般是 Table 名，例如 \"tag\": \"User\" "); + } + } + return tag; + } + + + protected M objectVerify(RequestMethod method, String tag, int version, String name, @NotNull M request + , int maxUpdateCount, SQLCreator creator, M object) throws Exception { + // 获取指定的JSON结构 >>>>>>>>>>>>>> + M target = wrapRequest(method, tag, object, true); + // Map clone 浅拷贝没用，Structure.parse 会导致 structure 里面被清空，第二次从缓存里取到的就是 {} + return getVerifier().setParser(this).verifyRequest(method, name, target, request, maxUpdateCount, getGlobalDatabase(), getGlobalSchema()); + } + + /*** + * 兼容url crud, 获取真实method + * @param method = crud + * @param key + * @return + */ + public RequestMethod getRealMethod(RequestMethod method, String key, Object value) { + if (method == CRUD && (value instanceof Map || value instanceof List)) { + Map attrMap = keyObjectAttributesMap.get(key); + Object _method = attrMap == null ? null : attrMap.get(KEY_METHOD); + if (_method instanceof RequestMethod) { + return (RequestMethod) _method; + } + } + + return method; + } } diff --git a/APIJSONORM/src/main/java/apijson/orm/AbstractSQLConfig.java b/APIJSONORM/src/main/java/apijson/orm/AbstractSQLConfig.java index e6f3fd9cc..d9e9eb016 100755 --- a/APIJSONORM/src/main/java/apijson/orm/AbstractSQLConfig.java +++ b/APIJSONORM/src/main/java/apijson/orm/AbstractSQLConfig.java @@ -1,104 +1,128 @@ -/*Copyright (C) 2020 THL A29 Limited, a Tencent company. All rights reserved. +/*Copyright (C) 2020 Tencent. All rights reserved. This source code is licensed under the Apache License Version 2.0.*/ package apijson.orm; -import static apijson.JSONObject.KEY_CACHE; -import static apijson.JSONObject.KEY_COLUMN; -import static apijson.JSONObject.KEY_COMBINE; -import static apijson.JSONObject.KEY_DATABASE; -import static apijson.JSONObject.KEY_EXPLAIN; -import static apijson.JSONObject.KEY_FROM; -import static apijson.JSONObject.KEY_GROUP; -import static apijson.JSONObject.KEY_HAVING; -import static apijson.JSONObject.KEY_ID; -import static apijson.JSONObject.KEY_JSON; -import static apijson.JSONObject.KEY_ORDER; -import static apijson.JSONObject.KEY_RAW; -import static apijson.JSONObject.KEY_ROLE; -import static apijson.JSONObject.KEY_SCHEMA; -import static apijson.JSONObject.KEY_USER_ID; -import static apijson.RequestMethod.DELETE; -import static apijson.RequestMethod.GET; -import static apijson.RequestMethod.GETS; -import static apijson.RequestMethod.HEADS; -import static apijson.RequestMethod.POST; -import static apijson.RequestMethod.PUT; -import static apijson.SQL.AND; -import static apijson.SQL.NOT; -import static apijson.SQL.OR; - -import java.util.ArrayList; -import java.util.Arrays; -import java.util.Collection; -import java.util.HashMap; -import java.util.LinkedHashMap; -import java.util.List; -import java.util.Map; +import apijson.*; +import apijson.orm.Join.On; +import apijson.orm.exception.NotExistException; +import apijson.orm.exception.UnsupportedDataTypeException; +import apijson.orm.model.*; + +import java.util.*; import java.util.Map.Entry; -import java.util.Set; import java.util.regex.Pattern; -import javax.activation.UnsupportedDataTypeException; - -import com.alibaba.fastjson.JSONArray; -import com.alibaba.fastjson.JSONObject; -import com.alibaba.fastjson.annotation.JSONField; - -import apijson.JSON; -import apijson.JSONResponse; -import apijson.Log; -import apijson.NotNull; -import apijson.RequestMethod; -import apijson.RequestRole; -import apijson.SQL; -import apijson.StringUtil; -import apijson.orm.exception.NotExistException; -import apijson.orm.model.Access; -import apijson.orm.model.Column; -import apijson.orm.model.Document; -import apijson.orm.model.ExtendedProperty; -import apijson.orm.model.Function; -import apijson.orm.model.PgAttribute; -import apijson.orm.model.PgClass; -import apijson.orm.model.Request; -import apijson.orm.model.Response; -import apijson.orm.model.SysColumn; -import apijson.orm.model.SysTable; -import apijson.orm.model.Table; -import apijson.orm.model.Test; -import apijson.orm.model.TestRecord; +import static apijson.JSON.getBoolean; +import static apijson.JSON.getString; +import static apijson.JSONMap.*; +import static apijson.RequestMethod.*; +import static apijson.SQL.*; /**config sql for JSON Request * @author Lemon */ -public abstract class AbstractSQLConfig implements SQLConfig { +public abstract class AbstractSQLConfig, L extends List> + implements SQLConfig { private static final String TAG = "AbstractSQLConfig"; + /** + * 为 true 则兼容 5.0 之前 @having:"toId>0;avg(id)<100000" 默认 AND 连接，为 HAVING toId>0 AND avg(id)<100000； + * 否则按 5.0+ 新版默认 OR 连接，为 HAVING toId>0 OR avg(id)<100000，使用 @having& 或 @having:{ @combine: null } 时才用 AND 连接 + */ + public static boolean IS_HAVING_DEFAULT_AND = false; + /** + * 为 true 则兼容 5.0 之前 @having:"toId>0" 这种不包含 SQL 函数的表达式； + * 否则按 5.0+ 新版不允许，可以用 @having:"(toId)>0" 替代 + */ + public static boolean IS_HAVING_ALLOW_NOT_FUNCTION = false; + + /** + * 开启 WITH AS 表达式(在支持这种语法的数据库及版本)来简化 SQL 和提升性能 + */ + public static boolean ENABLE_WITH_AS = false; + + /** + * 对指定的方法，忽略空字符串，不作为 GET 条件，PUT 值等。可取值 new RequestMethod[]{ RequestMethod.GET, RequestMethod.POST ... } + */ + public static List IGNORE_EMPTY_STRING_METHOD_LIST = null; + /** + * 对指定的方法，忽略空白字符串。即首尾 trim 去掉所有不可见字符后，仍然为空的，就忽略，不作为 GET 条件，PUT 值等。 + * 可取值 new RequestMethod[]{ RequestMethod.GET, RequestMethod.POST ... } + */ + public static List IGNORE_BLANK_STRING_METHOD_LIST = null; + + public static String KEY_DELETED_KEY = "deletedKey"; + public static String KEY_DELETED_VALUE = "deletedValue"; + public static String KEY_NOT_DELETED_VALUE = "notDeletedValue"; + + public static int MAX_HAVING_COUNT = 5; + public static int MAX_WHERE_COUNT = 10; + public static int MAX_COMBINE_DEPTH = 2; + public static int MAX_COMBINE_COUNT = 5; + public static int MAX_COMBINE_KEY_COUNT = 2; + public static float MAX_COMBINE_RATIO = 1.0f; + public static boolean ALLOW_MISSING_KEY_4_COMBINE = true; + public static String DEFAULT_DATABASE = DATABASE_MYSQL; + public static String DEFAULT_NAMESPACE = ""; // "root"; + public static String DEFAULT_CATALOG = ""; // PostgreSQL JDBC 必须在 URI 中传 ""postgres"; public static String DEFAULT_SCHEMA = "sys"; - public static String PREFFIX_DISTINCT = "DISTINCT "; + public static String PREFIX_DISTINCT = "DISTINCT "; + public static Pattern PATTERN_SCHEMA; // * 和 / 不能同时出现，防止 /* */ 段注释！ # 和 -- 不能出现，防止行注释！ ; 不能出现，防止隔断SQL语句！空格不能出现，防止 CRUD,DROP,SHOW TABLES等语句！ - private static final Pattern PATTERN_RANGE; - private static final Pattern PATTERN_FUNCTION; - + public static Pattern PATTERN_RANGE; + public static Pattern PATTERN_FUNCTION; + + /** + * 表 SCHEMA 映射 + */ + public static Map TABLE_SCHEMA_MAP; + /** * 表名映射，隐藏真实表名，对安全要求很高的表可以这么做 */ - public static final Map TABLE_KEY_MAP; - public static final List CONFIG_TABLE_LIST; - public static final List DATABASE_LIST; + public static Map TABLE_KEY_MAP; + /** + * 字段名映射，隐藏真实字段名，对安全要求很高的表可以这么做，另外可以配置 name_tag:(name,tag) 来实现多字段 IN，length_tag:length(tag) 来实现 SQL 函数复杂条件 + */ + public static Map COLUMN_KEY_MAP; + /** + * 允许批量增删改部分记录失败的表 + */ + public static Map ALLOW_PARTIAL_UPDATE_FAIL_TABLE_MAP; + public static List CONFIG_TABLE_LIST; + public static List DATABASE_LIST; + // 自定义原始 SQL 片段 Map：当 substring 为 null 时忽略；当 substring 为 "" 时整个 value 是 raw SQL；其它情况则只是 substring 这段为 raw SQL - public static final Map RAW_MAP; - static { // 凡是 SQL 边界符、分隔符、注释符 都不允许，例如 ' " ` ( ) ; # -- ，以免拼接 SQL 时被注入意外可执行指令 + public static Map RAW_MAP; + // 允许调用的 SQL 函数：当 substring 为 null 时忽略；当 substring 为 "" 时整个 value 是 raw SQL；其它情况则只是 substring 这段为 raw SQL + public static Map SQL_AGGREGATE_FUNCTION_MAP; + public static Map SQL_FUNCTION_MAP; + + static { // 凡是 SQL 边界符、分隔符、注释符 都不允许，例如 ' " ` ( ) ; # -- /**/ ，以免拼接 SQL 时被注入意外可执行指令 + PATTERN_SCHEMA = Pattern.compile("^[A-Za-z0-9_-]+$"); PATTERN_RANGE = Pattern.compile("^[0-9%,!=\\<\\>/\\.\\+\\-\\*\\^]+$"); // ^[a-zA-Z0-9_*%!=<>(),"]+$ 导致 exists(select*from(Comment)) 通过！ - PATTERN_FUNCTION = Pattern.compile("^[A-Za-z0-9%,:_@&~!=\\<\\>\\|\\[\\]\\{\\} /\\.\\+\\-\\*\\^\\?\\$]+$"); //TODO 改成更好的正则，校验前面为单词，中间为操作符，后面为值 - - - TABLE_KEY_MAP = new HashMap(); + // TODO 改成更好的正则，校验前面为单词，中间为操作符，后面为值 + PATTERN_FUNCTION = Pattern.compile("^[A-Za-z0-9%,:_@&~`!=\\<\\>\\|\\[\\]\\{\\} /\\.\\+\\-\\*\\^\\?\\(\\)\\$]+$"); + + TABLE_SCHEMA_MAP = new HashMap<>(); + TABLE_SCHEMA_MAP.put(Table.class.getSimpleName(), DEFAULT_SCHEMA); + TABLE_SCHEMA_MAP.put(Column.class.getSimpleName(), DEFAULT_SCHEMA); + TABLE_SCHEMA_MAP.put(PgClass.class.getSimpleName(), DEFAULT_SCHEMA); + TABLE_SCHEMA_MAP.put(PgAttribute.class.getSimpleName(), DEFAULT_SCHEMA); + TABLE_SCHEMA_MAP.put(SysTable.class.getSimpleName(), DEFAULT_SCHEMA); + TABLE_SCHEMA_MAP.put(SysColumn.class.getSimpleName(), DEFAULT_SCHEMA); + TABLE_SCHEMA_MAP.put(ExtendedProperty.class.getSimpleName(), DEFAULT_SCHEMA); + TABLE_SCHEMA_MAP.put(AllTable.class.getSimpleName(), DEFAULT_SCHEMA); + TABLE_SCHEMA_MAP.put(AllColumn.class.getSimpleName(), DEFAULT_SCHEMA); + TABLE_SCHEMA_MAP.put(AllTableComment.class.getSimpleName(), DEFAULT_SCHEMA); + TABLE_SCHEMA_MAP.put(AllColumnComment.class.getSimpleName(), DEFAULT_SCHEMA); + + TABLE_KEY_MAP = new HashMap<>(); TABLE_KEY_MAP.put(Table.class.getSimpleName(), Table.TABLE_NAME); TABLE_KEY_MAP.put(Column.class.getSimpleName(), Column.TABLE_NAME); TABLE_KEY_MAP.put(PgClass.class.getSimpleName(), PgClass.TABLE_NAME); @@ -106,12 +130,16 @@ public abstract class AbstractSQLConfig implements SQLConfig { TABLE_KEY_MAP.put(SysTable.class.getSimpleName(), SysTable.TABLE_NAME); TABLE_KEY_MAP.put(SysColumn.class.getSimpleName(), SysColumn.TABLE_NAME); TABLE_KEY_MAP.put(ExtendedProperty.class.getSimpleName(), ExtendedProperty.TABLE_NAME); + TABLE_KEY_MAP.put(AllTable.class.getSimpleName(), AllTable.TABLE_NAME); + TABLE_KEY_MAP.put(AllColumn.class.getSimpleName(), AllColumn.TABLE_NAME); + TABLE_KEY_MAP.put(AllTableComment.class.getSimpleName(), AllTableComment.TABLE_NAME); + TABLE_KEY_MAP.put(AllColumnComment.class.getSimpleName(), AllColumnComment.TABLE_NAME); + + ALLOW_PARTIAL_UPDATE_FAIL_TABLE_MAP = new HashMap<>(); CONFIG_TABLE_LIST = new ArrayList<>(); // Table, Column 等是系统表 AbstractVerifier.SYSTEM_ACCESS_MAP.keySet()); CONFIG_TABLE_LIST.add(Function.class.getSimpleName()); CONFIG_TABLE_LIST.add(Request.class.getSimpleName()); - CONFIG_TABLE_LIST.add(Response.class.getSimpleName()); - CONFIG_TABLE_LIST.add(Test.class.getSimpleName()); CONFIG_TABLE_LIST.add(Access.class.getSimpleName()); CONFIG_TABLE_LIST.add(Document.class.getSimpleName()); CONFIG_TABLE_LIST.add(TestRecord.class.getSimpleName()); @@ -123,14 +151,732 @@ public abstract class AbstractSQLConfig implements SQLConfig { DATABASE_LIST.add(DATABASE_SQLSERVER); DATABASE_LIST.add(DATABASE_ORACLE); DATABASE_LIST.add(DATABASE_DB2); + DATABASE_LIST.add(DATABASE_MARIADB); + DATABASE_LIST.add(DATABASE_TIDB); + DATABASE_LIST.add(DATABASE_COCKROACHDB); + DATABASE_LIST.add(DATABASE_DAMENG); + DATABASE_LIST.add(DATABASE_KINGBASE); + DATABASE_LIST.add(DATABASE_ELASTICSEARCH); + DATABASE_LIST.add(DATABASE_MANTICORE); + DATABASE_LIST.add(DATABASE_CLICKHOUSE); + DATABASE_LIST.add(DATABASE_HIVE); + DATABASE_LIST.add(DATABASE_PRESTO); + DATABASE_LIST.add(DATABASE_TRINO); + DATABASE_LIST.add(DATABASE_MILVUS); + DATABASE_LIST.add(DATABASE_INFLUXDB); + DATABASE_LIST.add(DATABASE_TDENGINE); + DATABASE_LIST.add(DATABASE_TIMESCALEDB); + DATABASE_LIST.add(DATABASE_QUESTDB); + DATABASE_LIST.add(DATABASE_IOTDB); + DATABASE_LIST.add(DATABASE_SNOWFLAKE); + DATABASE_LIST.add(DATABASE_DATABEND); + DATABASE_LIST.add(DATABASE_DATABRICKS); + DATABASE_LIST.add(DATABASE_REDIS); + DATABASE_LIST.add(DATABASE_MONGODB); + DATABASE_LIST.add(DATABASE_CASSANDRA); + DATABASE_LIST.add(DATABASE_KAFKA); + DATABASE_LIST.add(DATABASE_MQ); + DATABASE_LIST.add(DATABASE_DUCKDB); + DATABASE_LIST.add(DATABASE_SURREALDB); + DATABASE_LIST.add(DATABASE_OPENGAUSS); + DATABASE_LIST.add(DATABASE_DORIS); + RAW_MAP = new LinkedHashMap<>(); // 保证顺序，避免配置冲突等意外情况 + + RAW_MAP.put("+", ""); + RAW_MAP.put("-", ""); + RAW_MAP.put("*", ""); + RAW_MAP.put("/", ""); + RAW_MAP.put("=", ""); + RAW_MAP.put("!=", ""); + RAW_MAP.put(">", ""); + RAW_MAP.put(">=", ""); + RAW_MAP.put("<", ""); + RAW_MAP.put("<=", ""); + RAW_MAP.put("%", ""); + RAW_MAP.put("(", ""); + RAW_MAP.put(")", ""); + + RAW_MAP.put("&", ""); // 位运算 + RAW_MAP.put("|", ""); // 位运算 + RAW_MAP.put("^", ""); // 位运算 + RAW_MAP.put("~", ""); // 位运算 + RAW_MAP.put("&=", ""); // 位运算 + RAW_MAP.put("|=", ""); // 位运算 + RAW_MAP.put("~=", ""); // 位运算 + RAW_MAP.put(">>", ""); // 位运算 + RAW_MAP.put("<<", ""); // 位运算 + + // MySQL 关键字 + RAW_MAP.put("AS", ""); + RAW_MAP.put("IS NOT NULL", ""); + RAW_MAP.put("IS NULL", ""); + RAW_MAP.put("IS", ""); + RAW_MAP.put("NULL", ""); + RAW_MAP.put("AND", ""); + RAW_MAP.put("OR", ""); + RAW_MAP.put("NOT", ""); + RAW_MAP.put("VALUE", ""); + RAW_MAP.put("DISTINCT", ""); + RAW_MAP.put("CASE", ""); + RAW_MAP.put("WHEN", ""); + RAW_MAP.put("THEN", ""); + RAW_MAP.put("ELSE", ""); + RAW_MAP.put("END", ""); + + //时间 + RAW_MAP.put("now()", ""); + RAW_MAP.put("DATE", ""); + RAW_MAP.put("TIME", ""); + RAW_MAP.put("DATETIME", ""); + RAW_MAP.put("TIMESTAMP", ""); + RAW_MAP.put("DateTime", ""); + RAW_MAP.put("SECOND", ""); + RAW_MAP.put("MINUTE", ""); + RAW_MAP.put("HOUR", ""); + RAW_MAP.put("DAY", ""); + RAW_MAP.put("WEEK", ""); + RAW_MAP.put("MONTH", ""); + RAW_MAP.put("QUARTER", ""); + RAW_MAP.put("YEAR", ""); + // RAW_MAP.put("json", ""); + // RAW_MAP.put("unit", ""); + + //MYSQL 数据类型 BINARY，CHAR，DATETIME，TIME，DECIMAL，SIGNED，UNSIGNED + RAW_MAP.put("BINARY", ""); + RAW_MAP.put("SIGNED", ""); + RAW_MAP.put("DECIMAL", ""); + RAW_MAP.put("DOUBLE", ""); + RAW_MAP.put("FLOAT", ""); + RAW_MAP.put("BOOLEAN", ""); + RAW_MAP.put("ENUM", ""); + RAW_MAP.put("SET", ""); + RAW_MAP.put("POINT", ""); + RAW_MAP.put("BLOB", ""); + RAW_MAP.put("LONGBLOB", ""); + RAW_MAP.put("UNSIGNED", ""); + RAW_MAP.put("BIT", ""); + RAW_MAP.put("TINYINT", ""); + RAW_MAP.put("SMALLINT", ""); + RAW_MAP.put("INT", ""); + RAW_MAP.put("BIGINT", ""); + RAW_MAP.put("CHAR", ""); + RAW_MAP.put("VARCHAR", ""); + RAW_MAP.put("TEXT", ""); + RAW_MAP.put("LONGTEXT", ""); + RAW_MAP.put("JSON", ""); + + //窗口函数关键字 + RAW_MAP.put("OVER", ""); + RAW_MAP.put("INTERVAL", ""); + RAW_MAP.put("GROUP BY", ""); // 往前 + RAW_MAP.put("GROUP", ""); // 往前 + RAW_MAP.put("ORDER BY", ""); // 往前 + RAW_MAP.put("ORDER", ""); + RAW_MAP.put("PARTITION BY", ""); // 往前 + RAW_MAP.put("PARTITION", ""); // 往前 + RAW_MAP.put("BY", ""); + RAW_MAP.put("DESC", ""); + RAW_MAP.put("ASC", ""); + RAW_MAP.put("PRECEDING", ""); // 往前 + RAW_MAP.put("FOLLOWING", ""); // 往后 + RAW_MAP.put("BETWEEN", ""); + RAW_MAP.put("ROWS", ""); + + RAW_MAP.put("AGAINST", ""); + RAW_MAP.put("IN NATURAL LANGUAGE MODE", ""); + RAW_MAP.put("IN BOOLEAN MODE", ""); + RAW_MAP.put("IN", ""); + RAW_MAP.put("NATURAL", ""); + RAW_MAP.put("LANGUAGE", ""); + RAW_MAP.put("MODE", ""); + + + SQL_AGGREGATE_FUNCTION_MAP = new LinkedHashMap<>(); // 保证顺序，避免配置冲突等意外情况 + SQL_AGGREGATE_FUNCTION_MAP.put("max", ""); // MAX(a, b, c ...) 最大值 + SQL_AGGREGATE_FUNCTION_MAP.put("min", ""); // MIN(a, b, c ...) 最小值 + SQL_AGGREGATE_FUNCTION_MAP.put("avg", ""); // AVG(a, b, c ...) 平均值 + SQL_AGGREGATE_FUNCTION_MAP.put("count", ""); // COUNT(a, b, c ...) 总数 + SQL_AGGREGATE_FUNCTION_MAP.put("sum", ""); // SUM(a, b, c ...) 总和 + + SQL_FUNCTION_MAP = new LinkedHashMap<>(); // 保证顺序，避免配置冲突等意外情况 + + // 窗口函数 + SQL_FUNCTION_MAP.put("rank", ""); // RANK(a, b, c ...) 得到数据项在分组中的排名，排名相等的时候会留下空位 + SQL_FUNCTION_MAP.put("dense_rank", ""); // DENSE_RANK(a, b, c ...) 得到数据项在分组中的排名，排名相等的时候不会留下空位 + SQL_FUNCTION_MAP.put("row_num", ""); // ROW_NUM() 按照分组中的顺序生成序列，不存在重复的序列 + SQL_FUNCTION_MAP.put("row_number", ""); // ROW_NUMBER() 按照分组中的顺序生成序列，不存在重复的序列 + SQL_FUNCTION_MAP.put("ntile", ""); // NTILE(a, b, c ...) 用于将分组数据按照顺序切分成N片，返回当前切片值，不支持ROWS_BETWEE + SQL_FUNCTION_MAP.put("first_value", ""); // FIRST_VALUE() 取分组排序后，截止到当前行，分组内第一个值 + SQL_FUNCTION_MAP.put("last_value", ""); // LAST_VALUE() 取分组排序后，截止到当前行，分组内的最后一个值 + SQL_FUNCTION_MAP.put("lag", ""); // LAG() 统计窗口内往上第n行值。第一个参数为列名，第二个参数为往上第n行（可选，默认为1），第三个参数为默认值（当往上第n行为NULL时候，取默认值，如不指定，则为NULL） + SQL_FUNCTION_MAP.put("lead", ""); // LEAD() 统计窗口内往下第n行值。第一个参数为列名，第二个参数为往下第n行（可选，默认为1），第三个参数为默认值（当往下第n行为NULL时候，取默认值，如不指定，则为NULL） + SQL_FUNCTION_MAP.put("cume_dist", ""); // CUME_DIST() 返回（小于等于当前行值的行数）/（当前分组内的总行数） + SQL_FUNCTION_MAP.put("percent_rank", ""); // PERCENT_RANK(a, b, c ...) 返回（组内当前行的rank值-1）/（分组内做总行数-1） + + // MySQL 字符串函数 + SQL_FUNCTION_MAP.put("ascii", ""); // ASCII(s) 返回字符串 s 的第一个字符的 ASCII 码。 + SQL_FUNCTION_MAP.put("char_length", ""); // CHAR_LENGTH(s) 返回字符串 s 的字符数 + SQL_FUNCTION_MAP.put("character_length", ""); // CHARACTER_LENGTH(s) 返回字符串 s 的字符数 + SQL_FUNCTION_MAP.put("concat", ""); // CONCAT(s1, s2...sn) 字符串 s1,s2 等多个字符串合并为一个字符串 + SQL_FUNCTION_MAP.put("concat_ws", ""); // CONCAT_WS(x, s1, s2...sn) 同 CONCAT(s1, s2 ...) 函数，但是每个字符串之间要加上 x，x 可以是分隔符 + SQL_FUNCTION_MAP.put("field", ""); // FIELD(s, s1, s2...) 返回第一个字符串 s 在字符串列表 (s1, s2...)中的位置 + SQL_FUNCTION_MAP.put("find_in_set", ""); // FIND_IN_SET(s1, s2) 返回在字符串s2中与s1匹配的字符串的位置 + SQL_FUNCTION_MAP.put("format", ""); // FORMAT(x, n) 函数可以将数字 x 进行格式化 "#,###.##", 将 x 保留到小数点后 n 位，最后一位四舍五入。 + SQL_FUNCTION_MAP.put("insert", ""); // INSERT(s1, x, len, s2) 字符串 s2 替换 s1 的 x 位置开始长度为 len 的字符串 + SQL_FUNCTION_MAP.put("locate", ""); // LOCATE(s1, s) 从字符串 s 中获取 s1 的开始位置 + SQL_FUNCTION_MAP.put("lcase", ""); // LCASE(s) 将字符串 s 的所有字母变成小写字母 + SQL_FUNCTION_MAP.put("left", ""); // LEFT(s, n) 返回字符串 s 的前 n 个字符 + SQL_FUNCTION_MAP.put("length", ""); // LENGTH(s) 返回字符串 s 的字符数 + SQL_FUNCTION_MAP.put("lower", ""); // LOWER(s) 将字符串 s 的所有字母变成小写字母 + SQL_FUNCTION_MAP.put("lpad", ""); // LPAD(s1, len, s2) 在字符串 s1 的开始处填充字符串 s2，使字符串长度达到 len + SQL_FUNCTION_MAP.put("ltrim", ""); // LTRIM(s) 去掉字符串 s 开始处的空格 + SQL_FUNCTION_MAP.put("mid", ""); // MID(s, n, len) 从字符串 s 的 n 位置截取长度为 len 的子字符串，同 SUBSTRING(s, n, len) + SQL_FUNCTION_MAP.put("position", ""); // POSITION(s, s1); 从字符串 s 中获取 s1 的开始位置 + SQL_FUNCTION_MAP.put("repeat", ""); // REPEAT(s, n) 将字符串 s 重复 n 次 + SQL_FUNCTION_MAP.put("replace", ""); // REPLACE(s, s1, s2) 将字符串 s2 替代字符串 s 中的字符串 s1 + SQL_FUNCTION_MAP.put("reverse", ""); // REVERSE(s); // ) 将字符串s的顺序反过来 + SQL_FUNCTION_MAP.put("right", ""); // RIGHT(s, n) 返回字符串 s 的后 n 个字符 + SQL_FUNCTION_MAP.put("rpad", ""); // RPAD(s1, len, s2) 在字符串 s1 的结尾处添加字符串 s2，使字符串的长度达到 len + SQL_FUNCTION_MAP.put("rtrim", ""); // RTRIM", ""); // ) 去掉字符串 s 结尾处的空格 + SQL_FUNCTION_MAP.put("space", ""); // SPACE(n) 返回 n 个空格 + SQL_FUNCTION_MAP.put("strcmp", ""); // STRCMP(s1, s2) 比较字符串 s1 和 s2，如果 s1 与 s2 相等返回 0 ，如果 s1>s2 返回 1，如果 s1d2 之间相隔的天数 + SQL_FUNCTION_MAP.put("date_add", ""); // DATE_ADD(d，INTERVAL expr type) 计算起始日期 d 加上一个时间段后的日期 + SQL_FUNCTION_MAP.put("date_format", ""); // DATE_FORMAT(d,f) 按表达式 f的要求显示日期 d + SQL_FUNCTION_MAP.put("date_sub", ""); // DATE_SUB(date,INTERVAL expr type) 函数从日期减去指定的时间间隔。 + SQL_FUNCTION_MAP.put("day", ""); // DAY(d) 返回日期值 d 的日期部分 + SQL_FUNCTION_MAP.put("dayname", ""); // DAYNAME(d) 返回日期 d 是星期几，如 Monday,Tuesday + SQL_FUNCTION_MAP.put("dayofmonth", ""); // DAYOFMONTH(d) 计算日期 d 是本月的第几天 + SQL_FUNCTION_MAP.put("dayofweek", ""); // DAYOFWEEK(d) 日期 d 今天是星期几，1 星期日，2 星期一，以此类推 + SQL_FUNCTION_MAP.put("dayofyear", ""); // DAYOFYEAR(d) 计算日期 d 是本年的第几天 + SQL_FUNCTION_MAP.put("extract", ""); // EXTRACT(type FROM d) 从日期 d 中获取指定的值，type 指定返回的值。 + SQL_FUNCTION_MAP.put("from_days", ""); // FROM_DAYS(n) 计算从 0000 年 1 月 1 日开始 n 天后的日期 + SQL_FUNCTION_MAP.put("hour", ""); // 'HOUR(t) 返回 t 中的小时值 + SQL_FUNCTION_MAP.put("last_day", ""); // LAST_DAY(d) 返回给给定日期的那一月份的最后一天 + SQL_FUNCTION_MAP.put("localtime", ""); // LOCALTIME() 返回当前日期和时间 + SQL_FUNCTION_MAP.put("localtimestamp", ""); // LOCALTIMESTAMP() 返回当前日期和时间 + SQL_FUNCTION_MAP.put("makedate", ""); // MAKEDATE(year, day-of-year) 基于给定参数年份 year 和所在年中的天数序号 day-of-year 返回一个日期 + SQL_FUNCTION_MAP.put("maketime", ""); // MAKETIME(hour, minute, second) 组合时间，参数分别为小时、分钟、秒 + SQL_FUNCTION_MAP.put("microsecond", ""); // MICROSECOND(date) 返回日期参数所对应的微秒数 + SQL_FUNCTION_MAP.put("minute", ""); // MINUTE(t) 返回 t 中的分钟值 + SQL_FUNCTION_MAP.put("monthname", ""); // MONTHNAME(d) 返回日期当中的月份名称，如 November + SQL_FUNCTION_MAP.put("month", ""); // MONTH(d) 返回日期d中的月份值，1 到 12 + SQL_FUNCTION_MAP.put("now", ""); // NOW() 返回当前日期和时间 + SQL_FUNCTION_MAP.put("period_add", ""); // PERIOD_ADD(period, number) 为 年-月 组合日期添加一个时段 + SQL_FUNCTION_MAP.put("period_diff", ""); // PERIOD_DIFF(period1, period2) 返回两个时段之间的月份差值 + SQL_FUNCTION_MAP.put("quarter", ""); // QUARTER(d) 返回日期d是第几季节，返回 1 到 4 + SQL_FUNCTION_MAP.put("second", ""); // SECOND(t) 返回 t 中的秒钟值 + SQL_FUNCTION_MAP.put("sec_to_time", ""); // SEC_TO_TIME(sec, format); // ) 将以秒为单位的时间 s 转换为时分秒的格式 + SQL_FUNCTION_MAP.put("str_to_date", ""); // STR_TO_DATE(string, format) 将字符串转变为日期 + SQL_FUNCTION_MAP.put("subdate", ""); // SUBDATE(d,n) 日期 d 减去 n 天后的日期 + SQL_FUNCTION_MAP.put("subtime", ""); // SUBTIME(t,n) 时间 t 减去 n 秒的时间 + SQL_FUNCTION_MAP.put("sysdate", ""); // SYSDATE() 返回当前日期和时间 + SQL_FUNCTION_MAP.put("time", ""); // TIME(expression) 提取传入表达式的时间部分 + SQL_FUNCTION_MAP.put("time_format", ""); // TIME_FORMAT(t,f) 按表达式 f 的要求显示时间 t + SQL_FUNCTION_MAP.put("time_to_sec", ""); // TIME_TO_SEC(t) 将时间 t 转换为秒 + SQL_FUNCTION_MAP.put("timediff", ""); // TIMEDIFF(time1, time2) 计算时间差值 + SQL_FUNCTION_MAP.put("timestamp", ""); // TIMESTAMP(expression, interval) 单个参数时，函数返回日期或日期时间表达式；有2个参数时，将参数加和 + SQL_FUNCTION_MAP.put("to_days", ""); // TO_DAYS(d) 计算日期 d 距离 0000 年 1 月 1 日的天数 + SQL_FUNCTION_MAP.put("week", ""); // WEEK(d) 计算日期 d 是本年的第几个星期，范围是 0 到 53 + SQL_FUNCTION_MAP.put("weekday", ""); // WEEKDAY(d) 日期 d 是星期几，0 表示星期一，1 表示星期二 + SQL_FUNCTION_MAP.put("weekofyear", ""); // WEEKOFYEAR(d) 计算日期 d 是本年的第几个星期，范围是 0 到 53 + SQL_FUNCTION_MAP.put("year", ""); // YEAR(d) 返回年份 + SQL_FUNCTION_MAP.put("yearweek", ""); // YEARWEEK(date, mode) 返回年份及第几周（0到53），mode 中 0 表示周天，1表示周一，以此类推 + SQL_FUNCTION_MAP.put("unix_timestamp", ""); // UNIX_TIMESTAMP(date) 获取UNIX时间戳函数，返回一个以 UNIX 时间戳为基础的无符号整数 + SQL_FUNCTION_MAP.put("from_unixtime", ""); // FROM_UNIXTIME(date) 将 UNIX 时间戳转换为时间格式，与UNIX_TIMESTAMP互为反函数 + + // MYSQL JSON 函数 + SQL_FUNCTION_MAP.put("json_append", ""); // JSON_APPEND(json_doc, path, val[, path, val] ...)) 插入JSON数组 + SQL_FUNCTION_MAP.put("json_array", ""); // JSON_ARRAY(val1, val2...) 创建JSON数组 + SQL_FUNCTION_MAP.put("json_array_append", ""); // JSON_ARRAY_APPEND(json_doc, val) 将数据附加到JSON文档 + SQL_FUNCTION_MAP.put("json_array_insert", ""); // JSON_ARRAY_INSERT(json_doc, val) 插入JSON数组 + SQL_FUNCTION_MAP.put("json_array_get", ""); // JSON_ARRAY_GET(json_doc, position) 从JSON数组提取指定位置的元素 + SQL_FUNCTION_MAP.put("json_contains", ""); // JSON_CONTAINS(json_doc, val) JSON文档是否在路径中包含特定对象 + SQL_FUNCTION_MAP.put("json_array_contains", ""); // JSON_ARRAY_CONTAINS(json_doc, path) JSON文档是否在路径中包含特定对象 + SQL_FUNCTION_MAP.put("json_contains_path", ""); // JSON_CONTAINS_PATH(json_doc, path) JSON文档是否在路径中包含任何数据 + SQL_FUNCTION_MAP.put("json_depth", ""); // JSON_DEPTH(json_doc) JSON文档的最大深度 + SQL_FUNCTION_MAP.put("json_extract", ""); // JSON_EXTRACT(json_doc, path) 从JSON文档返回数据 + SQL_FUNCTION_MAP.put("json_extract_scalar", ""); // JSON_EXTRACT_SCALAR(json_doc, path) 从JSON文档返回基础类型数据，例如 Boolean, Number, String + SQL_FUNCTION_MAP.put("json_insert", ""); // JSON_INSERT(json_doc, val) 将数据插入JSON文档 + SQL_FUNCTION_MAP.put("json_keys", ""); // JSON_KEYS(json_doc[, path]) JSON文档中的键数组 + SQL_FUNCTION_MAP.put("json_length", ""); // JSON_LENGTH(json_doc) JSON文档中的元素数 + SQL_FUNCTION_MAP.put("json_size", ""); // JSON_SIZE(json_doc) JSON文档中的元素数 + SQL_FUNCTION_MAP.put("json_array_length", ""); // JSON_ARRAY_LENGTH(json_doc) JSON文档中的元素数 + SQL_FUNCTION_MAP.put("json_format", ""); // JSON_FORMAT(json_doc) 格式化 JSON + SQL_FUNCTION_MAP.put("json_parse", ""); // JSON_PARSE(val) 转换为 JSON + SQL_FUNCTION_MAP.put("json_merge", ""); // JSON_MERGE(json_doc1, json_doc2) （已弃用） 合并JSON文档，保留重复的键。JSON_MERGE_PRESERVE（）的已弃用同义词 + SQL_FUNCTION_MAP.put("json_merge_patch", ""); // JSON_MERGE_PATCH(json_doc1, json_doc2) 合并JSON文档，替换重复键的值 + SQL_FUNCTION_MAP.put("json_merge_preserve", ""); // JSON_MERGE_PRESERVE(json_doc1, json_doc2) 合并JSON文档，保留重复的键 + SQL_FUNCTION_MAP.put("json_object", ""); // JSON_OBJECT(key1, val1, key2, val2...) 创建JSON对象 + SQL_FUNCTION_MAP.put("json_overlaps", ""); // JSON_OVERLAPS(json_doc1, json_doc2) （引入8.0.17） 比较两个JSON文档，如果它们具有相同的键值对或数组元素，则返回TRUE（1），否则返回FALSE（0） + SQL_FUNCTION_MAP.put("json_pretty", ""); // JSON_PRETTY(json_doc) 以易于阅读的格式打印JSON文档 + SQL_FUNCTION_MAP.put("json_quote", ""); // JSON_QUOTE(json_doc1) 引用JSON文档 + SQL_FUNCTION_MAP.put("json_remove", ""); // JSON_REMOVE(json_doc1, path) 从JSON文档中删除数据 + SQL_FUNCTION_MAP.put("json_replace", ""); // JSON_REPLACE(json_doc1, val1, val2) 替换JSON文档中的值 + SQL_FUNCTION_MAP.put("json_schema_valid", ""); // JSON_SCHEMA_VALID(json_doc) （引入8.0.17） 根据JSON模式验证JSON文档；如果文档针对架构进行验证，则返回TRUE / 1；否则，则返回FALSE / 0 + SQL_FUNCTION_MAP.put("json_schema_validation_report", ""); // JSON_SCHEMA_VALIDATION_REPORT(json_doc, mode) （引入8.0.17） 根据JSON模式验证JSON文档；以JSON格式返回有关验证结果的报告，包括成功或失败以及失败原因 + SQL_FUNCTION_MAP.put("json_search", ""); // JSON_SEARCH(json_doc, val) JSON文档中值的路径 + SQL_FUNCTION_MAP.put("json_set", ""); // JSON_SET(json_doc, val) 将数据插入JSON文档 + // SQL_FUNCTION_MAP.put("json_storage_free", ""); // JSON_STORAGE_FREE() 部分更新后，JSON列值的二进制表示形式中的可用空间 + // SQL_FUNCTION_MAP.put("json_storage_size", ""); // JSON_STORAGE_SIZE() 用于存储JSON文档的二进制表示的空间 + SQL_FUNCTION_MAP.put("json_table", ""); // JSON_TABLE() 从JSON表达式返回数据作为关系表 + SQL_FUNCTION_MAP.put("json_type", ""); // JSON_TYPE(json_doc) JSON值类型 + SQL_FUNCTION_MAP.put("json_unquote", ""); // JSON_UNQUOTE(json_doc) 取消引用JSON值 + SQL_FUNCTION_MAP.put("json_valid", ""); // JSON_VALID(json_doc) JSON值是否有效 + SQL_FUNCTION_MAP.put("json_arrayagg", ""); // JSON_ARRAYAGG(key) 将每个表达式转换为 JSON 值，然后返回一个包含这些 JSON 值的 JSON 数组 + SQL_FUNCTION_MAP.put("json_objectagg", ""); // JSON_OBJECTAGG(key, val)) 将每个表达式转换为 JSON 值，然后返回一个包含这些 JSON 值的 JSON 对象 + SQL_FUNCTION_MAP.put("is_json_scalar", ""); // IS_JSON_SCALAR(val)) 是否为JSON基本类型，例如 Boolean, Number, String + + // MySQL 高级函数 + // SQL_FUNCTION_MAP.put("bin", ""); // BIN(x) 返回 x 的二进制编码 + // SQL_FUNCTION_MAP.put("binary", ""); // BINARY(s) 将字符串 s 转换为二进制字符串 + SQL_FUNCTION_MAP.put("case", ""); // CASE 表示函数开始，END 表示函数结束。如果 condition1 成立，则返回 result1, 如果 condition2 成立，则返回 result2，当全部不成立则返回 result，而当有一个成立之后，后面的就不执行了。 + SQL_FUNCTION_MAP.put("cast", ""); // CAST(x AS type) 转换数据类型 + SQL_FUNCTION_MAP.put("coalesce", ""); // COALESCE(expr1, expr2, ...., expr_n) 返回参数中的第一个非空表达式（从左向右） + // SQL_FUNCTION_MAP.put("conv", ""); // CONV(x,f1,f2) 返回 f1 进制数变成 f2 进制数 + // SQL_FUNCTION_MAP.put("convert", ""); // CONVERT(s, cs) 函数将字符串 s 的字符集变成 cs + SQL_FUNCTION_MAP.put("if", ""); // IF(expr,v1,v2) 如果表达式 expr 成立，返回结果 v1；否则，返回结果 v2。 + SQL_FUNCTION_MAP.put("ifnull", ""); // IFNULL(v1,v2) 如果 v1 的值不为 NULL，则返回 v1，否则返回 v2。 + SQL_FUNCTION_MAP.put("isnull", ""); // ISNULL(expression) 判断表达式是否为 NULL + SQL_FUNCTION_MAP.put("nullif", ""); // NULLIF(expr1, expr2) 比较两个字符串，如果字符串 expr1 与 expr2 相等 返回 NULL，否则返回 expr1 + SQL_FUNCTION_MAP.put("group_concat", ""); // GROUP_CONCAT([DISTINCT], s1, s2...) 聚合拼接字符串 + SQL_FUNCTION_MAP.put("match", ""); // MATCH (name,tag) AGAINST ('a b' IN NATURAL LANGUAGE MODE) 全文检索 + SQL_FUNCTION_MAP.put("any_value", ""); // any_value(userId) 解决 ONLY_FULL_GROUP_BY 报错 + + + // ClickHouse 字符串函数 注释的函数表示返回的格式暂时不支持，如：返回数组 ，同时包含因版本不同 clickhosue不支持的函数，版本 + SQL_FUNCTION_MAP.put("empty", ""); // empty(s) 对于空字符串s返回1，对于非空字符串返回0 + SQL_FUNCTION_MAP.put("notEmpty", ""); // notEmpty(s) 对于空字符串返回0，对于非空字符串返回1。 + SQL_FUNCTION_MAP.put("lengthUTF8", ""); // 假定字符串以UTF-8编码组成的文本，返回此字符串的Unicode字符长度。如果传入的字符串不是UTF-8编码，则函数可能返回一个预期外的值 + SQL_FUNCTION_MAP.put("lcase", ""); // 将字符串中的ASCII转换为小写 + SQL_FUNCTION_MAP.put("ucase", ""); // 将字符串中的ASCII转换为大写。 + SQL_FUNCTION_MAP.put("lowerUTF8", ""); // 将字符串转换为小写，函数假设字符串是以UTF-8编码文本的字符集。 + SQL_FUNCTION_MAP.put("upperUTF8", ""); // 将字符串转换为大写，函数假设字符串是以UTF-8编码文本的字符集。 + SQL_FUNCTION_MAP.put("isValidUTF8", ""); // 检查字符串是否为有效的UTF-8编码，是则返回1，否则返回0。 + SQL_FUNCTION_MAP.put("toValidUTF8", ""); // 用（U+FFFD）字符替换无效的UTF-8字符。所有连续的无效字符都会被替换为一个替换字符。 + SQL_FUNCTION_MAP.put("reverseUTF8", ""); // 以Unicode字符为单位反转UTF-8编码的字符串。 + SQL_FUNCTION_MAP.put("concatAssumeInjective", ""); // concatAssumeInjective(s1, s2, …) 与concat相同，区别在于，你需要保证concat(s1, s2, s3) -> s4是单射的，它将用于GROUP BY的优化。 + SQL_FUNCTION_MAP.put("substringUTF8", ""); // substringUTF8(s,offset,length)¶ 与’substring’相同，但其操作单位为Unicode字符，函数假设字符串是以UTF-8进行编码的文本。如果不是则可能返回一个预期外的结果（不会抛出异常）。 + SQL_FUNCTION_MAP.put("appendTrailingCharIfAbsent", ""); // appendTrailingCharIfAbsent(s,c) 如果’s’字符串非空并且末尾不包含’c’字符，则将’c’字符附加到末尾 + SQL_FUNCTION_MAP.put("convertCharset", ""); // convertCharset(s,from,to) 返回从’from’中的编码转换为’to’中的编码的字符串’s’。 + SQL_FUNCTION_MAP.put("base64Encode", ""); // base64Encode(s) 将字符串’s’编码成base64 + SQL_FUNCTION_MAP.put("base64Decode", ""); // base64Decode(s) 使用base64将字符串解码成原始字符串。如果失败则抛出异常。 + SQL_FUNCTION_MAP.put("tryBase64Decode", ""); // tryBase64Decode(s) 使用base64将字符串解码成原始字符串。但如果出现错误，将返回空字符串。 + SQL_FUNCTION_MAP.put("endsWith", ""); // endsWith(s,后缀) 返回是否以指定的后缀结尾。如果字符串以指定的后缀结束，则返回1，否则返回0。 + SQL_FUNCTION_MAP.put("startsWith", ""); // startsWith（s，前缀) 返回是否以指定的前缀开头。如果字符串以指定的前缀开头，则返回1，否则返回0。 + SQL_FUNCTION_MAP.put("trimLeft", ""); // trimLeft(s)返回一个字符串，用于删除左侧的空白字符。 + SQL_FUNCTION_MAP.put("trimRight", ""); // trimRight(s) 返回一个字符串，用于删除右侧的空白字符。 + SQL_FUNCTION_MAP.put("trimBoth", ""); // trimBoth(s)，用于删除任一侧的空白字符 + SQL_FUNCTION_MAP.put("extractAllGroups", ""); // extractAllGroups(text, regexp) 从正则表达式匹配的非重叠子字符串中提取所有组 + // SQL_FUNCTION_MAP.put("leftPad", ""); // leftPad('string', 'length'[, 'pad_string']) 用空格或指定的字符串从左边填充当前字符串(如果需要，可以多次)，直到得到的字符串达到给定的长度 + // SQL_FUNCTION_MAP.put("leftPadUTF8", ""); // leftPadUTF8('string','length'[, 'pad_string']) 用空格或指定的字符串从左边填充当前字符串(如果需要，可以多次)，直到得到的字符串达到给定的长度 + // SQL_FUNCTION_MAP.put("rightPad", ""); // rightPad('string', 'length'[, 'pad_string']) 用空格或指定的字符串(如果需要，可以多次)从右边填充当前字符串，直到得到的字符串达到给定的长度 + // SQL_FUNCTION_MAP.put("rightPadUTF8", "");// rightPadUTF8('string','length'[, 'pad_string']) 用空格或指定的字符串(如果需要，可以多次)从右边填充当前字符串，直到得到的字符串达到给定的长度。 + SQL_FUNCTION_MAP.put("normalizeQuery", ""); // normalizeQuery(x) 用占位符替换文字、文字序列和复杂的别名。 + SQL_FUNCTION_MAP.put("normalizedQueryHash", ""); // normalizedQueryHash(x) 为类似查询返回相同的64位散列值，但不包含文字值。有助于对查询日志进行分析 + SQL_FUNCTION_MAP.put("positionUTF8", ""); // positionUTF8(s, needle[, start_pos]) 返回在字符串中找到的子字符串的位置(以Unicode点表示)，从1开始。 + SQL_FUNCTION_MAP.put("multiSearchFirstIndex", ""); // multiSearchFirstIndex(s, [needle1, needle2, …, needlen]) 返回字符串s中最左边的needlei的索引i(从1开始)，否则返回0 + SQL_FUNCTION_MAP.put("multiSearchAny", ""); // multiSearchAny(s, [needle1, needle2, …, needlen])如果至少有一个字符串needlei匹配字符串s，则返回1，否则返回0。 + SQL_FUNCTION_MAP.put("match", ""); // match(s, pattern) 检查字符串是否与模式正则表达式匹配。re2正则表达式。re2正则表达式的语法比Perl正则表达式的语法更有局限性。 + SQL_FUNCTION_MAP.put("multiMatchAny", ""); // multiMatchAny(s, [pattern1, pattern2, …, patternn]) 与match相同，但是如果没有匹配的正则表达式返回0，如果有匹配的模式返回1 + SQL_FUNCTION_MAP.put("multiMatchAnyIndex", ""); // multiMatchAnyIndex(s, [pattern1, pattern2, …, patternn]) 与multiMatchAny相同，但返回与干堆匹配的任何索引 + SQL_FUNCTION_MAP.put("extract", ""); // extract(s, pattern) 使用正则表达式提取字符串的片段 + SQL_FUNCTION_MAP.put("extractAll", ""); // extractAll(s, pattern) 使用正则表达式提取字符串的所有片段 + SQL_FUNCTION_MAP.put("like", ""); // like(s, pattern) 检查字符串是否与简单正则表达式匹配 + SQL_FUNCTION_MAP.put("notLike", ""); // 和‘like’是一样的，但是是否定的 + SQL_FUNCTION_MAP.put("countSubstrings", ""); // countSubstrings(s, needle[, start_pos])返回子字符串出现的次数 + SQL_FUNCTION_MAP.put("countMatches", ""); // 返回干s中的正则表达式匹配数。countMatches(s, pattern) + SQL_FUNCTION_MAP.put("replaceOne", ""); // replaceOne(s, pattern, replacement)将' s '中的' pattern '子串的第一个出现替换为' replacement '子串。 + + SQL_FUNCTION_MAP.put("replaceAll", ""); // replaceAll(s, pattern, replacement)/用' replacement '子串替换' s '中所有出现的' pattern '子串 + SQL_FUNCTION_MAP.put("replaceRegexpOne", ""); // replaceRegexpOne(s, pattern, replacement)使用' pattern '正则表达式进行替换 + SQL_FUNCTION_MAP.put("replaceRegexpAll", ""); // replaceRegexpAll(s, pattern, replacement) + SQL_FUNCTION_MAP.put("regexpQuoteMeta", ""); // regexpQuoteMeta(s)该函数在字符串中某些预定义字符之前添加一个反斜杠 + + // clickhouse日期函数 + SQL_FUNCTION_MAP.put("toYear", ""); // 将Date或DateTime转换为包含年份编号（AD）的UInt16类型的数字。 + SQL_FUNCTION_MAP.put("toQuarter", ""); // 将Date或DateTime转换为包含季度编号的UInt8类型的数字。 + SQL_FUNCTION_MAP.put("toMonth", ""); // Date或DateTime转换为包含月份编号（1-12）的UInt8类型的数字。 + SQL_FUNCTION_MAP.put("toDayOfYear", ""); // 将Date或DateTime转换为包含一年中的某一天的编号的UInt16（1-366）类型的数字。 + SQL_FUNCTION_MAP.put("toDayOfMonth", "");// 将Date或DateTime转换为包含一月中的某一天的编号的UInt8（1-31）类型的数字。 + SQL_FUNCTION_MAP.put("toDayOfWeek", ""); // 将Date或DateTime转换为包含一周中的某一天的编号的UInt8（周一是1, 周日是7）类型的数字。 + SQL_FUNCTION_MAP.put("toHour", ""); // 将DateTime转换为包含24小时制（0-23）小时数的UInt8数字。 + SQL_FUNCTION_MAP.put("toMinute", ""); // 将DateTime转换为包含一小时中分钟数（0-59）的UInt8数字。 + SQL_FUNCTION_MAP.put("toSecond", ""); // 将DateTime转换为包含一分钟中秒数（0-59）的UInt8数字。 + SQL_FUNCTION_MAP.put("toUnixTimestamp", ""); // 对于DateTime参数：将值转换为UInt32类型的数字-Unix时间戳 + SQL_FUNCTION_MAP.put("toStartOfYear", ""); // 将Date或DateTime向前取整到本年的第一天。 + SQL_FUNCTION_MAP.put("toStartOfISOYear", ""); // 将Date或DateTime向前取整到ISO本年的第一天。 + SQL_FUNCTION_MAP.put("toStartOfQuarter", "");// 将Date或DateTime向前取整到本季度的第一天。 + SQL_FUNCTION_MAP.put("toStartOfMonth", ""); // 将Date或DateTime向前取整到本月的第一天。 + SQL_FUNCTION_MAP.put("toMonday", ""); // 将Date或DateTime向前取整到本周的星期 + SQL_FUNCTION_MAP.put("toStartOfWeek", ""); // 按mode将Date或DateTime向前取整到最近的星期日或星期一。 + SQL_FUNCTION_MAP.put("toStartOfDay", ""); // 将DateTime向前取整到今天的开始。 + SQL_FUNCTION_MAP.put("toStartOfHour", ""); // 将DateTime向前取整到当前小时的开始。 + SQL_FUNCTION_MAP.put("toStartOfMinute", ""); // 将DateTime向前取整到当前分钟的开始。 + SQL_FUNCTION_MAP.put("toStartOfSecond", ""); // 将DateTime向前取整到当前秒数的开始。 + SQL_FUNCTION_MAP.put("toStartOfFiveMinute", "");// 将DateTime以五分钟为单位向前取整到最接近的时间点。 + SQL_FUNCTION_MAP.put("toStartOfTenMinutes", ""); // 将DateTime以十分钟为单位向前取整到最接近的时间点。 + SQL_FUNCTION_MAP.put("toStartOfFifteenMinutes", ""); // 将DateTime以十五分钟为单位向前取整到最接近的时间点。 + SQL_FUNCTION_MAP.put("toStartOfInterval", ""); // + SQL_FUNCTION_MAP.put("toTime", ""); // 将DateTime中的日期转换为一个固定的日期，同时保留时间部分。 + SQL_FUNCTION_MAP.put("toISOYear", ""); // 将Date或DateTime转换为包含ISO年份的UInt16类型的编号。 + SQL_FUNCTION_MAP.put("toISOWeek", ""); // + SQL_FUNCTION_MAP.put("toWeek", "");// 返回Date或DateTime的周数。 + SQL_FUNCTION_MAP.put("toYearWeek", ""); // 返回年和周的日期 + SQL_FUNCTION_MAP.put("date_trunc", ""); // 截断日期和时间数据到日期的指定部分 + SQL_FUNCTION_MAP.put("date_diff", ""); // 回两个日期或带有时间值的日期之间的差值。 + + SQL_FUNCTION_MAP.put("yesterday", ""); // 不接受任何参数并在请求执行时的某一刻返回昨天的日期(Date)。 + SQL_FUNCTION_MAP.put("today", ""); // 不接受任何参数并在请求执行时的某一刻返回当前日期(Date)。 + SQL_FUNCTION_MAP.put("timeSlot", ""); // 将时间向前取整半小时。 + SQL_FUNCTION_MAP.put("toYYYYMM", ""); // + SQL_FUNCTION_MAP.put("toYYYYMMDD", "");// + SQL_FUNCTION_MAP.put("toYYYYMMDDhhmmss", ""); // + SQL_FUNCTION_MAP.put("addYears", ""); // Function adds a Date/DateTime interval to a Date/DateTime and then return the Date/DateTime + SQL_FUNCTION_MAP.put("addMonths", ""); // 同上 + SQL_FUNCTION_MAP.put("addWeeks", ""); // 同上 + SQL_FUNCTION_MAP.put("addDays", ""); // 同上 + SQL_FUNCTION_MAP.put("addHours", ""); // 同上 + SQL_FUNCTION_MAP.put("addMinutes", "");// 同上 + SQL_FUNCTION_MAP.put("addSeconds", ""); // 同上 + SQL_FUNCTION_MAP.put("addQuarters", ""); // 同上 + SQL_FUNCTION_MAP.put("subtractYears", ""); // Function subtract a Date/DateTime interval to a Date/DateTime and then return the Date/DateTime + SQL_FUNCTION_MAP.put("subtractMonths", ""); // 同上 + SQL_FUNCTION_MAP.put("subtractWeeks", ""); // 同上 + SQL_FUNCTION_MAP.put("subtractDays", ""); // 同上 + SQL_FUNCTION_MAP.put("subtractours", "");// 同上 + SQL_FUNCTION_MAP.put("subtractMinutes", ""); // 同上 + SQL_FUNCTION_MAP.put("subtractSeconds", ""); // 同上 + SQL_FUNCTION_MAP.put("subtractQuarters", ""); // 同上 + SQL_FUNCTION_MAP.put("formatDateTime", ""); // 函数根据给定的格式字符串来格式化时间 + SQL_FUNCTION_MAP.put("timestamp_add", ""); // 使用提供的日期或日期时间值添加指定的时间值。 + SQL_FUNCTION_MAP.put("timestamp_sub", ""); // 从提供的日期或带时间的日期中减去时间间隔。 + + // ClickHouse json函数 + SQL_FUNCTION_MAP.put("visitParamHas", ""); // visitParamHas(params, name)检查是否存在«name»名称的字段 + SQL_FUNCTION_MAP.put("visitParamExtractUInt", ""); // visitParamExtractUInt(params, name)将名为«name»的字段的值解析成UInt64。 + SQL_FUNCTION_MAP.put("visitParamExtractInt", ""); // 与visitParamExtractUInt相同，但返回Int64。 + SQL_FUNCTION_MAP.put("visitParamExtractFloat", ""); // 与visitParamExtractUInt相同，但返回Float64。 + SQL_FUNCTION_MAP.put("visitParamExtractBool", "");// 解析true/false值。其结果是UInt8类型的。 + SQL_FUNCTION_MAP.put("visitParamExtractRaw", ""); // 返回字段的值，包含空格符。 + SQL_FUNCTION_MAP.put("visitParamExtractString", ""); // 使用双引号解析字符串。这个值没有进行转义。如果转义失败，它将返回一个空白字符串。 + SQL_FUNCTION_MAP.put("JSONHas", ""); // 如果JSON中存在该值，则返回1。 + SQL_FUNCTION_MAP.put("JSONLength", ""); // 返回JSON数组或JSON对象的长度。 + SQL_FUNCTION_MAP.put("JSONType", ""); // 返回JSON值的类型。 + SQL_FUNCTION_MAP.put("JSONExtractUInt", ""); // 解析JSON并提取值。这些函数类似于visitParam*函数。 + SQL_FUNCTION_MAP.put("JSONExtractInt", ""); // + SQL_FUNCTION_MAP.put("JSONExtractFloat", ""); // + SQL_FUNCTION_MAP.put("JSONExtractBool", ""); // + SQL_FUNCTION_MAP.put("JSONExtractString", ""); // 解析JSON并提取字符串。此函数类似于visitParamExtractString函数。 + SQL_FUNCTION_MAP.put("JSONExtract", ""); // 解析JSON并提取给定ClickHouse数据类型的值。 + SQL_FUNCTION_MAP.put("JSONExtractKeysAndValues", ""); // 从JSON中解析键值对，其中值是给定的ClickHouse数据类型 + SQL_FUNCTION_MAP.put("JSONExtractRaw", ""); // 返回JSON的部分。 + SQL_FUNCTION_MAP.put("toJSONString", ""); // + + // ClickHouse 类型转换函数 + SQL_FUNCTION_MAP.put("toInt8", ""); // toInt8(expr) 转换一个输入值为Int类型 + SQL_FUNCTION_MAP.put("toInt16", ""); + SQL_FUNCTION_MAP.put("toInt32", ""); + SQL_FUNCTION_MAP.put("toInt64", ""); + SQL_FUNCTION_MAP.put("toInt8OrZero", ""); // toInt(8|16|32|64)OrZero 尝试把字符串转为 Int + SQL_FUNCTION_MAP.put("toInt16OrZero", ""); + SQL_FUNCTION_MAP.put("toInt32OrZero", ""); + SQL_FUNCTION_MAP.put("toInt64OrZero", ""); + SQL_FUNCTION_MAP.put("toInt8OrNull", "");// toInt(8|16|32|64)O 尝试把字符串转为 Int + SQL_FUNCTION_MAP.put("toInt16OrNull", ""); + SQL_FUNCTION_MAP.put("toInt32OrNull", ""); + SQL_FUNCTION_MAP.put("toInt64OrNull", ""); + SQL_FUNCTION_MAP.put("toUInt8", ""); // toInt8(expr) 转换一个输入值为Int类型 + SQL_FUNCTION_MAP.put("toUInt16", ""); + SQL_FUNCTION_MAP.put("toUInt32", ""); + SQL_FUNCTION_MAP.put("toUInt64", ""); + SQL_FUNCTION_MAP.put("toUInt8OrZero", ""); // toInt(8|16|32|64)OrZero 尝试把字符串转为 Int + SQL_FUNCTION_MAP.put("toUInt16OrZero", ""); + SQL_FUNCTION_MAP.put("toUInt32OrZero", ""); + SQL_FUNCTION_MAP.put("toUInt64OrZero", ""); + SQL_FUNCTION_MAP.put("toUInt8OrNull", ""); // toInt(8|16|32|64)OrNull 尝试把字符串转为 Int + SQL_FUNCTION_MAP.put("toUInt16OrNull", ""); + SQL_FUNCTION_MAP.put("toUInt32OrNull", ""); + SQL_FUNCTION_MAP.put("toUInt64OrNull", ""); + + SQL_FUNCTION_MAP.put("toFloat32", ""); + SQL_FUNCTION_MAP.put("toFloat64", ""); + SQL_FUNCTION_MAP.put("toFloat32OrZero", ""); + SQL_FUNCTION_MAP.put("toFloat64OrZero", ""); + SQL_FUNCTION_MAP.put("toFloat32OrNull", ""); + SQL_FUNCTION_MAP.put("toFloat64OrNull", ""); + + SQL_FUNCTION_MAP.put("toDate", ""); // + SQL_FUNCTION_MAP.put("toDateOrZero", ""); // toInt16(expr) + SQL_FUNCTION_MAP.put("toDateOrNull", ""); // toInt32(expr) + SQL_FUNCTION_MAP.put("toDateTimeOrZero", ""); // toInt64(expr) 尝试把字符串转为 DateTime + SQL_FUNCTION_MAP.put("toDateTimeOrNull", ""); // toInt(8|16|32|64) 尝试把字符串转为 DateTime + + SQL_FUNCTION_MAP.put("toDecimal32", ""); + SQL_FUNCTION_MAP.put("toFixedString", ""); // 将String类型的参数转换为FixedString(N)类型的值 + SQL_FUNCTION_MAP.put("toStringCutToZero", ""); // 接受String或FixedString参数,返回String，其内容在找到的第一个零字节处被截断。 + SQL_FUNCTION_MAP.put("toDecimal256", ""); + SQL_FUNCTION_MAP.put("toDecimal32OrNull", ""); + SQL_FUNCTION_MAP.put("toDecimal64OrNull", ""); + SQL_FUNCTION_MAP.put("toDecimal128OrNull", ""); + SQL_FUNCTION_MAP.put("toDecimal256OrNull", ""); + SQL_FUNCTION_MAP.put("toDecimal32OrZero", ""); + SQL_FUNCTION_MAP.put("toDecimal64OrZero", ""); + SQL_FUNCTION_MAP.put("toDecimal128OrZero", ""); + SQL_FUNCTION_MAP.put("toDecimal256OrZero", ""); + + SQL_FUNCTION_MAP.put("toIntervalSecond", ""); // 把一个数值类型的值转换为Interval类型的数据。 + SQL_FUNCTION_MAP.put("toIntervalMinute", ""); + SQL_FUNCTION_MAP.put("toIntervalHour", ""); + SQL_FUNCTION_MAP.put("toIntervalDay", ""); + SQL_FUNCTION_MAP.put("toIntervalWeek", ""); + SQL_FUNCTION_MAP.put("toIntervalMonth", ""); + SQL_FUNCTION_MAP.put("toIntervalQuarter", ""); + SQL_FUNCTION_MAP.put("toIntervalYear", ""); + SQL_FUNCTION_MAP.put("parseDateTimeBestEffort", ""); // 把String类型的时间日期转换为DateTime数据类型。 + SQL_FUNCTION_MAP.put("parseDateTimeBestEffortOrNull", ""); + SQL_FUNCTION_MAP.put("parseDateTimeBestEffortOrZero", ""); + SQL_FUNCTION_MAP.put("toLowCardinality", ""); + + + // ClickHouse hash 函数 + SQL_FUNCTION_MAP.put("halfMD5", ""); // 计算字符串的MD5。然后获取结果的前8个字节并将它们作为UInt64（大端）返回 + SQL_FUNCTION_MAP.put("MD5", ""); // 计算字符串的MD5并将结果放入FixedString(16)中返回 + + // ClickHouse ip 地址函数 + SQL_FUNCTION_MAP.put("IPv4NumToString", ""); // 接受一个 UInt32（大端）表示的IPv4的地址，返回相应IPv4的字符串表现形式 + SQL_FUNCTION_MAP.put("IPv4StringToNum", ""); // 与IPv4NumToString函数相反。如果IPv4地址格式无效，则返回0。 + SQL_FUNCTION_MAP.put("IPv6NumToString", ""); // 接受FixedString(16)类型的二进制格式的IPv6地址。以文本格式返回此地址的字符串。 + SQL_FUNCTION_MAP.put("IPv6StringToNum", ""); // 与IPv6NumToString的相反。如果IPv6地址格式无效，则返回空字节字符串。 + SQL_FUNCTION_MAP.put("IPv4ToIPv6", ""); // 接受一个UInt32类型的IPv4地址，返回FixedString(16)类型的IPv6地址 + SQL_FUNCTION_MAP.put("cutIPv6", ""); // 接受一个FixedString(16)类型的IPv6地址，返回 String，包含删除指定位之后的地址的文本格 + SQL_FUNCTION_MAP.put("toIPv4", ""); // IPv4StringToNum()的别名， + SQL_FUNCTION_MAP.put("toIPv6", ""); // IPv6StringToNum()的别名 + SQL_FUNCTION_MAP.put("isIPAddressInRange", ""); // 确定一个IP地址是否包含在以CIDR符号表示的网络中 + + // ClickHouse Nullable 处理函数 + SQL_FUNCTION_MAP.put("isNull", ""); // 检查参数是否为NULL。 + SQL_FUNCTION_MAP.put("isNotNull", ""); // 检查参数是否不为 NULL. + SQL_FUNCTION_MAP.put("ifNull", ""); // 如果第一个参数为«NULL»，则返回第二个参数的值。 + SQL_FUNCTION_MAP.put("assumeNotNull", ""); // 将可为空类型的值转换为非Nullable类型的值。 + SQL_FUNCTION_MAP.put("toNullable", ""); // 将参数的类型转换为Nullable。 + + // ClickHouse UUID 函数 + SQL_FUNCTION_MAP.put("generateUUIDv4", ""); // 生成一个UUID + SQL_FUNCTION_MAP.put("toUUID", ""); // toUUID(x) 将String类型的值转换为UUID类型的值。 + + // ClickHouse 系统函数 + SQL_FUNCTION_MAP.put("hostName", ""); // hostName()回一个字符串，其中包含执行此函数的主机的名称。 + SQL_FUNCTION_MAP.put("getMacro", ""); // 从服务器配置的宏部分获取指定值。 + SQL_FUNCTION_MAP.put("FQDN", ""); // 返回完全限定的域名。 + SQL_FUNCTION_MAP.put("basename", ""); // 提取字符串最后一个斜杠或反斜杠之后的尾随部分 + SQL_FUNCTION_MAP.put("currentUser", ""); // 返回当前用户的登录。在分布式查询的情况下，将返回用户的登录，即发起的查询 + SQL_FUNCTION_MAP.put("version", ""); // 以字符串形式返回服务器版本。 + SQL_FUNCTION_MAP.put("uptime", ""); // 以秒为单位返回服务器的正常运行时间。 + + // ClickHouse 数学函数 + SQL_FUNCTION_MAP.put("least", ""); // least(a, b) 返回a和b中最小的值。 + SQL_FUNCTION_MAP.put("greatest", ""); // greatest(a, b) 返回a和b的最大值。 + SQL_FUNCTION_MAP.put("plus", ""); // plus(a, b), a + b operator¶计算数值的总和。 + SQL_FUNCTION_MAP.put("minus", ""); // minus(a, b), a - b operator 计算数值之间的差，结果总是有符号的。 + SQL_FUNCTION_MAP.put("multiply", "");// multiply(a, b), a * b operator 计算数值的乘积 + SQL_FUNCTION_MAP.put("divide", ""); // divide(a, b), a / b operator 计算数值的商。结果类型始终是浮点类型 + SQL_FUNCTION_MAP.put("intDiv", ""); // intDiv(a,b)计算数值的商，向下舍入取整（按绝对值）。 + SQL_FUNCTION_MAP.put("intDivOrZero", ""); // intDivOrZero(a,b)与’intDiv’的不同之处在于它在除以零或将最小负数除以-1时返回零。 + SQL_FUNCTION_MAP.put("modulo", ""); // modulo(a, b), a % b operator 计算除法后的余数。 + SQL_FUNCTION_MAP.put("moduloOrZero", ""); // 和modulo不同之处在于，除以0时结果返回0 + SQL_FUNCTION_MAP.put("negate", ""); // 通过改变数值的符号位对数值取反，结果总是有符号 + SQL_FUNCTION_MAP.put("gcd", ""); // gcd(a,b) 返回数值的最大公约数。 + SQL_FUNCTION_MAP.put("lcm", ""); // lcm(a,b) 返回数值的最小公倍数 + SQL_FUNCTION_MAP.put("e", ""); // e() 返回一个接近数学常量e的Float64数字。 + SQL_FUNCTION_MAP.put("pi", ""); // pi() 返回一个接近数学常量π的Float64数字。 + SQL_FUNCTION_MAP.put("exp2", ""); // exp2(x)¶接受一个数值类型的参数并返回它的2的x次幂。 + SQL_FUNCTION_MAP.put("exp10", ""); // exp10(x)¶接受一个数值类型的参数并返回它的10的x次幂。 + SQL_FUNCTION_MAP.put("cbrt", ""); // cbrt(x) 接受一个数值类型的参数并返回它的立方根。 + SQL_FUNCTION_MAP.put("lgamma", ""); // lgamma(x) 返回x的绝对值的自然对数的伽玛函数。 + SQL_FUNCTION_MAP.put("tgamma", ""); // tgamma(x)¶返回x的伽玛函数。 + SQL_FUNCTION_MAP.put("intExp2", ""); // intExp2 接受一个数值类型的参数并返回它的2的x次幂（UInt64） + SQL_FUNCTION_MAP.put("intExp10", ""); // intExp10 接受一个数值类型的参数并返回它的10的x次幂（UInt64）。 + SQL_FUNCTION_MAP.put("cosh", ""); // cosh(x) + SQL_FUNCTION_MAP.put("sinh", ""); // sinh(x) + SQL_FUNCTION_MAP.put("asinh", ""); // asinh(x) + SQL_FUNCTION_MAP.put("atanh", ""); // atanh(x) + SQL_FUNCTION_MAP.put("atan2", ""); // atan2(y, x) + SQL_FUNCTION_MAP.put("hypot", ""); // hypot(x, y) + SQL_FUNCTION_MAP.put("log1p", ""); // log1p(x) + SQL_FUNCTION_MAP.put("trunc", ""); // 和 truncate 一样 + SQL_FUNCTION_MAP.put("roundToExp2", ""); // roundToExp2(num) 接受一个数字。如果数字小于1，它返回0。 + SQL_FUNCTION_MAP.put("roundDuration", ""); // roundDuration(num) 接受一个数字。如果数字小于1，它返回0。 + SQL_FUNCTION_MAP.put("roundAge", ""); // roundAge(age) 接受一个数字。如果数字小于18，它返回0。 + SQL_FUNCTION_MAP.put("roundDown", ""); // roundDown(num, arr) 接受一个数字并将其舍入到指定数组中的一个元素 + SQL_FUNCTION_MAP.put("bitAnd", ""); // bitAnd(a,b) + SQL_FUNCTION_MAP.put("bitOr", ""); // bitOr(a,b) + + // PostgreSQL 表结构相关 SQL 函数 + SQL_FUNCTION_MAP.put("obj_description", ""); + SQL_FUNCTION_MAP.put("col_description", ""); + + // SQLServer 相关 SQL 函数 + SQL_FUNCTION_MAP.put("len", ""); + SQL_FUNCTION_MAP.put("datalength", ""); + + // Milvus 相关 SQL 函数 + SQL_FUNCTION_MAP.put("vMatch", ""); + SQL_FUNCTION_MAP.put("consistencyLevel", ""); + SQL_FUNCTION_MAP.put("partitionBy", ""); + SQL_FUNCTION_MAP.put("gracefulTime", ""); + SQL_FUNCTION_MAP.put("guaranteeTimestamp", ""); + SQL_FUNCTION_MAP.put("roundDecimal", ""); + SQL_FUNCTION_MAP.put("travelTimestamp", ""); + SQL_FUNCTION_MAP.put("nProbe", ""); + SQL_FUNCTION_MAP.put("ef", ""); + SQL_FUNCTION_MAP.put("searchK", ""); + + } + + private Parser parser; + @Override + public Parser gainParser() { + if (parser == null && objectParser != null) { + parser = objectParser.getParser(); + } + return parser; + } + @Override + public AbstractSQLConfig setParser(Parser parser) { + this.parser = parser; + return this; + } + public AbstractSQLConfig putWarnIfNeed(String type, String warn) { + if (Log.DEBUG && parser instanceof AbstractParser) { + ((AbstractParser) parser).putWarnIfNeed(type, warn); + } + return this; + } + public AbstractSQLConfig putWarn(String type, String warn) { + if (Log.DEBUG && parser instanceof AbstractParser) { + ((AbstractParser) parser).putWarn(type, warn); + } + return this; + } + + private ObjectParser objectParser; + @Override + public ObjectParser gainObjectParser() { + return objectParser; + } + @Override + public AbstractSQLConfig setObjectParser(ObjectParser objectParser) { + this.objectParser = objectParser; + return this; + } + + private int version; + @Override + public int getVersion() { + if (version <= 0 && parser != null) { + version = parser.getVersion(); + } + return version; + } + @Override + public AbstractSQLConfig setVersion(int version) { + this.version = version; + return this; + } + + private String tag; + @Override + public String getTag() { + if (StringUtil.isEmpty(tag) && parser != null) { + tag = parser.getTag(); + } + return tag; + } + @Override + public AbstractSQLConfig setTag(String tag) { + this.tag = tag; + return this; } + // mysql8版本以上,子查询支持with as表达式 + private List withAsExprSQLList = null; + protected List withAsExprPreparedValueList = new ArrayList<>(); + private int[] dbVersionNums = null; + @Override + public int[] gainDBVersionNums() { + if (dbVersionNums == null || dbVersionNums.length <= 0) { + dbVersionNums = SQLConfig.super.gainDBVersionNums(); + } + return dbVersionNums; + } @Override public boolean limitSQLCount() { - return Log.DEBUG == false || AbstractVerifier.SYSTEM_ACCESS_MAP.containsKey(getTable()) == false; + return AbstractVerifier.SYSTEM_ACCESS_MAP.containsKey(getTable()) == false; + } + @Override + public boolean allowPartialUpdateFailed() { + return allowPartialUpdateFailed(getTable()); + } + public static boolean allowPartialUpdateFailed(String table) { + return ALLOW_PARTIAL_UPDATE_FAIL_TABLE_MAP.containsKey(table); } @NotNull @@ -144,49 +890,66 @@ public String getUserIdKey() { return KEY_USER_ID; } - - private Object id; //Table的id private RequestMethod method; //操作方法 private boolean prepared = true; //预编译 private boolean main = true; + + private Object id; // Table 的 id + private Object idIn; // User Table 的 id IN + private Object userId; // Table 的 userId + private Object userIdIn; // Table 的 userId IN + /** * TODO 被关联的表通过就忽略关联的表？(这个不行 User:{"sex@":"/Comment/toId"}) */ - private RequestRole role; //发送请求的用户的角色 + private String role; //发送请求的用户的角色 private boolean distinct = false; private String database; //表所在的数据库类型 + private String namespace; //表所在的命名空间 + private String catalog; //表所在的目录 private String schema; //表所在的数据库名 + private String datasource; //数据源 private String table; //表名 private String alias; //表别名 private String group; //分组方式的字符串数组，','分隔 - private String having; //聚合函数的字符串数组，','分隔 + private String havingCombine; //聚合函数的字符串数组，','分隔 + private Map having; //聚合函数的字符串数组，','分隔 + private String sample; //取样方式的字符串数组，','分隔 + private String latest; //最近方式的字符串数组，','分隔 + private String partition; //分区方式的字符串数组，','分隔 + private String fill; //填充方式的字符串数组，','分隔 private String order; //排序方式的字符串数组，','分隔 + + private Map keyMap; //字段名映射，支持 name_tag:(name,tag) 多字段 IN，year:left(date,4) 截取日期年份等 private List raw; //需要保留原始 SQL 的字段，','分隔 private List json; //需要转为 JSON 的字段，','分隔 - private Subquery from; //子查询临时表 + private Subquery from; //子查询临时表 private List column; //表内字段名(或函数名，仅查询操作可用)的字符串数组，','分隔 private List> values; //对应表内字段的值的字符串数组，','分隔 + private List nulls; + private Map cast; private Map content; //Request内容，key:value形式，column = content.keySet()，values = content.values() private Map where; //筛选条件，key:value形式 - private Map> combine; //条件组合，{ "&":[key], "|":[key], "!":[key] } - + private String combine; //条件组合， a | (b & c & !(d | !e)) + private Map> combineMap; //条件组合，{ "&":[key], "|":[key], "!":[key] } //array item <<<<<<<<<< private int count; //Table数量 private int page; //Table所在页码 private int position; //Table在[]中的位置 - private int query; //JSONRequest.query + private int query; //apijson.JSONRequest.QUERY + private Boolean compat; //apijson.JSONMap.compat query total private int type; //ObjectParser.type private int cache; private boolean explain; - private List joinList; //连表 配置列表 + private List> joinList; //连表 配置列表 //array item >>>>>>>>>> private boolean test; //测试 private String procedure; - public SQLConfig setProcedure(String procedure) { + public AbstractSQLConfig setProcedure(String procedure) { this.procedure = procedure; return this; } @@ -216,16 +979,16 @@ public RequestMethod getMethod() { return method; } @Override - public AbstractSQLConfig setMethod(RequestMethod method) { + public AbstractSQLConfig setMethod(RequestMethod method) { this.method = method; return this; } @Override public boolean isPrepared() { - return prepared; + return prepared && ! isMongoDB(); // MongoDB JDBC 还不支持预编译; } @Override - public AbstractSQLConfig setPrepared(boolean prepared) { + public AbstractSQLConfig setPrepared(boolean prepared) { this.prepared = prepared; return this; } @@ -234,7 +997,7 @@ public boolean isMain() { return main; } @Override - public AbstractSQLConfig setMain(boolean main) { + public AbstractSQLConfig setMain(boolean main) { this.main = main; return this; } @@ -245,21 +1008,49 @@ public Object getId() { return id; } @Override - public AbstractSQLConfig setId(Object id) { + public AbstractSQLConfig setId(Object id) { this.id = id; return this; } @Override - public RequestRole getRole() { + public Object getIdIn() { + return idIn; + } + @Override + public AbstractSQLConfig setIdIn(Object idIn) { + this.idIn = idIn; + return this; + } + + + @Override + public Object getUserId() { + return userId; + } + @Override + public AbstractSQLConfig setUserId(Object userId) { + this.userId = userId; + return this; + } + + @Override + public Object getUserIdIn() { + return userIdIn; + } + @Override + public AbstractSQLConfig setUserIdIn(Object userIdIn) { + this.userIdIn = userIdIn; + return this; + } + + @Override + public String getRole() { //不能 @NotNull , AbstractParser#getSQLObject 内当getRole() == null时填充默认值 return role; } - public AbstractSQLConfig setRole(String roleName) throws Exception { - return setRole(RequestRole.get(roleName)); - } @Override - public AbstractSQLConfig setRole(RequestRole role) { + public AbstractSQLConfig setRole(String role) { this.role = role; return this; } @@ -269,7 +1060,7 @@ public boolean isDistinct() { return distinct; } @Override - public SQLConfig setDistinct(boolean distinct) { + public AbstractSQLConfig setDistinct(boolean distinct) { this.distinct = distinct; return this; } @@ -279,7 +1070,7 @@ public String getDatabase() { return database; } @Override - public SQLConfig setDatabase(String database) { + public AbstractSQLConfig setDatabase(String database) { this.database = database; return this; } @@ -287,64 +1078,358 @@ public SQLConfig setDatabase(String database) { * @return db == null ? DEFAULT_DATABASE : db */ @NotNull - public String getSQLDatabase() { + public String gainSQLDatabase() { String db = getDatabase(); return db == null ? DEFAULT_DATABASE : db; // "" 表示已设置，不需要用全局默认的 StringUtil.isEmpty(db, false)) { } + @Override + public boolean isTSQL() { // 兼容 TSQL 语法 + return isOracle() || isSQLServer() || isDb2(); + } + @Override + public boolean isMSQL() { // 兼容 MySQL 语法，但不一定可以使用它的 JDBC/ODBC + return isMySQL() || isTiDB() || isMariaDB() || isSQLite() || isTDengine(); + } + @Override + public boolean isPSQL() { // 兼容 PostgreSQL 语法，但不一定可以使用它的 JDBC/ODBC + return isPostgreSQL() || isCockroachDB() || isOpenGauss() || isInfluxDB() || isTimescaleDB() || isQuestDB() || isDuckDB(); + } + @Override public boolean isMySQL() { - return isMySQL(getSQLDatabase()); + return isMySQL(gainSQLDatabase()); } public static boolean isMySQL(String db) { return DATABASE_MYSQL.equals(db); } + @Override public boolean isPostgreSQL() { - return isPostgreSQL(getSQLDatabase()); + return isPostgreSQL(gainSQLDatabase()); } public static boolean isPostgreSQL(String db) { return DATABASE_POSTGRESQL.equals(db); } + @Override public boolean isSQLServer() { - return isSQLServer(getSQLDatabase()); + return isSQLServer(gainSQLDatabase()); } public static boolean isSQLServer(String db) { return DATABASE_SQLSERVER.equals(db); } + @Override public boolean isOracle() { - return isOracle(getSQLDatabase()); + return isOracle(gainSQLDatabase()); } public static boolean isOracle(String db) { return DATABASE_ORACLE.equals(db); } + @Override public boolean isDb2() { - return isDb2(getSQLDatabase()); + return isDb2(gainSQLDatabase()); } public static boolean isDb2(String db) { return DATABASE_DB2.equals(db); } @Override - public String getQuote() { - return isMySQL() ? "`" : "\""; + public boolean isMariaDB() { + return isMariaDB(gainSQLDatabase()); + } + public static boolean isMariaDB(String db) { + return DATABASE_MARIADB.equals(db); } @Override - public String getSchema() { - return schema; + public boolean isTiDB() { + return isTiDB(gainSQLDatabase()); } - /** - * @param sqlTable - * @return - */ + public static boolean isTiDB(String db) { + return DATABASE_TIDB.equals(db); + } + + @Override + public boolean isCockroachDB() { + return isCockroachDB(gainSQLDatabase()); + } + public static boolean isCockroachDB(String db) { + return DATABASE_COCKROACHDB.equals(db); + } + + @Override + public boolean isDameng() { + return isDameng(gainSQLDatabase()); + } + public static boolean isDameng(String db) { + return DATABASE_DAMENG.equals(db); + } + + @Override + public boolean isKingBase() { + return isKingBase(gainSQLDatabase()); + } + public static boolean isKingBase(String db) { + return DATABASE_KINGBASE.equals(db); + } + + @Override + public boolean isElasticsearch() { + return isElasticsearch(gainSQLDatabase()); + } + public static boolean isElasticsearch(String db) { + return DATABASE_ELASTICSEARCH.equals(db); + } + + @Override + public boolean isManticore() { + return isManticore(gainSQLDatabase()); + } + public static boolean isManticore(String db) { + return DATABASE_MANTICORE.equals(db); + } + + @Override + public boolean isClickHouse() { + return isClickHouse(gainSQLDatabase()); + } + public static boolean isClickHouse(String db) { + return DATABASE_CLICKHOUSE.equals(db); + } + + @Override + public boolean isHive() { + return isHive(gainSQLDatabase()); + } + public static boolean isHive(String db) { + return DATABASE_HIVE.equals(db); + } + + @Override + public boolean isPresto() { + return isPresto(gainSQLDatabase()); + } + public static boolean isPresto(String db) { + return DATABASE_PRESTO.equals(db); + } + + @Override + public boolean isTrino() { + return isTrino(gainSQLDatabase()); + } + public static boolean isTrino(String db) { + return DATABASE_TRINO.equals(db); + } + + @Override + public boolean isSnowflake() { + return isSnowflake(gainSQLDatabase()); + } + public static boolean isSnowflake(String db) { + return DATABASE_SNOWFLAKE.equals(db); + } + + @Override + public boolean isDatabend() { + return isDatabend(gainSQLDatabase()); + } + public static boolean isDatabend(String db) { + return DATABASE_DATABEND.equals(db); + } + + @Override + public boolean isDatabricks() { + return isDatabricks(gainSQLDatabase()); + } + public static boolean isDatabricks(String db) { + return DATABASE_DATABRICKS.equals(db); + } + + @Override + public boolean isCassandra() { + return isCassandra(gainSQLDatabase()); + } + public static boolean isCassandra(String db) { + return DATABASE_CASSANDRA.equals(db); + } + + @Override + public boolean isMilvus() { + return isMilvus(gainSQLDatabase()); + } + public static boolean isMilvus(String db) { + return DATABASE_MILVUS.equals(db); + } + + @Override + public boolean isInfluxDB() { + return isInfluxDB(gainSQLDatabase()); + } + public static boolean isInfluxDB(String db) { + return DATABASE_INFLUXDB.equals(db); + } + + @Override + public boolean isTDengine() { + return isTDengine(gainSQLDatabase()); + } + public static boolean isTDengine(String db) { + return DATABASE_TDENGINE.equals(db); + } + + @Override + public boolean isTimescaleDB() { + return isTimescaleDB(gainSQLDatabase()); + } + public static boolean isTimescaleDB(String db) { + return DATABASE_TIMESCALEDB.equals(db); + } + + @Override + public boolean isQuestDB() { + return isQuestDB(gainSQLDatabase()); + } + public static boolean isQuestDB(String db) { + return DATABASE_QUESTDB.equals(db); + } + + + public boolean isIoTDB() { + return isIoTDB(getDatabase()); + } + public static boolean isIoTDB(String db) { + return DATABASE_IOTDB.equals(db); + } + + + @Override + public boolean isRedis() { + return isRedis(gainSQLDatabase()); + } + public static boolean isRedis(String db) { + return DATABASE_REDIS.equals(db); + } + + @Override + public boolean isMongoDB() { + return isMongoDB(gainSQLDatabase()); + } + public static boolean isMongoDB(String db) { + return DATABASE_MONGODB.equals(db); + } + + @Override + public boolean isKafka() { + return isKafka(gainSQLDatabase()); + } + public static boolean isKafka(String db) { + return DATABASE_KAFKA.equals(db); + } + + @Override + public boolean isMQ() { + return isMQ(gainSQLDatabase()); + } + public static boolean isMQ(String db) { + return DATABASE_MQ.equals(db) || isKafka(db); + } + + @Override + public boolean isSQLite() { + return isSQLite(gainSQLDatabase()); + } + public static boolean isSQLite(String db) { + return DATABASE_SQLITE.equals(db); + } + + @Override + public boolean isDuckDB() { + return isDuckDB(gainSQLDatabase()); + } + public static boolean isDuckDB(String db) { + return DATABASE_DUCKDB.equals(db); + } + + @Override + public boolean isSurrealDB() { + return isSurrealDB(gainSQLDatabase()); + } + public static boolean isSurrealDB(String db) { + return DATABASE_SURREALDB.equals(db); + } + + @Override + public boolean isOpenGauss() { + return isOpenGauss(gainSQLDatabase()); + } + public static boolean isOpenGauss(String db) { + return DATABASE_OPENGAUSS.equals(db); + } + + @Override + public boolean isDoris() { + return isDoris(gainSQLDatabase()); + } + public static boolean isDoris(String db) { + return DATABASE_DORIS.equals(db); + } + + @Override + public String getQuote() { // MongoDB 同时支持 `tbl` 反引号 和 "col" 双引号 + if(isElasticsearch() || isManticore() || isIoTDB() || isSurrealDB()) { + return ""; + } + return isMySQL() || isMariaDB() || isTiDB() || isClickHouse() || isTDengine() || isMilvus() || isDoris() ? "`" : "\""; + } + + public String quote(String s) { + String q = getQuote(); + return q + s + q; + } + + @Override + public String getSQLNamespace() { + String sch = getNamespace(); // 前端传参 @namespace 优先 + return sch == null ? DEFAULT_NAMESPACE : sch; // 最后代码默认兜底配置 + } + + @Override + public String getNamespace() { + return namespace; + } + + @Override + public AbstractSQLConfig setNamespace(String namespace) { + this.namespace = namespace; + return this; + } + + + @Override + public String gainSQLCatalog() { + String catalog = getCatalog(); // 前端传参 @catalog 优先 + return catalog == null ? DEFAULT_CATALOG : catalog; // 最后代码默认兜底配置 + } + + @Override + public String getCatalog() { + return catalog; + } + + @Override + public AbstractSQLConfig setCatalog(String catalog) { + this.catalog = catalog; + return this; + } + @NotNull - public String getSQLSchema() { + @Override + public String gainSQLSchema() { String table = getTable(); - //强制，避免因为全局默认的 @schema 自动填充进来，导致这几个类的 schema 为 sys 等其它值 + // FIXME 全部默认填充判断是 系统表 则不填充 // 强制，避免因为全局默认的 @schema 自动填充进来，导致这几个类的 schema 为 sys 等其它值 if (Table.TAG.equals(table) || Column.TAG.equals(table)) { return SCHEMA_INFORMATION; //MySQL, PostgreSQL, SQL Server 都有的 } @@ -354,25 +1439,45 @@ public String getSQLSchema() { if (SysTable.TAG.equals(table) || SysColumn.TAG.equals(table) || ExtendedProperty.TAG.equals(table)) { return SCHEMA_SYS; //SQL Server 在 sys 中的属性比 information_schema 中的要全，能拿到注释 } + if (AllTable.TAG.equals(table) || AllColumn.TAG.equals(table) + || AllTableComment.TAG.equals(table) || AllColumnComment.TAG.equals(table)) { + return ""; //Oracle, Dameng 的 all_tables, dba_tables 和 all_tab_columns, dba_columns 表好像不属于任何 Schema + } + + String sch = getSchema(); // 前端传参 @schema 优先 + if (sch == null) { + sch = TABLE_SCHEMA_MAP.get(table); // 其次 Access 表 alias 和 schema 配置 + } + return sch == null ? DEFAULT_SCHEMA : sch; // 最后代码默认兜底配置 + } - String sch = getSchema(); - return sch == null ? DEFAULT_SCHEMA : sch; + @Override + public String getSchema() { + return schema; } + @Override - public AbstractSQLConfig setSchema(String schema) { + public AbstractSQLConfig setSchema(String schema) { if (schema != null) { - String quote = getQuote(); - String s = schema.startsWith(quote) && schema.endsWith(quote) ? schema.substring(1, schema.length() - 1) : schema; - if (StringUtil.isEmpty(s, true) == false && StringUtil.isName(s) == false) { - throw new IllegalArgumentException("@schema:value 中value必须是1个单词！"); - } + AbstractFunctionParser.verifySchema(schema, getTable()); } this.schema = schema; return this; } + + @Override + public String getDatasource() { + return datasource; + } + @Override + public AbstractSQLConfig setDatasource(String datasource) { + this.datasource = datasource; + return this; + } + /**请求传进来的Table名 * @return - * @see {@link #getSQLTable()} + * @see {@link #gainSQLTable()} */ @Override public String getTable() { @@ -382,46 +1487,55 @@ public String getTable() { * 通过 {@link #TABLE_KEY_MAP} 映射 * @return */ - @JSONField(serialize = false) @Override - public String getSQLTable() { - // String t = TABLE_KEY_MAP.containsKey(table) ? TABLE_KEY_MAP.get(table) : table; - //如果要强制小写，则可在子类重写这个方法再 toLowerCase return DATABASE_POSTGRESQL.equals(getDatabase()) ? t.toLowerCase() : t; - return TABLE_KEY_MAP.containsKey(table) ? TABLE_KEY_MAP.get(table) : table; + public String gainSQLTable() { + // 如果要强制小写，则可在子类重写这个方法再 toLowerCase + // return DATABASE_POSTGRESQL.equals(getDatabase()) ? t.toLowerCase() : t; + String ot = getTable(); + String nt = TABLE_KEY_MAP.get(ot); + return StringUtil.isEmpty(nt) ? ot : nt; } - @JSONField(serialize = false) + + @Override - public String getTablePath() { + public String gainTablePath() { String q = getQuote(); - String sch = getSQLSchema(); - String sqlTable = getSQLTable(); + String ns = isSurrealDB() ? getSQLNamespace() : null; + String cl = isPSQL() ? gainSQLCatalog() : null; + String sch = gainSQLSchema(); + String sqlTable = gainSQLTable(); - return (StringUtil.isEmpty(sch, true) ? "" : q + sch + q + ".") + q + sqlTable + q + ( isKeyPrefix() ? " AS " + getAliasWithQuote() : ""); + return (StringUtil.isEmpty(ns, true) ? "" : q + ns + q + ".") + + (StringUtil.isEmpty(cl, true) ? "" : q + cl + q + ".") + + (StringUtil.isEmpty(sch, true) ? "" : q + sch + q + ".") + + q + sqlTable + q + (isKeyPrefix() ? gainAs() + q + gainSQLAlias() + q : ""); } @Override - public AbstractSQLConfig setTable(String table) { //Table已经在Parser中校验，所以这里不用防SQL注入 + public AbstractSQLConfig setTable(String table) { //Table已经在Parser中校验，所以这里不用防SQL注入 this.table = table; return this; } + public String gainAs() { + return isOracle() || isManticore() ? " " : " AS "; + } + @Override public String getAlias() { return alias; } @Override - public AbstractSQLConfig setAlias(String alias) { + public AbstractSQLConfig setAlias(String alias) { this.alias = alias; return this; } - public String getAliasWithQuote() { - String a = getAlias(); - if (StringUtil.isEmpty(a, true)) { - a = getTable(); - } + public String gainSQLAliasWithQuote() { + String a = gainSQLAlias(); String q = getQuote(); - //getTable 不能小写，因为Verifier用大小写敏感的名称判断权限 - //如果要强制小写，则可在子类重写这个方法再 toLowerCase return q + (DATABASE_POSTGRESQL.equals(getDatabase()) ? a.toLowerCase() : a) + q; + // getTable 不能小写，因为Verifier用大小写敏感的名称判断权限 + // 如果要强制小写，则可在子类重写这个方法再 toLowerCase + // return q + (DATABASE_POSTGRESQL.equals(getDatabase()) ? a.toLowerCase() : a) + q; return q + a + q; } @@ -429,266 +1543,539 @@ public String getAliasWithQuote() { public String getGroup() { return group; } - public AbstractSQLConfig setGroup(String... keys) { - return setGroup(StringUtil.getString(keys)); + public AbstractSQLConfig setGroup(String... keys) { + return setGroup(StringUtil.get(keys)); } @Override - public AbstractSQLConfig setGroup(String group) { + public AbstractSQLConfig setGroup(String group) { this.group = group; return this; } - @JSONField(serialize = false) - public String getGroupString(boolean hasPrefix) { + + public String gainGroupString(boolean hasPrefix) { //加上子表的 group String joinGroup = ""; if (joinList != null) { - SQLConfig cfg; - String c; boolean first = true; - for (Join j : joinList) { - if (j.isAppJoin()) { + for (Join join : joinList) { + if (join.isAppJoin()) { continue; } - cfg = j.isLeftOrRightJoin() ? j.getOuterConfig() : j.getJoinConfig(); - if (StringUtil.isEmpty(cfg.getAlias(), true)) { - cfg.setAlias(cfg.getTable()); - } + SQLConfig ocfg = join.getOnConfig(); + SQLConfig cfg = (ocfg != null && ocfg.getGroup() != null) || join.isLeftOrRightJoin() ? ocfg : join.getJoinConfig(); - c = ((AbstractSQLConfig) cfg).getGroupString(false); - if (StringUtil.isEmpty(c, true) == false) { - joinGroup += (first ? "" : ", ") + c; - first = false; + if (cfg != null) { + cfg.setMain(false).setKeyPrefix(true); + //if (StringUtil.isEmpty(cfg.getAlias(), true)) { + // cfg.setAlias(cfg.getTable()); + //} + String c = ((AbstractSQLConfig) cfg).gainGroupString(false); + + if (StringUtil.isNotEmpty(c, true)) { + joinGroup += (first ? "" : ", ") + c; + first = false; + } } + ////先处理左/右关联，内关联忽略 + //SQLConfig outerConfig = join.getOuterConfig(); + //SQLConfig outerConfig2 = (outerConfig != null && outerConfig.getGroup() != null) || join.isLeftOrRightJoin() ? outerConfig : null; + // + //if (outerConfig2 != null) { + // outerConfig2.setMain(false).setKeyPrefix(true); + // //if (StringUtil.isEmpty(cfg.getAlias(), true)) { + // // cfg.setAlias(cfg.getTable()); + // //} + // String c = ((AbstractSQLConfig) outerConfig2).gainGroupString(false); + // + // if (StringUtil.isNotEmpty(c, true)) { + // joinGroup += (first ? "" : ", ") + c; + // first = false; + // } + //} } } - group = StringUtil.getTrimedString(group); + group = StringUtil.trim(group); String[] keys = StringUtil.split(group); if (keys == null || keys.length <= 0) { return StringUtil.isEmpty(joinGroup, true) ? "" : (hasPrefix ? " GROUP BY " : "") + joinGroup; } for (int i = 0; i < keys.length; i++) { - if (isPrepared()) { //不能通过 ? 来代替，因为SQLExecutor statement.setString后 GROUP BY 'userId' 有单引号，只能返回一条数据，必须去掉单引号才行！ + if (isPrepared()) { + // 不能通过 ? 来代替，因为SQLExecutor statement.setString后 GROUP BY 'userId' 有单引号，只能返回一条数据，必须去掉单引号才行！ if (StringUtil.isName(keys[i]) == false) { throw new IllegalArgumentException("@group:value 中 value里面用 , 分割的每一项都必须是1个单词！并且不要有空格！"); } } - keys[i] = getKey(keys[i]); + keys[i] = gainKey(keys[i]); } - return (hasPrefix ? " GROUP BY " : "") + StringUtil.concat(StringUtil.getString(keys), joinGroup, ", "); + return (hasPrefix ? " GROUP BY " : "") + StringUtil.concat(StringUtil.get(keys), joinGroup, ", "); } @Override - public String getHaving() { - return having; + public String getHavingCombine() { + return havingCombine; + } + @Override + public AbstractSQLConfig setHavingCombine(String havingCombine) { + this.havingCombine = havingCombine; + return this; } - public AbstractSQLConfig setHaving(String... conditions) { - return setHaving(StringUtil.getString(conditions)); + + @Override + public Map getHaving() { + return having; } @Override - public AbstractSQLConfig setHaving(String having) { + public AbstractSQLConfig setHaving(Map having) { this.having = having; return this; } + public AbstractSQLConfig setHaving(String... conditions) { + return setHaving(StringUtil.get(conditions)); + } + /**TODO @having 改为默认 | 或连接，且支持 @having: { "key1>": 1, "key{}": "length(key2)>0", "@combine": "key1,key2" } * @return HAVING conditoin0 AND condition1 OR condition2 ... + * @throws Exception */ - @JSONField(serialize = false) - public String getHavingString(boolean hasPrefix) { + public String gainHavingString(boolean hasPrefix) throws Exception { //加上子表的 having String joinHaving = ""; if (joinList != null) { - SQLConfig cfg; - String c; boolean first = true; - for (Join j : joinList) { - if (j.isAppJoin()) { + for (Join join : joinList) { + if (join.isAppJoin()) { continue; } - cfg = j.isLeftOrRightJoin() ? j.getOuterConfig() : j.getJoinConfig(); - if (StringUtil.isEmpty(cfg.getAlias(), true)) { - cfg.setAlias(cfg.getTable()); - } + SQLConfig ocfg = join.getOnConfig(); + SQLConfig cfg = (ocfg != null && ocfg.getHaving() != null) || join.isLeftOrRightJoin() ? ocfg : join.getJoinConfig(); - c = ((AbstractSQLConfig) cfg).getHavingString(false); - if (StringUtil.isEmpty(c, true) == false) { - joinHaving += (first ? "" : ", ") + c; - first = false; - } + if (cfg != null) { + cfg.setMain(false).setKeyPrefix(true); + //if (StringUtil.isEmpty(cfg.getAlias(), true)) { + // cfg.setAlias(cfg.getTable()); + //} + String c = ((AbstractSQLConfig) cfg).gainHavingString(false); + if (StringUtil.isNotEmpty(c, true)) { + joinHaving += (first ? "" : ", ") + c; + first = false; + } + } } } - String[] keys = StringUtil.split(getHaving(), ";"); - if (keys == null || keys.length <= 0) { + Map map = getHaving(); + Set> set = map == null ? null : map.entrySet(); + if (set == null || set.isEmpty()) { return StringUtil.isEmpty(joinHaving, true) ? "" : (hasPrefix ? " HAVING " : "") + joinHaving; } - - String quote = getQuote(); - String tableAlias = getAliasWithQuote(); List raw = getRaw(); + // 提前把 @having& 转为 @having，或者干脆不允许 @raw:"@having&" boolean containRaw = raw != null && (raw.contains(KEY_HAVING) || raw.contains(KEY_HAVING_AND)); boolean containRaw = raw != null && raw.contains(KEY_HAVING); - - String expression; - String method; - //暂时不允许 String prefix; - String suffix; + + // 直接把 having 类型从 Map 定改为 Map，避免额外拷贝 + // Map newMap = new LinkedHashMap<>(map.size()); + // for (Entry entry : set) { + // newMap.put(entry.getKey(), entry.getValue()); + // } //fun0(arg0,arg1,...);fun1(arg0,arg1,...) - for (int i = 0; i < keys.length; i++) { + String havingString = parseCombineExpression(getMethod(), getQuote(), getTable() + , getAlias(), map, getHavingCombine(), true, containRaw, true); - //fun(arg0,arg1,...) - expression = keys[i]; - if (containRaw) { - try { - String rawSQL = getRawSQL(KEY_HAVING, expression); - if (rawSQL != null) { - keys[i] = rawSQL; - continue; + return (hasPrefix ? " HAVING " : "") + StringUtil.concat(havingString, joinHaving, AND); + } + + protected String gainHavingItem(String quote, String table, String alias + , String key, String expression, boolean containRaw) throws Exception { + //fun(arg0,arg1,...) + if (containRaw) { + String rawSQL = gainRawSQL(KEY_HAVING, expression); + if (rawSQL != null) { + return rawSQL; + } + } + + if (expression.length() > 100) { + throw new UnsupportedOperationException("@having:value 的 value 中字符串 " + expression + " 不合法！" + + "不允许传超过 100 个字符的函数或表达式！请用 @raw 简化传参！"); + } + + int start = expression.indexOf("("); + if (start < 0) { + if (isPrepared() && PATTERN_FUNCTION.matcher(expression).matches() == false) { + throw new UnsupportedOperationException("字符串 " + expression + " 不合法！" + + "预编译模式下 @having:\"column?value;function(arg0,arg1,...)?value...\"" + + " 中 column?value 必须符合正则表达式 " + PATTERN_FUNCTION + " 且不包含连续减号 -- ！不允许空格！"); + } + return expression; + } + + int end = expression.lastIndexOf(")"); + if (start >= end) { + throw new IllegalArgumentException("字符 " + expression + " 不合法！" + + "@having:value 中 value 里的 SQL函数必须为 function(arg0,arg1,...) 这种格式！"); + } + + String method = expression.substring(0, start); + if (method.isEmpty() == false) { + if (SQL_FUNCTION_MAP == null || SQL_FUNCTION_MAP.isEmpty()) { + if (StringUtil.isName(method) == false) { + throw new IllegalArgumentException("字符 " + method + " 不合法！" + + "预编译模式下 @having:\"column?value;function(arg0,arg1,...)?value...\"" + + " 中 function 必须符合小写英文单词的 SQL 函数名格式！"); + } + } + else if (SQL_FUNCTION_MAP.containsKey(method) == false) { + throw new IllegalArgumentException("字符 " + method + " 不合法！" + + "预编译模式下 @column:\"column0,column1:alias;function0(arg0,arg1,...);function1(...):alias...\"" + + " 中 function 必须符合小写英文单词的 SQL 函数名格式！且必须是后端允许调用的 SQL 函数!"); + } + } + + return method + parseSQLExpression(KEY_HAVING, expression.substring(start), containRaw, false, null); + } + + @Override + public String getSample() { + return sample; + } + public AbstractSQLConfig setSample(String... conditions) { + return setSample(StringUtil.get(conditions)); + } + @Override + public AbstractSQLConfig setSample(String sample) { + this.sample = sample; + return this; + } + public String gainSampleString(boolean hasPrefix) { + //加上子表的 sample + String joinSample = ""; + if (joinList != null) { + boolean first = true; + for (Join join : joinList) { + if (join.isAppJoin()) { + continue; + } + + SQLConfig ocfg = join.getOnConfig(); + SQLConfig cfg = (ocfg != null && ocfg.getSample() != null) || join.isLeftOrRightJoin() ? ocfg : join.getJoinConfig(); + + if (cfg != null) { + cfg.setMain(false).setKeyPrefix(true); + // if (StringUtil.isEmpty(cfg.getAlias(), true)) { + // cfg.setAlias(cfg.getTable()); + // } + String c = ((AbstractSQLConfig) cfg).gainSampleString(false); + + if (StringUtil.isNotEmpty(c, true)) { + joinSample += (first ? "" : ", ") + c; + first = false; } - } catch (Exception e) { - Log.e(TAG, "newSQLConfig rawColumnSQL == null >> try { " - + " String rawSQL = ((AbstractSQLConfig) config).getRawSQL(KEY_COLUMN, fk); ... " - + "} catch (Exception e) = " + e.getMessage()); } } - - if (expression.length() > 50) { - throw new UnsupportedOperationException("@having:value 的 value 中字符串 " + expression + " 不合法！" - + "不允许传超过 50 个字符的函数或表达式！请用 @raw 简化传参！"); + } + + String sample = StringUtil.trim(getSample()); + + String[] keys = StringUtil.split(sample); + if (keys == null || keys.length <= 0) { + return StringUtil.isEmpty(joinSample, true) ? "" : (hasPrefix ? " SAMPLE BY " : "") + joinSample; + } + + for (int i = 0; i < keys.length; i++) { + String item = keys[i]; + + String origin = item; + + if (isPrepared()) { //不能通过 ? 来代替，SELECT 'id','name' 返回的就是 id:"id", name:"name"，而不是数据库里的值！ + //这里既不对origin trim，也不对 ASC/DESC ignoreCase，希望前端严格传没有任何空格的字符串过来，减少传输数据量，节约服务器性能 + if (StringUtil.isName(origin)) {} + else if (StringUtil.isCombineOfNumOrAlpha(origin)) { + continue; + } + else { + throw new IllegalArgumentException("预编译模式下 @sample:value 中 " + item + " 不合法! value 里面用 , 分割的" + + "每一项必须是 column 且其中 column 必须是 数字或英语字母组合！并且不要有多余的空格！"); + } } - int start = expression.indexOf("("); - if (start < 0) { - if (isPrepared() && PATTERN_FUNCTION.matcher(expression).matches() == false) { - throw new UnsupportedOperationException("字符串 " + expression + " 不合法！" - + "预编译模式下 @having:\"column?value;function(arg0,arg1,...)?value...\"" - + " 中 column?value 必须符合正则表达式 " + PATTERN_FUNCTION + " 且不包含连续减号 -- ！不允许空格！"); + keys[i] = gainKey(origin); + } + + return (hasPrefix ? " SAMPLE BY " : "") + StringUtil.concat(StringUtil.get(keys), joinSample, ", "); + } + + @Override + public String getLatest() { + return latest; + } + public AbstractSQLConfig setLatest(String... conditions) { + return setLatest(StringUtil.get(conditions)); + } + @Override + public AbstractSQLConfig setLatest(String latest) { + this.latest = latest; + return this; + } + public String gainLatestString(boolean hasPrefix) { + //加上子表的 latest + String joinLatest = ""; + if (joinList != null) { + boolean first = true; + for (Join join : joinList) { + if (join.isAppJoin()) { + continue; + } + + SQLConfig ocfg = join.getOnConfig(); + SQLConfig cfg = (ocfg != null && ocfg.getLatest() != null) || join.isLeftOrRightJoin() ? ocfg : join.getJoinConfig(); + + if (cfg != null) { + cfg.setMain(false).setKeyPrefix(true); + // if (StringUtil.isEmpty(cfg.getAlias(), true)) { + // cfg.setAlias(cfg.getTable()); + // } + String c = ((AbstractSQLConfig) cfg).gainLatestString(false); + + if (StringUtil.isNotEmpty(c, true)) { + joinLatest += (first ? "" : ", ") + c; + first = false; + } + } + } + } + + String latest = StringUtil.trim(getLatest()); + + String[] keys = StringUtil.split(latest); + if (keys == null || keys.length <= 0) { + return StringUtil.isEmpty(joinLatest, true) ? "" : (hasPrefix ? " LATEST ON " : "") + joinLatest; + } + + for (int i = 0; i < keys.length; i++) { + String item = keys[i]; + String origin = item; + + if (isPrepared()) { //不能通过 ? 来代替，SELECT 'id','name' 返回的就是 id:"id", name:"name"，而不是数据库里的值！ + //这里既不对origin trim，也不对 ASC/DESC ignoreCase，希望前端严格传没有任何空格的字符串过来，减少传输数据量，节约服务器性能 + if (StringUtil.isName(origin) == false) { + throw new IllegalArgumentException("预编译模式下 @latest:value 中 " + item + " 不合法! value 里面用 , 分割的" + + "每一项必须是 column 且其中 column 必须是 英语单词！并且不要有多余的空格！"); } - continue; } - int end = expression.indexOf(")"); - if (start >= end) { - throw new IllegalArgumentException("字符 " + expression + " 不合法！" - + "@having:value 中 value 里的 SQL函数必须为 function(arg0,arg1,...) 这种格式！"); + keys[i] = gainKey(origin); + } + + return (hasPrefix ? " LATEST ON " : "") + StringUtil.concat(StringUtil.get(keys), joinLatest, ", "); + } + + @Override + public String getPartition() { + return partition; + } + public AbstractSQLConfig setPartition(String... conditions) { + return setPartition(StringUtil.get(conditions)); + } + @Override + public AbstractSQLConfig setPartition(String partition) { + this.partition = partition; + return this; + } + public String gainPartitionString(boolean hasPrefix) { + //加上子表的 partition + String joinPartition = ""; + if (joinList != null) { + boolean first = true; + for (Join join : joinList) { + if (join.isAppJoin()) { + continue; + } + + SQLConfig ocfg = join.getOnConfig(); + SQLConfig cfg = (ocfg != null && ocfg.getPartition() != null) || join.isLeftOrRightJoin() ? ocfg : join.getJoinConfig(); + + if (cfg != null) { + cfg.setMain(false).setKeyPrefix(true); + // if (StringUtil.isEmpty(cfg.getAlias(), true)) { + // cfg.setAlias(cfg.getTable()); + // } + String c = ((AbstractSQLConfig) cfg).gainPartitionString(false); + + if (StringUtil.isNotEmpty(c, true)) { + joinPartition += (first ? "" : ", ") + c; + first = false; + } + } } + } - method = expression.substring(0, start); + String partition = StringUtil.trim(getPartition()); - if (StringUtil.isName(method) == false) { - throw new IllegalArgumentException("字符 " + method + " 不合法！" - + "预编译模式下 @having:\"column?value;function(arg0,arg1,...)?value...\"" - + " 中SQL函数名 function 必须符合正则表达式 ^[0-9a-zA-Z_]+$ ！"); + String[] keys = StringUtil.split(partition); + if (keys == null || keys.length <= 0) { + return StringUtil.isEmpty(joinPartition, true) ? "" : (hasPrefix ? " PARTITION BY " : "") + joinPartition; + } + + for (int i = 0; i < keys.length; i++) { + String item = keys[i]; + String origin = item; + + if (isPrepared()) { //不能通过 ? 来代替，SELECT 'id','name' 返回的就是 id:"id", name:"name"，而不是数据库里的值！ + //这里既不对origin trim，也不对 ASC/DESC ignoreCase，希望前端严格传没有任何空格的字符串过来，减少传输数据量，节约服务器性能 + if (StringUtil.isName(origin) == false) { + throw new IllegalArgumentException("预编译模式下 @partition:value 中 " + item + " 不合法! value 里面用 , 分割的" + + "每一项必须是 column 且其中 column 必须是 英语单词！并且不要有多余的空格！"); + } } - suffix = expression.substring(end + 1, expression.length()); + keys[i] = gainKey(origin); + } - if (isPrepared() && (((String) suffix).contains("--") || ((String) suffix).contains("/*") || PATTERN_RANGE.matcher((String) suffix).matches() == false)) { - throw new UnsupportedOperationException("字符串 " + suffix + " 不合法！" - + "预编译模式下 @having:\"column?value;function(arg0,arg1,...)?value...\"" - + " 中 ?value 必须符合正则表达式 " + PATTERN_RANGE + " 且不包含连续减号 -- 或注释符 /* ！不允许多余的空格！"); + return (hasPrefix ? " PARTITION BY " : "") + StringUtil.concat(StringUtil.get(keys), joinPartition, ", "); + } + + @Override + public String getFill() { + return fill; + } + public AbstractSQLConfig setFill(String... conditions) { + return setFill(StringUtil.get(conditions)); + } + @Override + public AbstractSQLConfig setFill(String fill) { + this.fill = fill; + return this; + } + public String gainFillString(boolean hasPrefix) { + //加上子表的 fill + String joinFill = ""; + if (joinList != null) { + boolean first = true; + for (Join join : joinList) { + if (join.isAppJoin()) { + continue; + } + + SQLConfig ocfg = join.getOnConfig(); + SQLConfig cfg = (ocfg != null && ocfg.getFill() != null) || join.isLeftOrRightJoin() ? ocfg : join.getJoinConfig(); + + if (cfg != null) { + cfg.setMain(false).setKeyPrefix(true); + // if (StringUtil.isEmpty(cfg.getAlias(), true)) { + // cfg.setAlias(cfg.getTable()); + // } + String c = ((AbstractSQLConfig) cfg).gainFillString(false); + + if (StringUtil.isNotEmpty(c, true)) { + joinFill += (first ? "" : ", ") + c; + first = false; + } + } } + } - String[] ckeys = StringUtil.split(expression.substring(start + 1, end)); + String fill = StringUtil.trim(getFill()); - if (ckeys != null) { - for (int j = 0; j < ckeys.length; j++) { - String origin = ckeys[j]; + String[] keys = StringUtil.split(fill); + if (keys == null || keys.length <= 0) { + return StringUtil.isEmpty(joinFill, true) ? "" : (hasPrefix ? " FILL(" : "") + joinFill + ")"; + } - if (isPrepared()) { - if (origin.startsWith("_") || origin.contains("--") || PATTERN_FUNCTION.matcher(origin).matches() == false) { - throw new IllegalArgumentException("字符 " + ckeys[j] + " 不合法！" - + "预编译模式下 @having:\"column?value;function(arg0,arg1,...)?value...\"" - + " 中所有 column, arg 都必须是1个不以 _ 开头的单词 或者 符合正则表达式 " + PATTERN_FUNCTION + " 且不包含连续减号 -- ！不允许多余的空格！"); - } - } + for (int i = 0; i < keys.length; i++) { + String item = keys[i]; + if ("NULL".equals(item) || "LINEAR".equals(item) || "PREV".equals(item) || "PREVIOUS".equals(item)) { + continue; + } - //JOIN 副表不再在外层加副表名前缀 userId AS `Commet.userId`， 而是直接 userId AS `userId` - boolean isName = false; - if (StringUtil.isNumer(origin)) { - //do nothing - } - else if (StringUtil.isName(origin)) { - origin = quote + origin + quote; - isName = true; - } - else { - origin = getValue(origin).toString(); - } + String origin = item; - ckeys[j] = (isName && isKeyPrefix() ? tableAlias + "." : "") + origin; + if (isPrepared()) { //不能通过 ? 来代替，SELECT 'id','name' 返回的就是 id:"id", name:"name"，而不是数据库里的值！ + //这里既不对origin trim，也不对 ASC/DESC ignoreCase，希望前端严格传没有任何空格的字符串过来，减少传输数据量，节约服务器性能 + if (StringUtil.isName(origin)) {} + else if (StringUtil.isCombineOfNumOrAlpha(origin)) { + continue; + } + else { + throw new IllegalArgumentException("预编译模式下 @fill:value 中 " + item + " 不合法! value 里面用 , 分割的" + + "每一项必须是 column 且其中 column 必须是 数字或英语字母组合！并且不要有多余的空格！"); } } - keys[i] = method + "(" + StringUtil.getString(ckeys) + ")" + suffix; + keys[i] = gainKey(origin); } - //TODO 支持 OR, NOT 参考 @combine:"&key0,|key1,!key2" - return (hasPrefix ? " HAVING " : "") + StringUtil.concat(StringUtil.getString(keys, AND), joinHaving, AND); + return (hasPrefix ? " FILL(" : "") + StringUtil.concat(StringUtil.get(keys), joinFill, ", ") + ")"; } @Override public String getOrder() { return order; } - public AbstractSQLConfig setOrder(String... conditions) { - return setOrder(StringUtil.getString(conditions)); + public AbstractSQLConfig setOrder(String... conditions) { + return setOrder(StringUtil.get(conditions)); } @Override - public AbstractSQLConfig setOrder(String order) { + public AbstractSQLConfig setOrder(String order) { this.order = order; return this; } - @JSONField(serialize = false) - public String getOrderString(boolean hasPrefix) { + public String gainOrderString(boolean hasPrefix) { //加上子表的 order String joinOrder = ""; + String joinOuterOrder = ""; if (joinList != null) { - SQLConfig cfg; - String c; boolean first = true; - for (Join j : joinList) { - if (j.isAppJoin()) { + for (Join join : joinList) { + if (join.isAppJoin()) { continue; } - cfg = j.isLeftOrRightJoin() ? j.getOuterConfig() : j.getJoinConfig(); - if (StringUtil.isEmpty(cfg.getAlias(), true)) { - cfg.setAlias(cfg.getTable()); - } + SQLConfig ocfg = join.getOnConfig(); + SQLConfig cfg = (ocfg != null && ocfg.getOrder() != null) || join.isLeftOrRightJoin() ? ocfg : join.getJoinConfig(); - c = ((AbstractSQLConfig) cfg).getOrderString(false); - if (StringUtil.isEmpty(c, true) == false) { - joinOrder += (first ? "" : ", ") + c; - first = false; - } + if (cfg != null) { + cfg.setMain(false).setKeyPrefix(true); + //if (StringUtil.isEmpty(cfg.getAlias(), true)) { + // cfg.setAlias(cfg.getTable()); + //} + String c = ((AbstractSQLConfig) cfg).gainOrderString(false); + if (StringUtil.isNotEmpty(c, true)) { + joinOrder += (first ? "" : ", ") + c; + first = false; + } + } } } - String order = StringUtil.getTrimedString(getOrder()); + String order = StringUtil.trim(getOrder()); // SELECT * FROM sys.Moment ORDER BY userId ASC, rand(); 前面的 userId ASC 和后面的 rand() 都有效 // if ("rand()".equals(order)) { // return (hasPrefix ? " ORDER BY " : "") + StringUtil.concat(order, joinOrder, ", "); // } - if (getCount() > 0 && (isOracle() || isSQLServer() || isDb2())) { // Oracle, SQL Server, DB2 的 OFFSET 必须加 ORDER BY + if (getCount() > 0 && (isSQLServer() || isDb2())) { + // Oracle, SQL Server, DB2 的 OFFSET 必须加 ORDER BY.去掉Oracle，Oracle里面没有offset关键字 // String[] ss = StringUtil.split(order); if (StringUtil.isEmpty(order, true)) { //SQL Server 子查询内必须指定 OFFSET 才能用 ORDER BY String idKey = getIdKey(); if (StringUtil.isEmpty(idKey, true)) { - idKey = "id"; //ORDER BY NULL 不行，SQL Server 会报错，必须要有排序，才能使用 OFFSET FETCH，如果没有 idKey，请求中指定 @order 即可 + idKey = "id"; + // ORDER BY NULL 不行，SQL Server 会报错，必须要有排序，才能使用 OFFSET FETCH，如果没有 idKey，请求中指定 @order 即可 } order = idKey; //让数据库调控默认升序还是降序 + "+"; } @@ -744,10 +2131,20 @@ public String getOrderString(boolean hasPrefix) { } } - keys[i] = getKey(origin) + sort; + keys[i] = gainKey(origin) + sort; } - return (hasPrefix ? " ORDER BY " : "") + StringUtil.concat(StringUtil.getString(keys), joinOrder, ", "); + return (hasPrefix ? " ORDER BY " : "") + StringUtil.concat(StringUtil.get(keys), joinOrder, ", "); + } + + @Override + public Map getKeyMap() { + return keyMap; + } + @Override + public AbstractSQLConfig setKeyMap(Map keyMap) { + this.keyMap = keyMap; + return this; } @Override @@ -755,7 +2152,7 @@ public List getRaw() { return raw; } @Override - public SQLConfig setRaw(List raw) { + public AbstractSQLConfig setRaw(List raw) { this.raw = raw; return this; } @@ -767,7 +2164,22 @@ public SQLConfig setRaw(List raw) { * @throws Exception */ @Override - public String getRawSQL(String key, Object value) throws Exception { + public String gainRawSQL(String key, Object value) throws Exception { + return gainRawSQL(key, value, ! ALLOW_MISSING_KEY_4_COMBINE); + } + /**获取原始 SQL 片段 + * @param key + * @param value + * @param throwWhenMissing + * @return + * @throws Exception + */ + @Override + public String gainRawSQL(String key, Object value, boolean throwWhenMissing) throws Exception { + if (value == null) { + return null; + } + List rawList = getRaw(); boolean containRaw = rawList != null && rawList.contains(key); if (containRaw && value instanceof String == false) { @@ -778,11 +2190,15 @@ public String getRawSQL(String key, Object value) throws Exception { String rawSQL = containRaw ? RAW_MAP.get(value) : null; if (containRaw) { if (rawSQL == null) { - throw new UnsupportedOperationException("@raw:value 的 value 中 " + key + " 不合法！" - + "对应的 " + key + ":value 中 value 值 " + value + " 未在后端 RAW_MAP 中配置 ！"); - } + if (throwWhenMissing) { + throw new UnsupportedOperationException("@raw:value 的 value 中 " + key + " 不合法！" + + "对应的 " + key + ":value 中 value 值 " + value + " 未在后端 RAW_MAP 中配置 ！"); + } - if ("".equals(rawSQL)) { + putWarnIfNeed(JSONMap.KEY_RAW, "@raw:value 的 value 中 " + + key + " 不合法！对应的 " + key + ":value 中 value 值 " + value + " 未在后端 RAW_MAP 中配置 ！"); + } + else if (rawSQL.isEmpty()) { return (String) value; } } @@ -796,18 +2212,18 @@ public List getJson() { return json; } @Override - public AbstractSQLConfig setJson(List json) { + public AbstractSQLConfig setJson(List json) { this.json = json; return this; } @Override - public Subquery getFrom() { + public Subquery getFrom() { return from; } @Override - public AbstractSQLConfig setFrom(Subquery from) { + public AbstractSQLConfig setFrom(Subquery from) { this.from = from; return this; } @@ -817,34 +2233,96 @@ public List getColumn() { return column; } @Override - public AbstractSQLConfig setColumn(List column) { + public AbstractSQLConfig setColumn(List column) { this.column = column; return this; } - @JSONField(serialize = false) - public String getColumnString() throws Exception { - return getColumnString(false); + public String gainColumnString() throws Exception { + return gainColumnString(false); } - @JSONField(serialize = false) - public String getColumnString(boolean inSQLJoin) throws Exception { + public String gainColumnString(boolean inSQLJoin) throws Exception { + List column = getColumn(); + String as = gainAs(); + String q = getQuote(); + switch (getMethod()) { case HEAD: case HEADS: //StringUtil.isEmpty(column, true) || column.contains(",") 时SQL.count(column)会return "*" if (isPrepared() && column != null) { - String origin; - String alias; - int index; + List raw = getRaw(); + boolean containRaw = raw != null && raw.contains(KEY_COLUMN); + for (String c : column) { - index = c.lastIndexOf(":"); //StringUtil.split返回数组中，子项不会有null - origin = index < 0 ? c : c.substring(0, index); - alias = index < 0 ? null : c.substring(index + 1); - if (StringUtil.isName(origin) == false || (alias != null && StringUtil.isName(alias) == false)) { - throw new IllegalArgumentException("HEAD请求: 预编译模式下 @column:value 中 value里面用 , 分割的每一项" + if (containRaw) { + // 由于 HashMap 对 key 做了 hash 处理，所以 get 比 containsValue 更快 + if ("".equals(RAW_MAP.get(c)) || RAW_MAP.containsValue(c)) { // newSQLConfig 提前处理好的 + //排除@raw中的值，以避免使用date_format(date,'%Y-%m-%d %H:%i:%s') 时,冒号的解析出错 + //column.remove(c); + continue; + } + } + + int index = c.lastIndexOf(":"); //StringUtil.split返回数组中，子项不会有null + String origin = index < 0 ? c : c.substring(0, index); + String alias = index < 0 ? null : c.substring(index + 1); + + if (alias != null && StringUtil.isName(alias) == false) { + throw new IllegalArgumentException("HEAD请求: 字符 " + alias + + " 不合法！预编译模式下 @column:value 中 value里面用 , 分割的每一项" + " column:alias 中 column 必须是1个单词！如果有alias，则alias也必须为1个单词！并且不要有多余的空格！"); } + + if (StringUtil.isName(origin) == false) { + int start = origin.indexOf("("); + if (start < 0 || origin.lastIndexOf(")") <= start) { + throw new IllegalArgumentException("HEAD请求: 字符" + origin + + " 不合法！预编译模式下 @column:value 中 value里面用 , 分割的每一项" + + " column:alias 中 column 必须是1个单词！" + + "如果有alias，则 alias 也必须为1个单词！并且不要有多余的空格！"); + } + + if (start > 0 && StringUtil.isName(origin.substring(0, start)) == false) { + throw new IllegalArgumentException("HEAD请求: 字符 " + origin.substring(0, start) + + " 不合法！预编译模式下 @column:value 中 value里面用 , 分割的每一项" + + " column:alias 中 column 必须是1个单词！如果有alias，则alias也必须为1个单词！并且不要有多余的空格！"); + } + } + } + } + + boolean onlyOne = column != null && column.size() == 1; + String c0 = onlyOne ? column.get(0) : null; + + if (onlyOne) { + int index = c0 == null ? -1 : c0.lastIndexOf(":"); + if (index > 0) { + c0 = c0.substring(0, index); + } + + int start = c0 == null ? -1 : c0.indexOf("("); + int end = start <= 0 ? -1 : c0.lastIndexOf(")"); + if (start > 0 && end > start) { + String fun = c0.substring(0, start); + + // Invalid use of group function SELECT count(max(`id`)) AS count FROM `sys`.`Comment` + if (SQL_AGGREGATE_FUNCTION_MAP.containsKey(fun)) { + String group = getGroup(); // TODO 唯一 100% 兼容的可能只有 SELECT count(*) FROM (原语句) AS table + return StringUtil.isEmpty(group, true) ? "1" : "count(DISTINCT " + group + ")"; + } + + String[] args = start == end - 1 ? null : StringUtil.split(c0.substring(start + 1, end)); + if (args != null && args.length > 0) { + List raw = getRaw(); + boolean containRaw = raw != null && raw.contains(KEY_COLUMN); + c0 = parseSQLExpression(KEY_COLUMN, c0, containRaw, false, null); + } + + return "count(" + c0 + ")" + as + q + JSONResponse.KEY_COUNT + q; } } - return SQL.count(column != null && column.size() == 1 ? getKey(Pair.parseEntry(column.get(0), true).getKey()) : "*"); + + return "count(" + (onlyOne ? gainKey(c0) : "*") + ")" + as + q + JSONResponse.KEY_COUNT + q; + // return SQL.count(onlyOne && StringUtil.isName(column.get(0)) ? getKey(column.get(0)) : "*"); case POST: if (column == null || column.isEmpty()) { throw new IllegalArgumentException("POST 请求必须在Table内设置要保存的 key:value ！"); @@ -853,10 +2331,11 @@ public String getColumnString(boolean inSQLJoin) throws Exception { String s = ""; boolean pfirst = true; for (String c : column) { - if (isPrepared() && StringUtil.isName(c) == false) { //不能通过 ? 来代替，SELECT 'id','name' 返回的就是 id:"id", name:"name"，而不是数据库里的值！ + if (isPrepared() && StringUtil.isName(c) == false) { + // 不能通过 ? 来代替，SELECT 'id','name' 返回的就是 id:"id", name:"name"，而不是数据库里的值！ throw new IllegalArgumentException("POST请求: 每一个 key:value 中的key都必须是1个单词！"); } - s += ((pfirst ? "" : ",") + getKey(c)); + s += ((pfirst ? "" : ",") + gainKey(c)); pfirst = false; } @@ -864,224 +2343,503 @@ public String getColumnString(boolean inSQLJoin) throws Exception { return "(" + s + ")"; case GET: case GETS: - boolean isQuery = RequestMethod.isQueryMethod(method); //TODO 这个有啥用？上面应是 getMethod 的值 GET 和 GETS 了。 String joinColumn = ""; - if (isQuery && joinList != null) { - SQLConfig ecfg; - SQLConfig cfg; - String c; + if (joinList != null) { boolean first = true; - for (Join j : joinList) { - if (j.isAppJoin()) { + for (Join join : joinList) { + if (join.isAppJoin()) { continue; } - ecfg = j.getOuterConfig(); - if (ecfg != null && ecfg.getColumn() != null) { //优先级更高 - cfg = ecfg; - } - else { - cfg = j.getJoinConfig(); - } - - if (StringUtil.isEmpty(cfg.getAlias(), true)) { - cfg.setAlias(cfg.getTable()); - } + SQLConfig ocfg = join.getOnConfig(); + boolean isEmpty = ocfg == null || ocfg.getColumn() == null; + boolean isLeftOrRightJoin = join.isLeftOrRightJoin(); - c = ((AbstractSQLConfig) cfg).getColumnString(true); - if (StringUtil.isEmpty(c, true) == false) { - joinColumn += (first ? "" : ", ") + c; + if (isEmpty && isLeftOrRightJoin) { + // 改为 SELECT ViceTable.* 解决 SELECT sum(ViceTable.id) + // LEFT/RIGHT JOIN (SELECT sum(id) FROM ViceTable...) AS ViceTable + // 不仅导致 SQL 函数重复计算，还有时导致 SQL 报错或对应字段未返回 + joinColumn += (first ? "" : ", ") + q + SQLConfig.gainSQLAlias(join.getTable(), join.getAlias()) + q + ".*"; first = false; + } else { + SQLConfig cfg = isLeftOrRightJoin == false && isEmpty ? join.getJoinConfig() : ocfg; + if (cfg != null) { + cfg.setMain(false).setKeyPrefix(true); + //if (StringUtil.isEmpty(cfg.getAlias(), true)) { + // cfg.setAlias(cfg.getTable()); + //} + + String c = ((AbstractSQLConfig) cfg).gainColumnString(true); + if (StringUtil.isNotEmpty(c, true)) { + joinColumn += (first ? "" : ", ") + c; + first = false; + } + } } inSQLJoin = true; } } - String tableAlias = getAliasWithQuote(); - - // String c = StringUtil.getString(column); //id,name;json_length(contactIdList):contactCount;... + String tableAlias = q + gainSQLAlias() + q; + // String c = StringUtil.getString(column); //id,name;json_length(contactIdList):contactCount;... String[] keys = column == null ? null : column.toArray(new String[]{}); //StringUtil.split(c, ";"); if (keys == null || keys.length <= 0) { boolean noColumn = column != null && inSQLJoin; - String mc = isKeyPrefix() == false ? (noColumn ? "" : "*") : (noColumn ? "" : tableAlias + ".*"); + String mc = isKeyPrefix() ? (noColumn ? "" : tableAlias + ".*") : (noColumn ? "" : "*"); return StringUtil.concat(mc, joinColumn, ", ", true); } - List raw = getRaw(); boolean containRaw = raw != null && raw.contains(KEY_COLUMN); - String expression; - String method = null; - //...;fun0(arg0,arg1,...):fun0;fun1(arg0,arg1,...):fun1;... for (int i = 0; i < keys.length; i++) { - - //fun(arg0,arg1,...) - expression = keys[i]; + String expression = keys[i]; //fun(arg0,arg1,...) if (containRaw) { // 由于 HashMap 对 key 做了 hash 处理，所以 get 比 containsValue 更快 - if ("".equals(RAW_MAP.get(expression)) || RAW_MAP.containsValue(expression)) { // newSQLConfig 提前处理好的 + if ("".equals(RAW_MAP.get(expression)) || RAW_MAP.containsValue(expression)) { // newSQLConfig 提前处理好的 continue; } // 简单点， 后台配置就带上 AS - // int index = expression.lastIndexOf(":"); - // String alias = expression.substring(index+1); - // boolean hasAlias = StringUtil.isName(alias); - // String pre = index > 0 && hasAlias ? expression.substring(0, index) : expression; - // if (RAW_MAP.containsValue(pre) || "".equals(RAW_MAP.get(pre))) { // newSQLConfig 提前处理好的 - // expression = pre + (hasAlias ? " AS " + alias : ""); - // continue; - // } + int index = expression.lastIndexOf(":"); + String alias = expression.substring(index+1); + boolean hasAlias = StringUtil.isName(alias); + String pre = index > 0 && hasAlias ? expression.substring(0, index) : expression; + if (RAW_MAP.containsValue(pre) || "".equals(RAW_MAP.get(pre))) { // newSQLConfig 提前处理好的 + keys[i] = pre + (hasAlias ? gainAs() + q + alias + q : ""); + continue; + } } - if (expression.length() > 50) { + if (expression.length() > 100) { throw new UnsupportedOperationException("@column:value 的 value 中字符串 " + expression + " 不合法！" - + "不允许传超过 50 个字符的函数或表达式！请用 @raw 简化传参！"); + + "不允许传超过 100 个字符的函数或表达式！请用 @raw 简化传参！"); + } + keys[i] = parseSQLExpression(KEY_COLUMN, expression, containRaw, true + , "@column:\"column0,column1:alias1;function0(arg0,arg1,...);function1(...):alias2...\""); + } + + String c = StringUtil.get(keys); + c = c + (StringUtil.isEmpty(joinColumn, true) ? "" : ", " + joinColumn);//不能在这里改，后续还要用到: + return isMain() && isDistinct() ? PREFIX_DISTINCT + c : c; + default: + throw new UnsupportedOperationException( + "服务器内部错误：getColumnString 不支持 " + RequestMethod.getName(getMethod()) + + " 等 [GET,GETS,HEAD,HEADS,POST] 外的ReuqestMethod！" + ); + } + } + + /**解析@column 中以“;”分隔的表达式（"@column":"expression1;expression2;expression2;...."）中的expression + * @param key + * @param expression + * @param containRaw + * @param allowAlias + * @return + */ + public String parseSQLExpression(String key, String expression, boolean containRaw, boolean allowAlias) { + return parseSQLExpression(key, expression, containRaw, allowAlias, null); + } + /**解析@column 中以“;”分隔的表达式（"@column":"expression1;expression2;expression2;...."）中的expression + * @param key + * @param expression + * @param containRaw + * @param allowAlias + * @param example + * @return + */ + public String parseSQLExpression(String key, String expression, boolean containRaw, boolean allowAlias, String example) { + if (containRaw) { + String s = RAW_MAP.get(expression); + if ("".equals(s)) { + return expression; + } + if (s != null) { + return s; + } + } + + String quote = getQuote(); + int start = expression.indexOf('('); + if (start < 0) { + //没有函数 ,可能是字段,也可能是 DISTINCT xx + String[] cks = parseArgsSplitWithComma(expression, true, containRaw, allowAlias); + expression = StringUtil.get(cks); + } else { // FIXME 用括号断开？ 如果少的话，用关键词加括号断开，例如 )OVER( 和 )AGAINST( + // 窗口函数 rank() OVER (PARTITION BY id ORDER BY userId ASC) + // 全文索引 math(name,tag) AGAINST ('a b +c -d' IN NATURALE LANGUAGE MODE) // IN BOOLEAN MODE + + if (StringUtil.isEmpty(example)) { + if (KEY_COLUMN.equals(key)) { + example = key + ":\"column0,column1:alias1;function0(arg0,arg1,...);function1(...):alias2...\""; + } + // 和 key{}:"" 一样 else if (KEY_HAVING.equals(key) || KEY_HAVING_AND.equals(key)) { + // exeptionExample = key + ":\"function0(arg0,arg1,...)>1;function1(...)%5<=3...\""; + // } + else { + example = key + ":\"column0!=0;column1+3*2<=10;function0(arg0,arg1,...)>1;function1(...)%5<=3...\""; } + } + //有函数,但不是窗口函数 + int overIndex = expression.indexOf(")OVER("); // 传参不传空格，拼接带空格 ") OVER ("); + int againstIndex = expression.indexOf(")AGAINST("); // 传参不传空格，拼接带空格 ") AGAINST ("); + boolean containOver = overIndex > 0 && overIndex < expression.length() - ")OVER(".length(); + boolean containAgainst = againstIndex > 0 && againstIndex < expression.length() - ")AGAINST(".length(); + + if (containOver && containAgainst) { + throw new IllegalArgumentException("字符 " + expression + " 不合法！预编译模式下 " + example + + " 中 function 必须符合小写英文单词的 SQL 函数名格式！不能同时存在窗口函数关键词 OVER 和全文索引关键词 AGAINST！"); + } - int start = expression.indexOf("("); - int end = 0; - if (start >= 0) { - end = expression.indexOf(")"); - if (start >= end) { - throw new IllegalArgumentException("字符 " + expression + " 不合法！" - + "@column:value 中 value 里的 SQL函数必须为 function(arg0,arg1,...) 这种格式！"); + if (containOver == false && containAgainst == false) { + int end = expression.lastIndexOf(')'); + if (start >= end) { + throw new IllegalArgumentException("字符 " + expression + " 不合法！" + + key + ":value 中 value 里的 SQL函数必须为 function(arg0,arg1,...) 这种格式！"); + } + String fun = expression.substring(0, start); + if (fun.isEmpty() == false) { + if (SQL_FUNCTION_MAP == null || SQL_FUNCTION_MAP.isEmpty()) { + if (StringUtil.isName(fun) == false) { + throw new IllegalArgumentException("字符 " + fun + " 不合法！预编译模式下 " + example + + " 中 function 必须符合小写英文单词的 SQL 函数名格式！"); + } + } else if (SQL_FUNCTION_MAP.containsKey(fun) == false) { + throw new IllegalArgumentException("字符 " + fun + " 不合法！预编译模式下 " + example + + " 中 function 必须符合小写英文单词的 SQL 函数名格式！且必须是后端允许调用的 SQL 函数!"); } + } - method = expression.substring(0, start); - boolean distinct = i <= 0 && method.startsWith(PREFFIX_DISTINCT); - String fun = distinct ? method.substring(PREFFIX_DISTINCT.length()) : method; - - if (fun.isEmpty() == false && StringUtil.isName(fun) == false) { - throw new IllegalArgumentException("字符 " + method + " 不合法！" - + "预编译模式下 @column:\"column0,column1:alias;function0(arg0,arg1,...);function1(...):alias...\"" - + " 中SQL函数名 function 必须符合正则表达式 ^[0-9a-zA-Z_]+$ ！"); + String s = expression.substring(start + 1, end); + boolean distinct = s.startsWith(PREFIX_DISTINCT); + if (distinct) { + s = s.substring(PREFIX_DISTINCT.length()); + } + + // 解析函数内的参数 + String ckeys[] = parseArgsSplitWithComma(s, false, containRaw, allowAlias); + + String suffix = expression.substring(end + 1); //:contactCount + String alias = null; + if (allowAlias) { + int index = suffix.lastIndexOf(":"); + alias = index < 0 ? "" : suffix.substring(index + 1); //contactCount + suffix = index < 0 ? suffix : suffix.substring(0, index); + if (alias.isEmpty() == false && StringUtil.isName(alias) == false) { + throw new IllegalArgumentException("字符串 " + alias + " 不合法！预编译模式下 " + + key + ":value 中 value里面用 ; 分割的每一项" + + " function(arg0,arg1,...):alias 中 alias 必须是1个单词！并且不要有多余的空格！"); } - } - boolean isColumn = start < 0; + if (suffix.isEmpty() == false && (suffix.contains("--") || suffix.contains("/*") + || PATTERN_RANGE.matcher(suffix).matches() == false)) { + throw new UnsupportedOperationException("字符串 " + suffix + " 不合法！预编译模式下 " + key + + ":\"column?value;function(arg0,arg1,...)?value...\"" + + " 中 ?value 必须符合正则表达式 " + PATTERN_RANGE + " 且不包含连续减号 -- 或注释符 /* ！不允许多余的空格！"); + } - String[] ckeys = StringUtil.split(isColumn ? expression : expression.substring(start + 1, end)); - String quote = getQuote(); + String origin = fun + "(" + (distinct ? PREFIX_DISTINCT : "") + StringUtil.get(ckeys) + ")" + suffix; + expression = origin + (StringUtil.isEmpty(alias, true) ? "" : gainAs() + quote + alias + quote); + } + else { + //是窗口函数 fun(arg0,agr1) OVER (agr0 agr1 ...) + int keyIndex = containOver ? overIndex : againstIndex; + String s1 = expression.substring(0, keyIndex + 1); // OVER 前半部分 + String s2 = expression.substring(keyIndex + 1); // OVER 后半部分 - // if (isPrepared()) { //不能通过 ? 来代替，SELECT 'id','name' 返回的就是 id:"id", name:"name"，而不是数据库里的值！ - if (ckeys != null && ckeys.length > 0) { + int index1 = s1.indexOf("("); // 函数 "(" 的起始位置 + int end = s2.lastIndexOf(")"); // 后半部分 “)” 的位置 - boolean distinct; - String origin; - String alias; - int index; - for (int j = 0; j < ckeys.length; j++) { - index = isColumn ? ckeys[j].lastIndexOf(":") : -1; //StringUtil.split返回数组中，子项不会有null - origin = index < 0 ? ckeys[j] : ckeys[j].substring(0, index); - alias = index < 0 ? null : ckeys[j].substring(index + 1); + if (index1 >= end + s1.length()) { + throw new IllegalArgumentException("字符 " + expression + " 不合法！" + + key + ":value 中 value 里的 SQL 函数必须为 function(arg0,arg1,...) 这种格式！"); + } - distinct = j <= 0 && origin.startsWith(PREFFIX_DISTINCT); - if (distinct) { - origin = origin.substring(PREFFIX_DISTINCT.length()); + String fun = s1.substring(0, index1); // 函数名称 + if (fun.isEmpty() == false) { + if (SQL_FUNCTION_MAP == null || SQL_FUNCTION_MAP.isEmpty()) { + if (StringUtil.isName(fun) == false) { + throw new IllegalArgumentException("字符 " + fun + " 不合法！预编译模式下 " + example + + " 中 function 必须符合小写英文单词的 SQL 函数名格式！"); } + } + else if (SQL_FUNCTION_MAP.containsKey(fun) == false) { + throw new IllegalArgumentException("字符 " + fun + " 不合法！预编译模式下 " + example + + " 中 function 必须符合小写英文单词的 SQL 函数名格式！且必须是后端允许调用的 SQL 函数!"); + } + } - if (isPrepared()) { - if (isColumn) { - if (StringUtil.isName(origin) == false || (alias != null && StringUtil.isName(alias) == false)) { - throw new IllegalArgumentException("字符 " + ckeys[j] + " 不合法！" - + "预编译模式下 @column:value 中 value里面用 , 分割的每一项" - + " column:alias 中 column 必须是1个单词！如果有alias，则alias也必须为1个单词！" - + "DISTINCT 必须全大写，且后面必须有且只有 1 个空格！其它情况不允许空格！"); - } - } - else { - // if ((StringUtil.isName(origin) == false || origin.startsWith("_"))) { - if (origin.startsWith("_") || origin.contains("--") || PATTERN_FUNCTION.matcher(origin).matches() == false) { - throw new IllegalArgumentException("字符 " + ckeys[j] + " 不合法！" - + "预编译模式下 @column:\"column0,column1:alias;function0(arg0,arg1,...);function1(...):alias...\"" - + " 中所有 arg 都必须是1个不以 _ 开头的单词 或者符合正则表达式 " + PATTERN_FUNCTION + " 且不包含连续减号 -- ！DISTINCT 必须全大写，且后面必须有且只有 1 个空格！其它情况不允许空格！"); + // 获取前半部分函数的参数解析 fun(arg0,agr1) + String agrsString1[] = parseArgsSplitWithComma( + s1.substring(index1 + 1, s1.lastIndexOf(")")), false, containRaw, allowAlias + ); + + int index2 = s2.indexOf("("); // 后半部分 “(”的起始位置 + String argString2 = s2.substring(index2 + 1, end); // 后半部分的参数 + // 别名 + int aliasIndex = allowAlias ? s2.lastIndexOf(":") : -1; + String alias = aliasIndex < 0 ? "" : s2.substring(aliasIndex + 1); + if (alias.isEmpty() == false && StringUtil.isName(alias) == false) { + throw new IllegalArgumentException("字符串 " + alias + " 不合法！预编译模式下 " + + key + ":value 中 value里面用 ; 分割的每一项" + + " function(arg0,arg1,...):alias 中 alias 必须是1个单词！并且不要有多余的空格！"); + } + + String suffix = s2.substring(end + 1, aliasIndex < 0 ? s2.length() : aliasIndex); + if (suffix.isEmpty() == false && (suffix.contains("--") || suffix.contains("/*") + || PATTERN_RANGE.matcher(suffix).matches() == false)) { + throw new UnsupportedOperationException("字符串 " + suffix + " 不合法！预编译模式下 " + key + + ":\"column?value;function(arg0,arg1,...)?value...\"" + + " 中 ?value 必须符合正则表达式 " + PATTERN_RANGE + " 且不包含连续减号 -- 或注释符 /* ！不允许多余的空格！"); + } + + // 获取后半部分的参数解析 (agr0 agr1 ...) + String[] argsString2 = parseArgsSplitWithComma(argString2, false, containRaw, allowAlias); + expression = fun + "(" + StringUtil.get(agrsString1) + (containOver ? ") OVER (" : ") AGAINST (") + + StringUtil.get(argsString2) + ")" + suffix // 传参不传空格，拼接带空格 + + (StringUtil.isEmpty(alias, true) ? "" : gainAs() + quote + alias + quote); + } + } + + return expression; + } + + + /**解析函数参数或者字段,此函数对于解析字段 和 函数内参数通用 + * @param param + * @param isColumn true:不是函数参数。false:是函数参数 + * @param containRaw + * @param allowAlias + * @return + */ + private String[] parseArgsSplitWithComma(String param, boolean isColumn, boolean containRaw, boolean allowAlias) { + // 以"," 分割参数 + String quote = getQuote(); + boolean isKeyPrefix = isKeyPrefix(); + String tableAlias = quote + gainSQLAlias() + quote; + String[] ckeys = StringUtil.split(param); // 以","分割参数 + if (ckeys != null && ckeys.length > 0) { + + for (int i = 0; i < ckeys.length; i++) { + String ck = ckeys[i]; + + String origin; + String alias; + + // 如果参数包含 "'" ,解析字符串 + if (ck.startsWith("`") && ck.endsWith("`")) { + origin = ck.substring(1, ck.length() - 1); + //sql 注入判断 判断 + if (origin.startsWith("_") || StringUtil.isName(origin) == false) { + throw new IllegalArgumentException("字符 " + ck + " 不合法！" + + "预编译模式下 @column:\"`column0`,`column1`:alias;function0(arg0,arg1,...);function1(...):alias...\"" + + " 中所有字符串 column 都必须必须为1个单词 ！"); + } + + origin = gainKey(origin); + } + else if (ck.startsWith("'") && ck.endsWith("'")) { + origin = ck.substring(1, ck.length() - 1); + if (origin.contains("'")) { + throw new IllegalArgumentException("字符串 " + ck + " 不合法！" + + "预编译模式下 @column:\"column0,column1:alias;function0(arg0,arg1,...);function1(...):alias...\"" + + " 中字符串参数不合法，必须以 ' 开头, ' 结尾,字符串中不能包含 ' "); + } + + // 1.字符串不是字段也没有别名,所以不解析别名 2. 是字符串，进行预编译，使用getValue() ,对字符串进行截取 + origin = gainValue(origin).toString(); + } + else { + // 参数不包含",",即不是字符串 + // 解析参数:1. 字段 ,2. 是以空格分隔的参数 eg: cast(now() as date) + if ("=null".equals(ck)) { + origin = SQL.isNull(); + } + else if ("!=null".equals(ck)) { + origin = SQL.isNull(false); + } + else { + origin = ck; + alias = null; + if (allowAlias) { + int index = isColumn ? ck.lastIndexOf(":") : -1; //StringUtil.split返回数组中，子项不会有null + origin = index < 0 ? ck : ck.substring(0, index); //获取 : 之前的 + alias = index < 0 ? null : ck.substring(index + 1); + if (isPrepared()) { + if (isColumn) { + if (StringUtil.isName(origin) == false || (alias != null && StringUtil.isName(alias) == false)) { + throw new IllegalArgumentException("字符 " + ck + " 不合法！" + + "预编译模式下 @column:value 中 value里面用 , 分割的每一项" + + " column:alias 中 column 必须是1个单词！如果有alias，则alias也必须为1个单词！" + + "关键字必须全大写，且以空格分隔的参数，空格必须只有 1 个！其它情况不允许空格！"); + } + } else { + if (origin.startsWith("_") || origin.contains("--")) { + // || PATTERN_FUNCTION.matcher(origin).matches() == false) { + throw new IllegalArgumentException("字符 " + ck + " 不合法！" + + "预编译模式下 @column:\"column0,column1:alias;function0(arg0,arg1,...);function1(...):alias...\"" + + " 中所有 arg 都必须是1个不以 _ 开头的单词 或者符合正则表达式 " + + PATTERN_FUNCTION + " 且不包含连续减号 -- ！" + + "DISTINCT 必须全大写，且后面必须有且只有 1 个空格！其它情况不允许空格！"); + } } } } - //JOIN 副表不再在外层加副表名前缀 userId AS `Commet.userId`， 而是直接 userId AS `userId` - boolean isName = false; - if (StringUtil.isNumer(origin)) { - //do nothing - } - else if (StringUtil.isName(origin)) { - origin = quote + origin + quote; - isName = true; - } - else { - origin = getValue(origin).toString(); - } + // 以空格分割参数 + String[] mkes = containRaw ? StringUtil.split(ck, " ", true) : new String[]{ ck }; - if (isName && isKeyPrefix()) { - ckeys[j] = tableAlias + "." + origin; - // if (isColumn) { - // ckeys[j] += " AS " + quote + (isMain() ? "" : tableAlias + ".") + (StringUtil.isEmpty(alias, true) ? origin : alias) + quote; - // } - if (isColumn && StringUtil.isEmpty(alias, true) == false) { - ckeys[j] += " AS " + quote + alias + quote; - } + //如果参数中含有空格(少数情况) 比如 fun(arg1, arg2,arg3,arg4) 中的 arg1 arg2 arg3，比如 DISTINCT id + if (mkes != null && mkes.length >= 2) { + origin = parseArgsSplitWithSpace(mkes); } else { - ckeys[j] = origin + (StringUtil.isEmpty(alias, true) ? "" : " AS " + quote + alias + quote); - } + String mk = RAW_MAP.get(origin); + if (mk != null) { // newSQLConfig 提前处理好的 + if (mk.length() > 0) { + origin = mk; + } + } else if (StringUtil.isNumber(origin)) { + //do nothing + } else { + String[] keys = origin.split("[.]"); + StringBuilder sb = new StringBuilder(); + + int len = keys == null ? 0 : keys.length; + if (len > 0) { + boolean first = true; + for (String k : keys) { + if (StringUtil.isName(k) == false) { + sb = null; + break; + } + + sb.append(first ? "" : ".").append(quote).append(k).append(quote); + first = false; + } + } + + String s = sb == null ? null : sb.toString(); + if (StringUtil.isNotEmpty(s, true)) { + origin = (len == 1 && isKeyPrefix ? tableAlias + "." : "") + s; + } else { + origin = gainValue(origin).toString(); + } + } - if (distinct) { - ckeys[j] = PREFFIX_DISTINCT + ckeys[j]; + if (isColumn && StringUtil.isNotEmpty(alias, true)) { + origin += gainAs() + quote + alias + quote; + } } } - // } + } + + ckeys[i] = origin; + } + } + + return ckeys; + } + + /** + * 只解析以空格分隔的参数 + * + * @param mkes + * @return + */ + private String parseArgsSplitWithSpace(String[] mkes) { + String quote = getQuote(); + boolean isKeyPrefix = isKeyPrefix(); + String tableAlias = quote + gainSQLAlias() + quote; + + // 包含空格的参数 肯定不包含别名 不用处理别名 + if (mkes != null && mkes.length > 0) { + for (int j = 0; j < mkes.length; j++) { + // now()/AS/ DISTINCT/VALUE 等等放在RAW_MAP中 + String origin = mkes[j]; + + String mk = RAW_MAP.get(origin); + if (mk != null) { // newSQLConfig 提前处理好的 + if (mk.length() > 0) { + mkes[j] = mk; + } + continue; } - if (isColumn) { - keys[i] = StringUtil.getString(ckeys); + //这里为什么还要做一次判断 是因为解析窗口函数调用的时候会判断一次 + String ck = origin; + // 如果参数包含 "`" 或 "'" ,解析字符串 + if (ck.startsWith("`") && ck.endsWith("`")) { + origin = ck.substring(1, ck.length() - 1); + if (origin.startsWith("_") || StringUtil.isName(origin) == false) { + throw new IllegalArgumentException("字符 " + ck + " 不合法！" + + "预编译模式下 @column:\"`column0`,`column1`:alias;function0(arg0,arg1,...);function1(...):alias...\"" + + " 中所有字符串 column 都必须必须为1个单词 ！"); + } + + mkes[j] = gainKey(origin); + continue; } - else { - String suffix = expression.substring(end + 1, expression.length()); //:contactCount - int index = suffix.lastIndexOf(":"); - String alias = index < 0 ? "" : suffix.substring(index + 1); //contactCount - suffix = index < 0 ? suffix : suffix.substring(0, index); - - if (alias.isEmpty() == false && StringUtil.isName(alias) == false) { - throw new IllegalArgumentException("字符串 " + alias + " 不合法！" - + "预编译模式下 @column:value 中 value里面用 ; 分割的每一项" - + " function(arg0,arg1,...):alias 中 alias 必须是1个单词！并且不要有多余的空格！"); + else if (ck.startsWith("'") && ck.endsWith("'")) { + origin = ck.substring(1, ck.length() - 1); + if (origin.contains("'")) { + throw new IllegalArgumentException("字符串 " + ck + " 不合法！" + + "预编译模式下 @column:\"column0,column1:alias;function0(arg0,arg1,...);function1(...):alias...\"" + + " 中字符串参数不合法，必须以 ' 开头, ' 结尾,字符串中不能包含 ' "); } - - if (suffix.isEmpty() == false && (((String) suffix).contains("--") || ((String) suffix).contains("/*") || PATTERN_RANGE.matcher((String) suffix).matches() == false)) { - throw new UnsupportedOperationException("字符串 " + suffix + " 不合法！" - + "预编译模式下 @column:\"column?value;function(arg0,arg1,...)?value...\"" - + " 中 ?value 必须符合正则表达式 " + PATTERN_RANGE + " 且不包含连续减号 -- 或注释符 /* ！不允许多余的空格！"); + + // 1.字符串不是字段也没有别名,所以不解析别名 2. 是字符串，进行预编译，使用getValue() ,对字符串进行截取 + mkes[j] = gainValue(origin).toString(); + continue; + } + else if (ck.contains("`") || ck.contains("'") || origin.startsWith("_") || origin.contains("--")) { + // || PATTERN_FUNCTION.matcher(origin).matches() == false) { + throw new IllegalArgumentException("字符 " + origin + " 不合法！" + + "预编译模式下 @column:\"column0,column1:alias;function0(arg0,arg1,...);function1(...):alias...\"" + + " 中所有 arg 都必须是1个不以 _ 开头的单词 或者符合正则表达式 " + PATTERN_FUNCTION + + " 且不包含连续减号 -- ！DISTINCT 必须全大写，且后面必须有且只有 1 个空格！其它情况不允许空格！"); + } + + if (StringUtil.isNumber(origin)) { + //do nothing + } else { + String[] keys = origin.split("[.]"); + StringBuilder sb = new StringBuilder(); + + int len = keys == null ? 0 : keys.length; + if (len > 0) { + boolean first = true; + for (String k : keys) { + if (StringUtil.isName(k) == false) { + sb = null; + break; + } + + sb.append(first ? "" : ".").append(quote).append(k).append(quote); + first = false; + } } - String origin = method + "(" + StringUtil.getString(ckeys) + ")" + suffix; - // if (isKeyPrefix()) { - // keys[i] = origin + " AS " + quote + (isMain() ? "" : tableAlias + ".") + (StringUtil.isEmpty(alias, true) ? method : alias) + quote; - // } - // else { - keys[i] = origin + (StringUtil.isEmpty(alias, true) ? "" : " AS " + quote + alias + quote); - // } + String s = sb == null ? null : sb.toString(); + if (StringUtil.isNotEmpty(s, true)) { + origin = (len == 1 && isKeyPrefix ? tableAlias + "." : "") + s; + } else { + origin = gainValue(origin).toString(); + } } + mkes[j] = origin; } - - String c = StringUtil.getString(keys); - c = c + (StringUtil.isEmpty(joinColumn, true) ? "" : ", " + joinColumn);//不能在这里改，后续还要用到: - return isMain() && isDistinct() ? PREFFIX_DISTINCT + c : c; - default: - throw new UnsupportedOperationException( - "服务器内部错误：getColumnString 不支持 " + RequestMethod.getName(getMethod()) - + " 等 [GET,GETS,HEAD,HEADS,POST] 外的ReuqestMethod！" - ); } + // 返回重新以" "拼接后的参数 + return StringUtil.join(mkes, " "); } @@ -1089,7 +2847,6 @@ else if (StringUtil.isName(origin)) { public List> getValues() { return values; } - @JSONField(serialize = false) public String getValuesString() { String s = ""; if (values != null && values.size() > 0) { @@ -1103,16 +2860,16 @@ public String getValuesString() { items[i] = "("; for (int j = 0; j < vs.size(); j++) { - items[i] += ((j <= 0 ? "" : ",") + getValue(vs.get(j))); + items[i] += ((j <= 0 ? "" : ",") + gainValue(vs.get(j))); } items[i] += ")"; } - s = StringUtil.getString(items); + s = StringUtil.get(items); } return s; } @Override - public AbstractSQLConfig setValues(List> valuess) { + public AbstractSQLConfig setValues(List> valuess) { this.values = valuess; return this; } @@ -1122,7 +2879,7 @@ public Map getContent() { return content; } @Override - public AbstractSQLConfig setContent(Map content) { + public AbstractSQLConfig setContent(Map content) { this.content = content; return this; } @@ -1132,7 +2889,7 @@ public int getCount() { return count; } @Override - public AbstractSQLConfig setCount(int count) { + public AbstractSQLConfig setCount(int count) { this.count = count; return this; } @@ -1141,7 +2898,7 @@ public int getPage() { return page; } @Override - public AbstractSQLConfig setPage(int page) { + public AbstractSQLConfig setPage(int page) { this.page = page; return this; } @@ -1150,7 +2907,7 @@ public int getPosition() { return position; } @Override - public AbstractSQLConfig setPosition(int position) { + public AbstractSQLConfig setPosition(int position) { this.position = position; return this; } @@ -1160,16 +2917,26 @@ public int getQuery() { return query; } @Override - public AbstractSQLConfig setQuery(int query) { + public AbstractSQLConfig setQuery(int query) { this.query = query; return this; } + @Override + public Boolean getCompat() { + return compat; + } + @Override + public AbstractSQLConfig setCompat(Boolean compat) { + this.compat = compat; + return this; + } + @Override public int getType() { return type; } @Override - public AbstractSQLConfig setType(int type) { + public AbstractSQLConfig setType(int type) { this.type = type; return this; } @@ -1179,39 +2946,40 @@ public int getCache() { return cache; } @Override - public AbstractSQLConfig setCache(int cache) { + public AbstractSQLConfig setCache(int cache) { this.cache = cache; return this; } - public AbstractSQLConfig setCache(String cache) { + public AbstractSQLConfig setCache(String cache) { return setCache(getCache(cache)); } public static int getCache(String cache) { int cache2; if (cache == null) { - cache2 = JSONRequest.CACHE_ALL; + cache2 = JSONMap.CACHE_ALL; } else { // if (isSubquery) { - // throw new IllegalArgumentException("子查询内不支持传 " + JSONRequest.KEY_CACHE + "!"); + // throw new IllegalArgumentException("子查询内不支持传 " + apijson.JSONMap.KEY_CACHE + "!"); // } switch (cache) { case "0": - case JSONRequest.CACHE_ALL_STRING: - cache2 = JSONRequest.CACHE_ALL; + case JSONMap.CACHE_ALL_STRING: + cache2 = JSONMap.CACHE_ALL; break; case "1": - case JSONRequest.CACHE_ROM_STRING: - cache2 = JSONRequest.CACHE_ROM; + case JSONMap.CACHE_ROM_STRING: + cache2 = JSONMap.CACHE_ROM; break; case "2": - case JSONRequest.CACHE_RAM_STRING: - cache2 = JSONRequest.CACHE_RAM; + case JSONMap.CACHE_RAM_STRING: + cache2 = JSONMap.CACHE_RAM; break; default: - throw new IllegalArgumentException(JSONRequest.KEY_CACHE + ":value 中 value 的值不合法！必须在 [0,1,2] 或 [ALL, ROM, RAM] 内 !"); + throw new IllegalArgumentException(JSONMap.KEY_CACHE + + ":value 中 value 的值不合法！必须在 [0,1,2] 或 [ALL, ROM, RAM] 内 !"); } } return cache2; @@ -1222,17 +2990,17 @@ public boolean isExplain() { return explain; } @Override - public AbstractSQLConfig setExplain(boolean explain) { + public AbstractSQLConfig setExplain(boolean explain) { this.explain = explain; return this; } @Override - public List getJoinList() { + public List> getJoinList() { return joinList; } @Override - public SQLConfig setJoinList(List joinList) { + public AbstractSQLConfig setJoinList(List> joinList) { this.joinList = joinList; return this; } @@ -1247,7 +3015,7 @@ public boolean isTest() { return test; } @Override - public AbstractSQLConfig setTest(boolean test) { + public AbstractSQLConfig setTest(boolean test) { this.test = test; return this; } @@ -1255,7 +3023,6 @@ public AbstractSQLConfig setTest(boolean test) { /**获取初始位置offset * @return */ - @JSONField(serialize = false) public int getOffset() { return getOffset(getPage(), getCount()); } @@ -1267,101 +3034,200 @@ public int getOffset() { public static int getOffset(int page, int count) { return page*count; } - /**获取限制数量 - * @return - */ - @JSONField(serialize = false) - public String getLimitString() { - if (count <= 0 || RequestMethod.isHeadMethod(getMethod(), true)) { - return ""; - } - return getLimitString(getPage(), getCount(), isOracle() || isSQLServer() || isDb2()); + /**获取限制数量 + * @return + */ + public String gainLimitString() { + int count = getCount(); + int page = getPage(); + + boolean isMilvus = isMilvus(); + if ((count <= 0 && ! (isMilvus && isMain())) || RequestMethod.isHeadMethod(getMethod(), true)) { // TODO HEAD 真的不需要 LIMIT ？ + return ""; + } + + boolean isSurrealDB = isSurrealDB(); + boolean isQuestDB = isQuestDB(); + if (isSurrealDB || isQuestDB || isMilvus) { + if (count == 0) { + Parser parser = gainParser(); + count = parser == null ? AbstractParser.MAX_QUERY_COUNT : parser.getMaxQueryCount(); + } + + int offset = getOffset(page, count); + if (isQuestDB()) { + return " LIMIT " + offset + ", " + (offset + count); + } + else if (isSurrealDB()) { + return " START " + offset + " LIMIT " + count; + } + else { + return " LIMIT " + offset + ", " + count; // 目前 moql-transx 的限制 + } + } + + boolean isOracle = isOracle(); + return gainLimitString(page, count, isTSQL(), isOracle || isDameng() || isKingBase(), isPresto() || isTrino()); + } + /**获取限制数量及偏移量 + * @param page + * @param count + * @param isTSQL + * @param isOracle + * @return + */ + public static String gainLimitString(int page, int count, boolean isTSQL, boolean isOracle) { + return gainLimitString(page, count, isTSQL, isOracle, false); + } + /**获取限制数量及偏移量 + * @param page + * @param count + * @param isTSQL + * @param isOracle + * @param isPresto + * @return + */ + public static String gainLimitString(int page, int count, boolean isTSQL, boolean isOracle, boolean isPresto) { + int offset = getOffset(page, count); + + if (isOracle) { // TODO 判断版本，高版本可以用 OFFSET FETCH + return " WHERE ROWNUM BETWEEN " + offset + " AND " + (offset + count); + } + + if (isTSQL) { // OFFSET FECTH 中所有关键词都不可省略, 另外 Oracle 数据库使用子查询加 where 分页 + return " OFFSET " + offset + " ROWS FETCH FIRST " + count + " ROWS ONLY"; + } + + if (isPresto) { // https://prestodb.io/docs/current/sql/select.html + return (offset <= 0 ? "" : " OFFSET " + offset) + " LIMIT " + count; + } + + return " LIMIT " + count + (offset <= 0 ? "" : " OFFSET " + offset); // DELETE, UPDATE 不支持 OFFSET + } + + @Override + public List getNull() { + return nulls; + } + @Override + public AbstractSQLConfig setNull(List nulls) { + this.nulls = nulls; + return this; + } + + @Override + public Map getCast() { + return cast; + } + @Override + public AbstractSQLConfig setCast(Map cast) { + this.cast = cast; + return this; } - /**获取限制数量 - * @param limit - * @return - */ - public static String getLimitString(int page, int count, boolean isTSQL) { - int offset = getOffset(page, count); - if (isTSQL) { - return " OFFSET " + offset + " ROWS FETCH FIRST " + count + " ROWS ONLY"; - } + //WHERE <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< - return " LIMIT " + count + " OFFSET " + offset; + protected int getMaxHavingCount() { + return MAX_HAVING_COUNT; + } + protected int getMaxWhereCount() { + return MAX_WHERE_COUNT; + } + protected int getMaxCombineDepth() { + return MAX_COMBINE_DEPTH; + } + protected int getMaxCombineCount() { + return MAX_COMBINE_COUNT; + } + protected int getMaxCombineKeyCount() { + return MAX_COMBINE_KEY_COUNT; + } + protected float getMaxCombineRatio() { + return MAX_COMBINE_RATIO; } - //WHERE <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< + @Override - public Map getWhere() { - return where; + public String getCombine() { + return combine; } @Override - public AbstractSQLConfig setWhere(Map where) { - this.where = where; + public AbstractSQLConfig setCombine(String combine) { + this.combine = combine; return this; } + @NotNull @Override - public Map> getCombine() { - List andList = combine == null ? null : combine.get("&"); + public Map> getCombineMap() { + List andList = combineMap == null ? null : combineMap.get("&"); if (andList == null) { andList = where == null ? new ArrayList() : new ArrayList(where.keySet()); - if (combine == null) { - combine = new HashMap<>(); + if (combineMap == null) { + combineMap = new HashMap<>(); } - combine.put("&", andList); + combineMap.put("&", andList); } - return combine; + return combineMap; } @Override - public AbstractSQLConfig setCombine(Map> combine) { - this.combine = combine; + public AbstractSQLConfig setCombineMap(Map> combineMap) { + this.combineMap = combineMap; + return this; + } + + @Override + public Map getWhere() { + return where; + } + @Override + public AbstractSQLConfig setWhere(Map where) { + this.where = where; return this; } + /** * noFunctionChar = false * @param key * @return */ - @JSONField(serialize = false) @Override public Object getWhere(String key) { return getWhere(key, false); } + //CS304 Issue link: https://github.com/Tencent/APIJSON/issues/48 /** - * @param key - * @param exactMatch + * @param key - the key passed in + * @param exactMatch - whether it is exact match * @return + *

use entrySet+getValue() to replace keySet+get() to enhance efficiency

*/ - @JSONField(serialize = false) @Override public Object getWhere(String key, boolean exactMatch) { if (exactMatch) { return where == null ? null : where.get(key); } - Set set = key == null || where == null ? null : where.keySet(); - if (set != null) { - synchronized (where) { - if (where != null) { - int index; - for (String k : set) { - index = k.indexOf(key); - if (index >= 0 && StringUtil.isName(k.substring(index)) == false) { - return where.get(k); - } - } - } + if (key == null || where == null){ + return null; + } + + int index; + for (Entry entry : where.entrySet()) { + String k = entry.getKey(); + index = k.indexOf(key); + if (index >= 0 && StringUtil.isName(k.substring(index, index + 1)) == false) { + return entry.getValue(); } } + return null; } @Override - public AbstractSQLConfig putWhere(String key, Object value, boolean prior) { + public AbstractSQLConfig putWhere(String key, Object value, boolean prior) { if (key != null) { if (where == null) { - where = new LinkedHashMap(); + where = new LinkedHashMap<>(); } if (value == null) { where.remove(key); @@ -1369,10 +3235,12 @@ public AbstractSQLConfig putWhere(String key, Object value, boolean prior) { where.put(key, value); } - combine = getCombine(); - List andList = combine.get("&"); + Map> combineMap = getCombineMap(); + List andList = combineMap.get("&"); if (value == null) { - andList.remove(key); + if (andList != null) { + andList.remove(key); + } } else if (andList == null || andList.contains(key) == false) { int i = 0; @@ -1386,48 +3254,410 @@ else if (prior && andList.isEmpty() == false) { String userIdKey = getUserIdKey(); String userIdInKey = userIdKey + "{}"; - if (andList.contains(idKey)) { - i ++; + int lastIndex; + if (key.equals(idKey)) { + setId(value); + lastIndex = -1; } - if (andList.contains(idInKey)) { - i ++; + else if (key.equals(idInKey)) { + setIdIn(value); + lastIndex = andList.lastIndexOf(idKey); } - if (andList.contains(userIdKey)) { - i ++; + else if (key.equals(userIdKey)) { + setUserId(value); + lastIndex = andList.lastIndexOf(idInKey); + if (lastIndex < 0) { + lastIndex = andList.lastIndexOf(idKey); + } } - if (andList.contains(userIdInKey)) { - i ++; + else if (key.equals(userIdInKey)) { + setUserIdIn(value); + lastIndex = andList.lastIndexOf(userIdKey); + if (lastIndex < 0) { + lastIndex = andList.lastIndexOf(idInKey); + } + if (lastIndex < 0) { + lastIndex = andList.lastIndexOf(idKey); + } + } + else { + lastIndex = andList.lastIndexOf(userIdInKey); + if (lastIndex < 0) { + lastIndex = andList.lastIndexOf(userIdKey); + } + if (lastIndex < 0) { + lastIndex = andList.lastIndexOf(idInKey); + } + if (lastIndex < 0) { + lastIndex = andList.lastIndexOf(idKey); + } } + + i = lastIndex + 1; } if (prior) { - andList.add(i, key); //userId的优先级不能比id高 0, key); + andList.add(i, key); // userId 的优先级不能比 id 高 0, key); } else { - andList.add(key); //AbstractSQLExecutor.onPutColumn里getSQL，要保证缓存的SQL和查询的SQL里 where 的 key:value 顺序一致 + // AbstractSQLExecutor.onPutColumn 里 getSQL，要保证缓存的 SQL 和查询的 SQL 里 where 的 key:value 顺序一致 + andList.add(key); } } - combine.put("&", andList); + combineMap.put("&", andList); } + return this; } /**获取WHERE * @return - * @throws Exception + * @throws Exception */ - @JSONField(serialize = false) @Override - public String getWhereString(boolean hasPrefix) throws Exception { - return getWhereString(hasPrefix, getMethod(), getWhere(), getCombine(), getJoinList(), ! isTest()); + public String gainWhereString(boolean hasPrefix) throws Exception { + String combineExpr = getCombine(); + if (StringUtil.isEmpty(combineExpr, false)) { + return getWhereString(hasPrefix, getMethod(), getWhere(), getCombineMap(), getJoinList(), ! isTest()); + } + return getWhereString(hasPrefix, getMethod(), getWhere(), combineExpr, getJoinList(), ! isTest()); } /**获取WHERE * @param method * @param where * @return - * @throws Exception + * @throws Exception + */ + public String getWhereString(boolean hasPrefix, RequestMethod method, Map where + , String combine, List> joinList, boolean verifyName) throws Exception { + String whereString = parseCombineExpression(method, getQuote(), getTable(), getAlias() + , where, combine, verifyName, false, false); + whereString = concatJoinWhereString(whereString); + String result = StringUtil.isEmpty(whereString, true) ? "" : (hasPrefix ? " WHERE " : "") + whereString; + + if (result.isEmpty() && RequestMethod.isQueryMethod(method) == false) { + throw new UnsupportedOperationException("写操作请求必须带条件！！！"); + } + + return result; + } + + /**解析 @combine 条件 key 组合的与或非+括号的逻辑运算表达式为具体的完整条件组合 + * @param method + * @param quote + * @param table + * @param alias + * @param conditionMap where 或 having 对应条件的 Map + * @param combine + * @param verifyName + * @param containRaw + * @param isHaving + * @return + * @throws Exception + */ + protected String parseCombineExpression(RequestMethod method, String quote, String table, String alias + , Map conditionMap, String combine, boolean verifyName, boolean containRaw, boolean isHaving) throws Exception { + + String errPrefix = table + (isHaving ? ":{ @having:{ " : ":{ ") + "@combine:'" + combine + (isHaving ? "' } }" : "' }"); + String s = StringUtil.get(combine); + if (s.startsWith(" ") || s.endsWith(" ") ) { + throw new IllegalArgumentException(errPrefix + " 中字符 '" + s + + "' 不合法！不允许首尾有空格，也不允许连续空格！空格不能多也不能少！" + + "逻辑连接符 & | 左右必须各一个相邻空格！左括号 ( 右边和右括号 ) 左边都不允许有相邻空格！"); + } + + if (conditionMap == null) { + conditionMap = new HashMap<>(); + } + int size = conditionMap.size(); + + int maxCount = isHaving ? getMaxHavingCount() : getMaxWhereCount(); + if (maxCount > 0 && size > maxCount) { + throw new IllegalArgumentException(table + (isHaving ? ":{ @having:{ " : ":{ ") + "key0:value0, key1:value1... " + combine + + (isHaving ? " } }" : " }") + " 中条件 key:value 数量 " + size + " 已超过最大数量，必须在 0-" + maxCount + " 内！"); + } + + String result = ""; + + List preparedValues = getPreparedValueList(); + if (preparedValues == null && isHaving == false) { + preparedValues = new ArrayList<>(); + } + + Map usedKeyCountMap = new HashMap<>(size); + + int n = s.length(); + if (n > 0) { + if (isHaving == false) { // 只收集表达式条件值 + setPreparedValueList(new ArrayList<>()); // 必须反过来，否则 JOIN ON 内部 @combine 拼接后顺序错误 + } + + int maxDepth = getMaxCombineDepth(); + int maxCombineCount = getMaxCombineCount(); + int maxCombineKeyCount = getMaxCombineKeyCount(); + float maxCombineRatio = getMaxCombineRatio(); + + int depth = 0; + int allCount = 0; + + int i = 0; + + char lastLogic = 0; + char last = 0; + boolean first = true; + boolean isNot = false; + + String key = ""; + while (i <= n) { // "date> | (contactIdList<> & (name*~ | tag&$))" + boolean isOver = i >= n; + char c = isOver ? 0 : s.charAt(i); + boolean isBlankOrRightParenthesis = c == ' ' || c == ')'; + if (isOver || isBlankOrRightParenthesis) { + boolean isEmpty = StringUtil.isEmpty(key, true); + if (isEmpty && last != ')') { + throw new IllegalArgumentException(errPrefix + " 中字符 '" + (isOver ? s : s.substring(i)) + + "' 不合法！" + (c == ' ' ? "空格 ' ' " : "右括号 ')'") + " 左边缺少条件 key ！逻辑连接符 & | 左右必须各一个相邻空格！" + + "空格不能多也不能少！不允许首尾有空格，也不允许连续空格！左括号 ( 的右边 和 右括号 ) 的左边 都不允许有相邻空格！"); + } + + if (isEmpty == false) { + if (first == false && lastLogic <= 0) { + throw new IllegalArgumentException(errPrefix + " 中字符 " + + "'" + s.substring(i - key.length() - (isOver ? 1 : 0)) + + "' 不合法！左边缺少 & | 其中一个逻辑连接符！"); + } + + allCount ++; + if (allCount > maxCombineCount && maxCombineCount > 0) { + throw new IllegalArgumentException(errPrefix + " 中字符 '" + s + "' 不合法！" + + "其中 key 数量 " + allCount + " 已超过最大值，必须在条件键值对数量 0-" + maxCombineCount + " 内！"); + } + + String column = key; + int keyIndex = column.indexOf(":"); + column = keyIndex > 0 ? column.substring(0, keyIndex) : column; + Object value = conditionMap.get(column); + String wi = ""; + if (value == null && conditionMap.containsKey(column) == false) { // 兼容@null + isNot = false; // 以占位表达式为准 + size++; // 兼容 key 数量判断 + wi = keyIndex > 0 ? key.substring(keyIndex + 1) : ""; + if (StringUtil.isEmpty(wi)) { + throw new IllegalArgumentException(errPrefix + " 中字符 '" + + key + "' 对应的条件键值对 " + column + ":value 不存在！"); + } + } else { + wi = isHaving ? gainHavingItem(quote, table, alias, column, (String) value, containRaw) + : gainWhereItem(column, value, method, verifyName); + } + + if (1.0f*allCount/size > maxCombineRatio && maxCombineRatio > 0) { + throw new IllegalArgumentException(errPrefix + " 中字符 '" + s + "' 不合法！" + + "其中 key 数量 " + allCount + " / 条件键值对数量 " + size + " = " + (1.0f*allCount/size) + + " 已超过 最大倍数，必须在条件键值对数量 0-" + maxCombineRatio + " 倍内！"); + } + + if (StringUtil.isEmpty(wi, true)) { // 转成 1=1 ? + throw new IllegalArgumentException(errPrefix + " 中字符 '" + key + + "' 对应的 " + column + ":value 不是有效条件键值对！"); + } + + Integer count = usedKeyCountMap.get(column); + count = count == null ? 1 : count + 1; + if (count > maxCombineKeyCount && maxCombineKeyCount > 0) { + throw new IllegalArgumentException(errPrefix + " 中字符 '" + s + "' 不合法！" + + "其中 '" + column + "' 重复引用，次数 " + count + + " 已超过最大值，必须在 0-" + maxCombineKeyCount + " 内！"); + } + usedKeyCountMap.put(column, count); + + result += "( " + gainCondition(isNot, wi) + " )"; + isNot = false; + first = false; + } + + key = ""; + lastLogic = 0; + + if (isOver) { + break; + } + } + + if (c == ' ') { + } + else if (c == '&') { + if (last == ' ') { + if (i >= n - 1 || s.charAt(i + 1) != ' ') { + throw new IllegalArgumentException(errPrefix + " 中字符 '" + (i >= n - 1 ? s : s.substring(0, i + 1)) + + "' 不合法！逻辑连接符 & 右边缺少一个空格 ！逻辑连接符 & | 左右必须各一个相邻空格！空格不能多也不能少！" + + "不允许首尾有空格，也不允许连续空格！左括号 ( 的右边 和 右括号 ) 的左边 都不允许有相邻空格！"); + } + + result += SQL.AND; + lastLogic = c; + i ++; + } + else { + key += c; + } + } + else if (c == '|') { + if (last == ' ') { + if (i >= n - 1 || s.charAt(i + 1) != ' ') { + throw new IllegalArgumentException(table + ":{ @combine: '" + combine + + "' } 中字符 '" + (i >= n - 1 ? s : s.substring(0, i + 1)) + + "' 不合法！逻辑连接符 | 右边缺少一个空格 ！逻辑连接符 & | 左右必须各一个相邻空格！空格不能多也不能少！" + + "不允许首尾有空格，也不允许连续空格！左括号 ( 右边和右括号 ) 左边都不允许有相邻空格！"); + } + + result += SQL.OR; + lastLogic = c; + i ++; + } + else { + key += c; + } + } + else if (c == '!') { + last = i <= 0 ? 0 : s.charAt(i - 1); // & | 后面跳过了空格 + + char next = i >= n - 1 ? 0 : s.charAt(i + 1); + if (last == ' ' || last == '(') { + if (next == ' ') { + throw new IllegalArgumentException(errPrefix + " 中字符 '" + s.substring(0, i + 1) + + "' 不合法！非逻辑符 '!' 右边多了一个空格 ' ' ！非逻辑符 '!' " + + "右边不允许任何相邻空格 ' '，也不允许 ')' '&' '|' 中任何一个！"); + } + if (next == ')' || next == '&' || next == '!') { + throw new IllegalArgumentException(errPrefix + " 中字符 '" + s.substring(0, i + 1) + + "' 不合法！非逻辑符 '!' 右边多了一个字符 '" + + next + "' ！非逻辑符 '!' 右边不允许任何相邻空格 ' '，也不允许 ')' '&' '|' 中任何一个！"); + } + if (i > 0 && lastLogic <= 0 && last != '(') { + throw new IllegalArgumentException(errPrefix + " 中字符 '" + s.substring(i) + + "' 不合法！左边缺少 & | 逻辑连接符！逻辑连接符 & | 左右必须各一个相邻空格！空格不能多也不能少！" + + "不允许首尾有空格，也不允许连续空格！左括号 ( 的右边 和 右括号 ) 的左边 都不允许有相邻空格！"); + } + } + + if (next == '(') { + result += SQL.NOT; + lastLogic = c; + } + else if (last <= 0 || last == ' ' || last == '(') { + isNot = true; + // lastLogic = c; + } + else { + key += c; + } + } + else if (c == '(') { + if (key.isEmpty() == false || (i > 0 && lastLogic <= 0 && last != '(')) { + throw new IllegalArgumentException(errPrefix + " 中字符 '" + s.substring(i) + + "' 不合法！左边缺少 & | 逻辑连接符！逻辑连接符 & | 左右必须各一个相邻空格！空格不能多也不能少！" + + "不允许首尾有空格，也不允许连续空格！左括号 ( 的右边 和 右括号 ) 的左边 都不允许有相邻空格！"); + } + + depth ++; + if (depth > maxDepth && maxDepth > 0) { + throw new IllegalArgumentException(errPrefix + " 中字符 '" + s.substring(0, i + 1) + + "' 不合法！括号 (()) 嵌套层级 " + depth + " 已超过最大值，必须在 0-" + maxDepth + " 内！"); + } + + result += c; + lastLogic = 0; + first = true; + } + else if (c == ')') { + depth --; + if (depth < 0) { + throw new IllegalArgumentException(errPrefix + " 中字符 '" + s.substring(0, i + 1) + + "' 不合法！左括号 ( 比 右括号 ) 少！数量必须相等从而完整闭合 (...) ！"); + } + + result += c; + lastLogic = 0; + } + else { + key += c; + } + + last = c; + i ++; + } + + if (depth != 0) { + throw new IllegalArgumentException(errPrefix + " 中字符 '" + s + + "' 不合法！左括号 ( 比 右括号 ) 多！数量必须相等从而完整闭合 (...) ！"); + } + } + + List exprPreparedValues = getPreparedValueList(); + if (isHaving == false) { // 只收集 AND 条件值 + setPreparedValueList(new ArrayList<>()); + } + + Set> set = conditionMap.entrySet(); + + String andCond = ""; + boolean isItemFirst = true; + + for (Entry entry : set) { + String key = entry == null ? null : entry.getKey(); + if (key == null || usedKeyCountMap.containsKey(key)) { + continue; + } + + String wi = isHaving ? gainHavingItem(quote, table, alias, key, (String) entry.getValue(), containRaw) + : gainWhereItem(key, entry.getValue(), method, verifyName); + if (StringUtil.isEmpty(wi, true)) {//避免SQL条件连接错误 + continue; + } + + andCond += (isItemFirst ? "" : AND) + "(" + wi + ")"; + isItemFirst = false; + } + + if (isHaving == false) { // 优先存放 AND 条件值 + preparedValues.addAll(getPreparedValueList()); + } + + if (StringUtil.isEmpty(result, true)) { + result = andCond; + } + else if (StringUtil.isNotEmpty(andCond, true)) { // andCond 必须放后面，否则 prepared 值顺序错误 + if (isHaving) { + // HAVING 前 WHERE 已经有条件 ? 占位，不能反过来，想优化 AND 连接在最前，需要多遍历一次内部的 key，也可以 newSQLConfig 时存到 andList + result = "( " + result + " )" + AND + andCond; + } + else { + result = andCond + AND + "( " + result + " )"; // 先暂存之前的 prepared 值，然后反向整合 + } + } + + if (isHaving == false) { + if (exprPreparedValues != null && exprPreparedValues.isEmpty() == false) { + preparedValues.addAll(exprPreparedValues); // 在 AND 条件值后存放表达式内的条件值 + } + setPreparedValueList(preparedValues); + } + + return result; + } + + /**@combine:"a,b" 条件组合。虽然有了 @combine:"a | b" 这种新方式，但为了 Join 多个 On 能保证顺序正确，以及这个性能更好，还是保留这个方式 + * @param hasPrefix + * @param method + * @param where + * @param combine + * @param joinList + * @param verifyName + * @return + * @throws Exception */ - @JSONField(serialize = false) - public String getWhereString(boolean hasPrefix, RequestMethod method, Map where, Map> combine, List joinList, boolean verifyName) throws Exception { + public String getWhereString(boolean hasPrefix, RequestMethod method, Map where + , Map> combine, List> joinList, boolean verifyName) throws Exception { Set>> combineSet = combine == null ? null : combine.entrySet(); if (combineSet == null || combineSet.isEmpty()) { Log.w(TAG, "getWhereString combineSet == null || combineSet.isEmpty() >> return \"\";"); @@ -1461,18 +3691,16 @@ else if ("!".equals(ce.getKey())) { logic = Logic.TYPE_AND; } - isItemFirst = true; cs = ""; for (String key : keyList) { - c = getWhereItem(key, where.get(key), method, verifyName); + c = gainWhereItem(key, where.get(key), method, verifyName); if (StringUtil.isEmpty(c, true)) {//避免SQL条件连接错误 continue; } cs += (isItemFirst ? "" : (Logic.isAnd(logic) ? AND : OR)) + "(" + c + ")"; - isItemFirst = false; } @@ -1484,21 +3712,35 @@ else if ("!".equals(ce.getKey())) { isCombineFirst = false; } + whereString = concatJoinWhereString(whereString); + + String s = StringUtil.isEmpty(whereString, true) ? "" : (hasPrefix ? " WHERE " : "") + whereString; + + if (s.isEmpty() && RequestMethod.isQueryMethod(method) == false) { + throw new UnsupportedOperationException("写操作请求必须带条件！！！"); + } + + return s; + } + + protected String concatJoinWhereString(String whereString) throws Exception { + List> joinList = getJoinList(); if (joinList != null) { String newWs = ""; String ws = whereString; List newPvl = new ArrayList<>(); - List pvl = new ArrayList<>(preparedValueList); + List pvl = new ArrayList<>(getPreparedValueList()); - SQLConfig jc; + SQLConfig jc; + SQLConfig outerConfig; String js; - + boolean isWsEmpty = StringUtil.isEmpty(ws, true); boolean changed = false; - //各种 JOIN 没办法统一用 & | ！连接，只能按优先级，和 @combine 一样? - for (Join j : joinList) { + // 各种 JOIN 没办法统一用 & | ！连接，只能按优先级，和 @combine 一样? + for (Join j : joinList) { String jt = j.getJoinType(); switch (jt) { @@ -1506,26 +3748,48 @@ else if ("!".equals(ce.getKey())) { case "@": // APP JOIN case "<": // LEFT JOIN case ">": // RIGHT JOIN + outerConfig = j.getOuterConfig(); + if (outerConfig == null){ + break; + } + boolean isMain1 = outerConfig.isMain(); + outerConfig.setMain(false).setPrepared(isPrepared()).setPreparedValueList(new ArrayList()); + String outerWhere = outerConfig.gainWhereString(false); + + int logic1 = Logic.getType(jt); + newWs += " ( " + + gainCondition( + Logic.isNot(logic1), + ws + + ( isWsEmpty ? "" : (Logic.isAnd(logic1) ? AND : OR) ) + + " ( " + outerWhere + " ) " + ) + + " ) "; + newPvl.addAll(pvl); + newPvl.addAll(outerConfig.getPreparedValueList()); + + changed = true; break; - case "&": // INNER JOIN: A & B - case "": // FULL JOIN: A | B - case "|": // FULL JOIN: A | B + case "&": // INNER JOIN: A & B + case "": // FULL JOIN: A | B + case "|": // FULL JOIN: A | B case "!": // OUTER JOIN: ! (A | B) case "^": // SIDE JOIN: ! (A & B) case "(": // ANTI JOIN: A & ! B case ")": // FOREIGN JOIN: B & ! A + case "~": // ASOF JOIN: B ~= A jc = j.getJoinConfig(); boolean isMain = jc.isMain(); jc.setMain(false).setPrepared(isPrepared()).setPreparedValueList(new ArrayList()); - js = jc.getWhereString(false); + js = jc.gainWhereString(false); jc.setMain(isMain); boolean isOuterJoin = "!".equals(jt); boolean isSideJoin = "^".equals(jt); boolean isAntiJoin = "(".equals(jt); boolean isForeignJoin = ")".equals(jt); - boolean isWsEmpty = StringUtil.isEmpty(ws, true); + //boolean isWsEmpty = StringUtil.isEmpty(ws, true); if (isWsEmpty) { if (isOuterJoin) { // ! OUTER JOIN: ! (A | B) @@ -1551,7 +3815,7 @@ else if ("!".equals(ce.getKey())) { } else { if (isSideJoin || isForeignJoin) { - newWs += " ( " + getCondition(true, ws) + " ) "; + newWs += " ( " + gainCondition(true, ws) + " ) "; newPvl.addAll(pvl); newPvl.addAll(jc.getPreparedValueList()); @@ -1562,28 +3826,28 @@ else if ("!".equals(ce.getKey())) { continue; } - if (StringUtil.isEmpty(newWs, true) == false) { + if (StringUtil.isNotEmpty(newWs, true)) { newWs += AND; } - if (isAntiJoin) { // ( ANTI JOIN: A & ! B + if (isAntiJoin) { // ( ANTI JOIN: A & ! B newWs += " ( " + ( isWsEmpty ? "" : ws + AND ) + NOT + " ( " + js + " ) " + " ) "; } - else if (isForeignJoin) { // ) FOREIGN JOIN: B & ! A - newWs += " ( " + " ( " + js + " ) " + ( isWsEmpty ? "" : AND + NOT + ws ) + " ) "; + else if (isForeignJoin) { // ) FOREIGN JOIN: (! A) & B // preparedValueList.add 不好反过来 B & ! A + newWs += " ( " + NOT + " ( " + ws + " ) ) " + AND + " ( " + js + " ) "; } else if (isSideJoin) { // ^ SIDE JOIN: ! (A & B) //MySQL 因为 NULL 值处理问题，(A & ! B) | (B & ! A) 与 ! (A & B) 返回结果不一样，后者往往更多 - newWs += " ( " + getCondition( - true, + newWs += " ( " + gainCondition( + true, ( isWsEmpty ? "" : ws + AND ) + " ( " + js + " ) " ) + " ) "; } else { // & INNER JOIN: A & B; | FULL JOIN: A | B; OUTER JOIN: ! (A | B) - logic = Logic.getType(jt); + int logic = Logic.getType(jt); newWs += " ( " - + getCondition( - Logic.isNot(logic), + + gainCondition( + Logic.isNot(logic), ws + ( isWsEmpty ? "" : (Logic.isAnd(logic) ? AND : OR) ) + " ( " + js + " ) " @@ -1600,26 +3864,21 @@ else if (isSideJoin) { // ^ SIDE JOIN: ! (A & B) throw new UnsupportedOperationException( "join:value 中 value 里的 " + jt + "/" + j.getPath() + "错误！不支持 " + jt + " 等 [ @ APP, < LEFT, > RIGHT, * CROSS" - + ", & INNER, | FULL, ! OUTER, ^ SIDE, ( ANTI, ) FOREIGN ] 之外的 JOIN 类型 !" + + ", & INNER, | FULL, ! OUTER, ^ SIDE, ( ANTI, ) FOREIGN, ~ ASOF ] 之外的 JOIN 类型 !" ); } } if (changed) { whereString = newWs; - preparedValueList = newPvl; + setPreparedValueList(newPvl); } } - String s = StringUtil.isEmpty(whereString, true) ? "" : (hasPrefix ? " WHERE " : "") + whereString; - - if (s.isEmpty() && RequestMethod.isQueryMethod(method) == false) { - throw new UnsupportedOperationException("写操作请求必须带条件！！！"); - } - - return s; + return whereString; } + /** * @param key * @param value @@ -1628,26 +3887,26 @@ else if (isSideJoin) { // ^ SIDE JOIN: ! (A & B) * @return * @throws Exception */ - protected String getWhereItem(String key, Object value, RequestMethod method, boolean verifyName) throws Exception { + protected String gainWhereItem(String key, Object value, RequestMethod method, boolean verifyName) throws Exception { Log.d(TAG, "getWhereItem key = " + key); - //避免筛选到全部 value = key == null ? null : where.get(key); - if (key == null || value == null || key.endsWith("()") || key.startsWith("@")) { //关键字||方法, +或-直接报错 - Log.d(TAG, "getWhereItem key == null || value == null" - + " || key.startsWith(@) || key.endsWith(()) >> continue;"); + // 避免筛选到全部 value = key == null ? null : where.get(key); + if (key == null || key.endsWith("()") || key.startsWith("@")) { //关键字||方法, +或-直接报错 + Log.d(TAG, "getWhereItem key == null || key.endsWith(()) || key.startsWith(@) >> continue;"); return null; } - if (key.endsWith("@")) {//引用 + if (key.endsWith("@")) { // 引用 // key = key.substring(0, key.lastIndexOf("@")); throw new IllegalArgumentException(TAG + ".getWhereItem: 字符 " + key + " 不合法！"); } - // 原始 SQL 片段 - String rawSQL = getRawSQL(key, value); + if (value == null) { + return null; + } int keyType; if (key.endsWith("$")) { keyType = 1; - } + } else if (key.endsWith("~")) { keyType = key.charAt(key.length() - 2) == '*' ? -2 : 2; //FIXME StringIndexOutOfBoundsException } @@ -1678,94 +3937,168 @@ else if (key.endsWith("<")) { keyType = 0; } - key = getRealKey(method, key, false, true, verifyName); + String column = gainRealKey(method, key, false, true, verifyName); + + // 原始 SQL 片段 + String rawSQL = gainRawSQL(key, value); switch (keyType) { case 1: - return getSearchString(key, value, rawSQL); + return gainSearchString(key, column, value, rawSQL); case -2: case 2: - return getRegExpString(key, value, keyType < 0, rawSQL); + return gainRegExpString(key, column, value, keyType < 0, rawSQL); case 3: - return getBetweenString(key, value, rawSQL); + return gainBetweenString(key, column, value, rawSQL); case 4: - return getRangeString(key, value, rawSQL); + return gainRangeString(key, column, value, rawSQL); case 5: - return getExistsString(key, value, rawSQL); + return gainExistsString(key, column, value, rawSQL); case 6: - return getContainString(key, value, rawSQL); + return gainContainString(key, column, value, rawSQL); case 7: - return getCompareString(key, value, ">=", rawSQL); + return gainCompareString(key, column, value, ">=", rawSQL); case 8: - return getCompareString(key, value, "<=", rawSQL); + return gainCompareString(key, column, value, "<=", rawSQL); case 9: - return getCompareString(key, value, ">", rawSQL); + return gainCompareString(key, column, value, ">", rawSQL); case 10: - return getCompareString(key, value, "<", rawSQL); + return gainCompareString(key, column, value, "<", rawSQL); default: // TODO MySQL JSON类型的字段对比 key='[]' 会无结果！ key LIKE '[1, 2, 3]' //TODO MySQL , 后面有空格！ - return getEqualString(key, value, rawSQL); + return gainEqualString(key, column, value, rawSQL); } } - @JSONField(serialize = false) - public String getEqualString(String key, Object value, String rawSQL) throws Exception { - if (JSON.isBooleanOrNumberOrString(value) == false && value instanceof Subquery == false) { + public String gainEqualString(String key, String column, Object value, String rawSQL) throws Exception { + if (value != null && JSON.isBoolOrNumOrStr(value) == false && value instanceof Subquery == false) { throw new IllegalArgumentException(key + ":value 中value不合法！非PUT请求只支持 [Boolean, Number, String] 内的类型 ！"); } - boolean not = key.endsWith("!"); // & | 没有任何意义，写法多了不好控制 + boolean not = column.endsWith("!"); // & | 没有任何意义，写法多了不好控制 if (not) { - key = key.substring(0, key.length() - 1); + column = column.substring(0, column.length() - 1); } - if (StringUtil.isName(key) == false) { + + String rc = column.endsWith("[") || column.endsWith("{") ? column.substring(0, column.length() - 1) : column; + if (StringUtil.isName(rc) == false) { throw new IllegalArgumentException(key + ":value 中key不合法！不支持 ! 以外的逻辑符 ！"); } - return getKey(key) + (not ? " != " : " = ") + (value instanceof Subquery ? getSubqueryString((Subquery) value) : (rawSQL != null ? rawSQL : getValue(value))); + String logic = value == null && rawSQL == null ? (not ? SQL.IS_NOT : SQL.IS) : (not ? " != " : " = "); + return gainKey(column) + logic + (value instanceof Subquery ? gainSubqueryString((Subquery) value) + : (rawSQL != null ? rawSQL : gainValue(key, column, value))); } - @JSONField(serialize = false) - public String getCompareString(String key, Object value, String type, String rawSQL) throws Exception { - if (JSON.isBooleanOrNumberOrString(value) == false && value instanceof Subquery == false) { - throw new IllegalArgumentException(key + type + ":value 中value不合法！比较运算 [>, <, >=, <=] 只支持 [Boolean, Number, String] 内的类型 ！"); + public String gainCompareString(String key, String column, Object value, String type, String rawSQL) throws Exception { + if (value != null && JSON.isBoolOrNumOrStr(value) == false && value instanceof Subquery == false) { + throw new IllegalArgumentException(key + ":value 中 value 不合法！比较运算 [>, <, >=, <=] 只支持 [Boolean, Number, String] 内的类型 ！"); } - if (StringUtil.isName(key) == false) { - throw new IllegalArgumentException(key + type + ":value 中key不合法！比较运算 [>, <, >=, <=] 不支持 [&, !, |] 中任何逻辑运算符 ！"); + + String rc = column.endsWith("[") || column.endsWith("{") ? column.substring(0, column.length() - 1) : column; + if ( ! StringUtil.isName(rc)) { + throw new IllegalArgumentException(key + ":value 中 key 不合法！比较运算 [>, <, >=, <=] 不支持 [&, !, |] 中任何逻辑运算符 ！"); } - return getKey(key) + " " + type + " " + (value instanceof Subquery ? getSubqueryString((Subquery) value) : (rawSQL != null ? rawSQL : getValue(value))); + return gainKey(column) + " " + type + " " + (value instanceof Subquery ? gainSubqueryString((Subquery) value) + : (rawSQL != null ? rawSQL : gainValue(key, column, value))); } - public String getKey(String key) { - if (isTest()) { + public String gainKey(@NotNull String key) { + String lenFun = ""; + if (key.endsWith("[")) { + lenFun = isSQLServer() ? "datalength" : "length"; + key = key.substring(0, key.length() - 1); + } + else if (key.endsWith("{")) { + lenFun = "json_length"; + key = key.substring(0, key.length() - 1); + } + else if (isTest()) { if (key.contains("'")) { // || key.contains("#") || key.contains("--")) { throw new IllegalArgumentException("参数 " + key + " 不合法！key 中不允许有单引号 ' ！"); } - return getSQLValue(key).toString(); + return gainSQLValue(key).toString(); + } + + Map keyMap = getKeyMap(); + String expression = keyMap == null ? null : keyMap.get(key); + if (expression == null) { + expression = COLUMN_KEY_MAP == null ? null : COLUMN_KEY_MAP.get(key); + } + + String sqlKey; + if (expression == null) { + sqlKey = gainSQLKey(key); + } + else { + // (name,tag) left(date,4) 等 + List raw = getRaw(); + sqlKey = parseSQLExpression(KEY_KEY, expression, raw != null && raw.contains(KEY_KEY), false); } - return getSQLKey(key); + return lenFun.isEmpty() ? sqlKey : lenFun + "(" + sqlKey + ")"; } - public String getSQLKey(String key) { + public String gainSQLKey(String key) { String q = getQuote(); - return (isKeyPrefix() ? getAliasWithQuote() + "." : "") + q + key + q; + return (isKeyPrefix() ? q + gainSQLAlias() + q + "." : "") + q + key + q; } - /** - * 使用prepareStatement预编译，值为 ? ，后续动态set进去 - */ - private List preparedValueList = new ArrayList<>(); - private Object getValue(@NotNull Object value) { - if (isPrepared()) { + /** + * 使用prepareStatement预编译，值为 ? ，后续动态set进去 + */ + protected Object gainValue(@NotNull Object value) { + return gainValue(null, null, value); + } + + protected List preparedValueList = new ArrayList<>(); + protected Object gainValue(String key, String column, Object value) { + if (isPrepared()) { + if (value == null) { + return null; + } + + Map castMap = getCast(); + String type = key == null || castMap == null ? null : castMap.get(key); + + // if ("DATE".equalsIgnoreCase(type) && value instanceof Date == false) { + // value = value instanceof Number ? new Date(((Number) value).longValue()) : Date.valueOf((String) value); + // } + // else if ("TIME".equalsIgnoreCase(type) && value instanceof Time == false) { + // value = value instanceof Number ? new Time(((Number) value).longValue()) : Time.valueOf((String) value); + // } + // else if ("TIMESTAMP".equalsIgnoreCase(type) && value instanceof Timestamp == false) { + // value = value instanceof Number ? new Timestamp(((Number) value).longValue()) : Timestamp.valueOf((String) value); + // } + // else if ("ARRAY".equalsIgnoreCase(type) && value instanceof Array == false) { + // value = ((Collection) value).toArray(); + // } + // else if (StringUtil.isEmpty(type, true) == false) { + // preparedValueList.add(value); + // return "cast(?" + SQL.AS + type + ")"; + // } + preparedValueList.add(value); - return "?"; + return StringUtil.isEmpty(type, true) ? "?" : "cast(?" + SQL.AS + type + ")"; } - return getSQLValue(value); + + return key == null ? gainSQLValue(value) : gainSQLValue(key, column, value); + } + + public Object gainSQLValue(String key, String column, @NotNull Object value) { + Map castMap = getCast(); + String type = key == null || castMap == null ? null : castMap.get(key); + Object val = gainSQLValue(value); + return StringUtil.isEmpty(type, true) ? val : "cast(" + val + SQL.AS + type + ")"; } - public Object getSQLValue(@NotNull Object value) { - // return (value instanceof Number || value instanceof Boolean) && DATABASE_POSTGRESQL.equals(getDatabase()) ? value : "'" + value + "'"; - return (value instanceof Number || value instanceof Boolean) ? value : "'" + value + "'"; //MySQL 隐式转换用不了索引 + public Object gainSQLValue(@NotNull Object value) { + if (value == null) { + return SQL.NULL; + } + // return (value instanceof Number || value instanceof Boolean) + // && DATABASE_POSTGRESQL.equals(getDatabase()) ? value : "'" + value + "'"; + return (value instanceof Number || value instanceof Boolean) + ? value : "'" + value.toString().replaceAll("\\'", "\\\\'") + "'"; // MySQL 隐式转换用不了索引 } @Override @@ -1773,66 +4106,127 @@ public List getPreparedValueList() { return preparedValueList; } @Override - public AbstractSQLConfig setPreparedValueList(List preparedValueList) { + public AbstractSQLConfig setPreparedValueList(List preparedValueList) { this.preparedValueList = preparedValueList; return this; } //$ search <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< /**search key match value - * @param in - * @return {@link #getSearchString(String, Object[], int)} - * @throws IllegalArgumentException - */ - @JSONField(serialize = false) - public String getSearchString(String key, Object value, String rawSQL) throws IllegalArgumentException { + * @param key + * @param column + * @param value + * @param rawSQL + * @return {@link #gainSearchString(String, String, Object[], int)} + * @throws IllegalArgumentException + */ + public String gainSearchString(String key, String column, Object value, String rawSQL) throws IllegalArgumentException { if (rawSQL != null) { - throw new UnsupportedOperationException("@raw:value 中 " + key + " 不合法！@raw 不支持 key$ 这种功能符 ！只支持 key, key!, key<, key{} 等比较运算 和 @column, @having ！"); + throw new UnsupportedOperationException("@raw:value 中 " + + key + " 不合法！@raw 不支持 key$ 这种功能符 ！只支持 key, key!, key<, key{} 等比较运算 和 @column, @having ！"); } if (value == null) { return ""; } - Logic logic = new Logic(key); - key = logic.getKey(); - Log.i(TAG, "getSearchString key = " + key); + Logic logic = new Logic(column); + column = logic.getKey(); + Log.i(TAG, "getSearchString column = " + column); - JSONArray arr = newJSONArray(value); + List arr = newJSONArray(value); if (arr.isEmpty()) { return ""; } - return getSearchString(key, arr.toArray(), logic.getType()); + return gainSearchString(key, column, arr.toArray(), logic.getType()); } /**search key match values - * @param in - * @return LOGIC [ key LIKE 'values[i]' ] - * @throws IllegalArgumentException - */ - @JSONField(serialize = false) - public String getSearchString(String key, Object[] values, int type) throws IllegalArgumentException { + * @param key + * @param column + * @param values + * @param type + * @return LOGIC [ key LIKE 'values[i]' ] + * @throws IllegalArgumentException + */ + public String gainSearchString(String key, String column, Object[] values, int type) throws IllegalArgumentException { if (values == null || values.length <= 0) { return ""; } String condition = ""; for (int i = 0; i < values.length; i++) { - if (values[i] instanceof String == false) { - throw new IllegalArgumentException(key + "$:value 中value的类型只能为String或String[]！"); + Object v = values[i]; + if (v instanceof String == false) { + throw new IllegalArgumentException(key + ":value 中 value 的类型只能为 String 或 String[]！"); } - condition += (i <= 0 ? "" : (Logic.isAnd(type) ? AND : OR)) + getLikeString(key, values[i]); + if (((String) v).isEmpty()) { // 允许查空格 StringUtil.isEmpty((String) v, true) + throw new IllegalArgumentException(key + ":value 中 value 值 " + v + "是空字符串，没有意义，不允许这样传！"); + } + // if (((String) v).contains("%%")) { // 需要通过 %\%% 来模糊搜索 % + // throw new IllegalArgumentException(key + "$:value 中 value 值 " + v + " 中包含 %% ！不允许有连续的 % ！"); + // } + + condition += (i <= 0 ? "" : (Logic.isAnd(type) ? AND : OR)) + gainLikeString(key, column, (String) v); } - return getCondition(Logic.isNot(type), condition); + return gainCondition(Logic.isNot(type), condition); } /**WHERE key LIKE 'value' * @param key + * @param column * @param value * @return key LIKE 'value' */ - @JSONField(serialize = false) - public String getLikeString(String key, Object value) { - return getKey(key) + " LIKE " + getValue(value); + public String gainLikeString(@NotNull String key, @NotNull String column, String value) { + String k = key.substring(0, key.length() - 1); + char r = k.charAt(k.length() - 1); + + char l; + if (r == '%' || r == '_' || r == '?') { + k = k.substring(0, k.length() - 1); + + l = k.charAt(k.length() - 1); + if (l == '%' || l == '_' || l == '?') { + if (l == r) { + throw new IllegalArgumentException(key + ":value 中字符 " + + k + " 不合法！key$:value 中不允许 key 中有连续相同的占位符！"); + } + + k = k.substring(0, k.length() - 1); + } + else if (l > 0 && StringUtil.isName(String.valueOf(l))) { + l = r; + } + + if (l == '?') { + l = 0; + } + if (r == '?') { + r = 0; + } + } + else { + l = r = 0; + } + + if (l > 0 || r > 0) { + if (value == null) { + throw new IllegalArgumentException(key + ":value 中 value 为 null！" + + "key$:value 中 value 不能为 null，且类型必须是 String ！"); + } + + value = value.replaceAll("\\\\", "\\\\\\\\"); + value = value.replaceAll("\\%", "\\\\%"); + value = value.replaceAll("\\_", "\\\\_"); + if (l > 0) { + value = l + value; + } + if (r > 0) { + value = value + r; + } + } + + return gainKey(column) + " LIKE " + gainValue(key, column, value); } //$ search >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>> @@ -1842,40 +4236,42 @@ public String getLikeString(String key, Object value) { //~ regexp <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< /**search key match RegExp values * @param key + * @param column * @param value - * @param ignoreCase - * @return {@link #getRegExpString(String, Object[], int, boolean)} - * @throws IllegalArgumentException + * @param ignoreCase + * @return {@link #gainRegExpString(String, String, Object[], int, boolean)} + * @throws IllegalArgumentException */ - @JSONField(serialize = false) - public String getRegExpString(String key, Object value, boolean ignoreCase, String rawSQL) throws IllegalArgumentException { + public String gainRegExpString(String key, String column, Object value, boolean ignoreCase, String rawSQL) + throws IllegalArgumentException { if (rawSQL != null) { - throw new UnsupportedOperationException("@raw:value 中 " + key + " 不合法！@raw 不支持 key~ 这种功能符 ！只支持 key, key!, key<, key{} 等比较运算 和 @column, @having ！"); + throw new UnsupportedOperationException("@raw:value 中 " + key + " 不合法！@raw 不支持 key~ 这种功能符 ！" + + "只支持 key, key!, key<, key{} 等比较运算 和 @column, @having ！"); } if (value == null) { return ""; } - Logic logic = new Logic(key); - key = logic.getKey(); - Log.i(TAG, "getRegExpString key = " + key); + Logic logic = new Logic(column); + column = logic.getKey(); + Log.i(TAG, "getRegExpString column = " + column); - JSONArray arr = newJSONArray(value); + L arr = newJSONArray(value); if (arr.isEmpty()) { return ""; } - return getRegExpString(key, arr.toArray(), logic.getType(), ignoreCase); + return gainRegExpString(key, column, arr.toArray(), logic.getType(), ignoreCase); } /**search key match RegExp values * @param key * @param values - * @param type - * @param ignoreCase + * @param type + * @param ignoreCase * @return LOGIC [ key REGEXP 'values[i]' ] - * @throws IllegalArgumentException + * @throws IllegalArgumentException */ - @JSONField(serialize = false) - public String getRegExpString(String key, Object[] values, int type, boolean ignoreCase) throws IllegalArgumentException { + public String gainRegExpString(String key, String column, Object[] values, int type, boolean ignoreCase) + throws IllegalArgumentException { if (values == null || values.length <= 0) { return ""; } @@ -1883,12 +4279,13 @@ public String getRegExpString(String key, Object[] values, int type, boolean ign String condition = ""; for (int i = 0; i < values.length; i++) { if (values[i] instanceof String == false) { - throw new IllegalArgumentException(key + "$:value 中value的类型只能为String或String[]！"); + throw new IllegalArgumentException(key + ":value 中value的类型只能为String或String[]！"); } - condition += (i <= 0 ? "" : (Logic.isAnd(type) ? AND : OR)) + getRegExpString(key, (String) values[i], ignoreCase); + condition += (i <= 0 ? "" : (Logic.isAnd(type) ? AND : OR)) + + gainRegExpString(key, column, (String) values[i], ignoreCase); } - return getCondition(Logic.isNot(type), condition); + return gainCondition(Logic.isNot(type), condition); } /**WHERE key REGEXP 'value' @@ -1897,16 +4294,32 @@ public String getRegExpString(String key, Object[] values, int type, boolean ign * @param ignoreCase * @return key REGEXP 'value' */ - @JSONField(serialize = false) - public String getRegExpString(String key, String value, boolean ignoreCase) { - if (isPostgreSQL()) { - return getKey(key) + " ~" + (ignoreCase ? "* " : " ") + getValue(value); + public String gainRegExpString(String key, String column, String value, boolean ignoreCase) { + if (isPSQL()) { + return gainKey(column) + " ~" + (ignoreCase ? "* " : " ") + gainValue(key, column, value); + } + if (isOracle() || isDameng() || isKingBase() || (isMySQL() && gainDBVersionNums()[0] >= 8)) { + return "regexp_like(" + gainKey(column) + ", " + gainValue(key, column, value) + (ignoreCase ? ", 'i'" : ", 'c'") + ")"; + } + if (isPresto() || isTrino()) { + return "regexp_like(" + (ignoreCase ? "lower(" : "") + gainKey(column) + (ignoreCase ? ")" : "") + + ", " + (ignoreCase ? "lower(" : "") + gainValue(key, column, value) + (ignoreCase ? ")" : "") + ")"; + } + if (isClickHouse()) { + return "match(" + (ignoreCase ? "lower(" : "") + gainKey(column) + (ignoreCase ? ")" : "") + + ", " + (ignoreCase ? "lower(" : "") + gainValue(key, column, value) + (ignoreCase ? ")" : "") + ")"; } - if (isOracle()) { - return "regexp_like(" + getKey(key) + ", " + getValue(value) + (ignoreCase ? ", 'i'" : ", 'c'") + ")"; + if (isElasticsearch()) { + return gainKey(column) + " RLIKE " + gainValue(key, column, value); } - return getKey(key) + " REGEXP " + (ignoreCase ? "" : "BINARY ") + getValue(value); + if (isHive()) { + return (ignoreCase ? "lower(" : "") + gainKey(column) + (ignoreCase ? ")" : "") + + " REGEXP " + (ignoreCase ? "lower(" : "") + gainValue(key, column, value) + (ignoreCase ? ")" : ""); + } + return gainKey(column) + " REGEXP " + (ignoreCase ? "" : "BINARY ") + gainValue(key, column, value); } + + //~ regexp >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>> @@ -1917,33 +4330,37 @@ public String getRegExpString(String key, String value, boolean ignoreCase) { * @param key * @param value 'start,end' * @return LOGIC [ key BETWEEN 'start' AND 'end' ] - * @throws IllegalArgumentException + * @throws IllegalArgumentException */ - @JSONField(serialize = false) - public String getBetweenString(String key, Object value) throws IllegalArgumentException { + public String gainBetweenString(String key, String column, Object value, String rawSQL) throws IllegalArgumentException { + if (rawSQL != null) { + throw new UnsupportedOperationException("@raw:value 中 " + key + " 不合法！@raw 不支持 key% 这种功能符 ！" + + "只支持 key, key!, key<, key{} 等比较运算 和 @column, @having ！"); + } if (value == null) { return ""; } - Logic logic = new Logic(key); - key = logic.getKey(); - Log.i(TAG, "getBetweenString key = " + key); + Logic logic = new Logic(column); + column = logic.getKey(); + Log.i(TAG, "getBetweenString column = " + column); - JSONArray arr = newJSONArray(value); + L arr = newJSONArray(value); if (arr.isEmpty()) { return ""; } - return getBetweenString(key, arr.toArray(), logic.getType()); + return gainBetweenString(key, column, arr.toArray(), logic.getType()); } /**WHERE key BETWEEN 'start' AND 'end' * @param key - * @param value 'start,end' TODO 在 '1,2' 和 ['1,2', '3,4'] 基础上新增支持 [1, 2] 和 [[1,2], [3,4]] ？ + * @param column + * @param values ['start,end'] TODO 在 '1,2' 和 ['1,2', '3,4'] 基础上新增支持 [1, 2] 和 [[1,2], [3,4]] ？ + * @param type * @return LOGIC [ key BETWEEN 'start' AND 'end' ] - * @throws IllegalArgumentException + * @throws IllegalArgumentException */ - @JSONField(serialize = false) - public String getBetweenString(String key, Object[] values, int type) throws IllegalArgumentException { + public String gainBetweenString(String key, String column, Object[] values, int type) throws IllegalArgumentException { if (values == null || values.length <= 0) { return ""; } @@ -1952,32 +4369,36 @@ public String getBetweenString(String key, Object[] values, int type) throws Ill String[] vs; for (int i = 0; i < values.length; i++) { if (values[i] instanceof String == false) { - throw new IllegalArgumentException(key + "%:value 中 value 的类型只能为 String 或 String[] ！"); + throw new IllegalArgumentException(key + ":value 中 value 的类型只能为 String 或 String[] ！"); } vs = StringUtil.split((String) values[i]); if (vs == null || vs.length != 2) { - throw new IllegalArgumentException(key + "%:value 中 value 不合法！类型为 String 时必须包括1个逗号 , 且左右两侧都有值！类型为 String[] 里面每个元素要符合前面类型为 String 的规则 ！"); + throw new IllegalArgumentException(key + ":value 中 value 不合法！类型为 String 时必须包括1个逗号 , " + + "且左右两侧都有值！类型为 String[] 里面每个元素要符合前面类型为 String 的规则 ！"); } - condition += (i <= 0 ? "" : (Logic.isAnd(type) ? AND : OR)) + "(" + getBetweenString(key, vs[0], vs[1]) + ")"; + condition += (i <= 0 ? "" : (Logic.isAnd(type) ? AND : OR)) + + "(" + gainBetweenString(key, column, vs[0], (Object) vs[1]) + ")"; } - return getCondition(Logic.isNot(type), condition); + return gainCondition(Logic.isNot(type), condition); } /**WHERE key BETWEEN 'start' AND 'end' - * @param key - * @param value 'start,end' TODO 在 '1,2' 和 ['1,2', '3,4'] 基础上新增支持 [1, 2] 和 [[1,2], [3,4]] ？ - * @return key BETWEEN 'start' AND 'end' - * @throws IllegalArgumentException - */ - @JSONField(serialize = false) - public String getBetweenString(String key, Object start, Object end) throws IllegalArgumentException { - if (JSON.isBooleanOrNumberOrString(start) == false || JSON.isBooleanOrNumberOrString(end) == false) { - throw new IllegalArgumentException(key + "%:value 中 value 不合法！类型为 String 时必须包括1个逗号 , 且左右两侧都有值！类型为 String[] 里面每个元素要符合前面类型为 String 的规则 ！"); + * @return key + * @param column + * @param start + * @param end + * @return LOGIC [ key BETWEEN 'start' AND 'end' ] + * @throws IllegalArgumentException + */ + public String gainBetweenString(String key, String column, Object start, Object end) throws IllegalArgumentException { + if (JSON.isBoolOrNumOrStr(start) == false || JSON.isBoolOrNumOrStr(end) == false) { + throw new IllegalArgumentException(key + ":value 中 value 不合法！类型为 String 时必须包括1个逗号 , " + + "且左右两侧都有值！类型为 String[] 里面每个元素要符合前面类型为 String 的规则 ！"); } - return getKey(key) + " BETWEEN " + getValue(start) + AND + getValue(end); + return gainKey(column) + " BETWEEN " + gainValue(key, column, start) + AND + gainValue(key, column, end); } @@ -1992,23 +4413,21 @@ public String getBetweenString(String key, Object start, Object end) throws Ille * @param key * @param range "condition0,condition1..." * @return key condition0 AND key condition1 AND ... - * @throws Exception + * @throws Exception */ - @JSONField(serialize = false) - public String getRangeString(String key, Object range, String rawSQL) throws Exception { - Log.i(TAG, "getRangeString key = " + key); + public String gainRangeString(String key, String column, Object range, String rawSQL) throws Exception { + Log.i(TAG, "getRangeString column = " + column); if (range == null) {//依赖的对象都没有给出有效值，这个存在无意义。如果是客户端传的，那就能在客户端确定了。 - throw new NotExistException(TAG + "getRangeString(" + key + ", " + range - + ") range == null"); + throw new NotExistException(TAG + "getRangeString(" + column + ", " + range + ") range == null"); } - Logic logic = new Logic(key); + Logic logic = new Logic(column); String k = logic.getKey(); Log.i(TAG, "getRangeString k = " + k); if (range instanceof List) { if (rawSQL != null) { - throw new UnsupportedOperationException("@raw:value 的 value 中 " + key + "{} 不合法！" + throw new UnsupportedOperationException("@raw:value 的 value 中 " + key + " 不合法！" + "Raw SQL 不支持 key{}:[] 这种键值对！"); } @@ -2017,94 +4436,92 @@ public String getRangeString(String key, Object range, String rawSQL) throws Exc if (logic.isNot() && l.isEmpty()) { return ""; // key!{}: [] 这个条件无效，加到 SQL 语句中 key IN() 会报错，getInString 里不好处理 } - return getKey(k) + getInString(k, l.toArray(), logic.isNot()); + return gainKey(k) + gainInString(k, column, l.toArray(), logic.isNot()); } - throw new IllegalArgumentException(key + "{}\":[] 中 {} 前面的逻辑运算符错误！只能用'|','!'中的一种 ！"); + throw new IllegalArgumentException(key + ":[] 中 {} 前面的逻辑运算符错误！只能用'|','!'中的一种 ！"); } else if (range instanceof String) {//非Number类型需要客户端拼接成 < 'value0', >= 'value1'这种 String condition = ""; - String[] cs = rawSQL != null ? null : StringUtil.split((String) range, false); + String[] cs = rawSQL != null ? null : StringUtil.split((String) range, ";", false); if (rawSQL != null) { - int index = rawSQL == null ? -1 : rawSQL.indexOf("("); - condition = (index >= 0 && index < rawSQL.indexOf(")") ? "" : getKey(k) + " ") + rawSQL; + int index = rawSQL.indexOf("("); + condition = (index >= 0 && index < rawSQL.lastIndexOf(")") ? "" : gainKey(k) + " ") + rawSQL; } - // 还是只支持整段为 Raw SQL 比较好 - // boolean appendRaw = false; - // if ("".equals(rawSQL)) { - // condition = rawSQL; - // cs = null; - // } - // else { - // if (rawSQL != null) { //先找出所有 rawSQL 的位置，然后去掉，再最后按原位置来拼接 - // String[] rs = StringUtil.split((String) range, rawSQL, false); - // - // if (rs != null && rs.length > 0) { - // String cond = ""; - // for (int i = 0; i < rs.length; i++) { - // cond += rs[i]; - // } - // range = cond; - // appendRaw = true; - // } - // } - // - // cs = StringUtil.split((String) range, false); - // } - if (cs != null) { - String c; - int index; + List raw = getRaw(); + boolean containRaw = raw == null ? false : raw.contains(key); + String lk = logic.isAnd() ? AND : OR; + for (int i = 0; i < cs.length; i++) {//对函数条件length(key)<=5这种不再在开头加key - c = cs[i]; + String expr = cs[i]; - if ("=null".equals(c)) { - c = SQL.isNull(); + if (expr.length() > 100) { + throw new UnsupportedOperationException(key + ":value 的 value 中字符串 " + expr + " 不合法！" + + "不允许传超过 100 个字符的函数或表达式！请用 @raw 简化传参！"); } - else if ("!=null".equals(c)) { - c = SQL.isNull(false); + + int index = expr == null ? -1 : expr.indexOf("("); + if (index >= 0) { + expr = parseSQLExpression(key, expr, containRaw, false + , key + ":\"!=null;+3*2<=10;function0(arg0,arg1,...)>1;function1(...)%5<=3...\""); } - else if (isPrepared() && (c.contains("--") || PATTERN_RANGE.matcher(c).matches() == false)) { - throw new UnsupportedOperationException(key + "{}:value 的 value 中 " + c + " 不合法！" - + "预编译模式下 key{}:\"condition\" 中 condition 必须 为 =null 或 !=null 或 符合正则表达式 " + PATTERN_RANGE + " ！不允许连续减号 -- ！不允许空格！"); + else { + String fk = gainKey(k) + " "; + String[] ccs = StringUtil.split(expr, false); + expr = ""; + + for (int j = 0; j < ccs.length; j++) { + String c = ccs[j]; + if ("=null".equals(c)) { + c = SQL.isNull(); + } + else if ("!=null".equals(c)) { + c = SQL.isNull(false); + } + else if (isPrepared() && (c.contains("--") || PATTERN_RANGE.matcher(c).matches() == false)) { + throw new UnsupportedOperationException(key + ":value 的 value 中 " + c + " 不合法！" + + "预编译模式下 key{}:\"condition\" 中 condition 必须 为 =null 或 !=null " + + "或 符合正则表达式 " + PATTERN_RANGE + " ！不允许连续减号 -- ！不允许空格！"); + } + + expr += (j <= 0 ? "" : lk) + fk + c; + } } - index = c == null ? -1 : c.indexOf("("); - condition += ((i <= 0 ? "" : (logic.isAnd() ? AND : OR)) //连接方式 - + (index >= 0 && index < c.indexOf(")") ? "" : getKey(k) + " ") //函数和非函数条件 - + c); // 还是只支持整段为 Raw SQL 比较好 (appendRaw && index > 0 ? rawSQL : "") + c); //单个条件，如果有 Raw SQL 则按原来位置拼接 + condition += ((i <= 0 ? "" : lk) + expr); } } + if (condition.isEmpty()) { return ""; } - return getCondition(logic.isNot(), condition); + return gainCondition(logic.isNot(), condition); } - else if (range instanceof Subquery) { //如果在 Parser 解析成 SQL 字符串再引用，没法保证安全性，毕竟可以再通过远程函数等方式来拼接再替代，最后引用的字符串就能注入 - return getKey(k) + (logic.isNot() ? NOT : "") + " IN " + getSubqueryString((Subquery) range); + else if (range instanceof Subquery) { + // 如果在 Parser 解析成 SQL 字符串再引用，没法保证安全性，毕竟可以再通过远程函数等方式来拼接再替代，最后引用的字符串就能注入 + return gainKey(k) + (logic.isNot() ? NOT : "") + " IN " + gainSubqueryString((Subquery) range); } - throw new IllegalArgumentException(key + "{}:range 类型为" + range.getClass().getSimpleName() + throw new IllegalArgumentException(key + ":range 类型为" + range.getClass().getSimpleName() + "！range 只能是 用','分隔条件的字符串 或者 可取选项JSONArray！"); } /**WHERE key IN ('key0', 'key1', ... ) * @param in * @return IN ('key0', 'key1', ... ) - * @throws NotExistException + * @throws NotExistException */ - @JSONField(serialize = false) - public String getInString(String key, Object[] in, boolean not) throws NotExistException { + public String gainInString(String key, String column, Object[] in, boolean not) throws NotExistException { String condition = ""; if (in != null) {//返回 "" 会导致 id:[] 空值时效果和没有筛选id一样！ for (int i = 0; i < in.length; i++) { - condition += ((i > 0 ? "," : "") + getValue(in[i])); + condition += ((i > 0 ? "," : "") + gainValue(key, column, in[i])); } } if (condition.isEmpty()) {//条件如果存在必须执行，不能忽略。条件为空会导致出错，又很难保证条件不为空(@:条件)，所以还是这样好 - throw new NotExistException(TAG + ".getInString(" + key + ", [], " + not - + ") >> condition.isEmpty() >> IN()"); + throw new NotExistException(TAG + ".getInString(" + key + "," + column + ", [], " + not + ") >> condition.isEmpty() >> IN()"); } return (not ? NOT : "") + " IN (" + condition + ")"; } @@ -2113,30 +4530,31 @@ public String getInString(String key, Object[] in, boolean not) throws NotExistE //}{ exists <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< /**WHERE EXISTS subquery - * 如果合并到 getRangeString，一方面支持不了 [1,2,2] 和 ">1" (转成 EXISTS(SELECT IN ) 需要static newSQLConfig，但它不能传入子类实例，除非不是 static)，另一方面多了子查询临时表性能会比 IN 差 + * 如果合并到 getRangeString，一方面支持不了 [1,2,2] 和 ">1" (转成 EXISTS(SELECT IN ) 需要 + * static newSQLConfig，但它不能传入子类实例，除非不是 static)，另一方面多了子查询临时表性能会比 IN 差 * @param key * @param value * @return EXISTS ALL(SELECT ...) * @throws NotExistException */ - @JSONField(serialize = false) - public String getExistsString(String key, Object value, String rawSQL) throws Exception { + public String gainExistsString(String key, String column, Object value, String rawSQL) throws Exception { if (rawSQL != null) { - throw new UnsupportedOperationException("@raw:value 中 " + key + " 不合法！@raw 不支持 key}{ 这种功能符 ！只支持 key, key!, key<, key{} 等比较运算 和 @column, @having ！"); + throw new UnsupportedOperationException("@raw:value 中 " + key + " 不合法！" + + "@raw 不支持 key}{ 这种功能符 ！只支持 key, key!, key<, key{} 等比较运算 和 @column, @having ！"); } if (value == null) { return ""; } if (value instanceof Subquery == false) { - throw new IllegalArgumentException(key + "}{:subquery 类型为" + value.getClass().getSimpleName() + throw new IllegalArgumentException(key + ":subquery 类型为" + value.getClass().getSimpleName() + "！subquery 只能是 子查询JSONObejct！"); } - Logic logic = new Logic(key); - key = logic.getKey(); - Log.i(TAG, "getExistsString key = " + key); + Logic logic = new Logic(column); + column = logic.getKey(); + Log.i(TAG, "getExistsString column = " + column); - return (logic.isNot() ? NOT : "") + " EXISTS " + getSubqueryString((Subquery) value); + return (logic.isNot() ? NOT : "") + " EXISTS " + gainSubqueryString((Subquery) value); } //}{ exists >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>> @@ -2144,62 +4562,96 @@ public String getExistsString(String key, Object value, String rawSQL) throws Ex /**WHERE key contains value * @param key * @param value - * @return {@link #getContainString(String, Object[], int)} + * @return {@link #gainContainString(String, String, Object[], int)} * @throws NotExistException */ - @JSONField(serialize = false) - public String getContainString(String key, Object value, String rawSQL) throws IllegalArgumentException { - if (value == null) { - return ""; + public String gainContainString(String key, String column, Object value, String rawSQL) throws IllegalArgumentException { + if (rawSQL != null) { + throw new UnsupportedOperationException("@raw:value 中 " + key + " 不合法！@raw 不支持 key<> 这种功能符 ！" + + "只支持 key, key!, key<, key{} 等比较运算 和 @column, @having ！"); } - Logic logic = new Logic(key); - key = logic.getKey(); - Log.i(TAG, "getContainString key = " + key); + Logic logic = new Logic(column); + column = logic.getKey(); + Log.i(TAG, "getContainString column = " + column); - return getContainString(key, newJSONArray(value).toArray(), logic.getType()); + return gainContainString(key, column, newJSONArray(value).toArray(), logic.getType()); } - /**WHERE key contains childs + /**WHERE key contains childs TODO 支持 key<>: { "path":"$[0].name", "value": 82001 } + * 或者 key<$[0].name>:82001 或者 key$[0].name<>:82001 ？ 还是前者好，key 一旦复杂了， + * 包含 , ; : / [] 等就容易和 @combine 其它功能等冲突 * @param key * @param childs null ? "" : (empty ? no child : contains childs) * @param type |, &, ! * @return LOGIC [ ( key LIKE '[" + childs[i] + "]' OR key LIKE '[" + childs[i] + ", %' * OR key LIKE '%, " + childs[i] + ", %' OR key LIKE '%, " + childs[i] + "]' ) ] - * @throws IllegalArgumentException + * @throws IllegalArgumentException */ - @JSONField(serialize = false) - public String getContainString(String key, Object[] childs, int type) throws IllegalArgumentException { + public String gainContainString(String key, String column, Object[] childs, int type) throws IllegalArgumentException { boolean not = Logic.isNot(type); String condition = ""; if (childs != null) { for (int i = 0; i < childs.length; i++) { - if (childs[i] != null) { - if (childs[i] instanceof JSON) { - throw new IllegalArgumentException(key + "<>:value 中value类型不能为JSON！"); + Object c = childs[i]; + if (c instanceof Collection) { + throw new IllegalArgumentException(key + ":value 中 value 类型不能为 [JSONList, Collection] 中的任何一个 ！"); + } + + Object path = ""; + if (c instanceof Map) { + path = ((Map) c).get("path"); + if (path != null && path instanceof String == false) { + throw new IllegalArgumentException(key + ":{ path:path, value:value } 中 path 类型错误，" + + "只能是 $, $.key1, $[0].key2 等符合 SQL 中 JSON 路径的 String ！"); } - condition += (i <= 0 ? "" : (Logic.isAnd(type) ? AND : OR)); - if (isPostgreSQL()) { - condition += (getKey(key) + " @> " + getValue(newJSONArray(childs[i]))); //operator does not exist: jsonb @> character varying "[" + childs[i] + "]"); + c = ((Map) c).get("value"); + if (c instanceof Collection || c instanceof Map) { + throw new IllegalArgumentException(key + ":{ path:path, value:value } 中 value 类型" + + "不能为 [JSONMap, JSONList, Collection, Map] 中的任何一个 ！"); } - else if (isOracle()) { - condition += ("json_textcontains(" + getKey(key) + ", '$', " + getValue(childs[i].toString()) + ")"); + } + + condition += (i <= 0 ? "" : (Logic.isAnd(type) ? AND : OR)); + if (isPSQL()) { + condition += (gainKey(column) + " @> " + gainValue(key, column, newJSONArray(c))); + // operator does not exist: jsonb @> character varying "[" + c + "]"); + } + else if (isOracle() || isDameng() || isKingBase()) { + condition += ("json_textcontains(" + gainKey(column) + ", " + (StringUtil.isEmpty(path, true) + ? "'$'" : gainValue(key, column, path)) + ", " + gainValue(key, column, c == null ? null : c.toString()) + ")"); + } + else if (isPresto() || isTrino()) { + condition += ("json_array_contains(cast(" + gainKey(column) + " AS VARCHAR), " + + gainValue(key, column, c) + (StringUtil.isEmpty(path, true) + ? "" : ", " + gainValue(key, column, path)) + ")"); + } + else { + String v = c == null ? "null" : (c instanceof Boolean || c instanceof Number ? c.toString() : "\"" + c + "\""); + if (isClickHouse()) { + condition += (condition + "has(JSONExtractArrayRaw(assumeNotNull(" + gainKey(column) + "))" + + ", " + gainValue(key, column, v) + (StringUtil.isEmpty(path, true) + ? "" : ", " + gainValue(key, column, path)) + ")"); } else { - condition += ("json_contains(" + getKey(key) + ", " + getValue(childs[i].toString()) + ")"); + condition += ("json_contains(" + gainKey(column) + ", " + gainValue(key, column, v) + + (StringUtil.isEmpty(path, true) ? "" : ", " + gainValue(key, column, path)) + ")"); } } } + if (condition.isEmpty()) { - condition = (getKey(key) + SQL.isNull(true) + OR + getLikeString(key, "[]")); // key = '[]' 无结果！ - } else { - condition = (getKey(key) + SQL.isNull(false) + AND + "(" + condition + ")"); + condition = gainKey(column) + SQL.isNull(true) + OR + gainLikeString(key, column, "[]"); // key = '[]' 无结果！ + } + else { + condition = gainKey(column) + SQL.isNull(false) + AND + "(" + condition + ")"; } } + if (condition.isEmpty()) { return ""; } - return getCondition(not, condition); + return gainCondition(not, condition); } //<> contain >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>> @@ -2207,15 +4659,115 @@ else if (isOracle()) { //key@:{} Subquery <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< + public List getWithAsExprSQLList() { + return withAsExprSQLList; + } + private void clearWithAsExprListIfNeed() { + // mysql8版本以上,子查询支持with as表达式 + if(this.isMySQL() && this.gainDBVersionNums()[0] >= 8) { + this.withAsExprSQLList = new ArrayList<>(); + } + } + + @Override + public List getWithAsExprPreparedValueList() { + return this.withAsExprPreparedValueList; + } + @Override - public String getSubqueryString(Subquery subquery) throws Exception { - String range = subquery.getRange(); - SQLConfig cfg = subquery.getConfig(); + public AbstractSQLConfig setWithAsExprPreparedValueList(List list) { + this.withAsExprPreparedValueList = list; + return this; + } + + /** + * 只要 method != RequestMethod.POST 就都支持 with-as表达式 + * @param cfg + * @param subquery + * @return + * @throws Exception + */ + private String withAsExprSubqueryString(SQLConfig cfg, Subquery subquery) throws Exception { + boolean isWithAsEnable = isWithAsEnable(); + List list = isWithAsEnable ? getWithAsExprSQLList() : null; + if (cfg.getMethod() != RequestMethod.POST && list == null) { + clearWithAsExprListIfNeed(); + } + + String quote = getQuote(); + String as = gainAs(); + + String withAsExpreSql; + if (list != null) { + String withQuoteName = quote + subquery.gainKey() + quote; + list.add(" " + withQuoteName + as + "(" + cfg.gainSQL(isPrepared()) + ") "); + withAsExpreSql = " SELECT * FROM " + withQuoteName; + + // 预编译参数 FIXME 这里重复添加了，导致子查询都报错参数超过 ? 数量 Parameter index out of range (5 > number of parameters, which is 4) + List subPvl = cfg.getPreparedValueList(); + if (subPvl != null && subPvl.isEmpty() == false) { + List valueList = getWithAsExprPreparedValueList(); + if (valueList == null) { + valueList = new ArrayList<>(); + } + valueList.addAll(subPvl); + setWithAsExprPreparedValueList(valueList); + + cfg.setPreparedValueList(new ArrayList<>()); + } + } else { + withAsExpreSql = cfg.gainSQL(isPrepared()); + // mysql 才存在这个问题, 主表和子表是一张表 + if (isWithAsEnable && isMySQL() && StringUtil.equals(getTable(), subquery.gainFrom())) { + withAsExpreSql = " SELECT * FROM (" + withAsExpreSql + ")" + as + quote + subquery.gainKey() + quote; + } + } + return withAsExpreSql; + } + + @Override + public String gainSubqueryString(Subquery subquery) throws Exception { + if (subquery == null) { + return ""; + } + + String range = subquery.gainRange(); + SQLConfig cfg = subquery.gainConfig(); + + // 子查询 = 主语句 datasource + if (StringUtil.equals(this.getTable(), subquery.gainFrom()) == false && cfg.hasJoin() == false) { + cfg.setDatasource(this.getDatasource()); + } cfg.setPreparedValueList(new ArrayList<>()); - String sql = (range == null || range.isEmpty() ? "" : range) + "(" + cfg.getSQL(isPrepared()) + ") "; + String withAsExprSql = withAsExprSubqueryString(cfg, subquery); + String sql = (range == null || range.isEmpty() ? "" : range) + "(" + withAsExprSql + ") "; + + //// SELECT .. FROM(SELECT ..) .. WHERE .. 格式需要把子查询中的预编译值提前 + //// 如果外查询 SELECT concat(`name`,?) 这种 SELECT 里也有预编译值，那就不能这样简单反向 + //List subPvl = cfg.getPreparedValueList(); + //if (subPvl != null && subPvl.isEmpty() == false) { + // List pvl = getPreparedValueList(); + // + // if (pvl != null && pvl.isEmpty() == false) { + // subPvl.addAll(pvl); + // } + // setPreparedValueList(subPvl); + //} + + List subPvl = cfg.getPreparedValueList(); + if (subPvl != null && subPvl.isEmpty() == false) { + List pvl = getPreparedValueList(); + + if (pvl == null || pvl.isEmpty()) { + pvl = subPvl; + } + else { + pvl.addAll(subPvl); + } - preparedValueList.addAll(cfg.getPreparedValueList()); + setPreparedValueList(pvl); + } return sql; } @@ -2229,18 +4781,28 @@ public String getSubqueryString(Subquery subquery) throws Exception { * @param condition * @return */ - private static String getCondition(boolean not, String condition) { - return not ? NOT + "(" + condition + ")" : condition; + public static String gainCondition(boolean not, String condition) { + return gainCondition(not, condition, false); + } + /**拼接条件 + * @param not + * @param condition + * @param addOuterBracket + * @return + */ + public static String gainCondition(boolean not, String condition, boolean addOuterBracket) { + String s = not ? NOT + "(" + condition + ")" : condition; + return addOuterBracket ? "( " + s + " )" : s; } /**转为JSONArray - * @param tv + * @param obj * @return */ @NotNull - public static JSONArray newJSONArray(Object obj) { - JSONArray array = new JSONArray(); + public static > L newJSONArray(Object obj) { + L array = JSON.createJSONArray(); if (obj != null) { if (obj instanceof Collection) { array.addAll((Collection) obj); @@ -2257,20 +4819,20 @@ public static JSONArray newJSONArray(Object obj) { //SET <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< /**获取SET * @return - * @throws Exception + * @throws Exception */ - @JSONField(serialize = false) - public String getSetString() throws Exception { - return getSetString(getMethod(), getContent(), ! isTest()); + public String gainSetString() throws Exception { + return gainSetString(getMethod(), getContent(), ! isTest()); } + //CS304 Issue link: https://github.com/Tencent/APIJSON/issues/48 /**获取SET - * @param method - * @param content + * @param method -the method used + * @param content -the content map * @return - * @throws Exception + * @throws Exception + *

use entrySet+getValue() to replace keySet+get() to enhance efficiency

*/ - @JSONField(serialize = false) - public String getSetString(RequestMethod method, Map content, boolean verifyName) throws Exception { + public String gainSetString(RequestMethod method, Map content, boolean verifyName) throws Exception { Set set = content == null ? null : content.keySet(); String setString = ""; @@ -2280,7 +4842,8 @@ public String getSetString(RequestMethod method, Map content, bo Object value; String idKey = getIdKey(); - for (String key : set) { + for (Entry entry : content.entrySet()) { + String key = entry.getKey(); //避免筛选到全部 value = key == null ? null : content.get(key); if (key == null || idKey.equals(key)) { continue; @@ -2293,11 +4856,13 @@ public String getSetString(RequestMethod method, Map content, bo } else { keyType = 0; //注意重置类型，不然不该加减的字段会跟着加减 } - value = content.get(key); - key = getRealKey(method, key, false, true, verifyName); + value = entry.getValue(); + String column = gainRealKey(method, key, false, true, verifyName); - setString += (isFirst ? "" : ", ") + (getKey(key) + " = " + (keyType == 1 ? getAddString(key, value) : (keyType == 2 - ? getRemoveString(key, value) : getValue(value)) ) ); + setString += (isFirst ? "" : ", ") + (gainKey(column) + " = " + + (keyType == 1 ? gainAddString(key, column, value) : (keyType == 2 + ? gainRemoveString(key, column, value) : gainValue(key, column, value)) ) + ); isFirst = false; } @@ -2306,7 +4871,7 @@ public String getSetString(RequestMethod method, Map content, bo if (setString.isEmpty()) { throw new IllegalArgumentException("PUT 请求必须在Table内设置要修改的 key:value ！"); } - return " SET " + setString; + return (isClickHouse() ? " " : " SET ") + setString; } /**SET key = concat(key, 'value') @@ -2315,15 +4880,14 @@ public String getSetString(RequestMethod method, Map content, bo * @return concat(key, 'value') * @throws IllegalArgumentException */ - @JSONField(serialize = false) - public String getAddString(String key, Object value) throws IllegalArgumentException { + public String gainAddString(String key, String column, Object value) throws IllegalArgumentException { if (value instanceof Number) { - return getKey(key) + " + " + value; + return gainKey(column) + " + " + value; } if (value instanceof String) { - return SQL.concat(getKey(key), (String) getValue(value)); + return SQL.concat(gainKey(column), (String) gainValue(key, column, value)); } - throw new IllegalArgumentException(key + "+ 对应的值 " + value + " 不是Number,String,Array中的任何一种！"); + throw new IllegalArgumentException(key + ":value 中 value 类型错误，必须是 Number,String,Array 中的任何一种！"); } /**SET key = replace(key, 'value', '') * @param key @@ -2331,100 +4895,220 @@ public String getAddString(String key, Object value) throws IllegalArgumentExcep * @return REPLACE (key, 'value', '') * @throws IllegalArgumentException */ - @JSONField(serialize = false) - public String getRemoveString(String key, Object value) throws IllegalArgumentException { + public String gainRemoveString(String key, String column, Object value) throws IllegalArgumentException { if (value instanceof Number) { - return getKey(key) + " - " + value; + return gainKey(column) + " - " + value; } if (value instanceof String) { - return SQL.replace(getKey(key), (String) getValue(value), "''");// " replace(" + key + ", '" + value + "', '') "; + return SQL.replace(gainKey(column), (String) gainValue(key, column, value), "''"); + // " replace(" + column + ", '" + value + "', '') "; } - throw new IllegalArgumentException(key + "- 对应的值 " + value + " 不是Number,String,Array中的任何一种！"); + throw new IllegalArgumentException(key + ":value 中 value 类型错误，必须是 Number,String,Array 中的任何一种！"); } //SET >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>> + @Override + public boolean isFakeDelete() { + return false; + } + + @Override + public Map onFakeDelete(Map map) { + return map; + } /** * @return - * @throws Exception + * @throws Exception */ - @JSONField(serialize = false) @Override - public String getSQL(boolean prepared) throws Exception { - return getSQL(this.setPrepared(prepared)); + public String gainSQL(boolean prepared) throws Exception { + boolean isPrepared = isPrepared(); + if (isPrepared == prepared) { + return gainSQL(this); + } + + String sql = gainSQL(this.setPrepared(prepared)); + setPrepared(isPrepared); + return sql; } /** * @param config * @return - * @throws Exception + * @throws Exception */ - public static String getSQL(AbstractSQLConfig config) throws Exception { + public static , L extends List> String gainSQL(AbstractSQLConfig config) throws Exception { if (config == null) { Log.i(TAG, "getSQL config == null >> return null;"); return null; } - //TODO procedure 改为 List procedureList; behind : true; function: callFunction(); String key; ... + // TODO procedure 改为 List procedureList; behind : true; function: callFunction(); String key; ... // for (...) { Call procedure1();\n SQL \n; Call procedure2(); ... } - // 貌似不需要，因为 ObjecParser 里就已经处理的顺序等，只是这里要解决下 Schema 问题。 + // 貌似不需要，因为 ObjectParser 里就已经处理的顺序等，只是这里要解决下 Schema 问题。 + + String procedure = config.getProcedure(); + if (StringUtil.isNotEmpty(procedure, true)) { + int ind = procedure.indexOf("."); + boolean hasPrefix = ind >= 0 && ind < procedure.indexOf("("); + String sch = hasPrefix ? AbstractFunctionParser.extractSchema( + procedure.substring(0, ind), config.getTable() + ) : config.gainSQLSchema(); - String sch = config.getSQLSchema(); - if (StringUtil.isNotEmpty(config.getProcedure(), true)) { String q = config.getQuote(); - return "CALL " + q + sch + q + "."+ config.getProcedure(); + return "CALL " + q + sch + q + "." + (hasPrefix ? procedure.substring(ind + 1) : procedure); } - String tablePath = config.getTablePath(); - if (StringUtil.isNotEmpty(tablePath, true) == false) { - Log.i(TAG, "getSQL StringUtil.isNotEmpty(tablePath, true) == false >> return null;"); + String tablePath = config.gainTablePath(); + if (StringUtil.isEmpty(tablePath, true)) { + Log.i(TAG, "getSQL StringUtil.isEmpty(tablePath, true) >> return null;"); return null; } - switch (config.getMethod()) { - case POST: - return "INSERT INTO " + tablePath + config.getColumnString() + " VALUES" + config.getValuesString(); - case PUT: - return "UPDATE " + tablePath + config.getSetString() + config.getWhereString(true); - case DELETE: - return "DELETE FROM " + tablePath + config.getWhereString(true); - default: - String explain = (config.isExplain() ? (config.isSQLServer() || config.isOracle() ? "SET STATISTICS PROFILE ON " : "EXPLAIN ") : ""); - if (config.isTest() && RequestMethod.isGetMethod(config.getMethod(), true)) { - String q = config.getQuote(); // 生成 SELECT ( (24 >=0 AND 24 <3) ) AS `code` LIMIT 1 OFFSET 0 - return explain + "SELECT " + config.getWhereString(false) + " AS " + q + JSONResponse.KEY_CODE + q + config.getLimitString(); + // 解决重复添加导致报错：Parameter index out of range (6 > number of parameters, which is 5) + config.setPreparedValueList(new ArrayList<>()); + RequestMethod method = config.getMethod(); + if (method == null) { + method = GET; + } + + String cSql = null; + switch (method) { + case POST: + return "INSERT INTO " + tablePath + config.gainColumnString() + " VALUES" + config.getValuesString(); + case PUT: + if(config.isClickHouse()){ + return "ALTER TABLE " + tablePath + " UPDATE" + config.gainSetString() + config.gainWhereString(true); + } + cSql = "UPDATE " + tablePath + config.gainSetString() + config.gainWhereString(true) + + (config.isMySQL() ? config.gainLimitString() : ""); + cSql = buildWithAsExprSql(config, cSql); + return cSql; + case DELETE: + if(config.isClickHouse()){ + return "ALTER TABLE " + tablePath + " DELETE" + config.gainWhereString(true); + } + cSql = "DELETE FROM " + tablePath + config.gainWhereString(true) + + (config.isMySQL() ? config.gainLimitString() : ""); // PostgreSQL 不允许 LIMIT + cSql = buildWithAsExprSql(config, cSql); + return cSql; + default: + String explain = config.isExplain() ? (config.isSQLServer() ? "SET STATISTICS PROFILE ON " + : (config.isOracle() || config.isDameng() || config.isKingBase() ? "EXPLAIN PLAN FOR " : "EXPLAIN ")) : ""; + if (config.isTest() && RequestMethod.isGetMethod(config.getMethod(), true)) { // FIXME 为啥是 code 而不是 count ？ + String q = config.getQuote(); // 生成 SELECT ( (24 >=0 AND 24 <3) ) AS `code` LIMIT 1 OFFSET 0 + return explain + "SELECT " + config.gainWhereString(false) + + config.gainAs() + q + JSONResponse.KEY_COUNT + q + config.gainLimitString(); + } + + config.setPreparedValueList(new ArrayList()); + String column = config.gainColumnString(); + if (config.isOracle() || config.isDameng() || config.isKingBase()) { + //When config's database is oracle,Using subquery since Oracle12 below does not support OFFSET FETCH paging syntax. + //针对oracle分组后条数的统计 + if (StringUtil.isNotEmpty(config.getGroup(),true) && RequestMethod.isHeadMethod(config.getMethod(), true)){ + return explain + "SELECT count(*) FROM (SELECT " + (config.getCache() == JSONMap.CACHE_RAM + ? "SQL_NO_CACHE " : "") + column + " FROM " + gainConditionString(tablePath, config) + ") " + config.gainLimitString(); + } + + String sql = "SELECT " + (config.getCache() == JSONMap.CACHE_RAM + ? "SQL_NO_CACHE " : "") + column + " FROM " + gainConditionString(tablePath, config); + return explain + config.gainOraclePageSQL(sql); + } + + cSql = "SELECT " + (config.getCache() == JSONMap.CACHE_RAM ? "SQL_NO_CACHE " : "") + + column + " FROM " + gainConditionString(tablePath, config) + config.gainLimitString(); + cSql = buildWithAsExprSql(config, cSql); + if(config.isElasticsearch()) { // elasticSearch 不支持 explain + return cSql; + } + return explain + cSql; + } + } + + private static , L extends List> String buildWithAsExprSql(@NotNull AbstractSQLConfig config, String cSql) throws Exception { + if (config.isWithAsEnable() == false) { + return cSql; + } + + List list = config.getWithAsExprSQLList(); + int size = list == null ? 0 : list.size(); + if (size > 0) { + String withAsExpreSql = "WITH "; + for (int i = 0; i < size; i++) { + withAsExpreSql += (i <= 0 ? "" : ",") + list.get(i) + "\n"; } + cSql = withAsExpreSql + cSql; + config.clearWithAsExprListIfNeed(); + } + return cSql; + } - config.setPreparedValueList(new ArrayList()); - String column = config.getColumnString(); - return explain + "SELECT " + (config.getCache() == JSONRequest.CACHE_RAM ? "SQL_NO_CACHE " : "") + column + " FROM " + getConditionString(column, tablePath, config); + @Override + public boolean isWithAsEnable() { + return ENABLE_WITH_AS && (isMySQL() == false || gainDBVersionNums()[0] >= 8); + } + + /**Oracle的分页获取 + * @param sql + * @return + */ + protected String gainOraclePageSQL(String sql) { + int count = getCount(); + if (count <= 0 || RequestMethod.isHeadMethod(getMethod(), true)) { // TODO HEAD 真的不需要 LIMIT ？ + return sql; } + int offset = getOffset(getPage(), count); + String quote = getQuote(); + String alias = quote + gainSQLAlias() + quote; + return "SELECT * FROM (SELECT " + alias + ".*, ROWNUM "+ quote + "RN" + quote +" FROM (" + sql + ") " + alias + + " WHERE ROWNUM <= " + (offset + count) + ") WHERE "+ quote + "RN" + quote +" > " + offset; } /**获取条件SQL字符串 - * @param page - * @param column * @param table - * @param where + * @param config * @return - * @throws Exception + * @throws Exception */ - private static String getConditionString(String column, String table, AbstractSQLConfig config) throws Exception { - String where = config.getWhereString(true); - - Subquery from = config.getFrom(); + private static , L extends List> String gainConditionString( + String table, AbstractSQLConfig config) throws Exception { + Subquery from = config.getFrom(); if (from != null) { - table = config.getSubqueryString(from) + " AS " + config.getAliasWithQuote() + " "; + table = config.gainSubqueryString(from) + config.gainAs() + config.gainSQLAliasWithQuote() + " "; + } + + String join = config.gainJoinString(); + + String where = config.gainWhereString(true); + + //根据方法不同，聚合语句不同。GROUP BY 和 HAVING 可以加在 HEAD 上, HAVING 可以加在 PUT, DELETE 上，GET 全加，POST 全都不加 + String aggregation; + if (RequestMethod.isGetMethod(config.getMethod(), true)) { + aggregation = config.gainGroupString(true) + config.gainHavingString(true) + + config.gainSampleString(true) + config.gainLatestString(true) + + config.gainPartitionString(true) + config.gainFillString(true) + + config.gainOrderString(true); + } + else if (RequestMethod.isHeadMethod(config.getMethod(), true)) { + // TODO 加参数 isPagenation 判断是 GET 内分页 query:2 查总数，不用加这些条件 + aggregation = config.gainGroupString(true) + config.gainHavingString(true) + + config.gainSampleString(true) + config.gainLatestString(true) + + config.gainPartitionString(true) + config.gainFillString(true); + } + else if (config.getMethod() == PUT || config.getMethod() == DELETE) { + aggregation = config.gainHavingString(true) ; + } + else { + aggregation = ""; } - String condition = table + config.getJoinString() + where + ( - RequestMethod.isGetMethod(config.getMethod(), true) == false ? - "" : config.getGroupString(true) + config.getHavingString(true) + config.getOrderString(true) - ) - ; //+ config.getLimitString(); + String condition = table + join + where + aggregation; + ; //+ config.getLimitString(); //no need to optimize // if (config.getPage() <= 0 || ID.equals(column.trim())) { - return condition + config.getLimitString(); + return condition; // config.isOracle() ? condition : condition + config.getLimitString(); // } // // @@ -2464,26 +5148,24 @@ public boolean isKeyPrefix() { return keyPrefix; } @Override - public AbstractSQLConfig setKeyPrefix(boolean keyPrefix) { + public AbstractSQLConfig setKeyPrefix(boolean keyPrefix) { this.keyPrefix = keyPrefix; return this; } - - public String getJoinString() throws Exception { + public String gainJoinString() throws Exception { String joinOns = ""; if (joinList != null) { String quote = getQuote(); - List pvl = new ArrayList<>(); - boolean changed = false; + List pvl = getPreparedValueList(); // new ArrayList<>(); + //boolean changed = false; - String sql = null; - SQLConfig jc; - String jt; - String tn; + // 主表不用别名 String ta; for (Join j : joinList) { + onGainJoinString(j); + if (j.isAppJoin()) { // APP JOIN，只是作为一个标记，执行完主表的查询后自动执行副表的查询 User.id IN($commentIdList) continue; } @@ -2491,11 +5173,12 @@ public String getJoinString() throws Exception { //LEFT JOIN sys.apijson_user AS User ON User.id = Moment.userId， 都是用 = ，通过relateType处理缓存 // <"INNER JOIN User ON User.id = Moment.userId", UserConfig> TODO AS 放 getSQLTable 内 - jc = j.getJoinConfig(); + SQLConfig jc = j.getJoinConfig(); jc.setPrepared(isPrepared()); - - jt = StringUtil.isEmpty(jc.getAlias(), true) ? jc.getTable() : jc.getAlias(); - tn = j.getTargetName(); + // 将关联表所属数据源配置为主表数据源 + jc.setDatasource(this.getDatasource()); + String jt = jc.gainSQLAlias(); + List onList = j.getOnList(); //如果要强制小写，则可在子类重写这个方法再 toLowerCase // if (DATABASE_POSTGRESQL.equals(getDatabase())) { @@ -2503,58 +5186,275 @@ public String getJoinString() throws Exception { // tn = tn.toLowerCase(); // } + String sql; + switch (type) { //前面已跳过 case "@": // APP JOIN // continue; case "*": // CROSS JOIN - onGetCrossJoinString(j); + onGainCrossJoinString(j); case "<": // LEFT JOIN case ">": // RIGHT JOIN jc.setMain(true).setKeyPrefix(false); sql = ( "<".equals(type) ? " LEFT" : (">".equals(type) ? " RIGHT" : " CROSS") ) - + " JOIN ( " + jc.getSQL(isPrepared()) + " ) AS " - + quote + jt + quote + " ON " + quote + jt + quote + "." + quote + j.getKey() + quote + " = " - + quote + tn + quote + "." + quote + j.getTargetKey() + quote; + + " JOIN ( " + jc.gainSQL(isPrepared()) + " ) " + gainAs() + quote + jt + quote; + sql = concatJoinOn(sql, quote, j, jt, onList); + jc.setMain(false).setKeyPrefix(true); pvl.addAll(jc.getPreparedValueList()); - changed = true; + //changed = true; break; - case "&": // INNER JOIN: A & B - case "": // FULL JOIN: A | B - case "|": // FULL JOIN: A | B + case "&": // INNER JOIN: A & B + case "": // FULL JOIN: A | B + case "|": // FULL JOIN: A | B case "!": // OUTER JOIN: ! (A | B) case "^": // SIDE JOIN: ! (A & B) case "(": // ANTI JOIN: A & ! B case ")": // FOREIGN JOIN: B & ! A - sql = " INNER JOIN " + jc.getTablePath() - + " ON " + quote + jt + quote + "." + quote + j.getKey() + quote + " = " + quote + tn + quote + "." + quote + j.getTargetKey() + quote; + sql = " INNER JOIN " + jc.gainTablePath(); + sql = concatJoinOn(sql, quote, j, jt, onList); + break; + case "~": // ASOF JOIN: B ~= A + sql = " ASOF JOIN " + jc.gainTablePath(); + sql = concatJoinOn(sql, quote, j, jt, onList); break; default: + String k = jc.gainTableKey(); throw new UnsupportedOperationException( - "join:value 中 value 里的 " + jt + "/" + j.getPath() - + "错误！不支持 " + jt + " 等 [ @ APP, < LEFT, > RIGHT, * CROSS" - + ", & INNER, | FULL, ! OUTER, ^ SIDE, ( ANTI, ) FOREIGN ] 之外的 JOIN 类型 !" + "join:value 中 value 里的 " + k + "/" + j.getPath() + + "错误！不支持 " + k + " 等 [ @ APP, < LEFT, > RIGHT, * CROSS" + + ", & INNER, | FULL, ! OUTER, ^ SIDE, ( ANTI, ) FOREIGN, ~ ASOF ] 之外的 JOIN 类型 !" ); } - joinOns += " \n " + sql; - } + SQLConfig oc = j.getOnConfig(); + String ow = null; + if (oc != null) { + oc.setPrepared(isPrepared()); + oc.setPreparedValueList(new ArrayList<>()); + oc.setMain(false).setKeyPrefix(true); + ow = oc.gainWhereString(false); + + pvl.addAll(oc.getPreparedValueList()); + //changed = true; + } + + joinOns += " \n " + sql + (StringUtil.isEmpty(ow, true) ? "" : " AND ( " + ow + " ) "); + } + + + //if (changed) { + // List opvl = getPreparedValueList(); + // if (opvl != null && opvl.isEmpty() == false) { + // pvl.addAll(opvl); + // } + setPreparedValueList(pvl); + //} + + } + + return StringUtil.isEmpty(joinOns, true) ? "" : joinOns + " \n"; + } + + protected String concatJoinOn(@NotNull String sql, @NotNull String quote, @NotNull Join join, @NotNull String jt, List onList) { + if (onList != null) { + SQLConfig jc = join.getJoinConfig(); + Map castMap = jc == null ? null : jc.getCast(); + + boolean first = true; + for (On on : onList) { + Logic logic = on.getLogic(); + boolean isNot = logic == null ? false : logic.isNot(); + if (isNot) { + onJoinNotRelation(sql, quote, join, jt, onList, on); + } + + String lk = quote + jt + quote + "." + quote + on.getKey() + quote; + Object ct = castMap == null ? null : castMap.get(on.getOriginKey()); + if (StringUtil.isNotEmpty(ct, false)) { + lk = "cast(" + lk + " AS " + ct + ")"; // 解决 JOIN ON 不支持 @cast 问题，CAST(expression AS TYPE) 中 AS 不能省略 + } + + String rt = on.getRelateType(); + + String rk = quote + SQLConfig.gainSQLAlias(on.getTargetTable(), on.getTargetAlias()) + quote + "." + quote + on.getTargetKey() + quote; + + if (StringUtil.isEmpty(rt, false)) { + sql += (first ? ON : AND) + lk + (isNot ? " != " : " = ") + rk; + } + else { + onJoinComplexRelation(sql, quote, join, jt, onList, on); + + if (">=".equals(rt) || "<=".equals(rt) || ">".equals(rt) || "<".equals(rt)) { + if (isNot) { + throw new IllegalArgumentException("join:value 中 value 里的 " + jt + "/" + join.getPath() + + " 中 JOIN ON 条件关联逻辑符 " + rt + " 不合法！ >, <, >=, <= 不支持与或非逻辑符 & | ! ！"); + } + + sql += (first ? ON : AND) + lk + " " + rt + " " + rk; + } + else if (rt.endsWith("$")) { + String t = rt.substring(0, rt.length() - 1); + char r = t.isEmpty() ? 0 : t.charAt(t.length() - 1); + + char l; + if (r == '%' || r == '_' || r == '?') { + t = t.substring(0, t.length() - 1); + + if (t.isEmpty()) { + if (r == '?') { + throw new IllegalArgumentException(on.getOriginKey() + ":value 中字符 " + on.getOriginKey() + + " 不合法！key$:value 中不允许只有单独的 '?'，必须和 '%', '_' 之一配合使用 ！"); + } + + l = r; + } + else { + l = t.charAt(t.length() - 1); + if (l == '%' || l == '_' || l == '?') { + if (l == r) { + throw new IllegalArgumentException(on.getOriginKey() + + ":value 中字符 " + t + " 不合法！key$:value 中不允许 key 中有连续相同的占位符！"); + } + + t = t.substring(0, t.length() - 1); + } + else if (l > 0 && StringUtil.isName(String.valueOf(l))) { + l = r; + } + } + + if (l == '?') { + l = 0; + } + if (r == '?') { + r = 0; + } + } + else { + l = r = 0; + } + + if (l <= 0 && r <= 0) { + sql += (first ? ON : AND) + lk + (isNot ? NOT : "") + " LIKE " + rk; + } + else { + sql += (first ? ON : AND) + lk + (isNot ? NOT : "") + + (l <= 0 ? " LIKE concat(" : " LIKE concat('" + l + "', ") + rk + (r <= 0 ? ")" : ", '" + r + "')"); + } + } + else if (rt.endsWith("~")) { + boolean ignoreCase = "*~".equals(rt); + if (isPSQL()) { + sql += (first ? ON : AND) + lk + (isNot ? NOT : "") + " ~" + (ignoreCase ? "* " : " ") + rk; + } + else if (isOracle() || isDameng() || isKingBase()) { + sql += (first ? ON : AND) + "regexp_like(" + lk + ", " + rk + (ignoreCase ? ", 'i'" : ", 'c'") + ")"; + } + else if (isPresto() || isTrino()) { + sql += (first ? ON : AND) + "regexp_like(" + (ignoreCase ? "lower(" : "") + lk + (ignoreCase ? ")" : "") + + ", " + (ignoreCase ? "lower(" : "") + rk + (ignoreCase ? ")" : "") + ")"; + } + else if (isClickHouse()) { + sql += (first ? ON : AND) + "match(" + (ignoreCase ? "lower(" : "") + lk + (ignoreCase ? ")" : "") + + ", " + (ignoreCase ? "lower(" : "") + rk + (ignoreCase ? ")" : "") + ")"; + } + else if (isElasticsearch()) { + sql += (first ? ON : AND) + lk + (isNot ? NOT : "") + " RLIKE " + rk; + } + else if (isHive()) { + sql += (first ? ON : AND) + (ignoreCase ? "lower(" : "") + lk + (ignoreCase ? ")" : "") + + " REGEXP " + (ignoreCase ? "lower(" : "") + rk + (ignoreCase ? ")" : ""); + } + else { + sql += (first ? ON : AND) + lk + (isNot ? NOT : "") + " REGEXP " + (ignoreCase ? "" : "BINARY ") + rk; + } + } + else if ("{}".equals(rt) || "<>".equals(rt)) { + String tt = on.getTargetTable(); + String ta = on.getTargetAlias(); + + Map cast = null; + if (tt.equals(getTable()) && Objects.equals(ta, getAlias())) { + cast = getCast(); + } + else { + boolean find = false; + for (Join jn : joinList) { + if (tt.equals(jn.getTable()) && Objects.equals(ta, jn.getAlias())) { + cast = getCast(); + find = true; + break; + } + } + + if (find == false) { + throw new IllegalArgumentException("join:value 中 value 里的 " + jt + "/" + join.getPath() + + " 中 JOIN ON 条件中找不到对应的 " + rt + " 不合法！只支持 =, {}, <> 这几种！"); + } + } + + boolean isBoolOrNum = SQL.isBooleanOrNumber(cast == null ? null : cast.get(on.getTargetKey())); + boolean isIn = "{}".equals(rt); + String arrKeyPath = isIn ? rk : lk; + String itemKeyPath = isIn ? lk : rk; - if (changed) { - pvl.addAll(preparedValueList); - preparedValueList = pvl; - } + if (isPSQL()) { //operator does not exist: jsonb @> character varying "[" + c + "]"); + sql += (first ? ON : AND) + (isNot ? "( " : "") + gainCondition(isNot, arrKeyPath + + " IS NOT NULL AND " + arrKeyPath + " @> " + itemKeyPath) + (isNot ? ") " : ""); + } + else if (isOracle() || isDameng() || isKingBase()) { + sql += (first ? ON : AND) + (isNot ? "( " : "") + gainCondition(isNot, arrKeyPath + + " IS NOT NULL AND json_textcontains(" + arrKeyPath + + ", '$', " + itemKeyPath + ")") + (isNot ? ") " : ""); + } + else if (isPresto() || isTrino()) { + sql += (first ? ON : AND) + (isNot ? "( " : "") + gainCondition(isNot, arrKeyPath + + " IS NOT NULL AND json_array_contains(cast(" + arrKeyPath + + " AS VARCHAR), " + itemKeyPath + ")") + (isNot ? ") " : ""); + } + else if (isClickHouse()) { + sql += (first ? ON : AND) + (isNot ? "( " : "") + gainCondition(isNot, arrKeyPath + + " IS NOT NULL AND has(JSONExtractArrayRaw(assumeNotNull(" + arrKeyPath + "))" + + ", " + itemKeyPath + ")") + (isNot ? ") " : ""); + } + else { + sql += (first ? ON : AND) + (isNot ? "( " : "") + gainCondition(isNot, arrKeyPath + + " IS NOT NULL AND json_contains(" + arrKeyPath + + (isBoolOrNum ? ", cast(" + itemKeyPath + " AS CHAR), '$')" + : ", concat('\"', " + itemKeyPath + ", '\"'), '$')" + ) + ) + (isNot ? ") " : ""); + } + } + else { + throw new IllegalArgumentException("join:value 中 value 里的 " + jt + "/" + join.getPath() + + " 中 JOIN ON 条件关联类型 " + rt + " 不合法！只支持 =, >, <, >=, <=, !=, $, ~, {}, <> 这几种！"); + } + } + first = false; + } } - return joinOns; + return sql; + } + + protected void onJoinNotRelation(String sql, String quote, Join join, String table, List onList, On on) { + throw new UnsupportedOperationException("JOIN 已禁用 '!' 非逻辑连接符 ！性能很差、需求极少，如要取消禁用可在后端重写相关方法！"); + } + protected void onJoinComplexRelation(String sql, String quote, Join join, String table, List onList, On on) { + throw new UnsupportedOperationException("JOIN 已禁用 $, ~, {}, <>, >, <, >=, <= 等复杂关联 ！" + + "性能很差、需求极少，默认只允许 = 等价关联，如要取消禁用可在后端重写相关方法！"); } - protected void onGetCrossJoinString(Join j) throws UnsupportedOperationException { + protected void onGainJoinString(Join join) throws UnsupportedOperationException { + } + protected void onGainCrossJoinString(Join join) throws UnsupportedOperationException { throw new UnsupportedOperationException("已禁用 * CROSS JOIN ！性能很差、需求极少，如要取消禁用可在后端重写相关方法！"); } @@ -2565,83 +5465,92 @@ protected void onGetCrossJoinString(Join j) throws UnsupportedOperationException * @param isProcedure * @param callback * @return - * @throws Exception + * @throws Exception */ - public static SQLConfig newSQLConfig(RequestMethod method, String table, String alias, JSONObject request, List joinList, boolean isProcedure, Callback callback) throws Exception { + public static , L extends List> SQLConfig newSQLConfig( + RequestMethod method, String table, String alias + , M request, List> joinList, boolean isProcedure, Callback callback) throws Exception { if (request == null) { // User:{} 这种空内容在查询时也有效 - throw new NullPointerException(TAG + ": newSQLConfig request == null!"); + throw new NullPointerException(TAG + ": newSQLConfig request == null!"); } - boolean explain = request.getBooleanValue(KEY_EXPLAIN); - if (explain && Log.DEBUG == false) { //不在 config.setExplain 抛异常，一方面处理更早性能更好，另一方面为了内部调用可以绕过这个限制 - throw new UnsupportedOperationException("DEBUG 模式下不允许传 " + KEY_EXPLAIN + " ！"); + Boolean explain = getBoolean(request, KEY_EXPLAIN); + if (explain != null && explain && Log.DEBUG == false) { // 不在 config.setExplain 抛异常，一方面处理更早性能更好，另一方面为了内部调用可以绕过这个限制 + throw new UnsupportedOperationException("非DEBUG模式, 不允许传 " + KEY_EXPLAIN + " ！"); } - String database = request.getString(KEY_DATABASE); - if (StringUtil.isEmpty(database, false) == false && DATABASE_LIST.contains(database) == false) { - throw new UnsupportedDataTypeException("@database:value 中 value 错误，只能是 [" + StringUtil.getString(DATABASE_LIST.toArray()) + "] 中的一种！"); + String database = getString(request, KEY_DATABASE); + if (StringUtil.isNotEmpty(database, false) && DATABASE_LIST.contains(database) == false) { + throw new UnsupportedDataTypeException("@database:value 中 value 错误，只能是 [" + + StringUtil.get(DATABASE_LIST.toArray()) + "] 中的一种！"); } - String schema = request.getString(KEY_SCHEMA); + String datasource = getString(request, KEY_DATASOURCE); + String namespace = getString(request, KEY_NAMESPACE); + String catalog = getString(request, KEY_CATALOG); + String schema = getString(request, KEY_SCHEMA); - SQLConfig config = callback.getSQLConfig(method, database, schema, table); + SQLConfig config = (SQLConfig) callback.getSQLConfig(method, database, schema, datasource, table); config.setAlias(alias); - config.setDatabase(database); //不删，后面表对象还要用的，必须放在 parseJoin 前 - config.setSchema(schema); //不删，后面表对象还要用的 + config.setDatabase(database); // 不删，后面表对象还要用的，必须放在 parseJoin 前 + config.setDatasource(datasource); // 不删，后面表对象还要用的 + config.setNamespace(namespace); // 不删，后面表对象还要用的 + config.setCatalog(catalog); // 不删，后面表对象还要用的 + config.setSchema(schema); // 不删，后面表对象还要用的 if (isProcedure) { return config; } - config = parseJoin(method, config, joinList, callback); //放后面会导致主表是空对象时 joinList 未解析 + config = parseJoin(method, config, joinList, callback); // 放后面会导致主表是空对象时 joinList 未解析 if (request.isEmpty()) { // User:{} 这种空内容在查询时也有效 - return config; //request.remove(key); 前都可以直接return，之后必须保证 put 回去 + return config; // request.remove(key); 前都可以直接return，之后必须保证 put 回去 } + // 对 id, id{}, userId, userId{} 处理，这些只要不为 null 就一定会作为 AND 条件 <<<<<<<<<<<<<<<<<<<<<<<<< - String idKey = callback.getIdKey(database, schema, table); + String idKey = callback.getIdKey(datasource, database, schema, table); String idInKey = idKey + "{}"; - String userIdKey = callback.getUserIdKey(database, schema, table); + String userIdKey = callback.getUserIdKey(datasource, database, schema, table); String userIdInKey = userIdKey + "{}"; - Object idIn = request.get(idInKey); //可能是 id{}:">0" - - if (method == POST && request.get(idKey) == null) { - Object newId = callback.newId(method, database, schema, table); // null 表示数据库自增 id - if (newId != null) { - request.put(idKey, newId); - } - } - - if (idIn instanceof List) { // 排除掉 0, 负数, 空字符串 等无效 id 值 - List ids = ((List) idIn); + Object idIn = request.get(idInKey); // 可能是 id{}:">0" + if (idIn instanceof Collection) { // 排除掉 0, 负数, 空字符串 等无效 id 值 + Collection ids = (Collection) idIn; List newIdIn = new ArrayList<>(); - Object d; - for (int i = 0; i < ids.size(); i++) { //不用 idIn.contains(id) 因为 idIn 里存到很可能是 Integer，id 又是 Long！ - d = ids.get(i); + for (Object d : ids) { // 不用 idIn.contains(id) 因为 idIn 里存到很可能是 Integer，id 又是 Long！ if ((d instanceof Number && ((Number) d).longValue() > 0) || (d instanceof String && StringUtil.isNotEmpty(d, true))) { - newIdIn.add(d); + if (newIdIn.contains(d) == false) { + newIdIn.add(d); + } } } if (newIdIn.isEmpty()) { - throw new NotExistException(TAG + ": newSQLConfig idIn instanceof List >> 去掉无效 id 后 newIdIn.isEmpty()"); + throw new NotExistException(TAG + ": newSQLConfig idIn instanceof List >> 去掉无效 id 后 newIdIn.isEmpty()"); } idIn = newIdIn; + + if (method == DELETE || method == PUT) { + config.setCount(newIdIn.size()); + } } - - //对id和id{}处理，这两个一定会作为条件 + Object id = request.get(idKey); - if (id != null) { //null无效 - if (id instanceof Number) { - if (((Number) id).longValue() <= 0) { //一定没有值 - throw new NotExistException(TAG + ": newSQLConfig " + table + ".id <= 0"); + if (id == null && method == POST) { + id = callback.newId(method, database, schema, datasource, table); // null 表示数据库自增 id + } + + if (id != null) { // null 无效 + if (id instanceof Number) { + if (((Number) id).longValue() <= 0) { // 一定没有值 + throw new NotExistException(TAG + ": newSQLConfig " + table + ".id <= 0"); } } else if (id instanceof String) { - if (StringUtil.isEmpty(id, true)) { //一定没有值 - throw new NotExistException(TAG + ": newSQLConfig StringUtil.isEmpty(" + table + ".id, true)"); + if (StringUtil.isEmpty(id, true)) { // 一定没有值 + throw new NotExistException(TAG + ": newSQLConfig StringUtil.isEmpty(" + table + ".id, true)"); } } else if (id instanceof Subquery) {} @@ -2649,300 +5558,724 @@ else if (id instanceof Subquery) {} throw new IllegalArgumentException(idKey + ":value 中 value 的类型只能是 Long , String 或 Subquery ！"); } - if (idIn instanceof List) { //共用idIn场景少性能差 + if (idIn instanceof Collection) { // 共用idIn场景少性能差 boolean contains = false; - List ids = ((List) idIn); - Object d; - for (int i = 0; i < ids.size(); i++) { //不用 idIn.contains(id) 因为 idIn 里存到很可能是 Integer，id 又是 Long！ - d = ids.get(i); + Collection idList = ((Collection) idIn); + for (Object d : idList) { // 不用 idIn.contains(id) 因为 idIn 里存到很可能是 Integer，id 又是 Long！ if (d != null && id.toString().equals(d.toString())) { contains = true; break; } } - if (contains == false) {//empty有效 BaseModel.isEmpty(idIn) == false) { - throw new NotExistException(TAG + ": newSQLConfig idIn != null && (((List) idIn).contains(id) == false"); + if (contains == false) { // empty有效 BaseModel.isEmpty(idIn) == false) { + throw new NotExistException(TAG + ": newSQLConfig idIn != null && (((List) idIn).contains(id) == false"); } } - } + if (method == DELETE || method == PUT) { + config.setCount(1); + } + } - String role = request.getString(KEY_ROLE); - String cache = request.getString(KEY_CACHE); - String combine = request.getString(KEY_COMBINE); - Subquery from = (Subquery) request.get(KEY_FROM); - String column = request.getString(KEY_COLUMN); - String group = request.getString(KEY_GROUP); - String having = request.getString(KEY_HAVING); - String order = request.getString(KEY_ORDER); - String raw = request.getString(KEY_RAW); - String json = request.getString(KEY_JSON); + // 对 id, id{}, userId, userId{} 处理，这些只要不为 null 就一定会作为 AND 条件 <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< + Object userIdIn = userIdInKey.equals(idInKey) ? null : request.get(userIdInKey); // 可能是 userId{}:">0" + if (userIdIn instanceof Collection) { // 排除掉 0, 负数, 空字符串 等无效 userId 值 + Collection userIds = (Collection) userIdIn; + List newUserIdIn = new ArrayList<>(); + for (Object d : userIds) { // 不用 userIdIn.contains(userId) 因为 userIdIn 里存到很可能是 Integer，userId 又是 Long！ + if ((d instanceof Number && ((Number) d).longValue() > 0) || (d instanceof String && StringUtil.isNotEmpty(d, true))) { + if (newUserIdIn.contains(d) == false) { + newUserIdIn.add(d); + } + } + } + if (newUserIdIn.isEmpty()) { + throw new NotExistException(TAG + ": newSQLConfig userIdIn instanceof List >> 去掉无效 userId 后 newIdIn.isEmpty()"); + } + userIdIn = newUserIdIn; + } - //强制作为条件且放在最前面优化性能 - request.remove(idKey); - request.remove(idInKey); - //关键词 - request.remove(KEY_ROLE); - request.remove(KEY_EXPLAIN); - request.remove(KEY_CACHE); - request.remove(KEY_DATABASE); - request.remove(KEY_SCHEMA); - request.remove(KEY_COMBINE); - request.remove(KEY_FROM); - request.remove(KEY_COLUMN); - request.remove(KEY_GROUP); - request.remove(KEY_HAVING); - request.remove(KEY_ORDER); - request.remove(KEY_RAW); - request.remove(KEY_JSON); + Object userId = userIdKey.equals(idKey) ? null : request.get(userIdKey); + if (userId != null) { // null 无效 + if (userId instanceof Number) { + if (((Number) userId).longValue() <= 0) { // 一定没有值 + throw new NotExistException(TAG + ": newSQLConfig " + table + ".userId <= 0"); + } + } + else if (userId instanceof String) { + if (StringUtil.isEmpty(userId, true)) { // 一定没有值 + throw new NotExistException(TAG + ": newSQLConfig StringUtil.isEmpty(" + table + ".userId, true)"); + } + } + else if (userId instanceof Subquery) {} + else { + throw new IllegalArgumentException(userIdKey + ":value 中 value 的类型只能是 Long , String 或 Subquery ！"); + } - String[] rawArr = StringUtil.split(raw); - config.setRaw(rawArr == null || rawArr.length <= 0 ? null : new ArrayList<>(Arrays.asList(rawArr))); + if (userIdIn instanceof Collection) { // 共用 userIdIn 场景少性能差 + boolean contains = false; + Collection userIds = (Collection) userIdIn; + for (Object d : userIds) { // 不用 userIdIn.contains(userId) 因为 userIdIn 里存到很可能是 Integer，userId 又是 Long！ + if (d != null && userId.toString().equals(d.toString())) { + contains = true; + break; + } + } + if (contains == false) { // empty有效 BaseModel.isEmpty(userIdIn) == false) { + throw new NotExistException(TAG + ": newSQLConfig userIdIn != null && (((List) userIdIn).contains(userId) == false"); + } + } + } + // 对 id, id{}, userId, userId{} 处理，这些只要不为 null 就一定会作为 AND 条件 >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>> + + + String role = getString(request, KEY_ROLE); + String cache = getString(request, KEY_CACHE); + Subquery from = (Subquery) request.get(KEY_FROM); + String column = getString(request, KEY_COLUMN); + String nulls = getString(request, KEY_NULL); + String cast = getString(request, KEY_CAST); + String combine = getString(request, KEY_COMBINE); + String group = getString(request, KEY_GROUP); + Object having = request.get(KEY_HAVING); + String havingAnd = getString(request, KEY_HAVING_AND); + String sample = getString(request, KEY_SAMPLE); + String latest = getString(request, KEY_LATEST); + String partition = getString(request, KEY_PARTITION); + String fill = getString(request, KEY_FILL); + String order = getString(request, KEY_ORDER); + Object keyMap = request.get(KEY_KEY); + String raw = getString(request, KEY_RAW); + String json = getString(request, KEY_JSON); + String mthd = getString(request, KEY_METHOD); + + try { + // 强制作为条件且放在最前面优化性能 + request.remove(idKey); + request.remove(idInKey); + request.remove(userIdKey); + request.remove(userIdInKey); + // 关键词 + request.remove(KEY_ROLE); + request.remove(KEY_EXPLAIN); + request.remove(KEY_CACHE); + request.remove(KEY_DATABASE); + request.remove(KEY_DATASOURCE); + request.remove(KEY_NAMESPACE); + request.remove(KEY_CATALOG); + request.remove(KEY_SCHEMA); + request.remove(KEY_FROM); + request.remove(KEY_COLUMN); + request.remove(KEY_NULL); + request.remove(KEY_CAST); + request.remove(KEY_COMBINE); + request.remove(KEY_GROUP); + request.remove(KEY_HAVING); + request.remove(KEY_HAVING_AND); + request.remove(KEY_SAMPLE); + request.remove(KEY_LATEST); + request.remove(KEY_PARTITION); + request.remove(KEY_FILL); + request.remove(KEY_ORDER); + request.remove(KEY_KEY); + request.remove(KEY_RAW); + request.remove(KEY_JSON); + request.remove(KEY_METHOD); + + + // @null <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< + String[] nullKeys = StringUtil.split(nulls); + if (nullKeys != null && nullKeys.length > 0) { + for (String nk : nullKeys) { + if (StringUtil.isEmpty(nk, true)) { + throw new IllegalArgumentException(table + ":{ @null: value } 中的字符 '" + nk + "' 不合法！不允许为空！"); + } + if (request.get(nk) != null) { + throw new IllegalArgumentException(table + ":{ @null: value } 中的字符 '" + + nk + "' 已在当前对象有非 null 值！不允许对同一个 JSON key 设置不同值！"); + } - Map tableWhere = new LinkedHashMap();//保证顺序好优化 WHERE id > 1 AND name LIKE... + request.put(nk, null); + } + } + // @null >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>> + + // @cast <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< + String[] casts = StringUtil.split(cast); + Map castMap = null; + if (casts != null && casts.length > 0) { + castMap = new HashMap<>(casts.length); + for (String c : casts) { + apijson.orm.Entry p = Pair.parseEntry(c); + + if (StringUtil.isEmpty(p.getKey(), true)) { + throw new IllegalArgumentException(table + ":{} 里的 @cast: 'key0:type0,key1:type1..' 中 '" + + c + "' 对应的 key 的字符 '" + p.getKey() + "' 不合法！不允许为空！"); + } + if (StringUtil.isName(p.getValue()) == false) { + throw new IllegalArgumentException(table + ":{} 里的 @cast: 'key0:type0,key1:type1..' 中 '" + + c + "' 对应的 type 的字符 '" + p.getValue() + "' 不合法！必须符合类型名称格式！"); + } + if (castMap.get(p.getKey()) != null) { + throw new IllegalArgumentException(table + ":{} 里的 @cast: 'key0:type0,key1:type1..' 中 '" + + c + "' 对应的 key 的字符 '" + p.getKey() + "' 已存在！不允许重复设置类型！"); + } - //已经remove了id和id{}，以及@key - Set set = request.keySet(); //前面已经判断request是否为空 - if (method == POST) { //POST操作 - if (idIn != null) { - throw new IllegalArgumentException("POST 请求中不允许传 " + idInKey + " !"); + castMap.put(p.getKey(), p.getValue()); + } } + // @cast >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>> - if (set != null && set.isEmpty() == false) { //不能直接return，要走完下面的流程 - String[] columns = set.toArray(new String[]{}); - Collection valueCollection = request.values(); - Object[] values = valueCollection == null ? null : valueCollection.toArray(); + String[] rawArr = StringUtil.split(raw); + config.setRaw(rawArr == null || rawArr.length <= 0 ? null : new ArrayList<>(Arrays.asList(rawArr))); - if (values == null || values.length != columns.length) { - throw new Exception("服务器内部错误:\n" + TAG - + " newSQLConfig values == null || values.length != columns.length !"); - } - column = (id == null ? "" : idKey + ",") + StringUtil.getString(columns); //set已经判断过不为空 + Map tableWhere = new LinkedHashMap(); // 保证顺序好优化 WHERE id > 1 AND name LIKE... - List> valuess = new ArrayList<>(1); - List items; //(item0, item1, ...) - if (id == null) { //数据库自增 id - items = Arrays.asList(values); //FIXME 是否还需要进行 add 或 remove 操作？Arrays.ArrayList 不允许修改，会抛异常 - } - else { - int size = columns.length + (id == null ? 0 : 1); //以key数量为准 + boolean ignoreBlankStr = IGNORE_BLANK_STRING_METHOD_LIST != null && IGNORE_BLANK_STRING_METHOD_LIST.contains(method); + boolean ignoreEmptyStr = ignoreBlankStr || (IGNORE_EMPTY_STRING_METHOD_LIST != null && IGNORE_EMPTY_STRING_METHOD_LIST.contains(method)); + boolean ignoreEmptyOrBlankStr = ignoreEmptyStr || ignoreBlankStr; + + boolean enableFakeDelete = config.isFakeDelete(); - items = new ArrayList<>(size); - items.add(id); //idList.get(i)); //第0个就是id + // 已经 remove了 id 和 id{}，以及 @key + Set set = request.keySet(); // 前面已经判断 request 是否为空 + if (method == POST) { // POST操作 + if (idIn != null) { + throw new IllegalArgumentException(table + ":{" + idInKey + ": value} 里的 key 不合法！POST 请求中不允许传 " + idInKey + + " 这种非字段命名 key ！必须为 英文字母 开头且只包含 英文字母、数字、下划线的 字段命名！"); } + if (userIdIn != null) { + throw new IllegalArgumentException(table + ":{" + userIdInKey + ": value} 里的 key 不合法！POST 请求中不允许传 " + userIdInKey + + " 这种非字段命名 key ！必须为 英文字母 开头且只包含 英文字母、数字、下划线的 字段命名！"); } - for (int j = 1; j < size; j++) { - items.add(values[j-1]); //从第1个开始，允许"null" + if (set != null && set.isEmpty() == false) { // 不能直接return，要走完下面的流程 + for (String k : set) { + if (StringUtil.isName(k) == false) { + throw new IllegalArgumentException(table + ":{" + k + ": value} 里的 key 不合法！POST 请求中不允许传 " + k + + " 这种非字段命名 key ！必须为 英文字母 开头且只包含 英文字母、数字、下划线的 字段命名！"); + } } - } - valuess.add(items); - config.setValues(valuess); - } - } - else { //非POST操作 - final boolean isWhere = method != PUT;//除了POST,PUT，其它全是条件！！！ + String[] columns = set.toArray(new String[]{}); - //条件<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< - List whereList = null; + Collection valueCollection = request.values(); + Object[] values = valueCollection == null ? null : valueCollection.toArray(); - Map> combineMap = new LinkedHashMap<>(); - List andList = new ArrayList<>(); - List orList = new ArrayList<>(); - List notList = new ArrayList<>(); + if (values == null || values.length != columns.length) { + throw new Exception("服务器内部错误:\n" + TAG + + " newSQLConfig values == null || values.length != columns.length !"); + } - //强制作为条件且放在最前面优化性能 - if (id != null) { - tableWhere.put(idKey, id); - andList.add(idKey); - } - if (idIn != null) { - tableWhere.put(idInKey, idIn); - andList.add(idInKey); + column = (id == null ? "" : idKey + ",") + (userId == null ? "" : userIdKey + ",") + + StringUtil.get(columns); //set已经判断过不为空 + + int idCount = id == null ? (userId == null ? 0 : 1) : (userId == null ? 1 : 2); + int size = idCount + columns.length; // 以 key 数量为准 + + List items = new ArrayList<>(size); // VALUES(item0, item1, ...) + if (id != null) { + items.add(id); // idList.get(i)); // 第 0 个就是 id + } + if (userId != null) { + items.add(userId); // idList.get(i)); // 第 1 个就是 userId + } + + for (int j = 0; j < values.length; j++) { + items.add(values[j]); // 从第 1 个开始，允许 "null" + } + + List> valuess = new ArrayList<>(1); + valuess.add(items); + config.setValues(valuess); + } } + else { // 非 POST 操作 + final boolean isWhere = method != PUT; // 除了POST,PUT，其它全是条件！！！ - String[] ws = StringUtil.split(combine); - if (ws != null) { - if (method == DELETE || method == GETS || method == HEADS) { - throw new IllegalArgumentException("DELETE,GETS,HEADS 请求不允许传 @combine:value !"); + // 条件<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< + String[] ws = StringUtil.split(combine); + String combineExpr = ws == null || ws.length != 1 ? null : ws[0]; + + Map> combineMap = new LinkedHashMap<>(); + List andList = new ArrayList<>(); + List orList = new ArrayList<>(); + List notList = new ArrayList<>(); + + List whereList = new ArrayList<>(); + + // 强制作为条件且放在最前面优化性能 + if (id != null) { + tableWhere.put(idKey, id); + andList.add(idKey); + whereList.add(idKey); + } + if (idIn != null) { + tableWhere.put(idInKey, idIn); + andList.add(idInKey); + whereList.add(idInKey); + } + if (userId != null) { + tableWhere.put(userIdKey, userId); + andList.add(userIdKey); + whereList.add(userIdKey); + } + if (userIdIn != null) { + tableWhere.put(userIdInKey, userIdIn); + andList.add(userIdInKey); + whereList.add(userIdInKey); } - whereList = new ArrayList<>(); - String w; - for (int i = 0; i < ws.length; i++) { //去除 &,|,! 前缀 - w = ws[i]; - if (w != null) { - if (w.startsWith("&")) { - w = w.substring(1); - andList.add(w); - } - else if (w.startsWith("|")) { - if (method == PUT) { - throw new IllegalArgumentException(table + ":{} 里的 @combine:value 中的value里条件 " + ws[i] + " 不合法！" - + "PUT请求的 @combine:\"key0,key1,...\" 不允许传 |key 或 !key !"); + if (enableFakeDelete) { + // 查询 Access 假删除 + Map accessFakeDeleteMap = method == DELETE + ? null : AbstractVerifier.ACCESS_FAKE_DELETE_MAP.get(config.getTable()); + Object deletedKey = accessFakeDeleteMap == null ? null : accessFakeDeleteMap.get(KEY_DELETED_KEY); + boolean hasKey = deletedKey instanceof String && StringUtil.isNotEmpty(deletedKey, true); + Object deletedValue = hasKey ? accessFakeDeleteMap.get(KEY_DELETED_VALUE) : null; + boolean containNotDeletedValue = hasKey && accessFakeDeleteMap.containsKey(KEY_NOT_DELETED_VALUE); + Object notDeletedValue = containNotDeletedValue ? accessFakeDeleteMap.get(KEY_NOT_DELETED_VALUE) : null; + + if (deletedValue != null || containNotDeletedValue) { + boolean isFakeDelete = true; + if (from != null) { + // 兼容 JOIN 外层 SELECT 重复生成 deletedKey + SQLConfig cfg = from.gainConfig(); + if (cfg != null && StringUtil.equals(table, cfg.getTable())) { + isFakeDelete = false; } - w = w.substring(1); - orList.add(w); - } - else if (w.startsWith("!")) { - if (method == PUT) { - throw new IllegalArgumentException(table + ":{} 里的 @combine:value 中的value里条件 " + ws[i] + " 不合法！" - + "PUT请求的 @combine:\"key0,key1,...\" 不允许传 |key 或 !key !"); + + List> jl = isFakeDelete && cfg != null ? cfg.getJoinList() : null; + if (jl != null) { + for (Join join : jl) { + if (join != null && StringUtil.equals(table, join.getTable())) { + isFakeDelete = false; + break; + } + } } - w = w.substring(1); - notList.add(w); - } - else { - orList.add(w); } - if (w.isEmpty()) { - throw new IllegalArgumentException(table + ":{} 里的 @combine:value 中的value里条件 " + ws[i] + " 不合法！不允许为空值！"); - } - else { - if (idKey.equals(w) || idInKey.equals(w) || userIdKey.equals(w) || userIdInKey.equals(w)) { - throw new UnsupportedOperationException(table + ":{} 里的 @combine:value 中的value里 " + ws[i] + " 不合法！" - + "不允许传 [" + idKey + ", " + idInKey + ", " + userIdKey + ", " + userIdInKey + "] 其中任何一个！"); + if (isFakeDelete) { // 支持 deleted != 1 / deleted is null 等表达式 + if (deletedValue != null) { // deletedKey != deletedValue + String key = deletedKey + "!"; + tableWhere.put(key, deletedValue); + andList.add(key); + whereList.add(key); + } + + if (containNotDeletedValue) { // deletedKey = notDeletedValue + String key = deletedKey.toString(); + tableWhere.put(key, notDeletedValue); + andList.add(key); + whereList.add(key); } } + } + } - whereList.add(w); + if (StringUtil.isNotEmpty(combineExpr, true)) { + List banKeyList = Arrays.asList(idKey, idInKey, userIdKey, userIdInKey); + for (String key : banKeyList) { + if (isKeyInCombineExpr(combineExpr, key)) { + throw new UnsupportedOperationException(table + ":{} 里的 @combine:value 中的 value 里 " + key + " 不合法！" + + "不允许传 [" + idKey + ", " + idInKey + ", " + userIdKey + ", " + userIdInKey + "] 其中任何一个！"); + } } + } + else if (ws != null) { + for (int i = 0; i < ws.length; i++) { // 去除 &,|,! 前缀 + String w = ws[i]; + if (w != null) { + if (w.startsWith("&")) { + w = w.substring(1); + andList.add(w); + } + else if (w.startsWith("|")) { + if (method == PUT) { + throw new IllegalArgumentException(table + ":{} 里的 @combine:value 中的value里条件 " + ws[i] + " 不合法！" + + "PUT请求的 @combine:\"key0,key1,...\" 不允许传 |key 或 !key !"); + } + w = w.substring(1); + orList.add(w); + } + else if (w.startsWith("!")) { + if (method == PUT) { + throw new IllegalArgumentException(table + ":{} 里的 @combine:value 中的value里条件 " + ws[i] + " 不合法！" + + "PUT请求的 @combine:\"key0,key1,...\" 不允许传 |key 或 !key !"); + } + w = w.substring(1); + notList.add(w); + } + else { + orList.add(w); + } + + if (w.isEmpty()) { + throw new IllegalArgumentException(table + ":{} 里的 @combine:value 中的value里条件 " + ws[i] + " 不合法！不允许为空值！"); + } + else { + if (idKey.equals(w) || idInKey.equals(w) || userIdKey.equals(w) || userIdInKey.equals(w)) { + throw new UnsupportedOperationException(table + ":{} 里的 @combine:value 中的 value 里 " + ws[i] + " 不合法！" + + "不允许传 [" + idKey + ", " + idInKey + ", " + userIdKey + ", " + userIdInKey + "] 其中任何一个！"); + } + } - // 可重写回调方法自定义处理 // 动态设置的场景似乎很少，而且去掉后不方便用户排错！//去掉判断，有时候不在没关系，如果是对增删改等非开放请求强制要求传对应的条件，可以用 Operation.NECESSARY - if (request.containsKey(w) == false) { //和 request.get(w) == null 没区别，前面 Parser 已经过滤了 null - // throw new IllegalArgumentException(table + ":{} 里的 @combine:value 中的value里 " + ws[i] + " 对应的 " + w + " 不在它里面！"); - callback.onMissingKey4Combine(table, request, combine, ws[i], w); + whereList.add(w); + } + + // 可重写回调方法自定义处理 // 动态设置的场景似乎很少，而且去掉后不方便用户排错！ + // 去掉判断，有时候不在没关系，如果是对增删改等非开放请求强制要求传对应的条件，可以用 Operation.NECESSARY + if (request.containsKey(w) == false) { // 和 request.get(w) == null 没区别，前面 Parser 已经过滤了 null + // throw new IllegalArgumentException(table + ":{} 里的 @combine:value 中的value里 " + ws[i] + " 对应的 " + w + " 不在它里面！"); + callback.onMissingKey4Combine(table, request, combine, ws[i], w); + if (config instanceof AbstractSQLConfig) { + ((AbstractSQLConfig) config).putWarnIfNeed(KEY_COMBINE, table + ":{} 里的 @combine:value 中的 value 里 " + + ws[i] + " 对应的条件 " + w + ":value 中 value 必须存在且不能为 null！"); + } + } } } - } + // 条件 >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>> - //条件>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>> - Map tableContent = new LinkedHashMap(); - Object value; - for (String key : set) { - value = request.get(key); + Map tableContent = new LinkedHashMap(); + for (String key : set) { + Object value = request.get(key); + if (ignoreEmptyOrBlankStr && value instanceof String && StringUtil.isEmpty(value, ignoreBlankStr)) { + continue; + } - if (value instanceof Map) {//只允许常规Object - throw new IllegalArgumentException("不允许 " + key + " 等任何key的value类型为 {JSONObject} !"); - } + if (key.endsWith("<>") == false && value instanceof Map) { // 只允许常规 Object + throw new IllegalArgumentException(table + ":{ " + key + ":value } 中 value 类型错误！除了 key<>:{} 外，不允许 " + + key + " 等其它任何 key 对应 value 的类型为 JSONMap {} !"); + } - //解决AccessVerifier新增userId没有作为条件，而是作为内容，导致PUT，DELETE出错 - if (isWhere) { - tableWhere.put(key, value); - if (whereList == null || whereList.contains(key) == false) { - andList.add(key); + // 兼容 PUT @combine + // 解决AccessVerifier新增userId没有作为条件，而是作为内容，导致PUT，DELETE出错 + if ((isWhere || (StringUtil.isName(key.replaceFirst("[+-]$", "")) == false)) + || (isWhere == false && StringUtil.isNotEmpty(combineExpr, true) && isKeyInCombineExpr(combineExpr, key))) { + tableWhere.put(key, value); + if (whereList.contains(key) == false) { + andList.add(key); + } + } else if (whereList.contains(key)) { + tableWhere.put(key, value); + } else { + tableContent.put(key, value); // 一样 instanceof List ? JSON.toJSONString(value) : value); } } - else if (whereList != null && whereList.contains(key)) { - tableWhere.put(key, value); - } - else { - tableContent.put(key, value);//一样 instanceof JSONArray ? JSON.toJSONString(value) : value); + + if (combineMap != null) { + combineMap.put("&", andList); + combineMap.put("|", orList); + combineMap.put("!", notList); } + config.setCombineMap(combineMap); + config.setCombine(combineExpr); + + config.setContent(tableContent); } - combineMap.put("&", andList); - combineMap.put("|", orList); - combineMap.put("!", notList); - config.setCombine(combineMap); + if (enableFakeDelete && method == DELETE) { + // 查询 Access 假删除 + Map accessFakeDeleteMap = AbstractVerifier.ACCESS_FAKE_DELETE_MAP.get(config.getTable()); + + Object deletedKey = accessFakeDeleteMap.get(KEY_DELETED_KEY); + if (StringUtil.isNotEmpty(deletedKey, true)) { + // 假删除需要更新的其他字段，比如：删除时间 deletedTime 之类的 + Map fakeDeleteMap = new HashMap<>(); + fakeDeleteMap.put(deletedKey.toString(), accessFakeDeleteMap.get(KEY_DELETED_VALUE)); + fakeDeleteMap = config.onFakeDelete(fakeDeleteMap); + + Map content = config.getContent(); + if (content == null || content.isEmpty()) { + content = fakeDeleteMap; + } else { + content.putAll(fakeDeleteMap); + } - config.setContent(tableContent); - } + config.setMethod(PUT); + config.setContent(content); + } + } + List cs = new ArrayList<>(); - List cs = new ArrayList<>(); + List rawList = config.getRaw(); + boolean containColumnHavingAnd = rawList != null && rawList.contains(KEY_HAVING_AND); - List rawList = config.getRaw(); - boolean containColumnRaw = rawList != null && rawList.contains(KEY_COLUMN); + if (containColumnHavingAnd) { + throw new IllegalArgumentException(table + ":{ @raw:value } 的 value 里字符 @having& 不合法！" + + "@raw 不支持 @having&，请用 @having 替代！"); + } - String rawColumnSQL = null; - if (containColumnRaw) { - try { - rawColumnSQL = config.getRawSQL(KEY_COLUMN, column); + // TODO 这段是否必要？如果 @column 只支持分段后的 SQL 片段，也没问题 + boolean containColumnRaw = rawList != null && rawList.contains(KEY_COLUMN); + String rawColumnSQL = null; + if (containColumnRaw) { + rawColumnSQL = config.gainRawSQL(KEY_COLUMN, column); if (rawColumnSQL != null) { cs.add(rawColumnSQL); } - } catch (Exception e) { - Log.e(TAG, "newSQLConfig config instanceof AbstractSQLConfig >> try { " - + " rawColumnSQL = ((AbstractSQLConfig) config).getRawSQL(KEY_COLUMN, column); " - + "} catch (Exception e) = " + e.getMessage()); } - } - boolean distinct = column == null || rawColumnSQL != null ? false : column.startsWith(PREFFIX_DISTINCT); - if (rawColumnSQL == null) { - String[] fks = StringUtil.split(distinct ? column.substring(PREFFIX_DISTINCT.length()) : column, ";"); // key0,key1;fun0(key0,...);fun1(key0,...);key3;fun2(key0,...) - if (fks != null) { - String[] ks; - for (String fk : fks) { - if (containColumnRaw) { - try { - String rawSQL = config.getRawSQL(KEY_COLUMN, fk); + boolean distinct = rawColumnSQL == null && column != null && column.startsWith(PREFIX_DISTINCT); + if (rawColumnSQL == null) { + // key0,key1;fun0(key0,...);fun1(key0,...);key3;fun2(key0,...) + String[] fks = StringUtil.split(distinct ? column.substring(PREFIX_DISTINCT.length()) : column, ";"); + if (fks != null) { + for (String fk : fks) { + if (containColumnRaw) { + String rawSQL = config.gainRawSQL(KEY_COLUMN, fk); if (rawSQL != null) { cs.add(rawSQL); continue; } - } catch (Exception e) { - Log.e(TAG, "newSQLConfig rawColumnSQL == null >> try { " - + " String rawSQL = ((AbstractSQLConfig) config).getRawSQL(KEY_COLUMN, fk); ... " - + "} catch (Exception e) = " + e.getMessage()); } - } - if (fk.contains("(")) { // fun0(key0,...) - cs.add(fk); + if (fk.contains("(")) { // fun0(key0,...) + cs.add(fk); + } + else { // key0,key1... + String[] ks = StringUtil.split(fk); + if (ks != null && ks.length > 0) { + cs.addAll(Arrays.asList(ks)); + } + } } - else { //key0,key1... - ks = StringUtil.split(fk); - if (ks != null && ks.length > 0) { - cs.addAll(Arrays.asList(ks)); + } + } + + + // @having, @haivng& <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< + Object newHaving = having; + boolean isHavingAnd = false; + + Map havingMap = new LinkedHashMap<>(); + if (havingAnd != null) { + if (having != null) { + throw new IllegalArgumentException(table + ":{ @having: value1, @having&: value2 } " + + "中 value1 与 value2 不合法！不允许同时传 @having 和 @having& ，两者最多传一个！"); + } + + newHaving = havingAnd; + isHavingAnd = true; + } + + String havingKey = (isHavingAnd ? KEY_HAVING_AND : KEY_HAVING); + String havingCombine = ""; + + if (newHaving instanceof String) { + String[] havingss = StringUtil.split((String) newHaving, ";"); + if (havingss != null) { + int ind = -1; + for (int i = 0; i < havingss.length; i++) { + + String havingsStr = havingss[i]; + int start = havingsStr == null ? -1 : havingsStr.indexOf("("); + int end = havingsStr == null ? -1 : havingsStr.lastIndexOf(")"); + if (IS_HAVING_ALLOW_NOT_FUNCTION == false && (start < 0 || start >= end)) { + throw new IllegalArgumentException(table + ":{ " + havingKey + ":value } 里的 value 中的第 " + i + + " 个字符 '" + havingsStr + "' 不合法！里面没有包含 SQL 函数！必须为 fun(col1,col2..)?val 格式！"); + } + + String[] havings = start >= 0 && end > start ? new String[]{havingsStr} : StringUtil.split(havingsStr); + if (havings != null) { + for (int j = 0; j < havings.length; j++) { + ind ++; + String h = havings[j]; + if (StringUtil.isEmpty(h, true)) { + throw new IllegalArgumentException(table + ":{ " + havingKey + ":value } 里的" + + " value 中的第 " + ind + " 个字符 '" + h + "' 不合法！不允许为空！"); + } + + havingMap.put("having" + ind, h); + + if (isHavingAnd == false && IS_HAVING_DEFAULT_AND == false) { + havingCombine += (ind <= 0 ? "" : " | ") + "having" + ind; + } + } } } } } - } + else if (newHaving instanceof Map) { + if (isHavingAnd) { + throw new IllegalArgumentException(table + ":{ " + havingKey + ":value } 里的 value 类型不合法！" + + "@having&:value 中 value 只能是 String，@having:value 中 value 只能是 String 或 JSONMap ！"); + } - config.setExplain(explain); - config.setCache(getCache(cache)); - config.setFrom(from); - config.setDistinct(distinct); - config.setColumn(column == null ? null : cs); //解决总是 config.column != null，总是不能得到 * - config.setWhere(tableWhere); + M havingObj = JSON.createJSONObject((Map) newHaving); + Set> havingSet = havingObj.entrySet(); + for (Entry entry : havingSet) { + String k = entry == null ? null : entry.getKey(); + Object v = k == null ? null : entry.getValue(); + if (v == null) { + continue; + } + if (v instanceof String == false) { + throw new IllegalArgumentException(table + ":{ " + havingKey + ":{ " + k + ":value } } 里的" + + " value 不合法！类型只能是 String，且不允许为空！"); + } + if (ignoreEmptyOrBlankStr && StringUtil.isEmpty(v, ignoreBlankStr)) { + continue; + } + + if (KEY_COMBINE.equals(k)) { + havingCombine = (String) v; + } + else if (StringUtil.isName(k) == false) { + throw new IllegalArgumentException(table + ":{ " + havingKey + ":{ " + k + ":value } } 里的" + + " key 对应字符 " + k + " 不合法！必须为 英文字母 开头，且只包含 英文字母、下划线、数字 的合法变量名！"); + } + else { + havingMap.put(k, (String) v); + } + } + } + else if (newHaving != null) { + throw new IllegalArgumentException(table + ":{ " + havingKey + ":value } 里的 value 类型不合法！" + + "@having:value 中 value 只能是 String 或 JSONMap，@having&:value 中 value 只能是 String ！"); + } + // @having, @haivng& >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>> - config.setId(id); - //在 tableWhere 第0个 config.setIdIn(idIn); + if (keyMap instanceof Map) { + config.setKeyMap((Map) keyMap); + } + else if (keyMap instanceof String) { + String[] ks = StringUtil.split((String) keyMap, ";"); + if (ks.length > 0) { + Map nkm = new LinkedHashMap<>(); + for (int i = 0; i < ks.length; i++) { + Entry ety = Pair.parseEntry(ks[i]); + if (ety == null) { + continue; + } + nkm.put(ety.getKey(), ety.getValue()); + } + config.setKeyMap(nkm); + } + } + else if (keyMap != null) { + throw new UnsupportedDataTypeException("@key:value 中 value 错误，只能是 String, JSONMap 中的一种！"); + } - config.setRole(RequestRole.get(role)); - config.setGroup(group); - config.setHaving(having); - config.setOrder(order); - String[] jsonArr = StringUtil.split(json); - config.setJson(jsonArr == null || jsonArr.length <= 0 ? null : new ArrayList<>(Arrays.asList(jsonArr))); + config.setExplain(explain != null && explain); + config.setCache(getCache(cache)); + config.setDistinct(distinct); + config.setColumn(column == null ? null : cs); //解决总是 config.column != null，总是不能得到 * + config.setFrom(from); + + config.setRole(role); + config.setId(id); + config.setIdIn(idIn); + config.setUserId(userId); + config.setUserIdIn(userIdIn); + + config.setNull(nullKeys == null || nullKeys.length <= 0 ? null : new ArrayList<>(Arrays.asList(nullKeys))); + config.setCast(castMap); + config.setWhere(tableWhere); + config.setGroup(group); + config.setHaving(havingMap); + config.setHavingCombine(havingCombine); + config.setSample(sample); + config.setLatest(latest); + config.setPartition(partition); + config.setFill(fill); + config.setOrder(order); + + String[] jsons = StringUtil.split(json); + config.setJson(jsons == null || jsons.length <= 0 ? null : new ArrayList<>(Arrays.asList(jsons))); - //TODO 解析JOIN，包括 @column，@group 等要合并 + } + finally { // 后面还可能用到，要还原 + // id, id{}, userId, userIdIn 条件 + if (id != null) { + request.put(idKey, id); + } + if (idIn != null) { + request.put(idInKey, idIn); + } + if (userId != null) { + request.put(userIdKey, userId); + } + if (userIdIn != null) { + request.put(userIdInKey, userIdIn); + } - //后面还可能用到，要还原 - //id或id{}条件 - request.put(idKey, id); - request.put(idInKey, idIn); - //关键词 - request.put(KEY_DATABASE, database); - request.put(KEY_ROLE, role); - request.put(KEY_EXPLAIN, explain); - request.put(KEY_CACHE, cache); - request.put(KEY_SCHEMA, schema); - request.put(KEY_COMBINE, combine); - request.put(KEY_FROM, from); - request.put(KEY_COLUMN, column); - request.put(KEY_GROUP, group); - request.put(KEY_HAVING, having); - request.put(KEY_ORDER, order); - request.put(KEY_RAW, raw); - request.put(KEY_JSON, json); + // 关键词 + if (role != null) { + request.put(KEY_ROLE, role); + } + if (explain != null) { + request.put(KEY_EXPLAIN, explain); + } + if (cache != null) { + request.put(KEY_CACHE, cache); + } + if (database != null) { + request.put(KEY_DATABASE, database); + } + if (datasource != null) { + request.put(KEY_DATASOURCE, datasource); + } + if (schema != null) { + request.put(KEY_SCHEMA, schema); + } + if (from != null) { + request.put(KEY_FROM, from); + } + if (column != null) { + request.put(KEY_COLUMN, column); + } + if (nulls != null) { + request.put(KEY_NULL, nulls); + } + if (cast != null) { + request.put(KEY_CAST, cast); + } + if (combine != null) { + request.put(KEY_COMBINE, combine); + } + if (group != null) { + request.put(KEY_GROUP, group); + } + if (having != null) { + request.put(KEY_HAVING, having); + } + if (havingAnd != null) { + request.put(KEY_HAVING_AND, havingAnd); + } + if (sample != null) { + request.put(KEY_SAMPLE, sample); + } + if (latest != null) { + request.put(KEY_LATEST, latest); + } + if (partition != null) { + request.put(KEY_PARTITION, partition); + } + if (fill != null) { + request.put(KEY_FILL, fill); + } + if (order != null) { + request.put(KEY_ORDER, order); + } + if (keyMap != null) { + request.put(KEY_KEY, keyMap); + } + if (raw != null) { + request.put(KEY_RAW, raw); + } + if (json != null) { + request.put(KEY_JSON, json); + } + if (mthd != null) { + request.put(KEY_METHOD, mthd); + } + } return config; } @@ -2957,11 +6290,12 @@ else if (whereList != null && whereList.contains(key)) { * @return * @throws Exception */ - public static SQLConfig parseJoin(RequestMethod method, SQLConfig config, List joinList, Callback callback) throws Exception { + public static , L extends List> SQLConfig parseJoin( + RequestMethod method, SQLConfig config, List> joinList, Callback callback) throws Exception { boolean isQuery = RequestMethod.isQueryMethod(method); config.setKeyPrefix(isQuery && config.isMain() == false); - //TODO 解析出 SQLConfig 再合并 column, order, group 等 + //TODO 解析出 SQLConfig 再合并 column, order, group 等 if (joinList == null || joinList.isEmpty() || RequestMethod.isQueryMethod(method) == false) { return config; } @@ -2969,25 +6303,29 @@ public static SQLConfig parseJoin(RequestMethod method, SQLConfig config, List join : joinList) { + table = join.getTable(); + alias = join.getAlias(); //JOIN子查询不能设置LIMIT，因为ON关系是在子查询后处理的，会导致结果会错误 - SQLConfig joinConfig = newSQLConfig(method, table, alias, j.getRequest(), null, false, callback); - SQLConfig cacheConfig = newSQLConfig(method, table, alias, j.getRequest(), null, false, callback).setCount(1); + SQLConfig joinConfig = newSQLConfig(method, table, alias, join.getRequest(), null, false, callback); + SQLConfig cacheConfig = join.canCacheViceTable() == false ? null : newSQLConfig(method, table, alias + , join.getRequest(), null, false, callback).setCount(join.getCount()); - if (j.isAppJoin() == false) { //除了 @ APP JOIN，其它都是 SQL JOIN，则副表要这样配置 + if (join.isAppJoin() == false) { //除了 @ APP JOIN，其它都是 SQL JOIN，则副表要这样配置 if (joinConfig.getDatabase() == null) { joinConfig.setDatabase(config.getDatabase()); //解决主表 JOIN 副表，引号不一致 } else if (joinConfig.getDatabase().equals(config.getDatabase()) == false) { - throw new IllegalArgumentException("主表 " + config.getTable() + " 的 @database:" + config.getDatabase() + " 和它 SQL JOIN 的副表 " + table + " 的 @database:" + joinConfig.getDatabase() + " 不一致！"); + throw new IllegalArgumentException("主表 " + config.getTable() + " 的 @database:" + config.getDatabase() + + " 和它 SQL JOIN 的副表 " + table + " 的 @database:" + joinConfig.getDatabase() + " 不一致！"); } if (joinConfig.getSchema() == null) { joinConfig.setSchema(config.getSchema()); //主表 JOIN 副表，默认 schema 一致 } - cacheConfig.setDatabase(joinConfig.getDatabase()).setSchema(joinConfig.getSchema()); //解决主表 JOIN 副表，引号不一致 + if (cacheConfig != null) { + cacheConfig.setDatabase(joinConfig.getDatabase()).setSchema(joinConfig.getSchema()); //解决主表 JOIN 副表，引号不一致 + } if (isQuery) { config.setKeyPrefix(true); @@ -2995,26 +6333,52 @@ else if (joinConfig.getDatabase().equals(config.getDatabase()) == false) { joinConfig.setMain(false).setKeyPrefix(true); - if (j.isLeftOrRightJoin()) { - SQLConfig outterConfig = newSQLConfig(method, table, alias, j.getOuter(), null, false, callback); - outterConfig.setMain(false).setKeyPrefix(true).setDatabase(joinConfig.getDatabase()).setSchema(joinConfig.getSchema()); //解决主表 JOIN 副表，引号不一致 - j.setOuterConfig(outterConfig); + if (join.getOn() != null) { + SQLConfig onConfig = newSQLConfig(method, table, alias, join.getOn(), null, false, callback); + onConfig.setMain(false) + .setKeyPrefix(true) + .setDatabase(joinConfig.getDatabase()) + .setSchema(joinConfig.getSchema()); //解决主表 JOIN 副表，引号不一致 + + join.setOnConfig(onConfig); + } + + if (join.getOuter() != null) { + SQLConfig outerConfig = newSQLConfig(method, table, alias, join.getOuter(), null, false, callback); + outerConfig.setMain(false) + .setKeyPrefix(true) + .setDatabase(joinConfig.getDatabase()) + .setSchema(joinConfig.getSchema()); //解决主表 JOIN 副表，引号不一致 + join.setOuterConfig(outerConfig); } } - //解决 query: 1/2 查数量时报错 - /* SELECT count(*) AS count FROM sys.Moment AS Moment + //解决 query: 1/2 查数量时报错 + /* SELECT count(*) AS count FROM sys.Moment AS Moment LEFT JOIN ( SELECT count(*) AS count FROM sys.Comment ) AS Comment ON Comment.momentId = Moment.id LIMIT 1 OFFSET 0 */ if (RequestMethod.isHeadMethod(method, true)) { - joinConfig.setMethod(GET); //子查询不能为 SELECT count(*) ，而应该是 SELECT momentId - joinConfig.setColumn(Arrays.asList(j.getKey())); //优化性能，不取非必要的字段 + List onList = join.getOnList(); + List column = onList == null ? null : new ArrayList<>(onList.size()); + //解决 pg 如果只查询关联键，会报找不到column的错误 + ///* SELECT count(*) AS count FROM sys.Moment AS Moment + // LEFT JOIN ( SELECT * FROM sys.Comment ) AS Comment ON Comment.momentId = Moment.id LIMIT 1 OFFSET 0 */ + if (column != null && joinConfig.isMSQL()) { // 暂时这样兼容 PostgreSQL 等不支持 SELECT 中不包含对应 key 的隐式 ON 关联字段的数据库 + for (On on : onList) { + column.add(on.getKey()); // TODO PostgreSQL 等需要找到具体的 targetTable 对应 targetKey 来加到 SELECT，比直接 SELECT * 性能更好 + } + } - cacheConfig.setMethod(GET); //子查询不能为 SELECT count(*) ，而应该是 SELECT momentId - cacheConfig.setColumn(Arrays.asList(j.getKey())); //优化性能，不取非必要的字段 + joinConfig.setMethod(GET); // 子查询不能为 SELECT count(*) ，而应该是 SELECT momentId + joinConfig.setColumn(column); // 优化性能，不取非必要的字段 + + if (cacheConfig != null) { + cacheConfig.setMethod(GET); // 子查询不能为 SELECT count(*) ，而应该是 SELECT momentId + cacheConfig.setColumn(column); // 优化性能，不取非必要的字段 + } } - j.setJoinConfig(joinConfig); - j.setCacheConfig(cacheConfig); + join.setJoinConfig(joinConfig); + join.setCacheConfig(cacheConfig); } config.setJoinList(joinList); @@ -3032,9 +6396,9 @@ LEFT JOIN ( SELECT count(*) AS count FROM sys.Comment ) AS Comment ON Comment.m * @param saveLogic 保留逻辑运算符 & | ! * @return */ - public static String getRealKey(RequestMethod method, String originKey + public static String gainRealKey(RequestMethod method, String originKey , boolean isTableKey, boolean saveLogic) throws Exception { - return getRealKey(method, originKey, isTableKey, saveLogic, true); + return gainRealKey(method, originKey, isTableKey, saveLogic, true); } /**获取客户端实际需要的key * @param method @@ -3044,17 +6408,39 @@ public static String getRealKey(RequestMethod method, String originKey * @param verifyName 验证key名是否符合代码变量/常量名 * @return */ - public static String getRealKey(RequestMethod method, String originKey + public static String gainRealKey(RequestMethod method, String originKey , boolean isTableKey, boolean saveLogic, boolean verifyName) throws Exception { Log.i(TAG, "getRealKey saveLogic = " + saveLogic + "; originKey = " + originKey); - if (originKey == null || apijson.JSONObject.isArrayKey(originKey)) { - Log.w(TAG, "getRealKey originKey == null || apijson.JSONObject.isArrayKey(originKey) >> return originKey;"); + if (originKey == null || JSONMap.isArrayKey(originKey)) { + Log.w(TAG, "getRealKey originKey == null || apijson.JSONMap.isArrayKey(originKey) >> return originKey;"); return originKey; } - String key = new String(originKey); + String key = originKey; if (key.endsWith("$")) {//搜索 LIKE，查询时处理 - key = key.substring(0, key.length() - 1); + String k = key.substring(0, key.length() - 1); + // key%$:"a" -> key LIKE '%a%'; key?%$:"a" -> key LIKE 'a%'; key_?$:"a" -> key LIKE '_a'; key_%$:"a" -> key LIKE '_a%' + char c = k.isEmpty() ? 0 : k.charAt(k.length() - 1); + + if (c == '%' || c == '_' || c == '?') { + k = k.substring(0, k.length() - 1); + + char c2 = k.isEmpty() ? 0 : k.charAt(k.length() - 1); + if (c2 == '%' || c2 == '_' || c2 == '?') { + if (c2 == c) { + throw new IllegalArgumentException(originKey + ":value 中字符 " + + k + " 不合法！key$:value 中不允许 key 中有连续相同的占位符！"); + } + + k = k.substring(0, k.length() - 1); + } + else if (c == '?') { + throw new IllegalArgumentException(originKey + ":value 中字符 " + originKey + + " 不合法！key$:value 中不允许只有单独的 '?'，必须和 '%', '_' 之一配合使用 ！"); + } + } + + key = k; } else if (key.endsWith("~")) {//匹配正则表达式 REGEXP，查询时处理 key = key.substring(0, key.length() - 1); @@ -3067,16 +6453,16 @@ else if (key.endsWith("%")) {//数字、文本、日期范围 BETWEEN AND } else if (key.endsWith("{}")) {//被包含 IN，或者说key对应值处于value的范围内。查询时处理 key = key.substring(0, key.length() - 2); - } + } else if (key.endsWith("}{")) {//被包含 EXISTS，或者说key对应值处于value的范围内。查询时处理 key = key.substring(0, key.length() - 2); - } + } else if (key.endsWith("<>")) {//包含 json_contains，或者说value处于key对应值的范围内。查询时处理 key = key.substring(0, key.length() - 2); - } + } else if (key.endsWith("()")) {//方法，查询完后处理，先用一个Map保存 key = key.substring(0, key.length() - 2); - } + } else if (key.endsWith("@")) {//引用，引用对象查询完后处理。fillTarget中暂时不用处理，因为非GET请求都是由给定的id确定，不需要引用 key = key.substring(0, key.length() - 1); } @@ -3096,35 +6482,44 @@ else if (key.endsWith("+")) {//延长，PUT查询时处理 if (method == PUT) {//不为PUT就抛异常 key = key.substring(0, key.length() - 1); } - } + } else if (key.endsWith("-")) {//缩减，PUT查询时处理 if (method == PUT) {//不为PUT就抛异常 key = key.substring(0, key.length() - 1); } } - String last = null;//不用Logic优化代码，否则 key 可能变为 key| 导致 key=value 变成 key|=value 而出错 - if (RequestMethod.isQueryMethod(method)) {//逻辑运算符仅供GET,HEAD方法使用 - last = key.isEmpty() ? "" : key.substring(key.length() - 1); - if ("&".equals(last) || "|".equals(last) || "!".equals(last)) { - key = key.substring(0, key.length() - 1); - } else { - last = null;//避免key + StringUtil.getString(last)错误延长 - } + // TODO if (key.endsWith("-")) { // 表示 key 和 value 顺序反过来: value LIKE key ? + + // 不用Logic优化代码，否则 key 可能变为 key| 导致 key=value 变成 key|=value 而出错 + String last = key.isEmpty() ? "" : key.substring(key.length() - 1); + if ("&".equals(last) || "|".equals(last) || "!".equals(last)) { + key = key.substring(0, key.length() - 1); + } else { + last = null; // 避免key + StringUtil.getString(last) 错误延长 } - //"User:toUser":User转换"toUser":User, User为查询同名Table得到的JSONObject。交给客户端处理更好 - if (isTableKey) {//不允许在column key中使用Type:key形式 - key = Pair.parseEntry(key, true).getKey();//table以左边为准 + String len = ""; + if (key.endsWith("[") || key.endsWith("{")) { + len = key.substring(key.length() - 1); + key = key.substring(0, key.length() - 1); + } + + // "User:toUser":User转换"toUser":User, User为查询同名Table得到的JSONObject。交给客户端处理更好 + if (isTableKey) { // 不允许在column key中使用Type:key形式 + key = Pair.parseEntry(key, true).getKey(); // table以左边为准 } else { - key = Pair.parseEntry(key).getValue();//column以右边为准 + key = Pair.parseEntry(key).getValue();// column 以右边为准 } if (verifyName && StringUtil.isName(key.startsWith("@") ? key.substring(1) : key) == false) { throw new IllegalArgumentException(method + "请求，字符 " + originKey + " 不合法！" - + " key:value 中的key只能关键词 '@key' 或 'key[逻辑符][条件符]' 或 PUT请求下的 'key+' / 'key-' ！"); + + " key:value 中的 key 只能关键词 '@key' 或 'key[长度符][逻辑符][条件符]' 或 PUT 请求下的 'key+' / 'key-' ！" + + "长度符 只能为 [ - length 和 { - json_length，逻辑符 只能是 & - 与、| - 或、! - 非 ！"); } + key += len; + if (saveLogic && last != null) { key = key + last; } @@ -3133,7 +6528,7 @@ else if (key.endsWith("-")) {//缩减，PUT查询时处理 } - public static interface IdCallback { + public static interface IdCallback { /**为 post 请求新建 id， 只能是 Long 或 String * @param method * @param database @@ -3141,7 +6536,8 @@ public static interface IdCallback { * @param table * @return */ - Object newId(RequestMethod method, String database, String schema, String table); + T newId(RequestMethod method, String database, String schema, String datasource, String table); + /**获取主键名 * @param database @@ -3149,7 +6545,7 @@ public static interface IdCallback { * @param table * @return */ - String getIdKey(String database, String schema, String table); + String getIdKey(String database, String schema, String datasource, String table); /**获取 User 的主键名 * @param database @@ -3157,50 +6553,88 @@ public static interface IdCallback { * @param table * @return */ - String getUserIdKey(String database, String schema, String table); + String getUserIdKey(String database, String schema, String datasource, String table); } - public static interface Callback extends IdCallback { - /**获取 SQLConfig 的实例 + public static interface Callback, L extends List> extends IdCallback { + /**获取 SQLConfig 的实例 * @param method * @param database * @param schema * @param table * @return */ - SQLConfig getSQLConfig(RequestMethod method, String database, String schema, String table); + SQLConfig getSQLConfig(RequestMethod method, String database, String schema, String datasource, String table); /**combine 里的 key 在 request 中 value 为 null 或不存在，即 request 中缺少用来作为 combine 条件的 key: value * @param combine * @param key * @param request */ - public void onMissingKey4Combine(String name, JSONObject request, String combine, String item, String key) throws Exception; + void onMissingKey4Combine(String name, M request, String combine, String item, String key) throws Exception; } - public static abstract class SimpleCallback implements Callback { + public static Long LAST_ID; + static { + LAST_ID = System.currentTimeMillis(); + } + public static abstract class SimpleCallback, L extends List> implements Callback { + @SuppressWarnings("unchecked") @Override - public Object newId(RequestMethod method, String database, String schema, String table) { - return System.currentTimeMillis(); + public T newId(RequestMethod method, String database, String schema, String datasource, String table) { + Long id = System.currentTimeMillis(); + if (id <= LAST_ID) { + id = LAST_ID + 1; // 解决高并发下 id 冲突导致新增记录失败 + } + LAST_ID = id; + + return (T) id; } @Override - public String getIdKey(String database, String schema, String table) { + public String getIdKey(String database, String schema, String datasource, String table) { return KEY_ID; } @Override - public String getUserIdKey(String database, String schema, String table) { + public String getUserIdKey(String database, String schema, String datasource, String table) { return KEY_USER_ID; } @Override - public void onMissingKey4Combine(String name, JSONObject request, String combine, String item, String key) throws Exception { - throw new IllegalArgumentException(name + ":{} 里的 @combine:value 中的value里 " + item + " 对应的条件 " + key + ":value 中 value 不能为 null！"); + public void onMissingKey4Combine(String name, M request, String combine, String item, String key) throws Exception { + if (ALLOW_MISSING_KEY_4_COMBINE) { + return; + } + throw new IllegalArgumentException(name + ":{} 里的 @combine:value 中的value里 " + + item + " 对应的条件 " + key + ":value 中 value 必须存在且不能为 null！"); + } + + } + + private static boolean isKeyInCombineExpr(String combineExpr, String key) { + while (combineExpr.isEmpty() == false) { + int index = combineExpr.indexOf(key); + if (index < 0) { + return false; + } + + char left = index <= 0 ? ' ' : combineExpr.charAt(index - 1); + char right = index >= combineExpr.length() - key.length() ? ' ' : combineExpr.charAt(index + key.length()); + if ((left == ' ' || left == '(' || left == '&' || left == '|' || left == '!') && (right == ' ' || right == ')' || right == ':')) { + return true; + } + int newIndex = index + key.length() + 1; + if (combineExpr.length() <= newIndex) { + break; + } + combineExpr = combineExpr.substring(newIndex); } + return false; } + } diff --git a/APIJSONORM/src/main/java/apijson/orm/AbstractSQLExecutor.java b/APIJSONORM/src/main/java/apijson/orm/AbstractSQLExecutor.java index ccfe38f8c..797ac3dee 100755 --- a/APIJSONORM/src/main/java/apijson/orm/AbstractSQLExecutor.java +++ b/APIJSONORM/src/main/java/apijson/orm/AbstractSQLExecutor.java @@ -1,57 +1,53 @@ -/*Copyright (C) 2020 THL A29 Limited, a Tencent company. All rights reserved. +/*Copyright (C) 2020 Tencent. All rights reserved. This source code is licensed under the Apache License Version 2.0.*/ package apijson.orm; +import apijson.*; +import apijson.orm.Join.On; +import apijson.orm.exception.NotExistException; + import java.io.BufferedReader; -import java.sql.Blob; -import java.sql.Clob; -import java.sql.Connection; -import java.sql.Date; -import java.sql.DriverManager; -import java.sql.PreparedStatement; -import java.sql.ResultSet; -import java.sql.ResultSetMetaData; -import java.sql.SQLException; -import java.sql.Savepoint; -import java.sql.Statement; -import java.sql.Time; -import java.sql.Timestamp; -import java.util.ArrayList; -import java.util.Collection; -import java.util.HashMap; -import java.util.List; -import java.util.Map; +import java.math.BigDecimal; +import java.math.BigInteger; +import java.sql.*; +import java.time.DayOfWeek; +import java.time.LocalDateTime; +import java.time.Month; +import java.time.Year; +import java.util.Date; +import java.util.*; import java.util.Map.Entry; -import java.util.Set; - -import com.alibaba.fastjson.JSON; -import com.alibaba.fastjson.JSONObject; - -import apijson.JSONResponse; -import apijson.Log; -import apijson.NotNull; -import apijson.RequestMethod; -import apijson.StringUtil; +import java.util.regex.Pattern; /**executor for query(read) or update(write) MySQL database * @author Lemon */ -public abstract class AbstractSQLExecutor implements SQLExecutor { +public abstract class AbstractSQLExecutor, L extends List> + implements SQLExecutor { private static final String TAG = "AbstractSQLExecutor"; + //是否返回 值为null的字段 + public static boolean ENABLE_OUTPUT_NULL_COLUMN = false; + public static String KEY_RAW_LIST = "@RAW@LIST"; // 避免和字段命名冲突，不用 $RAW@LIST$ 是因为 $ 会在 fastjson 内部转义，浪费性能 + public static String KEY_VICE_ITEM = "@VICE@ITEM"; // 避免和字段命名冲突，不用 $VICE@LIST$ 是因为 $ 会在 fastjson 内部转义，浪费性能 - - private int generatedSQLCount; - private int cachedSQLCount; - private int executedSQLCount; - public AbstractSQLExecutor() { - generatedSQLCount = 0; - cachedSQLCount = 0; - executedSQLCount = 0; + private Parser parser; + @Override + public Parser getParser() { + return parser; + } + @Override + public AbstractSQLExecutor setParser(Parser parser) { + this.parser = parser; + return this; } + private int generatedSQLCount = 0; + private int cachedSQLCount = 0; + private int executedSQLCount = 0; + @Override public int getGeneratedSQLCount() { return generatedSQLCount; @@ -65,80 +61,101 @@ public int getExecutedSQLCount() { return executedSQLCount; } + private long executedSQLDuration = 0; + private long sqlResultDuration = 0; + @Override + public long getExecutedSQLDuration() { + return executedSQLDuration; + } + + @Override + public long getSqlResultDuration() { + return sqlResultDuration; + } + + /** - * 缓存map + * 缓存 Map */ - protected Map> cacheMap = new HashMap<>(); - + protected Map> cacheMap = new HashMap<>(); /**保存缓存 - * @param sql - * @param list - * @param isStatic + * @param sql key + * @param list value + * @param config 一般主表 SQLConfig 不为 null，JOIN 副表的为 null */ @Override - public synchronized void putCache(String sql, List list, int type) { - if (sql == null || list == null) { //空map有效，说明查询过sql了 || list.isEmpty()) { + public void putCache(String sql, List list, SQLConfig config) { + if (sql == null || list == null) { // 空 list 有效，说明查询过 sql 了 || list.isEmpty()) { Log.i(TAG, "saveList sql == null || list == null >> return;"); return; } + cacheMap.put(sql, list); } - /**移除缓存 - * @param sql - * @param isStatic - */ - @Override - public synchronized void removeCache(String sql, int type) { - if (sql == null) { - Log.i(TAG, "removeList sql == null >> return;"); - return; - } - cacheMap.remove(sql); - } + /**获取缓存 + * @param sql key + * @param config 一般主表 SQLConfig 不为 null，JOIN 副表的为 null + */ @Override - public List getCache(String sql, int type) { + public List getCache(String sql, SQLConfig config) { return cacheMap.get(sql); } /**获取缓存 - * @param sql + * @param sql key * @param position - * @param type + * @param config 一般主表 SQLConfig 不为 null，JOIN 副表的为 null * @return */ @Override - public JSONObject getCacheItem(String sql, int position, int type) { - List list = getCache(sql, type); - //只要map不为null，则如果 list.get(position) == null，则返回 {} ，避免再次SQL查询 + public M getCacheItem(String sql, int position, SQLConfig config) { + List list = getCache(sql, config); + return getCacheItem(list, position, config); + } + + public M getCacheItem(List list, int position, SQLConfig config) { + // 只要 list 不为 null，则如果 list.get(position) == null，则返回 {} ，避免再次 SQL 查询 if (list == null) { return null; - } - JSONObject result = position >= list.size() ? null : list.get(position); - return result != null ? result : new JSONObject(); + } + + M result = position >= list.size() ? null : list.get(position); + return result != null ? result : JSON.createJSONObject(); } + /**移除缓存 + * @param sql key + * @param config + */ @Override - public ResultSet executeQuery(@NotNull Statement statement, String sql) throws Exception { - executedSQLCount ++; + public void removeCache(String sql, SQLConfig config) { + if (sql == null) { + Log.i(TAG, "removeList sql == null >> return;"); + return; + } + cacheMap.remove(sql); + } - return statement.executeQuery(sql); + + @Override + public ResultSet executeQuery(@NotNull Statement statement, String sql) throws Exception { + ResultSet rs = statement.executeQuery(sql); + return rs; } @Override public int executeUpdate(@NotNull Statement statement, String sql) throws Exception { - executedSQLCount ++; - - return statement.executeUpdate(sql); + int c = statement.executeUpdate(sql); + return c; } @Override public ResultSet execute(@NotNull Statement statement, String sql) throws Exception { - executedSQLCount ++; - statement.execute(sql); - return statement.getResultSet(); + ResultSet rs = statement.getResultSet(); + return rs; } /**执行SQL @@ -147,195 +164,582 @@ public ResultSet execute(@NotNull Statement statement, String sql) throws Except * @throws Exception */ @Override - public JSONObject execute(@NotNull SQLConfig config, boolean unknowType) throws Exception { - boolean prepared = config.isPrepared(); - - final String sql = config.getSQL(false); - - config.setPrepared(prepared); + public M execute(@NotNull SQLConfig config, boolean unknownType) throws Exception { + long executedSQLStartTime = System.currentTimeMillis(); + final String sql = config.gainSQL(false); if (StringUtil.isEmpty(sql, true)) { - Log.e(TAG, "select StringUtil.isEmpty(sql, true) >> return null;"); + Log.e(TAG, "execute StringUtil.isEmpty(sql, true) >> return null;"); return null; } + Parser parser2 = config.gainParser(); + parser = parser2 != null ? parser2 : getParser();; + + boolean isExplain = config.isExplain(); + boolean isHead = RequestMethod.isHeadMethod(config.getMethod(), true); + final int position = config.getPosition(); - JSONObject result; + M result; - if (config.isExplain() == false) { + if (isExplain == false) { generatedSQLCount ++; } long startTime = System.currentTimeMillis(); Log.d(TAG, "\n<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<" + "\n已生成 " + generatedSQLCount + " 条 SQL" - + "\nselect startTime = " + startTime - + "\ndatabase = " + StringUtil.getString(config.getDatabase()) - + "; schema = " + StringUtil.getString(config.getSchema()) + + "\nexecute startTime = " + startTime + + "\ndatabase = " + StringUtil.get(config.getDatabase()) + + "; schema = " + StringUtil.get(config.getSchema()) + "; sql = \n" + sql + "\n>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n"); ResultSet rs = null; + List resultList = null; + Map childMap = null; + Map keyMap = null; - if (unknowType) { - Statement statement = getStatement(config); - rs = execute(statement, sql); + try { + if (unknownType) { + if (isExplain == false) { //只有 SELECT 才能 EXPLAIN + executedSQLCount ++; + executedSQLStartTime = System.currentTimeMillis(); + } + Statement statement = getStatement(config); + rs = execute(statement, sql); + int updateCount = statement.getUpdateCount(); + if (isExplain == false) { + executedSQLDuration += System.currentTimeMillis() - executedSQLStartTime; + } - result = new JSONObject(true); - int updateCount = statement.getUpdateCount(); - result.put(JSONResponse.KEY_COUNT, updateCount); - result.put("update", updateCount >= 0); - //导致后面 rs.getMetaData() 报错 Operation not allowed after ResultSet closed result.put("moreResults", statement.getMoreResults()); - } - else { - switch (config.getMethod()) { - case HEAD: - case HEADS: - rs = executeQuery(config); + result = JSON.createJSONObject(); + result.put(JSONResponse.KEY_COUNT, updateCount); + result.put("update", updateCount >= 0); + //导致后面 rs.getMetaData() 报错 Operation not allowed after ResultSet closed result.put("moreResults", statement.getMoreResults()); + } + else { + RequestMethod method = config.getMethod(); + switch (method) { + case POST: + case PUT: + case DELETE: + if (isExplain == false) { //只有 SELECT 才能 EXPLAIN + executedSQLCount ++; + executedSQLStartTime = System.currentTimeMillis(); + } + int updateCount = executeUpdate(config); + if (isExplain == false) { + executedSQLDuration += System.currentTimeMillis() - executedSQLStartTime; + } - executedSQLCount ++; + if (updateCount <= 0) { + throw new IllegalAccessException("没权限访问或对象不存在！"); // NotExistException 会被 catch 转为成功状态 + } - result = rs.next() ? AbstractParser.newSuccessResult() - : AbstractParser.newErrorResult(new SQLException("数据库错误, rs.next() 失败！")); - result.put(JSONResponse.KEY_COUNT, rs.getLong(1)); + // updateCount>0时收集结果。例如更新操作成功时，返回count(affected rows)、id字段 + result = parser.newSuccessResult(); // TODO 对 APIAuto 及其它现有的前端/客户端影响比较大，暂时还是返回 code 和 msg，5.0 再移除 JSON.createJSONObject(); - rs.close(); - return result; + //id,id{}至少一个会有，一定会返回，不用抛异常来阻止关联写操作时前面错误导致后面无条件执行！ + result.put(JSONResponse.KEY_COUNT, updateCount);//返回修改的记录数 - case POST: - case PUT: - case DELETE: - executedSQLCount ++; + String idKey = config.getIdKey(); + if (config.getId() != null) { + result.put(idKey, config.getId()); + } + if (config.getIdIn() != null) { + result.put(idKey + "[]", config.getIdIn()); + } - int updateCount = executeUpdate(config); + if (method == RequestMethod.PUT || method == RequestMethod.DELETE) { + config.setMethod(RequestMethod.GET); + removeCache(config.gainSQL(false), config); + config.setMethod(method); + } - result = AbstractParser.newResult(updateCount > 0 ? JSONResponse.CODE_SUCCESS : JSONResponse.CODE_NOT_FOUND - , updateCount > 0 ? JSONResponse.MSG_SUCCEED : "没权限访问或对象不存在！"); + return result; - //id,id{}至少一个会有，一定会返回，不用抛异常来阻止关联写操作时前面错误导致后面无条件执行！ - result.put(JSONResponse.KEY_COUNT, updateCount);//返回修改的记录数 - if (config.getId() != null) { - result.put(config.getIdKey(), config.getId()); - } else { - result.put(config.getIdKey() + "[]", config.getWhere(config.getIdKey() + "{}", true)); - } - return result; + case GET: + case GETS: + case HEAD: + case HEADS: + List cache = getCache(sql, config); + result = getCacheItem(cache, position, config); + Log.i(TAG, ">>> execute result = getCache('" + sql + "', " + position + ") = " + result); + if (result != null) { + if (isExplain == false) { + cachedSQLCount ++; + } - case GET: - case GETS: - result = getCacheItem(sql, position, config.getCache()); - Log.i(TAG, ">>> select result = getCache('" + sql + "', " + position + ") = " + result); - if (result != null) { - cachedSQLCount ++; + if (cache != null && cache.size() > 1) { + result.put(KEY_RAW_LIST, cache); + } + Log.d(TAG, "\n\n execute result != null >> return result;" + "\n>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n\n"); + return result; + } - Log.d(TAG, "\n\n select result != null >> return result;" + "\n>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n\n"); - return result; - } + if (isExplain == false) { //只有 SELECT 才能 EXPLAIN + executedSQLCount ++; + executedSQLStartTime = System.currentTimeMillis(); + } + rs = executeQuery(config); //FIXME SQL Server 是一次返回两个结果集，包括查询结果和执行计划，需要 moreResults + if (isExplain == false) { + executedSQLDuration += System.currentTimeMillis() - executedSQLStartTime; + } + break; - rs = executeQuery(config); //FIXME SQL Server 是一次返回两个结果集，包括查询结果和执行计划，需要 moreResults + default: //OPTIONS, TRACE等 + Log.e(TAG, "execute sql = " + sql + " ; method = " + config.getMethod() + " >> return null;"); + return null; + } + } - if (config.isExplain() == false) { //只有 SELECT 才能 EXPLAIN - executedSQLCount ++; + if (isExplain == false && isHead) { + if (rs.next() == false) { + return parser.newErrorResult(new SQLException("数据库错误, rs.next() 失败！")); } - break; - default://OPTIONS, TRACE等 - Log.e(TAG, "select sql = " + sql + " ; method = " + config.getMethod() + " >> return null;"); - return null; + result = parser.newSuccessResult(); + // 兼容nosql,比如 elasticSearch-sql + if(config.isElasticsearch()) { + result.put(JSONResponse.KEY_COUNT, rs.getObject(1)); + }else { + result.put(JSONResponse.KEY_COUNT, rs.getLong(1)); + } + resultList = new ArrayList<>(1); + resultList.add(result); } - } + else { + // final boolean cache = config.getCount() != 1; + // Log.d(TAG, "select cache = " + cache + "; resultList" + (resultList == null ? "=" : "!=") + "null"); + try { // 设置初始容量为查到的数据量，解决频繁扩容导致的延迟，貌似只有 rs.last 取 rs.getRow() ? 然后又得 rs.beforeFirst 重置位置以便下方取值 + rs.last(); //移到最后一行 + resultList = new ArrayList<>(rs.getRow()); + rs.beforeFirst(); + } + catch (Throwable e) { + Log.e(TAG, "try { rs.last(); resultList = new ArrayList<>(rs.getRow()); rs.beforeFirst(); >> } catch (Throwable e) = " + e.getMessage()); + int capacity; + if (config.getId() != null) { // id:Object 一定是 AND 条件，最终返回数据最多就这么多 + capacity = 1; + } + else { + Object idIn = config.getIdIn(); + if (idIn instanceof Collection) { // id{}:[] 一定是 AND 条件，最终返回数据最多就这么多 + capacity = ((Collection) idIn).size(); + } + else { // 预估容量 + capacity = config.getCount() <= 0 ? AbstractParser.MAX_QUERY_COUNT : config.getCount(); + if (capacity > 100) { + // 有 WHERE 条件，条件越多过滤数据越多，暂时不考虑 @combine:"a | (b & !c)" 里面 | OR 和 ! NOT 条件，太复杂也不是很必要 + Map> combine = config.getCombineMap(); + + List andList = combine == null ? null : combine.get("&"); + int andCondCount = andList == null ? (config.getWhere() == null ? 0 : config.getWhere().size()) : andList.size(); + + List orList = combine == null ? null : combine.get("|"); + int orCondCount = orList == null ? 0 : orList.size(); + + List notList = combine == null ? null : combine.get("!"); + int notCondCount = notList == null ? 0 : notList.size(); + + // 有 GROUP BY 分组，字段越少过滤数据越多 + String[] group = StringUtil.split(config.getGroup()); + int groupCount = group == null ? 0 : group.length; + if (groupCount > 0 && Arrays.asList(group).contains(config.getIdKey())) { + groupCount = 0; + } + + // 有 HAVING 聚合函数，字段越多过滤数据越多，暂时不考虑 @combine:"a | (b & !c)" 里面 | OR 和 ! NOT 条件，太复杂也不是很必要 + Map having = config.getHaving(); + int havingCount = having == null ? 0 : having.size(); + + capacity /= Math.pow(1.5, Math.log10(capacity) + + andCondCount + + ((orCondCount <= 0 ? 0 : 2.0d/orCondCount) // 1: 2.3, 2: 1.5, 3: 1.3, 4: 1.23, 5: 1.18 + + (notCondCount/5.0d) // 1: 1.08, 2: 1.18, 3: 1.28, 4: 1.38, 1.50 + + (groupCount <= 0 ? 0 : 10.0d/groupCount)) // 1: 57.7, 7.6, 3: 3.9, 4: 2.8, 5: 2.3 + + havingCount + ); + capacity += 1; // 避免正好比需要容量少一点点导致多一次扩容，大量数据 System.arrayCopy + } + } + } + + resultList = new ArrayList<>(capacity); + } + + int index = -1; + long startTime2 = System.currentTimeMillis(); + ResultSetMetaData rsmd = rs.getMetaData(); + final int length = rsmd.getColumnCount(); + sqlResultDuration += System.currentTimeMillis() - startTime2; + // - Map childMap = new HashMap<>(); //要存到cacheMap - // WHERE id = ? AND ... 或 WHERE ... AND id = ? 强制排序 remove 再 put，还是重新 getSQL吧 +// int viceColumnStart = length + 1; //第一个副表字段的index +// FIXME 统计游标查找的时长？可能 ResultSet.next() 及 getTableName, getColumnName, getObject 比较耗时，因为不是一次加载到内存，而是边读边发 - boolean hasJoin = config.hasJoin(); - int viceColumnStart = length + 1; //第一个副表字段的index - while (rs.next()) { - index ++; - Log.d(TAG, "\n\n<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<\n select while (rs.next()){ index = " + index + "\n\n"); + long lastCursorTime = System.currentTimeMillis(); + while (rs.next()) { + sqlResultDuration += System.currentTimeMillis() - lastCursorTime; + lastCursorTime = System.currentTimeMillis(); + + index ++; + Log.d(TAG, "\n\n<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<\n execute while (rs.next()){ index = " + index + "\n\n"); - JSONObject item = new JSONObject(true); + M item = JSON.createJSONObject(); + M viceItem = null; + M curItem = item; + boolean isMain = true; + boolean reseted = false; - for (int i = 1; i <= length; i++) { + for (int i = 1; i <= length; i++) { - // if (hasJoin && viceColumnStart > length && config.getSQLTable().equalsIgnoreCase(rsmd.getTableName(i)) == false) { - // viceColumnStart = i; - // } + // if (hasJoin && viceColumnStart > length && config.getSQLTable().equalsIgnoreCase(rsmd.getTableName(i)) == false) { + // viceColumnStart = i; + // } + + // bugfix-修复非常规数据库字段，获取表名失败导致输出异常 + Join curJoin = columnIndexAndJoinMap == null ? null : columnIndexAndJoinMap[i - 1]; // columnIndexAndJoinMap.get(i); + + // 为什么 isExplain == false 不用判断？因为所有字段都在一张 Query Plan 表 + if (index <= 0 && columnIndexAndJoinMap != null) { // && viceColumnStart > length) { + + SQLConfig curConfig = curJoin == null || ! curJoin.isSQLJoin() ? null : curJoin.getCacheConfig(); + List curColumn = curConfig == null ? null : curConfig.getColumn(); + String sqlTable = curConfig == null ? null : curConfig.gainSQLTable(); + String sqlAlias = curConfig == null ? null : curConfig.getAlias(); + + List column = config.getColumn(); + int mainColumnSize = column == null ? 0 : column.size(); + boolean toFindJoin = mainColumnSize <= 0 || i > mainColumnSize; // 主表就不用找 JOIN 配置 + + if (StringUtil.isEmpty(sqlTable, true)) { + //sqlTable = null; + + if (toFindJoin) { // 在主表字段数量内的都归属主表 + long startTime3 = System.currentTimeMillis(); + sqlTable = rsmd.getTableName(i); // SQL 函数甚至部分字段都不返回表名，当然如果没传 @column 生成的 Table.* 则返回的所有字段都会带表名 + + //if (StringUtil.isEmpty(sqlTable, true)) { + // boolean isEmpty = curItem == null || curItem.isEmpty(); + String key = getKey(config, rs, rsmd, index, curItem, i, childMap, keyMap); + char last = repeatMap == null ? 0 : key.charAt(key.length() - 1); + String repeatKey = last < '0' || last > '9' ? null : key.substring(0, key.length() - 1); + Integer repeatCount = repeatKey == null ? null : repeatMap.get(repeatKey); + int nc = repeatCount == null ? 1 : repeatCount + 1; + if (last == nc + '0') { + keyMap.put(key, repeatKey); + repeatMap.put(repeatKey, nc); + key = repeatKey; // QuestDB 会自动把副表与主表同名的字段重命名，例如 id 改为 id1, date 改为 date1 + } + + if (i > 1 && ( (curItem != null && curItem.containsKey(key)) + || (StringUtil.isNotEmpty(key) && StringUtil.equals(key, curConfig == null ? null : curConfig.getIdKey()))) + ) { // Presto 等引擎 JDBC 返回 rsmd.getTableName(i) 为空，主表如果一个字段都没有会导致 APISJON 主副表所有字段都不返回 + sqlTable = null; + if (reseted) { + SQLConfig lastCfg = lastJoin == null ? null : lastJoin.getCacheConfig(); + List lastColumn = lastCfg == null ? null : lastCfg.getColumn(); + + lastViceTableStart ++; + lastViceColumnStart += lastColumn == null ? 1 : lastColumn.size(); + } + else if (isMain) { + for (int j = 0; j < joinList.size(); j++) { + Join join = joinList.get(j); + SQLConfig cfg = join == null || ! join.isSQLJoin() ? null : join.getJoinConfig(); + List c = cfg == null ? null : cfg.getColumn(); + + if (cfg != null) { + sqlTable = cfg.gainSQLTable(); + sqlAlias = cfg.getAlias(); + lastViceTableStart = j; // 避免后面的空 @column 表内字段被放到之前的空 @column 表 + lastViceColumnStart = i + 1; + + curJoin = join; + curConfig = cfg; + curColumn = c; + + toFindJoin = false; + isMain = false; + break; + } + } + } + + reseted = true; + } + //} + sqlResultDuration += System.currentTimeMillis() - startTime3; + + if (toFindJoin && StringUtil.isEmpty(sqlTable, true)) { // hasJoin 已包含这个判断 && joinList != null) { + //sqlTable = null; // QuestDB 等 rsmd.getTableName(i) 返回 "" 导致以下 StringUtil.equalsIgnoreCase 对比失败 + + int nextViceColumnStart = lastViceColumnStart; // 主表没有 @column 时会偏小 lastViceColumnStart + int joinCount = joinList.size(); + for (int j = lastViceTableStart; j < joinCount; j++) { // 查找副表 @column，定位字段所在表 + Join join = joinList.get(j); + SQLConfig cfg = join == null || ! join.isSQLJoin() ? null : join.getJoinConfig(); + List c = cfg == null ? null : cfg.getColumn(); + + nextViceColumnStart += (c != null && ! c.isEmpty() ? + c.size() : ( + StringUtil.equalsIgnoreCase(sqlTable, lastTableName) + && StringUtil.equals(sqlAlias, lastAliasName) ? 1 : 0 + ) + ); + if (i < nextViceColumnStart) { // 导致只 JOIN 一张副表时主表数据放到副表 || j >= joinCount - 1) { + sqlTable = cfg.gainSQLTable(); + sqlAlias = cfg.getAlias(); + lastViceTableStart = j; // 避免后面的空 @column 表内字段被放到之前的空 @column 表 + + curJoin = join; + curConfig = cfg; + curColumn = c; + + toFindJoin = false; + isMain = false; + break; + } + } + } + + // 没有 @column，仍然定位不了，用前一个 table 名。FIXME 如果刚好某个表内第一个字段是就是 SQL 函数？ + if (StringUtil.isEmpty(sqlTable, true)) { + sqlTable = lastTableName; + sqlAlias = lastAliasName; + toFindJoin = false; + } + } + } else if (config.isClickHouse() && (sqlTable.startsWith("`") || sqlTable.startsWith("\""))){ + sqlTable = sqlTable.substring(1, sqlTable.length() - 1); + } + + if (StringUtil.equalsIgnoreCase(sqlTable, lastTableName) == false || StringUtil.equals(sqlAlias, lastAliasName) == false) { + lastTableName = sqlTable; + lastAliasName = sqlAlias; + lastViceColumnStart = i; + + if (toFindJoin) { // 找到对应的副表 JOIN 配置 + for (int j = lastViceTableStart; j < joinList.size(); j++) { // 查找副表 @column，定位字段所在表 + Join join = joinList.get(j); + SQLConfig cfg = join == null || ! join.isSQLJoin() ? null : join.getJoinConfig(); + + if (cfg != null && StringUtil.equalsIgnoreCase(sqlTable, cfg.gainSQLTable()) + ) { // FIXME 导致副表字段错放到主表 && StringUtil.equals(sqlAlias, cfg.getAlias())) { + lastViceTableStart = j; // 避免后面的空 @column 表内字段被放到之前的空 @column 表 + + curJoin = join; + curConfig = cfg; + curColumn = curConfig == null ? null : curConfig.getColumn(); + + isMain = false; + break; + } + } + } + } + + if (isMain) { + lastViceColumnStart ++; + } + else { + if (curJoin == null) { + curJoin = lastJoin; + } + else { + lastJoin = curJoin; + } + + if (curColumn == null) { + curConfig = curJoin == null || ! curJoin.isSQLJoin() ? null : curJoin.getJoinConfig(); + curColumn = curConfig == null ? null : curConfig.getColumn(); + } + + // 解决后面的表内 SQL 函数被放到之前的空 @column 表 + if (curColumn == null || curColumn.isEmpty()) { + lastViceColumnStart ++; + } + } + + columnIndexAndJoinMap[i - 1] = curJoin; + } - // bugfix-修复非常规数据库字段，获取表名失败导致输出异常 - if (config.isExplain() == false && hasJoin && viceColumnStart > length) { - List column = config.getColumn(); + // 如果是主表则直接用主表对应的 item，否则缓存副表数据到 childMap + Join prevJoin = columnIndexAndJoinMap == null || i < 2 ? null : columnIndexAndJoinMap[i - 2]; + if (curJoin != prevJoin) { // 前后字段不在同一个表对象，即便后面出现 null，也不该是主表数据，而是逻辑 bug 导致 + SQLConfig viceConfig = curJoin != null && curJoin.isSQLJoin() ? curJoin.getCacheConfig() : null; + boolean hasPK = false; + if (viceConfig != null) { //FIXME 只有和主表关联才能用 item，否则应该从 childMap 查其它副表数据 + List onList = curJoin.getOnList(); + int size = onList == null ? 0 : onList.size(); + if (size > 0) { + String idKey = viceConfig.getIdKey(); + String tblKey = config.gainTableKey(); + for (int j = size - 1; j >= 0; j--) { + On on = onList.get(j); + String ok = on == null ? null : on.getOriginKey(); + if (ok == null) { + throw new NullPointerException("服务器内部错误，List 中 Join.onList[" + j + (on == null ? "] = null！" : ".getOriginKey() = null！")); + } + + String k = ok.substring(0, ok.length() - 1); + String ttk = on.getTargetTableKey(); + + M target = StringUtil.equals(ttk, tblKey) ? item : (viceItem == null ? null : JSON.get(viceItem, ttk)); + Object v = target == null ? null : target.get(on.getTargetKey()); + hasPK = hasPK || (k.equals(idKey) && v != null); + + viceConfig.putWhere(k, v, true); + } + } + } + + if (viceConfig == null) { // StringUtil.isEmpty(viceSql, true)) { + Log.i(TAG, "execute viceConfig == null >> item = null; >> "); + curItem = null; + } + else if (curJoin.isOuterJoin() || curJoin.isAntiJoin()) { + Log.i(TAG, "execute curJoin.isOuterJoin() || curJoin.isAntiJoin() >> item = null; >> "); + curItem = null; // 肯定没有数据，缓存也无意义 + // 副表是按常规条件查询，缓存会导致其它同表同条件对象查询结果集为空 childMap.put(viceSql, JSON.createJSONObject()); // 缓存固定空数据，避免后续多余查询 + } + else { + String viceName = viceConfig.gainTableKey(); + if (viceItem == null) { + viceItem = JSON.createJSONObject(); + } + curItem = JSON.get(viceItem, viceName); + + String viceSql = hasPK ? viceConfig.gainSQL(false) : null; // TODO 在 SQLConfig 缓存 SQL，减少大量的重复生成 + M curCache = hasPK ? childMap.get(viceSql) : null; + + if (curItem == null || curItem.isEmpty()) { + // 导致前面判断重复 key 出错 curItem = curCache != null ? curCache : JSON.createJSONObject(); + curItem = JSON.createJSONObject(); + viceItem.put(viceName, curItem); + if (hasPK && curCache == null) { + childMap.put(viceSql, curItem); + } + } + else if (hasPK) { + if (curCache == null || curCache.isEmpty()) { + childMap.put(viceSql, curItem); + } + else { + curCache.putAll(curItem); + // 导致前面判断重复 key 出错 curItem = curCache; + // viceItem.put(viceName, curItem); + } + } + } + } - if (column != null && column.isEmpty() == false) { - viceColumnStart = column.size() + 1; + curItem = (M) onPutColumn(config, rs, rsmd, index, curItem, i, curJoin, childMap, keyMap); // isExplain == false && hasJoin && i >= viceColumnStart ? childMap : null); } - else if (config.getSQLTable().equalsIgnoreCase(rsmd.getTableName(i)) == false) { - viceColumnStart = i; - } - } - item = onPutColumn(config, rs, rsmd, index, item, i, config.isExplain() == false && hasJoin && i >= viceColumnStart ? childMap : null); - } + if (viceItem != null) { + item.put(KEY_VICE_ITEM, viceItem); + } - resultList = onPutTable(config, rs, rsmd, resultList, index, item); + resultList = onPutTable(config, rs, rsmd, resultList, index, item); - Log.d(TAG, "\n select while (rs.next()) { resultList.put( " + index + ", result); " - + "\n >>>>>>>>>>>>>>>>>>>>>>>>>>> \n\n"); + Log.d(TAG, "execute while (rs.next()) { resultList.put( " + index + ", result); " + "\n >>>>>>>>>>>>>>>>>>>>>>>>>>> \n\n"); + } + } + } + finally { + if (rs != null) { + try { + rs.close(); + } + catch (Exception e) { + e.printStackTrace(); + } + } } - rs.close(); + if (resultList == null) { + return null; + } - if (unknowType || config.isExplain()) { - if (config.isExplain()) { + if (unknownType || isExplain) { + if (isExplain) { if (result == null) { - result = new JSONObject(true); + result = JSON.createJSONObject(); } - boolean explain = config.isExplain(); config.setExplain(false); - result.put("sql", config.getSQL(false)); - config.setExplain(explain); - config.setPrepared(prepared); + result.put("sql", config.gainSQL(false)); + config.setExplain(isExplain); } result.put("list", resultList); + + if (unknownType == false) { + putCache(sql, Arrays.asList(result), config); + } + return result; } - // @ APP JOIN 查询副表并缓存到 childMap <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< + if (isHead == false) { + // @ APP JOIN 查询副表并缓存到 childMap <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< + Map> appJoinChildMap = new HashMap<>(); + childMap.forEach((viceSql, item) -> appJoinChildMap.put(viceSql, Arrays.asList(item))); + executeAppJoin(config, resultList, appJoinChildMap, keyMap); + + // @ APP JOIN 查询副表并缓存到 childMap >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>> + + //子查询 SELECT Moment.*, Comment.id 中的 Comment 内字段 + Set>> set = appJoinChildMap.entrySet(); + + // + for (Entry> entry : set) { + putCache(entry.getKey(), entry.getValue(), null); + } - executeAppJoin(config, resultList, childMap); + Log.i(TAG, ">>> execute putCache('" + sql + "', resultList); resultList.size() = " + resultList.size()); - // @ APP JOIN 查询副表并缓存到 childMap >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>> + // 数组主表对象额外一次返回全部，方便 Parser 缓存来提高性能 - //子查询 SELECT Moment.*, Comment.id 中的 Comment 内字段 - Set> set = childMap.entrySet(); + result = position >= resultList.size() ? JSON.createJSONObject() : resultList.get(position); + if (position == 0 && resultList.size() > 1 && result != null && result.isEmpty() == false) { + // 不是 main 不会直接执行，count=1 返回的不会超过 1 && config.isMain() && config.getCount() != 1 + Log.i(TAG, ">>> execute position == 0 && resultList.size() > 1 && result != null && result.isEmpty() == false" + + " >> result = JSON.createJSONObject(result); result.put(KEY_RAW_LIST, resultList);"); - // - for (Entry entry : set) { - List l = new ArrayList<>(); - l.add(entry.getValue()); - putCache(entry.getKey(), l, JSONRequest.CACHE_ROM); + result = (M) JSON.createJSONObject(result); + result.put(KEY_RAW_LIST, resultList); + } } - putCache(sql, resultList, config.getCache()); - Log.i(TAG, ">>> select putCache('" + sql + "', resultList); resultList.size() = " + resultList.size()); + putCache(sql, resultList, config); long endTime = System.currentTimeMillis(); - Log.d(TAG, "\n\n select endTime = " + endTime + "; duration = " + (endTime - startTime) + Log.d(TAG, "\n\n execute endTime = " + endTime + "; duration = " + (endTime - startTime) + "\n return resultList.get(" + position + ");" + "\n>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n\n"); - return position >= resultList.size() ? new JSONObject() : resultList.get(position); + return result; } @@ -343,53 +747,130 @@ else if (config.getSQLTable().equalsIgnoreCase(rsmd.getTableName(i)) == false) { * @param config * @param resultList * @param childMap - * @throws Exception + * @throws Exception */ - protected void executeAppJoin(SQLConfig config, List resultList, Map childMap) throws Exception { - List joinList = config.getJoinList(); + protected void executeAppJoin(SQLConfig config, List resultList, Map> childMap, Map keyMap) throws Exception { + List> joinList = config.getJoinList(); if (joinList != null) { - SQLConfig jc; - SQLConfig cc; - - for (Join j : joinList) { - if (j.isAppJoin() == false) { + for (Join join : joinList) { + if (join.isAppJoin() == false) { Log.i(TAG, "executeAppJoin for (Join j : joinList) >> j.isAppJoin() == false >> continue;"); continue; } - jc = j.getJoinConfig(); - cc = j.getCacheConfig(); //这里用config改了getSQL后再还原很麻烦，所以提前给一个config2更好 + SQLConfig cc = join.getCacheConfig(); //这里用config改了getSQL后再还原很麻烦，所以提前给一个config2更好 + if (cc == null) { + if (Log.DEBUG) { + throw new NullPointerException("服务器内部错误, executeAppJoin cc == null ! 导致不能缓存 @ APP JOIN 的副表数据！"); + } + continue; + } + + SQLConfig jc = join.getJoinConfig(); + + List onList = join.getOnList(); + On on = onList == null || onList.isEmpty() ? null : onList.get(0); // APP JOIN 应该有且只有一个 ON 条件 + String originKey = on == null ? null : on.getOriginKey(); + if (originKey == null) { + throw new NullPointerException("服务器内部错误，List 中 Join.onList[0" + (on == null ? "] = null！" : ".getOriginKey() = null！")); + } + String key = on.getKey(); + if (key == null) { + throw new NullPointerException("服务器内部错误，List 中 Join.onList[0" + (on == null ? "] = null！" : ".getKey() = null！")); + } - //取出 "id@": "@/User/userId" 中所有 userId 的值 + // 取出 "id@": "@/User/userId" 中所有 userId 的值 List targetValueList = new ArrayList<>(); - JSONObject mainTable; - Object targetValue; for (int i = 0; i < resultList.size(); i++) { - mainTable = resultList.get(i); - targetValue = mainTable == null ? null : mainTable.get(j.getTargetKey()); + M mainTable = resultList.get(i); + Object targetValue = mainTable == null ? null : mainTable.get(on.getTargetKey()); if (targetValue != null && targetValueList.contains(targetValue) == false) { targetValueList.add(targetValue); } } + if (targetValueList.isEmpty() && config.isExplain() == false) { + throw new NotExistException("targetValueList.isEmpty() && config.isExplain() == false"); + } - //替换为 "id{}": [userId1, userId2, userId3...] - jc.putWhere(j.getOriginKey(), null, false); - jc.putWhere(j.getKey() + "{}", targetValueList, false); - - jc.setMain(true).setPreparedValueList(new ArrayList<>()); + // 替换为 "id{}": [userId1, userId2, userId3...] + jc.putWhere(originKey, null, false); // remove originKey + jc.putWhere(key + "{}", targetValueList, true); // add originKey{} } + + jc.setMain(true).setPreparedValueList(new ArrayList<>()); + + // 放一块逻辑更清晰，也避免解析 * 等不支持或性能开销 + // String q = jc.getQuote(); + // if (allChildCount > 0 && jc.getCount() <= 0) { + // List column = jc.getColumn(); + // if (column == null || column.isEmpty()) { + // column = Arrays.asList("*;row_number()OVER(PARTITION BY " + q + key + q + " ORDER BY " + q + key + q + " ASC):_row_num_"); + // } + // else { + // column.add("row_number()OVER(PARTITION BY " + q + key + q + " ORDER BY " + q + key + q + " ASC):_row_num_"); + // } + // jc.setColumn(column); + // } + + int childCount = cc.getCount(); + int allChildCount = childCount*config.getCount(); // 所有分组子项数量总和 + boolean isOne2Many = childCount != 1 || join.isOne2Many(); + // 一对多会漏副表数据 TODO 似乎一对一走以下优化 row_number() <= childCount 逻辑也没问题 + // if (isOne2Many == false && allChildCount > 0 && jc.getCount() < allChildCount) { + // jc.setCount(allChildCount); + // } boolean prepared = jc.isPrepared(); - final String sql = jc.getSQL(false); - jc.setPrepared(prepared); + String sql = jc.gainSQL(false); if (StringUtil.isEmpty(sql, true)) { throw new NullPointerException(TAG + ".executeAppJoin StringUtil.isEmpty(sql, true) >> return null;"); } + String sql2 = null; + if (childCount > 0 && isOne2Many && (jc.isMySQL() == false || jc.gainDBVersionNums()[0] >= 8)) { + // 加 row_number 字段并不会导致 count 等聚合函数统计出错，结果偏大，SQL JOIN 才会，之前没发现是因为缓存失效 bug + // boolean noAggrFun = true; + // List column = jc.getColumn(); + // if (column != null) { + // for (String c : column) { + // int start = c == null ? -1 : c.indexOf("("); + // int end = start <= 0 ? -1 : c.lastIndexOf(")"); + // if (start > 0 && end > start) { + // String fun = c.substring(0, start); + // if (AbstractSQLConfig.SQL_AGGREGATE_FUNCTION_MAP.containsKey(fun)) { + // noAggrFun = false; + // break; + // } + // } + // } + // } + // + // if (noAggrFun) { // 加 row_number 字段会导致 count 等聚合函数统计出错，结果偏大？ + String q = jc.getQuote(); + sql2 = prepared && jc.isTDengine() == false ? jc.gainSQL(true) : sql; + + String prefix = "SELECT * FROM("; + String rnStr = ", row_number() OVER (PARTITION BY " + q + key + q + ((AbstractSQLConfig) jc).gainOrderString(true) + ") _row_num_ FROM "; + String suffix = ") _t WHERE ( (_row_num_ <= " + childCount + ") )" + (allChildCount > 0 ? " LIMIT " + allChildCount : ""); + + sql2 = prefix + // 放一块逻辑更清晰，也避免解析 * 等不支持或性能开销 + sql + + sql2.replaceFirst(" FROM ", rnStr) // * 居然只能放在 row_number() 前面，放后面就报错 "SELECT ", rnStr) + + suffix; + + sql = prepared ? (prefix + sql.replaceFirst(" FROM ", rnStr) + suffix) : sql2; + // } + } + + boolean isExplain = jc.isExplain(); + if (isExplain == false) { + generatedSQLCount ++; + } + long startTime = System.currentTimeMillis(); Log.d(TAG, "\n<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<" + "\n executeAppJoin startTime = " + startTime @@ -397,41 +878,79 @@ protected void executeAppJoin(SQLConfig config, List resultList, Map + "\n>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>\n"); //执行副表的批量查询 并 缓存到 childMap - ResultSet rs = executeQuery(jc); + ResultSet rs = null; + try { + long executedSQLStartTime = 0; + if (isExplain == false) { //只有 SELECT 才能 EXPLAIN + executedSQLCount ++; + executedSQLStartTime = System.currentTimeMillis(); + } + rs = executeQuery(jc, sql2); + if (isExplain == false) { + executedSQLDuration += System.currentTimeMillis() - executedSQLStartTime; + } - int index = -1; + int count = 0; - ResultSetMetaData rsmd = rs.getMetaData(); - final int length = rsmd.getColumnCount(); + int index = -1; - JSONObject result; - String cacheSql; - while (rs.next()) { //FIXME 同时有 @ APP JOIN 和 < 等 SQL JOIN 时，next = false 总是无法进入循环，导致缓存失效，可能是连接池或线程问题 - index ++; - Log.d(TAG, "\n\n<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<\n executeAppJoin while (rs.next()){ index = " + index + "\n\n"); + long startTime2 = System.currentTimeMillis(); + ResultSetMetaData rsmd = rs.getMetaData(); + final int length = rsmd.getColumnCount(); + sqlResultDuration += System.currentTimeMillis() - startTime2; - result = new JSONObject(true); + Map skipMap = new HashMap<>(); - for (int i = 1; i <= length; i++) { + long lastCursorTime = System.currentTimeMillis(); + while ((allChildCount <= 0 || count < allChildCount) && rs.next()) { //FIXME 同时有 @ APP JOIN 和 < 等 SQL JOIN 时，next = false 总是无法进入循环，导致缓存失效，可能是连接池或线程问题 + sqlResultDuration += System.currentTimeMillis() - lastCursorTime; + lastCursorTime = System.currentTimeMillis(); - result = onPutColumn(jc, rs, rsmd, index, result, i, null); - } + index ++; + Log.d(TAG, "\n\n<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<\n executeAppJoin while (rs.next()){ index = " + index + "\n\n"); - //每个 result 都要用新的 SQL 来存 childResultMap = onPutTable(config, rs, rsmd, childResultMap, index, result); + M result = JSON.createJSONObject(); - Log.d(TAG, "\n executeAppJoin while (rs.next()) { resultList.put( " + index + ", result); " - + "\n >>>>>>>>>>>>>>>>>>>>>>>>>>> \n\n"); + for (int i = 1; i <= length; i++) { + result = onPutColumn(jc, rs, rsmd, index, result, i, null, null, keyMap); + } - //缓存到 childMap - cc.putWhere(j.getKey(), result.get(j.getKey()), false); - cacheSql = cc.getSQL(false); - childMap.put(cacheSql, result); + //每个 result 都要用新的 SQL 来存 childResultMap = onPutTable(config, rs, rsmd, childResultMap, index, result); - Log.d(TAG, ">>> executeAppJoin childMap.put('" + cacheSql + "', result); childMap.size() = " + childMap.size()); - } + Log.d(TAG, "\n executeAppJoin while (rs.next()) { resultList.put(" + index + ", result); " + + "\n >>>>>>>>>>>>>>>>>>>>>>>>>>> \n\n"); - rs.close(); + //TODO 兼容复杂关联 + cc.putWhere(key, result.get(key), true); // APP JOIN 应该有且只有一个 ON 条件 + String cacheSql = cc.gainSQL(false); + List results = childMap.get(cacheSql); + if (results == null || skipMap.get(cacheSql) == null) { // 避免添加重复数据 + results = new ArrayList<>(childCount); + childMap.put(cacheSql, results); + skipMap.put(cacheSql, Boolean.TRUE); + } + + if (childCount <= 0 || results.size() < childCount) { // 避免超过子数组每页数量 + // if (count == 1 && results.isEmpty() == false) { // 避免添加重复数据 + // results.clear(); + // } + results.add(result); //缓存到 childMap + count ++; + Log.d(TAG, ">>> executeAppJoin childMap.put('" + cacheSql + "', result); childMap.size() = " + childMap.size()); + } + } + } + finally { + if (rs != null) { + try { + rs.close(); + } + catch (Exception e) { + e.printStackTrace(); + } + } + } long endTime = System.currentTimeMillis(); Log.d(TAG, "\n\n executeAppJoin endTime = " + endTime + "; duration = " + (endTime - startTime) @@ -445,77 +964,59 @@ protected void executeAppJoin(SQLConfig config, List resultList, Map /**table.put(rsmd.getColumnLabel(i), rs.getObject(i)); - * @param config + * @param config * @param rs * @param rsmd - * @param tablePosition 从0开始 + * @param row 从0开始 * @param table * @param columnIndex 从1开始 - * @param childMap + * @param childMap * @return result * @throws Exception */ - protected JSONObject onPutColumn(@NotNull SQLConfig config, @NotNull ResultSet rs, @NotNull ResultSetMetaData rsmd - , final int tablePosition, @NotNull JSONObject table, final int columnIndex, Map childMap) throws Exception { - - if (rsmd.getColumnName(columnIndex).startsWith("_")) { - Log.i(TAG, "select while (rs.next()){ ..." - + " >> rsmd.getColumnName(i).startsWith(_) >> continue;"); + protected M onPutColumn(@NotNull SQLConfig config, @NotNull ResultSet rs, @NotNull ResultSetMetaData rsmd + , final int row, @NotNull M table, final int columnIndex, Join join, Map childMap + , Map keyMap) throws Exception { + if (table == null) { // 对应副表 viceSql 不能生成正常 SQL， 或者是 ! - Outer, ( - ANTI JOIN 的副表这种不需要缓存及返回的数据 + Log.i(TAG, "onPutColumn table == null >> return table;"); return table; } - //已改为 rsmd.getTableName(columnIndex) 支持副表不传 @column ， 但如何判断是副表？childMap != null - // String lable = rsmd.getColumnLabel(columnIndex); - // int dotIndex = lable.indexOf("."); - String lable = rsmd.getColumnLabel(columnIndex);//dotIndex < 0 ? lable : lable.substring(dotIndex + 1); - - String childTable = childMap == null ? null : rsmd.getTableName(columnIndex); //dotIndex < 0 ? null : lable.substring(0, dotIndex); - - JSONObject finalTable = null; - String childSql = null; - SQLConfig childConfig = null; - - if (childTable == null) { - finalTable = table; + if (isHideColumn(config, rs, rsmd, row, table, columnIndex, childMap, keyMap)) { + Log.i(TAG, "onPutColumn isHideColumn(config, rs, rsmd, row, table, columnIndex, childMap) >> return table;"); + return table; } - else { - // lable = column; - - // - - List joinList = config.getJoinList(); - if (joinList != null) { - for (Join j : joinList) { - childConfig = j.isAppJoin() ? null : j.getCacheConfig(); //这里用config改了getSQL后再还原很麻烦，所以提前给一个config2更好 - - if (childConfig != null && childTable.equalsIgnoreCase(childConfig.getSQLTable())) { - childConfig.putWhere(j.getKey(), table.get(j.getTargetKey()), false); - childSql = childConfig.getSQL(false); + String label = getKey(config, rs, rsmd, row, table, columnIndex, childMap, keyMap); + Object value = getValue(config, rs, rsmd, row, table, columnIndex, label, childMap, keyMap); - if (StringUtil.isEmpty(childSql, true)) { - return table; - } - - finalTable = (JSONObject) childMap.get(childSql); - break; - } - } - } - - if (finalTable == null) { - finalTable = new JSONObject(true); - childMap.put(childSql, finalTable); - } + // 主表必须 put 至少一个 null 进去，否则全部字段为 null 都不 put 会导致中断后续正常返回值 + if (value != null || ENABLE_OUTPUT_NULL_COLUMN || (join == null && table.isEmpty())) { + table.put(label, value); } - finalTable.put(lable, getValue(config, rs, rsmd, tablePosition, table, columnIndex, lable, childMap)); - return table; } + /**如果不需要这个功能，在子类重写并直接 return false; 来提高性能 + * @param config + * @param rs + * @param rsmd + * @param row + * @param table + * @param columnIndex + * @param childMap + * @return + * @throws SQLException + */ + protected boolean isHideColumn(@NotNull SQLConfig config, @NotNull ResultSet rs, @NotNull ResultSetMetaData rsmd + , final int row, @NotNull M table, final int columnIndex, Map childMap + , Map keyMap) throws SQLException { + return rsmd.getColumnName(columnIndex).startsWith("_"); + } + /**resultList.put(position, table); - * @param config + * @param config * @param rs * @param rsmd * @param resultList @@ -523,20 +1024,51 @@ protected JSONObject onPutColumn(@NotNull SQLConfig config, @NotNull ResultSet r * @param table * @return resultList */ - protected List onPutTable(@NotNull SQLConfig config, @NotNull ResultSet rs, @NotNull ResultSetMetaData rsmd - , @NotNull List resultList, int position, @NotNull JSONObject table) { + protected List onPutTable(@NotNull SQLConfig config, @NotNull ResultSet rs, @NotNull ResultSetMetaData rsmd + , @NotNull List resultList, int position, @NotNull M table) { resultList.add(table); return resultList; } + protected String getKey(@NotNull SQLConfig config, @NotNull ResultSet rs, @NotNull ResultSetMetaData rsmd + , final int row, @NotNull M table, final int columnIndex, Map childMap + , Map keyMap) throws Exception { + long startTime = System.currentTimeMillis(); + String key = rsmd.getColumnLabel(columnIndex); // dotIndex < 0 ? label : label.substring(dotIndex + 1); + sqlResultDuration += System.currentTimeMillis() - startTime; + + if (config.isHive()) { + String tableName = config.getTable(); + String realTableName = AbstractSQLConfig.TABLE_KEY_MAP.get(tableName); - protected Object getValue(@NotNull SQLConfig config, @NotNull ResultSet rs, @NotNull ResultSetMetaData rsmd - , final int tablePosition, @NotNull JSONObject table, final int columnIndex, String lable, Map childMap) throws Exception { + String pattern = "^" + (StringUtil.isEmpty(realTableName, true) ? tableName : realTableName) + "\\." + "[a-zA-Z]+$"; + boolean isMatch = Pattern.matches(pattern, key); + if (isMatch) { + key = key.split("\\.")[1]; + } + } + + if (keyMap != null && ! keyMap.isEmpty()) { + String nk = keyMap.get(key); + if (StringUtil.isNotEmpty(nk, true)) { + key = nk; // QuestDB 会自动把副表与主表同名的字段重命名，例如 id 改为 id1, date 改为 date1 + } + } + return key; + } + + protected Object getValue(@NotNull SQLConfig config, @NotNull ResultSet rs, @NotNull ResultSetMetaData rsmd + , final int row, @NotNull M table, final int columnIndex, String label + , Map childMap, Map keyMap) throws Exception { + + long startTime = System.currentTimeMillis(); Object value = rs.getObject(columnIndex); + sqlResultDuration += System.currentTimeMillis() - startTime; + // Log.d(TAG, "name:" + rsmd.getColumnName(i)); - // Log.d(TAG, "lable:" + rsmd.getColumnLabel(i)); + // Log.d(TAG, "label:" + rsmd.getColumnLabel(i)); // Log.d(TAG, "type:" + rsmd.getColumnType(i)); // Log.d(TAG, "typeName:" + rsmd.getColumnTypeName(i)); @@ -546,19 +1078,31 @@ protected Object getValue(@NotNull SQLConfig config, @NotNull ResultSet rs, @Not boolean castToJson = false; //数据库查出来的null和empty值都有意义，去掉会导致 Moment:{ @column:"content" } 部分无结果及中断数组查询！ - if (value instanceof Boolean || value instanceof Number) { + if (value instanceof Boolean) { //加快判断速度 } + else if (value instanceof Number) { + value = getNumVal((Number) value); + } else if (value instanceof Timestamp) { value = ((Timestamp) value).toString(); } - else if (value instanceof Date) { + else if (value instanceof Date) { // java.sql.Date 和 java.sql.Time 都继承 java.util.Date value = ((Date) value).toString(); } - else if (value instanceof Time) { - value = ((Time) value).toString(); + else if (value instanceof LocalDateTime) { + value = ((LocalDateTime) value).toString(); + } + else if (value instanceof Year) { + value = ((Year) value).getValue(); + } + else if (value instanceof Month) { + value = ((Month) value).getValue(); } - else if (value instanceof String && isJSONType(config, rsmd, columnIndex, lable)) { //json String + else if (value instanceof DayOfWeek) { + value = ((DayOfWeek) value).getValue(); + } + else if (value instanceof String && isJSONType(config, rsmd, columnIndex, label)) { //json String castToJson = true; } else if (value instanceof Blob) { //FIXME 存的是 abcde，取出来直接就是 [97, 98, 99, 100, 101] 这种 byte[] 类型，没有经过以下处理，但最终序列化后又变成了字符串 YWJjZGU= @@ -568,43 +1112,81 @@ else if (value instanceof Blob) { //FIXME 存的是 abcde，取出来直接就 else if (value instanceof Clob) { //SQL Server TEXT 类型 居然走这个 castToJson = true; - StringBuffer sb = new StringBuffer(); - BufferedReader br = new BufferedReader(((Clob) value).getCharacterStream()); + StringBuffer sb = new StringBuffer(); + BufferedReader br = new BufferedReader(((Clob) value).getCharacterStream()); String s = br.readLine(); while (s != null) { - sb.append(s); - s = br.readLine(); + sb.append(s); + s = br.readLine(); } value = sb.toString(); + + try { + br.close(); + } + catch (Exception e) { + e.printStackTrace(); + } } if (castToJson == false) { List json = config.getJson(); - castToJson = json != null && json.contains(lable); + castToJson = json != null && json.contains(label); } if (castToJson) { try { - value = JSON.parse((String) value); + value = JSON.parse(value); } catch (Exception e) { - Log.e(TAG, "getValue try { value = JSON.parse((String) value); } catch (Exception e) { \n" + e.getMessage()); + Log.e(TAG, "getValue try { value = parseJSON((String) value); } catch (Exception e) { \n" + e.getMessage()); } } return value; } + public Object getNumVal(Number value) { + if (value == null) { + return null; + } + + if (value instanceof BigInteger) { + return ((BigInteger) value).toString(); + } + + if (value instanceof BigDecimal) { + return ((BigDecimal) value).toString(); + } + + double v = value.doubleValue(); + // if (v > Integer.MAX_VALUE || v < Integer.MIN_VALUE) { // 避免前端/客户端拿到精度丢失甚至严重失真的值 + // return value.toString(); + // } + // JavaScript: Number.MAX_SAFE_INTEGER ~ Number.MIN_SAFE_INTEGER + if (v > 9007199254740991L || v < -9007199254740991L) { // 避免前端/客户端拿到精度丢失甚至严重失真的值 + return value.toString(); + } + + return value; + } + /**判断是否为JSON类型 - * @param config - * @param lable + * @param config + * @param label * @param rsmd * @param position * @return */ @Override - public boolean isJSONType(@NotNull SQLConfig config, ResultSetMetaData rsmd, int position, String lable) { + public boolean isJSONType(@NotNull SQLConfig config, ResultSetMetaData rsmd, int position, String label) { try { + long startTime = System.currentTimeMillis(); String column = rsmd.getColumnTypeName(position); + sqlResultDuration += System.currentTimeMillis() - startTime; + // nosql elasticSearch jdbc获取不到 字段类型 + if(StringUtil.isEmpty(column)) { + return false; + } //TODO CHAR和JSON类型的字段，getColumnType返回值都是1 ，如果不用CHAR，改用VARCHAR，则可以用上面这行来提高性能。 //return rsmd.getColumnType(position) == 1; @@ -615,27 +1197,63 @@ public boolean isJSONType(@NotNull SQLConfig config, ResultSetMetaData rsmd, int e.printStackTrace(); } // List json = config.getJson(); - // return json != null && json.contains(lable); + // return json != null && json.contains(label); return false; } + @Override // 重写是为了返回类型从 Statement 改为 PreparedStatement，避免其它方法出错 + public PreparedStatement getStatement(@NotNull SQLConfig config) throws Exception { + return getStatement(config, null); + } - /** - * @param config - * @return - * @throws Exception - */ @Override - public PreparedStatement getStatement(@NotNull SQLConfig config) throws Exception { + public PreparedStatement getStatement(@NotNull SQLConfig config, String sql) throws Exception { + if (StringUtil.isEmpty(sql)) { + sql = config.gainSQL(config.isPrepared()); + } + + Connection conn = getConnection(config); PreparedStatement statement; //创建Statement对象 if (config.getMethod() == RequestMethod.POST && config.getId() == null) { //自增id - statement = getConnection(config).prepareStatement(config.getSQL(config.isPrepared()), Statement.RETURN_GENERATED_KEYS); + if (config.isOracle()) { + // 解决 oracle 使用自增主键 插入获取不到id问题 + String[] generatedColumns = {config.getIdKey()}; + statement = conn.prepareStatement(sql, generatedColumns); + } else { + statement = conn.prepareStatement(sql, Statement.RETURN_GENERATED_KEYS); + } + } + else if (RequestMethod.isGetMethod(config.getMethod(), true)) { + // if (config.isPresto() || config.isTrino()) { + // statement = getConnection(config).prepareStatement(sql); // , ResultSet.TYPE_FORWARD_ONLY, ResultSet.CONCUR_READ_ONLY, ResultSet.HOLD_CURSORS_OVER_COMMIT); + // } else { + // statement = getConnection(config).prepareStatement(sql, ResultSet.TYPE_SCROLL_SENSITIVE, ResultSet.CONCUR_UPDATABLE); + // } + + // TODO 补充各种支持 TYPE_SCROLL_SENSITIVE 和 CONCUR_UPDATABLE 的数据库 + if (config.isMySQL() || config.isTiDB() || config.isMariaDB() || config.isOracle() || config.isSQLServer() || config.isDb2() + || config.isPostgreSQL() || config.isCockroachDB() || config.isOpenGauss() || config.isTimescaleDB() || config.isQuestDB() + ) { + statement = conn.prepareStatement(sql, ResultSet.TYPE_SCROLL_SENSITIVE, ResultSet.CONCUR_UPDATABLE); + } else { + statement = conn.prepareStatement(sql); + } } else { - statement = getConnection(config).prepareStatement(config.getSQL(config.isPrepared())); + statement = conn.prepareStatement(sql); } + List valueList = config.isPrepared() ? config.getPreparedValueList() : null; +// List withAsExprePreparedValueList = config.isPrepared() ? config.getWithAsExprePreparedValueList() : null; +// +// // 不同数据库, 预编译mysql使用with-as +// if (valueList != null && withAsExprePreparedValueList != null && withAsExprePreparedValueList.size() > 0) { +// withAsExprePreparedValueList.addAll(valueList); +// valueList = withAsExprePreparedValueList; +// // 多条POST/PUT/DELETE语句的情况,需要重新初始化 +// config.setWithAsExprePreparedValueList(new ArrayList<>()); +// } if (valueList != null && valueList.isEmpty() == false) { for (int i = 0; i < valueList.size(); i++) { @@ -647,9 +1265,9 @@ public PreparedStatement getStatement(@NotNull SQLConfig config) throws Exceptio return statement; } - public PreparedStatement setArgument(@NotNull SQLConfig config, @NotNull PreparedStatement statement, int index, Object value) throws SQLException { - //JSON.isBooleanOrNumberOrString(v) 解决 PostgreSQL: Can't infer the SQL type to use for an instance of com.alibaba.fastjson.JSONArray - if (apijson.JSON.isBooleanOrNumberOrString(value)) { + public PreparedStatement setArgument(@NotNull SQLConfig config, @NotNull PreparedStatement statement, int index, Object value) throws SQLException { + //JSON.isBooleanOrNumberOrString(v) 解决 PostgreSQL: Can't infer the SQL type to use for an instance of com.alibaba.fastjson.JSONList + if (apijson.JSON.isBoolOrNumOrStr(value)) { statement.setObject(index + 1, value); //PostgreSQL JDBC 不支持隐式类型转换 tinyint = varchar 报错 } else { @@ -659,19 +1277,36 @@ public PreparedStatement setArgument(@NotNull SQLConfig config, @NotNull Prepare } protected Map connectionMap = new HashMap<>(); + public Map getConnectionMap() { + if (connectionMap == null) { + connectionMap = new HashMap<>(); + } + return connectionMap; + } + protected Connection connection; + @NotNull + public Connection getConnection(String key) throws Exception { + return getConnectionMap().get(key); + } + public Connection putConnection(String key, Connection connection) throws Exception { + return getConnectionMap().put(key, connection); + } + @NotNull @Override - public Connection getConnection(@NotNull SQLConfig config) throws Exception { - connection = connectionMap.get(config.getDatabase()); + public Connection getConnection(@NotNull SQLConfig config) throws Exception { + String connectionKey = getConnectionKey(config); + connection = getConnection(connectionKey); if (connection == null || connection.isClosed()) { Log.i(TAG, "select connection " + (connection == null ? " = null" : ("isClosed = " + connection.isClosed()))) ; - // PostgreSQL 不允许 cross-database - connection = DriverManager.getConnection(config.getDBUri(), config.getDBAccount(), config.getDBPassword()); - connectionMap.put(config.getDatabase(), connection); + // PostgreSQL 不允许 cross-database + connection = DriverManager.getConnection(config.gainDBUri(), config.gainDBAccount(), config.gainDBPassword()); + putConnection(connectionKey, connection); } - int ti = getTransactionIsolation(); + // TDengine 驱动内部事务处理方法都是空实现，手动 commit 无效 + int ti = config.isTDengine() ? Connection.TRANSACTION_NONE : getTransactionIsolation(); if (ti != Connection.TRANSACTION_NONE) { //java.sql.SQLException: Transaction isolation level NONE not supported by MySQL begin(ti); } @@ -679,6 +1314,13 @@ public Connection getConnection(@NotNull SQLConfig config) throws Exception { return connection; } + public String getConnectionKey(@NotNull SQLConfig config) { + return getConnectionKey(config.getDatabase(), config.getDatasource(), config.getNamespace(), config.getCatalog()); + } + public String getConnectionKey(String database, String datasource, String namespace, String catalog) { + return database + "-" + datasource + "-" + namespace + "-" + catalog; + } + //事务处理 <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< private int transactionIsolation; @Override @@ -690,42 +1332,120 @@ public void setTransactionIsolation(int transactionIsolation) { this.transactionIsolation = transactionIsolation; } + protected Map isolationMap = new LinkedHashMap<>(); @Override public void begin(int transactionIsolation) throws SQLException { Log.d("\n\n" + TAG, "<<<<<<<<<<<<<< TRANSACTION begin transactionIsolation = " + transactionIsolation + " >>>>>>>>>>>>>>>>>>>>>>> \n\n"); - //不做判断，如果掩盖了问题，调用层都不知道为啥事务没有提交成功 + // 不做判断，如果掩盖了问题，调用层都不知道为啥事务没有提交成功 // if (connection == null || connection.isClosed()) { // return; // } - connection.setTransactionIsolation(transactionIsolation); - connection.setAutoCommit(false); //java.sql.SQLException: Can''t call commit when autocommit=true + + // 将所有连接设置隔离级别，且禁止自动提交，需要以下代码来 commit/rollback + Collection connections = connectionMap == null ? null : connectionMap.values(); + if (connections != null) { + for (Connection connection : connections) { + try { + Integer isolation = isolationMap.get(connection); + if (isolation == null || isolation != transactionIsolation) { // 只设置一次 Isolation 等级 PG 及 MySQL 某些版本重复设置事务等级会报错 + isolationMap.put(connection, transactionIsolation); + + connection.setTransactionIsolation(transactionIsolation); // 这句导致 TDengine 驱动报错 + if (isolation == null) { + connection.setAutoCommit(false); // java.sql.SQLException: Can''t call commit when autocommit=true + } + } + } + catch (SQLException e) { + e.printStackTrace(); + } + } + } } + @Override public void rollback() throws SQLException { Log.d("\n\n" + TAG, "<<<<<<<<<<<<<< TRANSACTION rollback >>>>>>>>>>>>>>>>>>>>>>> \n\n"); //权限校验不通过，connection 也不会生成，还是得判断 //不做判断，如果掩盖了问题，调用层都不知道为啥事务没有提交成功 - if (connection == null) { // || connection.isClosed()) { - return; +// if (connection == null) { // || connection.isClosed()) { +// return; +// } + + // 将所有连接进行回滚 + Collection connections = connectionMap == null ? null : connectionMap.values(); + if (connections != null) { + for (Connection connection : connections) { + try { + if (connection != null && connection.isClosed() == false) { + connection.rollback(); + connection.setAutoCommit(true); + + isolationMap.remove(connection); + } + } + catch (SQLException e) { + e.printStackTrace(); + } + } } - connection.rollback(); } + @Override public void rollback(Savepoint savepoint) throws SQLException { Log.d("\n\n" + TAG, "<<<<<<<<<<<<<< TRANSACTION rollback savepoint " + (savepoint == null ? "" : "!") + "= null >>>>>>>>>>>>>>>>>>>>>>> \n\n"); - //权限校验不通过，connection 也不会生成，还是得判断 //不做判断，如果掩盖了问题，调用层都不知道为啥事务没有提交成功 - if (connection == null) { // || connection.isClosed()) { + if (savepoint == null) { + rollback(); return; } - connection.rollback(savepoint); + + //权限校验不通过，connection 也不会生成，还是得判断 //不做判断，如果掩盖了问题，调用层都不知道为啥事务没有提交成功 +// if (connection == null) { // || connection.isClosed()) { +// return; +// } + + // 将所有连接进行回滚 + Collection connections = connectionMap == null ? null : connectionMap.values(); + if (connections != null) { + for (Connection connection : connections) { + try { + if (connection != null && connection.isClosed() == false) { + connection.rollback(savepoint); + connection.setAutoCommit(true); + + isolationMap.remove(connection); + } + } + catch (SQLException e) { + e.printStackTrace(); + } + } + } } + @Override public void commit() throws SQLException { Log.d("\n\n" + TAG, "<<<<<<<<<<<<<< TRANSACTION commit >>>>>>>>>>>>>>>>>>>>>>> \n\n"); //权限校验不通过，connection 也不会生成，还是得判断 //不做判断，如果掩盖了问题，调用层都不知道为啥事务没有提交成功 - if (connection == null) { // || connection.isClosed()) { - return; +// if (connection == null) { // || connection.isClosed()) { +// return; +// } + + // 将所有连接进行提交 + Collection connections = connectionMap == null ? null : connectionMap.values(); + if (connections != null) { + for (Connection connection : connections) { + try { + if (connection != null && connection.isClosed() == false) { + connection.commit(); + + isolationMap.remove(connection); + } + } + catch (SQLException e) { + e.printStackTrace(); + } + } } - connection.commit(); } //事务处理 >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>> @@ -740,12 +1460,11 @@ public void close() { cachedSQLCount = 0; executedSQLCount = 0; - if (connectionMap == null) { + if (connectionMap == null || connectionMap.isEmpty()) { return; } Collection connections = connectionMap.values(); - if (connections != null) { for (Connection connection : connections) { try { @@ -764,24 +1483,62 @@ public void close() { } @Override - public ResultSet executeQuery(@NotNull SQLConfig config) throws Exception { - return getStatement(config).executeQuery(); //PreparedStatement 不用传 SQL + public ResultSet executeQuery(@NotNull SQLConfig config, String sql) throws Exception { + if (config.isPrepared() == false || config.isTDengine() // TDengine JDBC 不支持 PreparedStatement + || (config.isExplain() && (config.isPresto() || config.isTrino()))) { // Presto JDBC 0.277 在 EXPLAIN 模式下预编译值不会替代 ? 占位导致报错 + + Connection conn = getConnection(config); + Statement stt = conn.createStatement(); + // Statement stt = config.isTDengine() + // ? conn.createStatement() // fix Presto: ResultSet: Exception: set type is TYPE_FORWARD_ONLY, Result set concurrency must be CONCUR_READ_ONLY + // : conn.createStatement(ResultSet.TYPE_FORWARD_ONLY, ResultSet.CONCUR_READ_ONLY, ResultSet.HOLD_CURSORS_OVER_COMMIT); + + return executeQuery(stt, StringUtil.isEmpty(sql) ? config.gainSQL(false) : sql); + } + + // Presto JDBC 0.277 在 EXPLAIN 模式下预编译值不会替代 ? 占位导致报错 + PreparedStatement stt = getStatement(config, sql); + ResultSet rs = stt.executeQuery(); //PreparedStatement 不用传 SQL + // if (config.isExplain() && (config.isSQLServer() || config.isOracle())) { + // FIXME 返回的是 boolean 值 rs = stt.getMoreResults(Statement.CLOSE_CURRENT_RESULT); + // } + + return rs; } + @Override - public int executeUpdate(@NotNull SQLConfig config) throws Exception { - PreparedStatement s = getStatement(config); - int count = s.executeUpdate(); //PreparedStatement 不用传 SQL - - if (config.getMethod() == RequestMethod.POST && config.getId() == null) { //自增id - ResultSet rs = s.getGeneratedKeys(); + public int executeUpdate(@NotNull SQLConfig config, String sql) throws Exception { + Statement stt; + int count; + if (config.isTDengine()) { + Connection conn = getConnection(config); + stt = conn.createStatement(); + //stt = config.isTDengine() + // ? conn.createStatement() // fix Presto: ResultSet: Exception: set type is TYPE_FORWARD_ONLY, Result set concurrency must be CONCUR_READ_ONLY + // : conn.createStatement(ResultSet.TYPE_FORWARD_ONLY, ResultSet.CONCUR_READ_ONLY, ResultSet.HOLD_CURSORS_OVER_COMMIT); + + count = stt.executeUpdate(StringUtil.isEmpty(sql) ? config.gainSQL(false) : sql); + } + else { + stt = getStatement(config); + count = ((PreparedStatement) stt).executeUpdate(); // PreparedStatement 不用传 SQL + } + + if (count <= 0 && config.isHive()) { + count = 1; + } + + if (config.getId() == null && config.getMethod() == RequestMethod.POST) { // 自增id + ResultSet rs = stt.getGeneratedKeys(); if (rs != null && rs.next()) { - config.setId(rs.getLong(1));//返回插入的主键id + config.setId(rs.getLong(1)); } } - + return count; } } + diff --git a/APIJSONORM/src/main/java/apijson/orm/AbstractVerifier.java b/APIJSONORM/src/main/java/apijson/orm/AbstractVerifier.java index 2e14f0881..44b2d7f1d 100755 --- a/APIJSONORM/src/main/java/apijson/orm/AbstractVerifier.java +++ b/APIJSONORM/src/main/java/apijson/orm/AbstractVerifier.java @@ -1,10 +1,13 @@ -/*Copyright (C) 2020 THL A29 Limited, a Tencent company. All rights reserved. +/*Copyright (C) 2020 Tencent. All rights reserved. This source code is licensed under the Apache License Version 2.0.*/ package apijson.orm; +import static apijson.JSON.*; +import static apijson.JSONMap.KEY_COMBINE; +import static apijson.JSONMap.KEY_KEY; import static apijson.RequestMethod.DELETE; import static apijson.RequestMethod.GET; import static apijson.RequestMethod.GETS; @@ -12,11 +15,10 @@ import static apijson.RequestMethod.HEADS; import static apijson.RequestMethod.POST; import static apijson.RequestMethod.PUT; -import static apijson.orm.Operation.DISALLOW; +import static apijson.orm.Operation.ALLOW_PARTIAL_UPDATE_FAIL; import static apijson.orm.Operation.EXIST; import static apijson.orm.Operation.INSERT; import static apijson.orm.Operation.MUST; -import static apijson.orm.Operation.NECESSARY; import static apijson.orm.Operation.REFUSE; import static apijson.orm.Operation.REMOVE; import static apijson.orm.Operation.REPLACE; @@ -24,82 +26,128 @@ import static apijson.orm.Operation.UNIQUE; import static apijson.orm.Operation.UPDATE; import static apijson.orm.Operation.VERIFY; +import static apijson.orm.Operation.IF; +//import static apijson.orm.Operation.CODE; import java.net.URL; import java.time.LocalDate; import java.time.LocalDateTime; import java.time.LocalTime; -import java.util.ArrayList; -import java.util.Arrays; -import java.util.Collection; -import java.util.HashMap; -import java.util.HashSet; -import java.util.LinkedHashSet; -import java.util.List; -import java.util.Map; -import java.util.Map.Entry; -import java.util.Set; -import java.util.SortedMap; +import java.util.*; +import java.util.regex.Matcher; import java.util.regex.Pattern; -import javax.activation.UnsupportedDataTypeException; +import apijson.*; -import com.alibaba.fastjson.JSONArray; -import com.alibaba.fastjson.JSONObject; - -import apijson.JSON; -import apijson.JSONResponse; -import apijson.Log; -import apijson.MethodAccess; -import apijson.NotNull; -import apijson.RequestMethod; -import apijson.RequestRole; -import apijson.StringUtil; import apijson.orm.AbstractSQLConfig.IdCallback; import apijson.orm.exception.ConflictException; import apijson.orm.exception.NotLoggedInException; +import apijson.orm.exception.UnsupportedDataTypeException; import apijson.orm.model.Access; import apijson.orm.model.Column; import apijson.orm.model.Document; import apijson.orm.model.ExtendedProperty; import apijson.orm.model.Function; +import apijson.orm.model.Script; import apijson.orm.model.PgAttribute; import apijson.orm.model.PgClass; import apijson.orm.model.Request; -import apijson.orm.model.Response; import apijson.orm.model.SysColumn; import apijson.orm.model.SysTable; import apijson.orm.model.Table; -import apijson.orm.model.Test; +import apijson.orm.model.AllTable; +import apijson.orm.model.AllColumn; +import apijson.orm.model.AllTableComment; +import apijson.orm.model.AllColumnComment; import apijson.orm.model.TestRecord; +import javax.script.ScriptEngine; +import javax.script.ScriptEngineManager; + /**校验器(权限、请求参数、返回结果等) * TODO 合并 Structure 的代码 * @author Lemon * @param id 与 userId 的类型，一般为 Long */ -public abstract class AbstractVerifier implements Verifier, IdCallback { +public abstract class AbstractVerifier, L extends List> + implements Verifier, IdCallback { private static final String TAG = "AbstractVerifier"; + /**为 PUT, DELETE 强制要求必须有 id/id{}/id{}@ 条件 + */ + public static boolean IS_UPDATE_MUST_HAVE_ID_CONDITION = true; + /**开启校验请求角色权限 + */ + public static boolean ENABLE_VERIFY_ROLE = true; + /**开启校验请求传参内容 + */ + public static boolean ENABLE_VERIFY_CONTENT = true; + + /**未登录，不明身份的用户 + */ + public static final String UNKNOWN = "UNKNOWN"; + + /**已登录的用户 + */ + public static final String LOGIN = "LOGIN"; + + /**联系人，必须已登录 + */ + public static final String CONTACT = "CONTACT"; + + /**圈子成员(CONTACT + OWNER)，必须已登录 + */ + public static final String CIRCLE = "CIRCLE"; + + /**拥有者，必须已登录 + */ + public static final String OWNER = "OWNER"; + + /**管理员，必须已登录 + */ + public static final String ADMIN = "ADMIN"; + +// public static ParserCreator PARSER_CREATOR; + + public static ScriptEngineManager SCRIPT_ENGINE_MANAGER; + public static ScriptEngine SCRIPT_ENGINE; // 共享 STRUCTURE_MAP 则不能 remove 等做任何变更，否则在并发情况下可能会出错，加锁效率又低，所以这里改为忽略对应的 key - public static final List OPERATION_KEY_LIST; + public static Map> ROLE_MAP; + + public static List OPERATION_KEY_LIST; // > // > @NotNull - public static final Map> SYSTEM_ACCESS_MAP; + public static Map> SYSTEM_ACCESS_MAP; @NotNull - public static final Map> ACCESS_MAP; + public static Map> ACCESS_MAP; + @NotNull + public static Map> ACCESS_FAKE_DELETE_MAP; // > // > @NotNull - public static final Map> REQUEST_MAP; + public static Map>> REQUEST_MAP; + private static String VERIFY_LENGTH_RULE = "(?[>=<]*)(?[0-9]*)"; + private static Pattern VERIFY_LENGTH_PATTERN = Pattern.compile(VERIFY_LENGTH_RULE); + // 正则匹配的别名快捷方式，例如用 "PHONE" 代替 "^((13[0-9])|(15[^4,\\D])|(18[0-2,5-9])|(17[0-9]))\\d{8}$" @NotNull public static final Map COMPILE_MAP; static { + SCRIPT_ENGINE_MANAGER = new ScriptEngineManager(); + SCRIPT_ENGINE = SCRIPT_ENGINE_MANAGER.getEngineByName("js"); + + ROLE_MAP = new LinkedHashMap<>(); + ROLE_MAP.put(UNKNOWN, new Entry()); + ROLE_MAP.put(LOGIN, new Entry("userId>", 0)); + ROLE_MAP.put(CONTACT, new Entry("userId{}", "contactIdList")); + ROLE_MAP.put(CIRCLE, new Entry("userId-()", "verifyCircle()")); // "userId{}", "circleIdList")); // 还是 {"userId":"currentUserId", "userId{}": "contactIdList", "@combine": "userId,userId{}" } ? + ROLE_MAP.put(OWNER, new Entry("userId", "userId")); + ROLE_MAP.put(ADMIN, new Entry("userId-()", "verifyAdmin()")); + OPERATION_KEY_LIST = new ArrayList<>(); OPERATION_KEY_LIST.add(TYPE.name()); OPERATION_KEY_LIST.add(VERIFY.name()); @@ -111,23 +159,27 @@ public abstract class AbstractVerifier implements Verifier, IdCallback { OPERATION_KEY_LIST.add(REMOVE.name()); OPERATION_KEY_LIST.add(MUST.name()); OPERATION_KEY_LIST.add(REFUSE.name()); - OPERATION_KEY_LIST.add(NECESSARY.name()); - OPERATION_KEY_LIST.add(DISALLOW.name()); - - - SYSTEM_ACCESS_MAP = new HashMap>(); + OPERATION_KEY_LIST.add(IF.name()); +// OPERATION_KEY_LIST.add(CODE.name()); + OPERATION_KEY_LIST.add(ALLOW_PARTIAL_UPDATE_FAIL.name()); + + + SYSTEM_ACCESS_MAP = new HashMap>(); SYSTEM_ACCESS_MAP.put(Access.class.getSimpleName(), getAccessMap(Access.class.getAnnotation(MethodAccess.class))); SYSTEM_ACCESS_MAP.put(Function.class.getSimpleName(), getAccessMap(Function.class.getAnnotation(MethodAccess.class))); + SYSTEM_ACCESS_MAP.put(Script.class.getSimpleName(), getAccessMap(Script.class.getAnnotation(MethodAccess.class))); SYSTEM_ACCESS_MAP.put(Request.class.getSimpleName(), getAccessMap(Request.class.getAnnotation(MethodAccess.class))); - SYSTEM_ACCESS_MAP.put(Response.class.getSimpleName(), getAccessMap(Response.class.getAnnotation(MethodAccess.class))); - SYSTEM_ACCESS_MAP.put(Test.class.getSimpleName(), getAccessMap(Test.class.getAnnotation(MethodAccess.class))); if (Log.DEBUG) { SYSTEM_ACCESS_MAP.put(Table.class.getSimpleName(), getAccessMap(Table.class.getAnnotation(MethodAccess.class))); SYSTEM_ACCESS_MAP.put(Column.class.getSimpleName(), getAccessMap(Column.class.getAnnotation(MethodAccess.class))); SYSTEM_ACCESS_MAP.put(PgAttribute.class.getSimpleName(), getAccessMap(PgAttribute.class.getAnnotation(MethodAccess.class))); SYSTEM_ACCESS_MAP.put(PgClass.class.getSimpleName(), getAccessMap(PgClass.class.getAnnotation(MethodAccess.class))); + SYSTEM_ACCESS_MAP.put(AllTable.class.getSimpleName(), getAccessMap(AllTable.class.getAnnotation(MethodAccess.class))); + SYSTEM_ACCESS_MAP.put(AllTableComment.class.getSimpleName(), getAccessMap(AllTableComment.class.getAnnotation(MethodAccess.class))); + SYSTEM_ACCESS_MAP.put(AllColumn.class.getSimpleName(), getAccessMap(AllColumn.class.getAnnotation(MethodAccess.class))); + SYSTEM_ACCESS_MAP.put(AllColumnComment.class.getSimpleName(), getAccessMap(AllColumnComment.class.getAnnotation(MethodAccess.class))); SYSTEM_ACCESS_MAP.put(SysTable.class.getSimpleName(), getAccessMap(SysTable.class.getAnnotation(MethodAccess.class))); SYSTEM_ACCESS_MAP.put(SysColumn.class.getSimpleName(), getAccessMap(SysColumn.class.getAnnotation(MethodAccess.class))); SYSTEM_ACCESS_MAP.put(ExtendedProperty.class.getSimpleName(), getAccessMap(ExtendedProperty.class.getAnnotation(MethodAccess.class))); @@ -138,21 +190,23 @@ public abstract class AbstractVerifier implements Verifier, IdCallback { ACCESS_MAP = new HashMap<>(SYSTEM_ACCESS_MAP); - REQUEST_MAP = new HashMap<>(ACCESS_MAP.size()*6); // 单个与批量增删改 + REQUEST_MAP = new HashMap<>(ACCESS_MAP.size()*7); // 单个与批量增删改 COMPILE_MAP = new HashMap(); + } + /**获取权限Map，每种操作都只允许对应的角色 * @param access * @return */ - public static HashMap getAccessMap(MethodAccess access) { + public static HashMap getAccessMap(MethodAccess access) { if (access == null) { return null; } - HashMap map = new HashMap<>(); + HashMap map = new HashMap<>(); map.put(GET, access.GET()); map.put(HEAD, access.HEAD()); map.put(GETS, access.GETS()); @@ -166,21 +220,23 @@ public static HashMap getAccessMap(MethodAccess ac @Override - public String getVisitorIdKey(SQLConfig config) { - return config.getUserIdKey(); + public String getVisitorIdKey(SQLConfig config) { + return config == null ? getUserIdKey(null, null, null, null) : config.getUserIdKey(); } @Override - public String getIdKey(String database, String schema, String table) { - return apijson.JSONObject.KEY_ID; + public String getIdKey(String database, String schema, String datasource, String table) { + return JSONMap.KEY_ID; } @Override - public String getUserIdKey(String database, String schema, String table) { - return apijson.JSONObject.KEY_USER_ID; + public String getUserIdKey(String database, String schema, String datasource, String table) { + return JSONMap.KEY_USER_ID; } + + @SuppressWarnings("unchecked") @Override - public Object newId(RequestMethod method, String database, String schema, String table) { - return System.currentTimeMillis(); + public T newId(RequestMethod method, String database, String schema, String datasource, String table) { + return (T) Long.valueOf(System.currentTimeMillis()); } @@ -194,11 +250,11 @@ public Visitor getVisitor() { return visitor; } @Override - public AbstractVerifier setVisitor(Visitor visitor) { + public AbstractVerifier setVisitor(Visitor visitor) { this.visitor = visitor; this.visitorId = visitor == null ? null : visitor.getId(); - //导致内部调用且放行校验(noVerifyLogin, noVerifyRole)也抛异常 + //导致内部调用且放行校验(needVerifyLogin, needVerifyRole)也抛异常 // if (visitorId == null) { // throw new NullPointerException(TAG + ".setVisitor visitorId == null !!! 可能导致权限校验失效，引发安全问题！"); // } @@ -209,42 +265,105 @@ public AbstractVerifier setVisitor(Visitor visitor) { /**验证权限是否通过 * @param config - * @param visitor * @return * @throws Exception */ - @Deprecated - public boolean verify(SQLConfig config) throws Exception { - return verifyAccess(config); - } - /**验证权限是否通过 - * @param config - * @param visitor - * @return - * @throws Exception - */ - public boolean verifyAccess(SQLConfig config) throws Exception { + @Override + public boolean verifyAccess(SQLConfig config) throws Exception { + if (ENABLE_VERIFY_ROLE == false) { + throw new UnsupportedOperationException("AbstractVerifier.ENABLE_VERIFY_ROLE == false " + + "时不支持校验角色权限！如需支持则设置 AbstractVerifier.ENABLE_VERIFY_ROLE = true ！"); + } + String table = config == null ? null : config.getTable(); if (table == null) { return true; } - RequestRole role = config.getRole(); + + String role = config.getRole(); if (role == null) { - role = RequestRole.UNKNOWN; + role = UNKNOWN; } + else { + if (ROLE_MAP.containsKey(role) == false) { + Set NAMES = ROLE_MAP.keySet(); + throw new IllegalArgumentException("角色 " + role + " 不存在！" + + "只能是[" + StringUtil.get(NAMES.toArray()) + "]中的一种！"); + } - if (role != RequestRole.UNKNOWN) {//未登录的角色 - verifyLogin(); + if (role.equals(UNKNOWN) == false) { //未登录的角色 + verifyLogin(); + } } RequestMethod method = config.getMethod(); + verifyRole(config, table, method, role); + + return true; + } + + @Override + public void verifyRole(SQLConfig config, String table, RequestMethod method, String role) throws Exception { + verifyAllowRole(config, table, method, role); //验证允许的角色 + verifyUseRole(config, table, method, role); //验证使用的角色 + } + + /**允许请求使用的所以可能角色 + * @param config + * @param table + * @param method + * @param role + * @return + * @throws Exception + * @see {@link JSONMap#KEY_ROLE} + */ + public void verifyAllowRole(SQLConfig config, String table, RequestMethod method, String role) throws Exception { + Log.d(TAG, "verifyAllowRole table = " + table + "; method = " + method + "; role = " + role); + if (table == null) { + table = config == null ? null : config.getTable(); + } - verifyRole(table, method, role);//验证允许的角色 + if (table != null) { + if (method == null) { + method = config == null ? GET : config.getMethod(); + } + if (role == null) { + role = config == null ? UNKNOWN : config.getRole(); + } + Map map = ACCESS_MAP.get(table); + if (map == null || Arrays.asList(map.get(method)).contains(role) == false) { + throw new IllegalAccessException(table + " 不允许 " + role + " 用户的 " + method.name() + " 请求！"); + } + } + } + + /**校验请求使用的角色，角色不好判断，让访问者发过来角色名，OWNER,CONTACT,ADMIN等 + * @param config + * @param table + * @param method + * @param role + * @return + * @throws Exception + * @see {@link JSONMap#KEY_ROLE} + */ + public void verifyUseRole(@NotNull SQLConfig config, String table, RequestMethod method, String role) throws Exception { + Log.d(TAG, "verifyUseRole table = " + table + "; method = " + method + "; role = " + role); + Objects.requireNonNull(config); //验证角色，假定真实强制匹配<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< - String visitorIdkey = getVisitorIdKey(config); + if (table == null) { + table = config.getTable(); + } + if (method == null) { + method = config.getMethod(); + } + if (role == null) { + role = config.getRole(); + } + + String visitorIdKey = getVisitorIdKey(config); Object requestId; switch (role) { @@ -252,38 +371,48 @@ public boolean verifyAccess(SQLConfig config) throws Exception { break; case CONTACT: case CIRCLE: - //TODO 做一个缓存contactMap，提高[]:{}查询性能， removeAccessInfo时map.remove(visitorId) - //不能在Visitor内null -> [] ! 否则会导致某些查询加上不需要的条件！ + // TODO 做一个缓存contactMap，提高[]:{}查询性能， removeAccessInfo时map.remove(visitorId) + // 不能在 Visitor内null -> [] ! 否则会导致某些查询加上不需要的条件！ List list = visitor.getContactIdList() == null ? new ArrayList() : new ArrayList(visitor.getContactIdList()); - if (role == RequestRole.CIRCLE) { + if (CIRCLE.equals(role)) { list.add(visitorId); } - //key!{}:[] 或 其它没有明确id的条件 等 可以和key{}:list组合。类型错误就报错 - requestId = (Number) config.getWhere(visitorIdkey, true);//JSON里数值不能保证是Long，可能是Integer - JSONArray requestIdArray = (JSONArray) config.getWhere(visitorIdkey + "{}", true);//不能是 &{}， |{} 不要传，直接{} + // key!{}:[] 或 其它没有明确id的条件 等 可以和 key{}:[] 组合。类型错误就报错 + requestId = config.getWhere(visitorIdKey, true); // JSON 里数值不能保证是 Long，可能是 Integer + @SuppressWarnings("unchecked") + Collection requestIdArray = (Collection) config.getWhere(visitorIdKey + "{}", true); // 不能是 &{}， |{} 不要传，直接 {} if (requestId != null) { if (requestIdArray == null) { - requestIdArray = new JSONArray(); + requestIdArray = JSON.createJSONArray(); } requestIdArray.add(requestId); } - if (requestIdArray == null) {//可能是@得到 || requestIdArray.isEmpty()) {//请求未声明key:id或key{}:[...]条件，自动补全 - config.putWhere(visitorIdkey+"{}", JSON.parseArray(list), true); //key{}:[]有效，SQLConfig里throw NotExistException - } - else {//请求已声明key:id或key{}:[]条件，直接验证 + if (requestIdArray == null) { // 可能是 @ 得到 || requestIdArray.isEmpty()) { // 请求未声明 key:id 或 key{}:[...] 条件，自动补全 + config.putWhere(visitorIdKey+"{}", JSON.parseArray(list), true); // key{}:[] 有效，SQLConfig 里 throw NotExistException + } + else { // 请求已声明 key:id 或 key{}:[] 条件，直接验证 for (Object id : requestIdArray) { if (id == null) { continue; } - if (id instanceof Number == false) {//不能准确地判断Long，可能是Integer - throw new UnsupportedDataTypeException(table + ".id类型错误，id类型必须是Long！"); + + if (id instanceof Number) { // 不能准确地判断 Long，可能是 Integer + if (((Number) id).longValue() <= 0 || list.contains(Long.valueOf("" + id)) == false) { // Integer等转为 Long 才能正确判断，强转崩溃 + throw new IllegalAccessException(visitorIdKey + " = " + id + " 的 " + table + + " 不允许 " + role + " 用户的 " + method.name() + " 请求！"); + } + } + else if (id instanceof String) { + if (StringUtil.isEmpty(id) || list.contains(id) == false) { + throw new IllegalAccessException(visitorIdKey + " = " + id + " 的 " + table + + " 不允许 " + role + " 用户的 " + method.name() + " 请求！"); + } } - if (list.contains(new Long("" + id)) == false) {//Integer等转为Long才能正确判断。强转崩溃 - throw new IllegalAccessException(visitorIdkey + " = " + id + " 的 " + table - + " 不允许 " + role.name() + " 用户的 " + method.name() + " 请求！"); + else { + throw new UnsupportedDataTypeException(table + ".id 类型错误，类型必须是 Long/String！"); } } } @@ -296,20 +425,20 @@ public boolean verifyAccess(SQLConfig config) throws Exception { throw new IllegalArgumentException("POST 请求必须在Table内设置要保存的 key:value ！"); } - int index = c.indexOf(visitorIdkey); + int index = c.indexOf(visitorIdKey); if (index >= 0) { Object oid; for (List ovl : ovs) { oid = ovl == null || index >= ovl.size() ? null : ovl.get(index); - if (oid == null || StringUtil.getString(oid).equals("" + visitorId) == false) { - throw new IllegalAccessException(visitorIdkey + " = " + oid + " 的 " + table - + " 不允许 " + role.name() + " 用户的 " + method.name() + " 请求！"); + if (oid == null || StringUtil.get(oid).equals("" + visitorId) == false) { + throw new IllegalAccessException(visitorIdKey + " = " + oid + " 的 " + table + + " 不允许 " + role + " 用户的 " + method.name() + " 请求！"); } } } else { List nc = new ArrayList<>(c); - nc.add(visitorIdkey); + nc.add(visitorIdKey); config.setColumn(nc); List> nvs = new ArrayList<>(); @@ -324,16 +453,16 @@ public boolean verifyAccess(SQLConfig config) throws Exception { } } else { - requestId = config.getWhere(visitorIdkey, true);//JSON里数值不能保证是Long，可能是Integer - if (requestId != null && StringUtil.getString(requestId).equals(StringUtil.getString(visitorId)) == false) { - throw new IllegalAccessException(visitorIdkey + " = " + requestId + " 的 " + table - + " 不允许 " + role.name() + " 用户的 " + method.name() + " 请求！"); + requestId = config.getWhere(visitorIdKey, true);//JSON里数值不能保证是Long，可能是Integer + if (requestId != null && StringUtil.get(requestId).equals(StringUtil.get(visitorId)) == false) { + throw new IllegalAccessException(visitorIdKey + " = " + requestId + " 的 " + table + + " 不允许 " + role + " 用户的 " + method.name() + " 请求！"); } - config.putWhere(visitorIdkey, visitorId, true); + config.putWhere(visitorIdKey, visitorId, true); } break; - case ADMIN://这里不好做，在特定接口内部判。 可以是 /get/admin + 固定秘钥 Parser#noVerify，之后全局跳过验证 + case ADMIN://这里不好做，在特定接口内部判。 可以是 /get/admin + 固定秘钥 Parser#needVerify，之后全局跳过验证 verifyAdmin(); break; default://unknown，verifyRole通过就行 @@ -341,61 +470,26 @@ public boolean verifyAccess(SQLConfig config) throws Exception { } //验证角色，假定真实强制匹配>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>> - - - return true; - } - - - - - - /**允许请求，角色不好判断，让访问者发过来角色名，OWNER,CONTACT,ADMIN等 - * @param table - * @param method - * @param role - * @return - * @throws Exception - * @see {@link apijson.JSONObject#KEY_ROLE} - */ - public void verifyRole(String table, RequestMethod method, RequestRole role) throws Exception { - Log.d(TAG, "verifyRole table = " + table + "; method = " + method + "; role = " + role); - if (table != null) { - if (method == null) { - method = GET; - } - if (role == null) { - role = RequestRole.UNKNOWN; - } - Map map = ACCESS_MAP.get(table); - - if (map == null || Arrays.asList(map.get(method)).contains(role) == false) { - throw new IllegalAccessException(table + " 不允许 " + role.name() + " 用户的 " + method.name() + " 请求！"); - } - } } /**登录校验 - * @author Lemon - * @param visitorId - * @throws Exception */ @Override public void verifyLogin() throws Exception { //未登录没有权限操作 if (visitorId == null) { - throw new NotLoggedInException("未登录，请登录后再操作！"); + throw new NotLoggedInException("未登录或登录过期，请登录后再操作！"); } if (visitorId instanceof Number) { if (((Number) visitorId).longValue() <= 0) { - throw new NotLoggedInException("未登录，请登录后再操作！"); + throw new NotLoggedInException("未登录或登录过期，请登录后再操作！"); } - } + } else if (visitorId instanceof String) { if (StringUtil.isEmpty(visitorId, true)) { - throw new NotLoggedInException("未登录，请登录后再操作！"); + throw new NotLoggedInException("未登录或登录过期，请登录后再操作！"); } } else { @@ -406,7 +500,8 @@ else if (visitorId instanceof String) { @Override public void verifyAdmin() throws Exception { - throw new UnsupportedOperationException("不支持 ADMIN 角色！如果要支持就在子类重写这个方法来校验 ADMIN 角色，不通过则 throw IllegalAccessException!"); + throw new UnsupportedOperationException("不支持 ADMIN 角色！如果要支持就在子类重写这个方法" + + "来校验 ADMIN 角色，不通过则 throw IllegalAccessException!"); } @@ -439,18 +534,21 @@ public void verifyRepeat(String table, String key, Object value, long exceptId) throw new UnsupportedDataTypeException(key + ":value 中value的类型不能为JSON！"); } - JSONRequest request = new JSONRequest(key, value); + M tblObj = JSON.createJSONObject(); + tblObj.put(key, value); if (exceptId > 0) {//允许修改自己的属性为该属性原来的值 - request.put(JSONRequest.KEY_ID + "!", exceptId); // FIXME 这里 id 写死了，不支持自定义 + tblObj.put(JSONMap.KEY_ID + "!", exceptId); // FIXME 这里 id 写死了，不支持自定义 } - JSONObject repeat = createParser().setMethod(GET).setNeedVerify(true).parseResponse( - new JSONRequest(table, request) - ); - repeat = repeat == null ? null : repeat.getJSONObject(table); + + M req = JSON.createJSONObject(); + req.put(table, tblObj); + Map repeat = createParser().setMethod(HEAD).setNeedVerify(true).parseResponse(req); + + repeat = repeat == null ? null : JSON.get(repeat, table); if (repeat == null) { throw new Exception("服务器内部错误 verifyRepeat repeat == null"); } - if (repeat.getIntValue(JSONResponse.KEY_CODE) > 0) { + if (getIntValue(repeat, JSONResponse.KEY_COUNT) > 0) { throw new ConflictException(key + ": " + value + " 已经存在，不能重复！"); } } @@ -458,22 +556,20 @@ public void verifyRepeat(String table, String key, Object value, long exceptId) /**从request提取target指定的内容 - * @param method - * @param name - * @param target - * @param request - * @param maxUpdateCount - * @param idKey - * @param userIdKey - * @param creator - * @return - * @throws Exception - */ + * @param method + * @param name + * @param target + * @param request + * @param maxUpdateCount + * @param database + * @param schema + * @return + * @throws Exception + */ @Override - public JSONObject verifyRequest(@NotNull final RequestMethod method, final String name - , final JSONObject target, final JSONObject request, final int maxUpdateCount - , final String database, final String schema, final SQLCreator creator) throws Exception { - return verifyRequest(method, name, target, request, maxUpdateCount, database, schema, this, creator); + public M verifyRequest(@NotNull final RequestMethod method, final String name, final M target, final M request, final int maxUpdateCount + , final String database, final String schema) throws Exception { + return verifyRequest(method, name, target, request, maxUpdateCount, database, schema, this, getParser()); } /**从request提取target指定的内容 @@ -481,13 +577,14 @@ public JSONObject verifyRequest(@NotNull final RequestMethod method, final Strin * @param name * @param target * @param request - * @param creator + * @param parser * @return * @throws Exception */ - public static JSONObject verifyRequest(@NotNull final RequestMethod method, final String name - , final JSONObject target, final JSONObject request, final SQLCreator creator) throws Exception { - return verifyRequest(method, name, target, request, Parser.MAX_UPDATE_COUNT, creator); + public static , L extends List> M verifyRequest( + @NotNull final RequestMethod method, final String name, final M target, final M request + , @NotNull Parser parser) throws Exception { + return verifyRequest(method, name, target, request, AbstractParser.MAX_UPDATE_COUNT, parser); } /**从request提取target指定的内容 * @param method @@ -495,30 +592,60 @@ public static JSONObject verifyRequest(@NotNull final RequestMethod method, fina * @param target * @param request * @param maxUpdateCount - * @param creator + * @param parser * @return * @throws Exception */ - public static JSONObject verifyRequest(@NotNull final RequestMethod method, final String name - , final JSONObject target, final JSONObject request, final int maxUpdateCount, final SQLCreator creator) throws Exception { - return verifyRequest(method, name, target, request, maxUpdateCount, null, null, null, creator); + public static , L extends List> M verifyRequest( + @NotNull final RequestMethod method, final String name, final M target, final M request + , final int maxUpdateCount, @NotNull Parser parser) throws Exception { + + return verifyRequest(method, name, target, request, maxUpdateCount, null, null, null, parser); } /**从request提取target指定的内容 - * @param method - * @param name - * @param target - * @param request - * @param maxUpdateCount - * @param idKey - * @param userIdKey - * @param creator - * @return - * @throws Exception - */ - public static JSONObject verifyRequest(@NotNull final RequestMethod method, final String name - , final JSONObject target, final JSONObject request, final int maxUpdateCount - , final String database, final String schema, final IdCallback idCallback, final SQLCreator creator) throws Exception { + * @param method + * @param name + * @param target + * @param request + * @param maxUpdateCount + * @param database + * @param schema + * @param idCallback + * @param parser + * @return + * @param + * @throws Exception + */ + public static , L extends List> M verifyRequest( + @NotNull RequestMethod method, String name, M target, M request, int maxUpdateCount, String database + , String schema, IdCallback idCallback, @NotNull Parser parser) throws Exception { + + return verifyRequest(method, name, target, request, maxUpdateCount, database, schema, null, idCallback, parser); + } + /**从request提取target指定的内容 + * @param method + * @param name + * @param target + * @param request + * @param maxUpdateCount + * @param database + * @param schema + * @param datasource + * @param idCallback + * @param parser + * @return + * @param + * @throws Exception + */ + public static , L extends List> M verifyRequest( + @NotNull final RequestMethod method, final String name, final M target, final M request + , final int maxUpdateCount, final String database, final String schema, final String datasource + , final IdCallback idCallback, @NotNull Parser parser) throws Exception { + if (ENABLE_VERIFY_CONTENT == false) { + throw new UnsupportedOperationException("AbstractVerifier.ENABLE_VERIFY_CONTENT == false" + + " 时不支持校验请求传参内容！如需支持则设置 AbstractVerifier.ENABLE_VERIFY_CONTENT = true ！"); + } Log.i(TAG, "verifyRequest method = " + method + "; name = " + name + "; target = \n" + JSON.toJSONString(target) @@ -530,57 +657,62 @@ public static JSONObject verifyRequest(@NotNull final RequestMethod method, fina } //已在 Verifier 中处理 - // if (RequestRole.get(request.getString(JSONRequest.KEY_ROLE)) == RequestRole.ADMIN) { + // if (get(getString(request, apijson.JSONMap.KEY_ROLE)) == ADMIN) { // throw new IllegalArgumentException("角色设置错误！不允许在写操作Request中传 " + name + - // ":{ " + JSONRequest.KEY_ROLE + ":admin } ！"); + // ":{ " + apijson.JSONMap.KEY_ROLE + ":admin } ！"); // } //解析 - return parse(method, name, target, request, database, schema, idCallback, creator, new OnParseCallback() { + return parse(method, name, target, request, database, schema, idCallback, parser, new OnParseCallback() { @Override - public JSONObject onParseJSONObject(String key, JSONObject tobj, JSONObject robj) throws Exception { + public M onParseJSONObject(String key, M tobj, M robj) throws Exception { // Log.i(TAG, "verifyRequest.parse.onParseJSONObject key = " + key + "; robj = " + robj); if (robj == null) { if (tobj != null) {//不允许不传Target中指定的Table throw new IllegalArgumentException(method + "请求，请在 " + name + " 内传 " + key + ":{} ！"); } - } else if (apijson.JSONObject.isTableKey(key)) { - String db = request.getString(apijson.JSONObject.KEY_DATABASE); - String sh = request.getString(apijson.JSONObject.KEY_SCHEMA); + } else if (JSONMap.isTableKey(key)) { + String db = getString(request, JSONMap.KEY_DATABASE); + String sh = getString(request, JSONMap.KEY_SCHEMA); + String ds = getString(request, JSONMap.KEY_DATASOURCE); if (StringUtil.isEmpty(db, false)) { db = database; } if (StringUtil.isEmpty(sh, false)) { sh = schema; } + if (StringUtil.isEmpty(ds, false)) { + ds = datasource; + } - String idKey = idCallback == null ? null : idCallback.getIdKey(db, sh, key); - String finalIdKey = StringUtil.isEmpty(idKey, false) ? apijson.JSONObject.KEY_ID : idKey; + String idKey = idCallback == null ? null : idCallback.getIdKey(db, sh, ds, key); + String finalIdKey = StringUtil.isEmpty(idKey, false) ? JSONMap.KEY_ID : idKey; if (method == RequestMethod.POST) { if (robj.containsKey(finalIdKey)) { throw new IllegalArgumentException(method + "请求，" + name + "/" + key + " 不能传 " + finalIdKey + " ！"); } } else { - if (RequestMethod.isQueryMethod(method) == false) { - verifyId(method.name(), name, key, robj, finalIdKey, maxUpdateCount, true); + Boolean atLeastOne = tobj == null ? null : getBoolean(tobj, Operation.IS_ID_CONDITION_MUST.name()); + if (Boolean.TRUE.equals(atLeastOne) || RequestMethod.isUpdateMethod(method)) { + verifyId(method.name(), name, key, robj, finalIdKey, maxUpdateCount, atLeastOne != null ? atLeastOne : IS_UPDATE_MUST_HAVE_ID_CONDITION); - String userIdKey = idCallback == null ? null : idCallback.getUserIdKey(db, sh, key); - String finalUserIdKey = StringUtil.isEmpty(userIdKey, false) ? apijson.JSONObject.KEY_USER_ID : userIdKey; + String userIdKey = idCallback == null ? null : idCallback.getUserIdKey(db, sh, ds, key); + String finalUserIdKey = StringUtil.isEmpty(userIdKey, false) ? JSONMap.KEY_USER_ID : userIdKey; verifyId(method.name(), name, key, robj, finalUserIdKey, maxUpdateCount, false); } } } - return verifyRequest(method, key, tobj, robj, maxUpdateCount, database, schema, idCallback, creator); + return verifyRequest(method, key, tobj, robj, maxUpdateCount, database, schema, idCallback, parser); } @Override - protected JSONArray onParseJSONArray(String key, JSONArray tarray, JSONArray rarray) throws Exception { - if ((method == RequestMethod.POST || method == RequestMethod.PUT) && JSONRequest.isArrayKey(key)) { + protected L onParseJSONArray(String key, L tarray, L rarray) throws Exception { + if ((method == RequestMethod.POST || method == RequestMethod.PUT) && JSONMap.isArrayKey(key)) { if (rarray == null || rarray.isEmpty()) { throw new IllegalArgumentException(method + "请求，请在 " + name + " 内传 " + key + ":[{ ... }] " + "，批量新增 Table[]:value 中 value 必须是包含表对象的非空数组！其中每个子项 { ... } 都是" @@ -605,30 +737,32 @@ protected JSONArray onParseJSONArray(String key, JSONArray tarray, JSONArray rar * @param idKey * @param atLeastOne 至少有一个不为null */ - private static void verifyId(@NotNull String method, @NotNull String name, @NotNull String key - , @NotNull JSONObject robj, @NotNull String idKey, final int maxUpdateCount, boolean atLeastOne) { + private static , L extends List> void verifyId( + @NotNull String method, @NotNull String name, @NotNull String key + , @NotNull M robj, @NotNull String idKey, final int maxUpdateCount, boolean atLeastOne) throws Exception { //单个修改或删除 Object id = robj.get(idKey); //如果必须传 id ，可在Request表中配置NECESSARY if (id != null && id instanceof Number == false && id instanceof String == false) { throw new IllegalArgumentException(method + "请求，" + name + "/" + key - + " 里面的 " + idKey + ":value 中value的类型只能是 Long 或 String ！"); + + " 里面的 " + idKey + ":value 中value的类型只能是 Long 或 String ！"); } //批量修改或删除 String idInKey = idKey + "{}"; - - JSONArray idIn = null; + // id引用, 格式: "id{}@": "sql" + String idRefInKey = getString(robj, idKey + "{}@"); + L idIn = null; try { - idIn = robj.getJSONArray(idInKey); //如果必须传 id{} ，可在Request表中配置NECESSARY + idIn = JSON.get(robj, idInKey); //如果必须传 id{} ，可在Request表中配置NECESSARY } catch (Exception e) { throw new IllegalArgumentException(method + "请求，" + name + "/" + key + " 里面的 " + idInKey + ":value 中value的类型只能是 [Long] ！"); } if (idIn == null) { - if (atLeastOne && id == null) { + if (atLeastOne && id == null && idRefInKey == null) { throw new IllegalArgumentException(method + "请求，" + name + "/" + key - + " 里面 " + idKey + " 和 " + idInKey + " 至少传其中一个！"); + + " 里面 " + idKey + "," + idInKey + "," + (idKey + "{}@") + " 至少传其中一个！"); } } else { if (idIn.size() > maxUpdateCount) { //不允许一次操作 maxUpdateCount 条以上记录 @@ -659,7 +793,7 @@ else if (o instanceof String) { } else { throw new IllegalArgumentException(method + "请求，" + name + "/" + key - + " 里面的 " + idInKey + ":[] 中所有项的类型都只能是 Long 或 String ！"); + + " 里面的 " + idInKey + ":[] 中所有项的类型都只能是 Long 或 String ！"); } } } @@ -667,51 +801,54 @@ else if (o instanceof String) { /**校验并将response转换为指定的内容和结构 - * @param method - * @param name - * @param target - * @param response - * @param idKey - * @param callback - * @param creator - * @return - * @throws Exception - */ + * @param method + * @param name + * @param target + * @param response + * @param database + * @param schema + * @param parser + * @param callback + * @return + * @throws Exception + */ @Override - public JSONObject verifyResponse(@NotNull final RequestMethod method, final String name - , final JSONObject target, final JSONObject response, final String database, final String schema - , SQLCreator creator, OnParseCallback callback) throws Exception { - return verifyResponse(method, name, target, response, database, schema, this, creator, callback); + public M verifyResponse(@NotNull final RequestMethod method, final String name, final M target, final M response + , final String database, final String schema, @NotNull Parser parser, OnParseCallback callback) throws Exception { + return verifyResponse(method, name, target, response, database, schema, this, parser, callback); } /**校验并将response转换为指定的内容和结构 - * @param method - * @param name - * @param target - * @param response - * @param callback - * @param creator - * @return - * @throws Exception - */ - public static JSONObject verifyResponse(@NotNull final RequestMethod method, final String name - , final JSONObject target, final JSONObject response, SQLCreator creator, OnParseCallback callback) throws Exception { - return verifyResponse(method, name, target, response, null, null, null, creator, callback); + * @param method + * @param name + * @param target + * @param response + * @param parser + * @param callback + * @return + * @throws Exception + */ + public static , L extends List> M verifyResponse(@NotNull final RequestMethod method, final String name + , final M target, final M response, @NotNull Parser parser, OnParseCallback callback) throws Exception { + return verifyResponse(method, name, target, response, null, null, null, parser, callback); } /**校验并将response转换为指定的内容和结构 - * @param method - * @param name - * @param target - * @param response - * @param idKey - * @param callback - * @param creator - * @return - * @throws Exception - */ - public static JSONObject verifyResponse(@NotNull final RequestMethod method, final String name - , final JSONObject target, final JSONObject response, final String database, final String schema - , final IdCallback idKeyCallback, SQLCreator creator, OnParseCallback callback) throws Exception { + * @param method + * @param name + * @param target + * @param response + * @param database + * @param schema + * @param idKeyCallback + * @param parser + * @param callback + * @return + * @param + * @throws Exception + */ + public static , L extends List> M verifyResponse(@NotNull final RequestMethod method + , final String name, final M target, final M response, final String database, final String schema + , final IdCallback idKeyCallback, @NotNull Parser parser, OnParseCallback callback) throws Exception { Log.i(TAG, "verifyResponse method = " + method + "; name = " + name + "; target = \n" + JSON.toJSONString(target) @@ -723,7 +860,13 @@ public static JSONObject verifyResponse(@NotNull final RequestMethod method, fin } //解析 - return parse(method, name, target, response, database, schema, idKeyCallback, creator, callback != null ? callback : new OnParseCallback() {}); + return parse(method, name, target, response, database, schema + , idKeyCallback, parser, callback != null ? callback : new OnParseCallback() { + @Override + protected M onParseJSONObject(String key, M tobj, M robj) throws Exception { + return verifyResponse(method, key, tobj, robj, database, schema, idKeyCallback, parser, callback); + } + }); } @@ -732,48 +875,80 @@ public static JSONObject verifyResponse(@NotNull final RequestMethod method, fin * @param name * @param target * @param real - * @param creator + * @param parser * @param callback * @return * @throws Exception */ - public static JSONObject parse(@NotNull final RequestMethod method, String name, JSONObject target, JSONObject real - , SQLCreator creator, @NotNull OnParseCallback callback) throws Exception { - return parse(method, name, target, real, null, null, null, creator, callback); + public static , L extends List> M parse(@NotNull final RequestMethod method + , String name, M target, M real, @NotNull Parser parser, @NotNull OnParseCallback callback) throws Exception { + return parse(method, name, target, real, null, null, null, parser, callback); } - /**对request和response不同的解析用callback返回 * @param method * @param name * @param target * @param real - * @param idKey - * @param userIdKey - * @param creator + * @param database + * @param schema + * @param idCallback + * @param parser + * @param callback + * @return + * @throws Exception + */ + public static , L extends List> M parse( + @NotNull final RequestMethod method, String name, M target, M real, final String database, final String schema + , final IdCallback idCallback, @NotNull Parser parser, @NotNull OnParseCallback callback) throws Exception { + return parse(method, name, target, real, database, schema, null, idCallback, parser, callback); + } + /**对request和response不同的解析用callback返回 + * @param method + * @param name + * @param target + * @param real + * @param database + * @param schema + * @param datasource + * @param idCallback + * @param parser * @param callback * @return * @throws Exception */ - public static JSONObject parse(@NotNull final RequestMethod method, String name, JSONObject target, JSONObject real - , final String database, final String schema, final IdCallback idCallback, SQLCreator creator, @NotNull OnParseCallback callback) throws Exception { + public static , L extends List> M parse(@NotNull final RequestMethod method + , String name, M target, M real, final String database, final String schema, final String datasource + , final IdCallback idCallback, @NotNull Parser parser, @NotNull OnParseCallback callback) throws Exception { if (target == null) { return null; } // 获取配置<<<<<<<<<<<<<<<<<<<<<<<<<<<< - JSONObject type = target.getJSONObject(TYPE.name()); - JSONObject verify = target.getJSONObject(VERIFY.name()); - JSONObject insert = target.getJSONObject(INSERT.name()); - JSONObject update = target.getJSONObject(UPDATE.name()); - JSONObject replace = target.getJSONObject(REPLACE.name()); + M type = JSON.get(target, TYPE.name()); + M verify = JSON.get(target, VERIFY.name()); + M insert = JSON.get(target, INSERT.name()); + M update = JSON.get(target, UPDATE.name()); + M replace = JSON.get(target, REPLACE.name()); + + String exist = StringUtil.get(getString(target, EXIST.name())); + String unique = StringUtil.get(getString(target, UNIQUE.name())); + String remove = StringUtil.get(getString(target, REMOVE.name())); + String must = StringUtil.get(getString(target, MUST.name())); + String refuse = StringUtil.get(getString(target, REFUSE.name())); + + Object _if = target.get(IF.name()); + boolean ifIsStr = _if instanceof String && StringUtil.isNotEmpty(_if, true); + M ifObj = ifIsStr == false && _if instanceof Map ? (M) _if : null; +// : (_if instanceof String ? new apijson.JSONMap((String) _if, "" /* "throw new Error('')" */ ) : null); + if (ifObj == null && _if != null && ifIsStr == false) { +// if (_if instanceof List) { +// } + throw new IllegalArgumentException(name + ": { " + IF.name() + ": value } 中 value 类型错误！只允许 String, JSONRequest！"); + } + +// Object code = target.get(CODE.name()); - String exist = StringUtil.getNoBlankString(target.getString(EXIST.name())); - String unique = StringUtil.getNoBlankString(target.getString(UNIQUE.name())); - String remove = StringUtil.getNoBlankString(target.getString(REMOVE.name())); - String must = StringUtil.getNoBlankString(target.getString(MUST.name())); - String refuse = StringUtil.getNoBlankString(target.getString(REFUSE.name())); - String necessary = StringUtil.getNoBlankString(target.getString(NECESSARY.name())); - String disallow = StringUtil.getNoBlankString(target.getString(DISALLOW.name())); + String allowPartialUpdateFail = StringUtil.get(getString(target, ALLOW_PARTIAL_UPDATE_FAIL.name())); // 移除字段<<<<<<<<<<<<<<<<<<< @@ -787,208 +962,370 @@ public static JSONObject parse(@NotNull final RequestMethod method, String name, // 判断必要字段是否都有<<<<<<<<<<<<<<<<<<< String[] musts = StringUtil.split(must); - List mustList = musts == null ? new ArrayList() : Arrays.asList(musts); - for (String s : mustList) { - if (real.get(s) == null) { // 可能传null进来，这里还会通过 real.containsKey(s) == false) { - throw new IllegalArgumentException(method + "请求，" + name - + " 里面不能缺少 " + s + " 等[" + must + "]内的任何字段！"); - } - } + Set mustSet = new HashSet(); - String[] necessarys = StringUtil.split(necessary); - List necessaryList = necessarys == null ? new ArrayList() : Arrays.asList(necessarys); - for (String s : necessaryList) { - if (real.get(s) == null) {//可能传null进来，这里还会通过 real.containsKey(s) == false) { - throw new IllegalArgumentException(method + "请求，" + name - + " 里面不能缺少 " + s + " 等[" + necessary + "]内的任何字段！"); + if (musts != null && musts.length > 0) { + for (String s : musts) { + if (real.get(s) == null && real.get(s+"@") == null) { // 可能传null进来，这里还会通过 real.containsKey(s) == false) { + throw new IllegalArgumentException(method + "请求，" + + name + " 里面不能缺少 " + s + " 等[" + must + "]内的任何字段！"); + } + + mustSet.add(s); } } - //判断必要字段是否都有>>>>>>>>>>>>>>>>>>> + // 判断必要字段是否都有>>>>>>>>>>>>>>>>>>> - Set objKeySet = new HashSet(); //不能用tableKeySet，仅判断 Table:{} 会导致 key:{ Table:{} } 绕过判断 + Set objKeySet = new HashSet(); // 不能用tableKeySet，仅判断 Table:{} 会导致 key:{ Table:{} } 绕过判断 - //解析内容<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< + // 解析内容<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<< - Set> set = new LinkedHashSet<>(target.entrySet()); + Set> set = new LinkedHashSet<>(target.entrySet()); if (set.isEmpty() == false) { - String key; - Object tvalue; - Object rvalue; - for (Entry entry : set) { - key = entry == null ? null : entry.getKey(); + for (Map.Entry entry : set) { + String key = entry == null ? null : entry.getKey(); if (key == null || OPERATION_KEY_LIST.contains(key)) { continue; } - tvalue = entry.getValue(); - rvalue = real.get(key); + Object tvalue = entry.getValue(); + Object rvalue = real.get(key); if (callback.onParse(key, tvalue, rvalue) == false) { continue; } - if (tvalue instanceof JSONObject) { //JSONObject，往下一级提取 - if (rvalue != null && rvalue instanceof JSONObject == false) { - throw new UnsupportedDataTypeException(key + ":value 的value不合法！类型必须是 OBJECT ，结构为 {} !"); + if (tvalue instanceof Map) { // JSONRequest，往下一级提取 + if (rvalue != null && rvalue instanceof Map == false) { + throw new UnsupportedDataTypeException(key + ":value 的 value 不合法！类型必须是 OBJECT ，结构为 {} !"); } - tvalue = callback.onParseJSONObject(key, (JSONObject) tvalue, (JSONObject) rvalue); + tvalue = callback.onParseJSONObject(key, (M) tvalue, (M) rvalue); objKeySet.add(key); - } else if (tvalue instanceof JSONArray) { //JSONArray - if (rvalue != null && rvalue instanceof JSONArray == false) { - throw new UnsupportedDataTypeException(key + ":value 的value不合法！类型必须是 ARRAY ，结构为 [] !"); + } else if (tvalue instanceof List) { // L + if (rvalue != null && rvalue instanceof List == false) { + throw new UnsupportedDataTypeException(key + ":value 的 value 不合法！类型必须是 ARRAY ，结构为 [] !"); } - tvalue = callback.onParseJSONArray(key, (JSONArray) tvalue, (JSONArray) rvalue); + tvalue = callback.onParseJSONArray(key, (L) tvalue, (L) rvalue); - if ((method == RequestMethod.POST || method == RequestMethod.PUT) && JSONRequest.isArrayKey(key)) { + if ((method == RequestMethod.POST || method == RequestMethod.PUT) && JSONMap.isArrayKey(key)) { objKeySet.add(key); } - } else {//其它Object + } else { // 其它Object tvalue = callback.onParseObject(key, tvalue, rvalue); } - if (tvalue != null) {//可以在target中加上一些不需要客户端传的键值对 + if (tvalue != null) { // 可以在target中加上一些不需要客户端传的键值对 real.put(key, tvalue); } } } - //解析内容>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>> + // 解析内容>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>> - Set rkset = real.keySet(); //解析内容并没有改变rkset + Set rkset = real.keySet(); // 解析内容并没有改变rkset - //解析不允许的字段<<<<<<<<<<<<<<<<<<< - List refuseList = new ArrayList(); - if ("!".equals(refuse)) {//所有非 must，改成 !must 更好 - for (String key : rkset) {//对@key放行，@role,@column,自定义@position等 - if (key != null && key.startsWith("@") == false - && mustList.contains(key) == false && objKeySet.contains(key) == false) { - refuseList.add(key); + // 解析不允许的字段<<<<<<<<<<<<<<<<<<< + String[] refuses = StringUtil.split(refuse); + Set refuseSet = new HashSet(); + + if (refuses != null && refuses.length > 0) { + Set notRefuseSet = new HashSet(); + + for (String rfs : refuses) { + if (rfs == null) { // StringUtil.isEmpty(rfs, true) { + continue; } - } - } else { - String[] refuses = StringUtil.split(refuse); - if (refuses != null && refuses.length > 0) { - refuseList.addAll(Arrays.asList(refuses)); - } - } - List disallowList = new ArrayList(); - if ("!".equals(disallow)) {//所有非necessary，改成 !necessary 更好 - for (String key : rkset) {//对@key放行，@role,@column,自定义@position等 - if (key != null && key.startsWith("@") == false - && necessaryList.contains(key) == false && objKeySet.contains(key) == false) { - disallowList.add(key); + if (rfs.startsWith("!")) { + rfs = rfs.substring(1); + + if (notRefuseSet.contains(rfs)) { + throw new ConflictException(REFUSE.name() + ":value 中出现了重复的 !" + + rfs + " ！不允许重复，也不允许一个 key 和取反 !key 同时使用！"); + } + if (refuseSet.contains(rfs)) { + throw new ConflictException(REFUSE.name() + ":value 中同时出现了 " + + rfs + " 和 !" + rfs + " ！不允许重复，也不允许一个 key 和取反 !key 同时使用！"); + } + + if (rfs.equals("")) { // 所有非 MUST + // 对@key放行，@role,@column,自定义@position等， @key:{ "Table":{} } 不会解析内部 + for (String key : rkset) { + if (key == null || key.startsWith("@") || notRefuseSet.contains(key) + || mustSet.contains(key) || objKeySet.contains(key)) { + continue; + } + // 支持id ref: id{}@ + if (key.endsWith("@") && mustSet.contains(key.substring(0, key.length() - 1))) { + continue; + } + refuseSet.add(key); + } + } + else { // 排除 !key 后再禁传其它的 + notRefuseSet.add(rfs); + } + } + else { + if (refuseSet.contains(rfs)) { + throw new ConflictException(REFUSE.name() + ":value 中出现了重复的 " + rfs + " ！" + + "不允许重复，也不允许一个 key 和取反 !key 同时使用！"); + } + if (notRefuseSet.contains(rfs)) { + throw new ConflictException(REFUSE.name() + ":value 中同时出现了 " + rfs + " 和 !" + rfs + " ！" + + "不允许重复，也不允许一个 key 和取反 !key 同时使用！"); + } + + refuseSet.add(rfs); } - } - } else { - String[] disallows = StringUtil.split(disallow); - if (disallows != null && disallows.length > 0) { - disallowList.addAll(Arrays.asList(disallows)); } } - //解析不允许的字段>>>>>>>>>>>>>>>>>>> + // 解析不允许的字段>>>>>>>>>>>>>>>>>>> - //判断不允许传的key<<<<<<<<<<<<<<<<<<<<<<<<< + Set onKeys = new LinkedHashSet<>(); + + // 判断不允许传的key<<<<<<<<<<<<<<<<<<<<<<<<< for (String rk : rkset) { - if (refuseList.contains(rk)) { //不允许的字段 - throw new IllegalArgumentException(method + "请求，" + name - + " 里面不允许传 " + rk + " 等" + StringUtil.getString(refuseList) + "内的任何字段！"); + if (rk == null) { // 无效的key + real.remove(rk); + continue; } - if (disallowList.contains(rk)) { //不允许的字段 + + if (refuseSet.contains(rk)) { // 不允许的字段 throw new IllegalArgumentException(method + "请求，" + name - + " 里面不允许传 " + rk + " 等" + StringUtil.getString(disallowList) + "内的任何字段！"); + + " 里面不允许传 " + rk + " 等" + StringUtil.get(refuseSet) + "内的任何字段！"); } - if (rk == null) { //无效的key - real.remove(rk); - continue; + if (KEY_COMBINE.equals(rk)) { + throw new UnsupportedOperationException(method + " 请求，" + rk + " 不合法！" + + "非开放请求不允许传 " + KEY_COMBINE + ":value ！"); + } + if (KEY_KEY.equals(rk)) { + throw new UnsupportedOperationException(method + " 请求，" + rk + " 不合法！" + + "非开放请求不允许传 " + KEY_KEY + ":value ！"); } Object rv = real.get(rk); - //不允许传远程函数，只能后端配置 + // 不允许传远程函数，只能后端配置 if (rk.endsWith("()") && rv instanceof String) { - throw new UnsupportedOperationException(method + " 请求，" + rk + " 不合法！非开放请求不允许传远程函数 key():\"fun()\" ！"); + throw new UnsupportedOperationException(method + " 请求，" + rk + " 不合法！" + + "非开放请求不允许传远程函数 key():\"fun()\" ！"); } - //不在target内的 key:{} - if (rk.startsWith("@") == false && objKeySet.contains(rk) == false) { - if (rv instanceof JSONObject) { - throw new UnsupportedOperationException(method + " 请求，" +name + " 里面不允许传 " + rk + ":{} ！"); + // 不在target内的 key:{} + if (rk.startsWith("@") == false && rk.endsWith("@") == false && objKeySet.contains(rk) == false) { + if (rv instanceof Map) { + throw new UnsupportedOperationException(method + " 请求，" + + name + " 里面不允许传 " + rk + ":{} ！"); } - if ((method == RequestMethod.POST || method == RequestMethod.PUT) && rv instanceof JSONArray && JSONRequest.isArrayKey(rk)) { - throw new UnsupportedOperationException(method + " 请求，" + name + " 里面不允许 " + rk + ":[] 等未定义的 Table[]:[{}] 批量操作键值对！"); + if ((method == RequestMethod.POST || method == RequestMethod.PUT) + && rv instanceof List && JSONMap.isArrayKey(rk)) { + throw new UnsupportedOperationException(method + " 请求，" + name + " 里面不允许 " + + rk + ":[] 等未定义的 Table[]:[{}] 批量操作键值对！"); } } + + // 先让其它操作符完成 +// if (rv != null) { // || nulls.contains(rk)) { +// onKeys.add(rk); +// } } - //判断不允许传的key>>>>>>>>>>>>>>>>>>>>>>>>> + // 判断不允许传的key>>>>>>>>>>>>>>>>>>>>>>>>> - //校验与修改Request<<<<<<<<<<<<<<<<< - //在tableKeySet校验后操作，避免 导致put/add进去的Table 被当成原Request的内容 - real = operate(TYPE, type, real, creator); - real = operate(VERIFY, verify, real, creator); - real = operate(INSERT, insert, real, creator); - real = operate(UPDATE, update, real, creator); - real = operate(REPLACE, replace, real, creator); - //校验与修改Request>>>>>>>>>>>>>>>>> + // 校验与修改Request<<<<<<<<<<<<<<<<< + // 在tableKeySet校验后操作，避免 导致put/add进去的Table 被当成原Request的内容 + real = operate(TYPE, type, real, parser); + real = operate(VERIFY, verify, real, parser); + real = operate(INSERT, insert, real, parser); + real = operate(UPDATE, update, real, parser); + real = operate(REPLACE, replace, real, parser); + // 校验与修改Request>>>>>>>>>>>>>>>>> - String db = real.getString(apijson.JSONObject.KEY_DATABASE); - String sh = real.getString(apijson.JSONObject.KEY_SCHEMA); + String db = getString(real, JSONMap.KEY_DATABASE); + String sh = getString(real, JSONMap.KEY_SCHEMA); + String ds = getString(real, JSONMap.KEY_DATASOURCE); if (StringUtil.isEmpty(db, false)) { db = database; } if (StringUtil.isEmpty(sh, false)) { sh = schema; } - String idKey = idCallback == null ? null : idCallback.getIdKey(db, sh, name); - String finalIdKey = StringUtil.isEmpty(idKey, false) ? apijson.JSONObject.KEY_ID : idKey; + if (StringUtil.isEmpty(ds, false)) { + ds = datasource; + } + String idKey = idCallback == null ? null : idCallback.getIdKey(db, sh, ds, name); + String finalIdKey = StringUtil.isEmpty(idKey, false) ? JSONMap.KEY_ID : idKey; - //TODO放在operate前？考虑性能、operate修改后再验证的值是否和原来一样 - //校验存在<<<<<<<<<<<<<<<<<<< TODO 格式改为 id;version,tag 兼容多个字段联合主键 + // TODO 放在operate前？考虑性能、operate修改后再验证的值是否和原来一样 + // 校验存在<<<<<<<<<<<<<<<<<<< String[] exists = StringUtil.split(exist); if (exists != null && exists.length > 0) { - long exceptId = real.getLongValue(finalIdKey); + long exceptId = getLongValue(real, finalIdKey); + Map map = new HashMap<>(); for (String e : exists) { - verifyExist(name, e, real.get(e), exceptId, creator); + map.put(e,real.get(e)); } + verifyExist(name, map, exceptId, parser); } - //校验存在>>>>>>>>>>>>>>>>>>> + // 校验存在>>>>>>>>>>>>>>>>>>> - //TODO放在operate前？考虑性能、operate修改后再验证的值是否和原来一样 - //校验重复<<<<<<<<<<<<<<<<<<< TODO 格式改为 id;version,tag 兼容多个字段联合主键 + // TODO 放在operate前？考虑性能、operate修改后再验证的值是否和原来一样 + // 校验重复<<<<<<<<<<<<<<<<<<< String[] uniques = StringUtil.split(unique); if (uniques != null && uniques.length > 0) { - long exceptId = real.getLongValue(finalIdKey); + long exceptId = getLongValue(real, finalIdKey); + Map map = new HashMap<>(); for (String u : uniques) { - verifyRepeat(name, u, real.get(u), exceptId, finalIdKey, creator); + map.put(u, real.get(u)); + } + verifyRepeat(name, map, exceptId, finalIdKey, parser); + } + // 校验重复>>>>>>>>>>>>>>>>>>> + + // 校验并配置允许批量增删改部分失败<<<<<<<<<<<<<<<<<<< + String[] partialFails = StringUtil.split(allowPartialUpdateFail); + if (partialFails != null && partialFails.length > 0) { + for (String key : partialFails) { + if (JSONMap.isArrayKey(key) == false) { + throw new IllegalArgumentException("后端 Request 表中 " + ALLOW_PARTIAL_UPDATE_FAIL.name() + + ":value 中 " + key + " 不合法！必须以 [] 结尾！"); + } + if (target.get(key) instanceof Collection == false) { + throw new IllegalArgumentException("后端 Request 表中 " + ALLOW_PARTIAL_UPDATE_FAIL.name() + + ":value 中 " + key + " 对应的 " + key + ":[] 不存在！"); + } + + // 可能 Table[] 和 Table:alias[] 冲突 int index = key.indexOf(":"); + // String k = index < 0 ? key.substring(0, key.length() - 2) : key.substring(0, index); + String k = key.substring(0, key.length() - 2); + if (k.isEmpty()) { + throw new IllegalArgumentException("后端 Request 表中 " + ALLOW_PARTIAL_UPDATE_FAIL.name() + + ":value 中 " + key + " 不合法！[] 前必须有名字！"); + } + + AbstractSQLConfig.ALLOW_PARTIAL_UPDATE_FAIL_TABLE_MAP.putIfAbsent(k, ""); } } - //校验重复>>>>>>>>>>>>>>>>>>> + // 校验并配置允许部分批量增删改失败>>>>>>>>>>>>>>>>>>> + + + String[] nks = ifObj == null ? null : StringUtil.split(getString(real, JSONMap.KEY_NULL)); + Collection nkl = nks == null || nks.length <= 0 ? new HashSet<>() : Arrays.asList(nks); + + Set> ifSet = ifObj == null ? null : ifObj.entrySet(); + if (ifIsStr || (ifSet != null && ifSet.isEmpty() == false)) { + // 没必要限制，都是后端配置的，安全可控，而且可能确实有特殊需求，需要 id, @column 等 +// List condKeys = new ArrayList<>(Arrays.asList(apijson.JSONMap.KEY_ID, apijson.JSONMap.KEY_ID_IN +// , apijson.JSONMap.KEY_USER_ID, apijson.JSONMap.KEY_USER_ID_IN)); +// condKeys.addAll(apijson.JSONMap.TABLE_KEY_LIST); + + String preCode = "var curObj = " + JSON.toJSONString(real) + ";"; + + // 未传的 key 在后面 eval 时总是报错 undefined，而且可能有冲突，例如对象里有 "curObj": val 键值对，就会覆盖当前对象定义，还不如都是 curObj.sex 这样取值 +// Set> rset = real.entrySet(); +// for (Map.Entry entry : rset) { +// String k = entry == null ? null : entry.getKey(); +// if (StringUtil.isEmpty(k)) { +// continue; +// } +// String vn = JSONResponse.formatOtherKey(k); +// if (StringUtil.isName(vn) == false) { // 通过 curObj['id@'] 这样取值，写在 IF 配置里 +// continue; +// } +// +// Object v = entry.getValue(); +// String vs = v instanceof String ? "\"" + ((String) v).replaceAll("\"", "\\\"") + "\"" +// : (JSON.isBooleanOrNumberOrString(v) ? v.toString() : JSON.format(v)); +// preCode += "\nvar " + vn + " = " + vs + ";"; +// } + + if (ifIsStr) { + String ifStr = (String) _if; + int ind = ifStr.indexOf(":"); + String lang = ind < 0 || ind > 20 ? null : ifStr.substring(0, ind); + boolean isName = StringUtil.isName(lang); + ScriptEngine engine = getScriptEngine(isName ? lang : null); + engine.eval(preCode + "\n" + (isName ? ifStr.substring(ind + 1) : ifStr)); + } + else { + for (Map.Entry entry : ifSet) { + String k = entry == null ? null : entry.getKey(); +// if (condKeys.contains(k)) { +// throw new IllegalArgumentException("Request 表 structure 配置的 " + ON.name() +// + ":{ " + k + ":value } 中 key 不合法，不允许传 [" + StringUtil.join(condKeys.toArray(new String[]{})) + "] 中的任何一个 ！"); +// } + + Object v = k == null ? null : entry.getValue(); + if (v instanceof String) { + int ind = k.indexOf(":"); + String lang = ind < 0 || ind > 20 ? null : k.substring(0, ind); + boolean isName = StringUtil.isName(lang); + ScriptEngine engine = getScriptEngine(isName ? lang : null); + k = isName ? k.substring(ind + 1) : k; + + boolean isElse = StringUtil.isEmpty(k, false); // 其它直接报错，不允许传 StringUtil.isEmpty(k, true) || "ELSE".equals(k); +// String code = preCode + "\n\n" + (StringUtil.isEmpty(v, false) ? k : (isElse ? v : "if (" + k + ") {\n " + v + "\n}")); + String code = preCode + "\n\n" + (isElse ? v : "if (" + k + ") {\n " + v + "\n}"); + +// ScriptExecutor executor = new JavaScriptExecutor(); +// executor.execute(null, real, ) + + engine.eval(code); + +// PARSER_CREATOR.createFunctionParser() +// .setCurrentObject(real) +// .setKey(k) +// .setMethod(method) +// .invoke() + continue; + } + if (v instanceof Map == false) { + throw new IllegalArgumentException("Request 表 structure 配置的 " + IF.name() + + ":{ " + k + ":value } 中 value 不合法，必须是 JSONRequest {} ！"); + } + if (nkl.contains(k) || real.get(k) != null) { + real = parse(method, name, (M) v, real, database, schema, datasource, idCallback, parser, callback); + } + } + } + } Log.i(TAG, "parse return real = " + JSON.toJSONString(real)); return real; } + public static ScriptEngine getScriptEngine(String lang) { + boolean isEmpty = StringUtil.isEmpty(lang, true); + ScriptEngine engine = isEmpty ? SCRIPT_ENGINE : SCRIPT_ENGINE_MANAGER.getEngineByName(lang); + + if (engine == null) { + throw new NullPointerException("找不到可执行 " + (isEmpty ? "js" : lang) + " 脚本的引擎！engine == null!"); + } + + return engine; + } /**执行操作 * @param opt * @param targetChild * @param real - * @param creator + * @param parser * @return * @throws Exception */ - private static JSONObject operate(Operation opt, JSONObject targetChild, JSONObject real, SQLCreator creator) throws Exception { + private static , L extends List> M operate(Operation opt, M targetChild + , M real, @NotNull Parser parser) throws Exception { if (targetChild == null) { return real; } @@ -996,24 +1333,20 @@ private static JSONObject operate(Operation opt, JSONObject targetChild, JSONObj throw new IllegalArgumentException("operate real == null!!!"); } - - Set> set = new LinkedHashSet<>(targetChild.entrySet()); - String tk; - Object tv; - - for (Entry e : set) { - tk = e == null ? null : e.getKey(); + Set> set = new LinkedHashSet<>(targetChild.entrySet()); + for (Map.Entry e : set) { + String tk = e == null ? null : e.getKey(); if (tk == null || OPERATION_KEY_LIST.contains(tk)) { continue; } - - tv = e.getValue(); + + Object tv = e.getValue(); if (opt == TYPE) { verifyType(tk, tv, real); } else if (opt == VERIFY) { - verifyValue(tk, tv, real, creator); + verifyValue(tk, tv, real, parser); } else if (opt == UPDATE) { real.put(tk, tv); @@ -1042,7 +1375,8 @@ else if (opt == UPDATE) { * @param real * @throws Exception */ - public static void verifyType(@NotNull String tk, Object tv, @NotNull JSONObject real) throws UnsupportedDataTypeException { + public static void verifyType(@NotNull String tk, Object tv, @NotNull Map real) + throws UnsupportedDataTypeException { if (tv instanceof String == false) { throw new UnsupportedDataTypeException("服务器内部错误，" + tk + ":value 的value不合法！" + "Request表校验规则中 TYPE:{ key:value } 中的value只能是String类型！"); @@ -1056,7 +1390,8 @@ public static void verifyType(@NotNull String tk, Object tv, @NotNull JSONObject * @param rv * @throws Exception */ - public static void verifyType(@NotNull String tk, @NotNull String tv, Object rv) throws UnsupportedDataTypeException { + public static void verifyType(@NotNull String tk, @NotNull String tv, Object rv) + throws UnsupportedDataTypeException { verifyType(tk, tv, rv, false); } /**验证值类型 @@ -1066,13 +1401,13 @@ public static void verifyType(@NotNull String tk, @NotNull String tv, Object rv) * @param isInArray * @throws Exception */ - public static void verifyType(@NotNull String tk, @NotNull String tv, Object rv, boolean isInArray) throws UnsupportedDataTypeException { + public static void verifyType(@NotNull String tk, @NotNull String tv, Object rv, boolean isInArray) + throws UnsupportedDataTypeException { if (rv == null) { return; } if (tv.endsWith("[]")) { - verifyType(tk, "ARRAY", rv); for (Object o : (Collection) rv) { @@ -1084,8 +1419,8 @@ public static void verifyType(@NotNull String tk, @NotNull String tv, Object rv, //这里不抽取 enum，因为 enum 不能满足扩展需求，子类需要可以自定义，而且 URL[] 这种也不符合命名要求，得用 constructor + getter + setter switch (tv) { - case "BOOLEAN": //Boolean.parseBoolean(real.getString(tk)); 只会判断null和true - if (rv instanceof Boolean == false) { //JSONObject.getBoolean 可转换Number类型 + case "BOOLEAN": //Boolean.parseBoolean(getString(real, tk)); 只会判断null和true + if (rv instanceof Boolean == false) { //apijson.JSONMap.getBoolean 可转换Number类型 throw new UnsupportedDataTypeException(tk + ":value 的value不合法！类型必须是 BOOLEAN" + (isInArray ? "[] !" : " !")); } break; @@ -1100,56 +1435,64 @@ public static void verifyType(@NotNull String tk, @NotNull String tv, Object rv, try { Double.parseDouble(rv.toString()); } catch (Exception e) { - throw new UnsupportedDataTypeException(tk + ":value 的value不合法！类型必须是 DECIMAL" + (isInArray ? "[] !" : " !")); + throw new UnsupportedDataTypeException(tk + ":value 的value不合法！" + + "类型必须是 DECIMAL" + (isInArray ? "[] !" : " !")); } break; case "STRING": - if (rv instanceof String == false) { //JSONObject.getString 可转换任何类型 - throw new UnsupportedDataTypeException(tk + ":value 的value不合法！类型必须是 STRING" + (isInArray ? "[] !" : " !")); + if (rv instanceof String == false) { //apijson.JSONMap.getString 可转换任何类型 + throw new UnsupportedDataTypeException(tk + ":value 的value不合法！" + + "类型必须是 STRING" + (isInArray ? "[] !" : " !")); } break; case "URL": //网址，格式为 http://www.apijson.org, https://www.google.com 等 try { new URL((String) rv); } catch (Exception e) { - throw new UnsupportedDataTypeException(tk + ":value 的value不合法！类型必须是 URL" + (isInArray ? "[] !" : " !")); + throw new UnsupportedDataTypeException(tk + ":value 的value不合法！" + + "类型必须是 URL" + (isInArray ? "[] !" : " !")); } break; case "DATE": //日期，格式为 YYYY-MM-DD（例如 2020-02-20）的 STRING try { LocalDate.parse((String) rv); } catch (Exception e) { - throw new UnsupportedDataTypeException(tk + ":value 的value不合法！类型必须是格式为 YYYY-MM-DD（例如 2020-02-20）的 DATE" + (isInArray ? "[] !" : " !")); + throw new UnsupportedDataTypeException(tk + ":value 的value不合法！" + + "类型必须是格式为 YYYY-MM-DD（例如 2020-02-20）的 DATE" + (isInArray ? "[] !" : " !")); } break; case "TIME": //时间，格式为 HH:mm:ss（例如 12:01:30）的 STRING try { LocalTime.parse((String) rv); } catch (Exception e) { - throw new UnsupportedDataTypeException(tk + ":value 的value不合法！类型必须是格式为 HH:mm:ss（例如 12:01:30）的 TIME" + (isInArray ? "[] !" : " !")); + throw new UnsupportedDataTypeException(tk + ":value 的value不合法！" + + "类型必须是格式为 HH:mm:ss（例如 12:01:30）的 TIME" + (isInArray ? "[] !" : " !")); } break; case "DATETIME": //日期+时间，格式为 YYYY-MM-DDTHH:mm:ss（例如 2020-02-20T12:01:30）的 STRING try { LocalDateTime.parse((String) rv); } catch (Exception e) { - throw new UnsupportedDataTypeException(tk + ":value 的value不合法！类型必须是格式为 YYYY-MM-DDTHH:mm:ss（例如 2020-02-20T12:01:30）的 DATETIME" + (isInArray ? "[] !" : " !")); + throw new UnsupportedDataTypeException(tk + ":value 的value不合法！类型必须是格式为 " + + "YYYY-MM-DDTHH:mm:ss（例如 2020-02-20T12:01:30）的 DATETIME" + (isInArray ? "[] !" : " !")); } break; case "OBJECT": - if (rv instanceof Map == false) { //JSONObject.getJSONObject 可转换String类型 - throw new UnsupportedDataTypeException(tk + ":value 的value不合法！类型必须是 OBJECT" + (isInArray ? "[] !" : " !") + " OBJECT 结构为 {} !"); + if (rv instanceof Map == false) { //apijson.JSONMap.getJSONObject 可转换String类型 + throw new UnsupportedDataTypeException(tk + ":value 的value不合法！" + + "类型必须是 OBJECT" + (isInArray ? "[] !" : " !") + " OBJECT 结构为 {} !"); } break; case "ARRAY": - if (rv instanceof Collection == false) { //JSONObject.getJSONArray 可转换String类型 - throw new UnsupportedDataTypeException(tk + ":value 的value不合法！类型必须是 ARRAY" + (isInArray ? "[] !" : " !") + " ARRAY 结构为 [] !"); + if (rv instanceof Collection == false) { //apijson.JSONMap.getJSONArray 可转换String类型 + throw new UnsupportedDataTypeException(tk + ":value 的value不合法！" + + "类型必须是 ARRAY" + (isInArray ? "[] !" : " !") + " ARRAY 结构为 [] !"); } break; //目前在业务表中还用不上，单一的类型校验已经够用 // case "JSON": // try { - // com.alibaba.fastjson.JSON.parse(rv.toString()); + // com.alibaba.fastjson.parseJSON(rv.toString()); // } catch (Exception e) { // throw new UnsupportedDataTypeException(tk + ":value 的value不合法！类型必须是 JSON ！" // + "也就是 {Object}, [Array] 或 它们对应的字符串 '{Object}', '[Array]' 4种中的一个 !"); @@ -1169,10 +1512,11 @@ public static void verifyType(@NotNull String tk, @NotNull String tv, Object rv, * @param tk * @param tv * @param real - * @param creator + * @param parser * @throws Exception */ - private static void verifyValue(@NotNull String tk, @NotNull Object tv, @NotNull JSONObject real, SQLCreator creator) throws Exception { + private static , L extends List> void verifyValue(@NotNull String tk + , @NotNull Object tv, @NotNull M real, @NotNull Parser parser) throws Exception { if (tv == null) { throw new IllegalArgumentException("operate operate == VERIFY " + tk + ":" + tv + " , >> tv == null!!!"); } @@ -1181,7 +1525,7 @@ private static void verifyValue(@NotNull String tk, @NotNull Object tv, @NotNull Object rv; Logic logic; if (tk.endsWith("$")) { // 模糊搜索 - verifyCondition("$", real, tk, tv, creator); + verifyCondition("$", real, tk, tv, parser); } else if (tk.endsWith("~")) { // 正则匹配 logic = new Logic(tk.substring(0, tk.length() - 1)); @@ -1191,7 +1535,7 @@ else if (tk.endsWith("~")) { // 正则匹配 return; } - JSONArray array = AbstractSQLConfig.newJSONArray(tv); + L array = AbstractSQLConfig.newJSONArray(tv); boolean m; boolean isOr = false; @@ -1226,9 +1570,9 @@ else if (tk.endsWith("~")) { // 正则匹配 } else if (tk.endsWith("{}")) { //rv符合tv条件或在tv内 if (tv instanceof String) {//TODO >= 0, < 10 - verifyCondition("{}", real, tk, tv, creator); + verifyCondition("{}", real, tk, tv, parser); } - else if (tv instanceof JSONArray) { + else if (tv instanceof List) { logic = new Logic(tk.substring(0, tk.length() - 2)); rk = logic.getKey(); rv = real.get(rk); @@ -1236,7 +1580,7 @@ else if (tv instanceof JSONArray) { return; } - if (((JSONArray) tv).contains(rv) == logic.isNot()) { + if (((L) tv).contains(rv) == logic.isNot()) { throw new IllegalArgumentException(rk + ":value 中value不合法！必须匹配 " + tk + ":" + tv + " !"); } } @@ -1244,6 +1588,26 @@ else if (tv instanceof JSONArray) { throw new UnsupportedDataTypeException("服务器Request表verify配置错误！"); } } + else if (tk.endsWith("{L}")) { //字符串长度 + if (tv instanceof String) { + logic = new Logic(tk.substring(0, tk.length() - 3)); + + rk = logic.getKey(); + rv = real.get(rk); + if (rv == null) { + return; + } + String[] tvs = tv.toString().split(","); + for (String tvItem : tvs) { + if (!verifyRV(tvItem,rv.toString())) { + throw new IllegalArgumentException(rk + ":value 中value长度不合法！必须匹配 " + tk + ":" + tv + " !"); + } + } + } + else { + throw new UnsupportedDataTypeException("服务器Request表verify配置错误！"); + } + } else if (tk.endsWith("<>")) { //rv包含tv内的值 logic = new Logic(tk.substring(0, tk.length() - 2)); rk = logic.getKey(); @@ -1252,15 +1616,15 @@ else if (tk.endsWith("<>")) { //rv包含tv内的值 return; } - if (rv instanceof JSONArray == false) { + if (rv instanceof Collection == false) { throw new UnsupportedDataTypeException("服务器Request表verify配置错误！"); } - JSONArray array = AbstractSQLConfig.newJSONArray(tv); + L array = AbstractSQLConfig.newJSONArray(tv); boolean isOr = false; for (Object o : array) { - if (((JSONArray) rv).contains(o)) { + if (((L) rv).contains(o)) { if (logic.isNot()) { throw new IllegalArgumentException(rk + ":value 中value不合法！必须匹配 " + tk + ":" + tv + " !"); } @@ -1284,16 +1648,56 @@ else if (tk.endsWith("<>")) { //rv包含tv内的值 } } + /** + * 校验字符串长度 + * + * @param rule 规则 + * @param content 内容 + * @return + * @throws UnsupportedDataTypeException + */ + private static boolean verifyRV(String rule,String content) throws UnsupportedDataTypeException { + String first = null; + String second = null; + Matcher matcher = VERIFY_LENGTH_PATTERN.matcher(rule); + while (matcher.find()) { + first = StringUtil.isEmpty(first)?matcher.group("first"):first; + second = StringUtil.isEmpty(second)?matcher.group("second"):second; + } + // first和second为空表示规则不合法 + if(StringUtil.isEmpty(first) || StringUtil.isEmpty(second)){ + throw new UnsupportedDataTypeException("服务器Request表verify配置错误！"); + } + + int secondNum = Integer.parseInt(second); + switch (Objects.requireNonNull(first)){ + case ">": + return content.length() > secondNum; + case ">=": + return content.length() >= secondNum; + case "<": + return content.length() < secondNum; + case "<=": + return content.length() <= secondNum; + case "<>": + return content.length() != secondNum; + default: + } + // 出现不能识别的符号也认为规则不合法 + throw new UnsupportedDataTypeException("服务器Request表verify配置错误！"); + } + /**通过数据库执行SQL语句来验证条件 * @param funChar * @param real * @param tk * @param tv - * @param creator + * @param parser * @throws Exception */ - private static void verifyCondition(@NotNull String funChar, @NotNull JSONObject real, @NotNull String tk, @NotNull Object tv - , @NotNull SQLCreator creator) throws Exception { + private static , L extends List> void verifyCondition( + @NotNull String funChar, @NotNull M real, @NotNull String tk, @NotNull Object tv + , @NotNull Parser parser) throws Exception { //不能用Parser, 0 这种不符合 StringUtil.isName ! Logic logic = new Logic(tk.substring(0, tk.length() - funChar.length())); String rk = logic.getKey(); @@ -1306,21 +1710,24 @@ private static void verifyCondition(@NotNull String funChar, @NotNull JSONObject throw new IllegalArgumentException(rk + ":value 中value不合法！value 中不允许有单引号 ' ！"); } - SQLConfig config = creator.createSQLConfig().setMethod(RequestMethod.GET).setCount(1).setPage(0); + SQLConfig config = parser.createSQLConfig().setMethod(RequestMethod.GET).setCount(1).setPage(0); config.setTest(true); // config.setTable(Test.class.getSimpleName()); // config.setColumn(rv + logic.getChar() + funChar) - config.putWhere(rv + logic.getChar() + funChar, tv, false); // 字符串可能 SQL 注入，目前的解决方式是加 TYPE 校验类型或者干脆不用 sqlVerify，而是通过远程函数来校验 + // 字符串可能 SQL 注入，目前的解决方式是加 TYPE 校验类型或者干脆不用 sqlVerify，而是通过远程函数来校验 + config.putWhere(rv + logic.getChar() + funChar, tv, false); config.setCount(1); - SQLExecutor executor = creator.createSQLExecutor(); - JSONObject result = null; + SQLExecutor executor = parser.createSQLExecutor(); // close 后复用导致不好修复的 NPE getSQLExecutor(); + executor.setParser(parser); + M result; try { result = executor.execute(config, false); } finally { executor.close(); } - if (result != null && JSONResponse.isExist(result.getIntValue(JSONResponse.KEY_CODE)) == false) { + + if (result != null && JSONResponse.isExist(result) == false) { throw new IllegalArgumentException(rk + ":value 中value不合法！必须匹配 '" + tk + "': '" + tv + "' ！"); } } @@ -1332,7 +1739,8 @@ private static void verifyCondition(@NotNull String funChar, @NotNull JSONObject * @param value * @throws Exception */ - public static void verifyExist(String table, String key, Object value, long exceptId, @NotNull SQLCreator creator) throws Exception { + public static , L extends List>void verifyExist(String table, String key + , Object value, long exceptId, @NotNull Parser parser) throws Exception { if (key == null || value == null) { Log.e(TAG, "verifyExist key == null || value == null >> return;"); return; @@ -1340,20 +1748,37 @@ public static void verifyExist(String table, String key, Object value, long exce if (value instanceof JSON) { throw new UnsupportedDataTypeException(key + ":value 中value的类型不能为JSON！"); } + Map map = new HashMap<>(); + map.put(key,value); + verifyExist(table,map,exceptId,parser); + } + /**验证是否存在 + * @param table + * @param param + * @throws Exception + */ + public static , L extends List> void verifyExist(String table + , Map param, long exceptId, @NotNull Parser parser) throws Exception { + if (param.isEmpty()) { + Log.e(TAG, "verifyExist is empty >> return;"); + return; + } - SQLConfig config = creator.createSQLConfig().setMethod(RequestMethod.HEAD).setCount(1).setPage(0); + SQLConfig config = parser.createSQLConfig().setMethod(RequestMethod.HEAD).setCount(1).setPage(0); config.setTable(table); - config.putWhere(key, value, false); + param.forEach((key,value) -> config.putWhere(key, value, false)); - SQLExecutor executor = creator.createSQLExecutor(); + SQLExecutor executor = parser.getSQLExecutor(); try { - JSONObject result = executor.execute(config, false); + M result = executor.execute(config, false); if (result == null) { throw new Exception("服务器内部错误 verifyExist result == null"); } - if (result.getIntValue(JSONResponse.KEY_COUNT) <= 0) { - throw new ConflictException(key + ": " + value + " 不存在！如果必要请先创建！"); + if (getIntValue(result, JSONResponse.KEY_COUNT) <= 0) { + StringBuilder sb = new StringBuilder(); + param.forEach((key,value) -> sb.append("key:").append(key).append(" value:").append(value).append(" ")); + throw new ConflictException(sb + "的数据不存在！如果必要请先创建！"); } } finally { executor.close(); @@ -1366,8 +1791,9 @@ public static void verifyExist(String table, String key, Object value, long exce * @param value * @throws Exception */ - public static void verifyRepeat(String table, String key, Object value, @NotNull SQLCreator creator) throws Exception { - verifyRepeat(table, key, value, 0, creator); + public static , L extends List> void verifyRepeat(String table, String key + , Object value, @NotNull Parser parser) throws Exception { + verifyRepeat(table, key, value, 0, parser); } /**验证是否重复 @@ -1377,8 +1803,9 @@ public static void verifyRepeat(String table, String key, Object value, @NotNull * @param exceptId 不包含id * @throws Exception */ - public static void verifyRepeat(String table, String key, Object value, long exceptId, @NotNull SQLCreator creator) throws Exception { - verifyRepeat(table, key, value, exceptId, null, creator); + public static , L extends List> void verifyRepeat(String table, String key + , Object value, long exceptId, @NotNull Parser parser) throws Exception { + verifyRepeat(table, key, value, exceptId, null, parser); } /**验证是否重复 @@ -1388,10 +1815,11 @@ public static void verifyRepeat(String table, String key, Object value, long exc * @param value * @param exceptId 不包含id * @param idKey - * @param creator + * @param parser * @throws Exception */ - public static void verifyRepeat(String table, String key, Object value, long exceptId, String idKey, @NotNull SQLCreator creator) throws Exception { + public static , L extends List>void verifyRepeat(String table, String key + , Object value, long exceptId, String idKey, @NotNull Parser parser) throws Exception { if (key == null || value == null) { Log.e(TAG, "verifyRepeat key == null || value == null >> return;"); return; @@ -1399,33 +1827,55 @@ public static void verifyRepeat(String table, String key, Object value, long exc if (value instanceof JSON) { throw new UnsupportedDataTypeException(key + ":value 中value的类型不能为JSON！"); } + Map map = new HashMap<>(); + map.put(key,value); + verifyRepeat(table, map, exceptId, idKey, parser); + } - String finalIdKey = StringUtil.isEmpty(idKey, false) ? apijson.JSONObject.KEY_ID : idKey; + /**验证是否重复 + * TODO 与 AbstractVerifier.verifyRepeat 代码重复，需要简化 + * @param table + * @param param + * @param exceptId 不包含id + * @param idKey + * @param parser + * @throws Exception + */ + public static , L extends List> void verifyRepeat(String table + , Map param, long exceptId, String idKey, @NotNull Parser parser) throws Exception { + if (param.isEmpty()) { + Log.e(TAG, "verifyRepeat is empty >> return;"); + return; + } + + String finalIdKey = StringUtil.isEmpty(idKey, false) ? JSONMap.KEY_ID : idKey; - SQLConfig config = creator.createSQLConfig().setMethod(RequestMethod.GET).setCount(1).setPage(0); + SQLConfig config = parser.createSQLConfig().setMethod(RequestMethod.HEAD).setCount(1).setPage(0); config.setTable(table); if (exceptId > 0) { //允许修改自己的属性为该属性原来的值 config.putWhere(finalIdKey + "!", exceptId, false); } - config.putWhere(key, value, false); + param.forEach((key,value) -> config.putWhere(key,value, false)); - SQLExecutor executor = creator.createSQLExecutor(); + SQLExecutor executor = parser.getSQLExecutor(); try { - JSONObject result = executor.execute(config, false); + M result = executor.execute(config, false); if (result == null) { throw new Exception("服务器内部错误 verifyRepeat result == null"); } - if (result.getIntValue(JSONResponse.KEY_CODE) > 0) { - throw new ConflictException(key + ": " + value + " 已经存在，不能重复！"); + if (getIntValue(result, JSONResponse.KEY_COUNT) > 0) { + StringBuilder sb = new StringBuilder(); + param.forEach((key,value) -> sb.append("key:").append(key).append(" value:").append(value).append(" ")); + throw new ConflictException(sb + "的数据已经存在，不能重复！"); } } finally { executor.close(); } } + public static String getCacheKeyForRequest(String method, String tag) { - return method + " " + tag; + return method + "/" + tag; } - } diff --git a/APIJSONORM/src/main/java/apijson/orm/Entry.java b/APIJSONORM/src/main/java/apijson/orm/Entry.java index 93e9f0418..3e010435b 100755 --- a/APIJSONORM/src/main/java/apijson/orm/Entry.java +++ b/APIJSONORM/src/main/java/apijson/orm/Entry.java @@ -1,10 +1,12 @@ -/*Copyright (C) 2020 THL A29 Limited, a Tencent company. All rights reserved. +/*Copyright (C) 2020 Tencent. All rights reserved. This source code is licensed under the Apache License Version 2.0.*/ package apijson.orm; +import java.util.Map; + /**自定义Entry * *java.util.Map.Entry是interface，new Entry(...)不好用，其它的Entry也不好用 * @author Lemon @@ -13,7 +15,7 @@ * @use new Entry(...) * @warn K,V都需要基本类型时不建议使用，判空麻烦，不如新建一个Model */ -public class Entry { +public class Entry implements Map.Entry { public K key; public V value; @@ -39,8 +41,9 @@ public void setKey(K key) { public V getValue() { return value; } - public void setValue(V value) { + public V setValue(V value) { this.value = value; + return value; } public boolean isEmpty() { diff --git a/APIJSONORM/src/main/java/apijson/orm/FunctionParser.java b/APIJSONORM/src/main/java/apijson/orm/FunctionParser.java index ce68bb674..8af029234 100644 --- a/APIJSONORM/src/main/java/apijson/orm/FunctionParser.java +++ b/APIJSONORM/src/main/java/apijson/orm/FunctionParser.java @@ -1,50 +1,54 @@ -/*Copyright (C) 2020 THL A29 Limited, a Tencent company. All rights reserved. +/*Copyright (C) 2020 Tencent. All rights reserved. This source code is licensed under the Apache License Version 2.0.*/ package apijson.orm; -import com.alibaba.fastjson.JSONObject; +import java.util.List; +import java.util.Map; -import apijson.NotNull; -import apijson.RequestMethod; +import apijson.*; /**远程函数解析器 * @author Lemon */ -public interface FunctionParser { +public interface FunctionParser, L extends List> { + + Object invoke(@NotNull String function, @NotNull M currentObject) throws Exception; + Object invoke(@NotNull String function, @NotNull M currentObject, boolean containRaw) throws Exception; + + Parser getParser(); + + FunctionParser setParser(Parser parser); - Object invoke(@NotNull String function, @NotNull JSONObject currentObject) throws Exception; - RequestMethod getMethod(); - FunctionParser setMethod(RequestMethod method); + FunctionParser setMethod(RequestMethod method); String getTag(); - FunctionParser setTag(String tag); + FunctionParser setTag(String tag); int getVersion(); - AbstractFunctionParser setVersion(int version); + FunctionParser setVersion(int version); @NotNull - JSONObject getRequest(); - FunctionParser setRequest(@NotNull JSONObject request); + M getRequest(); + FunctionParser setRequest(@NotNull M request); String getKey(); - FunctionParser setKey(String key); + FunctionParser setKey(String key); String getParentPath(); - FunctionParser setParentPath(String parentPath); + FunctionParser setParentPath(String parentPath); String getCurrentName(); - FunctionParser setCurrentName(String currentName); - - @NotNull - JSONObject getCurrentObject(); - FunctionParser setCurrentObject(@NotNull JSONObject currentObject); + FunctionParser setCurrentName(String currentName); + @NotNull + M getCurrentObject(); + FunctionParser setCurrentObject(@NotNull M currentObject); } diff --git a/APIJSONORM/src/main/java/apijson/orm/JSONRequest.java b/APIJSONORM/src/main/java/apijson/orm/JSONRequest.java index 89d17f7d2..40bfa147a 100755 --- a/APIJSONORM/src/main/java/apijson/orm/JSONRequest.java +++ b/APIJSONORM/src/main/java/apijson/orm/JSONRequest.java @@ -1,23 +1,23 @@ -/*Copyright (C) 2020 THL A29 Limited, a Tencent company. All rights reserved. +/*Copyright (C) 2020 Tencent. All rights reserved. This source code is licensed under the Apache License Version 2.0.*/ package apijson.orm; -import java.util.Map; +import java.util.*; import apijson.JSON; import apijson.StringUtil; -/**JSONRequest for Server to replace apijson.JSONRequest, - * put JSON.parseObject(value) and not encode in default cases +/**JSONRequest for Server to replace apijson.JSONMap, + * put JSON.parseObject(value) and not encode in public cases * @author Lemon - * @see #put(String, Object, boolean) + * @see #put(String, Object) */ -public class JSONRequest extends apijson.JSONRequest { - private static final long serialVersionUID = 1L; - +public class JSONRequest implements apijson.JSONRequest, ArrayList> { + + protected Map map = new LinkedHashMap<>(); public JSONRequest() { super(); } @@ -27,21 +27,40 @@ public JSONRequest() { * @param object */ public JSONRequest(Object object) { - super(object); + super(); + put(object); } /** * @param name * @param object */ public JSONRequest(String name, Object object) { - super(name, object); + super(); + put(name, object); } - - + ///**create a parent JSONMap named KEY_ARRAY + // * @param count + // * @param page + // * @return {@link #toArray(int, int)} + // */ + //public LinkedHashMap toArray(int count, int page) { + // return toArray(count, page, null); + //} + // + ///**create a parent JSONMap named name+KEY_ARRAY. + // * @param count + // * @param page + // * @param name + // * @return {name+KEY_ARRAY : this}. if needs to be put, use {@link #putsAll(Map)} instead + // */ + //public LinkedHashMap toArray(int count, int page, String name) { + // return new JSONRequest(StringUtil.get(name) + KEY_ARRAY, this.setCount(count).setPage(page)); + //} + @Override - public JSONRequest putsAll(Map map) { - super.putsAll(map); + public JSONRequest putsAll(Map m) { + putAll(m); return this; } @@ -51,7 +70,8 @@ public JSONRequest putsAll(Map map) { */ @Override public JSONRequest puts(Object value) { - return puts(null, value); + put(value); + return this; } /** * @param key @@ -65,14 +85,7 @@ public JSONRequest puts(String key, Object value) { return this; } - /** - * @param value - * @return {@link #put(String, Object)} - */ - @Override - public Object put(Object value) { - return put(null, value); - } + /**自定义类型必须转为JSONObject或JSONArray，否则RequestParser解析不了 */ @Override @@ -81,12 +94,79 @@ public Object put(String key, Object value) { return null; } - Object target = JSON.parse(value); - // if (target == null) { // "tag":"User" 报错 + Object target = null; + try { + target = JSON.parse(value); + } catch (Exception e) { + // nothing + e.printStackTrace(); + } + // if (target == null) { // "tag":"User" 报错 // return null; // } - return super.put(StringUtil.isNotEmpty(key, true) ? key : value.getClass().getSimpleName() //must handle key here + return map.put(StringUtil.isNotEmpty(key, true) ? key : value.getClass().getSimpleName() //must handle key here , target == null ? value : target); } + + @Override + public int size() { + return map.size(); + } + + @Override + public boolean isEmpty() { + return map.isEmpty(); + } + + @Override + public boolean containsKey(Object key) { + return map.containsKey(key); + } + + @Override + public boolean containsValue(Object value) { + return map.containsValue(value); + } + + @Override + public Object get(Object key) { + return map.get(key); + } + + @Override + public Object remove(Object key) { + return map.remove(key); + } + + + @Override + public void clear() { + map.clear(); + } + + @Override + public Set keySet() { + return map.keySet(); + } + + @Override + public Collection values() { + return map.values(); + } + + @Override + public Set> entrySet() { + return map.entrySet(); + } + + @Override + public String toString() { + return JSON.toJSONString(map); + } + + public String toJSONString() { + return JSON.toJSONString(map); + } + } diff --git a/APIJSONORM/src/main/java/apijson/orm/Join.java b/APIJSONORM/src/main/java/apijson/orm/Join.java index 168e3e77d..96d5e2ec7 100644 --- a/APIJSONORM/src/main/java/apijson/orm/Join.java +++ b/APIJSONORM/src/main/java/apijson/orm/Join.java @@ -1,38 +1,38 @@ -/*Copyright (C) 2020 THL A29 Limited, a Tencent company. All rights reserved. +/*Copyright (C) 2020 Tencent. All rights reserved. This source code is licensed under the Apache License Version 2.0.*/ package apijson.orm; -import com.alibaba.fastjson.JSONObject; +import java.util.List; +import java.util.Map; import apijson.NotNull; +import apijson.StringUtil; /**连表 配置 * @author Lemon */ -public class Join { +public class Join, L extends List> { - private String path; + private String path; // /User/id@ - private String originKey; - private String originValue; + private String joinType; // "@" - APP, "<" - LEFT, ">" - RIGHT, "*" - CROSS, "&" - INNER, "|" - FULL, "!" - OUTER, "^" - SIDE, "(" - ANTI, ")" - FOREIGN, "~" ASOF + private String table; // User + private String alias; // owner + private int count = 1; // 当app join子表，需要返回子表的行数，默认1行； + private List onList; // ON User.id = Moment.userId AND ... - private String joinType; // "@" - APP, "<" - LEFT, ">" - RIGHT, "*" - CROSS, "&" - INNER, "|" - FULL, "!" - OUTER, "^" - SIDE, "(" - ANTI, ")" - FOREIGN - private String relateType; // "" - 一对一, "{}" - 一对多, "<>" - 多对一 - private JSONObject request; // { "id@":"/Moment/userId" } - private String table; //User - private String alias; //owner - private String key; //id - private String targetName; // Moment - private String targetKey; // userId + private M request; // { "id@":"/Moment/userId" } + private M on; // "join": { " joinConfig; + private SQLConfig cacheConfig; + private SQLConfig onConfig; - private SQLConfig joinConfig; - private SQLConfig cacheConfig; - private SQLConfig outterConfig; + private SQLConfig outerConfig; public String getPath() { return path; @@ -41,17 +41,11 @@ public void setPath(String path) { this.path = path; } - public String getOriginKey() { - return originKey; + public int getCount() { + return count; } - public void setOriginKey(String originKey) { - this.originKey = originKey; - } - public String getOriginValue() { - return originValue; - } - public void setOriginValue(String originValue) { - this.originValue = originValue; + public void setCount(int count) { + this.count = count; } public String getJoinType() { @@ -60,13 +54,6 @@ public String getJoinType() { public void setJoinType(String joinType) { this.joinType = joinType; } - public String getRelateType() { - return relateType; - } - public void setRelateType(String relateType) { - this.relateType = relateType; - } - public String getTable() { return table; } @@ -79,107 +66,292 @@ public String getAlias() { public void setAlias(String alias) { this.alias = alias; } - public JSONObject getRequest() { - return request; + + public List getOnList() { + return onList; } - public void setRequest(JSONObject request) { - this.request = request; + public void setOnList(List onList) { + this.onList = onList; } - public String getKey() { - return key; + + public M getRequest() { + return request; } - public void setKey(String key) { - this.key = key; + public void setRequest(M request) { + this.request = request; } - public String getTargetName() { - return targetName; + public M getOn() { + return on; } - public void setTargetName(String targetName) { - this.targetName = targetName; + public void setOn(M on) { + this.on = on; } - public String getTargetKey() { - return targetKey; + + public void setOuter(M outer) { + this.outer = outer; } - public void setTargetKey(String targetKey) { - this.targetKey = targetKey; + + public M getOuter() { + return outer; } - public JSONObject getOuter() { - return outter; + public SQLConfig getOuterConfig() { + return outerConfig; } - public void setOuter(JSONObject outter) { - this.outter = outter; + + public void setOuterConfig(SQLConfig outerConfig) { + this.outerConfig = outerConfig; } - public SQLConfig getJoinConfig() { + public SQLConfig getJoinConfig() { return joinConfig; } - public void setJoinConfig(SQLConfig joinConfig) { + public void setJoinConfig(SQLConfig joinConfig) { this.joinConfig = joinConfig; } - public SQLConfig getCacheConfig() { + public SQLConfig getCacheConfig() { return cacheConfig; } - public void setCacheConfig(SQLConfig cacheConfig) { + public void setCacheConfig(SQLConfig cacheConfig) { this.cacheConfig = cacheConfig; } - - public SQLConfig getOuterConfig() { - return outterConfig; + public SQLConfig getOnConfig() { + return onConfig; } - public void setOuterConfig(SQLConfig outterConfig) { - this.outterConfig = outterConfig; + public void setOnConfig(SQLConfig onConfig) { + this.onConfig = onConfig; } + public boolean isOne2One() { + return ! isOne2Many(); + } + public boolean isOne2Many() { + return count != 1 || (path != null && path.contains("[]")); // TODO 必须保证一对一时不会传包含 [] 的 path + } - public void setKeyAndType(@NotNull String originKey) throws Exception { //id, id@, id{}@, contactIdList<>@ ... - if (originKey.endsWith("@")) { - originKey = originKey.substring(0, originKey.length() - 1); - } - else { //TODO 暂时只允许 User.id = Moment.userId 字段关联，不允许 User.id = 82001 这种 - throw new IllegalArgumentException(joinType + "/.../" + table + "/" + originKey + " 不合法！join:'.../refKey'" + " 中 refKey 必须以 @ 结尾！"); - } - - if (originKey.endsWith("{}")) { - setRelateType("{}"); - setKey(originKey.substring(0, originKey.length() - 2)); - } - else if (originKey.endsWith("<>")) { - setRelateType("<>"); - setKey(originKey.substring(0, originKey.length() - 2)); - } - else { - setRelateType(""); - setKey(originKey); - } + public boolean isAppJoin() { + return "@".equals(getJoinType()); + } + public boolean isLeftJoin() { + return "<".equals(getJoinType()); + } + public boolean isRightJoin() { + return ">".equals(getJoinType()); + } + public boolean isCrossJoin() { + return "*".equals(getJoinType()); + } + public boolean isInnerJoin() { + return "&".equals(getJoinType()); + } + public boolean isFullJoin() { + String jt = getJoinType(); + return "".equals(jt) || "|".equals(jt); + } + public boolean isOuterJoin() { + return "!".equals(getJoinType()); + } + public boolean isSideJoin() { + return "^".equals(getJoinType()); + } + public boolean isAntiJoin() { + return "(".equals(getJoinType()); + } + public boolean isForeignJoin() { + return ")".equals(getJoinType()); + } + public boolean isAsofJoin() { + return "~".equals(getJoinType()); } + public boolean isLeftOrRightJoin() { + String jt = getJoinType(); + return "<".equals(jt) || ">".equals(jt); + } + public boolean canCacheViceTable() { + String jt = getJoinType(); + return "@".equals(jt) || "<".equals(jt) || ">".equals(jt) || "&".equals(jt) || "*".equals(jt) || ")".equals(jt); + // 副表是按常规条件查询，缓存会导致其它同表同条件对象查询结果集为空 return ! isFullJoin(); // ! - OUTER, ( - FOREIGN 都需要缓存空副表数据，避免多余的查询 + } public boolean isSQLJoin() { return ! isAppJoin(); } - public static boolean isSQLJoin(Join j) { + public static boolean isSQLJoin(Join j) { return j != null && j.isSQLJoin(); } - public boolean isAppJoin() { - return "@".equals(getJoinType()); - } - - public static boolean isAppJoin(Join j) { + public static boolean isAppJoin(Join j) { return j != null && j.isAppJoin(); } - public boolean isLeftOrRightJoin() { - return "<".equals(getJoinType()) || ">".equals(getJoinType()); - } - - public static boolean isLeftOrRightJoin(Join j) { + public static boolean isLeftOrRightJoin(Join j) { return j != null && j.isLeftOrRightJoin(); } + public static class On { + + private String originKey; + private String originValue; + + private Logic logic; // & | ! + private String relateType; // "" - 一对一, "{}" - 一对多, "<>" - 多对一, > , <= , != + private String key; // id + private String targetTableKey; // Moment:main + private String targetTable; // Moment + private String targetAlias; // main + private String targetKey; // userId + + public String getOriginKey() { + return originKey; + } + public void setOriginKey(String originKey) { + this.originKey = originKey; + } + public String getOriginValue() { + return originValue; + } + public void setOriginValue(String originValue) { + this.originValue = originValue; + } + + + public Logic getLogic() { + return logic; + } + public void setLogic(Logic logic) { + this.logic = logic; + } + public String getRelateType() { + return relateType; + } + public void setRelateType(String relateType) { + this.relateType = relateType; + } + + public String getKey() { + return key; + } + public void setKey(String key) { + this.key = key; + } + + public void setTargetTableKey(String targetTableKey) { + this.targetTableKey = targetTableKey; + } + public String getTargetTableKey() { + return targetTableKey; + } + + public void setTargetTable(String targetTable) { + this.targetTable = targetTable; + } + public String getTargetTable() { + return targetTable; + } + public void setTargetAlias(String targetAlias) { + this.targetAlias = targetAlias; + } + public String getTargetAlias() { + return targetAlias; + } + public String getTargetKey() { + return targetKey; + } + public void setTargetKey(String targetKey) { + this.targetKey = targetKey; + } + + + public void setKeyAndType(String joinType, String table, @NotNull String originKey) throws Exception { //id, id@, id{}@, contactIdList<>@ ... + if (originKey.endsWith("@")) { + originKey = originKey.substring(0, originKey.length() - 1); + } + else { //TODO 暂时只允许 User.id = Moment.userId 字段关联，不允许 User.id = 82001 这种 + throw new IllegalArgumentException(joinType + "/.../" + table + "/" + originKey + " 中字符 " + originKey + " 不合法！join:'.../refKey'" + " 中 refKey 必须以 @ 结尾！"); + } + + String k; + + if (originKey.endsWith("{}")) { + setRelateType("{}"); + k = originKey.substring(0, originKey.length() - 2); + } + else if (originKey.endsWith("<>")) { + setRelateType("<>"); + k = originKey.substring(0, originKey.length() - 2); + } + else if (originKey.endsWith("$")) { // key%$:"a" -> key LIKE '%a%'; key?%$:"a" -> key LIKE 'a%'; key_?$:"a" -> key LIKE '_a'; key_%$:"a" -> key LIKE '_a%' + k = originKey.substring(0, originKey.length() - 1); + char c = k.isEmpty() ? 0 : k.charAt(k.length() - 1); + + String t = "$"; + if (c == '%' || c == '_' || c == '?') { + t = c + t; + k = k.substring(0, k.length() - 1); + + char c2 = k.isEmpty() ? 0 : k.charAt(k.length() - 1); + if (c2 == '%' || c2 == '_' || c2 == '?') { + if (c2 == c) { + throw new IllegalArgumentException(originKey + ":value 中字符 " + k + " 不合法！key$:value 中不允许 key 中有连续相同的占位符！"); + } + + t = c2 + t; + k = k.substring(0, k.length() - 1); + } + else if (c == '?') { + throw new IllegalArgumentException(originKey + ":value 中字符 " + originKey + " 不合法！key$:value 中不允许只有单独的 '?'，必须和 '%', '_' 之一配合使用 ！"); + } + } + + setRelateType(t); + } + else if (originKey.endsWith("~")) { + boolean ignoreCase = originKey.endsWith("*~"); + setRelateType(ignoreCase ? "*~" : "~"); + k = originKey.substring(0, originKey.length() - (ignoreCase ? 2 : 1)); + } + else if (originKey.endsWith(">=")) { + setRelateType(">="); + k = originKey.substring(0, originKey.length() - 2); + } + else if (originKey.endsWith("<=")) { + setRelateType("<="); + k = originKey.substring(0, originKey.length() - 2); + } + else if (originKey.endsWith(">")) { + setRelateType(">"); + k = originKey.substring(0, originKey.length() - 1); + } + else if (originKey.endsWith("<")) { + setRelateType("<"); + k = originKey.substring(0, originKey.length() - 1); + } + else { + setRelateType(""); + k = originKey; + } + + if (k != null && (k.contains("&") || k.contains("|"))) { + throw new UnsupportedOperationException(joinType + "/.../" + table + "/" + originKey + " 中字符 " + k + " 不合法！与或非逻辑符仅支持 '!' 非逻辑符 ！"); + } + + //TODO if (c3 == '-') { // 表示 key 和 value 顺序反过来: value LIKE key + + Logic l = new Logic(k); + setLogic(l); + + if (StringUtil.isName(l.getKey()) == false) { + throw new IllegalArgumentException(joinType + "/.../" + table + "/" + originKey + " 中字符 " + l.getKey() + " 不合法！必须符合字段命名格式！"); + } + + setKey(l.getKey()); + } + + } + } diff --git a/APIJSONORM/src/main/java/apijson/orm/Logic.java b/APIJSONORM/src/main/java/apijson/orm/Logic.java index b795ae961..f860aa9a4 100755 --- a/APIJSONORM/src/main/java/apijson/orm/Logic.java +++ b/APIJSONORM/src/main/java/apijson/orm/Logic.java @@ -1,4 +1,4 @@ -/*Copyright (C) 2020 THL A29 Limited, a Tencent company. All rights reserved. +/*Copyright (C) 2020 Tencent. All rights reserved. This source code is licensed under the Apache License Version 2.0.*/ @@ -30,6 +30,7 @@ public class Logic { private int type; private String key; + private String originKey; public Logic() { super(); @@ -40,7 +41,8 @@ public Logic(int type) { this.type = type; } public Logic(String key) { - key = StringUtil.getString(key); + this.originKey = key; + key = StringUtil.get(key); int type = getType(key.isEmpty() ? "" : key.substring(key.length() - 1)); @@ -71,6 +73,9 @@ public String getKey() { public void setKey(String key) { this.key = key; } + public String getOriginKey() { + return originKey; + } public boolean isOr() { diff --git a/APIJSONORM/src/main/java/apijson/orm/ObjectParser.java b/APIJSONORM/src/main/java/apijson/orm/ObjectParser.java index a43a2d879..5d207f41a 100755 --- a/APIJSONORM/src/main/java/apijson/orm/ObjectParser.java +++ b/APIJSONORM/src/main/java/apijson/orm/ObjectParser.java @@ -1,4 +1,4 @@ -/*Copyright (C) 2020 THL A29 Limited, a Tencent company. All rights reserved. +/*Copyright (C) 2020 Tencent. All rights reserved. This source code is licensed under the Apache License Version 2.0.*/ @@ -8,26 +8,31 @@ import java.util.List; import java.util.Map; -import com.alibaba.fastjson.JSON; -import com.alibaba.fastjson.JSONArray; -import com.alibaba.fastjson.JSONObject; - -import apijson.NotNull; -import apijson.RequestMethod; +import apijson.*; /**简化Parser，getObject和getArray(getArrayConfig)都能用 * @author Lemon */ -public interface ObjectParser { +public interface ObjectParser, L extends List> { + + Parser getParser(); + ObjectParser setParser(Parser parser); + + String getParentPath(); + ObjectParser setParentPath(String parentPath); + + ObjectParser setCache(M cache); + M getCache(); /**解析成员 * response重新赋值 - * @param config 传递给第0个Table + * @param name + * @param isReuse * @return null or this * @throws Exception */ - ObjectParser parse() throws Exception; + ObjectParser parse(String name, boolean isReuse) throws Exception; /**调用 parser 的 sqlExecutor 来解析结果 * @param method @@ -39,14 +44,14 @@ public interface ObjectParser { * @return * @throws Exception */ - public JSONObject parseResponse(RequestMethod method, String table, String alias, JSONObject request, List joinList, boolean isProcedure) throws Exception; + M parseResponse(RequestMethod method, String table, String alias, M request, List> joinList, boolean isProcedure) throws Exception; /**调用 parser 的 sqlExecutor 来解析结果 * @param config * @param isProcedure * @return * @throws Exception */ - public JSONObject parseResponse(SQLConfig config, boolean isProcedure) throws Exception; + M parseResponse(SQLConfig config, boolean isProcedure) throws Exception; @@ -61,10 +66,11 @@ public interface ObjectParser { * @param index * @param key * @param value + * @param cache SQL 结果缓存 * @return * @throws Exception */ - JSON onChildParse(int index, String key, JSONObject value) throws Exception; + Object onChildParse(int index, String key, M value, Object cache) throws Exception; /**解析赋值引用 * @param path @@ -78,55 +84,55 @@ public interface ObjectParser { * @param array * @throws Exception */ - void onPUTArrayParse(@NotNull String key, @NotNull JSONArray array) throws Exception; + void onPUTArrayParse(@NotNull String key, @NotNull L array) throws Exception; /**批量新增或修改 POST or PUT Table[]:[{}] * @param key * @param array * @throws Exception */ - void onTableArrayParse(@NotNull String key, @NotNull JSONArray array) throws Exception; + void onTableArrayParse(@NotNull String key, @NotNull L array) throws Exception; /**SQL 配置，for single object * @return {@link #setSQLConfig(int, int, int)} * @throws Exception */ - ObjectParser setSQLConfig() throws Exception; + ObjectParser setSQLConfig() throws Exception; /**SQL 配置 * @return * @throws Exception */ - ObjectParser setSQLConfig(int count, int page, int position) throws Exception; + ObjectParser setSQLConfig(int count, int page, int position) throws Exception; /**执行 SQL * @return * @throws Exception */ - ObjectParser executeSQL() throws Exception; + ObjectParser executeSQL() throws Exception; /** * @return * @throws Exception */ - JSONObject onSQLExecute() throws Exception; + M onSQLExecute() throws Exception; /** * @return response * @throws Exception */ - JSONObject response() throws Exception; + M response() throws Exception; void onFunctionResponse(String type) throws Exception; void onChildResponse() throws Exception; - SQLConfig newSQLConfig(boolean isProcedure) throws Exception; - SQLConfig newSQLConfig(RequestMethod method, String table, String alias, JSONObject request, List joinList, boolean isProcedure) throws Exception; + SQLConfig newSQLConfig(boolean isProcedure) throws Exception; + SQLConfig newSQLConfig(RequestMethod method, String table, String alias, M request, List> joinList, boolean isProcedure) throws Exception; /** * response has the final value after parse (and query if isTableKey) @@ -139,8 +145,7 @@ public interface ObjectParser { void recycle(); - - ObjectParser setMethod(RequestMethod method); + ObjectParser setMethod(RequestMethod method); RequestMethod getMethod(); @@ -148,15 +153,15 @@ public interface ObjectParser { String getPath(); String getTable(); String getAlias(); - SQLConfig getArrayConfig(); + SQLConfig getArrayConfig(); - SQLConfig getSQLConfig(); - JSONObject getResponse(); - JSONObject getSqlRequest(); - JSONObject getSqlReponse(); + SQLConfig getSQLConfig(); + M getResponse(); + M getSQLRequest(); + M getSQLResponse(); Map getCustomMap(); Map> getFunctionMap(); - Map getChildMap(); + Map getChildMap(); } diff --git a/APIJSONORM/src/main/java/apijson/orm/OnParseCallback.java b/APIJSONORM/src/main/java/apijson/orm/OnParseCallback.java index 952c41e3b..e02fd90f8 100755 --- a/APIJSONORM/src/main/java/apijson/orm/OnParseCallback.java +++ b/APIJSONORM/src/main/java/apijson/orm/OnParseCallback.java @@ -1,17 +1,17 @@ -/*Copyright (C) 2020 THL A29 Limited, a Tencent company. All rights reserved. +/*Copyright (C) 2020 Tencent. All rights reserved. This source code is licensed under the Apache License Version 2.0.*/ package apijson.orm; -import com.alibaba.fastjson.JSONArray; -import com.alibaba.fastjson.JSONObject; +import java.util.List; +import java.util.Map; /** * @author Lemon */ -public abstract class OnParseCallback { +public abstract class OnParseCallback, L extends List> { /** @@ -43,7 +43,7 @@ protected Object onParseObject(String key, Object to, Object ro) throws Exceptio * @return * @throws Exception */ - protected JSONObject onParseJSONObject(String key, JSONObject tobj, JSONObject robj) throws Exception { + protected M onParseJSONObject(String key, M tobj, M robj) throws Exception { return robj; } @@ -54,7 +54,7 @@ protected JSONObject onParseJSONObject(String key, JSONObject tobj, JSONObject r * @return * @throws Exception */ - protected JSONArray onParseJSONArray(String key, JSONArray tarray, JSONArray rarray) throws Exception { + protected L onParseJSONArray(String key, L tarray, L rarray) throws Exception { return rarray; } diff --git a/APIJSONORM/src/main/java/apijson/orm/Operation.java b/APIJSONORM/src/main/java/apijson/orm/Operation.java index a0e2278b1..1c4f2dc5f 100755 --- a/APIJSONORM/src/main/java/apijson/orm/Operation.java +++ b/APIJSONORM/src/main/java/apijson/orm/Operation.java @@ -1,11 +1,11 @@ -/*Copyright (C) 2020 THL A29 Limited, a Tencent company. All rights reserved. +/*Copyright (C) 2020 Tencent. All rights reserved. This source code is licensed under the Apache License Version 2.0.*/ package apijson.orm; -/**对请求JSON的操作 +/**对请求 JSON 的操作 * @author Lemon */ public enum Operation { @@ -14,21 +14,12 @@ public enum Operation { * "key0,key1,key2..." */ MUST, - /** - * @deprecated 用 MUST 代替，最早可能 4.5.0 移除 - */ - NECESSARY, /** * 不允许传的字段，结构是 * "key0,key1,key2..." */ REFUSE, - /** - * @deprecated 用 REFUSE 代替，最早可能 4.5.0 移除 - */ - DISALLOW, - /**TODO 是否应该把数组类型写成 BOOLEANS, NUMBERS 等复数单词，以便抽取 enum ？扩展用 VERIFY 或 INSERT/UPDATE 远程函数等 * 验证是否符合预设的类型: @@ -47,7 +38,7 @@ public enum Operation { * "id": "NUMBER", //id 类型必须为 NUMBER * "pictureList": "URL[]", //pictureList 类型必须为 URL[] * } - * @see {@link Structure#type(String, String, Object, boolean)} + * @see {@link AbstractVerifier#verifyType(String, String, Object, boolean)} */ TYPE, @@ -61,22 +52,25 @@ public enum Operation { * } * 例如 * { - * "phone~": "PHONE", //phone 必须满足 PHONE 的格式 + * "phone~": "PHONE", //phone 必须满足 PHONE 的格式，配置见 {@link AbstractVerifier#COMPILE_MAP} * "status{}": [1,2,3], //status 必须在给出的范围内 + * "content{L}": ">0,<=255", //content的长度 必须在给出的范围内 * "balance&{}":">0,<=10000" //必须满足 balance>0 & balance<=10000 * } */ VERIFY, - /**TODO 格式改为 id;version,tag 兼容多个字段联合主键。 ["id", "version,tag"] 也行 + /** * 验证是否存在，结构是 * "key0,key1,key2..." + * 多个字段用逗号隔开，联合校验 */ EXIST, - /**TODO 格式改为 id;version,tag 兼容多个字段联合主键。 ["id", "version,tag"] 也行 + /** * 验证是否不存在，除了本身的记录，结构是 * "key0,key1,key2..." + * 多个字段用逗号隔开，联合校验 */ UNIQUE, @@ -118,6 +112,46 @@ public enum Operation { * 移除，当要被移除的对象存在时，结构是 * "key0,key1,key2..." */ - REMOVE; - + REMOVE, + + /** + * 监听事件，用于同步到其它表，结构是 + * "key0": {} + * 例如 "name": { "UPDATE": { "Comment": { "userName@": "/name" } } } + * 当 User.name 被修改时，同步修改 Comment.userName + * + * 例如 "sex != 0 && sex != 1": "throw new Error('sex 必须在 [0, 1] 内！')" + * 自定义代码，当满足条件是执行后面的代码 + * + * 还有 + * "ELSE": "" + * 自定义代码，不处理，和不传一样 + */ + IF, + +// /** 直接用 IF 替代 +// * 自定义代码，结构是 "code"，例如 +// * "var a = 1; +// * var b = a + 2; +// * if (b % 2 == 0) { +// * throw new Error('b % 2 == 0 !'); +// * } +// * " +// * +// * 或 { "code": "JS", "code2": "LUA" } +// */ +// CODE, + + /** + * 允许批量增删改部分失败，结构是 + * "Table[],key[],key:alias[]" + * 自动 ALLOW_PARTIAL_UPDATE_FAILED_TABLE_MAP.put，结构是 Boolean，例如 true + */ + ALLOW_PARTIAL_UPDATE_FAIL, + + /** + * 强制要求必须有 id/id{}/id{}@ 条件，结构是 Boolean，例如 true + */ + IS_ID_CONDITION_MUST; + } diff --git a/APIJSONORM/src/main/java/apijson/orm/Pair.java b/APIJSONORM/src/main/java/apijson/orm/Pair.java index a1f471c42..7661d07b5 100755 --- a/APIJSONORM/src/main/java/apijson/orm/Pair.java +++ b/APIJSONORM/src/main/java/apijson/orm/Pair.java @@ -1,4 +1,4 @@ -/*Copyright (C) 2020 THL A29 Limited, a Tencent company. All rights reserved. +/*Copyright (C) 2020 Tencent. All rights reserved. This source code is licensed under the Apache License Version 2.0.*/ @@ -9,9 +9,6 @@ import java.util.HashMap; import java.util.Map; -import com.alibaba.fastjson.JSONArray; -import com.alibaba.fastjson.JSONObject; - import apijson.StringUtil; /**key:value @@ -37,8 +34,8 @@ public class Pair extends Entry { CLASS_MAP.put(String.class.getSimpleName(), String.class); CLASS_MAP.put(Collection.class.getSimpleName(), Collection.class);//不允许指定 CLASS_MAP.put(Map.class.getSimpleName(), Map.class);//不允许指定 - CLASS_MAP.put(JSONObject.class.getSimpleName(), JSONObject.class);//必须有，Map中没有getLongValue等方法 - CLASS_MAP.put(JSONArray.class.getSimpleName(), JSONArray.class);//必须有，Collection中没有getJSONObject等方法 +// CLASS_MAP.put(JSONMap.class.getSimpleName(), JSONMap.class);//必须有，Map中没有getLongValue等方法 +// CLASS_MAP.put(JSONList.class.getSimpleName(), JSONList.class);//必须有，Collection中没有getJSONObject等方法 } @@ -60,14 +57,14 @@ public static boolean isCorrect(Entry pair) { } /** - * @param pair * @return */ public String toPairString() { return toPairString(getKey(), getValue()); } /** - * @param pair + * @param typeKey + * @param valueKey * @return */ public static String toPairString(String typeKey, String valueKey) { @@ -79,7 +76,7 @@ public static String toPairString(String typeKey, String valueKey) { * @return */ public static String toPairString(Class type, Object value) { - return toPairString(type == null ? null : type.getSimpleName(), StringUtil.getString(value)); + return toPairString(type == null ? null : type.getSimpleName(), StringUtil.get(value)); } /** @@ -109,7 +106,7 @@ public static Entry parseEntry(String pair, boolean isRightValue * @return @NonNull */ public static Entry parseEntry(String pair, boolean isRightValueDefault, String defaultValue) { - pair = StringUtil.getString(pair);//让客户端去掉所有空格 getNoBlankString(pair); + pair = StringUtil.get(pair);//让客户端去掉所有空格 getNoBlankString(pair); Entry entry = new Entry(); if (pair.isEmpty() == false) { int index = pair.indexOf(":"); @@ -137,7 +134,7 @@ public static Entry parseVariableEntry(String pair) { * @return */ public static Entry, Object> parseVariableEntry(String pair, Map valueMap) { - pair = StringUtil.getString(pair);//让客户端去掉所有空格 getNoBlankString(pair); + pair = StringUtil.get(pair);//让客户端去掉所有空格 getNoBlankString(pair); Entry, Object> entry = new Entry, Object>(); if (pair.isEmpty() == false) { int index = pair.contains(":") ? pair.indexOf(":") : -1; diff --git a/APIJSONORM/src/main/java/apijson/orm/Parser.java b/APIJSONORM/src/main/java/apijson/orm/Parser.java index 4e09c5738..1492dfc11 100755 --- a/APIJSONORM/src/main/java/apijson/orm/Parser.java +++ b/APIJSONORM/src/main/java/apijson/orm/Parser.java @@ -1,4 +1,4 @@ -/*Copyright (C) 2020 THL A29 Limited, a Tencent company. All rights reserved. +/*Copyright (C) 2020 Tencent. All rights reserved. This source code is licensed under the Apache License Version 2.0.*/ @@ -7,80 +7,67 @@ import java.sql.SQLException; import java.sql.Savepoint; +import java.util.List; +import java.util.Map; -import com.alibaba.fastjson.JSONArray; -import com.alibaba.fastjson.JSONObject; - -import apijson.NotNull; -import apijson.RequestMethod; -import apijson.RequestRole; +import apijson.*; /**解析器 * @author Lemon */ -public interface Parser { - - int DEFAULT_QUERY_COUNT = 10; - int MAX_QUERY_PAGE = 100; - int MAX_QUERY_COUNT = 100; - int MAX_UPDATE_COUNT = 10; - int MAX_SQL_COUNT = 200; - int MAX_OBJECT_COUNT = 5; - int MAX_ARRAY_COUNT = 5; - int MAX_QUERY_DEPTH = 5; - - +public interface Parser, L extends List> + extends ParserCreator, VerifierCreator, SQLCreator { + @NotNull Visitor getVisitor(); - Parser setVisitor(@NotNull Visitor visitor); + Parser setVisitor(@NotNull Visitor visitor); @NotNull RequestMethod getMethod(); - Parser setMethod(@NotNull RequestMethod method); + Parser setMethod(@NotNull RequestMethod method); int getVersion(); - Parser setVersion(int version); + Parser setVersion(int version); String getTag(); - Parser setTag(String tag); + Parser setTag(String tag); - JSONObject getRequest(); - Parser setRequest(JSONObject request); + M getRequest(); + Parser setRequest(M request); - Parser setNeedVerify(boolean needVerify); + Parser setNeedVerify(boolean needVerify); boolean isNeedVerifyLogin(); - Parser setNeedVerifyLogin(boolean needVerifyLogin); + Parser setNeedVerifyLogin(boolean needVerifyLogin); boolean isNeedVerifyRole(); - Parser setNeedVerifyRole(boolean needVerifyRole); + Parser setNeedVerifyRole(boolean needVerifyRole); boolean isNeedVerifyContent(); - Parser setNeedVerifyContent(boolean needVerifyContent); + Parser setNeedVerifyContent(boolean needVerifyContent); String parse(String request); - String parse(JSONObject request); + String parse(M request); - JSONObject parseResponse(String request); - JSONObject parseResponse(JSONObject request); + M parseResponse(String request); + M parseResponse(M request); + // 没必要性能还差 JSONRequest parseCorrectResponse(String table, JSONRequest response) throws Exception; - JSONObject parseCorrectRequest() throws Exception; + M parseCorrectRequest() throws Exception; - JSONObject parseCorrectRequest(RequestMethod method, String tag, int version, String name, JSONObject request, - int maxUpdateCount, SQLCreator creator) throws Exception; - - JSONObject parseCorrectResponse(String table, JSONObject response) throws Exception; + M parseCorrectRequest(RequestMethod method, String tag, int version, String name, M request, + int maxUpdateCount, SQLCreator creator) throws Exception; - JSONObject getStructure(String table, String method, String tag, int version) throws Exception; + Map getStructure(String table, String method, String tag, int version) throws Exception; - JSONObject onObjectParse(JSONObject request, String parentPath, String name, SQLConfig arrayConfig, boolean isSubquery) throws Exception; + M onObjectParse(M request, String parentPath, String name, SQLConfig arrayConfig, boolean isSubquery, M cache) throws Exception; - JSONArray onArrayParse(JSONObject request, String parentPath, String name, boolean isSubquery) throws Exception; + L onArrayParse(M request, String parentPath, String name, boolean isSubquery, L cache) throws Exception; /**解析远程函数 * @param key @@ -91,12 +78,13 @@ JSONObject parseCorrectRequest(RequestMethod method, String tag, int version, St * @return * @throws Exception */ - Object onFunctionParse(String key, String function, String parentPath, String currentName, JSONObject currentObject) throws Exception; + Object onFunctionParse(String key, String function, String parentPath, String currentName, M currentObject, boolean containRaw) throws Exception; - ObjectParser createObjectParser(JSONObject request, String parentPath, String name, SQLConfig arrayConfig, boolean isSubquery) throws Exception; + ObjectParser createObjectParser(M request, String parentPath, SQLConfig arrayConfig, boolean isSubquery, boolean isTable, boolean isArrayMainTable) throws Exception; - int getDefaultQueryCount(); + int getMinQueryPage(); int getMaxQueryPage(); + int getDefaultQueryCount(); int getMaxQueryCount(); int getMaxUpdateCount(); int getMaxSQLCount(); @@ -112,20 +100,23 @@ JSONObject parseCorrectRequest(RequestMethod method, String tag, int version, St void onVerifyLogin() throws Exception; void onVerifyContent() throws Exception; - void onVerifyRole(SQLConfig config) throws Exception; + void onVerifyRole(SQLConfig config) throws Exception; - JSONObject executeSQL(SQLConfig config, boolean isSubquery) throws Exception; + M executeSQL(SQLConfig config, boolean isSubquery) throws Exception; - SQLExecutor getSQLExecutor(); - Verifier getVerifier(); + SQLExecutor getSQLExecutor(); + Verifier getVerifier(); - Boolean getGlobleFormat(); - RequestRole getGlobleRole(); - String getGlobleDatabase(); - String getGlobleSchema(); - Boolean getGlobleExplain(); - String getGlobleCache(); + Boolean getGlobalFormat(); + String getGlobalRole(); + String getGlobalDatabase(); + String getGlobalDatasource(); + String getGlobalNamespace(); + String getGlobalCatalog(); + String getGlobalSchema(); + Boolean getGlobalExplain(); + String getGlobalCache(); int getTransactionIsolation(); @@ -137,5 +128,7 @@ JSONObject parseCorrectRequest(RequestMethod method, String tag, int version, St void commit() throws SQLException; void close(); + M newSuccessResult(); + M newErrorResult(Exception e); } diff --git a/APIJSONORM/src/main/java/apijson/orm/ParserCreator.java b/APIJSONORM/src/main/java/apijson/orm/ParserCreator.java index 2af2767c3..f3f8d375b 100755 --- a/APIJSONORM/src/main/java/apijson/orm/ParserCreator.java +++ b/APIJSONORM/src/main/java/apijson/orm/ParserCreator.java @@ -1,4 +1,4 @@ -/*Copyright (C) 2020 THL A29 Limited, a Tencent company. All rights reserved. +/*Copyright (C) 2020 Tencent. All rights reserved. This source code is licensed under the Apache License Version 2.0.*/ @@ -7,14 +7,17 @@ import apijson.NotNull; +import java.util.List; +import java.util.Map; + /**SQL相关创建器 * @author Lemon */ -public interface ParserCreator { +public interface ParserCreator, L extends List> { @NotNull - Parser createParser(); + Parser createParser(); @NotNull - FunctionParser createFunctionParser(); + FunctionParser createFunctionParser(); } diff --git a/APIJSONORM/src/main/java/apijson/orm/SQLConfig.java b/APIJSONORM/src/main/java/apijson/orm/SQLConfig.java index ed466e2cf..5386d160e 100755 --- a/APIJSONORM/src/main/java/apijson/orm/SQLConfig.java +++ b/APIJSONORM/src/main/java/apijson/orm/SQLConfig.java @@ -1,4 +1,4 @@ -/*Copyright (C) 2020 THL A29 Limited, a Tencent company. All rights reserved. +/*Copyright (C) 2020 Tencent. All rights reserved. This source code is licensed under the Apache License Version 2.0.*/ @@ -10,18 +10,50 @@ import apijson.NotNull; import apijson.RequestMethod; -import apijson.RequestRole; +import apijson.StringUtil; /**SQL配置 * @author Lemon */ -public interface SQLConfig { - - String DATABASE_MYSQL = "MYSQL"; - String DATABASE_POSTGRESQL = "POSTGRESQL"; - String DATABASE_SQLSERVER = "SQLSERVER"; - String DATABASE_ORACLE = "ORACLE"; - String DATABASE_DB2 = "DB2"; +public interface SQLConfig, L extends List> { + + String DATABASE_MYSQL = "MYSQL"; // https://www.mysql.com + String DATABASE_POSTGRESQL = "POSTGRESQL"; // https://www.postgresql.org + String DATABASE_SQLSERVER = "SQLSERVER"; // https://www.microsoft.com/en-us/sql-server + String DATABASE_ORACLE = "ORACLE"; // https://www.oracle.com/database + String DATABASE_DB2 = "DB2"; // https://www.ibm.com/products/db2 + String DATABASE_MARIADB = "MARIADB"; // https://mariadb.org + String DATABASE_TIDB = "TIDB"; // https://www.pingcap.com/tidb + String DATABASE_COCKROACHDB = "COCKROACHDB"; // https://www.cockroachlabs.com + String DATABASE_DAMENG = "DAMENG"; // https://www.dameng.com + String DATABASE_KINGBASE = "KINGBASE"; // https://www.kingbase.com.cn + String DATABASE_ELASTICSEARCH = "ELASTICSEARCH"; // https://www.elastic.co/guide/en/elasticsearch/reference/7.4/xpack-sql.html + String DATABASE_MANTICORE = "MANTICORE"; // https://manticoresearch.com + String DATABASE_CLICKHOUSE = "CLICKHOUSE"; // https://clickhouse.com + String DATABASE_HIVE = "HIVE"; // https://hive.apache.org + String DATABASE_PRESTO = "PRESTO"; // Facebook PrestoDB https://prestodb.io + String DATABASE_TRINO = "TRINO"; // PrestoSQL https://trino.io + String DATABASE_DORIS = "DORIS"; // https://doris.apache.org + String DATABASE_SNOWFLAKE = "SNOWFLAKE"; // https://www.snowflake.com + String DATABASE_DATABEND = "DATABEND"; // https://www.databend.com + String DATABASE_DATABRICKS = "DATABRICKS"; // https://www.databricks.com + String DATABASE_CASSANDRA = "CASSANDRA"; // https://cassandra.apache.org + String DATABASE_MILVUS = "MILVUS"; // https://milvus.io + String DATABASE_INFLUXDB = "INFLUXDB"; // https://www.influxdata.com/products/influxdb-overview + String DATABASE_TDENGINE = "TDENGINE"; // https://tdengine.com + String DATABASE_TIMESCALEDB = "TIMESCALEDB"; // https://www.timescale.com + String DATABASE_QUESTDB = "QUESTDB"; // https://questdb.com + String DATABASE_IOTDB = "IOTDB"; // https://iotdb.apache.org/zh/UserGuide/latest/API/Programming-JDBC.html + + String DATABASE_REDIS = "REDIS"; // https://redisql.com + String DATABASE_MONGODB = "MONGODB"; // https://www.mongodb.com/docs/atlas/data-federation/query/query-with-sql + String DATABASE_KAFKA = "KAFKA"; // https://github.com/APIJSON/APIJSON-Demo/tree/master/APIJSON-Java-Server/APIJSONDemo-MultiDataSource-Kafka + String DATABASE_SQLITE = "SQLITE"; // https://www.sqlite.org + String DATABASE_DUCKDB = "DUCKDB"; // https://duckdb.org + String DATABASE_SURREALDB = "SURREALDB"; // https://surrealdb.com + String DATABASE_OPENGAUSS = "OPENGAUSS"; // https://opengauss.org + + String DATABASE_MQ = "MQ"; // String SCHEMA_INFORMATION = "information_schema"; //MySQL, PostgreSQL, SQL Server 都有的系统模式 String SCHEMA_SYS = "sys"; //SQL Server 系统模式 @@ -32,19 +64,83 @@ public interface SQLConfig { int TYPE_ITEM = 1; int TYPE_ITEM_CHILD_0 = 2; + Parser gainParser(); + + SQLConfig setParser(Parser parser); + + ObjectParser gainObjectParser(); + + SQLConfig setObjectParser(ObjectParser objectParser); + + int getVersion(); + + SQLConfig setVersion(int version); + + String getTag(); + + SQLConfig setTag(String tag); + + boolean isTSQL(); + boolean isMSQL(); + boolean isPSQL(); + boolean isMySQL(); boolean isPostgreSQL(); boolean isSQLServer(); boolean isOracle(); boolean isDb2(); - //暂时只兼容以上 5 种 + boolean isMariaDB(); + boolean isTiDB(); + boolean isCockroachDB(); + boolean isDameng(); + boolean isKingBase(); + boolean isElasticsearch(); + boolean isManticore(); + boolean isClickHouse(); + boolean isHive(); + boolean isPresto(); + boolean isTrino(); + boolean isSnowflake(); + boolean isDatabend(); + boolean isDatabricks(); + boolean isCassandra(); + boolean isMilvus(); + boolean isInfluxDB(); + boolean isTDengine(); + boolean isTimescaleDB(); + boolean isQuestDB(); + boolean isIoTDB(); + boolean isRedis(); + boolean isMongoDB(); + boolean isKafka(); + boolean isMQ(); + boolean isSQLite(); + boolean isDuckDB(); + boolean isSurrealDB(); + boolean isOpenGauss(); + boolean isDoris(); + + + // 暂时只兼容以上几种 // boolean isSQL(); // boolean isTSQL(); // boolean isPLSQL(); // boolean isAnsiSQL(); - boolean limitSQLCount(); //用来给 Table, Column 等系统属性表来绕过 MAX_SQL_COUNT 等限制 - + /**用来给 Table, Column 等系统属性表来绕过 MAX_SQL_COUNT 等限制 + * @return + */ + boolean limitSQLCount(); + + /**是否开启 WITH AS 表达式来简化 SQL 和提升性能 + * @return + */ + boolean isWithAsEnable(); + /**允许增删改部分失败 + * @return + */ + boolean allowPartialUpdateFailed(); + @NotNull String getIdKey(); @NotNull @@ -55,125 +151,196 @@ public interface SQLConfig { * MYSQL: 8.0, 5.7, 5.6 等； PostgreSQL: 11, 10, 9.6 等 * @return */ - String getDBVersion(); + String gainDBVersion(); + + @NotNull + default int[] gainDBVersionNums() { + String dbVersion = StringUtil.noBlank(gainDBVersion()); + if (dbVersion.isEmpty()) { + return new int[]{0}; + } + + int index = dbVersion.indexOf("-"); + if (index > 0) { + dbVersion = dbVersion.substring(0, index); + } + + String[] ss = dbVersion.split("[.]"); + int[] nums = new int[Math.max(1, ss.length)]; + for (int i = 0; i < ss.length; i++) { + nums[i] = Integer.valueOf(ss[i]); + } + + return nums; + } /**获取数据库地址 * @return */ - String getDBUri(); + String gainDBUri(); /**获取数据库账号 * @return */ - String getDBAccount(); + String gainDBAccount(); /**获取数据库密码 * @return */ - String getDBPassword(); + String gainDBPassword(); /**获取SQL语句 * @return * @throws Exception */ - String getSQL(boolean prepared) throws Exception; + String gainSQL(boolean prepared) throws Exception; boolean isTest(); - SQLConfig setTest(boolean test); + SQLConfig setTest(boolean test); int getType(); - SQLConfig setType(int type); + SQLConfig setType(int type); int getCount(); - SQLConfig setCount(int count); + SQLConfig setCount(int count); int getPage(); - SQLConfig setPage(int page); + SQLConfig setPage(int page); int getQuery(); - SQLConfig setQuery(int query); + SQLConfig setQuery(int query); + + Boolean getCompat(); + SQLConfig setCompat(Boolean compat); int getPosition(); - SQLConfig setPosition(int position); + SQLConfig setPosition(int position); int getCache(); - SQLConfig setCache(int cache); + SQLConfig setCache(int cache); boolean isExplain(); - SQLConfig setExplain(boolean explain); + SQLConfig setExplain(boolean explain); RequestMethod getMethod(); - SQLConfig setMethod(RequestMethod method); + SQLConfig setMethod(RequestMethod method); Object getId(); - SQLConfig setId(Object id); + SQLConfig setId(Object id); - RequestRole getRole(); - SQLConfig setRole(RequestRole role); + Object getIdIn(); + SQLConfig setIdIn(Object idIn); + + Object getUserId(); + SQLConfig setUserId(Object userId); + + Object getUserIdIn(); + SQLConfig setUserIdIn(Object userIdIn); + + String getRole(); + SQLConfig setRole(String role); public boolean isDistinct(); - public SQLConfig setDistinct(boolean distinct); + public SQLConfig setDistinct(boolean distinct); String getDatabase(); - SQLConfig setDatabase(String database); + SQLConfig setDatabase(String database); - String getQuote(); + String getSQLNamespace(); + String getNamespace(); + SQLConfig setNamespace(String namespace); + String gainSQLCatalog(); + String getCatalog(); + SQLConfig setCatalog(String catalog); + + String gainSQLSchema(); String getSchema(); - SQLConfig setSchema(String schema); + SQLConfig setSchema(String schema); + + String getDatasource(); + SQLConfig setDatasource(String datasource); + + String getQuote(); + + List getJson(); + SQLConfig setJson(List json); /**请求传进来的Table名 * @return - * @see {@link #getSQLTable()} + * @see {@link #gainSQLTable()} */ String getTable(); + + SQLConfig setTable(String table); + /**数据库里的真实Table名 - * 通过 {@link #TABLE_KEY_MAP} 映射 + * 通过 {@link AbstractSQLConfig.TABLE_KEY_MAP} 映射 * @return */ - String getSQLTable(); + String gainSQLTable(); + + String gainTablePath(); - String getTablePath(); + Map getKeyMap(); + SQLConfig setKeyMap(Map keyMap); List getRaw(); - SQLConfig setRaw(List raw); + SQLConfig setRaw(List raw); - SQLConfig setTable(String table); + Subquery getFrom(); + SQLConfig setFrom(Subquery from); - String getGroup(); - SQLConfig setGroup(String group); + List getColumn(); + SQLConfig setColumn(List column); - String getHaving(); - SQLConfig setHaving(String having); + List> getValues(); + SQLConfig setValues(List> values); - String getOrder(); - SQLConfig setOrder(String order); + Map getContent(); + SQLConfig setContent(Map content); - List getJson(); - SQLConfig setJson(List json); - - Subquery getFrom(); - SQLConfig setFrom(Subquery from); + Map> getCombineMap(); + SQLConfig setCombineMap(Map> combineMap); - List getColumn(); - SQLConfig setColumn(List column); + String getCombine(); + SQLConfig setCombine(String combine); - List> getValues(); - SQLConfig setValues(List> values); + Map getCast(); + SQLConfig setCast(Map cast); - Map getContent(); - SQLConfig setContent(Map content); + List getNull(); + SQLConfig setNull(List nulls); Map getWhere(); - SQLConfig setWhere(Map where); + SQLConfig setWhere(Map where); + + String getGroup(); + SQLConfig setGroup(String group); + + Map getHaving(); + SQLConfig setHaving(Map having); + + String getHavingCombine(); + SQLConfig setHavingCombine(String havingCombine); + + String getSample(); + SQLConfig setSample(String order); + + String getLatest(); + SQLConfig setLatest(String latest); - Map> getCombine(); - SQLConfig setCombine(Map> combine); + String getPartition(); + SQLConfig setPartition(String partition); + String getFill(); + SQLConfig setFill(String fill); + String getOrder(); + SQLConfig setOrder(String order); /** * exactMatch = false @@ -192,45 +359,65 @@ public interface SQLConfig { * @param value * @return */ - SQLConfig putWhere(String key, Object value, boolean prior); + SQLConfig putWhere(String key, Object value, boolean prior); boolean isPrepared(); - SQLConfig setPrepared(boolean prepared); + SQLConfig setPrepared(boolean prepared); boolean isMain(); - SQLConfig setMain(boolean main); + SQLConfig setMain(boolean main); List getPreparedValueList(); - SQLConfig setPreparedValueList(List preparedValueList); + SQLConfig setPreparedValueList(List preparedValueList); String getAlias(); - SQLConfig setAlias(String alias); + SQLConfig setAlias(String alias); - String getWhereString(boolean hasPrefix) throws Exception; + default String gainTableKey() { + String alias = getAlias(); + return getTable() + (StringUtil.isEmpty(alias) ? "" : ":" + alias); + } - String getRawSQL(String key, Object value) throws Exception; + default String gainSQLAlias() { + return gainSQLAlias(getTable(), getAlias()); + } + static String gainSQLAlias(@NotNull String table, String alias) { + // 这里不用 : $ 等符号，因为部分数据库/引擎似乎不支持 `key`, "key", [key] 等避免关键词冲突的方式，只能使用符合变量命名的表别名 + return StringUtil.isEmpty(alias) ? table : table + "__" + alias; // 带上原表名，避免 alias 和其它表名/字段名冲突 + } - boolean isKeyPrefix(); - SQLConfig setKeyPrefix(boolean keyPrefix); + String gainWhereString(boolean hasPrefix) throws Exception; + String gainRawSQL(String key, Object value) throws Exception; + String gainRawSQL(String key, Object value, boolean throwWhenMissing) throws Exception; + + boolean isKeyPrefix(); - List getJoinList(); + SQLConfig setKeyPrefix(boolean keyPrefix); - SQLConfig setJoinList(List joinList); + List> getJoinList(); + SQLConfig setJoinList(List> joinList); boolean hasJoin(); - String getSubqueryString(Subquery subquery) throws Exception; + String gainSubqueryString(Subquery subquery) throws Exception; + + SQLConfig setProcedure(String procedure); + + + List getWithAsExprPreparedValueList(); + SQLConfig setWithAsExprPreparedValueList(List withAsExprePreparedValueList); - SQLConfig setProcedure(String procedure); + boolean isFakeDelete(); + Map onFakeDelete(Map map); } diff --git a/APIJSONORM/src/main/java/apijson/orm/SQLCreator.java b/APIJSONORM/src/main/java/apijson/orm/SQLCreator.java index 11d7d2c89..77625cfa6 100755 --- a/APIJSONORM/src/main/java/apijson/orm/SQLCreator.java +++ b/APIJSONORM/src/main/java/apijson/orm/SQLCreator.java @@ -1,4 +1,4 @@ -/*Copyright (C) 2020 THL A29 Limited, a Tencent company. All rights reserved. +/*Copyright (C) 2020 Tencent. All rights reserved. This source code is licensed under the Apache License Version 2.0.*/ @@ -7,14 +7,17 @@ import apijson.NotNull; +import java.util.List; +import java.util.Map; + /**SQL相关创建器 * @author Lemon */ -public interface SQLCreator { +public interface SQLCreator, L extends List> { @NotNull - SQLConfig createSQLConfig(); + SQLConfig createSQLConfig(); @NotNull - SQLExecutor createSQLExecutor(); + SQLExecutor createSQLExecutor(); } diff --git a/APIJSONORM/src/main/java/apijson/orm/SQLExecutor.java b/APIJSONORM/src/main/java/apijson/orm/SQLExecutor.java index b2b0425d5..6540771d7 100755 --- a/APIJSONORM/src/main/java/apijson/orm/SQLExecutor.java +++ b/APIJSONORM/src/main/java/apijson/orm/SQLExecutor.java @@ -1,4 +1,4 @@ -/*Copyright (C) 2020 THL A29 Limited, a Tencent company. All rights reserved. +/*Copyright (C) 2020 Tencent. All rights reserved. This source code is licensed under the Apache License Version 2.0.*/ @@ -12,73 +12,91 @@ import java.sql.Savepoint; import java.sql.Statement; import java.util.List; +import java.util.Map; -import com.alibaba.fastjson.JSONObject; - -import apijson.NotNull; +import apijson.*; /**executor for query(read) or update(write) MySQL database * @author Lemon */ -public interface SQLExecutor { +public interface SQLExecutor, L extends List> { + Parser getParser(); + SQLExecutor setParser(Parser parser); /**保存缓存 * @param sql - * @param map - * @param type + * @param list + * @param config */ - void putCache(String sql, List list, int type);; - - List getCache(String sql, int type); + void putCache(String sql, List list, SQLConfig config); - /**移除缓存 + /**获取缓存 * @param sql - * @param type + * @param config + * @return */ - void removeCache(String sql, int type); + List getCache(String sql, SQLConfig config); + /**获取缓存 * @param sql * @param position - * @param type + * @param config * @return */ - JSONObject getCacheItem(String sql, int position, int type); + M getCacheItem(String sql, int position, SQLConfig config); + /**移除缓存 + * @param sql + * @param config + */ + void removeCache(String sql, SQLConfig config); /**执行SQL * @param config + * @param unknownType * @return * @throws Exception */ - JSONObject execute(@NotNull SQLConfig config, boolean unknowType) throws Exception; - + M execute(@NotNull SQLConfig config, boolean unknownType) throws Exception; + //executeQuery和executeUpdate这两个函数因为返回类型不同，所以不好合并 /**执行查询 - * @param sql + * @param config * @return * @throws SQLException */ - ResultSet executeQuery(@NotNull SQLConfig config) throws Exception; - + default ResultSet executeQuery(@NotNull SQLConfig config) throws Exception { + return executeQuery(config, null); + } + ResultSet executeQuery(@NotNull SQLConfig config, String sql) throws Exception; + /**执行增、删、改 - * @param sql + * @param config * @return * @throws SQLException */ - int executeUpdate(@NotNull SQLConfig config) throws Exception; - + default int executeUpdate(@NotNull SQLConfig config) throws Exception { + return executeUpdate(config, null); + } + int executeUpdate(@NotNull SQLConfig config, String sql) throws Exception; + /**判断是否为JSON类型 - * @param rsmd - * @param position - * @return - */ - boolean isJSONType(@NotNull SQLConfig config, ResultSetMetaData rsmd, int position, String lable); + * @param config + * @param rsmd + * @param position + * @param label + * @return + */ + boolean isJSONType(@NotNull SQLConfig config, ResultSetMetaData rsmd, int position, String label); + + + Connection getConnection(@NotNull SQLConfig config) throws Exception; + default Statement getStatement(@NotNull SQLConfig config) throws Exception { + return getStatement(config, null); + } + Statement getStatement(@NotNull SQLConfig config, String sql) throws Exception; - - Connection getConnection(@NotNull SQLConfig config) throws Exception; - Statement getStatement(@NotNull SQLConfig config) throws Exception; - int getTransactionIsolation(); void setTransactionIsolation(int transactionIsolation); /**开始事务 @@ -100,11 +118,11 @@ public interface SQLExecutor { /**关闭连接，释放资源 */ void close(); - + ResultSet executeQuery(@NotNull Statement statement, String sql) throws Exception; - + int executeUpdate(@NotNull Statement statement, String sql) throws Exception; - + ResultSet execute(@NotNull Statement statement, String sql) throws Exception; int getGeneratedSQLCount(); @@ -113,5 +131,8 @@ public interface SQLExecutor { int getExecutedSQLCount(); - + long getExecutedSQLDuration(); + + long getSqlResultDuration(); + } diff --git a/APIJSONORM/src/main/java/apijson/orm/Structure.java b/APIJSONORM/src/main/java/apijson/orm/Structure.java deleted file mode 100755 index b5d146f90..000000000 --- a/APIJSONORM/src/main/java/apijson/orm/Structure.java +++ /dev/null @@ -1,241 +0,0 @@ -/*Copyright (C) 2020 THL A29 Limited, a Tencent company. All rights reserved. - -This source code is licensed under the Apache License Version 2.0.*/ - - -package apijson.orm; - -import java.util.Map; -import java.util.regex.Pattern; - -import javax.activation.UnsupportedDataTypeException; - -import com.alibaba.fastjson.JSONObject; - -import apijson.JSON; -import apijson.Log; -import apijson.NotNull; -import apijson.RequestMethod; -import apijson.orm.AbstractSQLConfig.Callback; -import apijson.orm.AbstractSQLConfig.IdCallback; - -/**结构类。已整合进 AbstractVerifier，最快 4.5.0 移除 - * 增删改查: OPERATION(ADD,REPLACE,PUT,REMOVE) OPERATION:{key0:value0, key1:value1 ...} - * 对值校验: VERIFY:{key0:value0, key1:value1 ...} (key{}:range,key$:"%m%"等) - * 对值重复性校验: UNIQUE:"key0:, key1 ..." (UNIQUE:"phone,email" 等) - * @author Lemon - */ -@Deprecated -public class Structure { - public static final String TAG = "Structure"; - - public static final Map COMPILE_MAP = AbstractVerifier.COMPILE_MAP; - - private Structure() {} - - - /**从request提取target指定的内容 - * @param method - * @param name - * @param target - * @param request - * @param creator - * @return - * @throws Exception - */ - public static JSONObject parseRequest(@NotNull final RequestMethod method, final String name - , final JSONObject target, final JSONObject request, final SQLCreator creator) throws Exception { - return parseRequest(method, name, target, request, Parser.MAX_UPDATE_COUNT, creator); - } - /**从request提取target指定的内容 - * @param method - * @param name - * @param target - * @param request - * @param maxUpdateCount - * @param creator - * @return - * @throws Exception - */ - public static JSONObject parseRequest(@NotNull final RequestMethod method, final String name - , final JSONObject target, final JSONObject request, final int maxUpdateCount, final SQLCreator creator) throws Exception { - return parseRequest(method, name, target, request, maxUpdateCount, null, null, null, creator); - } - /**从request提取target指定的内容 - * @param method - * @param name - * @param target - * @param request - * @param maxUpdateCount - * @param idKey - * @param userIdKey - * @param creator - * @return - * @throws Exception - */ - public static JSONObject parseRequest(@NotNull final RequestMethod method, final String name - , final JSONObject target, final JSONObject request, final int maxUpdateCount - , final String database, final String schema, final IdCallback idCallback, final SQLCreator creator) throws Exception { - - return AbstractVerifier.verifyRequest(method, name, target, request, maxUpdateCount, database, schema, idCallback, creator); - } - - /**校验并将response转换为指定的内容和结构 - * @param method - * @param name - * @param target - * @param response - * @param callback - * @param creator - * @return - * @throws Exception - */ - public static JSONObject parseResponse(@NotNull final RequestMethod method, final String name - , final JSONObject target, final JSONObject response, SQLCreator creator, OnParseCallback callback) throws Exception { - return parseResponse(method, name, target, response, null, null, null, creator, callback); - } - /**校验并将response转换为指定的内容和结构 - * @param method - * @param name - * @param target - * @param response - * @param idKey - * @param callback - * @param creator - * @return - * @throws Exception - */ - public static JSONObject parseResponse(@NotNull final RequestMethod method, final String name - , final JSONObject target, final JSONObject response, final String database, final String schema - , final Callback idKeyCallback, SQLCreator creator, OnParseCallback callback) throws Exception { - - Log.i(TAG, "parseResponse method = " + method + "; name = " + name - + "; target = \n" + JSON.toJSONString(target) - + "\n response = \n" + JSON.toJSONString(response)); - - if (target == null || response == null) {// || target.isEmpty() { - Log.i(TAG, "parseRequest target == null || response == null >> return response;"); - return response; - } - - //解析 - return parse(method, name, target, response, database, schema, idKeyCallback, creator, callback != null ? callback : new OnParseCallback() {}); - } - - - /**对request和response不同的解析用callback返回 - * @param method - * @param name - * @param target - * @param real - * @param creator - * @param callback - * @return - * @throws Exception - */ - public static JSONObject parse(@NotNull final RequestMethod method, String name, JSONObject target, JSONObject real - , SQLCreator creator, @NotNull OnParseCallback callback) throws Exception { - return parse(method, name, target, real, null, null, null, creator, callback); - } - - /**对request和response不同的解析用callback返回 - * @param method - * @param name - * @param target - * @param real - * @param idKey - * @param userIdKey - * @param creator - * @param callback - * @return - * @throws Exception - */ - public static JSONObject parse(@NotNull final RequestMethod method, String name, JSONObject target, JSONObject real - , final String database, final String schema, final IdCallback idCallback, SQLCreator creator, @NotNull OnParseCallback callback) throws Exception { - return AbstractVerifier.parse(method, name, target, real, database, schema, idCallback, creator, callback); - } - - - - /**验证值类型 - * @param tk - * @param tv {@link Operation} - * @param real - * @throws Exception - */ - public static void type(@NotNull String tk, Object tv, @NotNull JSONObject real) throws UnsupportedDataTypeException { - if (tv instanceof String == false) { - throw new UnsupportedDataTypeException("服务器内部错误，" + tk + ":value 的value不合法！" - + "Request表校验规则中 TYPE:{ key:value } 中的value只能是String类型！"); - } - - type(tk, (String) tv, real.get(tk)); - } - /**验证值类型 - * @param tk - * @param tv {@link Operation} - * @param rv - * @throws Exception - */ - public static void type(@NotNull String tk, @NotNull String tv, Object rv) throws UnsupportedDataTypeException { - type(tk, tv, rv, false); - } - /**验证值类型 - * @param tk - * @param tv {@link Operation} - * @param rv - * @param isInArray - * @throws Exception - */ - public static void type(@NotNull String tk, @NotNull String tv, Object rv, boolean isInArray) throws UnsupportedDataTypeException { - AbstractVerifier.verifyType(tk, tv, rv, isInArray); - } - - - /**验证是否存在 - * @param table - * @param key - * @param value - * @throws Exception - */ - public static void verifyExist(String table, String key, Object value, long exceptId, @NotNull SQLCreator creator) throws Exception { - AbstractVerifier.verifyExist(table, key, value, exceptId, creator); - } - - /**验证是否重复 - * @param table - * @param key - * @param value - * @throws Exception - */ - public static void verifyRepeat(String table, String key, Object value, @NotNull SQLCreator creator) throws Exception { - verifyRepeat(table, key, value, 0, creator); - } - - /**验证是否重复 - * @param table - * @param key - * @param value - * @param exceptId 不包含id - * @throws Exception - */ - public static void verifyRepeat(String table, String key, Object value, long exceptId, @NotNull SQLCreator creator) throws Exception { - verifyRepeat(table, key, value, exceptId, null, creator); - } - - /**验证是否重复 - * TODO 与 AbstractVerifier.verifyRepeat 代码重复，需要简化 - * @param table - * @param key - * @param value - * @param exceptId 不包含id - * @param idKey - * @param creator - * @throws Exception - */ - public static void verifyRepeat(String table, String key, Object value, long exceptId, String idKey, @NotNull SQLCreator creator) throws Exception { - AbstractVerifier.verifyRepeat(table, key, value, exceptId, idKey, creator); - } - - -} diff --git a/APIJSONORM/src/main/java/apijson/orm/Subquery.java b/APIJSONORM/src/main/java/apijson/orm/Subquery.java index 66fdf14df..ce6e72445 100644 --- a/APIJSONORM/src/main/java/apijson/orm/Subquery.java +++ b/APIJSONORM/src/main/java/apijson/orm/Subquery.java @@ -1,83 +1,74 @@ -/*Copyright (C) 2020 THL A29 Limited, a Tencent company. All rights reserved. +/*Copyright (C) 2020 Tencent. All rights reserved. This source code is licensed under the Apache License Version 2.0.*/ package apijson.orm; -import com.alibaba.fastjson.JSONObject; -import com.alibaba.fastjson.annotation.JSONField; +import java.util.List; +import java.util.Map; /**子查询 配置 * @author Lemon */ -public class Subquery { +public class Subquery, L extends List> { private String path; // []/0/User private String originKey; //id{}@ - private JSONObject originValue; // { "from": "Comment", "Comment": {...} } + private M originValue; // { "from": "Comment", "Comment": {...} } private String from; // Comment - private String range; // any, all + private String range; // ANY, ALL private String key; //id{} - private SQLConfig config; + private SQLConfig config; - @JSONField(serialize = false) //解决泄漏 SQLConfig 里的 dbPassword 等 - public String getPath() { + public String gainPath() { return path; } public void setPath(String path) { this.path = path; } - @JSONField(serialize = false) //解决泄漏 SQLConfig 里的 dbPassword 等 - public String getOriginKey() { + public String gainOriginKey() { return originKey; } public void setOriginKey(String originKey) { this.originKey = originKey; } - @JSONField(serialize = false) //解决泄漏 SQLConfig 里的 dbPassword 等 - public JSONObject getOriginValue() { + public M gainOriginValue() { return originValue; } - public void setOriginValue(JSONObject originValue) { + public void setOriginValue(M originValue) { this.originValue = originValue; } - @JSONField(serialize = false) //解决泄漏 SQLConfig 里的 dbPassword 等 - public String getFrom() { + public String gainFrom() { return from; } public void setFrom(String from) { this.from = from; } - @JSONField(serialize = false) //解决泄漏 SQLConfig 里的 dbPassword 等 - public String getRange() { + public String gainRange() { return range; } public void setRange(String range) { this.range = range; } - @JSONField(serialize = false) //解决泄漏 SQLConfig 里的 dbPassword 等 - public String getKey() { + public String gainKey() { return key; } public void setKey(String key) { this.key = key; } - @JSONField(serialize = false) //解决泄漏 SQLConfig 里的 dbPassword 等 - public SQLConfig getConfig() { + public SQLConfig gainConfig() { return config; } - public void setConfig(SQLConfig config) { + public void setConfig(SQLConfig config) { this.config = config; } - - } diff --git a/APIJSONORM/src/main/java/apijson/orm/Verifier.java b/APIJSONORM/src/main/java/apijson/orm/Verifier.java index b91549ec0..4b926519a 100755 --- a/APIJSONORM/src/main/java/apijson/orm/Verifier.java +++ b/APIJSONORM/src/main/java/apijson/orm/Verifier.java @@ -1,54 +1,45 @@ -/*Copyright (C) 2020 THL A29 Limited, a Tencent company. All rights reserved. +/*Copyright (C) 2020 Tencent. All rights reserved. This source code is licensed under the Apache License Version 2.0.*/ package apijson.orm; -import com.alibaba.fastjson.JSONObject; +import java.util.List; +import java.util.Map; -import apijson.NotNull; -import apijson.RequestMethod; -import apijson.RequestRole; +import apijson.*; /**校验器(权限、请求参数、返回结果等) * @author Lemon */ -public interface Verifier { +public interface Verifier, L extends List> { + - /**验证权限是否通过，用 verifyAccess 替代，最早 4.5.0 移除 - * @param config - * @param visitor - * @return - * @throws Exception - */ - @Deprecated - boolean verify(SQLConfig config) throws Exception; /**验证权限是否通过 * @param config - * @param visitor * @return * @throws Exception */ - boolean verifyAccess(SQLConfig config) throws Exception; + boolean verifyAccess(SQLConfig config) throws Exception; + - /**允许请求，角色不好判断，让访问者发过来角色名，OWNER,CONTACT,ADMIN等 + /**校验请求使用的角色，角色不好判断，让访问者发过来角色名，OWNER,CONTACT,ADMIN等 + * @param config * @param table * @param method * @param role * @return * @throws Exception - * @see {@link apijson.JSONObject#KEY_ROLE} + * @see {@link JSONMap#KEY_ROLE} */ - void verifyRole(String table, RequestMethod method, RequestRole role) throws Exception; + void verifyRole(SQLConfig config, String table, RequestMethod method, String role) throws Exception; /**登录校验 - * @param config * @throws Exception */ void verifyLogin() throws Exception; /**管理员角色校验 - * @param config * @throws Exception */ void verifyAdmin() throws Exception; @@ -73,33 +64,48 @@ public interface Verifier { void verifyRepeat(String table, String key, Object value, long exceptId) throws Exception; /**验证请求参数的数据和结构 - * @param table - * @param key - * @param value - * @param exceptId 不包含id + * @param method + * @param name + * @param target + * @param request + * @param maxUpdateCount + * @param globalDatabase + * @param globalSchema + * @param creator + * @return * @throws Exception */ - JSONObject verifyRequest(RequestMethod method, String name, JSONObject target, JSONObject request, - int maxUpdateCount, String globleDatabase, String globleSchema, SQLCreator creator) throws Exception; + M verifyRequest(RequestMethod method, String name, M target, M request, + int maxUpdateCount, String globalDatabase, String globalSchema) throws Exception; /**验证返回结果的数据和结构 - * @param table - * @param key - * @param value - * @param exceptId 不包含id + * @param method + * @param name + * @param target + * @param response + * @param database + * @param schema + * @param creator + * @param callback + * @return * @throws Exception */ - JSONObject verifyResponse(RequestMethod method, String name, JSONObject target, JSONObject response, - String database, String schema, SQLCreator creator, OnParseCallback callback) throws Exception; + M verifyResponse( + RequestMethod method, String name, M target, M response, + String database, String schema, @NotNull Parser parser, OnParseCallback callback + ) throws Exception; @NotNull - Parser createParser(); + Parser createParser(); + + Parser getParser(); + Verifier setParser(AbstractParser parser); @NotNull Visitor getVisitor(); - Verifier setVisitor(@NotNull Visitor visitor); + Verifier setVisitor(@NotNull Visitor visitor); - String getVisitorIdKey(SQLConfig config); + String getVisitorIdKey(SQLConfig config); } diff --git a/APIJSONORM/src/main/java/apijson/orm/VerifierCreator.java b/APIJSONORM/src/main/java/apijson/orm/VerifierCreator.java index 735b1104d..374290989 100644 --- a/APIJSONORM/src/main/java/apijson/orm/VerifierCreator.java +++ b/APIJSONORM/src/main/java/apijson/orm/VerifierCreator.java @@ -1,4 +1,4 @@ -/*Copyright (C) 2020 THL A29 Limited, a Tencent company. All rights reserved. +/*Copyright (C) 2020 Tencent. All rights reserved. This source code is licensed under the Apache License Version 2.0.*/ @@ -7,11 +7,14 @@ import apijson.NotNull; +import java.util.List; +import java.util.Map; + /**验证器相关创建器 * @author Lemon */ -public interface VerifierCreator { +public interface VerifierCreator, L extends List> { @NotNull - Verifier createVerifier(); + Verifier createVerifier(); } diff --git a/APIJSONORM/src/main/java/apijson/orm/Visitor.java b/APIJSONORM/src/main/java/apijson/orm/Visitor.java index f474bd91e..5d1b6063d 100755 --- a/APIJSONORM/src/main/java/apijson/orm/Visitor.java +++ b/APIJSONORM/src/main/java/apijson/orm/Visitor.java @@ -1,4 +1,4 @@ -/*Copyright (C) 2020 THL A29 Limited, a Tencent company. All rights reserved. +/*Copyright (C) 2020 Tencent. All rights reserved. This source code is licensed under the Apache License Version 2.0.*/ diff --git a/APIJSONORM/src/main/java/apijson/orm/exception/CommonException.java b/APIJSONORM/src/main/java/apijson/orm/exception/CommonException.java new file mode 100755 index 000000000..7e2884ef7 --- /dev/null +++ b/APIJSONORM/src/main/java/apijson/orm/exception/CommonException.java @@ -0,0 +1,305 @@ +/*Copyright (C) 2020 Tencent. All rights reserved. + +This source code is licensed under the Apache License Version 2.0.*/ + + +package apijson.orm.exception; + +import java.io.UnsupportedEncodingException; +import java.net.HttpRetryException; +import java.sql.SQLException; +import java.util.concurrent.TimeoutException; + +import apijson.JSONResponse; +import apijson.Log; +import apijson.StringUtil; +import apijson.orm.AbstractSQLConfig; +import apijson.orm.SQLConfig; + +/**异常包装器，主要用来包装构造器没有 Throwable 参数的 Exception + * @author Lemon + */ +public class CommonException extends Exception { + private static final long serialVersionUID = 1L; + private Integer code; + private String environment; + + public CommonException setCode(Integer code) { + this.code = code; + return this; + } + public Integer getCode() { + if (code == null) { + code = getCode(getCause()); + } + return code; + } + + + public static int getCode(Throwable e) { + boolean isCommon = Log.DEBUG && e instanceof CommonException; + + Integer code = isCommon ? ((CommonException) e).getCode() : null; + if (code != null) { + return code; + } + + Throwable t = isCommon ? e.getCause() : e; + if (t == null) { + return JSONResponse.CODE_SERVER_ERROR; + } + + if (t instanceof HttpRetryException) { + return ((HttpRetryException) t).responseCode(); + } + + if (t instanceof UnsupportedEncodingException) { + return JSONResponse.CODE_UNSUPPORTED_ENCODING; + } + + if (t instanceof IllegalAccessException) { + return JSONResponse.CODE_ILLEGAL_ACCESS; + } + + if (t instanceof UnsupportedOperationException) { + return JSONResponse.CODE_UNSUPPORTED_OPERATION; + } + + if (t instanceof NotExistException) { + return JSONResponse.CODE_NOT_FOUND; + } + + if (t instanceof IllegalArgumentException) { + return JSONResponse.CODE_ILLEGAL_ARGUMENT; + } + + if (t instanceof NotLoggedInException) { + return JSONResponse.CODE_NOT_LOGGED_IN; + } + + if (t instanceof TimeoutException) { + return JSONResponse.CODE_TIME_OUT; + } + + if (t instanceof ConflictException) { + return JSONResponse.CODE_CONFLICT; + } + + if (t instanceof ConditionErrorException) { + return JSONResponse.CODE_CONDITION_ERROR; + } + + if (t instanceof UnsupportedDataTypeException) { + return JSONResponse.CODE_UNSUPPORTED_TYPE; + } + + if (t instanceof OutOfRangeException) { + return JSONResponse.CODE_OUT_OF_RANGE; + } + + if (t instanceof NullPointerException) { + return JSONResponse.CODE_NULL_POINTER; + } + + return JSONResponse.CODE_SERVER_ERROR; + } + + public static String getMsg(Throwable e) { + if (e == null) { + return null; + } + + String msg = e.getMessage(); + if (msg != null) { + return msg; + } + + Throwable t = e.getCause(); + return t == null ? null : t.getMessage(); + } + + public CommonException setEnvironment(String environment) { + this.environment = environment; + return this; + } + + public String getEnvironment() { + return environment; + } + + public CommonException(Throwable t) { + this(null, t); + } + public CommonException(String msg, Throwable t) { + super(msg == null && t != null ? t.getMessage() : null, t); + } + + public CommonException(int code, String msg) { + this(code, msg, null); + } + public CommonException(int code, String msg, Throwable t) { + this(msg, t); + setCode(code); + } + public CommonException(Throwable t, String environment) { + this(null, t); + setEnvironment(environment); + } + + + public static Exception wrap(Exception e, SQLConfig config) { + if (Log.DEBUG == false && e instanceof SQLException) { + return new SQLException("数据库驱动执行异常SQLException，非 Log.DEBUG 模式下不显示详情，避免泄漏真实模式名、表名等隐私信息", e); + } + + // String msg = e.getMessage(); + + if (Log.DEBUG && (e instanceof CommonException == false || ((CommonException) e).getEnvironment() == null)) { + // msg != null && msg.contains(Log.KEY_SYSTEM_INFO_DIVIDER) == false) { + try { + String db = config == null ? AbstractSQLConfig.DEFAULT_DATABASE : (config instanceof AbstractSQLConfig + ? ((AbstractSQLConfig) config).gainSQLDatabase() : config.getDatabase() + ); + + String dbVersion = config == null ? null : config.gainDBVersion(); + if (StringUtil.isEmpty(dbVersion)) { + dbVersion = ""; + } + + if (db != null || config == null) { + db += " " + dbVersion; + } + else if (config.isMySQL()) { + db = SQLConfig.DATABASE_MYSQL + " " + dbVersion; + } + else if (config.isMariaDB()) { + db = SQLConfig.DATABASE_MARIADB + " " + dbVersion; + } + else if (config.isTiDB()) { + db = SQLConfig.DATABASE_TIDB + " " + dbVersion; + } + else if (config.isPostgreSQL()) { + db = SQLConfig.DATABASE_POSTGRESQL + " " + dbVersion; + } + else if (config.isCockroachDB()) { + db = SQLConfig.DATABASE_COCKROACHDB + " " + dbVersion; + } + else if (config.isSQLServer()) { + db = SQLConfig.DATABASE_SQLSERVER + " " + dbVersion; + } + else if (config.isOracle()) { + db = SQLConfig.DATABASE_ORACLE + " " + dbVersion; + } + else if (config.isDb2()) { + db = SQLConfig.DATABASE_DB2 + " " + dbVersion; + } + else if (config.isDuckDB()) { + db = SQLConfig.DATABASE_DUCKDB + " " + dbVersion; + } + else if (config.isSurrealDB()) { + db = SQLConfig.DATABASE_SURREALDB + " " + dbVersion; + } + else if (config.isOpenGauss()) { + db = SQLConfig.DATABASE_OPENGAUSS + " " + dbVersion; + } + else if (config.isDameng()) { + db = SQLConfig.DATABASE_DAMENG + " " + dbVersion; + } + else if (config.isKingBase()) { + db = SQLConfig.DATABASE_KINGBASE + " " + dbVersion; + } + else if (config.isElasticsearch()) { + db = SQLConfig.DATABASE_ELASTICSEARCH + " " + dbVersion; + } + else if (config.isManticore()) { + db = SQLConfig.DATABASE_MANTICORE + " " + dbVersion; + } + else if (config.isClickHouse()) { + db = SQLConfig.DATABASE_CLICKHOUSE + " " + dbVersion; + } + else if (config.isMilvus()) { + db = SQLConfig.DATABASE_MILVUS + " " + dbVersion; + } + else if (config.isInfluxDB()) { + db = SQLConfig.DATABASE_INFLUXDB + " " + dbVersion; + } + else if (config.isTDengine()) { + db = SQLConfig.DATABASE_TDENGINE + " " + dbVersion; + } + else if (config.isTimescaleDB()) { + db = SQLConfig.DATABASE_TIMESCALEDB + " " + dbVersion; + } + else if (config.isQuestDB()) { + db = SQLConfig.DATABASE_QUESTDB + " " + dbVersion; + } + else if (config.isIoTDB()) { + db = SQLConfig.DATABASE_IOTDB + " " + dbVersion; + } + else if (config.isSQLite()) { + db = SQLConfig.DATABASE_SQLITE + " " + dbVersion; + } + else if (config.isHive()) { + db = SQLConfig.DATABASE_HIVE + " " + dbVersion; + } + else if (config.isPresto()) { + db = SQLConfig.DATABASE_PRESTO + " " + dbVersion; + } + else if (config.isTrino()) { + db = SQLConfig.DATABASE_TRINO + " " + dbVersion; + } + else if (config.isDoris()) { + db = SQLConfig.DATABASE_DORIS + " " + dbVersion; + } + else if (config.isSnowflake()) { + db = SQLConfig.DATABASE_SNOWFLAKE + " " + dbVersion; + } + else if (config.isDatabend()) { + db = SQLConfig.DATABASE_DATABEND + " " + dbVersion; + } + else if (config.isDatabricks()) { + db = SQLConfig.DATABASE_DATABRICKS + " " + dbVersion; + } + else if (config.isMongoDB()) { + db = SQLConfig.DATABASE_MONGODB + " " + dbVersion; + } + else if (config.isCassandra()) { + db = SQLConfig.DATABASE_CASSANDRA + " " + dbVersion; + } + else if (config.isRedis()) { + db = SQLConfig.DATABASE_REDIS + " " + dbVersion; + } + else if (config.isKafka()) { + db = SQLConfig.DATABASE_KAFKA + " " + dbVersion; + } + else { + db = ""; + } + +// Class clazz = e.getClass(); +// msg = msg +// + " " + Log.KEY_SYSTEM_INFO_DIVIDER + " **环境信息** " + String env = " **环境信息** " + + " \n 系统: " + Log.OS_NAME + " " + Log.OS_VERSION + + " \n 数据库: " + db + + " \n JDK: " + Log.JAVA_VERSION + " " + Log.OS_ARCH + + " \n APIJSON: " + Log.VERSION; + + if (e instanceof CommonException) { + ((CommonException) e).setEnvironment(env); + return e; + } + +// try { +// e = clazz.getConstructor(String.class, Throwable.class).newInstance(msg, e); +// } +// catch (Throwable e2) { + return new CommonException(e, env); // e = clazz.getConstructor(String.class).newInstance(msg); +// } + } catch (Throwable e2) {} + } + + return e; + } + +} + diff --git a/APIJSONORM/src/main/java/apijson/orm/exception/ConditionErrorException.java b/APIJSONORM/src/main/java/apijson/orm/exception/ConditionErrorException.java index fe2ccd761..44c43a29f 100755 --- a/APIJSONORM/src/main/java/apijson/orm/exception/ConditionErrorException.java +++ b/APIJSONORM/src/main/java/apijson/orm/exception/ConditionErrorException.java @@ -1,4 +1,4 @@ -/*Copyright (C) 2020 THL A29 Limited, a Tencent company. All rights reserved. +/*Copyright (C) 2020 Tencent. All rights reserved. This source code is licensed under the Apache License Version 2.0.*/ diff --git a/APIJSONORM/src/main/java/apijson/orm/exception/ConflictException.java b/APIJSONORM/src/main/java/apijson/orm/exception/ConflictException.java index ee258eee9..a39d88d3b 100755 --- a/APIJSONORM/src/main/java/apijson/orm/exception/ConflictException.java +++ b/APIJSONORM/src/main/java/apijson/orm/exception/ConflictException.java @@ -1,4 +1,4 @@ -/*Copyright (C) 2020 THL A29 Limited, a Tencent company. All rights reserved. +/*Copyright (C) 2020 Tencent. All rights reserved. This source code is licensed under the Apache License Version 2.0.*/ diff --git a/APIJSONORM/src/main/java/apijson/orm/exception/NotExistException.java b/APIJSONORM/src/main/java/apijson/orm/exception/NotExistException.java index 5c5a42bc8..69e34a809 100755 --- a/APIJSONORM/src/main/java/apijson/orm/exception/NotExistException.java +++ b/APIJSONORM/src/main/java/apijson/orm/exception/NotExistException.java @@ -1,4 +1,4 @@ -/*Copyright (C) 2020 THL A29 Limited, a Tencent company. All rights reserved. +/*Copyright (C) 2020 Tencent. All rights reserved. This source code is licensed under the Apache License Version 2.0.*/ diff --git a/APIJSONORM/src/main/java/apijson/orm/exception/NotLoggedInException.java b/APIJSONORM/src/main/java/apijson/orm/exception/NotLoggedInException.java index 2fbbb89ba..1e16b5796 100755 --- a/APIJSONORM/src/main/java/apijson/orm/exception/NotLoggedInException.java +++ b/APIJSONORM/src/main/java/apijson/orm/exception/NotLoggedInException.java @@ -1,4 +1,4 @@ -/*Copyright (C) 2020 THL A29 Limited, a Tencent company. All rights reserved. +/*Copyright (C) 2020 Tencent. All rights reserved. This source code is licensed under the Apache License Version 2.0.*/ diff --git a/APIJSONORM/src/main/java/apijson/orm/exception/OutOfRangeException.java b/APIJSONORM/src/main/java/apijson/orm/exception/OutOfRangeException.java index bde6fa42c..043ba5a65 100755 --- a/APIJSONORM/src/main/java/apijson/orm/exception/OutOfRangeException.java +++ b/APIJSONORM/src/main/java/apijson/orm/exception/OutOfRangeException.java @@ -1,4 +1,4 @@ -/*Copyright (C) 2020 THL A29 Limited, a Tencent company. All rights reserved. +/*Copyright (C) 2020 Tencent. All rights reserved. This source code is licensed under the Apache License Version 2.0.*/ diff --git a/APIJSONORM/src/main/java/apijson/orm/exception/UnsupportedDataTypeException.java b/APIJSONORM/src/main/java/apijson/orm/exception/UnsupportedDataTypeException.java new file mode 100644 index 000000000..1c7d7c27a --- /dev/null +++ b/APIJSONORM/src/main/java/apijson/orm/exception/UnsupportedDataTypeException.java @@ -0,0 +1,26 @@ +/*Copyright (C) 2020 Tencent. All rights reserved. + +This source code is licensed under the Apache License Version 2.0.*/ + + +package apijson.orm.exception; + +import java.io.IOException; + +/** + * 给定的数据类型不被支持 + * + * @author cnscoo + */ + +public class UnsupportedDataTypeException extends IOException { + private static final long serialVersionUID = 1L; + + public UnsupportedDataTypeException() { + super(); + } + + public UnsupportedDataTypeException(String s) { + super(s); + } +} diff --git a/APIJSONORM/src/main/java/apijson/orm/exception/package-info.java b/APIJSONORM/src/main/java/apijson/orm/exception/package-info.java index 70d3bb96e..073c6bdac 100755 --- a/APIJSONORM/src/main/java/apijson/orm/exception/package-info.java +++ b/APIJSONORM/src/main/java/apijson/orm/exception/package-info.java @@ -1,4 +1,4 @@ -/*Copyright (C) 2020 THL A29 Limited, a Tencent company. All rights reserved. +/*Copyright (C) 2020 Tencent. All rights reserved. This source code is licensed under the Apache License Version 2.0.*/ diff --git a/APIJSONORM/src/main/java/apijson/orm/model/Access.java b/APIJSONORM/src/main/java/apijson/orm/model/Access.java index e114f5654..ab44f8664 100644 --- a/APIJSONORM/src/main/java/apijson/orm/model/Access.java +++ b/APIJSONORM/src/main/java/apijson/orm/model/Access.java @@ -1,4 +1,4 @@ -/*Copyright (C) 2020 THL A29 Limited, a Tencent company. All rights reserved. +/*Copyright (C) 2020 Tencent. All rights reserved. This source code is licensed under the Apache License Version 2.0.*/ diff --git a/APIJSONORM/src/main/java/apijson/orm/model/AllColumn.java b/APIJSONORM/src/main/java/apijson/orm/model/AllColumn.java new file mode 100644 index 000000000..02906c6ec --- /dev/null +++ b/APIJSONORM/src/main/java/apijson/orm/model/AllColumn.java @@ -0,0 +1,18 @@ +/*Copyright (C) 2020 Tencent. All rights reserved. + +This source code is licensed under the Apache License Version 2.0.*/ + + +package apijson.orm.model; + +import apijson.MethodAccess; + +/**SQL Server 在 sys 下的字段(列名) + * @author Lemon + */ +@MethodAccess(POST = {}, PUT = {}, DELETE = {}) +public class AllColumn { + public static final String TAG = "AllColumn"; + public static final String TABLE_NAME = "ALL_TAB_COLUMNS"; + +} diff --git a/APIJSONORM/src/main/java/apijson/orm/model/AllColumnComment.java b/APIJSONORM/src/main/java/apijson/orm/model/AllColumnComment.java new file mode 100644 index 000000000..81e2c9fe9 --- /dev/null +++ b/APIJSONORM/src/main/java/apijson/orm/model/AllColumnComment.java @@ -0,0 +1,18 @@ +/*Copyright (C) 2020 Tencent. All rights reserved. + +This source code is licensed under the Apache License Version 2.0.*/ + + +package apijson.orm.model; + +import apijson.MethodAccess; + +/**SQL Server 在 sys 下的字段(列名) + * @author Lemon + */ +@MethodAccess(POST = {}, PUT = {}, DELETE = {}) +public class AllColumnComment { + public static final String TAG = "AllColumnComment"; + public static final String TABLE_NAME = "ALL_COL_COMMENTS"; + +} diff --git a/APIJSONORM/src/main/java/apijson/orm/model/AllTable.java b/APIJSONORM/src/main/java/apijson/orm/model/AllTable.java new file mode 100644 index 000000000..2934ad0ba --- /dev/null +++ b/APIJSONORM/src/main/java/apijson/orm/model/AllTable.java @@ -0,0 +1,18 @@ +/*Copyright (C) 2020 Tencent. All rights reserved. + +This source code is licensed under the Apache License Version 2.0.*/ + + +package apijson.orm.model; + +import apijson.MethodAccess; + +/**SQL Server 表属性 + * @author Lemon + */ +@MethodAccess(POST = {}, PUT = {}, DELETE = {}) +public class AllTable { + public static final String TAG = "AllTable"; + public static final String TABLE_NAME = "ALL_TABLES"; + +} diff --git a/APIJSONORM/src/main/java/apijson/orm/model/AllTableComment.java b/APIJSONORM/src/main/java/apijson/orm/model/AllTableComment.java new file mode 100644 index 000000000..49a4dee3a --- /dev/null +++ b/APIJSONORM/src/main/java/apijson/orm/model/AllTableComment.java @@ -0,0 +1,18 @@ +/*Copyright (C) 2020 Tencent. All rights reserved. + +This source code is licensed under the Apache License Version 2.0.*/ + + +package apijson.orm.model; + +import apijson.MethodAccess; + +/**SQL Server 表属性 + * @author Lemon + */ +@MethodAccess(POST = {}, PUT = {}, DELETE = {}) +public class AllTableComment { + public static final String TAG = "AllTableComment"; + public static final String TABLE_NAME = "ALL_TAB_COMMENTS"; + +} diff --git a/APIJSONORM/src/main/java/apijson/orm/model/Column.java b/APIJSONORM/src/main/java/apijson/orm/model/Column.java index d38d4fda3..573ab7fc4 100755 --- a/APIJSONORM/src/main/java/apijson/orm/model/Column.java +++ b/APIJSONORM/src/main/java/apijson/orm/model/Column.java @@ -1,4 +1,4 @@ -/*Copyright (C) 2020 THL A29 Limited, a Tencent company. All rights reserved. +/*Copyright (C) 2020 Tencent. All rights reserved. This source code is licensed under the Apache License Version 2.0.*/ diff --git a/APIJSONORM/src/main/java/apijson/orm/model/Document.java b/APIJSONORM/src/main/java/apijson/orm/model/Document.java index 6d5ded353..2e8db19c2 100755 --- a/APIJSONORM/src/main/java/apijson/orm/model/Document.java +++ b/APIJSONORM/src/main/java/apijson/orm/model/Document.java @@ -1,12 +1,12 @@ -/*Copyright (C) 2020 THL A29 Limited, a Tencent company. All rights reserved. +/*Copyright (C) 2020 Tencent. All rights reserved. This source code is licensed under the Apache License Version 2.0.*/ package apijson.orm.model; -import static apijson.RequestRole.ADMIN; -import static apijson.RequestRole.LOGIN; +import static apijson.orm.AbstractVerifier.ADMIN; +import static apijson.orm.AbstractVerifier.LOGIN; import java.io.Serializable; import java.sql.Timestamp; diff --git a/APIJSONORM/src/main/java/apijson/orm/model/ExtendedProperty.java b/APIJSONORM/src/main/java/apijson/orm/model/ExtendedProperty.java index 81227eb13..393a7e0d1 100644 --- a/APIJSONORM/src/main/java/apijson/orm/model/ExtendedProperty.java +++ b/APIJSONORM/src/main/java/apijson/orm/model/ExtendedProperty.java @@ -1,4 +1,4 @@ -/*Copyright (C) 2020 THL A29 Limited, a Tencent company. All rights reserved. +/*Copyright (C) 2020 Tencent. All rights reserved. This source code is licensed under the Apache License Version 2.0.*/ diff --git a/APIJSONORM/src/main/java/apijson/orm/model/Function.java b/APIJSONORM/src/main/java/apijson/orm/model/Function.java index b02175f4a..da6c3f53e 100644 --- a/APIJSONORM/src/main/java/apijson/orm/model/Function.java +++ b/APIJSONORM/src/main/java/apijson/orm/model/Function.java @@ -1,4 +1,4 @@ -/*Copyright (C) 2020 THL A29 Limited, a Tencent company. All rights reserved. +/*Copyright (C) 2020 Tencent. All rights reserved. This source code is licensed under the Apache License Version 2.0.*/ diff --git a/APIJSONORM/src/main/java/apijson/orm/model/PgAttribute.java b/APIJSONORM/src/main/java/apijson/orm/model/PgAttribute.java index 7c85f9f42..dbd4b4b69 100644 --- a/APIJSONORM/src/main/java/apijson/orm/model/PgAttribute.java +++ b/APIJSONORM/src/main/java/apijson/orm/model/PgAttribute.java @@ -1,4 +1,4 @@ -/*Copyright (C) 2020 THL A29 Limited, a Tencent company. All rights reserved. +/*Copyright (C) 2020 Tencent. All rights reserved. This source code is licensed under the Apache License Version 2.0.*/ diff --git a/APIJSONORM/src/main/java/apijson/orm/model/PgClass.java b/APIJSONORM/src/main/java/apijson/orm/model/PgClass.java index 3a47b2791..199a7ef86 100644 --- a/APIJSONORM/src/main/java/apijson/orm/model/PgClass.java +++ b/APIJSONORM/src/main/java/apijson/orm/model/PgClass.java @@ -1,4 +1,4 @@ -/*Copyright (C) 2020 THL A29 Limited, a Tencent company. All rights reserved. +/*Copyright (C) 2020 Tencent. All rights reserved. This source code is licensed under the Apache License Version 2.0.*/ diff --git a/APIJSONORM/src/main/java/apijson/orm/model/Request.java b/APIJSONORM/src/main/java/apijson/orm/model/Request.java index 8e83a2707..5d0d04092 100755 --- a/APIJSONORM/src/main/java/apijson/orm/model/Request.java +++ b/APIJSONORM/src/main/java/apijson/orm/model/Request.java @@ -1,4 +1,4 @@ -/*Copyright (C) 2020 THL A29 Limited, a Tencent company. All rights reserved. +/*Copyright (C) 2020 Tencent. All rights reserved. This source code is licensed under the Apache License Version 2.0.*/ diff --git a/APIJSONORM/src/main/java/apijson/orm/model/Response.java b/APIJSONORM/src/main/java/apijson/orm/model/Script.java old mode 100755 new mode 100644 similarity index 62% rename from APIJSONORM/src/main/java/apijson/orm/model/Response.java rename to APIJSONORM/src/main/java/apijson/orm/model/Script.java index f5dbc3926..53cda4323 --- a/APIJSONORM/src/main/java/apijson/orm/model/Response.java +++ b/APIJSONORM/src/main/java/apijson/orm/model/Script.java @@ -1,4 +1,4 @@ -/*Copyright (C) 2020 THL A29 Limited, a Tencent company. All rights reserved. +/*Copyright (C) 2020 Tencent. All rights reserved. This source code is licensed under the Apache License Version 2.0.*/ @@ -7,9 +7,9 @@ import apijson.MethodAccess; -/**结果处理 +/**代码脚本 * @author Lemon */ @MethodAccess(POST = {}, PUT = {}, DELETE = {}) -public class Response { -} +public class Script { +} \ No newline at end of file diff --git a/APIJSONORM/src/main/java/apijson/orm/model/SysColumn.java b/APIJSONORM/src/main/java/apijson/orm/model/SysColumn.java index 3e2c5c2b0..a4d7ca881 100644 --- a/APIJSONORM/src/main/java/apijson/orm/model/SysColumn.java +++ b/APIJSONORM/src/main/java/apijson/orm/model/SysColumn.java @@ -1,4 +1,4 @@ -/*Copyright (C) 2020 THL A29 Limited, a Tencent company. All rights reserved. +/*Copyright (C) 2020 Tencent. All rights reserved. This source code is licensed under the Apache License Version 2.0.*/ diff --git a/APIJSONORM/src/main/java/apijson/orm/model/SysTable.java b/APIJSONORM/src/main/java/apijson/orm/model/SysTable.java index 221807c48..bb6142310 100644 --- a/APIJSONORM/src/main/java/apijson/orm/model/SysTable.java +++ b/APIJSONORM/src/main/java/apijson/orm/model/SysTable.java @@ -1,4 +1,4 @@ -/*Copyright (C) 2020 THL A29 Limited, a Tencent company. All rights reserved. +/*Copyright (C) 2020 Tencent. All rights reserved. This source code is licensed under the Apache License Version 2.0.*/ diff --git a/APIJSONORM/src/main/java/apijson/orm/model/Table.java b/APIJSONORM/src/main/java/apijson/orm/model/Table.java index 0135fd947..1ab004cce 100755 --- a/APIJSONORM/src/main/java/apijson/orm/model/Table.java +++ b/APIJSONORM/src/main/java/apijson/orm/model/Table.java @@ -1,4 +1,4 @@ -/*Copyright (C) 2020 THL A29 Limited, a Tencent company. All rights reserved. +/*Copyright (C) 2020 Tencent. All rights reserved. This source code is licensed under the Apache License Version 2.0.*/ diff --git a/APIJSONORM/src/main/java/apijson/orm/model/Test.java b/APIJSONORM/src/main/java/apijson/orm/model/Test.java deleted file mode 100755 index 5b887e383..000000000 --- a/APIJSONORM/src/main/java/apijson/orm/model/Test.java +++ /dev/null @@ -1,17 +0,0 @@ -/*Copyright (C) 2020 THL A29 Limited, a Tencent company. All rights reserved. - -This source code is licensed under the Apache License Version 2.0.*/ - - -package apijson.orm.model; - -import apijson.MethodAccess; - -/**条件测试。最早可能 4.5.0 移除。AbstractSQLConfig 已支持 SELECT 2>1 这种简单条件表达式， - * 相当于是 SELECT 后只有 WHERE 条件表达式，其它全都没有，这样就可以去掉仅用来动态执行校验逻辑 Test 表了。 - * @author Lemon - */ -@Deprecated -@MethodAccess(POST = {}, PUT = {}, DELETE = {}) -public class Test { -} diff --git a/APIJSONORM/src/main/java/apijson/orm/model/TestRecord.java b/APIJSONORM/src/main/java/apijson/orm/model/TestRecord.java index b8c519e75..32ad98f9e 100644 --- a/APIJSONORM/src/main/java/apijson/orm/model/TestRecord.java +++ b/APIJSONORM/src/main/java/apijson/orm/model/TestRecord.java @@ -1,12 +1,12 @@ -/*Copyright (C) 2020 THL A29 Limited, a Tencent company. All rights reserved. +/*Copyright (C) 2020 Tencent. All rights reserved. This source code is licensed under the Apache License Version 2.0.*/ package apijson.orm.model; -import static apijson.RequestRole.ADMIN; -import static apijson.RequestRole.LOGIN; +import static apijson.orm.AbstractVerifier.ADMIN; +import static apijson.orm.AbstractVerifier.LOGIN; import java.io.Serializable; import java.sql.Timestamp; diff --git a/APIJSONORM/src/main/java/apijson/orm/model/package-info.java b/APIJSONORM/src/main/java/apijson/orm/model/package-info.java index af556632a..a0b5641c9 100755 --- a/APIJSONORM/src/main/java/apijson/orm/model/package-info.java +++ b/APIJSONORM/src/main/java/apijson/orm/model/package-info.java @@ -1,4 +1,4 @@ -/*Copyright (C) 2020 THL A29 Limited, a Tencent company. All rights reserved. +/*Copyright (C) 2020 Tencent. All rights reserved. This source code is licensed under the Apache License Version 2.0.*/ diff --git a/APIJSONORM/src/main/java/apijson/orm/package-info.java b/APIJSONORM/src/main/java/apijson/orm/package-info.java index e0f9a3d51..76569c93d 100755 --- a/APIJSONORM/src/main/java/apijson/orm/package-info.java +++ b/APIJSONORM/src/main/java/apijson/orm/package-info.java @@ -1,4 +1,4 @@ -/*Copyright (C) 2020 THL A29 Limited, a Tencent company. All rights reserved. +/*Copyright (C) 2020 Tencent. All rights reserved. This source code is licensed under the Apache License Version 2.0.*/ diff --git a/APIJSONORM/src/main/java/apijson/orm/script/JSR223ScriptExecutor.java b/APIJSONORM/src/main/java/apijson/orm/script/JSR223ScriptExecutor.java new file mode 100644 index 000000000..6a3a6c4f4 --- /dev/null +++ b/APIJSONORM/src/main/java/apijson/orm/script/JSR223ScriptExecutor.java @@ -0,0 +1,79 @@ +package apijson.orm.script; + +import java.util.HashMap; +import java.util.List; +import java.util.Map; +import java.util.concurrent.ConcurrentHashMap; + +import javax.script.Bindings; +import javax.script.Compilable; +import javax.script.CompiledScript; +import javax.script.ScriptEngine; +import javax.script.ScriptEngineManager; +import javax.script.SimpleBindings; + +import apijson.orm.AbstractFunctionParser; + +/** + * JSR223 script engine的统一实现抽象类 + */ +public abstract class JSR223ScriptExecutor, L extends List> implements ScriptExecutor { + protected ScriptEngine scriptEngine; + + private final Map compiledScriptMap = new ConcurrentHashMap<>(); + + @Override + public ScriptExecutor init() { + ScriptEngineManager scriptEngineManager = new ScriptEngineManager(); + scriptEngine = scriptEngineManager.getEngineByName(scriptEngineName()); + return this; + } + + protected abstract String scriptEngineName(); + + protected abstract Object extendParameter(AbstractFunctionParser parser, Map currentObject, String methodName, Object[] args); + + protected abstract boolean isLockScript(String methodName); + + protected String convertScript(String script) { + return script; + } + + @Override + public void load(String name, String script) { + try { + CompiledScript compiledScript = ((Compilable) scriptEngine).compile(convertScript(script)); + compiledScriptMap.put(name, compiledScript); + } catch (Exception e) { + e.printStackTrace(); + } + + } + + @Override + public Object execute(AbstractFunctionParser parser, Map currentObject, String methodName, Object[] args) throws Exception { + CompiledScript compiledScript = compiledScriptMap.get(methodName); + Bindings bindings = new SimpleBindings(); + // 往脚本上下文里放入元数据 + // 把 RequestMethod method, String tag, int version, @NotNull JSONMap request, + // HttpSession session 等参数作为全局参数传进去供脚本使用 + + // 加载扩展属性 + Object extendParameter = this.extendParameter(parser, currentObject, methodName, args); + if(extendParameter != null) { + bindings.put("extParam", extendParameter); + } + + Map metaMap = new HashMap<>(); + metaMap.put("version", parser == null ? 0 : parser.getVersion()); + metaMap.put("tag", parser == null ? null : parser.getTag()); + metaMap.put("args", args); + bindings.put("_meta", metaMap); + return compiledScript.eval(bindings); + } + + @Override + public void cleanCache() { + compiledScriptMap.clear(); + } +} diff --git a/APIJSONORM/src/main/java/apijson/orm/script/JavaScriptExecutor.java b/APIJSONORM/src/main/java/apijson/orm/script/JavaScriptExecutor.java new file mode 100644 index 000000000..3f636b64a --- /dev/null +++ b/APIJSONORM/src/main/java/apijson/orm/script/JavaScriptExecutor.java @@ -0,0 +1,28 @@ +package apijson.orm.script; + +import java.util.List; +import java.util.Map; + +import apijson.orm.AbstractFunctionParser; + +/** + * JavaScript脚本语言的执行器实现 + */ +public class JavaScriptExecutor, L extends List> extends JSR223ScriptExecutor { + + @Override + protected String scriptEngineName() { + return "javascript"; + } + + @Override + protected Object extendParameter(AbstractFunctionParser parser, Map currentObject, String methodName, Object[] args) { + return null; + } + + @Override + protected boolean isLockScript(String methodName) { + return false; + } + +} diff --git a/APIJSONORM/src/main/java/apijson/orm/script/ScriptExecutor.java b/APIJSONORM/src/main/java/apijson/orm/script/ScriptExecutor.java new file mode 100644 index 000000000..c90ce7b15 --- /dev/null +++ b/APIJSONORM/src/main/java/apijson/orm/script/ScriptExecutor.java @@ -0,0 +1,18 @@ +package apijson.orm.script; + +import java.util.List; +import java.util.Map; + +import apijson.orm.AbstractFunctionParser; + +public interface ScriptExecutor, L extends List> { + + ScriptExecutor init(); + + void load(String name, String script); + + Object execute(AbstractFunctionParser parser, Map currentObject, String methodName, Object[] args) throws Exception; + + void cleanCache(); + +} diff --git a/APIJSONORM/src/main/java/apijson/package-info.java b/APIJSONORM/src/main/java/apijson/package-info.java index 42e240185..a4fcbeb21 100755 --- a/APIJSONORM/src/main/java/apijson/package-info.java +++ b/APIJSONORM/src/main/java/apijson/package-info.java @@ -1,4 +1,4 @@ -/*Copyright (C) 2020 THL A29 Limited, a Tencent company. All rights reserved. +/*Copyright (C) 2020 Tencent. All rights reserved. This source code is licensed under the Apache License Version 2.0.*/ diff --git "a/APIJSON\345\210\235\346\234\237\346\236\204\346\200\235\345\217\212\345\256\236\347\216\260.docx" "b/APIJSON\345\210\235\346\234\237\346\236\204\346\200\235\345\217\212\345\256\236\347\216\260.docx" index 7522282a3..14667653e 100644 Binary files "a/APIJSON\345\210\235\346\234\237\346\236\204\346\200\235\345\217\212\345\256\236\347\216\260.docx" and "b/APIJSON\345\210\235\346\234\237\346\236\204\346\200\235\345\217\212\345\256\236\347\216\260.docx" differ diff --git "a/APIJSON\345\210\235\346\234\237\346\236\204\346\200\235\345\217\212\345\256\236\347\216\260.pages" "b/APIJSON\345\210\235\346\234\237\346\236\204\346\200\235\345\217\212\345\256\236\347\216\260.pages" index 68fb236fe..e6bed5465 100644 Binary files "a/APIJSON\345\210\235\346\234\237\346\236\204\346\200\235\345\217\212\345\256\236\347\216\260.pages" and "b/APIJSON\345\210\235\346\234\237\346\236\204\346\200\235\345\217\212\345\256\236\347\216\260.pages" differ diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index af41fa23b..f9fab2942 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -5,61 +5,115 @@ ## Acknowledgements -非常感谢以下几位贡献者对于 APIJSON 的做出的贡献： +非常感谢以下贡献者们对于 APIJSON 本项目做出的贡献： -- [ruoranw](https://github.com/ruoranw) +- [TommyLemon](https://github.com/TommyLemon)(腾讯工程师，还开源了 APIJSON-Demo, apijson-framework, apijson-column, apijson-router 等) +- [ruoranw](https://github.com/ruoranw)(现居美国洛杉矶，还开源了 APIJSONdocs) - [zhoulingfengofcd](https://github.com/zhoulingfengofcd) -- [Zerounary](https://github.com/Zerounary) -- [vincentCheng](https://github.com/vincentCheng) +- [Zerounary](https://github.com/Zerounary)(还开源了 APIJSONParser) +- [fineday009](https://github.com/fineday009)(腾讯工程师，还贡献了 apijson-framework, APIJSON-Demo) +- [vincentCheng](https://github.com/vincentCheng)(还开源了 apijson-doc) - [justinfengchen](https://github.com/justinfengchen) - [linlwqq](https://github.com/linlwqq) -- [redcatmiss](https://github.com/redcatmiss) +- [redcatmiss](https://github.com/redcatmiss)(社保科技工程师) - [linbren](https://github.com/linbren) - [jinzhongjian](https://github.com/jinzhongjian) - [CoolGeo2016](https://github.com/CoolGeo2016) - [1906522096](https://github.com/1906522096) - [github-ganyu](https://github.com/github-ganyu) -- [sunxiaoguang](https://github.com/sunxiaoguang) +- [sunxiaoguang](https://github.com/sunxiaoguang)(知乎基础研发架构师) +- [403f](https://github.com/403f) +- [gujiachun](https://github.com/gujiachun) +- [gdjs2](https://github.com/gdjs2)(University of California, Riverside) +- [Rkyzzy](https://github.com/Rkyzzy)(理想汽车工程师, SUSTech, University of California, Berkeley) +- [kxlv2000](https://github.com/kxlv2000)(SUSTech) +- [caohao-go](https://github.com/caohao-go)(腾讯工程师，曾在华为、恒生担任C/C++开发工程师，在wps担任项目经理，在360担任技术专家) +- [Wscats](https://github.com/Wscats)(腾讯工程师、腾讯 AlloyTeam 成员、Tencent Creation Camp 成员、知名技术博主) +- [jun0315](https://github.com/jun0315)(腾讯工程师) +- [JieJo](https://github.com/JieJo) +- [yeyuezhishou](https://github.com/yeyuezhishou)(圆通工程师) +- [kenlig](https://github.com/kenlig)(还开源了 apijsondocs) +- [andream7](https://github.com/andream7)(字节跳动、微软 工程师，还开源了 apijson-db2) +- [qiujunlin](https://github.com/qiujunlin)(字节跳动工程师，还开源了 APIJSONDemo) +- [HANXU2018](https://github.com/HANXU2018)(网易工程师，还开源了 APIJSON-DOC) +- [hclown9804](https://github.com/hclown9804)(Datawhale) +- [chenyanlann](https://github.com/chenyanlann)(还开源了 APIJSONDemo_ClickHouse) +- [haolingzhang1](https://github.com/haolingzhang1)(腾讯工程师，还开源了 APIJson--demo) +- [jerrylususu](https://github.com/jerrylususu)(还开源了 apijson_todo_demo 和 apijson_role_extend) +- [Dalezee](https://github.com/Dalezee)(还开源了 apijson_camp) +- [aaronlinv](https://github.com/aaronlinv) +- [sy-records](https://github.com/sy-records) +- [Finkyky](https://github.com/Finkyky) +- [ifooling](https://github.com/ifooling) +- [transtone](https://github.com/transtone) +- [AwenJackson](https://github.com/AwenJackson)(上海信息出奇科技有限公司工程师，发布了 3 篇文章） +- [andy19055](https://github.com/andy19055) +- [glennliao](https://github.com/glennliao)(还开源了 [apijson-go](https://github.com/glennliao/apijson-go) 和 [apijson-go-ui](https://github.com/glennliao/apijson-go-ui)） +- [eltociear](https://github.com/eltociear) +- [wb04307201](https://github.com/wb04307201)(还开源了 [apijson-dynamic-datasource](https://github.com/wb04307201/apijson-dynamic-datasource)） +- [cloudAndMonkey](https://github.com/cloudAndMonkey)(还贡献了 apijson-framework, APIJSON-Demo，新增支持了 Redis, Elasticsearch, Kafka, Lua 等并提供了多个 Demo） +- [12345ZMTHL](https://github.com/12345ZMTHL) +- [cnscoo](https://github.com/cnscoo)(阿里云工程师） +- [aninZz](https://github.com/aninZz) +- [leomiaomiao](https://github.com/leomiaomiao) +- [YqxLzx](https://github.com/YqxLzx) +- [hiteshbedre](https://github.com/hiteshbedre)(privado.ai 印裔工程师) +- [wahowaho](https://github.com/wahowaho) +- [jarrodquan](https://github.com/jarrodquan) +- [gemufeng](https://github.com/gemufeng)(上海麦市工程师) +- [komiblog](https://github.com/komiblog) +- [ostrichManX](https://github.com/ostrichManX) +- [jia199807](https://github.com/jia199807) +- [zxcwindy](https://github.com/zxcwindy) +- [afumu](https://github.com/afumu)(gorm-plus 作者) +- [alittle-yu](https://github.com/alittle-yu) +- [Damon Nicola](https://github.com/Reynold3D) +- [calmcc](https://github.com/calmcc) +- [lindaifeng](https://github.com/lindaifeng) +- [DenineLu](https://github.com/DenineLu)(小红书工程师） +- [wz11wz](https://github.com/wz11wz) +- [GeXin97](https://github.com/GeXin97) +- [yunjiao-source](https://github.com/yunjiao-source)(还开源了 [apijson-spring-boot](https://gitee.com/yunjiao-source/apijson-spring-boot)) +- [moxixi527](https://github.com/moxixi527)(热门技术博主) #### 其中特别致谢:
+cloudAndMonkey 提交的 11 个 Commits, 对 APIJSON 做出了 1,496 增加和 845 处删减(截止 2022/12/15 日)；
justinfengchen 提交的 6 个 Commits, 对 APIJSON 做出了 3,130 增加和 0 处删减(截止 2020/11/04 日)；
ruoranw 提交的 18 个 Commits, 对 APIJSON 做出了 328 增加和 520 处删减(截止 2020/11/04 日)；
Zerounary 提交的 6 个 Commits, 对 APIJSON 做出了 1,104 增加和 1 处删减(截止 2020/11/04 日)。

-APIJSON 持续招募贡献者，即使是在 Issue 中回答问题，或者做一些简单的 Bug Fix ，也会给 APIJSON 带来很大的帮助。
-APIJSON 已开发近 4 年，在此感谢所有开发者对于 APIJSON 的喜欢和支持，希望你能够成为 APIJSON 的核心贡献者，
-加入 APIJSON ，共同打造一个更棒的自动化 ORM 库！🍾🎉 +APIJSON 持续招募贡献者，新增功能、修复 Bug、完善文档、修正错误、宣传推广、回答问题等，都能帮助项目及广大用户。
+APIJSON 已开发近 6 年，在此感谢所有开发者对于 APIJSON 的喜欢和支持，希望你能够成为 APIJSON 的核心贡献者，
+加入 APIJSON ，共同打造一个更棒的零代码、全功能、强安全 ORM 库，造福更多前后端开发者！🍾🎉 ### 为什么一定要贡献代码？ -贡献代码可以避免你碰到以下麻烦：
+APIJSON 作为腾讯开源的知名热门项目，贡献代码除了可以给简历加亮点、为面试加分，还可以避免你碰到以下麻烦：
1.你在 APIJSON 上更改的代码其他人看不到，不能帮你发现 Bug，更不可能帮你修复 Bug 甚至优化代码
2.作者和其它贡献者可能不兼容你更改的代码，导致你的项目在升级 APIJSON 版本后在功能甚至编译上出错
3.你需要自己维护你的代码，每次升级 APIJSON 版本时，你都需要下载 APIJSON 新代码再合并你自己的更改
#### 所以为了让你自己的更改始终能跟上项目版本，得到他人给予的可靠且持续的维护，强烈建议 [提交 Pull Request](/CONTRIBUTING.md#pull-request) 来贡献代码。 -​ +​ -## Issue 提交 +## Pull Request -#### 对于贡献者 +我们除了希望听到您的反馈和建议外，我们也希望您接受代码形式的直接帮助，对我们的 GitHub 发出 Pull Request 请求。 -在提 Issue 前请确保满足一下条件： +### 如果是小改文档或代码 -- 必须是一个 Bug 或者功能新增。 -- 必须是 APIJSON 相关问题。 -- 已经在 Issue 中搜索过，并且没有找到相似的 Issue 或者解决方案。 -- 完善下面模板中的信息 +直接点文件右上角的编辑图标按钮
+![image](https://user-images.githubusercontent.com/5738175/130585672-8bd49ae5-2978-4ad6-a7a6-de0a0c2d0b68.png) -如果已经满足以上条件，我们提供了 Issue 的标准模版，请按照模板填写。 +
-​ +然后底部简要输入修改说明，点击 Commit Change 按钮
+![image](https://user-images.githubusercontent.com/5738175/130586073-4a6aea74-3c88-4cd9-9c93-ffaba1270ab8.png) -## Pull Request -我们除了希望听到您的反馈和建议外，我们也希望您接受代码形式的直接帮助，对我们的 GitHub 发出 Pull Request 请求。 +### 如果有比较大的改动 -以下是具体步骤： +以下是具体步骤：(如果使用本步骤，GitHub 可能不会把贡献者添加到 Contributors 中，推荐用以下 [详细的图文步骤](https://github.com/Tencent/APIJSON/blob/master/CONTRIBUTING.md#%E8%AF%A6%E7%BB%86%E7%9A%84%E5%9B%BE%E6%96%87%E6%AD%A5%E9%AA%A4%E5%8F%AF%E5%8F%82%E8%80%83%E4%BB%A5%E4%B8%8B%E4%BB%BB%E6%84%8F%E4%B8%80%E7%AF%87)) #### Fork 仓库 @@ -85,8 +139,11 @@ $ git remote add APIJSON git@github.com:Tencent/APIJSON.git #### 保持与 APIJSON 仓库的同步 -更新上游仓库： +直接在 fork Repo 的首页点 Contribute > Open pull request + +![image](https://user-images.githubusercontent.com/5738175/131776033-74caf279-ebbf-45f1-a9c1-beff937a87fb.png) +或者 ```bash $ git pull --rebase # 等同于以下两条命令 @@ -106,3 +163,19 @@ https://www.jianshu.com/p/00cf29d2d66c

如何在 Github 上给别人的项目贡献代码
https://git-scm.com/book/zh/v2/GitHub-%E5%AF%B9%E9%A1%B9%E7%9B%AE%E5%81%9A%E5%87%BA%E8%B4%A1%E7%8C%AE + + +​ + +## Issue 提交 + +#### 对于贡献者 + +在提 Issue 前请确保满足一下条件： + +- 必须是一个 Bug 或者功能新增。 +- 必须是 APIJSON 相关问题。 +- 已经在 Issue 中搜索过，并且没有找到相似的 Issue 或者解决方案。 +- 完善下面模板中的信息 + +如果已经满足以上条件，我们提供了 Issue 的标准模版，请按照模板填写。 diff --git a/Document-English.md b/Document-English.md index 9dd2eb141..62f40b0a0 100644 --- a/Document-English.md +++ b/Document-English.md @@ -1,15 +1,301 @@ +### Examples: + +#### Get a User +Request: +
{
+  "User":{
+  }
+}
+
+ +[Click here to test](http://apijson.cn:8080/get/{"User":{}}) + +Response: +
{
+  "User":{
+    "id":38710,
+    "sex":0,
+    "name":"TommyLemon",
+    "certified":true,
+    "tag":"Android&Java",
+    "phone":13000038710,
+    "head":"http://static.oschina.net/uploads/user/1218/2437072_100.jpg?t=1461076033000",
+    "date":1485948110000,
+    "pictureList":[
+      "http://static.oschina.net/uploads/user/1218/2437072_100.jpg?t=1461076033000",
+      "http://common.cnblogs.com/images/icon_weibo_24.png"
+    ]
+  },
+  "code":200,
+  "msg":"success"
+}
+
+ +
+ +

+ [GIF] APIJSON single objects: simple queries, statistics, groups, orders, aggregations, comparisons, filters, aliases, etc. +

+ +![](https://raw.githubusercontent.com/TommyLemon/StaticResources/master/APIJSON/APIJSON_query_single.gif) + +#### Get an array of Users + +Request: +
{
+  "[]":{
+    "count":3, //just get 3 results
+    "User":{
+      "@column":"id,name" //just get ids and names
+    }
+  }
+}
+
+ +[Click here to test](http://apijson.cn:8080/get/{"[]":{"count":3,"User":{"@column":"id,name"}}}) + +Response: +
{
+  "[]":[
+    {
+      "User":{
+        "id":38710,
+        "name":"TommyLemon"
+      }
+    },
+    {
+      "User":{
+        "id":70793,
+        "name":"Strong"
+      }
+    },
+    {
+      "User":{
+        "id":82001,
+        "name":"Android"
+      }
+    }
+  ],
+  "code":200,
+  "msg":"success"
+}
+
+ +
+ +

+ [GIF] APIJSON single arrays: simple queries, statistics, groups, orders, aggregations, paginations, searches, regexps, combinations, etc. +

+ +![](https://raw.githubusercontent.com/TommyLemon/StaticResources/master/APIJSON/APIJSON_query_array.gif) + + +#### Get a Moment and its publisher +Request: +
{
+  "Moment":{
+  },
+  "User":{
+    "id@":"Moment/userId"  //User.id = Moment.userId
+  }
+}
+
+ +[Click here to test](http://apijson.cn:8080/get/{"Moment":{},"User":{"id@":"Moment%252FuserId"}}) + +Response: +
{
+  "Moment":{
+    "id":12,
+    "userId":70793,
+    "date":"2017-02-08 16:06:11.0",
+    "content":"1111534034"
+  },
+  "User":{
+    "id":70793,
+    "sex":0,
+    "name":"Strong",
+    "tag":"djdj",
+    "head":"http://static.oschina.net/uploads/user/585/1170143_50.jpg?t=1390226446000",
+    "contactIdList":[
+      38710,
+      82002
+    ],
+    "date":"2017-02-01 19:21:50.0"
+  },
+  "code":200,
+  "msg":"success"
+}
+
+ +
+ +#### Get a Moment list like Twitter tweets +Request: +
{
+  "[]":{                             //get an array
+    "page":0,                        //pagination
+    "count":2,
+    "Moment":{                       //get a Moment
+      "content$":"%a%"               //filter condition: content contains 'a'
+    },
+    "User":{
+      "id@":"/Moment/userId",        //User.id = Moment.userId, short reference path，starts from grandparents path
+      "@column":"id,name,head"       //get specified keys with the written order 
+    },
+    "Comment[]":{                    //get a Comment array, and unwrap Comment object
+      "count":2,
+      "Comment":{
+        "momentId@":"[]/Moment/id"   //Comment.momentId = Moment.id, full reference path
+      }
+    }
+  }
+}
+
+ +[Click here to test](http://apijson.cn:8080/get/{"[]":{"page":0,"count":2,"Moment":{"content$":"%2525a%2525"},"User":{"id@":"%252FMoment%252FuserId","@column":"id,name,head"},"Comment[]":{"count":2,"Comment":{"momentId@":"[]%252FMoment%252Fid"}}}}) + +Response: +
{
+  "[]":[
+    {
+      "Moment":{
+        "id":15,
+        "userId":70793,
+        "date":1486541171000,
+        "content":"APIJSON is a JSON Transmission Protocol…",
+        "praiseUserIdList":[
+          82055,
+          82002,
+          82001
+        ],
+        "pictureList":[
+          "http://static.oschina.net/uploads/user/1218/2437072_100.jpg?t=1461076033000",
+          "http://common.cnblogs.com/images/icon_weibo_24.png"
+        ]
+      },
+      "User":{
+        "id":70793,
+        "name":"Strong",
+        "head":"http://static.oschina.net/uploads/user/585/1170143_50.jpg?t=1390226446000"
+      },
+      "Comment[]":[
+        {
+          "id":176,
+          "toId":166,
+          "userId":38710,
+          "momentId":15,
+          "date":1490444883000,
+          "content":"thank you"
+        },
+        {
+          "id":1490863469638,
+          "toId":0,
+          "userId":82002,
+          "momentId":15,
+          "date":1490863469000,
+          "content":"Just do it"
+        }
+      ]
+    },
+    {
+      "Moment":{
+        "id":58,
+        "userId":90814,
+        "date":1485947671000,
+        "content":"This is a Content...-435",
+        "praiseUserIdList":[
+          38710,
+          82003,
+          82005,
+          93793,
+          82006,
+          82044,
+          82001
+        ],
+        "pictureList":[
+          "http://static.oschina.net/uploads/img/201604/22172507_aMmH.jpg"
+        ]
+      },
+      "User":{
+        "id":90814,
+        "name":7,
+        "head":"http://static.oschina.net/uploads/user/51/102723_50.jpg?t=1449212504000"
+      },
+      "Comment[]":[
+        {
+          "id":13,
+          "toId":0,
+          "userId":82005,
+          "momentId":58,
+          "date":1485948050000,
+          "content":"This is a Content...-13"
+        },
+        {
+          "id":77,
+          "toId":13,
+          "userId":93793,
+          "momentId":58,
+          "date":1485948050000,
+          "content":"This is a Content...-77"
+        }
+      ]
+    }
+  ],
+  "code":200,
+  "msg":"success"
+}
+
+ +

+ [GIF] APIJSON query multi related tables: one to one, one to many, many to one, various conditions, etc. +

+ +![](https://raw.githubusercontent.com/TommyLemon/StaticResources/master/APIJSON/APIJSON_query_associate.gif) + +
+ +

+ [GIF] APIJSON joins: < LEFT JOIN, & INNER JOIN, etc. +

+ +![](https://raw.githubusercontent.com/TommyLemon/StaticResources/master/APIJSON/APIJSON_query_join.gif) + +
+ +

+ [GIF] APIJSON subqueries：@from@ FROM, key@ =, key>@ >, key{}@ IN, key}{@ EXISTS, etc. +

+ +![](https://raw.githubusercontent.com/TommyLemon/StaticResources/master/APIJSON/APIJSON_query_subquery.gif) + +
+ +

+ [GIF] APIJSON: a set of some features, simple to complex +

+ +![](https://raw.githubusercontent.com/TommyLemon/StaticResources/master/APIJSON/APIJSON_query_summary.gif) + +
+ +[Test it online](http://apijson.cn/api) + +
+
+ ## API Design Rules ### 1. Methods and API endpoints -  Methods | URL | Request | Response + Methods | URL | Request | Response ------------ | ------------ | ------------ | ------------ -**GET**:
A general way to get data.
You can use dev tools to make edits in a web browser. | base_url/get/ | {
   TableName:{
     //Add contiditions here.
   }
}

Eg. To get a Moment with `id = 235`：
{
   "Moment":{
     "id":235
   }
} | {
   TableName:{
     ...
   },
   "code":200,
   "msg":"success"
}
Eg.
{
   "Moment":{
     "id":235,
     "userId":38710,
     "content":"APIJSON,let interfaces and documents go to hell !"
   },
   "code":200,
   "msg":"success"
} +**GET**:
A general way to get data.
You can use dev tools to make edits in a web browser. | base_url/get/ | {
   TableName:{
     //Add contiditions here.
   }
}

Eg. To get a Moment with `id = 235`：
{
   "Moment":{
     "id":235
   }
} | {
   TableName:{
     ...
   },
   "code":200,
   "msg":"success"
}
Eg.
{
   "Moment":{
     "id":235,
     "userId":38710,
     "content":"APIJSON is the real-time coding-free, powerful and secure ORM"
   },
   "code":200,
   "msg":"success"
} **HEAD**:
A general way to get counts.
You can use dev tools to make edits in a web browser. | base_url/head/ | {
   TableName:{
     …
   }
}
{…} are conditions.

Eg. Get the number of Moments posted by the user with `id = 38710`：
{
   "Moment":{
     "userId":38710
   }
} | {
   TableName:{
     "code":200,
     "msg":"success",
     "count":10
   },
   "code":200,
   "msg":"success"
}
Eg.
{
   "Moment":{
     "code":200,
     "msg":"success",
     "count":10
   },
   "code":200,
   "msg":"success"
} **GETS**:
Get data with high security and confidentiality.
Eg. bank accounts, birth date. | base_url/gets/ | You need to add `"tag":tag` with the same level of `Moment:{}`. Others are the same as **GET**. | Same as **GET**. **HEADS**:
Get counts of confidential data(eg. bank account).| base_url/heads/ | You need to add `"tag":tag` with the same level of `Moment:{}`. Others are the same as **HEAD**. | Same as **HEAD**. -**POST**:
Add new data. | base_url/post/ | {
   TableName:{
     …
   },
   "tag":tag
}
The id in {...} is generated automatically when table is built and can’t be set by the user.

Eg. A user with `id = 38710` posts a new Moment：
{
   "Moment":{
     "userId":38710,
     "content":"APIJSON,let interfaces and documents go to hell !"
   },
   "tag":"Moment"
} | {
   TableName:{
     "code":200,
     "msg":"success",
     "id":38710
   },
   "code":200,
   "msg":"success"
}
Eg.
{
   "Moment":{
     "code":200,
     "msg":"success",
     "id":120
   },
   "code":200,
   "msg":"success"
} -**PUT**:
Make changes to a specific item.
Only change the part sent to server. | base_url/put/ | {
   TableName:{
     "id":id,
     …
   },
   "tag":tag
}
You can also add multiple id as `id{}`.

Eg. Make changes to Moment's content with id= 235:
{
   "Moment":{
     "id":235,
     "content":"APIJSON,let interfaces and documents go to hell !"
   },
   "tag":"Moment"
} | Same as **POST**. +**POST**:
Add new data. | base_url/post/ | {
   TableName:{
     …
   },
   "tag":tag
}
The id in {...} is generated automatically when table is built and can’t be set by the user.

Eg. A user with `id = 38710` posts a new Moment：
{
   "Moment":{
     "userId":38710,
     "content":"APIJSON is the real-time coding-free, powerful and secure ORM"
   },
   "tag":"Moment"
} | {
   TableName:{
     "code":200,
     "msg":"success",
     "id":38710
   },
   "code":200,
   "msg":"success"
}
Eg.
{
   "Moment":{
     "code":200,
     "msg":"success",
     "id":120
   },
   "code":200,
   "msg":"success"
} +**PUT**:
Make changes to a specific item.
Only change the part sent to server. | base_url/put/ | {
   TableName:{
     "id":id,
     …
   },
   "tag":tag
}
You can also add multiple id as `id{}`.

Eg. Make changes to Moment's content with id= 235:
{
   "Moment":{
     "id":235,
     "content":"APIJSON is the real-time coding-free, powerful and secure ORM"
   },
   "tag":"Moment"
} | Same as **POST**. **DELETE**:
Delete data. | base_url/delete/ | {
   TableName:{
     "id":id
   },
   "tag":tag
}
You can also add multiple id as `id{}`.

Or Delete contents with multiple id：
{
   "Comment":{
     "id{}":[100,110,120]
   },
   "tag":"Comment[]"
} | {
   TableName:{
     "code":200,
     "msg":"success",
     "id[]":[100,110,120]
      "count":3
   },
   "code":200,
   "msg":"success"
}
Eg.
{
   "Comment":{
      "code":200,
      "msg":"success",
      "id[]":[100,110,120],
      "count":3
   },
   "code":200,
   "msg":"success"
} **Note**:
@@ -38,12 +324,13 @@ Fuzzy matching | `"key$":"SQL search expressions"` => `"key$":["SQL search expressions"]`
Any SQL search expressions.Eg.%key%(include key), key%(start with key),%k%e%y%(include k, e, y). % means any characters. | ["name$":"%m%"](http://apijson.cn:8080/get/{"User[]":{"count":3,"User":{"name$":"%2525m%2525"}}})
In SQL, it's
`name LIKE '%m%'`,
meaning that get User with ‘m’ in name. Regular Expression| `"key~":"regular expression"` => `"key~":["regular expression"]`
It can be any regular expressions.Eg. ^[0-9]+$ ，*~ not case sensitive, advanced search is applicable.| ["name~":"^[0-9]+$"](http://apijson.cn:8080/get/{"User[]":{"count":3,"User":{"name~":"^[0-9]%252B$"}}})
In SQL, it's
`name REGEXP '^[0-9]+$'`. Get data in a range| `"key%":"start,end"` => `"key%":["start,end"]`
The data type of start and end can only be either Boolean, Number or String. Eg. "2017-01-01,2019-01-01" ，["1,90000", "82001,100000"]. It's used for getting data from a specific time range. | ["date%":"2017-10-01,2018-10-01"](http://apijson.cn:8080/get/{"User[]":{"count":3,"User":{"date%2525":"2017-10-01,2018-10-01"}}})
In SQL, it's
`date BETWEEN '2017-10-01' AND '2018-10-01'`,
meaning to get User data that registered between 2017-10-01 and 2018-10-01. - Make an alias | `"name:alias"`
this changes name to alias in returning results. It’s applicable to column, tableName, SQL Functions, etc. but only in GET, HEAD requests. | ["@column":"toId:parentId"](http://apijson.cn:8080/get/{"Comment":{"@column":"id,toId:parentId","id":51}})
In SQL, it's
`toId AS parentId`.
It'll return `parentId` instead of `toId`. + Make an alias | `"name:alias"`
this changes name to alias in returning results. It’s applicable to column, tableName, SQL Functions, etc. but only in GET, HEAD requests. | ["@column":"toId:parentId"](http://apijson.cn:8080/get/{"Comment":{"@column":"id,toId:parentId","id":51}})
In SQL, it's
`toId AS parentId`.
It'll return `parentId` instead of `toId`.

For @key format like "lc_wai6b3vk2:(lc_wai6b3vk)", it means renaming field lc_wai6b3vk2 to lc_wai6b3vk, commonly used for field renaming scenarios. Example:
{
  "lc_sinan_ba074fbb": {
    "lc_wai6b3vk": "11",
    "lc_wai6b3vk2": "22",
    "@combine": "lc_wai6b3vk \\| lc_wai6b3vk2",
    "@key": "lc_wai6b3vk2:(lc_wai6b3vk)"
  }
}
corresponds to SQL `(lc_wai6b3vk = '11' OR lc_wai6b3vk2 = '22')`, but the lc_wai6b3vk2 field will be renamed and displayed as lc_wai6b3vk in the returned result Add / expand an item | `"key+":Object`
The type of Object is decided by *key*. Types can be Number, String, JSONArray. Froms are 82001,"apijson",["url0","url1"] respectively. It’s only applicable to PUT request.| "praiseUserIdList+":[82001]. In SQL, it's
`json_insert(praiseUserIdList,82001)`.
Add an *id* that praised the Moment. Delete / decrease an item | `"Key-":Object`
It’s the contrary of "key+" | "balance-":100.00. In SQL, it's
`balance = balance - 100.00`,
meaning there's 100 less in balance. Operations | &, \|, !
They're used in logic operations. It’s the same as AND, OR, NOT in SQL respectively.
By default, for the same key, it’s ‘\|’ (OR)operation among conditions; for different keys, the default operation among conditions is ‘&’(AND).
| ① ["id&{}":">80000,<=90000"](http://apijson.cn:8080/head/{"User":{"id&{}":">80000,<=90000"}})
In SQL, it's
`id>80000 AND id<=90000`,
meaning *id* needs to be id>80000 & id<=90000

② ["id\|{}":">90000,<=80000"](http://apijson.cn:8080/head/{"User":{"id\|{}":">90000,<=80000"}})
It's the same as "id{}":">90000,<=80000".
In SQL, it's
`id>80000 OR id<=90000`,
meaning that *id* needs to be id>90000 \| id<=80000

③ ["id!{}":[82001,38710]](http://apijson.cn:8080/head/{"User":{"id!{}":[82001,38710]}})
In SQL, it's
`id NOT IN(82001,38710)`,
meaning id needs to be ! (id=82001 \| id=38710). - Keywords in an Array: It can be self-defined. | As for `"key":Object`, *key* is the keyword of *{}* in *"[]":{}*. The type of *Object* is up to *key*.

① `"count":Integer` It's used to count the number. The default largest number is 100.

② `"page":Integer` It’s used for getting data from which page, starting from 0. The default largest number is 100. It’s usually used with COUNT.

③ `"query":Integer` Get the number of items that match conditions
When to get the object, the integer should be 0; when to get the total number, it’s 1; when both above, it’s 2.
You can get the total number with keyword total. It can be referred to other values.
Eg.
`"total@":"/[]/total"`
Put it as the same level of query.
*Query* and *total* are used in GET requests just for convenience. Generally, HEAD request is for getting numbers like the total number.

④ `"join":"&/Table0/key0@,Join tables：
"\<" - LEFT JOIN
">" - RIGHT JOIN
"&" - INNER JOIN
"\|" - FULL JOIN
"!" - OUTTER JOIN
"@" - APP JOIN
Where @ APP JOIN is in application layer.It’ll get all the keys in tables that refKeys in result tables are referred to, like refKeys:[value0, value1….]. Then, as the results get data according to `key=$refKey` a number of times (COUNT), it uses key `IN($refKeys)` to put these counts together in just one SQL query, in order to improve the performance.
Other JOIN functions are the same as those in SQL.
`"join":"`"MainTable":{},`
`"ViceTable":{"key@":"/MainTable/refKey"}`
will return
`MainTable LEFT JOIN ViceTable`
`ON ViceTable.key=MainTable.refKey`

⑤ `"otherKey":Object` Self-defined keyword other than those that already in the system. It also returns with self-defined keywords.| ① Get User arrays with maximum of 5：
["count":5](http://apijson.cn:8080/get/{"[]":{"count":5,"User":{}}})

② Look into User arrays on page 3. Show 5 of them each page.
["count":5,
"page":3](http://apijson.cn:8080/get/{"[]":{"count":5,"page":3,"User":{}}})

③ Get User Arrays and count the total number of Users：
["[]":{
   "query":2,
   "User":{}
},
"total@":"/[]/total"](http://apijson.cn:8080/get/{"[]":{"query":2,"count":5,"User":{}},"total@":"%252F[]%252Ftotal"})
Questions like total page numbers or if there's next page can be solved by total,count,page functions，
Total page number:
`int totalPage = Math.ceil(total / count)`
If this is the last page:
`boolean hasNextPage = total > count*page`
If this is the first page:
`boolean isFirstPage = page <= 0`
If it's the last page:
`boolean isLastPage = total <= count*page`
...

④ Moment INNER JOIN User LEFT JOIN Comment：
["[]":{
   "join": "&/User/id@,\    "Moment":{},
   "User":{
     "name~":"t",
     "id@": "/Moment/userId"
   },
   "Comment":{
     "momentId@": "/Moment/id"
   }
}](http://apijson.cn:8080/get/{"[]":{"count":5,"join":"&%252FUser%252Fid@,\<%252FComment%252FmomentId@","Moment":{"@column":"id,userId,content"},"User":{"name~":"t","id@":"%252FMoment%252FuserId","@column":"id,name,head"},"Comment":{"momentId@":"%252FMoment%252Fid","@column":"id,momentId,content"}}})

⑤ Add the current user to every level：
["User":{},
"[]":{
   "name@":"User/name", //self-defined keyword
   "Moment":{}
}](http://apijson.cn:8080/get/{"User":{},"[]":{"name@":"User%252Fname","Moment":{}}}) - Keywords in Objects: It can be self-defined. | `"@key":Object` @key is the keyword of {} in Table:{}. The type of Object is decided by @key

① `"@combine":"&key0,&key1,\|key2,key3,`
`!key4,!key5,&key6,key7..."`
First, it’ll group data with same operators. Within one group, it operates from left to right. Then it’ll follow the order of & \| ! to do the operation. Different groups are connected with &. So the expression above will be :
(key0 & key1 & key6 & other key) & (key2 \| key3 \| key7) & !(key4 \| key5)
\| is optional.

② `"@column":"column;function(arg)..."` Return with specific columns.

③ `"@order":"column0+,column1-..."` Decide the order of returning results:

④ `"@group":"column0,column1..."` How to group data. If @column has declared Table id, this id need to be included in @group. In other situations, at least one of the following needs to be done:
1.Group id is declared in @column
2.Primary Key of the table is declared in @group.

⑤ `@having":"function0(...)?value0;function1(...)?value1;function2(...)?value2..."` Add conditions on return results with @having. Usually working with@group, it’s declared in @column.

⑥ `"@schema":"sys"` Can be set as default setting.

⑦ `"@database":"POSTGRESQL"` Get data from a different database.Can be set as default setting.

⑧ `"@role":"OWNER"` Get information of the user, including
UNKNOWN,LOGIN,CONTACT,CIRCLE,OWNER,ADMIN，
Can be set as default setting.
You can self-define a new role or rewrite a role. Use`Verifier.verify` etc. to self-define validation methods.

⑨ `"@explain":true` Profiling. Can be set as default setting.

⑩ `"@otherKey":Object` Self-define keyword | ① Search *Users* that *name* or *tag* contains the letter "a":
["name~":"a",
"tag~":"a",
"@combine":"name~,tag~"](http://apijson.cn:8080/get/{"User[]":{"count":10,"User":{"@column":"id,name,tag","name~":"a","tag~":"a","@combine":"name~,tag~"}}})

② Only search column id,sex,name and return with the same order:
["@column":"id,sex,name"](http://apijson.cn:8080/get/{"User":{"@column":"id,sex,name","id":38710}})

③ Search Users that have descending order of name and default order of id:
["@order":"name-,id"](http://apijson.cn:8080/get/{"[]":{"count":10,"User":{"@column":"name,id","@order":"name-,id"}}})

④ Search Moment grouped with userId:
["@group":"userId,id"](http://apijson.cn:8080/get/{"[]":{"count":10,"Moment":%7B"@column":"userId,id","@group":"userId,id"}}})

⑤ Search Moments that id equals or less than 100 and group with userId:
["@column":"userId;max(id)",
"@group":"userId",
"@having":"max(id)>=100"](http://apijson.cn:8080/get/{"[]":{"count":10,"Moment":{"@column":"userId%253Bmax(id)","@group":"userId","@having":"max(id)>=100"}}})
You can also define the name of the returned function:
["@column":"userId;max(id):maxId",
"@group":"userId",
"@having":"maxId>=100"](http://apijson.cn:8080/get/{"[]":{"count":10,"Moment":{"@column":"userId%253Bmax(id):maxId","@group":"userId","@having":"maxId>=100"}}})

⑥ Check Users table in sys:
["@schema":"sys"](http://apijson.cn:8080/get/{"User":{"@schema":"sys"}})

⑦ Check Users table in PostgreSQL:
["@database":"POSTGRESQL"](http://apijson.cn:8080/get/{"User":{"@database":"POSTGRESQL"}})

⑧ Check the current user's activity:
["@role":"OWNER"](http://apijson.cn:8080/get/{"[]":{"Moment":{"@role":"OWNER"}}})

⑨ Turn on profiling:
["@explain":true](http://apijson.cn:8080/get/{"[]":{"Moment":{"@explain":true}}})

⑩ Get the No.0 picture from pictureList：
["@position":0, //self-defined keyword
"firstPicture()":"getFromArray(pictureList,@position)"](http://apijson.cn:8080/get/{"User":{"id":38710,"@position":0,"firstPicture()":"getFromArray(pictureList,@position)"}}) + Keywords in an Array: It can be self-defined. | As for `"key":Object`, *key* is the keyword of *{}* in *"[]":{}*. The type of *Object* is up to *key*.

① `"count":Integer` It's used to count the number. The default largest number is 100.

② `"page":Integer` It’s used for getting data from which page, starting from 0. The default largest number is 100. It’s usually used with COUNT.

③ `"query":Integer` Get the number of items that match conditions
When to get the object, the integer should be 0; when to get the total number, it’s 1; when both above, it’s 2.
You can get the total number with keyword total. It can be referred to other values.
Eg.
`"total@":"/[]/total"`
Put it as the same level of query.
*Query* and *total* are used in GET requests just for convenience. Generally, HEAD request is for getting numbers like the total number.

④ `"join":"&/Table0,Join tables：
"\<" - LEFT JOIN
">" - RIGHT JOIN
"&" - INNER JOIN
"\|" - FULL JOIN
"!" - OUTER JOIN
"@" - APP JOIN
Where @ APP JOIN is in application layer.It’ll get all the keys in tables that refKeys in result tables are referred to, like refKeys:[value0, value1….]. Then, as the results get data according to `key=$refKey` a number of times (COUNT), it uses key `IN($refKeys)` to put these counts together in just one SQL query, in order to improve the performance.
Other JOIN functions are the same as those in SQL.
`"join":"`"MainTable":{},`
`"ViceTable":{"key@":"/MainTable/refKey"}`
will return
`MainTable LEFT JOIN ViceTable`
`ON ViceTable.key=MainTable.refKey`

⑤ `"otherKey":Object` Self-defined keyword other than those that already in the system. It also returns with self-defined keywords.| ① Get User arrays with maximum of 5：
["count":5](http://apijson.cn:8080/get/{"[]":{"count":5,"User":{}}})

② Look into User arrays on page 3. Show 5 of them each page.
["count":5,
"page":3](http://apijson.cn:8080/get/{"[]":{"count":5,"page":3,"User":{}}})

③ Get User Arrays and count the total number of Users：
["[]":{
   "query":2,
   "User":{}
},
"total@":"/[]/total"](http://apijson.cn:8080/get/{"[]":{"query":2,"count":5,"User":{}},"total@":"%252F[]%252Ftotal"})
Questions like total page numbers or if there's next page can be solved by total,count,page functions，
Total page number:
`int totalPage = Math.ceil(total / count)`
If this is the last page:
`boolean hasNextPage = total > count*page`
If this is the first page:
`boolean isFirstPage = page <= 0`
If it's the last page:
`boolean isLastPage = total <= count*page`
...

④ Moment INNER JOIN User LEFT JOIN Comment：
["[]":{
   "join": "&/User,\    "Moment":{},
   "User":{
     "name~":"t",
     "id@": "/Moment/userId"
   },
   "Comment":{
     "momentId@": "/Moment/id"
   }
}](http://apijson.cn:8080/get/{"[]":{"count":5,"join":"&%252FUser,\<%252FComment","Moment":{"@column":"id,userId,content"},"User":{"name~":"t","id@":"%252FMoment%252FuserId","@column":"id,name,head"},"Comment":{"momentId@":"%252FMoment%252Fid","@column":"id,momentId,content"}}})

⑤ Add the current user to every level：
["User":{},
"[]":{
   "name@":"User/name", //self-defined keyword
   "Moment":{}
}](http://apijson.cn:8080/get/{"User":{},"[]":{"name@":"User%252Fname","Moment":{}}}) + Keywords in Objects: It can be self-defined. | `"@key":Object` @key is the keyword of {} in Table:{}. The type of Object is decided by @key

① `"@combine":"&key0,&key1,\|key2,key3,`
`!key4,!key5,&key6,key7..."`
First, it’ll group data with same operators. Within one group, it operates from left to right. Then it’ll follow the order of & \| ! to do the operation. Different groups are connected with &. So the expression above will be :
(key0 & key1 & key6 & other key) & (key2 \| key3 \| key7) & !(key4 \| key5)
\| is optional.

② `"@column":"column;function(arg)..."` Return with specific columns.

③ `"@order":"column0+,column1-..."` Decide the order of returning results:

④ `"@group":"column0,column1..."` How to group data. If @column has declared Table id, this id need to be included in @group. In other situations, at least one of the following needs to be done:
1.Group id is declared in @column
2.Primary Key of the table is declared in @group.

⑤ `@having":"function0(...)?value0;function1(...)?value1;function2(...)?value2..."` Add conditions on return results with @having. Usually working with@group, it’s declared in @column.

⑥ `"@schema":"sys"` Can be set as default setting.

⑦ `"@database":"POSTGRESQL"` Get data from a different database.Can be set as default setting.

⑧ `"@role":"OWNER"` Get information of the user, including
UNKNOWN,LOGIN,CONTACT,CIRCLE,OWNER,ADMIN，
Can be set as default setting.
You can self-define a new role or rewrite a role. Use`Verifier.verify` etc. to self-define validation methods.

⑨ `"@explain":true` Profiling. Can be set as default setting.

⑩ `"@otherKey":Object` Self-define keyword | ① Search *Users* that *name* or *tag* contains the letter "a":
["name~":"a",
"tag~":"a",
"@combine":"name~,tag~"](http://apijson.cn:8080/get/{"User[]":{"count":10,"User":{"@column":"id,name,tag","name~":"a","tag~":"a","@combine":"name~,tag~"}}})

② Only search column id,sex,name and return with the same order:
["@column":"id,sex,name"](http://apijson.cn:8080/get/{"User":{"@column":"id,sex,name","id":38710}})

③ Search Users that have descending order of name and default order of id:
["@order":"name-,id"](http://apijson.cn:8080/get/{"[]":{"count":10,"User":{"@column":"name,id","@order":"name-,id"}}})

④ Search Moment grouped with userId:
["@group":"userId,id"](http://apijson.cn:8080/get/{"[]":{"count":10,"Moment":%7B"@column":"userId,id","@group":"userId,id"}}})

⑤ Search Moments that id equals or less than 100 and group with userId:
["@column":"userId;max(id)",
"@group":"userId",
"@having":"max(id)>=100"](http://apijson.cn:8080/get/{"[]":{"count":10,"Moment":{"@column":"userId%253Bmax(id)","@group":"userId","@having":"max(id)>=100"}}})
You can also define the name of the returned function:
["@column":"userId;max(id):maxId",
"@group":"userId",
"@having":"(maxId)>=100"](http://apijson.cn:8080/get/{"[]":{"count":10,"Moment":{"@column":"userId%253Bmax(id):maxId","@group":"userId","@having":"(maxId)>=100"}}})

⑥ Check Users table in sys:
["@schema":"sys"](http://apijson.cn:8080/get/{"User":{"@schema":"sys"}})

⑦ Check Users table in PostgreSQL:
["@database":"POSTGRESQL"](http://apijson.cn:8080/get/{"User":{"@database":"POSTGRESQL"}})

⑧ Check the current user's activity:
["@role":"OWNER"](http://apijson.cn:8080/get/{"[]":{"Moment":{"@role":"OWNER"}}})

⑨ Turn on profiling:
["@explain":true](http://apijson.cn:8080/get/{"[]":{"Moment":{"@explain":true}}})

⑩ Get the No.0 picture from pictureList：
["@position":0, //self-defined keyword
"firstPicture()":"getFromArray(pictureList,@position)"](http://apijson.cn:8080/get/{"User":{"id":38710,"@position":0,"firstPicture()":"getFromArray(pictureList,@position)"}}) + global keyword. | It is a keyword inside the outermost object {}. Among them, @database, @schema, @datasource, @role, and @explain are basically the same as object keywords, see the above description, the difference is that the global keywords will be automatically inserted in each table object as the default value.

① "tag": String, the following tag is the identifier of the JSON structure matching the request in non-GET or HEAD requests, generally it is the name of the Table to be queried or the array Table[] or Table:[] corresponding to the name, determined by the backend specified in the Request table.

② "version": Integer, the interface version. If the version is not passed, null or <=0, the highest version will be used. If other valid values are passed, the lowest version closest to it will be used, which is specified in the backend Request table.

③ "format": Boolean, formatted to return the key of the Response JSON, generally converting TableName to tableName, TableName[] to tableNameList, Table:alias to alias, TableName-key[] to tableNameKeyList and other camelcase formats. | ① Check private information:：
[{"tag":"Privacy","Privacy":{"id":82001}}](http://apijson.cn/api?url=http%3A%2F%2Fapijson.cn%3A8080%2Fgets&type=JSON&json={%22tag%22:%22Privacy%22,%22Privacy%22:{%22id%22:82001}})

② Use the version 1 interface to check private information:：
[{"version":1,"tag":"Privacy","Privacy":{"id":82001}}](http://apijson.cn/api?url=http%3A%2F%2Fapijson.cn%3A8080%2Fgets&type=JSON&json={%22version%22:1,%22tag%22:%22Privacy%22,%22Privacy%22:{%22id%22:82001}})

③ Format Moments interface to return in JSON key：
[{
   "format":true,
   "[]":{
     "page":0,
     "count":3,
     "Moment":{},
     "User":{
       "id@":"/Moment/userId"
     },
     "Comment[]":{
       "count":3,
       "Comment":{
         "momentId@":"[]/Moment/id"
       }
     }
   }
}](http://apijson.cn:8080/get/{"format":true,"[]":{"page":0,"count":3,"Moment":{},"User":{"id@":"%252FMoment%252FuserId"},"Comment[]":{"count":3,"Comment":{"momentId@":"[]%252FMoment%252Fid"}}}})
diff --git a/Document.md b/Document.md index ab37d9f31..11db6fe86 100644 --- a/Document.md +++ b/Document.md @@ -1,5 +1,14 @@ -# APIJSON通用文档 -后端开发者可以先看这个详细的 [图文入门教程](https://vincentcheng.github.io/apijson-doc/zh)（如果和本文档有出入，以本文档为准，例如正则匹配 key? 已废弃，全面用 key~ 替代） +[English](https://github.com/Tencent/APIJSON/blob/master/Document-English.md) +
+ +# APIJSON 通用文档 +本文是通用文档，只和 APIJSON 协议有关，和 C#, Go, Java, JavaScript, PHP, Python, TypeScript 等开发语言无关。
+具体开发语言相关的 配置、运行、部署 等文档见各个相关项目的文档，可以在首页点击对应语言的入口来查看。
+https://github.com/Tencent/APIJSON +![image](https://user-images.githubusercontent.com/5738175/134520081-a63d3817-321c-4e7b-9e03-73c6827a19c1.png) + + +后端开发者可以先看 [图文入门教程1](http://apijson.cn/doc/zh/) 或 [图文入门教程2](https://hanxu2018.github.io/APIJSON-DOC/) （和本文档有出入的点以本文档为准。例如正则匹配 key? 已废弃，用 key~ 替代；例如 "@column":"store_id,sum(amt):totAmt" 中逗号 , 有误，应该用分号 ; 隔开 SQL 函数，改为 "@column":"store_id;sum(amt):totAmt"） * ### [1.示例](#1) * ### [2.对比传统方式](#2) @@ -21,7 +30,7 @@ 
{
   "User":{
     "id":38710
-  }
+  }
 }
@@ -46,16 +55,22 @@ } +

+ [GIF] APIJSON 各种单表对象查询：简单查询、统计、分组、排序、聚合、比较、筛选字段、字段别名 等 +

+ +![](https://raw.githubusercontent.com/TommyLemon/StaticResources/master/APIJSON/APIJSON_query_single.gif) +
#### 获取用户列表 请求： 
{
   "[]":{
-    "count":3,             //只要3个
-    "User":{
-      "@column":"id,name"  //只要id,name这两个字段
-    }
+    "count":3, //只要3个
+    "User":{
+      "@column":"id,name" //只要id,name这两个字段
+    }
   }
 }
@@ -89,6 +104,12 @@ } +

+ [GIF] APIJSON 各种单表数组查询：简单查询、统计、分组、排序、聚合、分页、比较、搜索、正则、条件组合 等 +

+ +![](https://raw.githubusercontent.com/TommyLemon/StaticResources/master/APIJSON/APIJSON_query_array.gif) +
#### 获取动态及发布者用户 @@ -128,21 +149,21 @@ "msg":"success" } - +
#### 获取类似微信朋友圈的动态列表 请求： 
{
   "[]":{                             //请求一个数组
-    "page":0,                        //数组条件
+    "page":0,                        //数组条件
     "count":2,
-    "Moment":{                       //请求一个名为Moment的对象
-      "content$":"%a%"               //对象条件，搜索content中包含a的动态
+    "Moment":{                       //请求一个名为Moment的对象
+      "content$":"%a%"               //对象条件，搜索content中包含a的动态
     },
     "User":{
-      "id@":"/Moment/userId",        //User.id = Moment.userId  缺省引用赋值路径，从所处容器的父容器路径开始
-      "@column":"id,name,head"       //指定返回字段
+      "id@":"/Moment/userId",  //User.id = Moment.userId  缺省引用赋值路径，从所处容器的父容器路径开始
+      "@column":"id,name,head"       //指定返回字段
     },
     "Comment[]":{                    //请求一个名为Comment的数组，并去除Comment包装
       "count":2,
@@ -164,7 +185,7 @@
         "id":15,
         "userId":70793,
         "date":1486541171000,
-        "content":"APIJSON is a JSON Transmission Structure Protocol…",
+        "content":"APIJSON is a JSON Transmission Protocol…",
         "praiseUserIdList":[
           82055,
           82002,
@@ -248,10 +269,39 @@
 }
+

+ [GIF] APIJSON 各种多表关联查询：一对一、一对多、多对一、各种条件 等 +

+![](https://raw.githubusercontent.com/TommyLemon/StaticResources/master/APIJSON/APIJSON_query_associate.gif) + +
+ +

+ [GIF] APIJSON 各种 JOIN：< LEFT JOIN, & INNER JOIN 等 +

+ +![](https://raw.githubusercontent.com/TommyLemon/StaticResources/master/APIJSON/APIJSON_query_join.gif) + +
+ +

+ [GIF] APIJSON 各种子查询：@from@ FROM, key@ =, key>@ >, key{}@ IN, key}{@ EXISTS 等 +

+ +![](https://raw.githubusercontent.com/TommyLemon/StaticResources/master/APIJSON/APIJSON_query_subquery.gif) +
+ +

+ [GIF] APIJSON 部分功能演示集合，由浅入深、由简单到复杂 +

-[在线测试](http://apijson.org/auto) +![](https://raw.githubusercontent.com/TommyLemon/StaticResources/master/APIJSON/APIJSON_query_summary.gif) + +
+ +[在线测试](http://apijson.cn/api)

@@ -318,7 +368,7 @@ 3.请求中的 / 需要转义。JSONRequest.java已经用URLEncoder.encode转义，不需要再写；但如果是浏览器或Postman等直接输入url/request，需要把request中的所有 / 都改成 %252F 。下同。
4.code，指返回结果中的状态码，200表示成功，其它都是错误码，值全部都是HTTP标准状态码。下同。
5.msg，指返回结果中的状态信息，对成功结果或错误原因的详细说明。下同。
-6.code和msg总是在返回结果的同一层级成对出现。对所有请求的返回结果都会在最外层有一对总结式code和msg。对非GET类型的请求，返回结果里面的每个JSONObject里都会有一对code和msg说明这个JSONObject的状态。下同。
+6.code和msg总是在返回结果的同一层级成对出现。对所有请求的返回结果都会在最外层有一对总结式code和msg。下同。
7.id等字段对应的值仅供说明，不一定是数据库里存在的，请求里用的是真实存在的值。下同。
@@ -328,19 +378,19 @@ ###

3.1 操作方法

-  方法及说明 | URL | Request | Response + 方法及说明 | URL | Request | Response ------------ | ------------ | ------------ | ------------ -GET:
普通获取数据，
可用浏览器调试 | base_url/get/ | {
   TableName:{
     …
   }
}
{…}内为限制条件

例如获取一个 id = 235 的 Moment：
{
   "Moment":{
     "id":235
   }
} | {
   TableName:{
     ...
   },
   "code":200,
   "msg":"success"
}
例如
{
   "Moment":{
     "id":235,
     "userId":38710,
     "content":"APIJSON,let interfaces and documents go to hell !"
   },
   "code":200,
   "msg":"success"
} -HEAD:
普通获取数量，
可用浏览器调试 | base_url/head/ | {
   TableName:{
     …
   }
}
{…}内为限制条件

例如获取一个 id = 38710 的 User 所发布的 Moment 总数：
{
   "Moment":{
     "userId":38710
   }
} | {
   TableName:{
     "code":200,
     "msg":"success",
     "count":10
   },
   "code":200,
   "msg":"success"
}
例如
{
   "Moment":{
     "code":200,
     "msg":"success",
     "count":10
   },
   "code":200,
   "msg":"success"
} -GETS:
安全/私密获取数据，
用于获取钱包等
对安全性要求高的数据 | base_url/gets/ | 最外层加一个 "tag":tag，其它同GET | 同GET -HEADS:
安全/私密获取数量，
用于获取银行卡数量等
对安全性要求高的数据总数 | base_url/heads/ | 最外层加一个 "tag":tag，其它同HEAD | 同HEAD -POST:
新增数据 | base_url/post/ | 单个：
{
   TableName:{
     …
   },
   "tag":tag
}
{…}中id由后端生成，不能传

例如一个 id = 38710 的 User 发布一个新 Moment：
{
   "Moment":{
     "userId":38710,
     "content":"APIJSON,let interfaces and documents go to hell !"
   },
   "tag":"Moment"
}

批量：
{
   TableName\[]:\[{
       …
     }, {
       …
     }
     …
   ],
   "tag":tag
}
{…}中id由后端生成，不能传

例如当前登录用户 82001 发布 2 个 Comment：
{
   "Comment\[]":\[{
     "momentId":12,
     "content":"APIJSON,let interfaces and documents go to hell !"
     }, {
     "momentId":15,
     "content":"APIJSON is a JSON transmision protocol."
   }],
   "tag":"Comment[]"
}
| 单个：
{
   TableName:{
     "code":200,
     "msg":"success",
     "id":38710
   },
   "code":200,
   "msg":"success"
}
例如
{
   "Moment":{
     "code":200,
     "msg":"success",
     "id":120
   },
   "code":200,
   "msg":"success"
}

批量：
{
   TableName:{
     "code":200,
     "msg":"success",
     "count":5,
     "id[]":[1, 2, 3, 4, 5]
   },
   "code":200,
   "msg":"success"
}
例如
{
   "Comment":{
     "code":200,
     "msg":"success",
     "count":2,
     "id[]":\[1, 2]
   },
   "code":200,
   "msg":"success"
} -PUT:
修改数据，
只修改所传的字段 | base_url/put/ | {
   TableName:{
     "id":id,
     …
   },
   "tag":tag
}
{…} 中 id 或 id{} 至少传一个

例如修改 id = 235 的 Moment 的 content：
{
   "Moment":{
     "id":235,
     "content":"APIJSON,let interfaces and documents go to hell !"
   },
   "tag":"Moment"
}

批量除了 id{}:\[] 也可类似批量 POST，只是每个 {...} 里面都必须有 id | 同POST -DELETE:
删除数据 | base_url/delete/ | {
   TableName:{
     "id":id
   },
   "tag":tag
}
{…} 中 id 或 id{} 至少传一个，一般只传 id 或 id{}

例如批量删除 id = 100,110,120 的 Comment：
{
   "Comment":{
     "id{}":[100,110,120]
   },
   "tag":"Comment[]"
} | {
   TableName:{
     "code":200,
     "msg":"success",
     "id[]":[100,110,120]
      "count":3
   },
   "code":200,
   "msg":"success"
}
例如
{
   "Comment":{
      "code":200,
      "msg":"success",
      "id[]":[100,110,120],
      "count":3
   },
   "code":200,
   "msg":"success"
} - +GET:
普通获取数据，
可用浏览器调试 | base_url/get/ | {
   TableName:{
     …
   }
}
{…}内为限制条件

例如获取一个 id = 235 的 Moment：
[{
   "Moment":{
     "id":235
   }
}](http://apijson.cn/api/?url=http%3A%2F%2Fapijson.cn%3A8080%2Fget&type=JSON&json={"Moment"%3A{"id"%3A235}})
后端校验通过后自动解析为 SQL 并执行：
`SELECT * FROM Moment WHERE id=235 LIMIT 1` | {
   TableName:{
     ...
   },
   "code":200,
   "msg":"success"
}
例如
{
   "Moment":{
     "id":235,
     "userId":38710,
     "content":"APIJSON is the real-time coding-free, powerful and secure ORM"
   },
   "code":200,
   "msg":"success"
} +HEAD:
普通获取数量，
可用浏览器调试 | base_url/head/ | {
   TableName:{
     …
   }
}
{…}内为限制条件

例如获取一个 id = 38710 的 User 所发布的 Moment 总数：
[{
   "Moment":{
     "userId":38710
   }
}](http://apijson.cn/api/?url=http%3A%2F%2Fapijson.cn%3A8080%2Fhead&type=JSON&json={"Moment"%3A{"userId"%3A38710}})
后端校验通过后自动解析为 SQL 并执行：
`SELECT count(*) FROM Moment WHERE userId=38710 LIMIT 1` | {
   TableName:{
     "code":200,
     "msg":"success",
     "count":10
   },
   "code":200,
   "msg":"success"
}
例如
{
   "Moment":{
     "code":200,
     "msg":"success",
     "count":10
   },
   "code":200,
   "msg":"success"
} +GETS:
安全/私密获取数据，
用于获取钱包等
对安全性要求高的数据 | base_url/gets/ | 最外层加一个 "tag":tag，例如 ["tag":"Privacy"](http://apijson.cn/api/?url=http%3A%2F%2Fapijson.cn%3A8080%2Fgets&type=JSON&json={"tag"%3A"Privacy","Privacy"%3A{"id"%3A82001}})，其它同GET | 同GET +HEADS:
安全/私密获取数量，
用于获取银行卡数量等
对安全性要求高的数据总数 | base_url/heads/ | 最外层加一个 "tag":tag，例如 ["tag":"Verify"](http://apijson.cn/api/?url=http%3A%2F%2Fapijson.cn%3A8080%2Fheads&type=JSON&json={"tag"%3A"Verify","Verify"%3A{"phone"%3A13000082001}})，其它同HEAD | 同HEAD +POST:
新增数据 | base_url/post/ | 单个：
{
   TableName:{
     …
   },
   "tag":tag
}
{…}中id由后端生成，不能传

例如当前登录用户 38710 发布一个新 Comment：
[{
   "Comment":{
     "momentId":12,
     "content":"APIJSON is the real-time coding-free, powerful and secure ORM"
   },
   "tag":"Comment"
}](http://apijson.cn/api?url=http%3A%2F%2Fapijson.cn%3A8080%2Fpost&type=JSON&json={"Comment":{"momentId":12,"content":"APIJSON%20is%20the%20Real-Time%20coding-free,%20powerful%20and%20secure%20ORM."},"tag":"Comment"})
后端校验通过后自动解析为 SQL 并执行：
`INSERT INTO Comment(userId,momentId,content) VALUES(38710,12,'APIJSON is the real-time coding-free, powerful and secure ORM')`

批量：
{
   TableName\[]:\[{
       …
     }, {
       …
     }
     …
   ],
   "tag":tag
}
{…}中id由后端生成，不能传

例如当前登录用户 82001 发布 2 个 Comment：
[{
   "Comment[]":[{
     "momentId":12,
     "content":"APIJSON is the real-time coding-free, powerful and secure ORM"
     }, {
     "momentId":15,
     "content":"APIJSON is a JSON transmision protocol."
   }],
   "tag":"Comment:[]"
}](http://apijson.cn/api?url=http%3A%2F%2Fapijson.cn%3A8080%2Fpost&type=JSON&json={"Comment[]":[{"momentId":12,"content":"APIJSON%20is%20the%20Real-Time%20coding-free,%20powerful%20and%20secure%20ORM."},{"momentId":15,"content":"APIJSON%20is%20a%20JSON%20transmision%20protocol."}],"tag":"Comment:[]"})
后端校验通过后自动解析为 SQL 并执行：
`INSERT INTO Comment(userId,momentId,content) VALUES(82001,12,'APIJSON is the real-time coding-free, powerful and secure ORM');`

`INSERT INTO Comment(userId,momentId,content) VALUES(82001,15,'APIJSON is a JSON transmision protocol.');` | 单个：
{
   TableName:{
     "code":200,
     "msg":"success",
     "id":38710
   },
   "code":200,
   "msg":"success"
}
例如
{
   "Comment":{
     "code":200,
     "msg":"success",
     "id":120
   },
   "code":200,
   "msg":"success"
}

批量：
{
   TableName:{
     "code":200,
     "msg":"success",
     "count":5,
     "id[]":[1, 2, 3, 4, 5]
   },
   "code":200,
   "msg":"success"
}
例如
{
   "Comment":{
     "code":200,
     "msg":"success",
     "count":2,
     "id[]":\[1, 2]
   },
   "code":200,
   "msg":"success"
} +PUT:
修改数据，
只修改所传的字段 | base_url/put/ | {
   TableName:{
     "id":id,
     …
   },
   "tag":tag
}
{…} 中 id 或 id{} 至少传一个

例如当前登录用户 82001 修改 id = 235 的 Moment 的 content：
[{
   "Moment":{
     "id":235,
     "content":"APIJSON is the real-time coding-free, powerful and secure ORM"
   },
   "tag":"Moment"
}](http://apijson.cn/api?url=http%3A%2F%2Fapijson.cn%3A8080%2Fput&type=JSON&json={"Moment":{"id":235,"content":"APIJSON%20is%20the%20Real-Time%20coding-free,%20powerful%20and%20secure%20ORM."},"tag":"Moment"})
后端校验通过后自动解析为 SQL 并执行：
`UPDATE Moment SET content='APIJSON is the real-time coding-free, powerful and secure ORM' WHERE id=235 AND userId=82001 LIMIT 1`

批量除了 id{}:\[] 也可类似批量 POST，只是每个 {...} 里面都必须有 id。
"tag":"Comment[]" 对应对象 "Comment":{"id{}":[1,2,3]}，表示指定记录全部统一设置；
"tag":"Comment:[]" 多了冒号，对应数组 "Comment[]":[{"id":1},{"id":2},{"id":3}]，表示每项单独设置 | 同POST +DELETE:
删除数据 | base_url/delete/ | {
   TableName:{
     "id":id
   },
   "tag":tag
}
{…} 中 id 或 id{} 至少传一个，一般只传 id 或 id{}

例如当前登录用户 82001 批量删除 id = 100,110,120 的 Comment：
[{
   "Comment":{
     "id{}":[100,110,120]
   },
   "tag":"Comment[]"
}](http://apijson.cn/api?url=http%3A%2F%2Fapijson.cn%3A8080%2Fdelete&type=JSON&json={"Comment":{"id{}":[100,110,120]},"tag":"Comment[]"})
后端校验通过后自动解析为 SQL 并执行：
`DELETE FROM Comment WHERE id IN(100,110,120) AND userId=82001 LIMIT 3` | {
   TableName:{
     "code":200,
     "msg":"success",
     "id[]":[100,110,120]
      "count":3
   },
   "code":200,
   "msg":"success"
}
例如
{
   "Comment":{
      "code":200,
      "msg":"success",
      "id[]":[100,110,120],
      "count":3
   },
   "code":200,
   "msg":"success"
} +以上接口的简单形式:
base_url/{method}/{tag} | GET: 普通获取数据
base_url/get/{tag}

HEAD: 普通获取数量
base_url/head/{tag}

GETS: 安全/私密获取数据
base_url/gets/{tag}

HEADS: 安全/私密获取数量
base_url/heads/{tag}

POST: 新增数据
base_url/post/{tag}

PUT: 修改数据 base_url/put/{tag}

DELETE: 删除数据
base_url/delete/{tag} | 例如安全/私密获取一个 id = 82001 的 Privacy：
[base_url/gets/Privacy/
{"id":82001}](http://apijson.cn/api/?url=http%3A%2F%2Fapijson.cn%3A8080%2Fgets%2FPrivacy&type=JSON&json={"id"%3A82001})
相当于
[base_url/gets/
{"tag":"Privacy", "Privacy":{"id":82001}}](http://apijson.cn/api/?url=http%3A%2F%2Fapijson.cn%3A8080%2Fgets&type=JSON&json={"tag"%3A"Privacy","Privacy"%3A{"id"%3A82001}})

例如批量修改 id = 114, 124 的 Comment 的 content：
[base_url/put/Comemnt[]/
{
   "id{}":[114,124],
   "content":"test multi put"
}](http://apijson.cn/api?url=http%3A%2F%2Fapijson.cn%3A8080%2Fput%2FComment[]&type=JSON&json={"id{}"%3A[114,124],"content"%3A"test%20multi%20put"})
相当于
[base_url/put/
{
   "tag":"Comment[]",
   "Comment":{
     "id{}":[114,124],
     "content":"test multi put"
   }
}](http://apijson.cn/api?url=http%3A%2F%2Fapijson.cn%3A8080%2Fput&type=JSON&json={"tag"%3A"Comment[]","Comment"%3A{"id{}"%3A[114,124],"content"%3A"test%20multi%20put"}}) | 同以上对应的方法 1.TableName指要查询的数据库表Table的名称字符串。第一个字符为大写字母，剩下的字符要符合英语字母、数字、下划线中的任何一种。对应的值的类型为JSONObject，结构是 {...}，里面放的是Table的字段(列名)。下同。
-2."tag":tag 后面的tag是非GET、HEAD请求中匹配请求的JSON结构的标识，一般是要查询的table的名称，由后端Request表中指定。下同。
+2."tag":tag 后面的tag是非GET、HEAD请求中匹配请求的JSON结构的标识，一般是要查询的Table的名称，由后端Request表中指定。下同。
3.GET、HEAD请求是开放请求，可任意组合任意嵌套。其它请求为受限制的安全/私密请求，对应的 方法（method）, 标识（tag）, 版本（version）, 结构（structure） 都必须和 后端Request表中所指定的 一一对应，否则请求将不被通过。version 不传、为 null 或 <=0 都会使用最高版本，传了其它有效值则会使用最接近它的最低版本。下同。
4.GETS与GET、HEADS与HEAD分别为同一类型的操作方法，请求稍有不同但返回结果相同。下同。
5.在HTTP通信中，自动化接口(get,gets,head,heads,post,put,delete) 全用HTTP POST请求。下同。
@@ -353,24 +403,24 @@ DELETE:
删除数据 | base_url/delete/ | {
   TableName:{< 功能 | 键值对格式 | 使用示例 ------------ | ------------ | ------------ - 查询数组 | "key[]":{}，后面是JSONObject，key可省略。当key和里面的Table名相同时，Table会被提取出来，即 {Table:{Content}} 会被转化为 {Content} | [{"User[]":{"User":{}}}](http://apijson.cn:8080/get/{"User[]":{"count":3,"User":{}}})，查询一个User数组。这里key和Table名都是User，User会被提取出来，即 {"User":{"id", ...}} 会被转化为 {"id", ...}，如果要进一步提取User中的id，可以把User[]改为User-id[] - 匹配选项范围 | "key{}":[]，后面是JSONArray，作为key可取的值的选项 | ["id{}":[38710,82001,70793]](http://apijson.cn:8080/get/{"User[]":{"count":3,"User":{"id{}":[38710,82001,70793]}}})，对应SQL是`id IN(38710,82001,70793)`，查询id符合38710,82001,70793中任意一个的一个User数组 - 匹配条件范围 | "key{}":"条件0,条件1..."，条件为SQL表达式字符串，可进行数字比较运算等 | ["id{}":"<=80000,\>90000"](http://apijson.cn:8080/get/{"User[]":{"count":3,"User":{"id{}":"<=80000,\>90000"}}})，对应SQL是`id<=80000 OR id>90000`，查询id符合id\<=80000 \| id>90000的一个User数组 - 包含选项范围 | "key<\>":Object => "key<\>":[Object]，key对应值的类型必须为JSONArray，Object类型不能为JSON | ["contactIdList<\>":38710](http://apijson.cn:8080/get/{"User[]":{"count":3,"User":{"contactIdList<\>":38710}}})，对应SQL是`json_contains(contactIdList,38710)`，查询contactIdList包含38710的一个User数组 + 查询数组 | "key[]":{}，后面是 JSONObject，key 可省略。当 key 和里面的 Table 名相同时，Table 会被提取出来，即 {Table:{Content}} 会被转化为 {Content} | [{"User[]":{"User":{}}}](http://apijson.cn:8080/get/{"User[]":{"count":3,"User":{}}})，查询一个 User 数组。这里 key 和 Table 名都是 User，User 会被提取出来，即 {"User":{"id", ...}} 会被转化为 {"id", ...}，如果要进一步提取 User 中的 id，可以把 User[] 改为 User-id[]，其中 - 用来分隔路径中涉及的 key + 匹配选项范围 | "key{}":[]，后面是 JSONArray，作为 key 可取的值的选项 | ["id{}":[38710,82001,70793]](http://apijson.cn:8080/get/{"User[]":{"count":3,"User":{"id{}":[38710,82001,70793]}}})，对应 SQL 是`id IN(38710,82001,70793)`，查询 id 符合 38710,82001,70793 中任意一个的一个 User 数组 + 匹配条件范围 | "key{}":"条件0,条件1..."，条件为 SQL 表达式字符串，可进行数字比较运算等 | ["id{}":"<=80000,\>90000"](http://apijson.cn:8080/get/{"User[]":{"count":3,"User":{"id{}":"<=80000,\>90000"}}})，对应 SQL 是`id<=80000 OR id>90000`，查询 id 符合 id\<=80000 \| id>90000 的一个 User 数组 + 包含选项范围 | "key<\>":value => "key<\>":[value]，key 对应值的类型必须为 JSONArray，value 值类型只能为 Boolean, Number, String 中的一种 | ["contactIdList<\>":38710](http://apijson.cn:8080/get/{"User[]":{"count":3,"User":{"contactIdList<\>":38710}}})，对应SQL是`json_contains(contactIdList,38710)`，查询 contactIdList 包含 38710 的一个 User 数组 判断是否存在 | "key}{@":{
   "from":"Table",
   "Table":{ ... }
}
其中：
}{ 表示 EXISTS；
key 用来标识是哪个判断；
@ 后面是 子查询 对象，具体见下方 子查询 的说明。 | ["id}{@":{
   "from":"Comment",
   "Comment":{
      "momentId":15
   }
}](http://apijson.cn:8080/get/{"User":{"id}{@":{"from":"Comment","Comment":{"momentId":15}}}})
WHERE EXISTS(SELECT * FROM Comment WHERE momentId=15) - 远程调用函数 | "key()":"函数表达式"，函数表达式为 function(key0,key1...)，会调用后端对应的函数 function(JSONObject request, String key0, String key1...)，实现 参数校验、数值计算、数据同步、消息推送、字段拼接、结构变换 等特定的业务逻辑处理，
可使用 - 和 + 表示优先级，解析 key-() > 解析当前对象 > 解析 key() > 解析子对象 > 解析 key+() | ["isPraised()":"isContain(praiseUserIdList,userId)"](http://apijson.cn:8080/get/{"Moment":{"id":301,"isPraised()":"isContain(praiseUserIdList,userId)"}})，会调用远程函数 boolean isContain(JSONObject request, String array, String value) ，然后变为 "isPraised":true 这种（假设点赞用户id列表包含了userId，即这个User点了赞） + 远程调用函数 | "key()":"函数表达式"，函数表达式为 function(key0,key1...)，会调用后端对应的函数 function(JSONObject request, String key0, String key1...)，实现 参数校验、数值计算、数据同步、消息推送、字段拼接、结构变换 等特定的业务逻辑处理，
可使用 - 和 + 表示优先级，解析 key-() > 解析当前对象 > 解析 key() > 解析子对象 > 解析 key+() | ["isPraised()":"isContain(praiseUserIdList,userId)"](http://apijson.cn:8080/get/{"Moment":{"id":301,"isPraised()":"isContain(praiseUserIdList,userId)"}})，会调用远程函数 [boolean isContain(JSONObject request, String array, String value)](https://github.com/APIJSON/apijson-framework/blob/master/src/main/java/apijson/framework/APIJSONFunctionParser.java#L361-L374) ，然后变为 "isPraised":true 这种（假设点赞用户id列表包含了userId，即这个User点了赞） 存储过程 | "@key()":"SQL函数表达式"，函数表达式为
function(key0,key1...)
会调用后端数据库对应的存储过程 SQL函数
function(String key0, String key1...)
除了参数会提前赋值，其它和 远程函数 一致 | ["@limit":10,
"@offset":0,
"@procedure()":"getCommentByUserId(id,@limit,@offset)"](http://apijson.cn:8080/get/{"User":{"@limit":10,"@offset":0,"@procedure()":"getCommentByUserId(id,@limit,@offset)"}})
会转为
`getCommentByUserId(38710,10,0)`
来调用存储过程 SQL 函数
`getCommentByUserId(IN id bigint, IN limit int, IN offset int)`
然后变为
"procedure":{
   "count":-1,
   "update":false,
   "list":[]
}
其中 count 是指写操作影响记录行数，-1 表示不是写操作；update 是指是否为写操作（增删改）；list 为返回结果集 引用赋值 | "key@":"key0/key1/.../refKey"，引用路径为用/分隔的字符串。以/开头的是缺省引用路径，从声明key所处容器的父容器路径开始；其它是完整引用路径，从最外层开始。
被引用的refKey必须在声明key的上面。如果对refKey的容器指定了返回字段，则被引用的refKey必须写在@column对应的值内，例如 "@column":"refKey,key1,..." | ["Moment":{
   "userId":38710
},
"User":{
   "id@":"/Moment/userId"
}](http://apijson.cn:8080/get/{"Moment":{"userId":38710},"User":{"id@":"%252FMoment%252FuserId"}})
User内的id引用了与User同级的Moment内的userId，
即User.id = Moment.userId，请求完成后
"id@":"/Moment/userId" 会变成 "id":38710 子查询 | "key@":{
   "range":"ALL",
   "from":"Table",
   "Table":{ ... }
}
其中：
range 可为 ALL,ANY；
from 为目标表 Table 的名称；
@ 后面的对象类似数组对象，可使用 count 和 join 等功能。 | ["id@":{
   "from":"Comment",
   "Comment":{
      "@column":"min(userId)"
   }
}](http://apijson.cn:8080/get/{"User":{"id@":{"from":"Comment","Comment":{"@column":"min(userId)"}}}})
WHERE id=(SELECT min(userId) FROM Comment) - 模糊搜索 | "key$":"SQL搜索表达式" => "key$":["SQL搜索表达式"]，任意SQL搜索表达式字符串，如 %key%(包含key), key%(以key开始), %k%e%y%(包含字母k,e,y) 等，%表示任意字符 | ["name$":"%m%"](http://apijson.cn:8080/get/{"User[]":{"count":3,"User":{"name$":"%2525m%2525"}}})，对应SQL是`name LIKE '%m%'`，查询name包含"m"的一个User数组 + 模糊搜索 | `"key$":"SQL搜索表达式"` => `"key$":["SQL搜索表达式"]`，任意SQL搜索表达式字符串，如 %key%(包含key), key%(以key开始), %k%e%y%(包含字母k,e,y) 等，%表示任意字符 | ["name$":"%m%"](http://apijson.cn:8080/get/{"User[]":{"count":3,"User":{"name$":"%2525m%2525"}}})，对应SQL是`name LIKE '%m%'`，查询name包含"m"的一个User数组 正则匹配 | "key~":"正则表达式" => "key~":["正则表达式"]，任意正则表达式字符串，如 ^[0-9]+$ ，*~ 忽略大小写，可用于高级搜索 | ["name~":"^[0-9]+$"](http://apijson.cn:8080/get/{"User[]":{"count":3,"User":{"name~":"^[0-9]%252B$"}}})，对应SQL是`name REGEXP '^[0-9]+$'`，查询name中字符全为数字的一个User数组 连续范围 | "key%":"start,end" => "key%":["start,end"]，其中 start 和 end 都只能为 Boolean, Number, String 中的一种，如 "2017-01-01,2019-01-01" ，["1,90000", "82001,100000"] ，可用于连续范围内的筛选 | ["date%":"2017-10-01,2018-10-01"](http://apijson.cn:8080/get/{"User[]":{"count":3,"User":{"date%2525":"2017-10-01,2018-10-01"}}})，对应SQL是`date BETWEEN '2017-10-01' AND '2018-10-01'`，查询在2017-10-01和2018-10-01期间注册的用户的一个User数组 - 新建别名 | "name:alias"，name映射为alias，用alias替代name。可用于 column,Table,SQL函数 等。只用于GET类型、HEAD类型的请求 | ["@column":"toId:parentId"](http://apijson.cn:8080/get/{"Comment":{"@column":"id,toId:parentId","id":51}})，对应SQL是`toId AS parentId`，将查询的字段toId变为parentId返回 + 新建别名 | ① "name:alias"，name 映射为 alias，用 alias 替代 name，可用于 column,Table,SQL 函数 等，只用于 GET 类型、HEAD 类型的请求

② 函数调用映射
"@key": "fun:avg(id);keyA:(keyB)",
"fun>": 1,
"keyA": 1
其中 fun:fun(arg) 把 SQL 函数调用 fun(arg) 作为左侧表达式替代 fun，即 fun(arg) > 1；
keyA:(keyB) 表示将字段 keyA 重命名为 keyB，即实际 SQL 中为 keyB = 1，常用于重命名冲突的多条件同名字段。 | ① ["@column":"toId:parentId"](http://apijson.cn:8080/get/{"Comment":{"@column":"id,toId:parentId","id":51}})，对应 SQL 是 `toId AS parentId`，将查询的字段 toId 变为 parentId 返回

② ["@key": "len:length(content);mid:(momentId)",
"len<=": 10,
"mid": 12,
"momentId": 15,
"@combine": "(len<= \\| mid) & momentId"](http://apijson.cn/api?type=JSON&json={%22Comment%22:{%22@key%22:%22len%3Alength(content)%3Bmid%3A(momentId)%22,%22len%3C=%22:10,%22mid%22:12,%22momentId%22:15,%22@combine%22:%22(len%3C%3D%20%7C%20mid)%20%26%20momentId%22}})
对应 SQL 是 `(length(content) <= 10 OR momentId = 12) AND momentId = 15` 增加 或 扩展 | "key+":Object，Object的类型由key指定，且类型为Number,String,JSONArray中的一种。如 82001,"apijson",["url0","url1"] 等。只用于PUT请求 | "praiseUserIdList+":[82001]，对应SQL是`json_insert(praiseUserIdList,82001)`，添加一个点赞用户id，即这个用户点了赞 减少 或 去除 | "key-":Object，与"key+"相反 | "balance-":100.00，对应SQL是`balance = balance - 100.00`，余额减少100.00，即花费了100元 - 比较运算 | >, <, >=, <= 比较运算符，用于
① 提供 "id{}":"<=90000" 这种条件范围的简化写法

② 实现子查询相关比较运算

不支持 "key=":Object 和 "key!=":Object 这两种写法，直接用更简单的 "key":Object 和 "key!":Object 替代。 | ① ["id<=":90000](http://apijson.cn:8080/get/{"[]":{"User":{"id<=":90000}}})，对应SQL是`id<=90000`，查询符合id<=90000的一个User数组

② ["id>@":{
   "from":"Comment",
   "Comment":{
      "@column":"min(userId)"
   }
}](http://apijson.cn:8080/get/{"User":{"id>@":{"from":"Comment","Comment":{"@column":"min(userId)"}}}})
WHERE id>(SELECT min(userId) FROM Comment) - 逻辑运算 | &, \|, ! 逻辑运算符，对应数据库 SQL 中的 AND, OR, NOT。
横或纵与：同一键值对的值内条件默认 \| 或连接，可以在 key 后加逻辑运算符来具体指定；不同键值对的条件默认 & 与连接，可以用下面说明的对象关键词 @combine 来具体指定。

① & 可用于"key&{}":"条件"等

② \| 可用于"key\|{}":"条件", "key\|{}":[]等，一般可省略

③ ! 可单独使用，如"key!":Object，也可像&,\|一样配合其他功能符使用
"key!":null 无效，null 值会导致整个键值对被忽略解析，可以用 "key{}":"!=null" 替代，
"key":null 同理，用 "key{}":"=null" 替代。 | ① ["id&{}":">80000,<=90000"](http://apijson.cn:8080/head/{"User":{"id&{}":">80000,<=90000"}})，对应SQL是`id>80000 AND id<=90000`，即id满足id>80000 & id<=90000

② ["id\|{}":">90000,<=80000"](http://apijson.cn:8080/head/{"User":{"id\|{}":">90000,<=80000"}})，同"id{}":">90000,<=80000"，对应SQL是`id>80000 OR id<=90000`，即id满足id>90000 \| id<=80000

③ ["id!{}":[82001,38710]](http://apijson.cn:8080/head/{"User":{"id!{}":[82001,38710]}})，对应SQL是`id NOT IN(82001,38710)`，即id满足 ! (id=82001 \| id=38710)，可过滤黑名单的消息 - 数组关键词，可自定义 | "key":Object，key为 "[]":{} 中{}内的关键词，Object的类型由key指定

① "count":Integer，查询数量，0 表示最大值，默认最大值为100

② "page":Integer，查询页码，从0开始，默认最大值为100，一般和count一起用

③ "query":Integer，查询内容
0-对象，1-总数和分页详情，2-以上全部
总数关键词为 total，分页详情关键词为 info，
它们都和 query 同级，通过引用赋值得到，例如
"total@":"/[]/total", "info@":"/[]/info"
这里query及total仅为GET类型的请求提供方便，
一般可直接用HEAD类型的请求获取总数

④ "join":"&/Table0/key0@,\多表连接方式：
"\<" - LEFT JOIN
">" - RIGHT JOIN
"&" - INNER JOIN
"\|" - FULL JOIN
"!" - OUTTER JOIN
"@" - APP JOIN
其中 @ APP JOIN 为应用层连表，会从已查出的主表里取得所有副表 key@ 关联的主表内的 refKey 作为一个数组 refKeys: [value0, value1...]，然后把原来副表 count 次查询 key=$refKey 的 SQL 用 key IN($refKeys) 的方式合并为一条 SQL 来优化性能；
其它 JOIN 都是 SQL JOIN，具体功能和 MySQL,PostgreSQL 等数据库的 JOIN 一一对应
`"join":"`"MainTable":{},`
`"ViceTable":{"key@":"/MainTable/refKey"}`
会对应生成
`MainTable LEFT JOIN ViceTable`
`ON ViceTable.key=MainTable.refKey`

⑤ "otherKey":Object，自定义关键词，名称和以上系统关键词不一样，且原样返回上传的值 | ① 查询User数组，最多5个：
["count":5](http://apijson.cn:8080/get/{"[]":{"count":5,"User":{}}})
对应SQL是`LIMIT 5`

② 查询第3页的User数组，每页5个：
["count":5,
"page":3](http://apijson.cn:8080/get/{"[]":{"count":5,"page":3,"User":{}}})
对应SQL是`LIMIT 5 OFFSET 15`

③ 查询User数组和对应的User总数：
["[]":{
   "query":2,
   "User":{}
},
"total@":"/[]/total",
"info@":"/[]/info"](http://apijson.cn:8080/get/{"[]":{"query":2,"count":5,"User":{}},"total@":"%252F[]%252Ftotal","info@":"%252F[]%252Finfo"})
返回的数据中，总数及分页详情结构为：
"total":139, //总数
"info":{ //分页详情
   "total":139, //总数
   "count":5, //每页数量
   "page":0, //当前页码
   "max":27, //最大页码
   "more":true, //是否还有更多
   "first":true, //是否为首页
   "last":false //是否为尾页
}

④ Moment INNER JOIN User LEFT JOIN Comment：
["[]":{
   "join":"&/User/id@,\    "Moment":{},
   "User":{
     "name~":"t",
     "id@":"/Moment/userId"
   },
   "Comment":{
     "momentId@":"/Moment/id"
   }
}](http://apijson.cn:8080/get/{"[]":{"count":5,"join":"&%252FUser%252Fid@,\<%252FComment%252FmomentId@","Moment":{"@column":"id,userId,content"},"User":{"name~":"t","id@":"%252FMoment%252FuserId","@column":"id,name,head"},"Comment":{"momentId@":"%252FMoment%252Fid","@column":"id,momentId,content"}}})

⑤ 每一层都加当前用户名：
["User":{},
"[]":{
   "name@":"User/name", //自定义关键词
   "Moment":{}
}](http://apijson.cn:8080/get/{"User":{},"[]":{"name@":"User%252Fname","Moment":{}}}) - 对象关键词，可自定义 | "@key":Object，@key为 Table:{} 中{}内的关键词，Object的类型由@key指定

① "@combine":"&key0,&key1,\|key2,key3,
!key4,!key5,&key6,key7..."，条件组合方式，\| 可省略。会自动把同类的合并，外层按照 & \| ! 顺序，内层的按传参顺序组合成
(key0 & key1 & key6 & 其它key) & (key2 \| key3 \| key7) & !(key4 \| key5)
这种连接方式，其中 "其它key" 是指与 @combine 在同一对象，且未被它声明的条件 key，默认都是 & 连接

② "@column":"column;function(arg)..."，返回字段

③ "@order":"column0+,column1-..."，排序方式

④ "@group":"column0,column1..."，分组方式。如果@column里声明了Table的id，则id也必须在@group中声明；其它情况下必须满足至少一个条件:
1.分组的key在@column里声明
2.Table主键在@group中声明

⑤ "@having":"function0(...)?value0;function1(...)?value1;function2(...)?value2..."，SQL函数条件，一般和@group一起用，函数一般在@column里声明

⑥ "@schema":"sys"，集合空间(模式)，非默认的值可通过它来指定，可以在最外层作为全局默认配置

⑦ "@database":"POSTGRESQL"，跨数据库，非默认的值可通过它来指定，可以在最外层作为全局默认配置

⑧ "@json":"key0,key1..."，转为 JSON 格式返回，符合 JSONObject 则转为 {...}，符合 JSONArray 则转为 \[...]

⑨ "@role":"OWNER"，来访角色，包括
UNKNOWN,LOGIN,CONTACT,CIRCLE,OWNER,ADMIN，
可以在最外层作为全局默认配置，
可自定义其它角色并重写 Verifier.verify 等相关方法来自定义校验

⑩ "@explain":true，性能分析，可以在最外层作为全局默认配置

⑪ "@raw":"key0,key1..."，其中 key0, key1 都对应有键值对
"key0":"SQL片段或SQL片段的别名",
"key1":"SQL片段或SQL片段的别名"
自定义原始SQL片段，可扩展嵌套SQL函数等复杂语句，必须是后端已配置的，只有其它功能符都做不到才考虑，谨慎使用，注意防SQL注入

⑫ "@otherKey":Object，自定义关键词，名称和以上系统关键词不一样，且原样返回上传的值 | ① 搜索name或tag任何一个字段包含字符a的User列表：
["name~":"a",
"tag~":"a",
"@combine":"name~,tag~"](http://apijson.cn:8080/get/{"User[]":{"count":10,"User":{"@column":"id,name,tag","name~":"a","tag~":"a","@combine":"name~,tag~"}}})
对应SQL是`name REGEXP 'a' OR tag REGEXP 'a'`

② 只查询id,sex,name这几列并且请求结果也按照这个顺序：
["@column":"id,sex,name"](http://apijson.cn:8080/get/{"User":{"@column":"id,sex,name","id":38710}})
对应SQL是`SELECT id,sex,name`

③ 查询按 name降序、id默认顺序 排序的User数组：
["@order":"name-,id"](http://apijson.cn:8080/get/{"[]":{"count":10,"User":{"@column":"name,id","@order":"name-,id"}}})
对应SQL是`ORDER BY name DESC,id`

④ 查询按userId分组的Moment数组：
["@group":"userId,id"](http://apijson.cn:8080/get/{"[]":{"count":10,"Moment":%7B"@column":"userId,id","@group":"userId,id"}}})
对应SQL是`GROUP BY userId,id`

⑤ 查询 按userId分组、id最大值>=100 的Moment数组：
["@column":"userId;max(id)",
"@group":"userId",
"@having":"max(id)>=100"](http://apijson.cn:8080/get/{"[]":{"count":10,"Moment":{"@column":"userId%253Bmax(id)","@group":"userId","@having":"max(id)>=100"}}})
对应SQL是`SELECT userId,max(id) ... GROUP BY userId HAVING max(id)>=100`
还可以指定函数返回名：
["@column":"userId;max(id):maxId",
"@group":"userId",
"@having":"maxId>=100"](http://apijson.cn:8080/get/{"[]":{"count":10,"Moment":{"@column":"userId%253Bmax(id):maxId","@group":"userId","@having":"maxId>=100"}}})
对应SQL是`SELECT userId,max(id) AS maxId ... GROUP BY userId HAVING maxId>=100`

⑥ 查询 sys 内的 User 表：
["@schema":"sys"](http://apijson.cn:8080/get/{"User":{"@schema":"sys"}})
对应SQL是`FROM sys.User`

⑦ 查询 PostgreSQL 数据库的 User 表：
["@database":"POSTGRESQL"](http://apijson.cn:8080/get/{"User":{"@database":"POSTGRESQL","@explain":true}})

⑧ 将 VARCHAR 字符串字段 get 转为 JSONArray 返回：
["@json":"get"](http://apijson.cn:8080/get/{"Access":{"@json":"get"}})

⑨ 查询当前用户的动态：
["@role":"OWNER"](http://apijson.cn:8080/get/{"[]":{"Moment":{"@role":"OWNER"}}})

⑩ 开启性能分析：
["@explain":true](http://apijson.cn:8080/get/{"[]":{"Moment":{"@explain":true}}})
对应SQL是`EXPLAIN`

⑪ 统计最近一周偶数userId的数量
["@column":"sum(if(userId%2=0,1,0))",
"@having":"to_days(now())-to_days(\`date\`)<=7",
"@raw":"@column,@having"](http://apijson.cn:8080/get/{"Comment":{"@column":"sum(if(userId%252=0,1,0))","@having":"to_days(now())-to_days(\`date\`)<=7","@raw":"@column,@having"}})
对应SQL是``SELECT sum(if(userId%2=0,1,0)) ... HAVING to_days(now())-to_days(`date`)<=7``

⑫ 从pictureList获取第0张图片：
["@position":0, //自定义关键词
"firstPicture()":"getFromArray(pictureList,@position)"](http://apijson.cn:8080/get/{"User":{"id":38710,"@position":0,"firstPicture()":"getFromArray(pictureList,@position)"}}) - + 比较运算 | >, <, >=, <= 比较运算符，用于
① 提供 "id{}":"<=90000" 这种条件范围的简化写法

② 实现子查询相关比较运算

不支持 "key=":Object 和 "key!=":Object 这两种写法，直接用更简单的 "key":Object 和 "key!":Object 替代。 | ① ["id<=":90000](http://apijson.cn:8080/get/{"[]":{"User":{"id<=":90000}}})，对应 SQL 是`id<=90000`，查询符合id<=90000的一个User数组

② ["id>@":{
   "from":"Comment",
   "Comment":{
      "@column":"min(userId)"
   }
}](http://apijson.cn:8080/get/{"User":{"id>@":{"from":"Comment","Comment":{"@column":"min(userId)"}}}})
WHERE id>(SELECT min(userId) FROM Comment) + 逻辑运算 | &, \|, ! 逻辑运算符，对应数据库 SQL 中的 AND, OR, NOT。
横或纵与：同一键值对的值内条件默认 \| 或连接，可以在 key 后加逻辑运算符来具体指定；不同键值对的条件默认 & 与连接，可以用下面说明的对象关键词 @combine 来具体指定。

① & 可用于 "key&{}":"条件"等

② \| 可用于 "key\|{}":"条件", "key\|{}":[]等，一般可省略

③ ! 可单独使用，如 "key!":Object，也可像 &,\| 一样配合其他功能符使用
"key!":null 无效，null 值会导致整个键值对被忽略解析，可以用 "key{}":"!=null" 替代，
"key":null 同理，用 "key{}":"=null" 替代。 | ① ["id&{}":">80000,<=90000"](http://apijson.cn:8080/head/{"User":{"id&{}":">80000,<=90000"}})，对应SQL是`id>80000 AND id<=90000`，即id满足id>80000 & id<=90000

② ["id\|{}":">90000,<=80000"](http://apijson.cn:8080/head/{"User":{"id\|{}":">90000,<=80000"}})，同 "id{}":">90000,<=80000"，对应 SQL 是`id>90000 OR id<=80000`，即 id 满足 id>90000 \| id<=80000

③ ["id!{}":[82001,38710]](http://apijson.cn:8080/head/{"User":{"id!{}":[82001,38710]}})，对应 SQL 是`id NOT IN(82001,38710)`，即 id 满足 ! (id=82001 \| id=38710)，可过滤黑名单的消息 + 数组关键词，可自定义 | "key":Object，key为 "[]":{} 中 {} 内的关键词，Object 的类型由 key 指定

① "count":5，查询数量，0 表示最大值，默认值为 10，默认最大值为 100

② "page":1，查询页码，从 0 开始，默认值为 0，默认最大值为 100，一般和 count 一起用

③ "query":2，查询内容
0-对象，1-总数和分页详情，2-数据、总数和分页详情
总数关键词为 total，分页详情关键词为 info，
它们都和 query 同级，通过引用赋值得到自定义 key:value 键值对，不传则返回默认键值对，例如
"total@":"/[]/total", "info@":"/[]/info"
这里query及total仅为GET类型的请求提供方便，
一般可直接用HEAD类型的请求获取总数

④ "compat": true
处理最外层查询字段有特殊处理的情况下 "query":2 返回查询总数不准确的问题：如DISTINCT去重、Aggregate 函数等

⑤ "join":"&/Table0,\"join":{
   "&/Table0":{}, // 支持 ON 多个字段关联,
   "\      "key0":value0, // 其它ON条件
     "key2":value2,
     ...
     "@combine":"...", // 其它ON条件的组合方式
     "@column":"...", // 外层 SELECT
     "@group":"...", // 外层 GROUP BY
     "@having":"..." // 外层 HAVING
   }
}
多表连接方式：
"@" - APP JOIN
"\<" - LEFT JOIN
">" - RIGHT JOIN
"&" - INNER JOIN
"\|" - FULL JOIN
"!" - OUTER JOIN
"*" - CROSS JOIN
"^" - SIDE JOIN
"(" - ANTI JOIN
")" - FOREIGN JOIN
其中 @ APP JOIN 为应用层连表，会从已查出的主表里取得所有副表 key@ 关联的主表内的 refKey 作为一个数组 refKeys: [value0, value1...]，然后把原来副表 count 次查询 key=$refKey 的 SQL 用 key IN($refKeys) 的方式合并为一条 SQL 来优化性能；
其它 JOIN 都是 SQL JOIN，具体功能和 MySQL,PostgreSQL 等数据库的 JOIN 一一对应
`"join":"`"MainTable":{},`
`"ViceTable":{"key@":"/MainTable/refKey"}`
会对应生成
`MainTable LEFT JOIN ViceTable`
`ON ViceTable.key=MainTable.refKey` AND 其它ON条件
除了 = 等价关联，也支持 ! 不等关联、\> \< \>= \<= 等比较关联和 $ ~ {} <> 等其它复杂关联方式

⑥ "otherKey":Object，自定义关键词，名称和以上系统关键词不一样，且原样返回上传的值 | ① 查询User数组，最多5个：
["count":5](http://apijson.cn:8080/get/{"[]":{"count":5,"User":{}}})
对应 SQL 是`LIMIT 5`

② 查询第3页的User数组，每页5个：
["count":5,
"page":3](http://apijson.cn:8080/get/{"[]":{"count":5,"page":3,"User":{}}})
对应 SQL 是`LIMIT 5 OFFSET 15`

③ 查询User数组和对应的User总数：
["[]":{
   "query":2,
   "User":{}
},
"total@":"/[]/total", // 可省略
"info@":"/[]/info" // 可省略](http://apijson.cn:8080/get/{"[]":{"query":2,"count":5,"User":{}},"total@":"%252F[]%252Ftotal","info@":"%252F[]%252Finfo"})
返回的数据中，总数及分页详情结构为：
"total":139, // 总数
"info":{ // 分页详情
   "total":139, // 总数
   "count":5, // 每页数量
   "page":0, // 当前页码
   "max":27, // 最大页码
   "more":true, // 是否还有更多
   "first":true, // 是否为首页
   "last":false // 是否为尾页
}

④查询User数组ID唯一情况下的User总数：
["[]":{
   "query":2,
   "compat":"true",
   "User":{
     "@column":"DISTINCT id"
   }
}](http://apijson.cn:8080/get/{"[]":{"query":2,"count":5,"User":{}}})
返回的数据和结构同上

⑤ Moment INNER JOIN User LEFT JOIN Comment：
["[]":{
   "join":"&/User/id@,\    "Moment":{
     "@group":"id" // 主副表不是一对一，要去除重复数据
   },
   "User":{
     "name~":"t",
     "id@":"/Moment/userId"
   },
   "Comment":{
     "momentId@":"/Moment/id"
   }
}](http://apijson.cn/api/?type=JSON&url=http://apijson.cn:8080/get&json=%7B%22%5B%5D%22:%7B%22count%22:5,%22join%22:%22%26%2FUser%2Fid@,%3C%2FComment%22,%22Moment%22:%7B%22@column%22:%22id,userId,content%22,%22@group%22:%22id%22%7D,%22User%22:%7B%22name~%22:%22t%22,%22id@%22:%22%2FMoment%2FuserId%22,%22@column%22:%22id,name,head%22%7D,%22Comment%22:%7B%22momentId@%22:%22%2FMoment%2Fid%22,%22@column%22:%22id,momentId,content%22%7D%7D%7D)

⑥ 每一层都加当前用户名：
["User":{},
"[]":{
   "name@":"User/name", // 自定义关键词
   "Moment":{}
}](http://apijson.cn:8080/get/{"User":{},"[]":{"name@":"User%252Fname","Moment":{}}}) + 对象关键词，可自定义 | "@key":Object，@key 为 Table:{} 中 {} 内的关键词，Object 的类型由 @key 指定

① "@combine":"key0 \| (key1 & (key2 \| !key3))..."，条件组合方式，最终按
(其它key条件 AND 连接) AND (key0条件 OR (key1条件 AND (key2条件 OR (NOT key3条件))))
这种方式连接，其中 "其它key" 是指与 @combine 在同一对象，且未被它声明的条件 key，默认都是 & 连接。注意不要缺少或多余任何一个空格。

② "@column":"column;function(arg)..."，返回字段

③ "@order":"column0+,column1-..."，排序方式

④ "@group":"column0,column1..."，分组方式。如果 @column 里声明了 Table 的 id，则 id 也必须在 @group 中声明；其它情况下必须满足至少一个条件:
1.分组的 key 在 @column 里声明
2.Table 主键在 @group 中声明

⑤ "@having":"function0(...)?value0;function1(...)?value1;function2(...)?value2..." // OR 连接，或
"@having&":"function0(...)?value0;function1(...)?value1;function2(...)?value2..." // AND 连接，或
"@having":{
   "h0":"function0(...)?value0",
   "h1":function1(...)?value1",
   "h2":function2(...)?value2...",
   "@combine":"h0 & (h1 \| !h2)" // 任意组合，非必传
}
SQL 函数条件，一般和 @group 一起用，函数一般在 @column 里声明

⑥ "@schema":"sys"，集合空间(数据库名/模式)，非默认的值可通过它来指定，可以在最外层作为全局默认配置

⑦ "@database":"POSTGRESQL"，数据库类型，非默认的值可通过它来指定，可以在最外层作为全局默认配置

⑧ "@datasource":"DRUID"，跨数据源，非默认的值可通过它来指定，可以在最外层作为全局默认配置

⑨ "@json":"key0,key1..."，转为 JSON 格式返回，符合 JSONObject 则转为 {...}，符合 JSONArray 则转为 \[...]

⑩ "@role":"OWNER"，来访角色，包括
UNKNOWN,LOGIN,CONTACT,CIRCLE,OWNER,ADMIN，
可以在最外层作为全局默认配置，
可自定义其它角色并重写 Verifier.verify 等相关方法来自定义校验

⑪ "@explain":true，性能分析，可以在最外层作为全局默认配置

⑫ "@raw":"key0,key1..."，其中 key0, key1 都对应有键值对
"key0":"SQL片段或SQL片段的别名",
"key1":"SQL片段或SQL片段的别名"
自定义原始SQL片段，可扩展嵌套SQL函数等复杂语句，必须是后端已配置的，只有其它功能符都做不到才考虑，谨慎使用，注意防 SQL 注入

⑬ "@null":"key1,key2..."，空值键值对，自动插入 key1:null, key2:null ... 并作为有效键值对执行，作为条件时对应 SQL 是 `WHERE tag IS NULL`，作为值时对应 SQL 是 `SET tag = NULL`

⑭ "@otherKey":Object，自定义关键词，名称和以上系统关键词不一样，且原样返回上传的值 | ① 搜索 name 或 tag 任何一个字段包含字符 a 的 User 列表：
["name~":"a",
"tag~":"a",
"@combine":"name~ \| tag~"](http://apijson.cn:8080/get/{"User[]":{"count":10,"User":{"@column":"id,name,tag","name~":"a","tag~":"a","@combine":"name~%20%7C%20tag~"}}})
对应SQL是`name REGEXP 'a' OR tag REGEXP 'a'`

② 只查询 id,sex,name 这几列并且请求结果也按照这个顺序：
["@column":"id,sex,name"](http://apijson.cn:8080/get/{"User":{"@column":"id,sex,name","id":38710}})
对应 SQL 是`SELECT id,sex,name`

③ 查询按 name 降序、id 默认顺序 排序的 User 数组：
["@order":"name-,id"](http://apijson.cn:8080/get/{"[]":{"count":10,"User":{"@column":"name,id","@order":"name-,id"}}})
对应 SQL 是`ORDER BY name DESC,id`

④ 查询按 userId 分组的 Moment 数组：
["@group":"userId,id"](http://apijson.cn:8080/get/{"[]":{"count":10,"Moment":%7B"@column":"userId,id","@group":"userId,id"}}})
对应 SQL 是`GROUP BY userId,id`

⑤ 查询 按 userId 分组、id 最大值>=100 的 Moment 数组：
["@column":"userId;max(id)",
"@group":"userId",
"@having":"max(id)>=100"](http://apijson.cn:8080/get/{"[]":{"count":10,"Moment":{"@column":"userId%253Bmax(id)","@group":"userId","@having":"max(id)>=100"}}})
对应 SQL 是`SELECT userId,max(id) ... GROUP BY userId HAVING max(id)>=100`
还可以指定函数返回名：
["@column":"userId;max(id):maxId",
"@group":"userId",
"@having":"(maxId)>=100"](http://apijson.cn:8080/get/{"[]":{"count":10,"Moment":{"@column":"userId%253Bmax(id):maxId","@group":"userId","@having":"(maxId)>=100"}}})
对应 SQL 是`SELECT userId,max(id) AS maxId ... GROUP BY userId HAVING (maxId)>=100`

⑥ 查询 sys 内的 User 表：
["@schema":"sys"](http://apijson.cn:8080/get/{"User":{"@schema":"sys"}})
对应 SQL 是`FROM sys.User`

⑦ 查询 PostgreSQL 数据库的 User 表：
["@database":"POSTGRESQL"](http://apijson.cn:8080/get/{"User":{"@database":"POSTGRESQL","@explain":true}})

⑧ 使用 Druid 连接池查询 User 表：
["@datasource":"DRUID"](http://apijson.cn:8080/get/{"User":{"@datasource":"DRUID"}})

⑨ 将 VARCHAR 字符串字段 get 转为 JSONArray 返回：
["@json":"get"](http://apijson.cn:8080/get/{"Access":{"@json":"get"}})

⑩ 查询当前用户的动态：
["@role":"OWNER"](http://apijson.cn:8080/get/{"[]":{"Moment":{"@role":"OWNER"}}})

⑪ 开启性能分析：
["@explain":true](http://apijson.cn:8080/get/{"[]":{"Moment":{"@explain":true}}})
对应 SQL 是`EXPLAIN`

⑫ 统计最近一周偶数 userId 的数量
["@column":"date;left(date,10):day;sum(if(userId%2=0,1,0))",
"@group":"day",
"@having":"to_days(now())-to_days(\`date\`)<=7",
"@raw":"@column,@having"](http://apijson.cn:8080/get/{"[]":{"Moment":{"@column":"date%3bleft(date,10):day%3bsum(if(userId%252=0,1,0))","@group":"day","@having":"to_days(now())-to_days(\`date\`)<=7","@raw":"@column,@having"}}})
对应 SQL 是``SELECT date, left(date,10) AS day, sum(if(userId%2=0,1,0)) ... GROUP BY day HAVING to_days(now())-to_days(`date`)<=7``

⑬ 把用户的标签设置为空
["@null":"tag"](http://apijson.cn/api/?type=JSON&url=http://apijson.cn:8080/put/User&json={%22id%22:82001,%22@null%22:%22tag%22,%22@explain%22:true})

⑭ 从pictureList 获取第 0 张图片：
["@position":0, // 自定义关键词
"firstPicture()":"getFromArray(pictureList,@position)"](http://apijson.cn:8080/get/{"User":{"id":38710,"@position":0,"firstPicture()":"getFromArray(pictureList,@position)"}}) + 全局关键词 | 为最外层对象 {} 内的关键词。其中 @database，@schema, @datasource, @role, @explain 基本同对象关键词，见上方说明，区别是全局关键词会每个表对象中没有时自动放入，作为默认值。

① "tag":"Table"，后面的 tag 是非 GET、HEAD 请求中匹配请求的 JSON 结构的标识，一般是要查询的 Table 的名称或该名称对应的数组 Table[] 或 Table:[]，由后端 Request 表中指定。

② "version":1，接口版本，version 不传、为 null 或 <=0 都会使用最高版本，传了其它有效值则会使用最接近它的最低版本，由后端 Request 表中指定。

③ "format":true，格式化返回 Response JSON 的 key，一般是将 TableName 转为 tableName, TableName[] 转为 tableNameList, Table:alias 转为 alias, TableName-key[] 转为 tableNameKeyList 等小驼峰格式。 | ① 查隐私信息：
[{"tag":"Privacy","Privacy":{"id":82001}}](http://apijson.cn/api?url=http%3A%2F%2Fapijson.cn%3A8080%2Fgets&type=JSON&json={%22tag%22:%22Privacy%22,%22Privacy%22:{%22id%22:82001}})

② 使用第 1 版接口查隐私信息：
[{"version":1,"tag":"Privacy","Privacy":{"id":82001}}](http://apijson.cn/api?url=http%3A%2F%2Fapijson.cn%3A8080%2Fgets&type=JSON&json={%22version%22:1,%22tag%22:%22Privacy%22,%22Privacy%22:{%22id%22:82001}})

③ 格式化朋友圈接口返回 JSON 中的 key：
[{
   "format":true,
   "[]":{
     "page":0,
     "count":3,
     "Moment":{},
     "User":{
       "id@":"/Moment/userId"
     },
     "Comment[]":{
       "count":3,
       "Comment":{
         "momentId@":"[]/Moment/id"
       }
     }
   }
}](http://apijson.cn:8080/get/{"format":true,"[]":{"page":0,"count":3,"Moment":{},"User":{"id@":"%252FMoment%252FuserId"},"Comment[]":{"count":3,"Comment":{"momentId@":"[]%252FMoment%252Fid"}}}})
diff --git a/LICENSE b/LICENSE index 1a71560c8..9743dd5aa 100644 --- a/LICENSE +++ b/LICENSE @@ -1,18 +1,18 @@ Tencent is pleased to support the open source community by making APIJSON available. -Copyright (C) 2020 THL A29 Limited, a Tencent company. All rights reserved. +Copyright (C) 2020 Tencent. All rights reserved. APIJSON is licensed under the Apache License Version 2.0. A copy of the Apache License Version 2.0 is included in this file. +The copyright notice pertaining to the Tencent code in this repo was previously in the name of “THL A29 Limited.” +That entity has now been de-registered. +You should treat all previously distributed copies of the code as if the copyright notice was in the name of “Tencent.” Other dependencies and licenses: Open Source Software Licensed under the Apache License Version 2.0: -------------------------------------------------------------------- -1. fastjson -Copyright 1999-2019 Alibaba Group Holding Ltd. - Terms of Apache License Version 2.0 diff --git a/Navigation.md b/Navigation.md index cbb730679..4d92cd9d1 100644 --- a/Navigation.md +++ b/Navigation.md @@ -41,6 +41,8 @@ ### [贡献者们](/README.md#%E8%B4%A1%E7%8C%AE%E8%80%85%E4%BB%AC) +### [统计分析](/README.md#%E7%BB%9F%E8%AE%A1%E5%88%86%E6%9E%90) + ### [规划及路线图](/README.md#%E8%A7%84%E5%88%92%E5%8F%8A%E8%B7%AF%E7%BA%BF%E5%9B%BE) ### [我要赞赏](/README.md#%E6%88%91%E8%A6%81%E8%B5%9E%E8%B5%8F) diff --git a/README-English.md b/README-English.md index 21b650aba..ccafb9850 100644 --- a/README-English.md +++ b/README-English.md @@ -1,59 +1,78 @@ Tencent is pleased to support the open source community by making APIJSON available.
-Copyright (C) 2020 THL A29 Limited, a Tencent company. All rights reserved.
+Copyright (C) 2020 Tencent. All rights reserved.
This source code is licensed under the Apache License Version 2.0

APIJSON

-

🏆Gitee Most Valuable Project
🚀A JSON Transmission Protocol and an ORM Library for providing APIs and Documents automatically.

+

🏆 Tencent Top 6 Open Source Project, Achieved 5 Awards Inside & Outside Tencent 🚀
A JSON Transmission Protocol and an ORM Library for providing APIs and Documents without writing any code.

+

+  中文版  +  Document  +  Video  +  Test  + Ask AI +

-   -   - + + + + + + + + + + + + + + + + + + +

- -   -   -   - + + + + + + +

- -   -   + + +

-  中文版  -  Document  -  Video  -  Test  + + +

- +

-
+ +--- #### A better online document is available at https://apijsondocs.readthedocs.io/ -* ### [1. About](#1) -* ### [2. Server-side deployment](#2) -* [2.1 Installing with Eclipse](#2.1) -* [2.2 Import MySQL table files](#2.2) -* [2.3 Installing with IntellIJ IDEA Ultimate](#2.3)` -* ### [3. Client-side deployment](#3) -* [3.1 For Android](#3.1) -* [3.2 For iOS](#3.2) -* [3.3 For Javascript](#3.3) +* ### [1.About](#1) +* ### [2.Backend usage](#2) +* ### [3.Frontend usage](#3) * ### [4.Contributing](#4) -* ### [5.Versioning](#5) +* ### [5.Releases](#5) * ### [6.Author](#6) * ### [7.Donating](#7) @@ -61,298 +80,314 @@ This source code is licensed under the Apache License Version 2.0
##

1. About

-APIJSON is a JSON based internet communication protocol and an ORM library that largely simplifies the process of back-end API development. It also allows users to get data more quickly with self-defined form and fewer endpoints requests. +APIJSON is a JSON based internet communication protocol and an ORM library
+that largely simplifies the process of back-end API development.
+It also allows users to get data more quickly with self-defined form and fewer endpoints requests. ### Features: #### For getting data: -You can get any data by defining the specific information you want and send it to the server.
-You can get different types of data by making just one request to the server. It's very convenient and flexible, and dosen't require different API endpoints with multiple requests.
-It provides CRUD(read and write), Fuzzy Search, Remote Function Calls，etc. You can also save duplicate data, see request history,etc.
+You can get any data by defining the specific information you want and send it to the server.
+You can get different types of data by making just one request to the server.
+It's very convenient and flexible, and dosen't require different API endpoints with multiple requests.
+It provides CRUD(read and write), Fuzzy Search, Remote Function Calls, etc.
+You can also save duplicate data, see request history, etc.
#### For API design: -APIJSON largely reduces API developers' workload by reducing most api design and documentation work.
-With APIJSON, client developers will no longer be suffered from possible errors in documents, and it saves communication between server developers and client developers about APIs or documentations .
-Server developers no longer need to worry about compatibility of APIs and documents with legacy apps. - -### Examples: -#### Get a User -Request: -

-{
-  "User":{
-  }
-}
-
- -[Click here to test](http://apijson.cn:8080/get/{"User":{}}) - -Response: -

-{
-  "User":{
-    "id":38710,
-    "sex":0,
-    "name":"TommyLemon",
-    "certified":true,
-    "tag":"Android&Java",
-    "phone":13000038710,
-    "head":"http://static.oschina.net/uploads/user/1218/2437072_100.jpg?t=1461076033000",
-    "date":1485948110000,
-    "pictureList":[
-      "http://static.oschina.net/uploads/user/1218/2437072_100.jpg?t=1461076033000",
-      "http://common.cnblogs.com/images/icon_weibo_24.png"
-    ]
-  },
-  "code":200,
-  "msg":"success"
-}
-
- +APIJSON largely reduces API developers' workload by reducing most api design and documentation work.
+With APIJSON, client developers will no longer be suffered from possible errors in documents,
+and it saves communication between server developers and client developers about APIs or documentations.
+Server developers no longer need to worry about compatibility of APIs and documents with legacy apps.
+ +![0F85206E116CCEE74DB68E5B9A3AEDAE](https://user-images.githubusercontent.com/5738175/196148099-d3a9e0ba-93e5-4e1a-a4f8-a714083c6f7e.jpg) +#### Song Firework-Katy Parry(Modified for APIJSON) +Do you ever feel like a backend slave
+Repeating CRUD, wanting to make a change?
+Do you ever feel, APIs' so paper thin
+Like a house of cards, one blow from cavin' in?
+Do you ever feel they always complain?
+Urging doc and feedback bugs, even ask your refactoring
+Do you know that there's still a chance for you?
+'Cause there's a powerful tool
+You just gotta depend and configure
+And let it init
+Just start APIs
+They are so easy to try
+'Cause baby, you're a firework
+Come on, show 'em what you're worth
+Make 'em go, "Oh, oh, oh"
+As you give 'em an A-T-M
+Baby, you're a firework
+Come on, let them serve themselves
+Make 'em go, "Oh, oh, oh"
+You're gonna leave 'em all in awe, awe, awe.
+ +
+ +**Tired with endless arguments about HTTP API dev or use?**
+**Use APIJSON-the ORM for providing infinity codeless CRUD APIs that fit almost all your needs.**
+**Unfold the Power(In Your Soul) with ⭐Star & Clone.** + +### APIJSON Show +#### Postman test APIJSON +![](https://static.oschina.net/uploads/img/201711/12230359_f7fQ.jpg) +
+ +#### APIAuto test APIJSON +Note: The UI is APIAuto, the URL+JSON is APIJSON

+

+ APIJSON: query multi related tables, flexible data structures. APIAuto: multi test accounts, easily share test cases +

-#### Get an Array of Users -Request: -

-{
-  "[]":{
-    "count":3,             //just get 3 results
-    "User":{
-      "@column":"id,name"  //just get ids and names
-    }
-  }
-}
-
- -[Click here to test](http://apijson.cn:8080/get/{"[]":{"count":3,"User":{"@column":"id,name"}}}) - -Response: -

-{
-  "[]":[
-    {
-      "User":{
-        "id":38710,
-        "name":"TommyLemon"
-      }
-    },
-    {
-      "User":{
-        "id":70793,
-        "name":"Strong"
-      }
-    },
-    {
-      "User":{
-        "id":82001,
-        "name":"Android"
-      }
-    }
-  ],
-  "code":200,
-  "msg":"success"
-}
-
+![](https://oscimg.oschina.net/oscnet/up-bbbec4fc5edc472be127c02a4f3cd8f4ec2.JPEG) +![](https://raw.githubusercontent.com/TommyLemon/StaticResources/master/APIJSON/APIJSON_query_associate.gif)
+

+ APIAuto: generate request code for frontend/clients or Python test cases, easily download code +

-[Test it online](http://apijson.cn/)
- -![](https://raw.githubusercontent.com/TommyLemon/StaticResources/master/APIJSON_Auto_get.jpg) +![](https://oscimg.oschina.net/oscnet/up-637193bbd89b41c3264827786319e842aee.JPEG) -![](https://raw.githubusercontent.com/TommyLemon/StaticResources/master/APIJSON_Auto_code.jpg) +

+ APIAuto: auto save test records, auto generate API doc, requests shortcut, easily replay +

- -##

2.Server-side deployment

- -You can use either Eclipse for JavaEE or IntelllJ IDEA Ultimate to make installation. For both, first download the project and save it to a path. - -###

2.1 Installing with Eclipse

- -####

2.1.1 prerequisites

- -Java Development Kit(JDK): 1.8 or above -[MAVEN](https://maven.apache.org/download.cgi): 3.0 or above -Mysql / Oracle -[Eclipse Java EE IDE](https://www.eclipse.org/downloads/)for Web Developers.Version: Mars.1 Release (4.5.1) - -####

2.1.2 Opening the project with Eclipse

- -Open Eclipse> *File > Import > Maven > Existing Maven Projects > Next > Browse > Select the path of the project you saved / APIJSON-Java-Server / APIJSONBoot > check pom.xml...apijson-demo > Finish* - -####

2.1.3 Preparing the library used in demo

- -In the menu at the right, click libs, right click apijson-orm.jar,click add as library. Apply the same to the rest *.jar* files in libs. - -####

2.1.4 Configuration

- -Open apijson.demo.server.DemoSQLConfig. In line 40-61, change return values of `getDBUri`,`getDBAccount`,`getDBPassword`,`getSchema` to your own database.
- -

-@Override
-	public String getDBUri() {
-		//TODO: Change the return value to your own
-		return DATABASE_POSTGRESQL.equalsIgnoreCase(getDatabase()) ? "jdbc:postgresql://localhost:5432/postgres" : "jdbc:mysql://192.168.71.146:3306/";
-	}
-	@Override
-	public String getDBAccount() {
-    //TODO: Change the return value to your own
-		return DATABASE_POSTGRESQL.equalsIgnoreCase(getDatabase()) ? "postgres" : "root";
-	}
-	@Override
-	public String getDBPassword() {
-  	//TODO: Change the return value to your own
-		return DATABASE_POSTGRESQL.equalsIgnoreCase(getDatabase()) ? null : "root"; 
-	}
-	@Override
-	public String getSchema() {
-		String s = super.getSchema();
-		return StringUtil.isEmpty(s, true) ? "thea" : s; //TODO: Change the return value to your own. For here,change "thea" to "your database's name"
-	}
-
- -**Note**: Instead of this step, you can also [import your database](#2.2). - -####

2.1.5 Running the application

- -In Eclipse, in the menu on the top, click *Run>Run As>Java Application>choose APIJSONApplication>OK* - -###

2.2 Import MySQL table files

- -This Server project needs [MySQL Server](https://dev.mysql.com/downloads/mysql/) and [MySQLWorkbench](https://www.mysql.com/products/workbench/). Please make sure that both of them are installed.
- -My config is Windows 7 + MySQL Community Server 5.7.16 + MySQLWorkbench 6.3.7 and OSX EI Capitan + MySQL Community Server 5.7.16 + MySQLWorkbench 6.3.8. Systems and softwares are all 64 bit. - -Start *MySQLWorkbench > Enter a connection > Click Server menu > Data Import > Select the path of your .sql file > Start Import > Refresh SCHEMAS*. Now you should see tables are added successfully. - -###

2.3 Installing with IntellIJ IDEA Ultimate

- -####

2.3.1 Opening the project

- -*Open > Select the path of the project/APIJSON-Java-Server/APIJSONBoot > OK* - -####

2.3.2 Preparing the library used in demo

- -In libs, right-click *apijson-orm.jar >Add as Library>OK*. Apply this to all *.jar* files in libs. - -####

2.3.3 Running the application

- -In the menu on the top: *Run > Run > Edit Configurations > + > Application > Configuration*
-In *Main class* , choose *APIJSONApplication*;
-In *Use classpath of module* , choose *apijson-demo*.
-Click *Run* in the bottom. - -**Note**: After running, you should see APIJSON test logs and in the last, it would show ‘APIJSON已启动’. If it shows ‘address already in use’, that means port 8080 has been used . You need tochange the port. See [how to change ports for a Spring Boot Application.](https://stackoverflow.com/questions/21083170/how-to-configure-port-for-a-spring-boot-application) +![](https://oscimg.oschina.net/oscnet/up-7dcb4ae71bd3892a909e4ffa37ba7c1d92a.JPEG)
+

+ APIAuto: auto regression test without code, annotation, comment, etc.) +

-##

3. Client-side deployment

- -###

3.1 For Android

- -Make sure you have either [ADT Bundle](https://stuff.mit.edu/afs/sipb/project/android/docs/sdk/installing/bundle.html) or [Android Studio](https://developer.android.com/studio) installed.
+![](https://oscimg.oschina.net/oscnet/up-c1ba774f8e7fcc5adcdb05cad5bd414d766.JPEG) -My config: Windows 7 + JDK 1.7.0_71 + ADT Bundle 20140702 + Android Studio 2.2 and OSX EI Capitan + (JDK 1.7.0_71 + ADT Bundle 20140702) + (JDK 1.8.0_91 + Android Studio 2.1.2). All the systems and software are 64 bit.
+
+

+ A picture is worth a thousand words - some basic features show for APIJSON +

-* 1.Importing
-*Open an existing Android Studio project > Select the path of APIJSON-Master/APIJSON-Android/APIJSONApp(or APIJSONTest） > OK* +![](https://oscimg.oschina.net/oscnet/up-e21240ef3770326ee6015e052226d0da184.JPEG) +![](https://raw.githubusercontent.com/TommyLemon/StaticResources/master/APIJSON/APIJSON_query_summary.gif) -* 2.Running
-*Run > Run app* -* 3.Testing
-In the browser, send a request to the server. It should return with the result. -If the default url is not available, change it to an available one, such as an IPV4 address that is running the server of the APIJSON project. Then click the request button again. +##

2.Backend usage

+You can skip this step and use 'apijson.cn:8080'.
+See https://github.com/APIJSON/APIJSON-Demo/blob/master/APIJSON-Java-Server/README-English.md -###

3.2 For iOS

- -Open xCode, then *APIJSON-Master/APIJSON-iOS/APIJSON-Swift > Open*
+
-In xCode, *Product > Run* +##

3. Frontend usage

+You can skip this step and use [APIAuto](https://github.com/TommyLemon/APIAuto) or download App.
+See [Android](https://github.com/APIJSON/APIJSON-Demo/blob/master/APIJSON-Android/README-English.md), [iOS](https://github.com/APIJSON/APIJSON-Demo/blob/master/APIJSON-iOS/README-English.md) or [JavaScript](https://github.com/APIJSON/APIJSON-Demo/blob/master/APIJSON-JavaScript/README-English.md)
-###

3.3 For Javascript

+### Download App -You can use either an IDE or text editor like sublime, Atom, etc. Webstorm is recommended.
-While using a text editor, you just open the .html file in the APIJSON-JS folder.
-You can also open it with Vue javascript framework. Click [here](https://vuejs.org/) to learn more. +Simple demo App for testing APIJSON
+[APIJSONTest.apk](http://files.cnblogs.com/files/tommylemon/APIJSONTest.apk) + +Complex production App like Twitter tweets
+[APIJSONApp.apk](http://files.cnblogs.com/files/tommylemon/APIJSONApp.apk) +
+ ##

4. Contributing

-We are always looking for more developers to help implementing new features, fix bugs, etc. Please have a look at the [open issues](https://github.com/Tencent/APIJSON/issues) before opening a new one.
+We are always looking for more developers to help implementing new features, fix bugs, etc.
+Please have a look at the [open issues](https://github.com/Tencent/APIJSON/issues) before opening a new one.
Fork the project and send a pull request.
Please also ⭐Star the project!
-##

5. Versioning

+##

5. Releases

-See the latest version [here](https://github.com/Tencent/APIJSON/commits/master). +See the latest release [here](https://github.com/Tencent/APIJSON/releases/tag/5.2.0).
-##

6. Auhtor

+##

6. Author

Check out the author's [github account](https://github.com/TommyLemon) to see more related projects.
+image If you have any questions or suggestions, you can [create an issue](https://github.com/Tencent/APIJSON/issues) or [send me an e-mail](mailto:tommylemon@qq.com).

-### Users of this project: +### Users of APIJSON: +https://github.com/Tencent/APIJSON/issues/187
- - - - - - - - - - - -
+ + +
+ + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ [More APIJSON Users](https://github.com/Tencent/APIJSON/issues/73) ### Contributers of APIJSON: -Here are the contributers of this project and authors of other projects for ecosystem of APIJSON: +Contributers for the APIJSON core project(6 Tencent engineers, 1 Microsoft engineer, 1 Zhihu architect, 1 Bytedance(TikTok) engineer, 1 NetEase engineer, 1 Zoom engineer, 1 YTO Express engineer, 1 Zhilian engineer, 1 UC student、3 SUSTech students, etc.):
+https://github.com/Tencent/APIJSON/blob/master/CONTRIBUTING.md
- - - - - - - - - - - - -
+ height="54" width="54" > + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ +Authors of other projects for ecosystem of APIJSON(2 Tencent engineers, 1 BAT(Baidu/Alibaba/Tencent) specialist, 1 Microsoft engineer, 2 Bytedance(TikTok) engineers, 1 Digital China engineer & Apache dubbo2js author, etc.):
+https://github.com/search?o=desc&q=apijson&s=stars&type=Repositories
+https://search.gitee.com/?skin=rec&type=repository&q=apijson&sort=stars_count
+
+ - + height="54" width="54" > + + + + height="54" width="54" > - + height="54" width="54" > + - + height="54" width="54" > + + + + + + + + + - - + height="54" width="54" > + + + + + + + + + + + + + + + +

+ Thanks to all contributers of APIJSON! +
+ +### Statistics +Hundreds of employees from big famous companies(Tencent, Google, Apple, Microsoft, Amazon, Huawei, Alibaba, Paypal, Meituan, Bytedance(TikTok), IBM, Baidu, JD, NetEase, Kuaishou, Shopee, etc.) starred,
+a lot of employees from big famous companies(Tencent, Huawei, Microsoft, Zoom, etc.) created PR/Issue, thank you all~
+[![Stargazers over time](https://starchart.cc/Tencent/APIJSON.svg)](https://starchart.cc/Tencent/APIJSON) +image +image +image + +
diff --git a/README-extend.md b/README-extend.md new file mode 100644 index 000000000..98b60ac2c --- /dev/null +++ b/README-extend.md @@ -0,0 +1,931 @@ +# 功能点 + +### 一个json(事务)同时支持新增、修改、删除、查询、别名 + +https://github.com/Tencent/APIJSON/issues/468 + +#### 使用说明 + +json 支持多种方式定义 method + +#### 第一种: + +"@post","@put","@delete","@head","@get","@gets","@head","@heads" + +"@post": "Moment,Comment[]" , 值为 String 或 JSONObject 格式, 为 String 时每个 value = key，为 JSONObject 时： +```json +"@post": { + "Moment": "Moment", // 只指定 tag，为 "" 则和 key 一致 + "Comment[]": { // 同时指定多个全局关键词 + "tag": "Comment[]", + "version": 2 + // 其它全局关键词 + } +} +``` + +需要保证每个key唯一, 唯一判断标准: + +key = Moment + +key= Moment[] + +会判断为相同key. 请通过别名区分, 别名格式: Sys_user_role:sur xxx表名:别名 + +``` +{ + "@post": "Moment,Comment:cArray[],User:u", // 分发到 POST 请求对应的解析处理 + "Moment": { + // TODO 其它字段 + }, + "Comment:cArray[]": [ + { + // TODO 其它字段 + } + ], + "@get": "User", // 分发到 GET 请求对应的解析处理 + "User:u": { + // TODO 其它字段 + }, + "Privacy": { // 按 URL 对应的默认方法处理 + // TODO 其它字段 + } +} + +对于没有显式声明操作方法的，直接用 URL(/get, /post 等) 对应的默认操作方法 + +``` + +#### 第二种: @Deprecated 即将弃用，请使用第一种 + +对象内定义"@method": "GET", value大写 + +``` +{ + "sql@": { + "@method": "GET", + "with": true, + "from": "Sys_role", + "Sys_role": { + "@column": "id", + "role_name": "角色1" + } + }, + "Sys_user_role:sur[]": { + "@method": "GET", + "Sys_user_role": { + "role_id{}@": "sql" + } + }, + "Sys_role_permission:srp[]": { + "@method": "GET", + "Sys_role_permission": { + "role_id{}@": "sql" + } + }, + "@explain": true +} +``` + +#### 解析顺序 + +1) 对象内 "@method" +2) "@post","@put","@delete" +3) 对于没有显式声明操作方法的，直接用 URL(/get, /post 等) 对应的默认操作方法 + +#### tag自动生成规则 + +/** + * { "xxx:aa":{ "@tag": "" }} + * 生成规则: + * 1、@tag存在,tag=@tag + * 2、@tag不存在 + * 1)、存在别名 + * key=对象: tag=key去除别名 + * key=数组: tag=key去除别名 + [] + * 2)、不存在别名 + * tag=key + * tag=key + [] + */ + + +![image](https://user-images.githubusercontent.com/12228225/204079184-06dd08a7-95a3-4a46-8e05-f062fa406847.png) + + +#### 建议 + +1. 一个json包含不同操作方法, url method 使用 /post, /put +2. value为JSONArray, 建议通过"@post" 方式配置, 如果没有配置,执行 3 + +#### Request表 配置说明 + +这只是我的配置仅供参考, 后续 测试会用到: + +``` +单条新增: +POST User_address {"MUST":"addr","UPDATE": {"@role": "OWNER,ADMIN","childFunTest-()": "childFunTest(addr)"}, "REFUSE": "id"} +批量新增: +POST User_address[] {"User_address[]": [{"MUST":"addr","REFUSE": "id"}], "UPDATE": {"@role": "OWNER,ADMIN","childFunTest-()": "childFunTest(addr)"}} +单条修改: +PUT User_address {"User_address":{ "MUST":"id","REFUSE": "userId", "UPDATE": {"@role": "OWNER,ADMIN","childFunTest-()": "childFunTest(addr)"}} } +批量修改: +PUT User_address[] {"User_address[]": [{"MUST": "id","REFUSE": "userId"}], "UPDATE": {"@role": "OWNER,ADMIN"}} +删除: +DELETE User_address {"User_address":{ "MUST":"id{}","REFUSE": "!", "INSERT": {"@role": "OWNER,ADMIN"}} } + +``` +![image](https://user-images.githubusercontent.com/12228225/204079438-8f352496-4b73-4b72-88c0-914894335074.png) + + + +### 别名 + +格式: + +Sys_user_role:sur xxx表名:别名 + +Comment:cArray[] + +#### 实现思路 + +当时参考了作者的示例: 注册流程. 看到绕过校验, 可以将多条json语句组装在一起, 批量执行. 于是就想如何实现一个json支持不同操作方法,并支持事物. + +通过分析源码, 熟悉了校验流程、json解析执行流程、json解析生成sql语句流程、一些兼容、校验规则等 + +经过和作者讨论, 很感谢作者提供了相关解决方案和思路. 逐步理解了apijson的设计原理和框架结构. + +一个json(事务)同时支持新增、修改、删除、查询、别名, 实现思路如下: + +1、校验模块 + +将json解析成对象、临时变量、子查询、别名、tag等 + +并将method 添加到 json对象属性中. + +```json +"Sys_role": { + "@method": "PUT", + "id": "6aedce0d-2a29-4fbe-aeed-0ba935ca6b41", + "id{}@": "sql", + "role_code": "code-subrange-4", + "role_name": "角色-subrange-4" +} +``` + +2、对象解析 + +用对象属性@method , 替换 Parser 的 method + +3、事物支持 + +### 后续优化建议 + +1、独立定义一个url method, 通过解析不同method执行不同流程 + +和已有method区分开,避免歧义 + +2、最外层新增传参 "transaction": true 来指定开启事务 +目前是url put、post来控制开启事物, 以及提交的时候 在 AbstractParser onCommit 判断 transactionIsolation (4 : 开启事物, 0: 非事物请求) + +![image](https://user-images.githubusercontent.com/12228225/204079532-26d9cd4b-d2d7-4c73-9f78-f425bbbcf623.png) + +详细实现请参见: https://github.com/Tencent/APIJSON/issues/468 + +3、完善 "[@Explain](https://github.com/Explain)" + +如果没有执行计划,则返回sql语句. 能够在 reponse返回值中, 看到json中执行的每条sql,方便排错 + +![image](https://user-images.githubusercontent.com/12228225/204079543-be464f67-a80f-4a33-87ea-d1870908e642.png) + +4、@version支持 + +定义不同场景的 新增、修改、删除等执行规则. 请通过version版本区分 + +Request表是通过tag、method、version来保证唯一. + +![image](https://user-images.githubusercontent.com/12228225/204079562-00449c38-42b1-4d9c-b562-2d56c77e6218.png) + +5、前置函数 + +前置函数能够将json语句, 加入到 当前事物中. + +例如: 像数组一样,解析成每一条语句去执行. + +### mysql8 with-as表达式 + +#### 前提条件 + +1、mysql版本: 8+ + +2、mysql-connector-java: 8.0.31 + +版本支持 with-as即可 + +3、druid: 1.2.15 + +版本支持 with-as即可 + +4、去掉 durid wall配置 + +delete子查询, druid wall 拦截器报错 sql injection violation + +![image](https://user-images.githubusercontent.com/12228225/204079572-19a4f50c-3bf3-4f9e-9677-6aa191276fef.png) + +#### 测试案例 + +#### 查询单个range ref引用 + +``` +// 测试 mysql8 with as表达式 +// 用户表 +// 用户角色表 +// 角色表 +// 示例一 单个range ref引用 +{ + "sql@": { + "@method": "GET", + "with": true, + "from": "Sys_role", + "Sys_role": { + "@column": "id", + "role_name": "角色1" + } + }, + "Sys_user_role:sur[]": { + "@method": "GET", + "Sys_user_role": { + "role_id{}@": "sql" + } + }, + "Sys_role_permission:srp[]": { + "@method": "GET", + "Sys_role_permission": { + "role_id{}@": "sql" + } + }, + "@explain": true +} + +// 第二种写法 +{ + "@get": ["sql@","Sys_user_role:sur[]","Sys_role_permission:srp[]"], + "sql@": { + "with": true, + "from": "Sys_role", + "Sys_role": { + "@column": "id", + "role_name": "角色1" + } + }, + "Sys_user_role:sur[]": { + "Sys_user_role": { + "role_id{}@": "sql" + } + }, + "Sys_role_permission:srp[]": { + "Sys_role_permission": { + "role_id{}@": "sql" + } + }, + "@explain": true +} +``` + +mysql8执行结果: + +![image](https://user-images.githubusercontent.com/12228225/204079581-bf835db2-30ae-4265-bda2-ebf34c0d9e77.png) + +mysql5.7执行结果: + +![image](https://user-images.githubusercontent.com/12228225/204079594-3ebc73a0-836e-4073-9aa4-acb665fe8d52.png) + + +#### 查询多个range ref引用 + +``` +{ + "sql@": { + "@method": "GET", + "with": true, + "from": "Sys_role", + "Sys_role": { + "@column": "id", + "role_name": "角色1" + } + }, + "sql_user@": { + "@method": "GET", + "with": true, + "from": "Sys_user", + "Sys_user": { + "@column": "id", + "id": "f0894db2-6940-4d89-a5b2-4405d0ad0c8f" + } + }, + "Sys_user_role:sur[]": { + "@method": "GET", + "Sys_user_role": { + "role_id{}@": "sql", + "user_id{}@": "sql_user" + } + }, + "Sys_role_permission:srp[]": { + "@method": "GET", + "Sys_role_permission": { + "role_id{}@": "sql" + } + }, + "@explain": true +} +``` + +mysql8执行结果: + +![image](https://user-images.githubusercontent.com/12228225/204079603-2ba224a3-3174-491a-a71b-7656c97d0146.png) + +mysql5.7执行结果: + +![image](https://user-images.githubusercontent.com/12228225/204079611-155f6a33-ad56-4d03-8e5d-6f44c3649051.png) + +#### delete子查询 + +```j s +{ + "sql@": { + "@method": "GET", + "with": true, + "from": "Sys_role_permission", + "Sys_role_permission": { + "@column": "id", + "role_id{}": ["e7129d5f-b07e-4996-9965-9528e370a393"] + } + }, + "Sys_role_permission": { + "@method": "DELETE", + "id{}@": "sql" + }, + "explan": true +} + +``` + +![image](https://user-images.githubusercontent.com/12228225/204079615-25185be5-a296-488f-9a13-98fb2b99a9d5.png) + +mysql8执行sql语句: + +``` +WITH `sql` AS (SELECT `id` FROM `housekeeping`.`Sys_role_permission` WHERE ( (`role_id` IN ('68877ee9-4cf4-4f32-86e6-16c505ca3b21')) ) ) DELETE FROM `housekeeping`.`Sys_role_permission` WHERE ( (`id` IN ( SELECT * FROM `sql`) ) ) + +Plain Text +``` + +mysql5.7执行结果: + +``` +DELETE FROM `housekeeping`.`Sys_role_permission` WHERE ( (`id` IN ( SELECT * FROM (SELECT `id` FROM `housekeeping`.`Sys_role_permission` WHERE ( (`role_id` IN ('20d337bb-9886-455f-8dce-f1cadab0ec4f')) ) ) AS `sql`) ) ) + + + +Plain Text +``` + +#### update子查询 + +``` +{ + "sql@": { + "@method": "GET", + "with": true, + "from": "Sys_role_permission", + "Sys_role_permission": { + "@column": "role_id", + "id{}": ["6aedce0d-2a29-4fbe-aeed-0ba935ca6b41"] + } + }, + "Sys_role": { + "@method": "PUT", + "id": "6aedce0d-2a29-4fbe-aeed-0ba935ca6b41", + "id{}@": "sql", + "role_code": "code-subrange-4", + "role_name": "角色-subrange-4" + }, + "@explain": true +} + +第二种写法 +{ + "@get": ["sql@"], + "sql@": { + "with": true, + "from": "Sys_role_permission", + "Sys_role_permission": { + "@column": "role_id", + "id{}": ["c95ef2d6-bf14-42b0-bb87-038cee8c78f1"] + } + }, + "@put": ["Sys_role"], + "Sys_role": { + "id": "0bb92d96-8ca6-469e-91e8-60308ce5b835", + "id{}@": "sql", + "role_code": "code-subrange-4", + "role_name": "角色-subrange-4" + }, + "@explain": true +} +``` + +mysql8执行sql语句: + +![image](https://user-images.githubusercontent.com/12228225/204079628-8536b4be-8078-42a5-b3f7-460159372a8a.png) + + +mysql5.7执行结果: + +![image](https://user-images.githubusercontent.com/12228225/204079633-df9175bc-703f-4997-95f6-85bbc1134b0b.png) + +#### GETS 单条子查询 + +会执行校验流程 + +``` +http://localhost:8675/lowCodePlatform/forms/api/gets + +{ + "sql@": { + "with": true, + "from": "Sys_user_role", + "Sys_user_role": { + "@column": "role_id", + "user_id": "4732209c-5785-4827-b532-5092f154fd94" + } + }, + "Sys_role[]": { + "Sys_role": { + "id{}@": "sql" + }, + "page": 0, + "count": 10, + "query": 2 + }, + "tag":"Sys_role[]", + "total@": "/Sys_role[]/total", + "@explain": true +} + +第二种写法 +{ + "@gets": ["sql@","Sys_role[]"], + "sql@": { + "with": true, + "from": "Sys_user_role", + "Sys_user_role": { + "@column": "role_id", + "user_id": "4732209c-5785-4827-b532-5092f154fd94" + } + }, + "Sys_role[]": { + "Sys_role": { + "id{}@": "sql" + }, + "page": 0, + "count": 10, + "query": 2 + }, + "tag":"Sys_role[]", + "total@": "/Sys_role[]/total", + "@explain": true +} + +``` + +Access、Request需要配置鉴权信息: + +![image](https://user-images.githubusercontent.com/12228225/204079649-510a047b-2b8e-44d2-a32a-f6ea0e7f6a74.png) + + +mysql8执行sql语句: + +![image](https://user-images.githubusercontent.com/12228225/204079657-6e62872a-2f29-478e-a29b-bcb0a92781a6.png) + +mysql5.7执行结果: + +![image](https://user-images.githubusercontent.com/12228225/204079878-a9885b86-5a44-4ba2-b837-66adc43b07d3.png) + +#### GETS多条子查询 + +会执行校验流程 + +``` +http://localhost:8675/lowCodePlatform/forms/api/gets + +{ + "sql@": { + "@method": "GETS", + "with": true, + "from": "Sys_role", + "Sys_role": { + "@column": "id", + "role_name": "超级管理员" + } + }, + "sql_user@": { + "@method": "GETS", + "with": true, + "from": "Sys_user", + "Sys_user": { + "@column": "id", + "id": "4732209c-5785-4827-b532-5092f154fd94" + } + }, + "Sys_user_role:sur[]": { + "@method": "GETS", + "Sys_user_role": { + "role_id{}@": "sql", + "user_id{}@": "sql_user" + } + }, + "Sys_role_permission:srp[]": { + "@method": "GETS", + "Sys_role_permission": { + "role_id{}@": "sql" + } + }, + "@explain": true +} + +``` + +mysql8执行sql语句: + +![image](https://user-images.githubusercontent.com/12228225/204079892-bc71eb65-cfbd-4c3c-bda9-4b31902058ba.png) + +mysql5.7执行结果: + +![image](https://user-images.githubusercontent.com/12228225/204079897-521a763f-bb08-44af-92c6-5e4117fe9d33.png) + +#### head 单个子查询 + +普通获取数量, get/head不执行校验流程 + +``` +http://localhost:8675/lowCodePlatform/forms/api/head +{ + "sql@": { + "@method": "GET", + "with": true, + "from": "Sys_user_role", + "Sys_user_role": { + "@column": "role_id", + "user_id": "4732209c-5785-4827-b532-5092f154fd94" + } + }, + "Sys_role": { + "@method": "head", + "id{}@": "sql" + }, + "@explain": true +} + +``` + +mysql8执行sql语句: + +![image](https://user-images.githubusercontent.com/12228225/204079903-e397a78a-1849-4678-ac41-0611165a1de1.png) + +mysql5.7执行结果: + +![image](https://user-images.githubusercontent.com/12228225/204079908-1efb5b28-889d-4d9b-b4f9-5092925888c9.png) + +#### head 多个子查询 + +普通获取数量, get/head不执行校验流程 + +``` +{ + "sql@": { + "@method": "GET", + "with": true, + "from": "Sys_role", + "Sys_role": { + "@column": "id", + "role_name": "超级管理员" + } + }, + "sql_user@": { + "@method": "GET", + "with": true, + "from": "Sys_user", + "Sys_user": { + "@column": "id", + "id": "4732209c-5785-4827-b532-5092f154fd94" + } + }, + "Sys_user_role": { + "@method": "HEAD", + "role_id{}@": "sql", + "user_id{}@": "sql_user" + }, + "Sys_role_permission": { + "@method": "HEAD", + "role_id{}@": "sql" + }, + "@explain": true +} + +``` + +mysql8执行sql语句: + +![image](https://user-images.githubusercontent.com/12228225/204079919-5fba8f87-56d8-4d7d-b457-4a2505f27d1e.png) + +mysql5.7执行结果: + +![image](https://user-images.githubusercontent.com/12228225/204079932-1e040caf-57fd-45a7-afa5-b26bdce83fba.png) + +#### heads 单个子查询 + +普通获取数量 + +会执行校验流程, Access、Request需要配置鉴权信息: +![image](https://user-images.githubusercontent.com/12228225/204079942-d790a3c0-eb46-4512-bb58-45a16894608a.png) + +``` +http://localhost:8675/lowCodePlatform/forms/api/heads + +{ + "sql@": { + "@method": "GET", + "with": true, + "from": "Sys_user_role", + "Sys_user_role": { + "@column": "role_id", + "user_id": "4732209c-5785-4827-b532-5092f154fd94" + } + }, + "Sys_role": { + "@method": "heads", + "id{}@": "sql" + }, + "@explain": true +} + +``` + +mysql8执行sql语句: + +![image](https://user-images.githubusercontent.com/12228225/204079952-976fa9b6-4a11-40ad-a2c7-6f901b186670.png) + +mysql5.7执行结果: + +![image](https://user-images.githubusercontent.com/12228225/204079959-6bf95b45-5f35-474e-b428-b51bcb5b500d.png) + +#### heads 多个子查询 + +会执行校验流程, Access、Request需要配置鉴权信息: + +![image](https://user-images.githubusercontent.com/12228225/204079967-a48f4f50-6e6b-476b-a281-b072ef8a352d.png) + +普通获取数量 + +``` +{ + "sql@": { + "@method": "GET", + "with": true, + "from": "Sys_role", + "Sys_role": { + "@column": "id", + "role_name": "超级管理员" + } + }, + "sql_user@": { + "@method": "GET", + "with": true, + "from": "Sys_user", + "Sys_user": { + "@column": "id", + "id": "4732209c-5785-4827-b532-5092f154fd94" + } + }, + "Sys_user_role": { + "@method": "HEADS", + "role_id{}@": "sql", + "user_id{}@": "sql_user" + }, + "Sys_role_permission": { + "@method": "HEADS", + "role_id{}@": "sql" + }, + "@explain": true +} + +``` + +mysql8执行sql语句: + +![image](https://user-images.githubusercontent.com/12228225/204079980-c93ef595-0c4b-42a7-a3b3-1e7402d3cb13.png) + +mysql5.7执行结果: + +![image](https://user-images.githubusercontent.com/12228225/204079987-878d5937-3f42-4f59-93dc-b5a840f5548c.png) + +### delete、put 支持子查询 + +https://github.com/Tencent/APIJSON/issues/471 + +静态变量做全局处理，特殊接口用 Operation.MUST id/id{}/id{}@ 做自定义处理。 + +之所以默认必传，是因为安全意识不够、编码粗心大意的人太多了，所以要有一个底线保障，尽可能避免安全隐患。 + +1、全局配置 为 PUT, DELETE 强制要求必须有 id/id{}/id{}@ 条件 + +AbstractVerifier.IS_UPDATE_MUST_HAVE_ID_CONDITION = true; // true: 必须有 + +![image](https://user-images.githubusercontent.com/12228225/204080001-eef4ee65-0ad0-4a41-93ba-9b16cd1c2e0e.png) + +2、细粒度控制 + +![image](https://user-images.githubusercontent.com/12228225/204080012-f7d781e9-0a53-461f-84db-3d6ecb167e20.png) + +#### 使用说明 + +``` +// 条件删除 +```json +{ + "User:del": { + "username": "test3" + }, + "tag": "User", + "explain": true +} +``` + +// 引用id{}@删除 +```json +{ + "sql@": { + "@method": "GET", + "with": true, + "from": "Sys_user_role", + "Sys_user_role": { + "@column": "user_id", + "role_id{}": ["023e1880-c0d4-4e7c-ae6c-7703199c2daf"] + } + }, + "Sys_user:aa": { + "@method": "DELETE", + "id{}@": "sql" + }, + "explan": true +} +``` + +// 子查询条件删除 +http://localhost:8675/lowCodePlatform/forms/api/delete +```json +{ + "sql@": { + "@method": "GET", + "with": true, + "from": "User", + "User": { + "@column": "username", + "username": "test-3" + } + }, + "User": { + "username{}@": "sql" + }, + "explan": true +} +``` + +第二种写法: +```json +{ + "@get": ["sql@"], + "sql@": { + "with": true, + "from": "User", + "User": { + "@column": "username", + "username": "test4" + } + }, + "User": { + "username{}@": "sql" + }, + "explan": true +} +``` + + + +开启id删除, 删除失败: + +```json +{ + "@get": ["sql@"], + "sql@": { + "with": true, + "from": "User", + "User": { + "@column": "username", + "username": "test4" + } + }, + "User": { + "username{}@": "sql" + }, + "explan": true +} +``` + +![image](https://user-images.githubusercontent.com/12228225/204080043-6614457c-a0ed-45b3-a26a-e75126dbb486.png) + +开启id删除、id引用 删除成功 + +```json +{ + "sql@": { + "@method": "GET", + "with": true, + "from": "Sys_user_role", + "Sys_user_role": { + "@column": "user_id", + "role_id{}": ["0bb92d96-8ca6-469e-91e8-60308ce5b835"] + } + }, + "Sys_user:aa": { + "@method": "DELETE", + "id{}@": "sql" + }, + "explan": true +} +``` + +![image](https://user-images.githubusercontent.com/12228225/204080050-e6f04fe6-319e-45b7-b1b2-bf4cda4ab2db.png) + +PUT 子查询 修改 + +```json +{ + "sql@": { + "@method": "GET", + "with": true, + "from": "Sys_role_permission", + "Sys_role_permission": { + "@column": "role_id", + "id{}": ["ba2634f8-0bdc-4b50-9c5e-47786b1536ef"] + } + }, + "Sys_role": { + "@method": "PUT", + "id{}@": "sql", + "role_code": "code-subrange-5", + "role_name": "角色-subrange-5" + }, + "@explain": true +} +``` + +![image](https://user-images.githubusercontent.com/12228225/204080072-8f605595-cd8c-474b-975f-4ac97fb92a26.png) + +#### bug修复 + +删除操作 主表 和 子查询 是同一张表 +mysql8以下 非with-as表达式 会报错: +"msg": "You can't specify target table 'User' for update in FROM clause", + +需要调整sql语句,将子查询包一层(select * from (子查询) as xxx) +DELETE FROM `housekeeping`.`User` +WHERE ( (`username` IN (SELECT * FROM (SELECT `username` FROM `housekeeping`.`User` WHERE ( (`username` = 'test1') )) as a) ) ) + +![image](https://user-images.githubusercontent.com/12228225/204080126-e1f7c82a-2f09-409d-b3f2-fe25badea180.png) + +![image](https://user-images.githubusercontent.com/12228225/204080131-0c15404d-3045-4d01-bd89-d2a1f1fa0360.png) + + +### must、refuses判断、delete、PUT支持 ref + +```json +{ + "sql@": { + "@method": "GET", + "with": true, + "from": "Sys_role_permission", + "Sys_role_permission": { + "@column": "id", + "role_id{}": ["94f79f0b-331b-4cc5-bfc0-ebfc47d00f13"] + } + }, + "Sys_role_permission": { + "@method": "DELETE", + "id{}@": "sql" + }, + "explan": true +} +``` + +![image](https://user-images.githubusercontent.com/12228225/204080150-28972226-37e0-4280-962a-83f7ac12d37c.png) diff --git a/README.md b/README.md index 73b68f069..281462b98 100644 --- a/README.md +++ b/README.md @@ -1,38 +1,77 @@ Tencent is pleased to support the open source community by making APIJSON available.
-Copyright (C) 2020 THL A29 Limited, a Tencent company. All rights reserved.
+Copyright (C) 2020 Tencent. All rights reserved.
This source code is licensed under the Apache License Version 2.0
-

APIJSON

- -

🏆 码云最有价值开源项目
🚀 后端接口和文档自动化，前端(客户端) 定制返回JSON的数据和结构！

+ +

🏆 实时 零代码、全功能、强安全 ORM 库 🚀
后端接口和文档零代码，前端(客户端) 定制返回 JSON 的数据和结构

+

+ English + 通用文档 + 视频教程 + 测试用例 + AI 问答 +

-   -   + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

-   -   -   + + + + + +

- -   -   + + + + +

- English -  通用文档 - 视频教程 - 在线体验 + + +

@@ -45,35 +84,30 @@ This source code is licensed under the Apache License Version 2.0
APIJSON 是一种专为 API 而生的 JSON 网络传输协议 以及 基于这套协议实现的 ORM 库。
-为 简单的增删改查、复杂的查询、简单的事务操作 提供了完全自动化的万能 API。
+为各种增删改查提供了完全自动化的万能通用接口，零代码实时满足千变万化的各种新增和变更需求。
能大幅降低开发和沟通成本，简化开发流程，缩短开发周期。
-适合中小型前后端分离的项目，尤其是 BaaS、Serverless、互联网创业项目和企业自用项目。
- -通过万能的 API，前端可以定制任何数据、任何结构！
-大部分 HTTP 请求后端再也不用写接口了，更不用写文档了！
-前端再也不用和后端沟通接口或文档问题了！再也不会被文档各种错误坑了！
-后端再也不用为了兼容旧接口写新版接口和文档了！再也不会被前端随时随地没完没了地烦了！ - -

- -

+适合中小型前后端分离的项目，尤其是 创业项目、内部项目、低代码/零代码、小程序、BaaS、Serverless 等。
+通过万能通用接口，前端可以定制任何数据、任何结构。
+大部分 HTTP 请求后端再也不用写接口了，更不用写文档了。
+前端再也不用和后端沟通接口或文档问题了。再也不会被文档各种错误坑了。
+后端再也不用为了兼容旧接口写新版接口和文档了。再也不会被前端随时随地没完没了地烦了。 ### 特点功能 +#### 对于后端 +* 提供万能通用接口，大部分 HTTP API 不用再写 +* 零代码增删改查、各种跨库连表、JOIN 嵌套子查询等 +* 自动生成文档，不用再编写和维护，且自动静态检查 +* 自动校验权限、自动管理版本、自动防 SQL 注入 +* 开放 HTTP API 无需划分版本，始终保持兼容 + #### 对于前端 * 不用再向后端催接口、求文档 * 数据和结构完全定制，要啥有啥 * 看请求知结果，所求即所得 * 可一次获取任何数据、任何结构 -* 能去除重复数据，节省流量提高速度 - -#### 对于后端 -* 提供通用接口，大部分 API 不用再写 -* 自动生成文档，不用再编写和维护 -* 自动校验权限、自动管理版本、自动防 SQL 注入 -* 开放 API 无需划分版本，始终保持兼容 -* 支持增删改查、模糊搜索、正则匹配、远程函数等 +* 能去除多余数据，节省流量提高速度
@@ -83,7 +117,7 @@ APIJSON 是一种专为 API 而生的 JSON 网络传输协议 以及 基于这
#### APIAuto 展示 APIJSON -使用 APIAuto-机器学习接口工具 来管理和测试 HTTP API 可大幅提升接口联调效率
+**使用 APIAuto-机器学习接口工具 来管理和测试 HTTP API 可大幅 减少传参错误、提升联调效率**
(注意网页工具界面是 APIAuto，里面的 URL+JSON 才是 APIJSON 的 HTTP API)：

@@ -91,6 +125,7 @@ APIJSON 是一种专为 API 而生的 JSON 网络传输协议 以及 基于这

![](https://oscimg.oschina.net/oscnet/up-bbbec4fc5edc472be127c02a4f3cd8f4ec2.JPEG) +![](https://raw.githubusercontent.com/TommyLemon/StaticResources/master/APIJSON/APIJSON_query_associate.gif)

@@ -119,6 +154,8 @@ APIJSON 是一种专为 API 而生的 JSON 网络传输协议 以及 基于这

![](https://oscimg.oschina.net/oscnet/up-e21240ef3770326ee6015e052226d0da184.JPEG) +![](https://raw.githubusercontent.com/TommyLemon/StaticResources/master/APIJSON/APIJSON_query_summary.gif) +

@@ -132,13 +169,19 @@ APIJSON 是一种专为 API 而生的 JSON 网络传输协议 以及 基于这
### APIJSON 分享演讲 -https://github.com/TommyLemon/StaticResources/tree/master/APIJSON/Share/GiteeGVPMeetup2020
-https://my.oschina.net/u/4570368/blog/4818203
-https://my.oschina.net/gitosc/blog/4864607
- -
-演讲录播视频 -https://www.bilibili.com/video/BV1Tv411t74v?p=4 +#### APIJSON-零代码接口与文档 ORM 库（国际开源谷 Gitee Meetup） + +https://www.bilibili.com/video/BV1Tv411t74v + +![image](http://apijson.cn/images/comparison/APIJSON_vs_PreviousWays.jpg) + + +#### APIJSON 和 APIAuto-零代码开发和测试（QECon 全球软件质量&效能大会） + +https://www.bilibili.com/video/BV1yv411p7Y4 + +wecom-temp-377bbd0daf5aed716baf7ebcb003d94c +
@@ -146,23 +189,58 @@ https://www.bilibili.com/video/BV1Tv411t74v?p=4 前后端 关于接口的 开发、文档、联调 等 10 大痛点解析
https://github.com/Tencent/APIJSON/wiki -* **解决十大痛点** (APIJSON 大幅提振开发效率、强力杜绝联调扯皮、巧妙规避文档缺陷、非常节省流量带宽 等) -* **开发提速巨大** (CRUD 零代码热更新自动化，APIJSONBoot 对比 SSM、SSH 等保守估计可提速 20 倍以上) -* **腾讯官方开源** (使用 GitHub、Gitee、工蜂 等平台的官方账号开源，微信公众号、腾讯云+社区 等官方公告) -* **社区影响力大** (GitHub 9.6K Star 在 350W Java 项目中排名前 150，远超 FLAG, BAT 等国内外绝大部分开源项目) -* **各项荣誉成就** (腾讯开源五个第一、腾讯首个 GVP 获奖项目、腾讯后端项目 Star 第一、GitHub Java 周榜第一 等) -* **多样用户案例** (腾讯内部用户包含 互娱、音乐、云与智慧，外部用户包含 500 强上市公司、数千亿资本国企 等) -* **适用场景广泛** (社交聊天、阅读资讯、影音视频、办公学习 等各种 App、网站、公众号、小程序 等非金融类项目) +* **解决十大痛点** (可帮前后端开发大幅提振开发效率、强力杜绝联调扯皮、巧妙规避文档缺陷、非常节省流量带宽) +* **开发提速很大** (CRUD 零代码热更新全自动，APIJSONBoot 对比 SSM、SSH 等保守估计可提速 20 倍以上) +* **腾讯官方开源** (使用 GitHub、Gitee、工蜂 等平台的官方账号开源，微信公众号、腾讯云+社区 等官方公告) +* **社区影响力大** (GitHub 18K+ Star 在 400W Java 项目排名前 100，远超 FLAG, BAT 等国内外绝大部分开源项目) +* **各项荣誉成就** (腾讯内外 5 个奖项、腾讯开源前五、腾讯后端 Star 第一、Trending 日周月榜大满贯 等) +* **多样用户案例** (腾讯内有互娱、音乐、微信、云与智慧，外部有华为、华能、百度、快手、中兴、圆通、传音等) +* **适用场景广泛** (社交聊天、阅读资讯、影音娱乐、办公学习 等各种 App、网站、小程序、公众号 等非金融类项目) * **周边生态丰富** (Android, iOS, Web 等各种 Demo、继承 JSON 的海量生态、零代码 接口测试 和 单元测试 工具等) -* **文档视频齐全** (项目介绍、快速上手、安装部署 等后端、前端、客户端的 图文解说、视频教程、代码注释 等) -* **功能丰富强大** (增删改查、分页排序、分组聚合、各种 JOIN、各种子查询、跨库跨表、性能分析 等零代码实现) -* **使用安全简单** (自动增删改查、自动生成文档、自动管理版本、自动控制权限、自动校验参数、自动防SQL注入等) -* **灵活定制业务** (在后端编写 远程函数，可以拿到 session、version、当前 JSON 对象 等，然后自定义处理) -* **高质可靠代码** (代码严谨规范，商业分析软件源伞 Pinpoint 代码扫描报告平均每行代码 Bug 率低至 0.15%) -* **兼容各种项目** (对各类 Web 框架集成友好且提供 SpringBoot, JFinal 的 Demo，协议不限 HTTP，与其它库无冲突) -* **工程轻量小巧** (仅依赖 fastjson，Jar 仅 280KB，Java 文件仅 59 个共 13719 行代码，例如 APIJSONORM 4.3.1) -* **多年持续迭代** (自 2016 年开源至今已连续维护 4 年，累计 2000+ Commits、70+ Releases，不断更新迭代中...) +* **文档视频齐全** (项目介绍、快速上手、安装部署 等后端、前端、客户端的 图文解说、视频教程、代码注释 等) +* **功能丰富强大** (增删改查、分页排序、分组聚合、各种条件、各种 JOIN、各种子查询、跨库连表 等零代码实现) +* **使用安全简单** (自动增删改查、自动生成文档、自动管理版本、自动控制权限、自动校验参数、自动防 SQL 注入) +* **灵活定制业务** (在后端编写 远程函数，可以拿到 session、version、当前 JSON 对象 等，然后自定义处理) +* **高质可靠代码** (代码严谨规范，蚂蚁集团源伞 Pinpoint 代码扫描分析报告平均每行代码 Bug 率低至 0.15%) +* **兼容各种项目** (协议不限 HTTP，与其它库无冲突，对各类 Web 框架集成友好且提供 SpringBoot, JFinal 的示例) +* **工程轻量小巧** (无第三方依赖，Jar 仅 263KB，Java 文件仅 68 个共 14864 行代码，例如 APIJSONORM 8.1.0) +* **多年持续迭代** (自 2016 年起已连续维护 8 年多，70+ 贡献者、100+ 发版、3000+ 提交，不断更新迭代中...) + +**按照一般互联网中小型项目情况可得出以下对比表格：** + +表数量 T | 平均每表字段数 C | SSMH 按快估计 | APIJSONBoot 按慢估计 | APIJSONBoot 提速倍数 +-------- | --------- | --------------------- | ------------------ | ----------- +1 | 3 | 179 min(约一上午) | 11 min(约十分钟) | 15.27 +5 | 4 | 1935 min(约朝九晚六一周) | 70 min(约一小时) | 26.64 +10 | 10 | 8550 min(大小周超半个月) | 320 min(约一下午) | 25.72 +20 | 15 | 31900 min(约 996 两个月) | 940 min(约上班两天) | 32.94 +50 | 20 | 176750 min(11117 超半年) | 3100 min(约上班一周) | 56.02 + +### 用户反馈 +**腾讯 IEG 数据产品开发组负责人 xinlin：** +“腾讯的 APIJSON 开源方案，它可以做到零代码生成接口和文档，并且整个生成过程是自动化。当企业有元数据的时候，马上就可以获得接口” + +**腾讯科技 后台开发高级工程师 雷大锤：** +“可以抽出时间来看apijson了，这个可以为T10做准备，也是业界很火的东西，可以提升个人影响力！” + +**腾讯 bodian520：** +“在调试GET、POST、PUT接口时遇到了一些问题，把个人的摸索经验分享一下，希望作者能梳理下文档，方便我们更好的接入” + +**华为 minshiwu：** +“demo工程，默认使用apijson-framework，可以做到无任何配置即可体验apijson的各种能力。” + +**字节跳动 qiujunlin：** +“初次见到这个项目，觉得太惊艳了，眼前一亮。给我的感受是，项目大大简化了开发流程，开发效率提升了很多倍。” + +**百度智慧城市研发 lpeng：** +“很兴奋的发现APIJSON很适合我们的一个开发场景，作为我们协议定义的一部分” + +**中兴 duyijiang：** +“感谢腾讯大大提供的框架，很好用” +https://github.com/Tencent/APIJSON/issues/132#issuecomment-1106669540 + +
### 常见问题 #### 1.如何定制业务逻辑？ @@ -182,8 +260,8 @@ https://github.com/Tencent/APIJSON/issues/36
### 注意事项 -请求参数 JSON 中表名、字段名、关键词及对应的值都是大小写敏感、逗号敏感、分号敏感、空格敏感、换行敏感，
-大部分情况都不允许空格和换行，表名以大写字母开头，不要想当然，请严格按照 [设计规范](https://github.com/Tencent/APIJSON/blob/master/Document.md#3) 来调用 API +**请求参数 JSON 中表名、字段名、关键词及对应的值都是大小写敏感、逗号敏感、分号敏感、空格敏感、换行敏感，
+大部分情况都不允许空格和换行，表名以大写字母开头，不要想当然，请严格按照 [设计规范](https://github.com/Tencent/APIJSON/blob/master/Document.md#3) 来调用 API ！** [#181](https://github.com/Tencent/APIJSON/issues/181)

@@ -200,7 +278,7 @@ https://github.com/Tencent/APIJSON/issues/36 #### 2.前端上手 可以跳过这个步骤，直接使用 [APIAuto-机器学习HTTP接口工具](https://github.com/TommyLemon/APIAuto) 或 下载客户端App。
-见  [Android](https://github.com/APIJSON/APIJSON-Demo/tree/master/APIJSON-Android)  或  [iOS](https://github.com/APIJSON/APIJSON-Demo/tree/master/APIJSON-iOS)  或  [JavaScript](https://github.com/APIJSON/APIJSON-Demo/tree/master/APIJSON-JavaScript)
+见  [Android](https://github.com/APIJSON/APIJSON-Demo/tree/master/APIJSON-Android)  或  [iOS](https://github.com/APIJSON/APIJSON-Demo/tree/master/APIJSON-iOS)  或  [JavaScript](https://github.com/APIJSON/APIJSON-Demo/tree/master/APIJSON-JavaScript)
### 下载客户端 App @@ -215,71 +293,230 @@ https://github.com/Tencent/APIJSON/issues/36 使用 [Apache License 2.0](/LICENSE)，对 公司、团队、个人 等 商用、非商用 都自由免费且非常友好，请放心使用和登记 ### 使用登记 -如果您在使用 APIJSON，请让我们知道，您的使用对我们非常重要(按登记顺序排列)：
+如果您在使用 APIJSON，请让我们知道，您的使用对我们非常重要(新的按登记顺序排列、专群优先答疑解惑)：
https://github.com/Tencent/APIJSON/issues/187
- - - - - - - - - - - + + +
+ + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
- + + * [腾讯科技有限公司](https://www.tencent.com) + * [腾讯音乐娱乐集团](https://www.tencentmusic.com) + * [深圳市传音通讯有限公司](https://www.transsion.com) + * [社宝信息科技（上海）有限公司](https://shebaochina.com) + * [华能贵诚信托有限公司](https://www.hngtrust.com) + * [投投科技](https://www.toutou.com.cn) + * [圆通速递](https://www.yto.net.cn) + * [乐拼科技](https://www.lepinyongche.com) + * [珠海采筑电子商务有限公司](https://www.aupup.com) + * [爱投斯智能技术（深圳）有限公司](http://www.aiotos.net) + * [邻盛科技（武汉）有限公司](http://www.linksame.com) + * [上海麦市信息科技有限公司](https://www.masscms.com) + * [上海翊丞互联网科技有限公司](http://www.renrencjl.com/home) + * [上海直真君智科技有限公司](http://www.zzjunzhi.com) + * [北明软件有限公司](https://www.bmsoft.com.cn/) + * [上海钰亿环保科技有限公司](#) ### 贡献者们 -主项目 APIJSON 的贡献者们和 生态周边项目 的作者们： +主项目 APIJSON 的贡献者们(6 个腾讯工程师、1 个微软工程师、1 个阿里云工程师、1 个字节跳动工程师、1 个网易工程师、1 个 Zoom 工程师、1 个圆通工程师、1 个知乎基础研发架构师、1 个智联招聘工程师、gorm-plus 作者、1 个美国加州大学学生、3 个 SUSTech 学生等)：
+https://github.com/Tencent/APIJSON/blob/master/CONTRIBUTING.md
- - - - - - - - - - - - - -
+ height="54" width="54" > + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ +生态周边项目的作者们(2 个腾讯工程师、1 个 BAT 技术专家、1 个微软工程师、2 个字节跳动工程师、1 个神州数码工程师&Apache dubbo2js 作者 等)：
+https://github.com/search?o=desc&q=apijson&s=stars&type=Repositories
+https://search.gitee.com/?skin=rec&type=repository&q=apijson&sort=stars_count
+
+ - + height="54" width="54" > + + + + height="54" width="54" > - + height="54" width="54" > + - + height="54" width="54" > + + + + + + + + + - - + height="54" width="54" > + + + + + + + + + + + + + + + + + +
+
+ +还有为 APIJSON 扫描代码贡献 Issue 的 [蚂蚁集团源伞](https://www.sourcebrella.com) 和 [奇安信代码卫士](https://github.com/QiAnXinCodeSafe) +
+ +

+ 感谢大家的贡献。 +### 统计分析 +腾讯、华为、阿里巴巴、美团、字节跳动、百度、京东、网易、快手等和 Google, Apple, Microsoft, Amazon, Paypal, IBM, Shopee 等
+数百名知名大厂员工点了 Star，也有腾讯、华为、字节跳动、Microsoft、Zoom 等不少知名大厂员工提了 PR/Issue，感谢大家的支持~
+[![Stargazers over time](https://starchart.cc/Tencent/APIJSON.svg)](https://starchart.cc/Tencent/APIJSON) +image +image +image + +根据开源指南针报告，APIJSON Java 版已经是国内顶级、国际一流的 Java 开源项目了 [#518](https://github.com/Tencent/APIJSON/issues/518)
+image ### 规划及路线图 新增功能、强化安全、提高性能、增强稳定、完善文档、丰富周边、推广使用
https://github.com/Tencent/APIJSON/blob/master/Roadmap.md 理论上所有支持 SQL 与 JDBC/ODBC 的软件，都可以用本项目对接 CRUD，待测试:
-[DB2](https://www.ibm.com/support/knowledgecenter/SSEPGG_11.1.0/com.ibm.db2.luw.sql.ref.doc/doc/r0059224.html), [Elasticsearch](https://www.elastic.co/cn/what-is/elasticsearch-sql), [ClickHouse](https://clickhouse.tech/docs/zh/sql-reference/syntax/), [OceanBase](https://www.oceanbase.com/docs/oceanbase/V2.2.50/ss-sr-select_daur3l), [Presto](https://prestodb.io/docs/current/admin/function-namespace-managers.html), [Spark](http://spark.apache.org/sql/), [Hive](https://cwiki.apache.org/confluence/display/Hive/LanguageManual+Select)(延伸支持 Hadoop, Spark), [Phoenix](http://phoenix.apache.org/language/index.html#select)(延伸支持 HBase) +[OceanBase](https://www.oceanbase.com/docs/oceanbase/V2.2.50/ss-sr-select_daur3l), [Spark](https://spark.apache.org/docs/3.3.0/sql-ref-syntax-qry-select.html)(可用 Hive 对接), [Phoenix](http://phoenix.apache.org/language/index.html#select)(延伸支持 HBase) ### 我要赞赏 -如果你喜欢 APIJSON，感觉 APIJSON 帮助到了你，可以点右上角 ⭐Star 支持一下，谢谢 ^_^
+创作不易，坚持更难，右上角点 ⭐Star 来支持/收藏下吧，谢谢 ^_^
+https://github.com/Tencent/APIJSON +


@@ -287,19 +524,33 @@ https://github.com/Tencent/APIJSON/blob/master/Roadmap.md 导航目录： [项目简介](#--apijson) [上手使用](#%E5%BF%AB%E9%80%9F%E4%B8%8A%E6%89%8B) 社区生态      完整详细的导航目录 [点这里查看](/Navigation.md)
### 技术交流 -如果有什么问题或建议可以 [提ISSUE](https://github.com/Tencent/APIJSON/issues) 或 加群，交流技术，分享经验。
-如果你解决了某些bug，或者新增了一些功能，欢迎 [贡献代码](https://github.com/Tencent/APIJSON/pulls)，感激不尽~
+如果有什么问题或建议可以 [填问卷](https://wj.qq.com/s2/10971431/2a09) 或 [提 Issue](https://github.com/Tencent/APIJSON/issues/36)，交流技术，分享经验。
+如果你解决了某些 bug，或者新增了一些功能，欢迎 [贡献代码](https://github.com/Tencent/APIJSON/pulls)，感激不尽~
https://github.com/Tencent/APIJSON/blob/master/CONTRIBUTING.md - -QQ 技术群： 734652054（新）、607020115（旧） - -如果你为 APIJSON 做出了以下任何一个贡献：
-[提交了 PR 且被合并](https://github.com/Tencent/APIJSON/pull/92)、[提交了优质 Issue](https://github.com/Tencent/APIJSON/issues/189)、[发表了优质文章](https://blog.csdn.net/qq_41829492/article/details/88670940)、[开发了可用的生态项目](https://github.com/zhangchunlin/uliweb-apijson) 或 [登记了你的公司](https://github.com/Tencent/APIJSON/issues/187)，可以加
-贡献者微信群，注意联系 LonelyExplorer，加好友描述中附上贡献链接，谢谢 - + +**开发者也是人，也需要工作、休息、恋爱、陪伴家人、走亲会友等，也有心情不好和身体病痛，**
+**往往没有额外的时间精力顾及一些小问题，请理解和支持，开源要大家参与贡献才会更美好~**
+**少数个人的热情终有被耗尽的一天，只有大家共同建设和繁荣社区，才能让开源可持续发展！**
+ +**开发者时间精力有限，原则上优先解决 登记用户 和 贡献者 的问题，**
+**不解决 文档/视频/常见问题 已明确说明、描述简陋 或 态度无礼 的问题！**
+**如果你已经多次得到帮助，却仍然只索取不贡献，那就别指望大家再帮你！**
+**私聊作者请教技术问题 或者 频繁在互助群 @ 作者 可能会被拉黑/禁言/踢群，请尊重和理解，谢谢！**
+ +如果你 [提 PR 登记了自己使用 APIJSON 的公司](https://github.com/Tencent/APIJSON/issues/187)，可以加 **企业用户支持专群**，作者亲自且优先答疑，
+作者只有解答完了这个专群里的全部问题，才看情况解答 Issue/问卷 里的问题(对 Issue/问卷 不保证解答、更不保证及时)；
+之前的几个互助群，由于大多数问题 在文档/Issue 已有答案却反复提 或者 缺少必要信息要来来回回沟通问清细节 已浪费太多时间，
+甚至有白嫖还把自己当大爷的自私自利伸手党输出情绪，我们不再支持，建议未登记企业的用户 [填问卷](https://wj.qq.com/s2/10971431/2a09) 或 [提 Issue](https://github.com/Tencent/APIJSON/issues/36)。
+ +如果你为 APIJSON 做出了以下任何一个贡献，我们将优先为你答疑解惑：
+[提交了 PR 且被合并](https://github.com/Tencent/APIJSON/pull/92)、[提交了优质 Issue](https://github.com/Tencent/APIJSON/issues/189)、[发表了优质文章](https://blog.csdn.net/qq_41829492/article/details/88670940)、[开发了可用的生态项目](https://github.com/zhangchunlin/uliweb-apijson)，
+Issue/问卷 一般解答顺序：贡献者 > 帮助他人的用户 > 提供任职企业的用户 > 其他用户。 + ### 相关推荐 -[APIJSON, 让接口和文档见鬼去吧！](https://my.oschina.net/tommylemon/blog/805459) +[APIJSON, 接口和文档的终结者！](https://my.oschina.net/tommylemon/blog/805459) + +[腾讯业务百万数据 6s 响应，APIJSON 性能优化背后的故事](https://my.oschina.net/tommylemon/blog/5375645) [仿QQ空间和微信朋友圈，高解耦高复用高灵活](https://my.oschina.net/tommylemon/blog/885787) @@ -309,12 +560,22 @@ https://github.com/Tencent/APIJSON/blob/master/CONTRIBUTING.md [3步创建APIJSON后端新表及配置](https://my.oschina.net/tommylemon/blog/889074) -[APIJSON对接分布式HTAP数据库TiDB](https://asktug.com/t/htap-tidb/395) +[APIJSON对接分布式HTAP数据库TiDB](https://my.oschina.net/tommylemon/blog/3081913) + +[APIJSON教程（一）：上手apijson项目，学习apijson语法，并实现持久层配置](https://zhuanlan.zhihu.com/p/375681893) + +[apijson简单demo](https://blog.csdn.net/dmw412724/article/details/113558115) + +[apijson简单使用](https://www.cnblogs.com/greyzeng/p/14311995.html) [APIJSON简单部署和使用](https://blog.csdn.net/m450744192/article/details/108462611) [学习自动化接口APIJSON](https://www.jianshu.com/p/981a2a630c7b) +[APIJSON 接口调试实践](https://github.com/Tencent/APIJSON/issues/189) + +[APIJSON-零代码接口和文档 JSON 协议 与 ORM 库](https://cloud.tencent.com/developer/article/2077042) + [APIJSON使用例子总结](https://blog.csdn.net/weixin_41077841/article/details/110518007) [APIJSON 自动化接口和文档的快速开发神器 （一）](https://blog.csdn.net/qq_41829492/article/details/88670940) @@ -323,17 +584,88 @@ https://github.com/Tencent/APIJSON/blob/master/CONTRIBUTING.md [APIJSON复杂业务深入实践（类似12306订票系统）](https://blog.csdn.net/aa330233789/article/details/105309571) +[新手搭建 APIJSON 项目指北](https://github.com/jerrylususu/apijson_todo_demo/blob/master/FULLTEXT.md) + +[使用APIJSON写低代码Crud接口](https://blog.csdn.net/weixin_42375862/article/details/121654264) + +[apijson在同一个接口调用中 使用远程函数写入更新时间和创建时间](https://blog.csdn.net/qietingfengsong/article/details/124097229) + +[APIJSON（一：综述）](https://blog.csdn.net/qq_50861917/article/details/120556168) + +[APIJSON 代码分析（三：demo主体代码）](https://blog.csdn.net/qq_50861917/article/details/120751630) + +[APIJSON 代码分析（二）AbstractParser类(解析器)](https://blog.csdn.net/weixin_45767055/article/details/120815927) + +[APIJSON 代码分析（四：AbstractObjectParser源码阅读）](https://blog.csdn.net/qq_50861917/article/details/120896381) + +[APIJSON 代码分析 AbstractSQLConfig 第二篇](https://blog.csdn.net/csascscascd/article/details/120684889) + +[APIJSON 代码分析（六）APIJSON—Verifier检查类](https://blog.csdn.net/weixin_45767055/article/details/121321731) + +[APIJSON 代码分析（四）AbstractSQLExecutor—SQL执行器](https://blog.csdn.net/weixin_45767055/article/details/121069887) + +[APIJSON使用](https://juejin.cn/post/7148253873478565902) + +[apijson 初探](https://www.cnblogs.com/x3d/p/apijson-lowcode.html) + +[APIJSON使用介绍](http://api.flyrise.cn:9099/docs/open-docs//1459) + +[MassCMS With APIJSON最佳实践](https://zhuanlan.zhihu.com/p/655826966) + +[APIJSON语法使用，超详细](https://blog.csdn.net/qq_36565607/article/details/139167040) + +[wend看源码-ORM-APIJSON](https://itwend.blog.csdn.net/article/details/143980281) + +[APIJSON – The No-Code API Revolution That Puts Developers in the Fast Lane](https://medevel.com/apijson) + +[APIJSON：17.4k Star！腾讯开源的零代码接口与文档协议及ORM库](https://mp.weixin.qq.com/s/gr84DmWKs4O6lcoT-iaV5w) + +[APIJSON腾讯开源的后端开发神器！！！](https://cloud.tencent.com/developer/article/2372220) + +[apijson 快速上手](https://blog.csdn.net/qq_16381291/article/details/147110737) + +[APIJSON快速入门-零后端代码，接口所见即所得](https://www.toutiao.com/article/7503844050689376783) + +[腾讯开源！零代码，全自动万能API接口](https://mp.weixin.qq.com/s/WWndAa68BqBfflWgL5592A) + +[APIJSON项目实战教程：零代码实现高效JSON接口开发](https://blog.csdn.net/gitblog_00682/article/details/148375065) + +[springboot整合APIJSON——零代码万能通用 API（附源码）](https://blog.csdn.net/longzhutengyue/article/details/150579233) ### 生态项目 [APIJSON-Demo](https://github.com/APIJSON/APIJSON-Demo) APIJSON 各种语言、各种框架 的 使用示例项目、上手文档、测试数据 SQL 文件 等 [apijson-orm](https://github.com/APIJSON/apijson-orm) APIJSON ORM 库，可通过 Maven, Gradle 等远程依赖 -[apijson-framework](https://github.com/APIJSON/apijson-framework) APIJSON 服务端框架，可通过 Maven, Gradle 等远程依赖 +[apijson-framework](https://github.com/APIJSON/apijson-framework) APIJSON 服务端框架，通过数据库表配置角色权限、参数校验等，简化使用 + +[apijson-router](https://github.com/APIJSON/apijson-router) APIJSON 的路由插件，可控地对公网暴露类 RESTful 简单接口，内部转成 APIJSON 格式请求来执行 + +[apijson-column](https://github.com/APIJSON/apijson-column) APIJSON 的字段插件，支持 字段名映射 和 !key 反选字段 + +[apijson-jackson](https://github.com/APIJSON/apijson-jackson) APIJSON 的 jackson 插件，简化使用 + +[apijson-fastjson2](https://github.com/APIJSON/apijson-fastjson2) APIJSON 的 fastjson2 插件，简化使用 + +[apijson-gson](https://github.com/APIJSON/apijson-gson) APIJSON 的 gson 插件，简化使用 + +[apijson-milvus](https://github.com/APIJSON/apijson-milvus) APIJSON 的 Milvus AI 向量数据库插件 + +[apijson-influxdb](https://github.com/APIJSON/apijson-influxdb) APIJSON 的 InfluxDB 物联网时序数据库插件 -[APIAuto](https://github.com/TommyLemon/APIAuto) 敏捷开发最强大易用的 HTTP 接口工具，机器学习零代码测试、生成代码与静态检查、生成文档与光标悬浮注释 +[apijson-mongodb](https://github.com/APIJSON/apijson-mongodb) APIJSON 的 MongoDB NoSQL 数据库插件 -[UnitAuto](https://github.com/TommyLemon/UnitAuto) 机器学习单元测试平台，零代码、全方位、自动化 测试 方法/函数 的正确性和可用性 +[apijson-cassandra](https://github.com/APIJSON/apijson-cassandra) APIJSON 的 Cassandra NoSQL 数据库插件 + +[APIAuto](https://github.com/TommyLemon/APIAuto) ☔ 敏捷开发最强大易用的接口工具，零代码测试与 AI 问答、生成代码与静态检查、生成文档与光标悬浮注释，腾讯、SHEIN、传音 等使用 + +[CVAuto](https://github.com/TommyLemon/CVAuto) 👁 零代码零标注 CV AI 自动化测试平台 🚀 免除大量人工画框和打标签等，直接快速测试 CV 计算机视觉 AI 图像识别算法 + +[UnitAuto](https://github.com/TommyLemon/UnitAuto) 最先进、最省事、ROI 最高的单元测试，机器学习 零代码、全方位、自动化 测试 方法/函数，用户包含腾讯、快手、某 500 强巨头等 + +[SQLAuto](https://github.com/TommyLemon/SQLAuto) 智能零代码自动化测试 SQL 数据库工具，任意增删改查、任意 SQL 模板变量、一键批量生成参数组合、快速构造大量测试数据 + +[UIGO](https://github.com/TommyLemon/UIGO) 📱 零代码快准稳 UI 智能录制回放平台 🚀 3 像素内自动精准定位，2 毫秒内自动精准等待，用户包含腾讯，微信团队邀请分享 [apijson-doc](https://github.com/vincentCheng/apijson-doc) APIJSON 官方文档，提供排版清晰、搜索方便的文档内容展示，包括设计规范、图文教程等 @@ -343,31 +675,168 @@ https://github.com/Tencent/APIJSON/blob/master/CONTRIBUTING.md [APIJSON.NET](https://github.com/liaozb/APIJSON.NET) C# 版 APIJSON ，支持 MySQL, PostgreSQL, SQL Server, Oracle, SQLite +[apijson-go](https://github.com/glennliao/apijson-go) Go 版 APIJSON ， 基于Go(>=1.18) + GoFrame2, 支持查询、单表增删改、权限管理等 + +[apijson-go](https://gitee.com/tiangao/apijson-go) Go 版 APIJSON ，支持单表查询、数组查询、多表一对一关联查询、多表一对多关联查询 等 + +[apijson-hyperf](https://github.com/kvnZero/hyperf-APIJSON.git) PHP 版 APIJSON，基于 Hyperf 支持 MySQL + +[APIJSON-php](https://github.com/xianglong111/APIJSON-php) PHP 版 APIJSON，基于 ThinkPHP，支持 MySQL, PostgreSQL, SQL Server, Oracle 等 + [apijson-php](https://github.com/qq547057827/apijson-php) PHP 版 APIJSON，基于 ThinkPHP，支持 MySQL, PostgreSQL, SQL Server, Oracle 等 -[apijson-node](https://github.com/kevinaskin/apijson-node) Node.ts 版 APIJSON，提供 nestjs 和 typeorm 的 Demo，支持 MySQL, PostgreSQL, SQL Server, Oracle +[apijson-node](https://github.com/kevinaskin/apijson-node) 字节跳动工程师开源的 Node.ts 版 APIJSON，提供 nestjs 和 typeorm 的 Demo 及后台管理 [uliweb-apijson](https://github.com/zhangchunlin/uliweb-apijson) Python 版 APIJSON，支持 MySQL, PostgreSQL, SQL Server, Oracle, SQLite 等 +[panda-base](https://gitee.com/digithub/panda-base) APIJSON 的 Rust 版，一个优雅、高性能的 Rust 多数据源管理系统，支持 MySQL 和 PostgreSQL + [APIJSONParser](https://github.com/Zerounary/APIJSONParser) 第三方 APIJSON 解析器，将 JSON 动态解析成 SQL -[ApiJsonByJFinal](https://gitee.com/zhiyuexin/ApiJsonByJFinal) 整合 APIJSON 和 JFinal 的 Demo +[FfApiJson](https://gitee.com/own_3_0/ff-api-json) 用 JSON 格式直接生成 SQL，借鉴 APIJSON 支持多数据源 + +[APIJSON-ToDo-Demo](https://github.com/jerrylususu/apijson_todo_demo) 一个简单的 todo 示例项目，精简数据，简化上手流程，带自定义鉴权逻辑 + +[apijson-learn](https://github.com/rainboy-learn/apijson-learn) APIJSON 学习笔记和源码解析 + +[apijson-practice](https://github.com/vcoolwind/apijson-practice) BAT 技术专家开源的 APIJSON 参数校验注解 Library 及相关 Demo + +[apijson-db2](https://github.com/andream7/apijson-db2) 微软工程师接入 IBM 数据库 DB2 的 APIJSON 使用 Demo + +[APIJSONDemo](https://github.com/qiujunlin/APIJSONDemo) 字节跳动工程师接入 ClickHouse 的 APIJSON 使用 Demo + +[APIJSONDemo_ClickHouse](https://github.com/chenyanlann/APIJSONDemo_ClickHouse) APIJSON + SpringBoot 连接 ClickHouse 使用的 Demo + +[APIJSONBoot_Hive](https://github.com/chenyanlann/APIJSONBoot_Hive) APIJSON + SpringBoot 连接 Hive 使用的 Demo + +[apijson-sample](https://gitee.com/greyzeng/apijson-sample) APIJSON 简单使用 Demo 及教程 + +[apijson-examples](https://gitee.com/drone/apijson-examples) APIJSON 的前端、业务后端、管理后端 Demo + +[apijson-ruoyi](https://github.com/daodol/apijson-ruoyi) APIJSON 和 RuoYi 框架整合，实现零代码生成页面模板接口，在线维护 APIJSON 数据库配置等 + +[light4j](https://github.com/xlongwei/light4j) 整合 APIJSON 和微服务框架 light-4j 的 Demo，同时接入了 Redis [SpringServer1.2-APIJSON](https://github.com/Airforce-1/SpringServer1.2-APIJSON) 智慧党建服务器端，提供 上传 和 下载 文件的接口 +[apijson_template](https://github.com/abliger/apijson_template) APIJSON Java 模版，使用 gradle 管理依赖和构建应用 + +[api-json-demo](https://gitee.com/hxdwd/api-json-demo) 基于 APIJSON，实现低代码写 CURD 代码，代替传统 ORM 框架，适配 Oracle 事务 + +[ApiJsonByJFinal](https://gitee.com/zhiyuexin/ApiJsonByJFinal) 整合 APIJSON 和 JFinal 的 Demo + +[apijson-go-demo](https://github.com/glennliao/apijson-go-demo) apijson-go demos，提供 3 个从简单到复杂的不同场景 Demo + [apijson-builder](https://github.com/pengxianggui/apijson-builder) 一个方便为 APIJSON 构建 RESTful 请求的 JavaScript 库 +[apijson-go-ui](https://github.com/glennliao/apijson-go-ui) apijson-go UI 界面配置, 支持权限管理、请求规则配置等 + [AbsGrade](https://github.com/APIJSON/AbsGrade) 列表级联算法，支持微信朋友圈单层评论、QQ空间双层评论、百度网盘多层(无限层)文件夹等 [APIJSON-Android-RxJava](https://github.com/TommyLemon/APIJSON-Android-RxJava) 仿微信朋友圈动态实战项目，ZBLibrary(UI) + APIJSON(HTTP) + RxJava(Data) -[Android-ZBLibrary](https://github.com/TommyLemon/Android-ZBLibrary) Android MVP快速开发框架，Demo全面，注释详细，使用简单，代码严谨 +[Android-ZBLibrary](https://github.com/TommyLemon/Android-ZBLibrary) Android MVP 快速开发框架，Demo 全面，注释详细，使用简单，代码严谨 + +[apijson-dynamic-datasource](https://github.com/wb04307201/apijson-dynamic-datasource) 基于APIJSON，动态切换数据源、同一数据源批量操作事务一致性DEMO + +[xyerp](https://gitee.com/yinjg1997/xyerp) 基于ApiJson的低代码ERP + +[quick-boot](https://github.com/csx-bill/quick-boot) 基于 Spring Cloud 2022、Spring Boot 3、AMIS 和 APIJSON 的低代码系统。 + +[apijson-query-spring-boot-starter](https://gitee.com/mingbaobaba/apijson-query-spring-boot-starter) 一个快速构建 APIJSON 查询条件的插件 + +[apijson-builder](https://github.com/yeli19950109/apijson-builder) 简单包装 APIJSON，相比直接构造查询 JSON 更好记，ts 编写，调整了一些参数和使用方式 + +[lanmuc](https://gitee.com/element-admin/lanmuc) 后端低代码生产接口的平台，兼容配置式接口和编写式接口，可做到快速生产接口，上线项目 + +[review_plan](https://gitee.com/PPXcodeTry/review_plan) 复习提醒Web版（Java技术练习项目） + +[apijson-nutz](https://github.com/vincent109/apijson-nutz) APIJSON + Nutz 框架 + NutzBoot 的 Demo + +[apijson-spring-boot](https://gitee.com/yunjiao-source/apijson-spring-boot) Springboot3 for APIJSON，用 YAML 简化代码配置 + +感谢热心的作者们的贡献，点 ⭐Star 支持下他们吧~ + + +### 腾讯犀牛鸟开源人才培养计划 +https://github.com/Tencent/APIJSON/issues/229 + +#### qiujunlin **2.接入 presto/hive/clickhouse/db2 任意一个** -感谢热心的作者们的贡献，点 ⭐Star 支持下他们吧。 +APIJSON 接入 clickhouse 使用demo
+https://github.com/qiujunlin/APIJSONDemo +#### zhangshukun 2.接入 presto/hive/clickhouse/db2 任意一个 +APIJSON-Demo接入db2
+https://github.com/andream7/apijson-db2 + +#### hanxu 1.完善入门介绍视频 +重构 APIJSON 文档
+https://hanxu2018.github.io/APIJSON-DOC/
+文档源码
+https://github.com/HANXU2018/APIJSON-DOC
+配套评论区 apijson-doc-Comment
+https://github.com/HANXU2018/apijson-doc-Comment + +#### chenyanlan 2.接入 presto/hive/clickhouse/db2 任意一个 +APIJSON + SpringBoot连接ClickHouse使用的Demo
+https://github.com/chenyanlann/APIJSONDemo_ClickHouse + +#### zhaoqiming 1.完善入门介绍视频 +APIJSON 后端教程（1）：简介 +https://www.bilibili.com/video/BV1vL411W7yd + +APIJSON 后端教程（2）：数据库 +https://www.bilibili.com/video/BV1eB4y1N77s + +APIJSON 后端教程（3）：Demo +https://www.bilibili.com/video/BV1FX4y1c7ug + +APIJSON 后端教程（4）：Boot +https://www.bilibili.com/video/BV18h411z7FK + +APIJSON 后端教程（5）：Final +https://www.bilibili.com/video/BV1GM4y1N7XJ + +APIJSON 后端教程（6）：uliweb_apijson +https://www.bilibili.com/video/BV1yb4y1S79v/ + +APIJSON 后端教程（7）：问题答疑 +https://www.bilibili.com/video/BV1dQ4y1h7Df + +APIJSON配套文档： +https://github.com/kenlig/apijsondocs + +#### huwen 2.接入 presto/hive/clickhouse/db2 任意一个 +APIJSON-Demo 接入presto +https://github.com/hclown9804/APIJSONDemo_presto + +#### zhanghaoling 1.完善入门介绍视频 +APIJSON结合已有项目，简化开发流程 +https://github.com/haolingzhang1/APIJson--demo + +说明文档 +https://github.com/haolingzhang1/APIJson--demo/tree/main/APIJson集成项目说明 + +(1)官方demo +https://github.com/haolingzhang1/APIJson--demo/blob/main/APIJson集成项目说明/APIJson集成现有项目（1）-%20官方demo.pdf + +(2)单表配置 +https://github.com/haolingzhang1/APIJson--demo/blob/main/APIJson集成项目说明/APIJson集成现有项目（2）-%20单表配置.pdf + +#### zhoukaile 1.完善入门介绍视频 + +视频链接：https://www.bilibili.com/video/BV1Uh411z7kZ/ + +文档链接：https://gitee.com/funkiz/apijson_camp + +#### lintao 1.完善入门介绍视频 + +APIJSON 上手教程：https://www.bilibili.com/video/BV1Pq4y1n7rJ ### 持续更新 + https://github.com/Tencent/APIJSON/commits/master ### 工蜂主页 diff --git a/Roadmap.md b/Roadmap.md index 6f0e3e5b7..c655f5fa8 100644 --- a/Roadmap.md +++ b/Roadmap.md @@ -7,7 +7,7 @@ ### 新增功能 部分功能描述可在 [APIAuto](https://github.com/TommyLemon/APIAuto) 上查看
账号 13000002020 密码 123456
-http://apijson.org:8000/auto/
+http://apijson.cn/api
##### 基本原则 1.一定要有相关的应用场景，不能是伪需求，最好举例说明
@@ -15,6 +15,9 @@ http://apijson.org:8000/auto/
3.不影响现有功能的使用，不能让现有功能不可用或者使用更复杂
#### 新增支持假删除 +20230106 更新：已支持，感谢 @cloudAndMonkey 的贡献
+https://github.com/Tencent/APIJSON/pull/493 + 一般对于互联网项目，数据非常重要，基本不会物理删除，
只是用 is_deleted 等字段来标记已删除，然后 CRUD 时默认过滤已标记的记录。
这个功能非常必要，可以通过重写 SQLConfig.isFakeDelete() 来标记，
@@ -30,11 +33,14 @@ POST: 用不上，不处理
然后读表自动配置是否为假删除 StringUtil.isNotEmpty(deletedKey, true) ，是假删除时 put 相应键值对。
#### 新增支持 @having& +20220328 更新：5.0.0 已支持
+https://github.com/Tencent/APIJSON/releases/tag/5.0.0 来实现内部条件 AND 连接，原来的 @having 由 AND 连接变为 OR 连接，保持 横或纵与 的统一规则。
@having! 必须性不大，可通过反转内部条件来实现，但如果实现简单、且不影响原来的功能，则可以顺便加上。
#### 新增支持 @column! +20210415 更新：已提供字段插件 [apijson-column](https://github.com/APIJSON/apijson-column)，支持 字段名映射 和 !key 反选字段。 这个只在 [apijson-framework](https://github.com/APIJSON/apijson-framework) 支持，需要配置每个接口版本、每张表所拥有的全部字段，然后排除掉 @column! 的。
可新增一个 VersionedColumn 表记录来代替 HashMap 代码配置。
@@ -43,8 +49,10 @@ POST: 用不上，不处理
如果有有重合字段，则抛异常，转为错误码和错误信息返回。
#### 新增支持 TSQL 的 @explain +20220809 更新：已支持 Oracle 的 EXPLAIN，感谢 @ifooling 的贡献
+https://github.com/Tencent/APIJSON/pull/434 -目前 APIJSON 支持 [Oracle](https://github.com/APIJSON/APIJSON-Demo/tree/master/Oracle) 和 [SQL Server](https://github.com/APIJSON/APIJSON-Demo/tree/master/SQLServer) 这两种 TSQL 数据库（群友测试 IBM DB2 也行）。
+目前 APIJSON 支持 [Oracle](https://github.com/APIJSON/APIJSON-Demo/tree/master/Oracle), [SQL Server](https://github.com/APIJSON/APIJSON-Demo/tree/master/SQLServer), DB2 这 3 种 TSQL 数据库。
但是 "@explain": true 使用的是 SET STATISTICS PROFILE ON(具体见 [AbstractSQLConfig](https://github.com/Tencent/APIJSON/blob/master/APIJSONORM/src/main/java/apijson/orm/AbstractSQLConfig.java) 和 [AbstrctSQLExecutor](https://github.com/Tencent/APIJSON/blob/master/APIJSONORM/src/main/java/apijson/orm/AbstrctSQLExecutor.java))
执行后居然是 SELECT 查到的放在默认的 ResultSet，性能分析放在 moreResult，
因为这个问题目前以上两个数据库的性能分析 @explain 实际并不可用，需要改用其它方式或解决现有方式的 bug。
@@ -109,6 +117,8 @@ LIMIT 10 OFFSET 0 #### 新增支持 With +20221126 更新：已支持，感谢 @cloudAndMonkey 的贡献
+https://github.com/Tencent/APIJSON/pull/481 可以减少子查询执行次数，提高性能。 ```js @@ -163,6 +173,70 @@ SELECT * FROM `sys`.`Comment` WHERE ( (`userId` IN `sql` ) ) ORDER BY `date` DES 暂时还没有想好如何设计。如果是 SQL 原来的写法，则有点繁琐。
+#### 新增支持 id 与其它字段同时作为增删改条件 +AbstractVerifier.IS_UPDATE_MUST_HAVE_ID_CONDITION = false
+就同时支持 id、其它条件删除
+https://github.com/Tencent/APIJSON/blob/master/APIJSONORM/src/main/java/apijson/orm/AbstractVerifier.java#L84-L86 + +但因为 Operation 没有 AT_LEAST_ONE/ANY_ONE 这样的操作，
+所以如果只配置一条规则，只能允许 MUST 配置传一种条件，不能单独传 id/其它字段。
+
+如果都传了，因为 id 强制作为 AND 条件，所以不能和其它条件 OR，
+可以配置两条不同规则，用不同的 tag 对应使用不同的条件。
+
+method: DELETE
+ +通过 id 删除 +``` +tag: Comment-by-id // 当然写成 Comment:id 等其它任何不符合表名格式的名称都可 +structure: ... "MUST":"id" ... +``` +
+ +通过 date 条件删除 +``` +tag: Comment-by-date +structure: ... "MUST":"date" ... +``` + +
+如果想只配置一条规则，则 Operation 加上 AT_LEAST_ONE/ANY_ONE ，然后配置 + +``` +tag: Comment +structure: ... "AT_LEAST_ONE":"id,date" ... // 至少传其中一个 +``` + +或 + +``` +tag: Comment +structure: ... "ANY_ONE":"id,date" ... // 必须传其中一个，不能同时传 2 个以上 +``` +
+ +AT_LEAST_ONE/ANY_ONE 其中一个也可以通过扩展 MUST 来实现（目前看这种方式更好）
+"MUST":"id | date,其它" 通过 | 或来表示其中任何一个，注意左右一定要各有一个空格，因为可能有 "name|$" "id|{}" 等包含 "|" 的 key
+https://github.com/Tencent/APIJSON/blob/master/APIJSONORM/src/main/java/apijson/orm/Operation.java + +
+还可以设置更复杂的表达方式 + +``` +"MUST":"1:id | date,其它" // id, date 必须传其中一个，且不能多传
+"MUST":">=2:id | momentId|{} | date>=,其它" // id, momentId|{}, date>= 必须至少其中 2 个 +"MUST":"2+:id | momentId|{} | date>=,其它" // id, momentId|{}, date>= 必须至少其中 2 个，替代 >= 2，更方便解析，并且不用考虑 >1, != 2 等其它各种不等式 +"MUST":"2-:id | momentId|{} | date>=,其它" // id, momentId|{}, date>= 最多传其中 2 个，替代 <= 2 +``` + +
+这样的话就不用加 Operation 了，不过 AbstractVerifier 仍然要处理下 REFUSE 和 MUST 的互斥关系
+https://github.com/Tencent/APIJSON/blob/master/APIJSONORM/src/main/java/apijson/orm/AbstractVerifier.java#L1012-L1042 +image + +##### 需求来源及具体讨论 +https://github.com/Tencent/APIJSON/pull/493#issuecomment-1373376359 + #### ... //欢迎补充 @@ -170,6 +244,9 @@ SELECT * FROM `sys`.`Comment` WHERE ( (`userId` IN `sql` ) ) ORDER BY `date` DES ### 强化安全 APIJSON 提供了各种安全机制，可在目前的基础上新增或改进。 +20220504 更新：新增插件 apijson-router，可控地对公网暴露类 RESTful 简单接口，内部转成 APIJSON 格式请求来执行。
+https://github.com/APIJSON/apijson-router + #### 防越权操作 目前有 RBAC 自动化权限管理。
@@ -187,10 +264,15 @@ APIJSONORM 提供 [@MethodAccess](https://github.com/Tencent/APIJSON/blob/master 目前有限流机制，getMaxQueryCount, getMaxUpdateCount, getMaxObjectCount, getMaxSQLCount, getMaxQueryDepth 等。
https://github.com/Tencent/APIJSON/blob/master/APIJSONORM/src/main/java/apijson/orm/Parser.java
+ #### ... //欢迎补充 ### 提高性能 +20200205 更新：最近的及次大幅提升性能相关优化及 Release
+[新增支持 ClickHouse、窗口函数 OVER、反引号 `key`、单引号 'value'；大幅提升单表数组查询性能](https://github.com/Tencent/APIJSON/releases/tag/4.8.0)
+[4.6.0【性能】大幅提升数组内主表查询性能](https://github.com/Tencent/APIJSON/releases/tag/4.6.0)
+[4.4.5【性能】大幅提升增删改的性能](https://github.com/Tencent/APIJSON/releases/tag/4.4.5)
#### 解析 JSON @@ -206,6 +288,8 @@ https://github.com/Tencent/APIJSON/blob/master/APIJSONORM/src/main/java/apijson/ [完善功能](https://github.com/Tencent/APIJSON/blob/master/Roadmap.md#%E5%AE%8C%E5%96%84%E5%8A%9F%E8%83%BD) 中 Union 和 With 也是优化 SQL 性能的方式。
#### 读写缓存 +20230105 更新：新增 Redis 缓存 Demo +https://github.com/APIJSON/APIJSON-Demo/commit/060a10e56818b31ab332770815467af9f052c261 在 [AbstractParser](https://github.com/Tencent/APIJSON/blob/master/APIJSONORM/src/main/java/apijson/orm/AbstractParser.java) 使用了 HashMap queryResultMap 存已解析的对象、总数等数据。
在 [AbstractSQLExecutor](https://github.com/Tencent/APIJSON/blob/master/APIJSONORM/src/main/java/apijson/orm/AbstractSQLExecutor.java) 使用了 HashMap cacheMap 存已通过 SQL 查出的结果集。
@@ -219,11 +303,14 @@ APIJSON 代码经过商业分析软件 [源伞Pinpoint](https://www.sourcebrella https://github.com/Tencent/APIJSON/issues/48
但我们需要再接再厉，尽可能做到 99.999% 可靠度，降低使用风险，让用户放心和安心。
+20200205 更新：已经解决了 [源伞科技](https://www.sourcebrella.com) 以上报告中的大部分问题 及 [奇安信代码卫士](https://github.com/QiAnXinCodeSafe) 发现的部分问题 +https://github.com/Tencent/APIJSON/issues/created_by/QiAnXinCodeSafe + #### 减少 Bug ##### [APIAuto](https://github.com/TommyLemon/APIAuto) 上统计的 bug 账号 13000002000 密码 123456
-http://apijson.org:8000/auto/
+http://apijson.cn/api
##### 其它发现的 Bug https://github.com/Tencent/APIJSON/issues?q=is%3Aissue+is%3Aopen+label%3Abug
@@ -231,13 +318,17 @@ https://github.com/Tencent/APIJSON/issues?q=is%3Aissue+is%3Aopen+label%3Abug
+http://apijson.cn/api
-##### 接入 UnitAuto-机器学习自动化单元测试平台，每次启动都自动测试所有可测方法并输出报告 -https://gitee.com/TommyLemon/UnitAuto
+##### 在 UnitAuto-机器学习自动化单元测试平台 上传更多、更全面、更细致的测试用例、动态参数等 +http://apijson.cn/unit
### 完善文档 +20211112 更新：已在官网部署文档 http://apijson.cn/doc/zh +20200205 更新：最近完善及更新了通用文档、上手文档、图文入门文档等，还对首页引导文档加了导航目录 +https://github.com/Tencent/APIJSON/blob/master/Navigation.md + #### 中文文档 ##### 通用文档 @@ -261,17 +352,18 @@ https://github.com/ruoranw/APIJSONdocs
### 丰富周边 #### 新增或完善各种语言 ORM 库 -Go, Kotlin, Ruby 等。
-https://github.com/APIJSON/APIJSON#%E7%94%9F%E6%80%81%E9%A1%B9%E7%9B%AE
+Go, Node(js/ts), C#, PHP, Kotlin, Ruby 等。
+https://github.com/Tencent/APIJSON#%E7%94%9F%E6%80%81%E9%A1%B9%E7%9B%AE
#### 新增或完善 Demo JavaScript 前端，TypeScript 前端，微信等小程序，
Android 客户端，iOS 客户端，C# 游戏客户端等。
-Java, C#, Node, Python 等后端 Demo 及数据。
+Java, C#, PHP, Node, Python 等后端 Demo 及数据。
https://github.com/APIJSON/APIJSON-Demo
#### 新增扩展 +目前官方有 apijson-column, apijson-router 两个插件 ##### 1.基于或整合 [APIJSONORM](https://github.com/Tencent/APIJSON/blob/master/APIJSONORM) 或 [apijson-framework](https://github.com/APIJSON/apijson-framework) 来实现的库/框架 @@ -291,6 +383,8 @@ https://github.com/APIJSON/APIJSON-Demo
https://github.com/Tencent/APIJSON#%E7%9B%B8%E5%85%B3%E6%8E%A8%E8%8D%90 +20200205 更新：最近首页相关推荐新增了 1 篇官方发的文章和 6 篇用户发的文章 +https://github.com/Tencent/APIJSON/blob/master/README.md#%E7%9B%B8%E5%85%B3%E6%8E%A8%E8%8D%90 #### 登记正在使用 APIJSON 的公司或项目 diff --git "a/\350\257\246\347\273\206\347\232\204\350\257\264\346\230\216\346\226\207\346\241\243.md" "b/\350\257\246\347\273\206\347\232\204\350\257\264\346\230\216\346\226\207\346\241\243.md" index 8a4d7f7c6..827fab38e 100644 --- "a/\350\257\246\347\273\206\347\232\204\350\257\264\346\230\216\346\226\207\346\241\243.md" +++ "b/\350\257\246\347\273\206\347\232\204\350\257\264\346\230\216\346\226\207\346\241\243.md" @@ -1,20 +1,25 @@ -# APIJSON +# APIJSON 入门教程 -[TOC] +可以先看更清晰直观的视频教程
+https://search.bilibili.com/all?keyword=APIJSON +![image](https://user-images.githubusercontent.com/5738175/135413311-0207ec13-f7ea-4767-9e34-1a6d08438295.png) +本文档已部署到官网，浏览和检索体验更好，但官网更新滞后，如有疏漏以本文档为准
+http://apijson.cn/doc/zh/ +其它各种官方和第三方文档见首页相关推荐
+https://github.com/Tencent/APIJSON#%E7%9B%B8%E5%85%B3%E6%8E%A8%E8%8D%90 ## A.介绍 ### A1.关于接口开发 -首先是看名字`APIJSON`，API是说这个项目是属于接口开发的项目，JSON是指传输数据格式是JSON格式。介于各位看官的水平高低不齐，这里就先为没有项目经验朋友啰嗦两句接口开发的内容。有经验的朋友可以跳到`A2`继续查看。 - -（此处内容以后会有的） +首先是看名字 `APIJSON`，API 是说这个项目是属于接口开发的项目，JSON 是指传输数据格式是 JSON 格式。介于各位看官的水平高低不齐，这里就先为没有项目经验朋友啰嗦两句接口开发的内容。有经验的朋友可以跳到 `A2` 继续查看。完整的详细介绍见项目首页
+https://github.com/Tencent/APIJSON#--apijson ### A2.功能说明 -一个接口的开发，比如Java用SpringBoot，Mybatis来开发一般来说就像下面这个流程 +一个接口的开发，比如 Java 用 SpringBoot + Mybatis 来开发一般来说就像下面这个流程 ![1545468341131](assets/1545468341131.png) @@ -24,68 +29,85 @@ 如果使用 [apijson-framework](https://github.com/APIJSON/apijson-framework)，还可进一步简化流程 -![1543975563776](assets/1543975563776.png) +![1543975563776](https://raw.githubusercontent.com/Tencent/APIJSON/master/assets/1543975563776.png) -换句话说，使用这个项目作为后端的支持的话，是不需要对每个表写增删改查等接口的，只需在该项目连接的数据里进行表的创建，以及配置接口权限即可。无需进行过多的开发，哪怕是要改结构也仅仅只需要修改表字段而已。想想仅仅是部署一个后端项目，现在需要些的接口就基本写好了，直接调用就行了，是不是挺爽的。 +换句话说，使用这个项目作为后端的支持的话，是不需要对每个表写增删改查等接口的，只需在该项目连接的数据里进行表的创建，以及配置接口权限即可。无需进行过多的开发，哪怕是要改结构也仅仅只需要修改表字段而已。想想仅仅是部署一个后端项目，现在需要写的接口就基本写好了，直接调用就行了，是不是挺爽的。 说这么多，咱们直接开干吧！ -## B.安装&使用 ->JDK： 1.8+ -> ->Maven： 3.0+ -> ->数据库：Mysql，Oralce +# B.安装&使用 -### B1.下载项目 +## B1.环境配置 -```bash -git clone https://github.com/TommyLemon/APIJSON.git -``` +JDK: 1.8+ + +MAVEN: 3.0+ -或者，直接下载ZIP打包好的项目文件。 +MySQL 5.7+ / PostgreSQL 9.5+ / Oracle 12C+ / ClickHouse 21.1+ / Presto 0.277+ / Hive 3.1.2+ / ... -![1542255627809](assets/1542255627809.png) +IntelliJ IDEA 2018+ / Eclipse Java EE IDE 4.5.1+ +## B2.下载项目 + +```git +git clone https://github.com/APIJSON/APIJSON-Demo.git +``` +或者，直接下载 ZIP 打包好的项目文件。 -### B2.导入项目 +![image](https://user-images.githubusercontent.com/5738175/135412855-574cae7b-402c-4fe0-9959-711e580799af.png) -Eclipse导入： +## B3.导入项目 -顶部菜单File > Import > Maven > Existing Maven Projects > Next > Browse +Eclipse 导入： -`APIJSON-Master/APIJSON-Java-Server/APIJSONBoot` +顶部菜单 File > Import > Maven > Existing Maven Projects > Next > Browse -报依赖错误的时候，同目录下的`lib`里面的`jar`添加到`Build Path`中。 +选择项目所在目录 [/APIJSON-Demo-Master/APIJSON-Java-Server](https://github.com/APIJSON/APIJSON-Demo/tree/master/APIJSON-Java-Server)/APIJSONBoot +当报依赖错误的时候，将同目录下的 libs 里面的 jar 包添加到 Build Path 中。 ![1542345887787](assets/1542345887787.png) -为了方便修改源代码，你可以像我一样不添加`libs/apijson-orm-3.5.1.jar`文件到`Build Path`中。而是`libs/apijson-orm-3.5.1.jar`的源码，复制到当前项目里。 +为了方便修改源代码，你可以像我一样不添加 libs/APIJSON.jar 文件到 Build Path 中。而是将 libs/APIJSON.jar 的源码，复制到当前项目里，然后添加到 Build Path 中。 -源代码在`APIJSON-Master/APIJSON-Java-Server/APIJSONORM`项目中。 +源代码在 [APIJSON-Master/APIJSON-Java-Server](https://github.com/Tencent/APIJSON)/APIJSONORM。 -### B3. pom.xml的错误修改。 -有可能这时候pom.xml中报错，例如： -``` xml +IntelliJ IDEA 导入具体见： + +https://github.com/APIJSON/APIJSON-Demo/tree/master/APIJSON-Java-Server#3%E7%94%A8-intellij-idea-ultimate-%E6%88%96-eclipse-for-javaee-%E8%BF%90%E8%A1%8C%E5%90%8E%E7%AB%AF%E5%B7%A5%E7%A8%8B + +## B4.错误修改 + +有可能 pom.xml 会报错，例如： + +```java ``` -这段代码中的这一句： -``` xml + +这段代码中的这一句提示错误： + +```java xsi:schemaLocation="http://maven.apache.org/POM/4.0.0%20http://maven.apache.org/xsd/maven-4.0.0.xsd"> ``` -提示错误。 -其实是maven中安装包的问题。 -那么在Window->Preference->Maven->User Settings中查找你的包安装目录删除对应的包。 -具体操作请自行百度。 + +修改步骤： + +- 请修改 Eclipse 中的 Maven 镜像地址，以便更快下载或者更新，具体方法自行百度； +- 打开 Eclipse->Windows->Preferences->Maven->Installations->Add 这个按钮用于指定 Maven 的安装目录。这里不建议使用 Eclipse 自带的，需要再自己设置。最终效果如下图所示： + ![install3](https://raw.githubusercontent.com/APIJSON/APIJSON-Doc/master/docs/.vuepress/public/assets/install3.png) +- 打开 Eclipse->Windows->Preferences->Maven->User Settings 这是指定 setting.xml 的位置，同时导向自己的本地 maven 仓库。最终效果如下图所示： + ![install4](https://raw.githubusercontent.com/APIJSON/APIJSON-Doc/master/docs/.vuepress/public/assets/install4.png) + +以上截图仅为示例，实际路径请以自己设定为准。 + ## C.开发说明 -### C-1.基于Mysql数据库的开发流程 +### C-1.基于 MySQL 数据库的开发流程 #### C-1-1.修改数据库链接 @@ -93,62 +115,82 @@ xsi:schemaLocation="http://maven.apache.org/POM/4.0.0%20http://maven.apache.org/xs%20%20|%20%E6%95%B0%E6%8D%AE%E5%BA%93%E5%8F%82%E6%95%B0%20|%20%E5%80%BC%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20|%20|%20----------%20|%20-------------------%20|-|%20%E5%9C%B0%E5%9D%80%20%20%20%20%20%20%20|%20192.168.71.146:3306%20|+|%20%E5%9C%B0%E5%9D%80%20%20%20%20%20%20%20|%20localhost:3306%20|%20|%20%E7%94%A8%E6%88%B7%20%20%20%20%20%20%20|%20root%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20|-|%20%E5%AF%86%E7%A0%81%20%20%20%20%20%20%20|%20root%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20|-|%20%E6%95%B0%E6%8D%AE%E5%BA%93%20%20%20%20%20|%20thea%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20|+|%20%E5%AF%86%E7%A0%81%20%20%20%20%20%20%20|%20apijson%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20|+|%20%E6%95%B0%E6%8D%AE%E5%BA%93%20%20%20%20%20|%20sys%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20|%20-%E9%82%A3%E4%B9%88%E9%9C%80%E8%A6%81%E5%9C%A8%60DemoSQLConfig%60%EF%BC%8C40-61%E8%A1%8C%EF%BC%8C%E6%94%B9%E4%B8%BA%E8%87%AA%E5%B7%B1%E6%95%B0%E6%8D%AE%E5%BA%93%E5%AF%B9%E5%BA%94%E7%9A%84%E9%93%BE%E6%8E%A5+%E9%82%A3%E4%B9%88%E9%9C%80%E8%A6%81%E5%9C%A8%20%60DemoSQLConfig%60%20%E9%85%8D%E7%BD%AE%E6%95%B0%E6%8D%AE%E5%BA%93%20%20%60%60%60java+static%20%7B+DEFAULT_DATABASE%20=%20DATABASE_MYSQL;%20%20//%20TODO%20%E9%BB%98%E8%AE%A4%E6%95%B0%E6%8D%AE%E5%BA%93%E7%B1%BB%E5%9E%8B%EF%BC%8C%E6%94%B9%E6%88%90%E4%BD%A0%E8%87%AA%E5%B7%B1%E7%9A%84+DEFAULT_SCHEMA%20="sys"; // TODO 默认数据库名/模式，改成你自己的，默认情况是 MySQL: sys, PostgreSQL: public, SQL Server: dbo, Oracle: + } + + @Override + public String getDBVersion() { + return "5.7.22"; // "8.0.11"; // TODO 改成你自己的 MySQL 或 PostgreSQL 数据库版本号 // MYSQL 8 和 7 使用的 JDBC 配置不一样 + } + + @JSONField(serialize = false) // 不在日志打印 账号/密码 等敏感信息 @Override public String getDBUri() { - //TODO 改成你自己的 - return DATABASE_POSTGRESQL.equalsIgnoreCase(getDatabase()) ? "jdbc:postgresql://localhost:5432/postgres" : "jdbc:mysql://192.168.71.146:3306/"; + // 这个是 MySQL 8.0 及以上，要加 userSSL=false return "jdbc:mysql://localhost:3306?userSSL=false&serverTimezone=GMT%2B8&useUnicode=true&characterEncoding=UTF-8"; + // 以下是 MySQL 5.7 及以下 + return "jdbc:mysql://localhost:3306?serverTimezone=GMT%2B8&useUnicode=true&characterEncoding=UTF-8"; //TODO 改成你自己的，TiDB 可以当成 MySQL 使用，默认端口为 4000 } + + @JSONField(serialize = false) // 不在日志打印 账号/密码 等敏感信息 @Override public String getDBAccount() { - return DATABASE_POSTGRESQL.equalsIgnoreCase(getDatabase()) ? "postgres" : "root"; //TODO 改成你自己的 + return "root"; // TODO 改成你自己的 } + + @JSONField(serialize = false) // 不在日志打印 账号/密码 等敏感信息 @Override public String getDBPassword() { - return DATABASE_POSTGRESQL.equalsIgnoreCase(getDatabase()) ? null : "root"; //TODO 改成你自己的 - } - @Override - public String getSchema() { - String s = super.getSchema(); - return StringUtil.isEmpty(s, true) ? "thea" : s; //TODO 改成你自己的。例如：将"thea"替换成你自己的“数据库名字” + return "apijson"; // TODO 改成你自己的，TiDB 可以当成 MySQL 使用， 默认密码为空字符串 "" } ``` +具体见源码
+https://github.com/APIJSON/APIJSON-Demo/blob/master/APIJSON-Java-Server/APIJSONDemo/src/main/java/apijson/demo/DemoSQLConfig.java #### C-1-2.导入表 -在`APIJSON-Master/MySQL`目录下有一批SQL脚本，他们看起来是这样的 +在 [APIJSON-Demo-Master/MySQL](https://github.com/APIJSON/APIJSON-Demo/tree/master/MySQL) 目录下有一批 SQL 脚本，他们看起来是这样的 ![1542345654422](assets/1542345654422.png) +MySQLWorkbench/Datagrip/Navicat 导入表具体见： + +https://github.com/APIJSON/APIJSON-Demo/tree/master/APIJSON-Java-Server#2%E5%AF%BC%E5%85%A5%E8%A1%A8%E6%96%87%E4%BB%B6%E5%88%B0%E6%95%B0%E6%8D%AE%E5%BA%93 + 导入完成之后。我们可以把项目跑起来看下，以刚刚配置的项目，项目是否能够连上数据库。其中也有一些初始化数据，可以方便我们测试。 ### C-1-2-1.更多测试用例 如果需要更多测试用例，请按照以下步骤获取： -1、在浏览器中输入 apijson.org； -2、点击右上角的“登录”按钮登录； -3、点击“测试账号”按钮左边第二个按钮。（也就是“-”左边的第一个）获取各种测试用例 -4、欢迎大家踊跃共享自己的测试用例； -5、也欢迎大家踊跃充值，哈哈哈哈~~~~~ +1. 用 Chrome(或 Firefox 等)浏览器中打开 http://apijson.cn/api ，或者 http://apijson.cn 然后点击按钮 \[接口 APIAuto 测试] 也行； +2. 点击右上角的“登录”按钮登录； +3. 点击“测试账号”按钮左边第二个按钮，（也就是“-”左边的第一个）获取各种测试用例； +4. 欢迎大家踊跃共享自己的测试用例； + +也可以参考 APIAuto 的文档或视频： + +https://github.com/TommyLemon/APIAuto #### C-1-3.测试查询 -为了方便测试，我这里使用的Chrome浏览器的Restlet Client插件，大家可以根据自己的喜好使用不同的工具测试。 +为了方便测试，我这里使用的 Chrome 浏览器的 Restlet Client 插件，大家可以根据自己的喜好使用不同的工具测试。 -使用` http://localhost:8080/get`测试结果。（请注意 APIJSONApplication.java 中使用 Tomcat 默认的 8080 端口，如果不小心开着PC端的“微信”，8080端口会被占用，建议改成 8081, 9090 等其它应用程序未占用的端口。） +使用 `http://localhost:8080/get` 测试结果。（请注意 DemoApplication.java 中使用 Tomcat 默认的 8080 端口，如果不小心开着PC端的“微信”，8080 端口会被占用，建议改成 8081, 9090 等其它应用程序未占用的端口。） -随便找一个表，比如`Moment`表，我们取其中ID为12的一条出来看看 +随便找一个表，比如 `Moment` 表，我们取其中 id 为 12 的一条出来看看 ![1542350018926](assets/1542350018926.png) -对接口地址`http://localhost:8080/get`发送一个JSON格式的请求 +对接口地址 `http://localhost:8080/get` 发送一个 JSON 格式的请求 ![1542350219020](assets/1542350219020.png) @@ -190,7 +232,7 @@ xsi:schemaLocation="http://maven.apache.org/POM/4.0.0%20http://maven.apache.org/xs%20%20#####%20%E5%AD%97%E6%AE%B5%E8%BF%87%E6%BB%A4%20-%E8%BF%99%E9%87%8C%E8%BF%99%E4%B9%88%E5%A4%9A%E5%AD%97%E6%AE%B5%EF%BC%8C%E5%A6%82%E6%9E%9C%E6%88%91%E5%8F%AA%E6%83%B3%E8%A6%81%E8%BF%99%E4%B8%AA%60content%60%E5%AD%97%E6%AE%B5%E7%9A%84%E4%BF%A1%E6%81%AF%E6%80%8E%E4%B9%88%E5%8A%9E%EF%BC%9F+%E8%BF%99%E9%87%8C%E8%BF%99%E4%B9%88%E5%A4%9A%E5%AD%97%E6%AE%B5%EF%BC%8C%E5%A6%82%E6%9E%9C%E6%88%91%E5%8F%AA%E6%83%B3%E8%A6%81%E8%BF%99%E4%B8%AA%20%60content%60%20%E5%AD%97%E6%AE%B5%E7%9A%84%E4%BF%A1%E6%81%AF%E6%80%8E%E4%B9%88%E5%8A%9E%EF%BC%9F%20%20%E4%BD%A0%E5%8F%AF%E4%BB%A5%E8%BF%99%E6%A0%B7%E8%AF%B7%E6%B1%82%EF%BC%9A%20@@%20-215,7%20+257,7%20@@%20xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xs } ``` -`@column`表示你要筛选出的字段，如果是多个字段可以这样写`"@column":"id,date,content"` +`@column` 表示你要筛选出的字段，如果是多个字段可以这样写 `"@column":"id,date,content"` @@ -233,13 +275,13 @@ xsi:schemaLocation="http://maven.apache.org/POM/4.0.0%20http://maven.apache.org/xs%20%7D%20%60%60%60%20-%E8%BF%99%E6%A0%B7%E5%9C%A8%E8%BF%94%E5%9B%9E%E7%9A%84%E6%95%B0%E6%8D%AE%E4%B8%AD%60date%60%E5%AD%97%E6%AE%B5%E5%B0%B1%E5%8F%98%E6%88%90%E4%BA%86%60time%60%EF%BC%8C%60content%60%E5%AD%97%E6%AE%B5%E5%8F%98%E6%88%90%E4%BA%86%60text%60%E3%80%82+%E8%BF%99%E6%A0%B7%E5%9C%A8%E8%BF%94%E5%9B%9E%E7%9A%84%E6%95%B0%E6%8D%AE%E4%B8%AD%20%60date%60%20%E5%AD%97%E6%AE%B5%E5%B0%B1%E5%8F%98%E6%88%90%E4%BA%86%20%60time%60,%20%60content%60%20%E5%AD%97%E6%AE%B5%E5%8F%98%E6%88%90%E4%BA%86%20%60text%60%E3%80%82%20%20%20%20#####%20%E9%80%BB%E8%BE%91%E8%BF%90%E7%AE%97%20-%E5%A6%82%E6%9E%9C%E6%83%B3%E8%A6%81%E7%AD%9B%E9%80%89%E5%87%BA%EF%BC%8CID%E5%9C%A8%6012,15,32%60%E4%B8%AD%E7%9A%84%E8%BF%99%E4%B8%89%E6%9D%A1%E6%95%B0%E6%8D%AE%E7%9A%84%60%E6%97%A5%E6%9C%9F%60%E5%92%8C%60%E5%86%85%E5%AE%B9%60%E6%80%8E%E4%B9%88%E5%8A%9E%E5%91%A2%EF%BC%9F+%E5%A6%82%E6%9E%9C%E6%83%B3%E8%A6%81%E7%AD%9B%E9%80%89%E5%87%BA%EF%BC%8Cid%20%E5%9C%A8%20%6012,15,32%60%20%E4%B8%AD%E7%9A%84%E8%BF%99%E4%B8%89%E6%9D%A1%E6%95%B0%E6%8D%AE%E7%9A%84%60%E6%97%A5%E6%9C%9F%60%E5%92%8C%60%E5%86%85%E5%AE%B9%60%E6%80%8E%E4%B9%88%E5%8A%9E%E5%91%A2%EF%BC%9F%20%20%E8%AF%B7%E6%B1%82%EF%BC%9A%20@@%20-287,25%20+329,25%20@@%20xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xs -如果所要筛选的数据的是在一定范围内的，比如ID是300到400之间的 +如果所要筛选的数据的是在一定范围内的，比如 id 是 300 到 400 之间的 -你可以这样过滤`"id&{}":">=300,<=400"` +你可以这样过滤 `"id&{}":">=300,<=400"` &的作用是表明后面的两个过滤条件的逻辑关系 ```sql -(ID >= 300 AND ID <= 500) +(id >= 300 AND id <= 500) ``` 现在的逻辑符号一共有三种，`&`，`|`，`!` -默认的逻辑关系是`|`，也就是说`"id|{}":"<=300,>=400"`和`"id{}":"<=300,>=400"`等价。 +默认的逻辑关系是 `|`，也就是说 `"id|{}":"<=300,>=400"` 和 `"id{}":"<=300,>=400"` 等价。 `!`主要用于反选，黑名单之类的 -`"id!{}":[12,15,32]`表示`id`不在12，15，32内的其他数据。 +`"id!{}":[12,15,32]` 表示 `id` 不在 12，15，32 内的其他数据。 复杂一些，如果多个条件相互组合，可以写多个关于id的过滤条件 @@ -321,7 +363,7 @@ xsi:schemaLocation="http://maven.apache.org/POM/4.0.0%20http://maven.apache.org/xs%20%7D%20%60%60%60%20-%E6%AF%94%E5%A6%82%E8%BF%99%E9%87%8C%E8%A1%A8%E7%A4%BAid%E5%9C%A810%E5%88%B040%E4%B9%8B%E9%97%B4%EF%BC%8C%E4%BD%86%E6%98%AF%E5%8D%B4%E4%B8%8D%E5%8C%85%E5%90%AB12%E7%9A%84%E6%95%B0%E6%8D%AE%E3%80%82+%E6%AF%94%E5%A6%82%E8%BF%99%E9%87%8C%E8%A1%A8%E7%A4%BA%20id%20%E5%9C%A8%2010%20%E5%88%B0%2040%20%E4%B9%8B%E9%97%B4%EF%BC%8C%E4%BD%86%E6%98%AF%E5%8D%B4%E4%B8%8D%E5%8C%85%E5%90%AB%2012%20%E7%9A%84%E6%95%B0%E6%8D%AE%E3%80%82%20%20%20@@%20-340,15%20+382,15%20@@%20xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xs 使用方式有多种： -`keyword%`，以`keyword`开头的字符串。 +`keyword%`，以 `keyword` 开头的字符串。 -`%keyword`，以`keyword`结束的字符串。 +`%keyword`，以 `keyword` 结束的字符串。 -`%keyword%`，包含`keyword`的字符串，如：`keyword123`、`123keyword`、`123keyword123` +`%keyword%`，包含 `keyword` 的字符串，如：`keyword123`, `123keyword`, `123keyword123` -`%k%e%y%`，包含字母`k`,`e`,`y`的字符串 +`%k%e%y%`，包含字母 `k`, `e`, `y` 的字符串 -还有几种比较便捷的方式，我们这里如果使用`"content~":"keyword"`来代替`"content$":"%keyword%"`，同样可以表示包含某字符串 +还有几种比较便捷的方式，我们这里如果使用 `"content~":"keyword"` 来代替 `"content$":"%keyword%"`，同样可以表示包含某字符串 @@ -365,7 +407,7 @@ xsi:schemaLocation="http://maven.apache.org/POM/4.0.0%20http://maven.apache.org/xs%20%7D%20%60%60%60%20-%E6%AD%A3%E5%88%99%E8%A1%A8%E8%BE%BE%E5%BC%8F%60%5E[0-9]+$%60%EF%BC%8C%E6%9F%A5%E8%AF%A2%60content%60%E4%B8%BA%E7%BA%AF%E6%95%B0%E5%AD%97%E7%9A%84%E6%95%B0%E6%8D%AE%EF%BC%8C[MySQL%E7%9A%84%E6%AD%A3%E5%88%99%E8%AF%AD%E6%B3%95](http://www.runoob.com/mysql/mysql-regexp.html)%E5%A6%82%E4%B8%8B%EF%BC%9A+%E6%AD%A3%E5%88%99%E8%A1%A8%E8%BE%BE%E5%BC%8F%20%60%5E[0-9]+$%60%EF%BC%8C%E6%9F%A5%E8%AF%A2%20%60content%60%20%E4%B8%BA%E7%BA%AF%E6%95%B0%E5%AD%97%E7%9A%84%E6%95%B0%E6%8D%AE%EF%BC%8C[MySQL%20%E7%9A%84%E6%AD%A3%E5%88%99%E8%AF%AD%E6%B3%95](http://www.runoob.com/mysql/mysql-regexp.html)%20%E5%A6%82%E4%B8%8B%EF%BC%9A%20%20|%20%E6%A8%A1%E5%BC%8F%20%20%20%20%20%20%20|%20%E6%8F%8F%E8%BF%B0%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20|%20|%20----------%20|%20------------------------------------------------------------%20|@@%20-408,7%20+450,7%20@@%20xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xs } ``` -里面的`pictureList`和`praiseUserIdList`是数组，这种数据在Mysql数据库中是JSON数据格式的。 +里面的 `pictureList` 和 `praiseUserIdList` 是数组，这种数据在 MySQL 数据库中是 JSON 数据格式的。 ![1542357146401](assets/1542357146401.png) @@ -416,7 +458,7 @@ xsi:schemaLocation="http://maven.apache.org/POM/4.0.0%20http://maven.apache.org/xs%20%20![1542357265371](assets/1542357265371.png)%20-%E5%A6%82%E6%9E%9C%E6%88%91%E4%BB%AC%E6%83%B3%E8%BF%87%E6%BB%A4%E5%87%BA%E9%87%8C%E9%9D%A2%E6%9C%89%6082001%60%E7%9A%84%E6%95%B0%E6%8D%AE%EF%BC%8C%E6%88%91%E4%BB%AC%E5%BA%94%E8%AF%A5%E8%BF%99%E6%A0%B7%E8%AF%B7%E6%B1%82+%E5%A6%82%E6%9E%9C%E6%88%91%E4%BB%AC%E6%83%B3%E8%BF%87%E6%BB%A4%E5%87%BA%E9%87%8C%E9%9D%A2%E6%9C%89%20%6082001%60%20%E7%9A%84%E6%95%B0%E6%8D%AE%EF%BC%8C%E6%88%91%E4%BB%AC%E5%BA%94%E8%AF%A5%E8%BF%99%E6%A0%B7%E8%AF%B7%E6%B1%82%20%20%60%60%60json%20%7B@@%20-431,9%20+473,9%20@@%20xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xs 结果是类似这样的，为了显示方便剔除了一些数据。 -```json +```js { - "[]": [ + "[]": [ // JavaScript/TypeScript/Python 中可用 data["[]"] 来提取不符合变量名格式的 key 对应的 value，Java 等可以用 data.getJSONArray("[]") 等。 { "Moment": { @@ -492,31 +534,31 @@ xsi:schemaLocation="http://maven.apache.org/POM/4.0.0%20http://maven.apache.org/xs%20%7D%20%60%60%60%20-%E8%AF%B7%E6%B3%A8%E6%84%8F%EF%BC%8C%E8%BF%99%E9%87%8C%E7%9A%84%60page%60%E5%92%8C%60count%60%E6%98%AF%E6%94%BE%E5%9C%A8%60[]%60%E5%86%85%E7%9A%84%E5%B1%9E%E6%80%A7%EF%BC%8C%E8%80%8C%E4%B8%8D%E6%98%AF%60Moment%60%E5%AF%B9%E8%B1%A1%E9%87%8C%E3%80%82%E8%BF%99%E9%87%8C%60count%60%E8%A1%A8%E7%A4%BA%E6%AF%8F%E9%A1%B5%E7%9A%84%E6%95%B0%E9%87%8F%EF%BC%8C%60page%60%E8%A1%A8%E7%A4%BA%E7%AC%AC%E5%87%A0%E9%A1%B5%EF%BC%8C%E9%A1%B5%E6%95%B0%E4%BB%8E0%E5%BC%80%E5%A7%8B%E7%AE%97%E3%80%82+%E8%AF%B7%E6%B3%A8%E6%84%8F%EF%BC%8C%E8%BF%99%E9%87%8C%E7%9A%84%20%60page%60%20%E5%92%8C%20%60count%60%20%E6%98%AF%E6%94%BE%E5%9C%A8%20%60[]%20%60%E5%86%85%E7%9A%84%E5%B1%9E%E6%80%A7%EF%BC%8C%E8%80%8C%E4%B8%8D%E6%98%AF%20%60Moment%60%20%E5%AF%B9%E8%B1%A1%E9%87%8C%E3%80%82%E8%BF%99%E9%87%8C%20%60count%60%20%E8%A1%A8%E7%A4%BA%E6%AF%8F%E9%A1%B5%E7%9A%84%E6%95%B0%E9%87%8F%EF%BC%8C%60page%60%20%E8%A1%A8%E7%A4%BA%E7%AC%AC%E5%87%A0%E9%A1%B5%EF%BC%8C%E9%A1%B5%E6%95%B0%E4%BB%8E%200%20%E5%BC%80%E5%A7%8B%E7%AE%97%E3%80%82%20%20%E4%B9%9F%E8%AE%B8%E4%BD%A0%E6%83%B3%E7%9C%8B%E7%9C%8B%E8%BF%99%E4%B8%AA%E8%AF%B7%E6%B1%82%E5%AF%B9%E5%BA%94%E7%9A%84SQL%E8%AF%AD%E5%8F%A5%20%20%60%60%60sql-SELECT%20%60id%60,%60date%60,%60content%60,%60praiseUserIdList%60%20FROM%20%60thea%60.%60Moment%60%20LIMIT%205%20OFFSET%200+SELECT%20%60id%60,%60date%60,%60content%60,%60praiseUserIdList%60%20FROM%20%60sys%60.%60Moment%60%20LIMIT%205%20OFFSET%200%20%60%60%60%20-%E8%BF%99%E9%87%8C%60thea%60%E6%98%AF%E6%88%91%E8%87%AA%E5%B7%B1%E7%9A%84%60schema%60%E7%9A%84%E5%90%8D%E5%AD%97%EF%BC%8C%E4%BD%A0%E7%9A%84%E5%8F%AF%E8%83%BD%E4%BC%9A%E6%9C%89%E6%89%80%E4%B8%8D%E5%90%8C%E3%80%82+%E8%BF%99%E9%87%8C%60sys%60%E6%98%AF%E6%88%91%E8%87%AA%E5%B7%B1%E7%9A%84%60schema%60%E7%9A%84%E5%90%8D%E5%AD%97%EF%BC%8C%E4%BD%A0%E7%9A%84%E5%8F%AF%E8%83%BD%E4%BC%9A%E6%9C%89%E6%89%80%E4%B8%8D%E5%90%8C%E3%80%82%20%20%E5%A6%82%E6%9E%9C%E4%B8%8D%E6%83%B3%E5%88%86%E9%A1%B5%E7%9A%84%EF%BC%8C%E4%B9%9F%E6%8F%90%E4%BE%9B%E4%BA%86%E4%B8%80%E5%A5%97%E7%89%B9%E6%AE%8A%E7%9A%84%E6%9F%A5%E8%AF%A2%E6%96%B9%E5%BC%8F%E3%80%82%E8%BF%99%E7%A7%8D%E6%9F%A5%E8%AF%A2%E6%96%B9%E5%BC%8F%E6%9C%89%E4%B8%89%E7%A7%8D%EF%BC%8C%E8%AF%B7%E6%B1%82%E6%96%B9%E5%BC%8F%E7%B1%BB%E5%9E%8B%E8%BF%99%E6%A0%B7%20-%60%60%60json+%60%60%60js%20%7B"[]": { "Moment":{ "@column":"id,date,content,praiseUserIdList" }, - "query": 2 + "query": 2 }, - "total@":"/[]/total" + "total@":"/[]/total" // key 里的 total 可改成 num 等几乎任意其它名称，还可以用 "info@": "/[]/info" 获取更详细的分页信息 } ``` -这里因为`query`的值是2，所有会查询`Moment`表中所有的数据。如果是1的话，则会返回当前表的总数 +这里因为 `query` 的值是 2，所有会同时查询 `Moment` 表中的数据和总数。如果是 1 的话，则只会返回当前表的总数： ```json {"total":59,"code":200,"msg":"success"} @@ -539,7 +581,7 @@ SELECT `id`,`date`,`content`,`praiseUserIdList` FROM `thea`.`Moment` LIMIT 5 OFF "@column":"id,date,content,praiseUserIdList", "praiseUserIdList<>":38710 }, - "query": 1 + "query": 1 }, "total@":"/[]/total" } @@ -569,42 +611,42 @@ SELECT `id`,`date`,`content`,`praiseUserIdList` FROM `thea`.`Moment` LIMIT 5 OFF } ``` -`"@order":"date-,id,content+"`其中，字段的前后顺序表示字段排序的优先级。`id`和`id+`是等价的，默认就是升序排列。`date-`表示将`date`字段降序排列。 +`"@order": "date-,id,content+"` 其中，字段的前后顺序表示字段排序的优先级。`id` 和 `id+` 是等价的，默认就是升序排列。`date-` 表示将 `date` 字段降序排列。 ##### 关联查询 在讲解关联查询的时候，我们需要先了解下表之间的关系 -现在有两张表USER和MOMENT，两张表的关系是下面这样 +现在有两张表 Moment 和 User，两张表的关系是下面这样 ![1545468294295](assets/1545468294295.png) -MOMENT表示动态，类似微信朋友圈、QQ空间的动态，每一条动态会有一个发表动态的用户USER，所以MOMENT表里会有一个USER表的外键关联 +MOMENT表示动态，类似微信朋友圈、QQ 空间的动态，每一条动态会有一个发表动态的用户 User，所以 Moment 表里会有一个和 User 表的外键关联：Moment.userId = User.id。 对于这样的数据关系，我们在查询动态时，很多时候我们会连带着用户一起查处来，这样又如何操作呢 -```json +```js { "[]": { "Moment":{ "@column":"id,date,userId", - "id":12 - }, + "id":12 // 注意 id 是主键，这个数组最多返回 1 条子项（如果 id=12 的表记录存在） + }, "User":{ - "id@":"/Moment/userId", + "id@":"/Moment/userId", // 不要求物理外键，只要能关联即可 "@column":"id,name" } } } ``` -这个请求稍微复杂点，首先我们用`[]`对象表示我们是想查询出一个列表，这个列表包含两个部分`Moment`和`User`。 +这个请求稍微复杂点，首先我们用 `[]` 对象表示我们是想查询出一个列表，这个列表包含两个部分 `Moment` 和 `User`。 -其中`Moment`是我们想要查询的主要内容，它的写法也和一般查询数据时无异。 +其中 `Moment` 是我们想要查询的主要内容，它的写法也和一般查询数据时无异。 -`User`是与`Moment`相关联的数据，所以查询的时候我们需要用`id@`来表示他们之间的关联关系 +`User` 是与 `Moment` 相关联的数据，所以查询的时候我们需要用 `id@` 来表示他们之间的关联关系 -`/Moment/userId`中，最开始的`/`相当于是指明了`[]`的位置，`/Moment`表示`[]`对象下的`Moemnt`对象，`/Moment/userId`表示`Moemnt`的`userId`字段是与`User`的`id`关联的。这是一种缺省引用路径，这里等价于完整引用路径 `[]/Moment/userId`。 +`/Moment/userId` 中，最开始的 `/` 相当于是指明了 `[]` 的位置，`/Moment` 表示 `[]` 对象下的 `Moemnt` 对象，`/Moment/userId` 表示 `Moment` 的 `userId` 字段是与 `User` 的 `id` 关联的。这是一种缺省引用路径，这里等价于完整引用路径 `[]/Moment/userId`。 响应的数据： @@ -632,7 +674,7 @@ MOMENT表示动态，类似微信朋友圈、QQ空间的动态，每一条动态 ##### 分组查询 -在了解分组查询之前，我们需要先了解下APIJSON所支持的函数 +在了解分组查询之前，我们需要先了解下 APIJSON 所支持的部分常见函数： | 函数名 | 说明 | | ------ | -------------------------- | @@ -642,6 +684,10 @@ MOMENT表示动态，类似微信朋友圈、QQ空间的动态，每一条动态 | min | 统计分组下，某字段的最小值 | | avg | 统计分组下，某字段的平均值 | +具体见 AbstractSQLConfig 中 SQL_FUNCTION_MAP 配置的所有 SQL 函数 ： + +https://github.com/Tencent/APIJSON/blob/master/APIJSONORM/src/main/java/apijson/orm/AbstractSQLConfig.java#L286-L765 + 比如，如果只是单纯的查出最大值，这样请求就可以了 ```json @@ -664,13 +710,13 @@ MOMENT表示动态，类似微信朋友圈、QQ空间的动态，每一条动态 } ``` -这里`maxid`是我们取的别名 +这里 `maxid` 是我们取的别名 -如果是有分组条件的，那我们需要使用`@group` +如果是有分组条件的，那我们需要使用 `@group` -比如，像下面SALE表，这张表表示，2018年1月1日某公司门下的3个店铺（STORE_ID）的营业额（AMT）数据 +比如，像下面 Sale 表，这张表表示，2018年1月1日某公司门下的 3 个店铺（store_id）的营业额（amt）数据 -| ID | STORE_ID | AMT | +| id | store_id | amt | | ---- | -------- | ---- | | 1 | 1 | 100 | | 2 | 1 | 80 | @@ -678,13 +724,13 @@ MOMENT表示动态，类似微信朋友圈、QQ空间的动态，每一条动态 | 4 | 2 | 100 | | 5 | 3 | 210 | -如果，我们想要计算出这天每个店铺一共卖了多少，我们通过APIJSON可以这样查询 +如果，我们想要计算出这天每个店铺一共卖了多少，我们通过 APIJSON 可以这样查询 ``` { "[]": { "Sale":{ - "@column":"store_id,sum(amt):totAmt", + "@column":"store_id;sum(amt):totAmt", // 注意 SQL 函数要用分号 ; 隔开 "@group":"store_id" } } @@ -695,7 +741,7 @@ MOMENT表示动态，类似微信朋友圈、QQ空间的动态，每一条动态 如果没有登录，由于权限的限制，是需要登录的。 -登录地址`http://127.0.0.1:8080/login`，发送请求 +登录地址 `http://localhost:8080/login` 或 `http://127.0.0.1:8080/login`，发送请求 ```json { @@ -704,7 +750,7 @@ MOMENT表示动态，类似微信朋友圈、QQ空间的动态，每一条动态 } ``` -账号和密码，可以到`apijson_user`里面查询 +账号和密码，可以到 `apijson_privacy` 里面查询 #### C-1-5.测试新增 @@ -724,7 +770,7 @@ MOMENT表示动态，类似微信朋友圈、QQ空间的动态，每一条动态 } ``` -`tag`是我们在`request`表里面配置的`tag`字段。 +`tag` 是我们在 `Request` 表里面配置的 `tag` 字段。 响应 @@ -741,7 +787,7 @@ MOMENT表示动态，类似微信朋友圈、QQ空间的动态，每一条动态 } ``` -返回的`id`是新增的数据的新id +返回的 `id` 是新增的数据的新主键值 #### C-1-4.测试修改 @@ -776,7 +822,7 @@ MOMENT表示动态，类似微信朋友圈、QQ空间的动态，每一条动态 } ``` -如果要对`json`类型操作的话，这样请求 +如果要对 `json` 类型操作的话，这样请求 ```json { @@ -788,9 +834,9 @@ MOMENT表示动态，类似微信朋友圈、QQ空间的动态，每一条动态 } ``` -这里的`praiseUserIdList`是一个`json`类型的字段，在操作之前它是空的`[]`，提交以后它是`[123]`，如果再添加一个21，则会变成`[123,21]` +这里的 `praiseUserIdList` 是一个 `json` 类型的字段，在操作之前它是空的 `[]`，提交以后它是 `[123]`，如果再添加一个 21，则会变成 `[123,21]` -要删除其中的值，把`+`变成`-`即可 +要删除其中的值，把 `+` 变成 `-` 即可。如果没有 `+`, `-` 符号，"praiseUserIdList": \[123] 将直接替换原本的值，可能丢失数据。 #### C-1-5.测试删除 @@ -811,7 +857,7 @@ MOMENT表示动态，类似微信朋友圈、QQ空间的动态，每一条动态 #### 1. 后台添加数据表 -在自己的数据库里新增一个表，比如我这里新增`b_stone` +在自己的数据库里新增一个表，比如我这里新增 `b_stone` ```sql -- 原石 @@ -827,7 +873,7 @@ CREATE TABLE `b_stone` ( `modifydate` timestamp DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP COMMENT '修改时间', `modifier` varchar(80) NULL, PRIMARY KEY (`id`) -)ENGINE=InnoDB DEFAULT CHARSET=utf8; +) ENGINE=InnoDB DEFAULT CHARSET=utf8; ``` #### 2. 配置权限 @@ -843,9 +889,9 @@ APIJSON 3.7.0  版开始，依赖了 apijson-framework.jar 的不需要写任 ~~如果低于 3.7.0 或者未依赖 apijson-framework.jar，而是直接依赖 apijson-orm.jar，则需要编写代码：~~ -##### ~~2.1）在Model中添加对象并配置权限~~ +##### ~~2.1）在 Model 中添加对象并配置权限~~ -~~项目的model目录下，新增一个类~~ +~~项目的 model 目录下，新增一个类~~ ```java package apijson.demo.server.model; @@ -863,7 +909,7 @@ public class Stone { ~~由于我们的类名和数据库表名不一致，需要注册一下。如果一样就不需要了。~~ -~~设置数据库的实际表名`DemoSQLConfig`，38行~~ +~~设置数据库的实际表名 `DemoSQLConfig`，38 行~~ ```java //表名映射，隐藏真实表名，对安全要求很高的表可以这么做 @@ -878,7 +924,7 @@ public class Stone { ~~注册权限是必须的，这样程序才能使用你配置的类权限去管理你的接口~~ -~~脚本`DemoVerifier.java`的48行~~ +~~脚本 `DemoVerifier.java` 的 48 行~~ ```java static { //注册权限 @@ -899,25 +945,25 @@ static { //注册权限 "type{}":[0,1,2] } ``` -就能校验 type 的值是不是 0，1，2中的一个。
+就能校验 type 的值是不是 0，1，2 中的一个。
还有
```js "VERIFY": { "money&{}":">0,<=10000" } //自动验证是否 money>0 & money<=10000 -"TYPE": { "balance": "Double" } //自动验证balance类型是否为Double -"UNIQUE": "phone" //强制phone的值为数据库中没有的 -"NECESSARY": "id,name" //强制传id,name两个字段 -"DISALLOW": "balance" //禁止传balance字段 -"INSERT": { "@role": "OWNER" } //如果没传@role就自动添加 +"TYPE": { "balance": "DECIMAL" } //自动验证 balance 类型是否为 DECIMAL（对应 Double 双精度浮点数） +"UNIQUE": "phone" //强制 phone 的值为数据库中没有的 +"NECESSARY": "id,name" //强制传 id,name 两个字段 +"DISALLOW": "balance" //禁止传 balance 字段 +"INSERT": { "@role": "OWNER" } //如果没传 @role 就自动添加 "UPDATE": { "id@": "User/id" } //强制放入键值对 ``` -全部操作符见 [Operation.java](https://github.com/APIJSON/APIJSON/blob/master/APIJSON-Java-Server/APIJSONORM/src/main/java/apijson/orm/Operation.java) 的注释 +全部操作符见 [Operation.java](https://github.com/Tencent/APIJSON/blob/master/APIJSONORM/src/main/java/apijson/orm/Operation.java) 的注释

-:first_quarter_moon_with_face:此处的介绍都只是简要介绍，只是为了引导刚刚接触APIJSON的道友快速了解APIJSON，并不代表APIJSON只有这些功能，具体功能详情参考下列图表 +:first_quarter_moon_with_face:此处的介绍都只是简要介绍，只是为了引导刚刚接触 APIJSON 的道友快速了解 APIJSON，并不代表 APIJSON 只有这些功能，具体功能详情参考下列图表 #### 4. 完整功能图表 -https://github.com/TommyLemon/APIJSON/blob/master/Document.md#3 +https://github.com/Tencent/APIJSON/blob/master/Document.md#3