LogicalMapper实现和部分测试

Author: zoooooway

mapper/src/main/java/io/mybatis/mapper/logical/LogicalColumn.java

@@ -0,0 +1,21 @@
+package io.mybatis.mapper.logical;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+/**
+ * 标记该字段为逻辑状态列
+ * <p>NOTE: 单张表中仅支持标记一个字段</p>
+ *
+ * @author hzw
+ */
+@Retention(RetentionPolicy.RUNTIME)
+@Target(ElementType.FIELD)
+public @interface LogicalColumn {
+  /**
+   * 表示逻辑删除的值，默认为null
+   */
+  String delete() default "null";
+}

mapper/src/main/java/io/mybatis/mapper/logical/LogicalMapper.java

@@ -0,0 +1,153 @@
+package io.mybatis.mapper.logical;
+
+import io.mybatis.mapper.BaseMapper;
+import io.mybatis.mapper.example.Example;
+import io.mybatis.mapper.example.ExampleProvider;
+import io.mybatis.mapper.fn.Fn;
+import io.mybatis.mapper.fn.FnMapper;
+import io.mybatis.mapper.fn.FnProvider;
+import io.mybatis.provider.Caching;
+import org.apache.ibatis.annotations.DeleteProvider;
+import org.apache.ibatis.annotations.Lang;
+import org.apache.ibatis.annotations.SelectProvider;
+import org.apache.ibatis.annotations.UpdateProvider;
+import org.apache.ibatis.cursor.Cursor;
+import org.apache.ibatis.session.RowBounds;
+
+import java.io.Serializable;
+import java.util.List;
+import java.util.Optional;
+
+/**
+ * 逻辑删除的 Mapper 方法
+ *
+ * @author hzw
+ */
+public interface LogicalMapper<T, I extends Serializable> extends BaseMapper<T, I>, FnMapper<T> {
+  /* BaseMapper +++ */
+
+  @Override
+  @Lang(Caching.class)
+  @UpdateProvider(type = LogicalProvider.class, method = "updateByPrimaryKeySelectiveWithForceFields")
+  int updateByPrimaryKeySelectiveWithForceFields(T entity, Fn.Fns<T> forceUpdateFields);
+
+  /* BaseMapper --- */
+
+  /* FnMapper +++ */
+
+  @Override
+  @Lang(Caching.class)
+  @SelectProvider(type = FnProvider.class, method = "selectColumns")
+  Optional<T> selectColumnsOne(T entity, Fn.Fns<T> selectFileds);
+
+  @Override
+  @Lang(Caching.class)
+  @SelectProvider(type = FnProvider.class, method = "selectColumns")
+  List<T> selectColumns(T entity, Fn.Fns<T> selectFileds);
+
+  /* FnMapper --- */
+
+  /* EntityMapper +++ */
+
+  @Override
+  @Lang(Caching.class)
+  @DeleteProvider(type = LogicalProvider.class, method = "deleteByPrimaryKey")
+  int deleteByPrimaryKey(I id);
+
+  @Override
+  @Lang(Caching.class)
+  @DeleteProvider(type = LogicalProvider.class, method = "delete")
+  int delete(T entity);
+
+  @Override
+  @Lang(Caching.class)
+  @UpdateProvider(type = LogicalProvider.class, method = "updateByPrimaryKey")
+  int updateByPrimaryKey(T entity);
+
+  @Override
+  @Lang(Caching.class)
+  @UpdateProvider(type = LogicalProvider.class, method = "updateByPrimaryKeySelective")
+  int updateByPrimaryKeySelective(T entity);
+
+  @Override
+  @Lang(Caching.class)
+  @SelectProvider(type = LogicalProvider.class, method = "selectByPrimaryKey")
+  Optional<T> selectByPrimaryKey(I id);
+
+  @Override
+  @Lang(Caching.class)
+  @SelectProvider(type = LogicalProvider.class, method = "select")
+  Optional<T> selectOne(T entity);
+
+  @Override
+  @Lang(Caching.class)
+  @SelectProvider(type = LogicalProvider.class, method = "select")
+  List<T> selectList(T entity);
+
+  @Override
+  @Lang(Caching.class)
+  @SelectProvider(type = LogicalProvider.class, method = "selectCount")
+  long selectCount(T entity);
+
+  /* EntityMapper --- */
+
+  /* CursorMapper +++ */
+
+  @Override
+  @Lang(Caching.class)
+  @SelectProvider(type = LogicalProvider.class, method = "select")
+  Cursor<T> selectCursor(T entity);
+
+  @Override
+  @Lang(Caching.class)
+  @SelectProvider(type = LogicalProvider.class, method = "selectByExample")
+  Cursor<T> selectCursorByExample(Example<T> example);
+
+  /* CursorMapper --- */
+
+  /* ExampleMapper +++ */
+  @Override
+  default Example<T> example() {
+    return BaseMapper.super.example();
+  }
+
+  @Override
+  @Lang(Caching.class)
+  @DeleteProvider(type = LogicalProvider.class, method = "deleteByExample")
+  int deleteByExample(Example<T> example);
+
+  @Override
+  @Lang(Caching.class)
+  @UpdateProvider(type = LogicalProvider.class, method = "updateByExample")
+  int updateByExample(T entity, Example<T> example);
+
+  @Override
+  @Lang(Caching.class)
+  @UpdateProvider(type = LogicalProvider.class, method = "updateByExampleSetValues")
+  int updateByExampleSetValues(Example<T> example);
+
+  @Override
+  @Lang(Caching.class)
+  @UpdateProvider(type = LogicalProvider.class, method = "updateByExampleSelective")
+  int updateByExampleSelective(T entity, Example<T> example);
+
+  @Override
+  @Lang(Caching.class)
+  @SelectProvider(type = LogicalProvider.class, method = "selectByExample")
+  List<T> selectByExample(Example<T> example);
+
+  @Override
+  @Lang(Caching.class)
+  @SelectProvider(type = LogicalProvider.class, method = "selectByExample")
+  Optional<T> selectOneByExample(Example<T> example);
+
+  @Override
+  @Lang(Caching.class)
+  @SelectProvider(type = ExampleProvider.class, method = "countByExample")
+  long countByExample(Example<T> example);
+
+  @Override
+  List<T> selectByExample(Example<T> example, RowBounds rowBounds);
+
+  /* ExampleMapper --- */
+}