SpringBoot項目里，讓TKmybatis支持可以手寫sql的Mapper.xml文件

SpringBoot項目通常配合TKMybatis或MyBatis-Plus來做數據的持久化。

對於單表的增刪改查，TKMybatis優雅簡潔，無需像傳統mybatis那樣在mapper.xml文件里定義sql。

 

我們目前的項目呢，有一些數據分析的需求，涉及到多表關聯、嵌套子查詢等復雜的sql。

那么，TKMybatis是不是可以支持手寫sql呢？

答案是yes！

 

 

我們知道，springboot集成tk-mybatis需添加2個依賴：

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

<dependency>
    <groupId>tk.mybatis</groupId>
    <artifactId>mapper</artifactId>
    <version>4.1.5</version>
</dependency>

執行dependency:tree時查看依賴關系，可以看到mapper-spring-boot-starter.jar同時依賴了org.mybatis。

[INFO] +- tk.mybatis:mapper-spring-boot-starter:jar:2.1.5:compile
[INFO] |  +- org.springframework.boot:spring-boot-starter-jdbc:jar:2.1.7.RELEASE:compile
[INFO] |  |  +- com.zaxxer:HikariCP:jar:3.2.0:compile
[INFO] |  |  \- org.springframework:spring-jdbc:jar:5.1.9.RELEASE:compile
[INFO] |  +- org.mybatis:mybatis:jar:3.4.6:compile
[INFO] |  +- org.mybatis:mybatis-spring:jar:1.3.2:compile
[INFO] |  +- tk.mybatis:mapper-core:jar:1.1.5:compile
[INFO] |  +- tk.mybatis:mapper-base:jar:1.1.5:compile
[INFO] |  +- tk.mybatis:mapper-weekend:jar:1.1.5:compile
[INFO] |  +- tk.mybatis:mapper-spring:jar:1.1.5:compile
[INFO] |  +- tk.mybatis:mapper-extra:jar:1.1.5:compile
[INFO] |  \- tk.mybatis:mapper-spring-boot-autoconfigure:jar:2.1.5:compile

 

那么，在springboot項目里，如果要實現mybatis那樣的在mapper文件里手寫sql，如下幾步輕松搞定。

 

1）application.yml里：

mybatis:
  mapper-locations: classpath:mapper/*.xml
  configuration:
    map-underscore-to-camel-case: true
  type-aliases-package: com.draft.entity

 

2）在resources/mapper目錄下創建 SpiderDraftsMapper.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.draft.dao.SpiderDraftsMapper">
    <resultMap id="columnMap" type="com.draft.entity.SpiderDrafts">
        <result column="order_id" property="orderId" jdbcType="VARCHAR"/>
        <result column="interest_days" property="interestDays"/>
        <result column="draft_owner" property="draftOwner"/>
    </resultMap>
    <select id="getfoo" resultMap="columnMap">
        select * from spider_drafts
        where order_id in(select order_id from spider_draft)
    </select>
    <select id="getfoo1" resultType="com.draft.entity.SpiderDrafts">
        select interest_days, order_id as orderId,draft_owner from spider_drafts
        where order_id in(select order_id from spider_draft)
    </select>
</mapper>

 

 

3）在com.draft.entity包下，創建pojo實體類 SpiderDrafts.java（可以用代碼生成器生成）：

package com.draft.entity;

import lombok.Data;

import javax.persistence.Column; import javax.persistence.Entity;
import javax.persistence.Table; import java.io.Serializable;

@Data
//@Table(name = "spider_drafts")
@Entity
public class SpiderDrafts implements Serializable {
//    @Column(name = "interest_days")
    private String interestDays;
    private String orderId;
    private String draftOwner;
}

 

4）數據訪問接口類統一定義在com.draft.dao包下，項目啟動程序直接通過@MapperScan("com.draft.dao")來進行掃描。 如下是SpiderDraftsMapper.java： 

package com.draft.dao;

import com.draft.entity.SpiderDrafts;
import tk.mybatis.mapper.common.Mapper;

import java.util.List;

public interface SpiderDraftsMapper extends Mapper<SpiderDrafts> {
    List<SpiderDrafts> getfoo();

    List<SpiderDrafts> getfoo1();
}

 

 

以上幾步，完美搞定。單標操作直接用tkmybatis，復雜sql則寫在mapper.xml文件里。

注意：getfoo與getfoo1兩個方法都是可用的，只是為了測試下划線命名方式的表字段與駝峰式命名的pojo屬性的映射（mybatis.configuration.map-underscore-to-camel-case屬性），見后文說明。

 

【幾點說明】

1）map-underscore-to-camel-case：
數據庫里表的字段是下划線命名，pojo的屬性是駝峰命名。打開這個屬性可實現這種轉換。不用再依靠mybatis那樣的resultMap了。

    <resultMap id="columnMap" type="com.draft.entity.SpiderDrafts">
        <result column="order_id" property="orderId" jdbcType="VARCHAR"/>
        <result column="interest_days" property="interestDays"/>
        <result column="draft_owner" property="draftOwner"/>
    </resultMap>

 

數據庫里表的字段是下划線命名，pojo的屬性是駝峰命名。另外，打開這個屬性后，pojo涉及到下划線式字段與駝峰式屬性這種對應關系的，就可以去掉@Table和@Column注解。

2）type-aliases-package：

mapper.xml文件中resultMap的type或者parameterType或者resultType會使用程序里定義的pojo，
此時可以用完全限定名來指定這些POJO的引用，例如 <select id="getfoo1" resultType="com.draft.entity.SpiderDrafts">，
又或者你可以通過在 application.yml/application.properties 中指定POJO掃描包來讓mybatis自動掃描到POJO，這時mapper.xml里pojo就可以不用帶上包名了。

 

【后記】

這是個新建的工程，在執行dependency:tree查看依賴關系時，maven報錯：

[Maven] Project build error: 'packaging' with value 'jar' is invalid. Aggregator projects require 'pom' as packaging.

人家提示了：聚合項目（父級項目）需要用pom作為打包方式。父pom文件得加上配置：

<packaging>pom</packaging>

 

 

▄︻┻┳═一參閱：

▄︻┻┳═一SpringBoot項目里，讓TKmybatis支持可以手寫sql的Mapper.xml文件

▄︻┻┳═一springboot項目集成mybatisplus兩部曲