TkMybatis 是什麼？

1、TkMybatis

Tkmybatis 是基於 Mybatis 框架開發的一個工具，經過調用它提供的方法實現對單表的數據操做，不須要寫任何 sql 語句，這極大地提升了項目開發效率。

2、怎麼用？

1. 引用

在 pom.xml 中引入 tk.mybatis 的引用。

<dependency>
    <groupId>tk.mybatis</groupId>
    <artifactId>mapper-spring-boot-starter</artifactId>
    <version>2.1.5</version>
</dependency>

2. DO 對象

@Table(name = "t_plan")
public class PopMerchantPlanDO{

	/**
	 * id
	 */
	@Id
	@GeneratedValue(strategy = GenerationType.IDENTITY)
	private Long id;
	/**
	 * 編號
	 */
	private String code;
}

映射數據庫表和實體對象，相似的註解還有 @Column、@ColumnType、@Transient 等等。

3. Mapper 數據庫操做接口

public interface BaseDao<T> extends BaseMapper<T>, MySqlMapper<T>, IdsMapper<T>, ConditionMapper<T>, ExampleMapper<T> {
}

Dao 對象繼承的這些接口幫你封裝了一系列單表的操做，使你不用再爲每一個單表編寫繁雜重複的 sql 語句。

當你使用 Dao 對象操做數據庫的時候，只須要調用這些接口中封裝好的方法，就能完成一系列對單表的 CURD 操做，好比下面的 selectAll 方法，鑑於篇幅，更多的 CURD 方法，你們能夠打開 Mapper 接口自行查看，一目瞭然。

@RegisterMapper
public interface SelectAllMapper<T> {

    /**
     * 查詢所有結果
     *
     * @return
     */
    @SelectProvider(type = BaseSelectProvider.class, method = "dynamicSQL")
    List<T> selectAll();
}

固然，對於複雜的 SQL 語句，好比 JOIN 操做等等，仍然須要自行編寫 xml 文件和 SQL 語句。

3、底層原理

TkMybatis 的封裝依賴一個 @SelectProvider 註解來完成，若是你使用過 @Select 註解，那麼 @SelectProvider 與它沒有質的區別，只是在定義註解的方式上有所不一樣, 一個是直接定義 sql, 一個是在外部定義好 sql 直接引用。

public interface Mapper {

    @Select("select uuid,full_name as name from t_system_company ")
    List<Map<String, String>> getCompanyInfo();
}

@RegisterMapper
public interface SelectAllMapper<T> {

    @SelectProvider(type = BaseSelectProvider.class, method = "dynamicSQL")
    List<T> selectAll();
}

@SelectProvider 引用的各類 *Provider.class 實現類，就是依賴反射、註解等手段拼接 SQL 語句的過程。

/**
     * 查詢所有結果
     *
     * @param ms
     * @return
     */
    public String selectAll(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)));

        // 邏輯刪除的未刪除查詢條件
        sql.append("<where>");
        sql.append(SqlHelper.whereLogicDelete(entityClass, false));
        sql.append("</where>");

        sql.append(SqlHelper.orderByDefault(entityClass));
        return sql.toString();
    }

4、結語

當初從 Hibernate 換到 Mybatis，把 HQL、QBC 語句的成本換成簡單的 SQL 語句，這？如今又兜兜轉轉回去了？

Tkmybatis 減小了一系列對單表的單調接口和繁雜的 SQL 語句，但也下降了代碼的可讀性，另外這種廣而全的數據庫操做，必然會犧牲一部分的查詢性能。

能夠在一些併發量不大、對性能要求不高的項目中嘗試下 Tkmybatis ，對一些比較大的項目來講，仍是但願本身對 SQL 的控制更強一點。

相關連接：1. mybatis @SelectProvider 註解, 打賭你沒有用過