diff --git a/README.md b/README.md index 3ecc3eb..1348e2b 100644 --- a/README.md +++ b/README.md @@ -1,50 +1,406 @@ # APIJSONParser -> 参考项目[APIJSON](https://github.com/TommyLemon/APIJSON)设计的一款编译SQL编译器框架，现已初步实现APIJSON格式的JSON到SQL的转换 +> 参考项目[APIJSON](https://github.com/TommyLemon/APIJSON)设计的一款编译SQL编译器框架，现已实现APIJSON格式的JSON到SQL的转换 -详细文档，计划2019年1月1日左右更新 +## 简介 +在APIJSON程序中，主要分三步：权限判断，解析生成SQL，包装成制定格式的响应 -## 未来 +APIJSONParser是其中**解析生成SQL**过程的一个工具类，提供将制定格式的JSON对象转化生成一条标准的SQL，如果你想自定义格式，底层的框架也完全支持你进行自由扩展。 -1. 现在的程序是写死的，处理逻辑能以链的形式组合就好了 +假设一个JSON是这样的： -@pipe("name") +```json +{ + "Product":{ + "id":"1" + } +} +``` + +将上述的JSON解析到一个叫`obj`的`JSONObject`中，经过以下代码： + +```java +APIJSONProvider apijsonProvider = new APIJSONProvider(obj); //一个APIJSON解析器拿到一个json对象 +apijsonProvider.setStatementType(StatementType.SELECT); //当前为查询模式，还支持新增，修改，删除 +SQLExplorer builder = new SQLExplorer(apijsonProvider); //装载APIJSON解析器 +System.out.println(builder.getSQL());//拿到SQL +``` + +之后会打印这样一句SQL + +```sql +SELECT Product.* +FROM Product Product +WHERE (Product.id = '1') +``` + +通过对比，我们很容易发现，其中的奥秘。JSON中`Product`是指表名，而其中的`id`则是它的过滤条件。这里你可能会有一些疑惑，比如注入之类的安全问题。解析器的在进行解析的时候，会进行严格的格式检查，诚然这将会牺牲一些效率和SQL本身的灵活性。 + + + +如果你觉得这里的别名很怪异，想自己定义，你可以这样： + +```json +{ + "Product:p":{ + "id":"1" + } +} +``` + +结果： + +```sql +SELECT p.* +FROM Product p +WHERE (p.id = '1') +``` + + + + + +这里我们查询出来的是`id`为1的数据的所有字段，如果我们想要部分字段怎么办？ + +```json +{ + "Product:p":{ + "@column":"id,code,name", + "id":"1" + } +} +``` + +结果： + +```sql +SELECT p.id, p.code, p.name +FROM Product p +WHERE (p.id = '1') +``` -如果能够自动装配的话，最好有一个 -2. 使用Mybatis别名的技巧来实现自动装配 + + + +倘若，你想要给表加别名一样给字段也加个别名 ```json { - "T":{ - "@column":"a,b,c" - }, - "T2":{ - "@parent":"T" - "@column":"d,e,f" - } -} + "Product:p":{ + "@column":"id,code,name:productName", + "id":"1" + } +} +``` + +结果： + +```sql +SELECT p.id, p.code, p.name as productName +FROM Product p +WHERE (p.id = '1') ``` -查询结果： + + + + +到现在为止，我们都是以`id`为1作为过滤条件的，其他还有很多过滤方法。 + +对于一个数值字段，我们要找出价格（price）300元以上的商品，我们可以这样 ```json - { - "T":{ - "a":"a", - "b":"b", - "c":"c", - "T2":{ - "d":"d", - "e":"e", - "f":"f" - } - } - } +{ + "Product:p":{ + "@column":"id,code,name,price", + "price{}":">300" + } +} ``` -3. 表，字段的黑白名单放出来，作为 +结果： + +```sql +SELECT p.id, p.code, p.name, p.price +FROM Product p +WHERE (p.price > 300) +``` + + + + + +这里的`{}`表示你查询的是一个范围，如果你有多个范围。除了这里演示的`>`，自然你也可以使用`<`，`<=`，`>`，`>=`，`=` + +```json +{ + "Product:p":{ + "@column":"id,code,name,price", + "price{}":">300,<1200" + } +} +``` + +结果： + +```sql +SELECT p.id, p.code, p.name, p.price +FROM Product p +WHERE (p.price > 300 AND p.price < 1200) +``` + + + + + +现在我们查询的范围是，300 < price < 1200，如果想要找，price <= 300或者price >= 1200的数据。 + +```json +{ + "Product:p":{ + "@column":"id,code,name,price", + "price|{}":">300,<1200" + } +} +``` + +结果： + +```sql +SELECT p.id, p.code, p.name, p.price +FROM Product p +WHERE (p.price > 300 OR p.price < 1200) +``` + + + + + +`{}`的另外一种用法是IN，只需要你`{}`的字段的值的类型的JSONArray。 + +例如，我们的商品`Product`有一个品牌的字段`brand_id`，这是一个品牌表（Brand）的外键字段，我们想选择某一部分的品牌的商品出来 + +```json +{ + "Product:p":{ + "@column":"id,code,name,price", + "brand_id{}": [1,4,5] + } +} +``` + +结果： + +```sql +SELECT p.id, p.code, p.name, p.price +FROM Product p +WHERE (p.brand_id IN [1, 4, 5]) +``` + + + + + +如果要排除某些品牌，你可以 + +```json +{ + "Product:p":{ + "@column":"id,code,name,price", + "brand_id!{}": [1,4,5] + } +} +``` + +结果： + +```sql +SELECT p.id, p.code, p.name, p.price +FROM Product p +WHERE (p.brand_id NOT IN [1, 4, 5]) +``` + +此功能同样支持文本字段 + + + + + +如果想查看商品名称字段`name`包含某一子串`双11`的商品 + +```json +{ + "Product:p":{ + "@column":"id,code,name,price", + "name~": "双11" + } +} +``` + +结果： + +```sql +SELECT p.id, p.code, p.name, p.price +FROM Product p +WHERE (p.name LIKE '%双11%') +``` + + + + + +如果你想自己调控`%`，也可以直接使用。 + +```json +{ + "Product:p":{ + "@column":"id,code,name,price", + "name$": "%双11" + } +} +``` + +结果： + +```sql +SELECT p.id, p.code, p.name, p.price +FROM Product p +WHERE (p.name LIKE '%双11') +``` + +`%`放哪里，你可以自己决定。 + + + + + +想使用正则的话 + +```json +{ + "Product:p":{ + "@column":"id,code,name,price", + "code?": "^[0-9]+$" + } +} +``` + +结果： + +```sql +SELECT p.id, p.code, p.name, p.price +FROM Product p +WHERE ( regexp_like(p.code,'^[0-9]+$')) +``` + +介于不同的数据库，函数名有一些区别，可按实际情况修改。`APIJSONProvider`类`345`行，进行修改。 + + + + + +如果你想要排序，你可以这样 + +```json +{ + "Product:p":{ + "@column":"id,code,name,price", + "name~": "双11", + "@orders": "price-" + } +} +``` + +结果： + +```json +SELECT p.id, p.code, p.name, p.price +FROM Product p +WHERE (p.name LIKE '%双11%') +ORDER BY p.price DESC +``` + +`-`表示降序，`+`表示增序。以上查询的是双11商品价格从高到底的列表 + + + + + +有时我们也要进行分组操作，比如找出双11商品中的最贵的商品 + +```json +{ + "Product:p":{ + "@column":"name,max(price):max_price", + "name~": "双11", + "@group": "name" + } +} +``` + +结果： + +```sql +SELECT p.name, max(p.price) as max_price +FROM Product p +WHERE (p.name LIKE '%双11%') +GROUP BY p.name +``` + +目前允许的函数没有进行控制，所有的单一参数的函数都可以使用。 + + + + + +单表查询的内容基本介绍完了。 + +接下来是多表查询，后续文档内容敬请期待。 + + + + + + + + + + + + + + + + +## 速查 + +### 查询 + +#### 别名 + +表的别名 + +```json +{ + "Table:t":{} +} +``` + +字段的别名 + +```json +{ + "Table:t":{ + "@column":"columnName:columnAliasName,.." + } +} +``` + + + +### 新增 -4. 权限的控制通过 +### 修改 - \ No newline at end of file +### 删除 \ No newline at end of file diff --git a/src/main/java/zuo/biao/apijson/parser/APIJSONProvider.java b/src/main/java/zuo/biao/apijson/parser/APIJSONProvider.java index 18bb3ac..83ed32e 100644 --- a/src/main/java/zuo/biao/apijson/parser/APIJSONProvider.java +++ b/src/main/java/zuo/biao/apijson/parser/APIJSONProvider.java @@ -180,7 +180,7 @@ public List getSelect() { * 多值："id{}" : [1,2,3] 即 id IN (1,2,3) * 多值："id!{}" : [1,2,3] 即 id NOT IN (1,2,3) * 模糊："content~":"keyword" 即字段content包含字符串keyword - * 模糊："content~":"%keyword" 同样是模糊查询，%放出来自己操控 + * 模糊："content$":"%keyword" 同样是模糊查询，%放出来自己操控 * 正则："content?":"^[0-9]+$" 后面填写正则即可 * 外键："id@":"/外键表/外键字段" */ @@ -284,7 +284,7 @@ public List getWhere() { for(int i = 0; i < array.size(); i++) { Object obj = array.get(i); if(i != 0) { - limit += ","; + limit += ", "; } if( obj instanceof Integer || obj instanceof Float || @@ -302,7 +302,7 @@ public List getWhere() { for(int i = 0; i < array.size(); i++) { Object obj = array.get(i); if(i != 0) { - limit += " , "; + limit += ", "; } if( obj instanceof Integer || obj instanceof Float || @@ -327,11 +327,11 @@ public List getWhere() { error(condition +"的值必须要是字符串"); return null; } - }else if(condition.matches("\\w+$")) { + }else if(condition.matches("\\w+\\$")) { //字符串查询，LIKE if(propertis.get(condition) instanceof String) { String exp = (String)propertis.get(condition); - String columnName = condition.replaceAll("$", ""); + String columnName = condition.replaceAll("\\$", ""); list.add(tableAliasName + "." + columnName + " LIKE '" + exp.replaceAll("'", "''") + "'" ); }else { error(condition +"的值必须要是字符串"); diff --git a/src/main/java/zuo/biao/apijson/parser/App.java b/src/main/java/zuo/biao/apijson/parser/App.java index d623df2..06c74db 100644 --- a/src/main/java/zuo/biao/apijson/parser/App.java +++ b/src/main/java/zuo/biao/apijson/parser/App.java @@ -14,11 +14,11 @@ public static void main( String[] args ) throws SQLProviderException { long st = System.currentTimeMillis(); String json = "{\r\n" + - " \"Retail\":{\r\n" + - " \"id\": 1,\r\n" + - " \"amt\": 1,\r\n" + - " \"@column\": \"id,cc\"\r\n" + - " }\r\n" + + " \"Product:p\":{\r\n" + + " \"@column\":\"name,max(price):max_price\",\r\n" + + " \"name~\": \"双11\",\r\n" + + " \"@group\": \"name\"\r\n" + + " }\r\n" + "}"; JSONObject req = JSONObject.parseObject(json); long fastJsonet = System.currentTimeMillis(); @@ -30,7 +30,7 @@ public static void main( String[] args ) throws SQLProviderException // apijsonProvider.getTableWhiteList().add("Retail"); // apijsonProvider.getTableWhiteList().add("StorE"); // apijsonProvider.getColumnBlackList().add("retail.id"); - apijsonProvider.getColumnWhiteList().add("retail.*"); +// apijsonProvider.getColumnWhiteList().add("retail.*"); // apijsonProvider.getColumnWhiteList().add("retail.amt"); // apijsonProvider.getColumnBlackList().add("retail.amt"); // apijsonProvider.getColumnWhiteList().add("store.id"); diff --git a/target/classes/META-INF/maven/APIJSONParser/APIJSONParser/pom.properties b/target/classes/META-INF/maven/APIJSONParser/APIJSONParser/pom.properties index 1f4c4e8..b28d1ab 100644 --- a/target/classes/META-INF/maven/APIJSONParser/APIJSONParser/pom.properties +++ b/target/classes/META-INF/maven/APIJSONParser/APIJSONParser/pom.properties @@ -1,5 +1,5 @@ #Generated by Maven Integration for Eclipse -#Mon Dec 24 14:28:09 CST 2018 +#Tue Dec 25 10:09:51 CST 2018 version=0.0.1-SNAPSHOT groupId=APIJSONParser m2e.projectName=APIJSONParser diff --git a/target/classes/zuo/biao/apijson/parser/APIJSONProvider.class b/target/classes/zuo/biao/apijson/parser/APIJSONProvider.class index 6af2e6f..6345296 100644 Binary files a/target/classes/zuo/biao/apijson/parser/APIJSONProvider.class and b/target/classes/zuo/biao/apijson/parser/APIJSONProvider.class differ diff --git a/target/classes/zuo/biao/apijson/parser/App.class b/target/classes/zuo/biao/apijson/parser/App.class index 9c7cd27..64ddeda 100644 Binary files a/target/classes/zuo/biao/apijson/parser/App.class and b/target/classes/zuo/biao/apijson/parser/App.class differ