feature: 扩展查询JAVA API，用于支持不会过滤掉已经被标记为逻辑删除（{@link Column#logicDelete}）的数据

Author: myoss

src/main/java/com/github/myoss/phoenix/mybatis/mapper/template/CrudMapper.java

@@ -20,6 +20,7 @@
 import com.github.myoss.phoenix.mybatis.mapper.annotation.RegisterMapper;
 import com.github.myoss.phoenix.mybatis.mapper.template.delete.DeleteMapper;
 import com.github.myoss.phoenix.mybatis.mapper.template.insert.CreateMapper;
+import com.github.myoss.phoenix.mybatis.mapper.template.select.RetrieveIncludeLogicDeleteMapper;
 import com.github.myoss.phoenix.mybatis.mapper.template.select.RetrieveMapper;
 import com.github.myoss.phoenix.mybatis.mapper.template.update.UpdateMapper;
 
@@ -30,5 +31,6 @@
  * @since 2018年4月29日 下午4:58:48
  */
 @RegisterMapper
-public interface CrudMapper<T> extends CreateMapper<T>, RetrieveMapper<T>, UpdateMapper<T>, DeleteMapper<T> {
+public interface CrudMapper<T> extends CreateMapper<T>, RetrieveMapper<T>, RetrieveIncludeLogicDeleteMapper<T>,
+        UpdateMapper<T>, DeleteMapper<T> {
 }

src/main/java/com/github/myoss/phoenix/mybatis/mapper/template/select/RetrieveIncludeLogicDeleteMapper.java

@@ -0,0 +1,33 @@
+/*
+ * Copyright 2018-2018 https://github.com/myoss
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
+package com.github.myoss.phoenix.mybatis.mapper.template.select;
+
+import com.github.myoss.phoenix.mybatis.mapper.annotation.RegisterMapper;
+import com.github.myoss.phoenix.mybatis.table.annotation.Column;
+
+/**
+ * 读取（Retrieve）操作，通用 Mapper 接口，不会过滤掉已经被标记为逻辑删除（{@link Column#logicDelete}）的数据
+ *
+ * @author Jerry.Chen
+ * @since 2018年4月29日 下午5:14:41
+ */
+@RegisterMapper
+public interface RetrieveIncludeLogicDeleteMapper<T> extends SelectOneIncludeLogicDeleteMapper<T>,
+        SelectListIncludeLogicDeleteMapper<T>, SelectCountIncludeLogicDeleteMapper<T>,
+        SelectPageIncludeLogicDeleteMapper<T>, SelectByPrimaryKeyIncludeLogicDeleteMapper<T> {
+}

src/main/java/com/github/myoss/phoenix/mybatis/mapper/template/select/SelectByPrimaryKeyIncludeLogicDeleteMapper.java

@@ -0,0 +1,55 @@
+/*
+ * Copyright 2018-2018 https://github.com/myoss
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
+package com.github.myoss.phoenix.mybatis.mapper.template.select;
+
+import java.io.Serializable;
+
+import org.apache.ibatis.annotations.SelectProvider;
+
+import com.github.myoss.phoenix.mybatis.mapper.annotation.RegisterMapper;
+import com.github.myoss.phoenix.mybatis.mapper.template.select.impl.SelectIncludeLogicDeleteMapperTemplate;
+import com.github.myoss.phoenix.mybatis.table.annotation.Column;
+
+/**
+ * 查询记录通用 Mapper 接口，不会过滤掉已经被标记为逻辑删除（{@link Column#logicDelete}）的数据
+ *
+ * @author Jerry.Chen
+ * @since 2018年6月11日 下午11:02:45
+ */
+@RegisterMapper
+public interface SelectByPrimaryKeyIncludeLogicDeleteMapper<T> {
+    /**
+     * 根据主键id查询实体对象，不会过滤掉已经被标记为逻辑删除（{@link Column#logicDelete}）的数据
+     *
+     * @param id 主键id
+     * @return 对应的实体对象
+     * @see SelectIncludeLogicDeleteMapperTemplate#selectByPrimaryKeyIncludeLogicDelete
+     */
+    @SelectProvider(type = SelectIncludeLogicDeleteMapperTemplate.class, method = "dynamicSql")
+    T selectByPrimaryKeyIncludeLogicDelete(Serializable id);
+
+    /**
+     * 根据主键字段查询实体对象，可以支持多主键字段的表，不会过滤掉已经被标记为逻辑删除（{@link Column#logicDelete}）的数据
+     *
+     * @param condition 匹配的条件，主键有值的实体对象
+     * @return 对应的实体对象
+     * @see SelectIncludeLogicDeleteMapperTemplate#selectWithPrimaryKeyIncludeLogicDelete
+     */
+    @SelectProvider(type = SelectIncludeLogicDeleteMapperTemplate.class, method = "dynamicSql")
+    T selectWithPrimaryKeyIncludeLogicDelete(T condition);
+}

src/main/java/com/github/myoss/phoenix/mybatis/mapper/template/select/SelectCountIncludeLogicDeleteMapper.java

@@ -0,0 +1,58 @@
+/*
+ * Copyright 2018-2018 https://github.com/myoss
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
+package com.github.myoss.phoenix.mybatis.mapper.template.select;
+
+import java.util.Map;
+
+import org.apache.ibatis.annotations.Param;
+import org.apache.ibatis.annotations.SelectProvider;
+
+import com.github.myoss.phoenix.mybatis.mapper.annotation.RegisterMapper;
+import com.github.myoss.phoenix.mybatis.mapper.template.select.impl.SelectIncludeLogicDeleteMapperTemplate;
+import com.github.myoss.phoenix.mybatis.table.annotation.Column;
+
+/**
+ * 查询记录通用 Mapper 接口，不会过滤掉已经被标记为逻辑删除（{@link Column#logicDelete}）的数据
+ *
+ * @author Jerry.Chen
+ * @since 2018年6月11日 下午10:54:56
+ */
+@RegisterMapper
+public interface SelectCountIncludeLogicDeleteMapper<T> {
+    /**
+     * 根据条件查询匹配的实体对象总记录数，不会过滤掉已经被标记为逻辑删除（{@link Column#logicDelete}）的数据
+     *
+     * @param condition 匹配的条件
+     * @return 匹配的实体对象
+     * @see SelectIncludeLogicDeleteMapperTemplate#selectCountIncludeLogicDelete
+     */
+    @SelectProvider(type = SelectIncludeLogicDeleteMapperTemplate.class, method = "dynamicSql")
+    int selectCountIncludeLogicDelete(T condition);
+
+    /**
+     * 根据条件查询匹配的实体对象总记录数，不会过滤掉已经被标记为逻辑删除（{@link Column#logicDelete}）的数据
+     *
+     * @param condition 匹配的条件
+     * @param extraCondition 扩展可选查询条件，需要自定义
+     * @return 匹配的实体对象
+     * @see SelectIncludeLogicDeleteMapperTemplate#selectCountIncludeLogicDelete2
+     */
+    @SelectProvider(type = SelectIncludeLogicDeleteMapperTemplate.class, method = "dynamicSql")
+    int selectCountIncludeLogicDelete2(@Param("condition") T condition,
+                                       @Param("extraCondition") Map<String, Object> extraCondition);
+}

src/main/java/com/github/myoss/phoenix/mybatis/mapper/template/select/SelectOneIncludeLogicDeleteMapper.java

@@ -0,0 +1,44 @@
+/*
+ * Copyright 2018-2018 https://github.com/myoss
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
+package com.github.myoss.phoenix.mybatis.mapper.template.select;
+
+import org.apache.ibatis.annotations.SelectProvider;
+
+import com.github.myoss.phoenix.mybatis.mapper.annotation.RegisterMapper;
+import com.github.myoss.phoenix.mybatis.mapper.template.select.impl.SelectIncludeLogicDeleteMapperTemplate;
+import com.github.myoss.phoenix.mybatis.table.annotation.Column;
+
+/**
+ * 查询记录通用 Mapper 接口，不会过滤掉已经被标记为逻辑删除（{@link Column#logicDelete}）的数据
+ *
+ * @author Jerry.Chen
+ * @since 2018年6月11日 下午11:01:23
+ */
+@RegisterMapper
+public interface SelectOneIncludeLogicDeleteMapper<T> {
+    /**
+     * 根据条件查询匹配的实体对象，只能有一条查询结果记录，有多条查询结果则会抛出异常，不会过滤掉已经被标记为逻辑删除（
+     * {@link Column#logicDelete}）的数据
+     *
+     * @param condition 匹配的条件
+     * @return 匹配的实体对象
+     * @see SelectIncludeLogicDeleteMapperTemplate#selectOneIncludeLogicDelete
+     */
+    @SelectProvider(type = SelectIncludeLogicDeleteMapperTemplate.class, method = "dynamicSql")
+    T selectOneIncludeLogicDelete(T condition);
+}

src/main/java/com/github/myoss/phoenix/mybatis/mapper/template/select/impl/SelectIncludeLogicDeleteMapperTemplate.java

@@ -17,6 +17,7 @@
 
 package com.github.myoss.phoenix.mybatis.mapper.template.select.impl;
 
+import java.io.Serializable;
 import java.util.Collections;
 import java.util.List;
 import java.util.Map;
@@ -31,7 +32,10 @@
 import org.apache.ibatis.session.Configuration;
 
 import com.github.myoss.phoenix.mybatis.mapper.template.AbstractMapperTemplate;
+import com.github.myoss.phoenix.mybatis.mapper.template.select.SelectByPrimaryKeyIncludeLogicDeleteMapper;
+import com.github.myoss.phoenix.mybatis.mapper.template.select.SelectCountIncludeLogicDeleteMapper;
 import com.github.myoss.phoenix.mybatis.mapper.template.select.SelectListIncludeLogicDeleteMapper;
+import com.github.myoss.phoenix.mybatis.mapper.template.select.SelectOneIncludeLogicDeleteMapper;
 import com.github.myoss.phoenix.mybatis.mapper.template.select.SelectPageIncludeLogicDeleteMapper;
 import com.github.myoss.phoenix.mybatis.table.TableInfo;
 import com.github.myoss.phoenix.mybatis.table.TableMetaObject;
@@ -62,6 +66,7 @@ public class SelectIncludeLogicDeleteMapperTemplate extends AbstractMapperTempla
      * @param tableInfo 数据库表结构信息
      * @param ms sql语句节点信息，会将生成的sql语句替换掉原有的 {@link MappedStatement#sqlSource}
      * @return 生成的sql语句
+     * @see SelectOneIncludeLogicDeleteMapper#selectOneIncludeLogicDelete(Object)
      */
     public String selectOneIncludeLogicDelete(TableInfo tableInfo, MappedStatement ms) {
         MetaObject metaObject = SystemMetaObject.forObject(ms);
@@ -125,6 +130,7 @@ public String selectListIncludeLogicDelete(TableInfo tableInfo, MappedStatement
      * @param tableInfo 数据库表结构信息
      * @param ms sql语句节点信息，会将生成的sql语句替换掉原有的 {@link MappedStatement#sqlSource}
      * @return 生成的sql语句
+     * @see SelectCountIncludeLogicDeleteMapper#selectCountIncludeLogicDelete(Object)
      */
     public String selectCountIncludeLogicDelete(TableInfo tableInfo, MappedStatement ms) {
         MetaObject metaObject = SystemMetaObject.forObject(ms);
@@ -165,6 +171,8 @@ public String selectCountIncludeLogicDelete(TableInfo tableInfo, MappedStatement
      * @param tableInfo 数据库表结构信息
      * @param ms sql语句节点信息，会将生成的sql语句替换掉原有的 {@link MappedStatement#sqlSource}
      * @return 生成的sql语句
+     * @see SelectCountIncludeLogicDeleteMapper#selectCountIncludeLogicDelete2(Object,
+     *      Map)
      */
     public String selectCountIncludeLogicDelete2(TableInfo tableInfo, MappedStatement ms) {
         MetaObject metaObject = SystemMetaObject.forObject(ms);
@@ -322,6 +330,7 @@ public String selectPageIncludeLogicDelete2(TableInfo tableInfo, MappedStatement
      * @param tableInfo 数据库表结构信息
      * @param ms sql语句节点信息，会将生成的sql语句替换掉原有的 {@link MappedStatement#sqlSource}
      * @return 生成的sql语句
+     * @see SelectByPrimaryKeyIncludeLogicDeleteMapper#selectByPrimaryKeyIncludeLogicDelete(Serializable)
      */
     public String selectByPrimaryKeyIncludeLogicDelete(TableInfo tableInfo, MappedStatement ms) {
         MetaObject metaObject = SystemMetaObject.forObject(ms);
@@ -360,6 +369,7 @@ public String selectByPrimaryKeyIncludeLogicDelete(TableInfo tableInfo, MappedSt
      * @param tableInfo 数据库表结构信息
      * @param ms sql语句节点信息，会将生成的sql语句替换掉原有的 {@link MappedStatement#sqlSource}
      * @return 生成的sql语句
+     * @see SelectByPrimaryKeyIncludeLogicDeleteMapper#selectWithPrimaryKeyIncludeLogicDelete(Object)
      */
     public String selectWithPrimaryKeyIncludeLogicDelete(TableInfo tableInfo, MappedStatement ms) {
         return selectByPrimaryKeyIncludeLogicDelete(tableInfo, ms);

src/main/java/com/github/myoss/phoenix/mybatis/repository/service/RetrieveIncludeLogicDeleteService.java

@@ -0,0 +1,99 @@
+/*
+ * Copyright 2018-2018 https://github.com/myoss
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
+package com.github.myoss.phoenix.mybatis.repository.service;
+
+import java.io.Serializable;
+import java.util.List;
+import java.util.Map;
+
+import com.github.myoss.phoenix.core.lang.dto.Page;
+import com.github.myoss.phoenix.core.lang.dto.Result;
+import com.github.myoss.phoenix.mybatis.table.annotation.Column;
+
+/**
+ * 封装数据库查询常用操作，不会过滤掉已经被标记为逻辑删除（{@link Column#logicDelete}）的数据
+ *
+ * @author Jerry.Chen
+ * @since 2018年6月12日 上午12:10:29
+ */
+public interface RetrieveIncludeLogicDeleteService<T> {
+    /**
+     * 根据主键查询实体对象，不会过滤掉已经被标记为逻辑删除（{@link Column#logicDelete}）的数据
+     *
+     * @param id 主键
+     * @return 对应的实体对象
+     */
+    Result<T> findByPrimaryKeyIncludeLogicDelete(Serializable id);
+
+    /**
+     * 根据主键查询实体对象，不会过滤掉已经被标记为逻辑删除（{@link Column#logicDelete}）的数据
+     *
+     * @param condition 匹配的条件，主键有值的实体对象
+     * @return 对应的实体对象
+     */
+    Result<T> findByPrimaryKeyIncludeLogicDelete(T condition);
+
+    /**
+     * 根据条件查询匹配的实体对象，不会过滤掉已经被标记为逻辑删除（{@link Column#logicDelete}）的数据
+     *
+     * @param condition 匹配的条件
+     * @return 匹配的实体对象
+     */
+    Result<T> findOneIncludeLogicDelete(T condition);
+
+    /**
+     * 根据条件查询匹配的实体对象，不会过滤掉已经被标记为逻辑删除（{@link Column#logicDelete}）的数据
+     *
+     * @param condition 匹配的条件
+     * @return 匹配的实体对象
+     */
+    Result<List<T>> findListIncludeLogicDelete(T condition);
+
+    /**
+     * 根据条件查询匹配的实体对象，不会过滤掉已经被标记为逻辑删除（{@link Column#logicDelete}）的数据，并支持字段排序
+     *
+     * @param condition 匹配的条件和排序字段
+     * @return 匹配的实体对象
+     */
+    Result<List<T>> findListWithSortIncludeLogicDelete(Page<T> condition);
+
+    /**
+     * 根据条件查询匹配的实体对象总记录数，不会过滤掉已经被标记为逻辑删除（{@link Column#logicDelete}）的数据
+     *
+     * @param condition 匹配的条件
+     * @return 匹配的实体对象总记录数
+     */
+    Result<Integer> findCountIncludeLogicDelete(T condition);
+
+    /**
+     * 根据条件查询匹配的实体对象总记录数，不会过滤掉已经被标记为逻辑删除（{@link Column#logicDelete}）的数据
+     *
+     * @param condition 匹配的条件
+     * @param extraCondition 扩展查询条件，需要自定义
+     * @return 匹配的实体对象总记录数
+     */
+    Result<Integer> findCountIncludeLogicDelete(T condition, Map<String, Object> extraCondition);
+
+    /**
+     * 根据条件查询匹配的实体对象，不会过滤掉已经被标记为逻辑删除（{@link Column#logicDelete}）的数据，并进行分页
+     *
+     * @param condition 匹配的条件
+     * @return 匹配的实体对象
+     */
+    Page<T> findPageIncludeLogicDelete(Page<T> condition);
+}