tkMyBatis 检索时返回指定列

在使用tkMyBatis时，Dao层直接继承的Mapper<T>，就可以使用已有的函数进行CRUD，但是有的时候，检索的时候不需要返回所有的列，如果能像Mybatis之前在xml里面指明返回哪些列，岂不是更加有效率。

于是，简单查看了一下Mapper<T>的内容，如果只关注select的部分，按照Mapper<T>->BaseMapper<T>->BaseSelectMapper<T>->SelectOneMapper<T>，可以查看到SelectOne方法的接口。

public interface SelectOneMapper<T> {
    @SelectProvider(type = BaseSelectProvider.class, method = "dynamicSQL")
    T selectOne(T record);
}

标签@SelectProvider

mybatis3之后提供的，用于灵活的设置sql来源，这里设置了服务提供类和方法，但这个库并没有直接用method指定的方法来返回sql，而是在运行时进行解析的。

在查看BaseSelectProvider，在里面找到selectOne的具体实现，简单来说就是返回了一个String类型的sql语句。

    public String selectOne(MappedStatement ms) {
        Class<?> entityClass = getEntityClass(ms);
        //修改返回值类型为实体类型
        setResultType(ms, entityClass);
        StringBuilder sql = new StringBuilder();
        sql.append(SqlHelper.selectAllColumns(entityClass));
        sql.append(SqlHelper.fromTable(entityClass, tableName(entityClass)));
        sql.append(SqlHelper.whereAllIfColumns(entityClass, isNotEmpty()));
        return sql.toString();
    }

可以看到，selectOne通过SqlHelper.selectAllColums包含了所有列。其他select相关的函数，也是返回所有列的，所以如果直接继承tkMyBatis的 Mapper<T>，那么检索相关就一定会返回所有列。

既然 @SelectProvider指定了tkMyBatis定义的这些接口实际的sql语句，那么为了返回指定的列，就可以考虑自定义SelectProvider类，来实现高效率的检索。

实现如下：

BookDao.interface

public interface BookDao extends Mapper<Book> {
    @SelectProvider(type = BookSelectProvider.class, method = "selectIdAndName")
    @ResultMap("BookResultMap")
    public Book selectIdAndName(@Param("id") Integer id);
}

注意：ResultMap一定要在xml中定义，否则找不到返回类型，同时，如果结果可能是多个，要使用List类型的返回结果定义接口。

BookSelectProvider.java

public class BookSelectProvider {

    public String selectIdAndName(int id) {
        return "select id,name from book where id = " + id;
    }
}

Book.xml

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"  "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.sherry.demo.mapper.BookDao">
 
	<resultMap id="BookResultMap" type="com.sherry.demo.entity.Book">
		<id column="id" property="id" jdbcType="INTEGER" />
		<result column="name" property="name" jdbcType="VARCHAR" />
	</resultMap>
</mapper>

Book.java

public class Book {

    @Id
    @GeneratedValue(generator = "JDBC")
    private Integer id;
	
    private String name;
	
    @Column(name="price")
    private double price;
    // get set toString省略
}