增加selectByIds和deleteByIds，用法见通用Mapper接口大全

abel533 · abel533 · commit 561dd1356ea7 · 2016-09-04T12:05:07.000+08:00
diff --git a/src/main/java/tk/mybatis/mapper/common/IdsMapper.java b/src/main/java/tk/mybatis/mapper/common/IdsMapper.java
@@ -0,0 +1,14 @@
+package tk.mybatis.mapper.common;
+
+import tk.mybatis.mapper.common.ids.DeleteByIdsMapper;
+import tk.mybatis.mapper.common.ids.SelectByIdsMapper;
+
+/**
+ * 通用Mapper接口,根据ids操作
+ *
+ * @param <T> 不能为空
+ * @author liuzh
+ */
+public interface IdsMapper<T> extends SelectByIdsMapper<T>, DeleteByIdsMapper<T> {
+
+}
diff --git a/src/main/java/tk/mybatis/mapper/common/ids/DeleteByIdsMapper.java b/src/main/java/tk/mybatis/mapper/common/ids/DeleteByIdsMapper.java
@@ -0,0 +1,26 @@
+package tk.mybatis.mapper.common.ids;
+
+import org.apache.ibatis.annotations.DeleteProvider;
+import org.apache.ibatis.annotations.SelectProvider;
+import tk.mybatis.mapper.provider.IdsProvider;
+
+import java.util.List;
+
+/**
+ * 通用Mapper接口,根据ids删除
+ *
+ * @param <T> 不能为空
+ * @author liuzh
+ */
+public interface DeleteByIdsMapper<T> {
+
+    /**
+     * 根据主键字符串进行删除，类中只有存在一个带有@Id注解的字段
+     *
+     * @param ids 如 "1,2,3,4"
+     * @return
+     */
+    @DeleteProvider(type = IdsProvider.class, method = "dynamicSQL")
+    int deleteByIds(String ids);
+
+}
diff --git a/src/main/java/tk/mybatis/mapper/common/ids/SelectByIdsMapper.java b/src/main/java/tk/mybatis/mapper/common/ids/SelectByIdsMapper.java
@@ -0,0 +1,25 @@
+package tk.mybatis.mapper.common.ids;
+
+import org.apache.ibatis.annotations.SelectProvider;
+import tk.mybatis.mapper.provider.IdsProvider;
+
+import java.util.List;
+
+/**
+ * 通用Mapper接口,根据ids查询
+ *
+ * @param <T> 不能为空
+ * @author liuzh
+ */
+public interface SelectByIdsMapper<T> {
+
+    /**
+     * 根据主键字符串进行查询，类中只有存在一个带有@Id注解的字段
+     *
+     * @param ids 如 "1,2,3,4"
+     * @return
+     */
+    @SelectProvider(type = IdsProvider.class, method = "dynamicSQL")
+    List<T> selectByIds(String ids);
+
+}
diff --git a/src/main/java/tk/mybatis/mapper/provider/IdsProvider.java b/src/main/java/tk/mybatis/mapper/provider/IdsProvider.java
@@ -0,0 +1,71 @@
+package tk.mybatis.mapper.provider;
+
+import org.apache.ibatis.mapping.MappedStatement;
+import tk.mybatis.mapper.entity.EntityColumn;
+import tk.mybatis.mapper.mapperhelper.EntityHelper;
+import tk.mybatis.mapper.mapperhelper.MapperHelper;
+import tk.mybatis.mapper.mapperhelper.MapperTemplate;
+import tk.mybatis.mapper.mapperhelper.SqlHelper;
+
+import java.util.Set;
+
+/**
+ * 通过 ids 字符串的各种操作
+ * <p/>
+ * ids 如 "1,2,3"
+ *
+ * @author liuzh
+ */
+public class IdsProvider extends MapperTemplate {
+
+    public IdsProvider(Class<?> mapperClass, MapperHelper mapperHelper) {
+        super(mapperClass, mapperHelper);
+    }
+
+    /**
+     * 根据主键字符串进行删除，类中只有存在一个带有@Id注解的字段
+     *
+     * @param ms
+     * @return
+     */
+    public String deleteByIds(MappedStatement ms) {
+        final Class<?> entityClass = getEntityClass(ms);
+        StringBuilder sql = new StringBuilder();
+        sql.append(SqlHelper.deleteFromTable(entityClass, tableName(entityClass)));
+        Set<EntityColumn> columnList = EntityHelper.getPKColumns(entityClass);
+        if (columnList.size() == 1) {
+            EntityColumn column = columnList.iterator().next();
+            sql.append(" where ");
+            sql.append(column.getColumn());
+            sql.append(" in (${_parameter})");
+        } else {
+            throw new RuntimeException("继承 deleteByIds 方法的实体类[" + entityClass.getCanonicalName() + "]中必须只有一个带有 @Id 注解的字段");
+        }
+        return sql.toString();
+    }
+
+    /**
+     * 根据主键字符串进行查询，类中只有存在一个带有@Id注解的字段
+     *
+     * @param ms
+     * @return
+     */
+    public String selectByIds(MappedStatement ms) {
+        final Class<?> entityClass = getEntityClass(ms);
+        //将返回值修改为实体类型
+        setResultType(ms, entityClass);
+        StringBuilder sql = new StringBuilder();
+        sql.append(SqlHelper.selectAllColumns(entityClass));
+        sql.append(SqlHelper.fromTable(entityClass, tableName(entityClass)));
+        Set<EntityColumn> columnList = EntityHelper.getPKColumns(entityClass);
+        if (columnList.size() == 1) {
+            EntityColumn column = columnList.iterator().next();
+            sql.append(" where ");
+            sql.append(column.getColumn());
+            sql.append(" in (${_parameter})");
+        } else {
+            throw new RuntimeException("继承 selectByIds 方法的实体类[" + entityClass.getCanonicalName() + "]中必须只有一个带有 @Id 注解的字段");
+        }
+        return sql.toString();
+    }
+}
diff --git a/src/test/java/tk/mybatis/mapper/mapper/CountryMapper.java b/src/test/java/tk/mybatis/mapper/mapper/CountryMapper.java
@@ -24,6 +24,7 @@
 
 package tk.mybatis.mapper.mapper;
 
+import tk.mybatis.mapper.common.IdsMapper;
 import tk.mybatis.mapper.common.Mapper;
 import tk.mybatis.mapper.common.MySqlMapper;
 import tk.mybatis.mapper.hsqldb.HsqldbMapper;
@@ -32,5 +33,5 @@
 /**
  * Created by liuzh on 2014/11/19.
  */
-public interface CountryMapper extends Mapper<Country>, HsqldbMapper<Country>, MySqlMapper<Country> {
+public interface CountryMapper extends Mapper<Country>, HsqldbMapper<Country>, MySqlMapper<Country>, IdsMapper<Country> {
 }
diff --git a/src/test/java/tk/mybatis/mapper/mapper/MybatisHelper.java b/src/test/java/tk/mybatis/mapper/mapper/MybatisHelper.java
@@ -29,6 +29,7 @@
 import org.apache.ibatis.session.SqlSession;
 import org.apache.ibatis.session.SqlSessionFactory;
 import org.apache.ibatis.session.SqlSessionFactoryBuilder;
+import tk.mybatis.mapper.common.IdsMapper;
 import tk.mybatis.mapper.common.Mapper;
 import tk.mybatis.mapper.common.MySqlMapper;
 import tk.mybatis.mapper.common.SqlServerMapper;
@@ -89,6 +90,7 @@ public class MybatisHelper {
                 mapperHelper.registerMapper(HsqldbMapper.class);
                 mapperHelper.registerMapper(MySqlMapper.class);
                 mapperHelper.registerMapper(SqlServerMapper.class);
+                mapperHelper.registerMapper(IdsMapper.class);
                 //配置完成后，执行下面的操作
                 mapperHelper.processConfiguration(session.getConfiguration());
                 //OK - mapperHelper的任务已经完成，可以不管了
diff --git a/src/test/java/tk/mybatis/mapper/test/ids/TestIds.java b/src/test/java/tk/mybatis/mapper/test/ids/TestIds.java
@@ -0,0 +1,71 @@
+/*
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2014-2016 abel533@gmail.com
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+
+package tk.mybatis.mapper.test.ids;
+
+import org.apache.ibatis.session.SqlSession;
+import org.junit.Assert;
+import org.junit.Test;
+import tk.mybatis.mapper.mapper.CountryMapper;
+import tk.mybatis.mapper.mapper.MybatisHelper;
+import tk.mybatis.mapper.model.Country;
+
+import java.util.List;
+
+/**
+ * 通过 ids 进行操作
+ *
+ * @author liuzh
+ */
+public class TestIds {
+
+    @Test
+    public void testSelectByIds() {
+        SqlSession sqlSession = MybatisHelper.getSqlSession();
+        try {
+            CountryMapper mapper = sqlSession.getMapper(CountryMapper.class);
+            List<Country> countryList = mapper.selectByIds("1,2,3");
+            //查询总数
+            Assert.assertEquals(3, countryList.size());
+        } finally {
+            sqlSession.close();
+        }
+    }
+
+    @Test
+    public void testDeleteByIds() {
+        SqlSession sqlSession = MybatisHelper.getSqlSession();
+        try {
+            CountryMapper mapper = sqlSession.getMapper(CountryMapper.class);
+            int count = mapper.deleteByIds("1,2,3");
+            //查询总数
+            Assert.assertEquals(3, count);
+            Assert.assertEquals(180, mapper.selectCount(null));
+        } finally {
+            sqlSession.rollback();
+            sqlSession.close();
+        }
+    }
+
+}
diff --git a/wiki/mapper3/5.Mappers.md b/wiki/mapper3/5.Mappers.md
@@ -202,6 +202,23 @@ Condition方法和Example方法作用完全一样，只是为了避免Example带
 接口：`SqlServerMapper`<br>
 说明：这是上面两个接口的组合接口。<br><br>
 
+##Ids接口
+
+通过操作ids字符串进行操作，ids 如 "1,2,3" 这种形式的字符串，这个方法要求实体类中有且只有一个带有`@Id`注解的字段，否则会抛出异常。
+
+接口：`SelectByIdsMapper`<br>
+方法：`List<T> selectByIds(String ids)`<br>
+说明：根据主键字符串进行查询，类中只有存在一个带有@Id注解的字段<br><br>
+
+接口：`DeleteByIdsMapper`<br>
+方法：`int deleteByIds(String ids)`<br>
+说明：根据主键字符串进行删除，类中只有存在一个带有@Id注解的字段<br><br>
+
+###Ids组合接口
+
+接口：`IdsMapper<T>`<br>
+方法：包含上面Ids中的前两个方法<br><br>
+
 ##Mapper<T>接口
 
 接口：`Mapper<T>`<br>
