对象支持序列化 & 单元测试多租户拦截器

Author: veasion

README.md

@@ -12,7 +12,7 @@ veasion-db 是一个轻量级持久层ORM框架，除slf4j-api外不依赖任何
 <dependency>
     <groupId>cn.veasion</groupId>
     <artifactId>veasion-db</artifactId>
-    <version>1.2.3</version>
+    <version>1.2.4</version>
 </dependency>
 ```
 支持sql解析生成veasion-db代码
@@ -61,6 +61,10 @@ public class SimpleQueryTest extends BaseTest {
         // select * from t_student where id = 1
         studentDao.getById(1L);
 
+        // 根据id查询学生性别（性别转枚举）
+        // select sex from t_student where id = 1
+        SexEnum sexEnum = studentDao.queryForType(new Q("sex").eq("id", 1), SexEnum.class);
+
         // 查询学号为s001的学生名称
         // select name from t_student where sno = 's001'
         studentDao.queryForType(new Q("name").eq("sno", "s001"), String.class);
@@ -379,7 +383,7 @@ public class InsertTest extends BaseTest {
         studentPO.setName("学生_" + s);
         studentPO.setSno("s" + s);
         studentPO.setAge(18);
-        studentPO.setSex(1);
+        studentPO.setSex(SexEnum.MALE);
         studentPO.setClassId(1L);
         studentPO.setIsDeleted(0L);
         studentPO.setVersion(0);
@@ -410,9 +414,33 @@ public class InsertTest extends BaseTest {
 前端传 { id: 1 } 自动映射成 select * from t_student where id = 1 <br>
 前端传 { id: 1, className: '三年二班' } 自动映射成 select s.* from t_student s join t_classes c on s.class_id = c.id where s.id = 1 and c.name = '三年二班' <br>
 
-具体参考单元测试 QueryCriteriaTest
+具体参考单元测试 cn.veasion.db.criteria.QueryCriteriaTest
+
+### 拦截器
+自定义拦截器可继承抽象类 cn.veasion.db.interceptor.AbstractInterceptor<br>
+
+内置：逻辑删除拦截器 cn.veasion.db.interceptor.LogicDeleteInterceptor <br>
+内置：拒绝无条件修改删除拦截器 cn.veasion.db.interceptor.UpdateDeleteNoFilterInterceptor <br>
+
+其他如租户SaaS数据隔离拦截器实现见单元测试：cn.veasion.db.interceptor.TenantInterceptor <br>
+
+需要使用上面拦截器功能可在项目 resources/META-INF/services 目录下新建 SPI 文件 cn.veasion.db.interceptor.EntityDaoInterceptor 中加入指定拦截器类，或显性调用InterceptorUtils.addInterceptor方法添加<br>
+
+具体参考单元测试代码示例。
+
+### 类型转换
+框架默认支持基本数据类型转换，其他类型可自定义扩展，SPI 实现 cn.veasion.db.utils.TypeConvert 接口<br>
+
+示例：枚举转换扩展见单元测试 cn.veasion.db.interceptor.ExtTypeConvert
+
+### 动态表名
+见 cn.veasion.db.jdbc.DefaultDynamicTableExt 加入SPI支持。<br>
+
+具体参考单元测试：cn.veasion.db.table.DynamicTableTest
 
 ### spring 项目接入 veasion-db
+推荐使用基础框架 [veasion-project-base](https://github.com/veasion/veasion-project-base) 接入
+
 SPI 实现 cn.veasion.db.jdbc.DataSourceProvider 接口
 ```java
 public class DefaultDataSourceProvider implements DataSourceProvider {

pom.xml

@@ -7,7 +7,7 @@
 
     <groupId>cn.veasion</groupId>
     <artifactId>veasion-db</artifactId>
-    <version>1.2.3</version>
+    <version>1.2.4</version>
 
     <name>veasion-db</name>
     <url>https://github.com/veasion/veasion-db</url>

src/main/java/cn/veasion/db/AbstractFilter.java

@@ -11,6 +11,7 @@
 import java.util.Collections;
 import java.util.List;
 import java.util.Objects;
+import java.util.function.Consumer;
 import java.util.stream.Collectors;
 
 /**
@@ -103,6 +104,10 @@ public T between(String field, Object value1, Object value2) {
         return addFilter(Filter.between(field, value1, value2));
     }
 
+    public T notBetween(String field, Object value1, Object value2) {
+        return addFilter(Filter.notBetween(field, value1, value2));
+    }
+
     public T andBracket(Filter... filters) {
         addFilter(Filter.leftBracket());
         addFilters(filters);
@@ -148,6 +153,11 @@ public T sqlFilter(Filter.SqlFilterHandler sqlFilterHandler, Object... values) {
         return addFilter(Filter.sqlFilter(sqlFilterHandler, values));
     }
 
+    public T exec(Consumer<T> consumer) {
+        consumer.accept(getSelf());
+        return getSelf();
+    }
+
     public List<Filter> getFilters() {
         return filters;
     }

src/main/java/cn/veasion/db/IFilter.java

@@ -1,15 +1,27 @@
 package cn.veasion.db;
 
 import cn.veasion.db.base.Filter;
+import cn.veasion.db.utils.TypeUtils;
+
+import java.io.Serializable;
 
 /**
  * IFilter
  *
  * @author luozhuowei
  * @date 2022/11/30
  */
-public interface IFilter<T> {
+public interface IFilter<T> extends Serializable {
 
     T addFilter(Filter filter);
 
+    @SuppressWarnings("unchecked")
+    default T copy() {
+        try {
+            return (T) TypeUtils.serializableCopy(this);
+        } catch (Exception e) {
+            throw new RuntimeException(e);
+        }
+    }
+
 }

src/main/java/cn/veasion/db/TableEntity.java

@@ -1,12 +1,14 @@
 package cn.veasion.db;
 
+import java.io.Serializable;
+
 /**
  * TableEntity
  *
  * @author luozhuowei
  * @date 2022/11/8
  */
-public final class TableEntity {
+public final class TableEntity implements Serializable {
 
     private String table;
 

src/main/java/cn/veasion/db/base/Expression.java

@@ -2,13 +2,15 @@
 
 import cn.veasion.db.DbException;
 
+import java.io.Serializable;
+
 /**
  * Expression
  *
  * @author luozhuowei
  * @date 2021/12/2
  */
-public class Expression {
+public class Expression implements Serializable {
 
     private String alias;
     private String expression;

src/main/java/cn/veasion/db/base/Filter.java

@@ -6,6 +6,7 @@
 import cn.veasion.db.utils.FieldUtils;
 import cn.veasion.db.utils.FilterUtils;
 
+import java.io.Serializable;
 import java.util.Arrays;
 import java.util.Collection;
 import java.util.Objects;
@@ -16,7 +17,7 @@
  * @author luozhuowei
  * @date 2021/12/1
  */
-public class Filter {
+public class Filter implements Serializable {
 
     public static Filter eq(String field, Object value) {
         return build(field, Operator.EQ, value);
@@ -170,6 +171,14 @@ public static <T, R> Filter between(LambdaFunction<T, R> fieldLambda, Object val
         return build(fieldLambda, Operator.BETWEEN, new Object[]{value1, value2}, Operator.BETWEEN.getOpt().concat(" ? AND ?"));
     }
 
+    public static Filter notBetween(String field, Object value1, Object value2) {
+        return build(field, Operator.NOT_BETWEEN, new Object[]{value1, value2}, Operator.NOT_BETWEEN.getOpt().concat(" ? AND ?"));
+    }
+
+    public static <T, R> Filter notBetween(LambdaFunction<T, R> fieldLambda, Object value1, Object value2) {
+        return build(fieldLambda, Operator.NOT_BETWEEN, new Object[]{value1, value2}, Operator.NOT_BETWEEN.getOpt().concat(" ? AND ?"));
+    }
+
     public static Filter subQuery(Operator operator, SubQueryParam subQueryParam) {
         return build((String) null, operator, Objects.requireNonNull(subQueryParam), null).special();
     }
@@ -345,6 +354,23 @@ public boolean isSpecial() {
         return special;
     }
 
+    @Override
+    public boolean equals(Object object) {
+        if (this == object) return true;
+        if (object == null || getClass() != object.getClass()) return false;
+        Filter filter = (Filter) object;
+        return Objects.equals(sql, filter.sql) &&
+                Objects.equals(field, filter.field) &&
+                operator == filter.operator &&
+                special == filter.special &&
+                Objects.equals(value, filter.value);
+    }
+
+    @Override
+    public int hashCode() {
+        return Objects.hash(field, operator, sql, value, special);
+    }
+
     @Override
     public String toString() {
         if (operator != null && value != null) {

src/main/java/cn/veasion/db/base/IBaseId.java

@@ -1,12 +1,14 @@
 package cn.veasion.db.base;
 
+import java.io.Serializable;
+
 /**
  * IBaseId
  *
  * @author luozhuowei
  * @date 2021/12/2
  */
-public interface IBaseId<ID> {
+public interface IBaseId<ID> extends Serializable {
 
     ID getId();
 

src/main/java/cn/veasion/db/base/JdbcTypeEnum.java

@@ -1,12 +1,14 @@
 package cn.veasion.db.base;
 
+import java.io.Serializable;
+
 /**
  * JdbcTypeEnum
  *
  * @author luozhuowei
  * @date 2021/12/9
  */
-public enum JdbcTypeEnum {
+public enum JdbcTypeEnum implements Serializable {
 
     INSERT,
 

src/main/java/cn/veasion/db/base/JoinType.java

@@ -1,12 +1,14 @@
 package cn.veasion.db.base;
 
+import java.io.Serializable;
+
 /**
  * JoinType
  *
  * @author luozhuowei
  * @date 2021/12/10
  */
-public interface JoinType {
+public interface JoinType extends Serializable {
 
     String getJoin();
 

src/main/java/cn/veasion/db/base/Operator.java

@@ -1,12 +1,14 @@
 package cn.veasion.db.base;
 
+import java.io.Serializable;
+
 /**
  * Operator
  *
  * @author luozhuowei
  * @date 2021/12/13
  */
-public enum Operator {
+public enum Operator implements Serializable {
 
     EQ("="),
     NEQ("<>"),
@@ -19,6 +21,7 @@ public enum Operator {
     LIKE("LIKE"),
     NOT_LIKE("NOT LIKE"),
     BETWEEN("BETWEEN"),
+    NOT_BETWEEN("NOT BETWEEN"),
     EXISTS("EXISTS"),
     NOT_EXISTS("NOT EXISTS"),
     NULL("IS NULL"),

src/main/java/cn/veasion/db/interceptor/AbstractInterceptor.java

@@ -46,23 +46,21 @@ public <R> R intercept(EntityDaoInvocation<R> invocation) {
         Object[] args = invocation.getArgs();
         if (args != null && !skip()) {
             for (Object arg : args) {
-                if (arg instanceof AbstractQuery && handleQuery) {
+                if (handleQuery && arg instanceof AbstractQuery) {
                     handleQuery((AbstractQuery<?>) arg);
-                } else if (arg instanceof AbstractUpdate && handleUpdate) {
+                } else if (handleUpdate && arg instanceof AbstractUpdate) {
                     handleUpdate((AbstractUpdate<?>) arg);
-                } else if (arg instanceof Delete && handleDelete) {
+                } else if (handleDelete && arg instanceof Delete) {
                     if (!containSkipClass(((Delete) arg).getEntityClass())) {
                         handleDelete((Delete) arg);
                     }
-                } else if (arg instanceof AbstractFilter) {
-                    if (handleAbstractFilter) {
-                        handleAbstractFilter((AbstractFilter<?>) arg);
-                    }
+                } else if (handleAbstractFilter && arg instanceof AbstractFilter) {
+                    handleAbstractFilter((AbstractFilter<?>) arg);
                 } else if (arg instanceof BatchEntityInsert) {
                     if (!containSkipClass(((BatchEntityInsert) arg).getEntityClass())) {
                         handleBatchInsert((BatchEntityInsert) arg);
                     }
-                } else if (arg instanceof EntityInsert && handleInsert) {
+                } else if (handleInsert && arg instanceof EntityInsert) {
                     EntityInsert insert = (EntityInsert) arg;
                     if (!containSkipClass(insert.getEntityClass())) {
                         handleInsert(insert.getEntityClass(), Collections.singletonList(insert.getEntity()), Collections.singletonList(insert.getFieldValueMap()));
@@ -147,11 +145,10 @@ protected void handleUpdate(AbstractUpdate<?> update) {
 
     protected void handleBatchInsert(BatchEntityInsert insert) {
         AbstractQuery<?> insertSelectQuery = insert.getInsertSelectQuery();
-        if (insertSelectQuery != null) {
-            if (handleQuery) {
-                handleQuery(insertSelectQuery);
-            }
-        } else if (handleInsert) {
+        if (handleQuery && insertSelectQuery != null) {
+            handleQuery(insertSelectQuery);
+        }
+        if (handleInsert && insert.getEntityList() != null) {
             handleInsert(insert.getEntityClass(), insert.getEntityList(), insert.getFieldValueMapList());
         }
     }