Merge branch 'master' of https://e.coding.net/biggates/java-projects/eaphone-spring-data-query.git

Author: Weihai Li

doc/Query.md

@@ -1,11 +1,11 @@
-# Why #
+# Why
 
 I use DataTables in some projects and wrote SpringMVC server side for it. Later the frontend is rewritten and DataTables is no longer used. Now is the time to refine the protocol for general data-grid query.
 
 * You can not assign a range via `columns[i][search][value]`, as in SQL: `BETWEEN`.
 * You can only do regular search OR regex search via `columns[i][search][regex]`, but not `=`, `LIKE`.
 
-## Query ##
+## Query
 
 HTTP POST as `@RequestBody` is recommended:
 
@@ -32,6 +32,7 @@ HTTP POST as `@RequestBody` is recommended:
             "_all": [],
             "_regex": "",
             "_like": "",
+            "_notlike": "",
             "_exists": true,
             "_null": true,
             "_empty": true,
@@ -41,39 +42,54 @@ HTTP POST as `@RequestBody` is recommended:
 }
 ```
 
-## Examples ##
+## Response format
 
-### Basic Query ###
+```json
+{
+    "draw": 1,
+    "total": 0,
+    "filtered": 0,
+    "error": "",
+    "data": []
+}
+```
+
+## Examples
+
+### Basic Query
 
 None of the `draw`, `offset`, `limit`, `order_by`, `where` are required, so the basic query is:
 
 ```http
-POST /search
+POST /search HTTP/1.1
+Content-Type: application/json
 
 {}
 ```
 
 e.g. NO parameters are needed.
 
-### Pagination ###
+### Pagination
 
 Paging is controlled by `offset` and `limit`, which keeps the same as `SKIP` and `LIMIT` in SQL.
 
 ```http
-POST /search
+POST /search HTTP/1.1
+Content-Type: application/json
 
 {
     "offset": 30,
     "limit": 10
 }
 ```
 
-### Ordering ###
+### Ordering
 
 Ordering by one column:
 
 ```http
-POST /search
+POST /search HTTP/1.1
+Content-Type: application/json
 
 {
     "order_by": [{
@@ -86,7 +102,8 @@ POST /search
 Ordering by more columns:
 
 ```http
-POST /search
+POST /search HTTP/1.1
+Content-Type: application/json
 
 {
     "order_by": [{
@@ -97,12 +114,13 @@ POST /search
 }
 ```
 
-### Filtering ###
+### Filtering
 
 * Search by equality
 
 ```http
-POST /search
+POST /search HTTP/1.1
+Content-Type: application/json
 
 {
     "where": {
@@ -116,7 +134,8 @@ POST /search
 * Like (`LIKE %value%`)
 
 ```http
-POST /search
+POST /search HTTP/1.1
+Content-Type: application/json
 
 {
     "where": {
@@ -130,7 +149,8 @@ POST /search
 * By Numerical Range
 
 ```http
-POST /search
+POST /search HTTP/1.1
+Content-Type: application/json
 
 {
     "where": {
@@ -146,7 +166,8 @@ POST /search
 * Date Range & Time Range
 
 ```http
-POST /search
+POST /search HTTP/1.1
+Content-Type: application/json
 
 {
     "where": {
@@ -162,7 +183,8 @@ POST /search
 * In
 
 ```http
-POST /search
+POST /search HTTP/1.1
+Content-Type: application/json
 
 {
     "where": {
@@ -173,12 +195,13 @@ POST /search
 }
 ```
 
-## Multiple Filters ##
+## Multiple Filters
 
 Multiple filters are joined by `AND` logic.
 
 ```http
-POST /search
+POST /search HTTP/1.1
+Content-Type: application/json
 
 {
     "where": {
@@ -197,6 +220,6 @@ POST /search
 
 ```
 
-## References ##
+## References
 
-* [DataTables: Server-side processing](https://datatables.net/manual/server-side)
+* [DataTables: Server-side processing](https://datatables.net/manual/server-side#Sent-parameters)

doc/Query.zh-CN.md

@@ -1,11 +1,11 @@
-# 关于查询 #
+# 关于查询
 
 在实际操作中，在 DataTables 的通信协议的基础上，遇到了一些不足，主要有以下方面：
 
 * 通过 `columns[i][search][value]` 实现的按列搜索功能，不能指定范围。比如 “指定日期范围” 或者 “大于 xx 的值” 这种场景，无法在统一的一个通信协议里传递
 * 通过 `columns[i][search][regex]` 只能指定 `普通搜索` 和 `按正则表达式搜索` 两种场景，
 
-## 查询方式 ##
+## 查询方式
 
 建议在 POST 接口上通过 `@RequestBody` 方式传入较为完整的查询内容。
 
@@ -32,6 +32,7 @@
             "_all": [],
             "_regex": "",
             "_like": "",
+            "_notlike": "",
             "_exists": true,
             "_null": true,
             "_empty": true,
@@ -41,39 +42,54 @@
 }
 ```
 
-## 示例 ##
+## 响应
 
-### 最简单的请求 ###
+```json
+{
+    "draw": 1,
+    "total": 0,
+    "filtered": 0,
+    "error": "",
+    "data": []
+}
+```
+
+## 示例
 
-因为 `draw`, `offset`, `limit`, `order_by`, `where` 全都改为可选的，因此最简单的请求就变成了
+### 最简单的请求
+
+因为 `draw`, `offset`, `limit`, `order_by`, `where` 全都改为可选的，因此最简单的请求就变成了：
 
 ```http
-POST /search
+POST /search HTTP/1.1
+Content-Type: application/json
 
 {}
 ```
 
-即：不需要任何参数。
+即：不需要传任何实际的参数。
 
-### 分页 ###
+### 分页
 
-单纯分页只需要传入 `offset` 和 `limit` 。（当然如果 `limit` 和后端一致的话也可以不传了）
+单纯分页只需要传入 `offset` 和 `limit` （当然如果 `limit` 和后端的默认值一致的话也可以不传）。
 
 ```http
-POST /search
+POST /search HTTP/1.1
+Content-Type: application/json
 
 {
     "offset": 30,
     "limit": 10
 }
 ```
 
-### 按某一列排序 ###
+### 按某一列排序
 
 最简单的排序：
 
 ```http
-POST /search
+POST /search HTTP/1.1
+Content-Type: application/json
 
 {
     "order_by": [{
@@ -85,7 +101,8 @@ POST /search
 稍微复杂一些的排序（请注意排序的顺序是有意义的，因此使用数组形式）：
 
 ```http
-POST /search
+POST /search HTTP/1.1
+Content-Type: application/json
 
 {
     "order_by": [{
@@ -96,12 +113,13 @@ POST /search
 }
 ```
 
-### 按某一列筛选 ###
+### 按某一列筛选
 
 * 精确查询
 
 ```http
-POST /search
+POST /search HTTP/1.1
+Content-Type: application/json
 
 {
     "where": {
@@ -114,8 +132,11 @@ POST /search
 
 * 模糊查询
 
+在 MongoDB 的实现中，'_like' 会使用 `$regex`, 并且按 SQL 的写法，'%' 会被替换成 '.+'。
+
 ```http
-POST /search
+POST /search HTTP/1.1
+Content-Type: application/json
 
 {
     "where": {
@@ -129,7 +150,8 @@ POST /search
 * 按数值范围
 
 ```http
-POST /search
+POST /search HTTP/1.1
+Content-Type: application/json
 
 {
     "where": {
@@ -145,7 +167,8 @@ POST /search
 * 按时间范围
 
 ```http
-POST /search
+POST /search HTTP/1.1
+Content-Type: application/json
 
 {
     "where": {
@@ -159,10 +182,11 @@ POST /search
 
 ```
 
-* 按枚举 (及 `$in` 操作)
+* 按枚举 (及 `_in` 操作)
 
 ```http
-POST /search
+POST /search HTTP/1.1
+Content-Type: application/json
 
 {
     "where": {
@@ -173,12 +197,13 @@ POST /search
 }
 ```
 
-## 复合查询 ##
+## 复合查询
 
 默认多个查询的参数之间是 `AND` 关系。
 
 ```http
-POST /search
+POST /search HTTP/1.1
+Content-Type: application/json
 
 {
     "where": {
@@ -197,6 +222,6 @@ POST /search
 
 ```
 
-## 参考 ##
+## 参考
 
-* [DataTables: Server-side processing](https://datatables.net/manual/server-side) 和相应的 [中文版](http://datatables.club/manual/server-side.html)
+* [DataTables: Server-side processing](https://datatables.net/manual/server-side#Sent-parameters) 和相应的 [中文版](http://datatables.club/manual/server-side.html)

eaphone-spring-data-query-commons/pom.xml

@@ -4,7 +4,7 @@
 	<parent>
 		<groupId>com.eaphonetech</groupId>
 		<artifactId>eaphone-spring-data-query-parent</artifactId>
-		<version>2.1.0</version>
+		<version>2.1.1</version>
 	</parent>
 
 	<artifactId>eaphone-spring-data-query-commons</artifactId>