MyBatis 是一款優(yōu)秀的持久層框架荡含，它支持定制化 SQL、存儲過程以及高級映射届垫。MyBatis 避免了幾乎所有的 JDBC 代碼和手動設(shè)置參數(shù)以及獲取結(jié)果集释液。MyBatis 可以使用簡單的 XML 或注解來配置和映射原生信息，將接口和 Java 的 POJOs(Plain Old Java Objects,普通的 Java對象)映射成數(shù)據(jù)庫中的記錄装处。

無論是使用注解還是 xml 映射文件配置方式误债，在使用之前有兩步是必須的：

1. 引入依賴

   <dependency>
       <groupId>org.mybatis.spring.boot</groupId>
       <artifactId>mybatis-spring-boot-starter</artifactId>
   </dependency>
   

2. 在啟動類上加注解 @MapperScan 指明 mapper 類的位置

   @MapperScan("com.solo.coderiver.project.mapper")
   public class ProjectApplication {
       public static void main(String[] args) {
           SpringApplication.run(ProjectApplication.class, args);
       }
   }
   

一、注解方式

相比于 xml 映射方式妄迁，注解方式明顯更簡潔寝蹈，但沒有 xml 方式靈活。目前大部分公司還是主要用 xml 方式登淘。

package com.solo.coderiver.project.mapper;

import com.solo.coderiver.project.dataobject.ProjectInfo;
import org.apache.ibatis.annotations.*;

/**
 * 注解方式使用 mybatis 增刪改查
 */
@Mapper
public interface ProjectMapper {

    @Select("SELECT * FROM project_info WHERE project_id = #{id}")
    @Results({
            @Result(property = "projectId", column = "project_id"),
            @Result(property = "projectName", column = "project_name"),
            @Result(property = "projectAvatar", column = "project_avatar"),
            @Result(property = "projectDifficulty", column = "project_difficulty"),
            @Result(property = "categoryType", column = "category_type"),
            @Result(property = "categoryName", column = "category_name"),
            @Result(property = "projectProgress", column = "project_progress"),
            @Result(property = "projectStatus", column = "project_status"),
            @Result(property = "projectIntroduce", column = "project_introduce"),
            @Result(property = "projectCreatorId", column = "project_creator_id"),
            @Result(property = "teamId", column = "team_id"),
    })
    ProjectInfo findProjectById(String id);

    @Insert("INSERT INTO " +
            "project_info(project_id, project_name, project_avatar, project_difficulty," +
            " category_type, category_name, project_progress, project_status, " +
            "project_introduce, project_creator_id, team_id) " +
            "VALUES(#{projectId}, #{projectName}, #{projectAvatar}, #{projectDifficulty}," +
            "#{categoryType}, #{categoryName}, #{projectProgress}, #{projectStatus}," +
            "#{projectIntroduce}, #{projectCreatorId}, #{teamId})")
    int insertProject(ProjectInfo info);


    @Update("UPDATE project_info set project_name = #{name} where project_id = #{id}")
    int updateProjectName(String id, String name);

    @Delete("DELETE FROM project_info WHERE project_id = #{id}")
    int deleteProject(String id);

}

直接將 sql 語句寫在注解里箫老，免去了配置 xml 文件。但有個(gè)顯而易見的缺點(diǎn)是如果 sql 太長了黔州，像字段多的 @Insert 耍鬓，如果換行需要用 + 連接，不利于后期維護(hù)流妻。

MyBatis 支持的注解屬性表：

二违霞、xml 方式使用

2.1 快速實(shí)現(xiàn)

xml 配置方式使用 MyBatis 主要步驟有以下三步：

1. 配置 application.yml
2. 編寫 mapper xml 文件
3. 寫 mapper java 代碼

1. 配置 application.yml

首先在 application.yml 中配置數(shù)據(jù)庫實(shí)體對象的位置和mapper文件的位置嘴办，配置了 type-aliases-package 后就可以在 xml 文件中直接寫類名，而不用寫全限定類名啦买鸽。

mybatis:
  type-aliases-package: com.solo.coderiver.project.dataobject
  mapper-locations: classpath:mapper/*.xml

如果不配置 mapper-locations涧郊，會報(bào)如下錯(cuò)誤：

org.apache.ibatis.binding.BindingException: Invalid bound statement (not found): com.solo.coderiver.project.mapper.ProjectCategoryMapper.insert

2. 編寫 mapper xml 映射文件

以項(xiàng)目類型 ProjectCategory 為例，添加 MyBatis 的增刪改查實(shí)現(xiàn)

ProjectCategoryMapper.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.solo.coderiver.project.mapper.ProjectCategoryMapper" >

    <resultMap id="BaseResultMap" type="ProjectCategory">
        <id column="category_id" property="categoryId" jdbcType="INTEGER"/>
        <result column="category_name" property="categoryName" jdbcType="VARCHAR" />
        <result column="category_type" property="categoryType" jdbcType="INTEGER" />
    </resultMap>

    <insert id="insert" parameterType="ProjectCategory">
        insert into project_category(category_id, category_name, category_type)
        values(#{categoryId, jdbcType=INTEGER}, #{categoryName, jdbcType=VARCHAR}, #{categoryType, jdbcType=INTEGER})
    </insert>

    <delete id="deleteByType" parameterType="java.lang.Integer">
        delete from project_category
        where category_type = #{type, jdbcType=INTEGER}
    </delete>

    <update id="updateByType" parameterType="ProjectCategory">
        update project_category
        set category_name = #{categoryName}
        where category_type = #{categoryType}
    </update>

    <select id="selectByType" parameterType="java.lang.Integer" resultMap="BaseResultMap">
        select * from project_category
        where category_type = #{categoryType}
    </select>
</mapper>

后面會講配置的詳細(xì)屬性眼五。

3. 寫 mapper java 代碼

ProjectCategoryMapper.java

@Mapper
public interface ProjectCategoryMapper {

    int insert(ProjectCategory category);

    int deleteByType(Integer type);

    int updateByType(ProjectCategory category);

    ProjectCategory selectByType(Integer type);
}

新建一個(gè)接口底燎，方法名要跟 ProjectCategoryMapper.xml 里 <insert>、 <delete>弹砚、 <update>双仍、 <select> 等 sql 操作語句的 id 保持一致，否則會報(bào)錯(cuò)桌吃。

然后再在類名上加注解 @Mapper 就可以啦朱沃。

ProjectCategory對象

package com.solo.coderiver.project.dataobject;

import lombok.Data;

import javax.persistence.Entity;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;

@Entity
@Data
public class ProjectCategory {

    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Integer categoryId;

    private String categoryName;

    private Integer categoryType;

    public ProjectCategory() {
    }

    public ProjectCategory(Integer categoryType, String categoryName) {
        this.categoryName = categoryName;
        this.categoryType = categoryType;
    }
}

2.2 xml 映射文件詳解

SQL 映射文件有很少的幾個(gè)頂級元素（按照它們應(yīng)該被定義的順序）：

• cache – 給定命名空間的緩存配置。
• cache-ref – 其他命名空間緩存配置的引用茅诱。
• resultMap – 是最復(fù)雜也是最強(qiáng)大的元素逗物，用來描述如何從數(shù)據(jù)庫結(jié)果集中來加載對象。
• parameterMap – 已廢棄瑟俭！老式風(fēng)格的參數(shù)映射翎卓。內(nèi)聯(lián)參數(shù)是首選,這個(gè)元素可能在將來被移除，這里不會記錄摆寄。
• sql – 可被其他語句引用的可重用語句塊失暴。
• insert – 映射插入語句
• update – 映射更新語句
• delete – 映射刪除語句
• select – 映射查詢語句

select

查詢語句是 MyBatis 中最常用的元素之一坯门，光能把數(shù)據(jù)存到數(shù)據(jù)庫中價(jià)值并不大，如果還能重新取出來才有用逗扒，多數(shù)應(yīng)用也都是查詢比修改要頻繁古戴。對每個(gè)插入、更新或刪除操作矩肩，通常對應(yīng)多個(gè)查詢操作酒觅。這是
MyBatis 的基本原則之一篮奄，也是將焦點(diǎn)和努力放到查詢和結(jié)果映射的原因适掰。

上文中實(shí)現(xiàn)了一個(gè)簡單的 select 語句：

<select id="selectByType" parameterType="java.lang.Integer" resultMap="BaseResultMap">
    select * from project_category
    where category_type = #{categoryType}
</select>

這個(gè)語句被稱作 selectByType次绘，接受一個(gè) int（或 Integer）類型的參數(shù)，并返回一個(gè) BaseResultMap 定義的 ProjectCategory 對象刽酱。這條語句的作用是根據(jù)傳入的類型查詢項(xiàng)目類型信息喳逛。

注意參數(shù)符號：#{categoryType} , 它表明接收傳入的參數(shù) categoryType。

select 的屬性表：

<select
  id="selectPerson"
  parameterType="int"
  parameterMap="deprecated"
  resultType="hashmap"
  resultMap="personResultMap"
  flushCache="false"
  useCache="true"
  timeout="10000"
  fetchSize="256"
  statementType="PREPARED"
  resultSetType="FORWARD_ONLY">

像本文的例子一樣，select 常用的屬性其實(shí)就是 id杈女、 parameterType朱浴、resultMap 三個(gè)，其他的了解即可碧信。

insert, update 和 delete

數(shù)據(jù)變更語句 insert赊琳，update 和 delete 的實(shí)現(xiàn)非常接近：

<insert
  id="insertAuthor"
  parameterType="domain.blog.Author"
  flushCache="true"
  statementType="PREPARED"
  keyProperty=""
  keyColumn=""
  useGeneratedKeys=""
  timeout="20">

<update
  id="updateAuthor"
  parameterType="domain.blog.Author"
  flushCache="true"
  statementType="PREPARED"
  timeout="20">

<delete
  id="deleteAuthor"
  parameterType="domain.blog.Author"
  flushCache="true"
  statementType="PREPARED"
  timeout="20">

屬性表

三個(gè)更新操作常用的屬性只有兩個(gè)：id医舆、parameterType俘侠，其他的了解即可。

Result Maps

resultMap 元素是 MyBatis 中最重要最強(qiáng)大的元素蔬将。它可以讓你從 90% 的 JDBC ResultSets 數(shù)據(jù)提取代碼中解放出來爷速，并在一些情形下允許你做一些 JDBC 不支持的事情。
實(shí)際上霞怀，在對復(fù)雜語句進(jìn)行聯(lián)合映射的時(shí)候惫东，它很可能可以代替數(shù)千行的同等功能的代碼。
ResultMap 的設(shè)計(jì)思想是毙石，簡單的語句不需要明確的結(jié)果映射廉沮，而復(fù)雜一點(diǎn)的語句只需要描述它們的關(guān)系就行了。

下面是 resultMap 元素的概念視圖：

resultMap

• constructor

  - 用于在實(shí)例化類時(shí)徐矩，注入結(jié)果到構(gòu)造方法中

  • idArg - ID 參數(shù);標(biāo)記出作為 ID 的結(jié)果可以幫助提高整體性能
  • arg - 將被注入到構(gòu)造方法的一個(gè)普通結(jié)果

• id – 一個(gè) ID 結(jié)果;標(biāo)記出作為 ID 的結(jié)果可以幫助提高整體性能

• result – 注入到字段或 JavaBean 屬性的普通結(jié)果

• association

  – 一個(gè)復(fù)雜類型的關(guān)聯(lián);許多結(jié)果將包裝成這種類型

  • 嵌套結(jié)果映射 – 關(guān)聯(lián)可以指定為一個(gè) resultMap 元素滞时，或者引用一個(gè)

• collection

  – 一個(gè)復(fù)雜類型的集合

  • 嵌套結(jié)果映射 – 集合可以指定為一個(gè) resultMap 元素，或者引用一個(gè)

• discriminator

  – 使用結(jié)果值來決定使用哪個(gè)

  resultMap

  • case

    – 基于某些值的結(jié)果映射

    • 嵌套結(jié)果映射 – 一個(gè) case 也是一個(gè)映射它本身的結(jié)果,因此可以包含很多相同的元素滤灯，或者它可以參照一個(gè)外部的 resultMap坪稽。

為了方便理解贝咙，再把上面項(xiàng)目中定義的 resultMap 貼出來

<resultMap id="BaseResultMap" type="ProjectCategory">
    <id column="category_id" property="categoryId" jdbcType="INTEGER"/>
    <result column="category_name" property="categoryName" jdbcType="VARCHAR" />
    <result column="category_type" property="categoryType" jdbcType="INTEGER" />
</resultMap>

id 和 result 標(biāo)簽中的屬性表如下：

關(guān)于 jdbcType

發(fā)現(xiàn)有些小伙伴在寫映射文件的時(shí)候，都習(xí)慣性的把所有的需要傳入的參數(shù)都加上 jdbcType=""爬舰，那到底什么情況下需要指明威沫，什么情況下不需要指明呢？

查閱官方文檔看到了官方的描述：

如果一個(gè)列允許 null 值洼专，并且會傳遞值 null 的參數(shù)棒掠，就必須要指定 JDBC Type。

也就是說只有當(dāng)一個(gè)列允許 null 并有可能傳入 null 時(shí)屁商，才必須要指定 JDBC Type烟很，其他情況是不需要指定的。當(dāng)然指定了也沒錯(cuò)蜡镶，就是多寫點(diǎn)代碼雾袱。

明白了什么時(shí)候需要指定，那還有個(gè)問題官还，java 中的類型跟 jdbcType 的類型如何對應(yīng)呢芹橡？如果對應(yīng)關(guān)系寫錯(cuò)了也會報(bào)錯(cuò)。下面就整理出了兩者的對應(yīng)關(guān)系：

JDBCType 與 JavaType 對應(yīng)關(guān)系

  JDBCType            JavaType
    CHAR                String
    VARCHAR             String
    LONGVARCHAR         String
    NUMERIC             java.math.BigDecimal
    DECIMAL             java.math.BigDecimal
    BIT                 boolean
    BOOLEAN             boolean
    TINYINT             byte
    SMALLINT            short
    INTEGER             int
    BIGINT              long
    REAL                float
    FLOAT               double
    DOUBLE              double
    BINARY              byte[]
    VARBINARY           byte[]
    LONGVARBINARY       byte[]
    DATE                java.sql.Date
    TIME                java.sql.Time
    TIMESTAMP           java.sql.Timestamp
    CLOB                Clob
    BLOB                Blob
    ARRAY               Array
    DISTINCT            mapping of underlying type
    STRUCT              Struct
    REF                 Ref
    DATALINK            java.net.URL[color=red][/color]

2.3 補(bǔ)充

如果查詢返回的結(jié)果是個(gè)列表怎么辦望伦？如何提取出可復(fù)用的 sql 呢林说？

日常使用中還有這兩個(gè)常見的應(yīng)用場景，下面就以項(xiàng)目成員表 ProejctMember 來演示一下屯伞。

一個(gè)項(xiàng)目可以對應(yīng)多個(gè)成員腿箩，所以根據(jù)項(xiàng)目 id 查詢成員的話肯定查出來多條數(shù)據(jù)。

ProjectMemberMapper.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.solo.coderiver.project.mapper.ProjectMemberMapper">

    <resultMap id="BaseResultMap" type="ProjectMember">
        <id column="id" property="id" jdbcType="INTEGER"/>
        <result column="project_id" property="projectId" jdbcType="VARCHAR"/>
        <result column="project_name" property="projectName" jdbcType="VARCHAR"/>
        <result column="project_avatar" property="projectAvatar" jdbcType="VARCHAR"/>
        <result column="user_id" property="userId" jdbcType="VARCHAR"/>
        <result column="user_name" property="userName" jdbcType="VARCHAR"/>
        <result column="user_avatar" property="userAvatar" jdbcType="VARCHAR"/>
        <result column="user_role" property="userRole" jdbcType="INTEGER"/>
        <result column="role_name" property="roleName" jdbcType="VARCHAR"/>
        <result column="status" property="status" jdbcType="INTEGER"/>
    </resultMap>

    <sql id="baseColumns">
        id, project_id, project_name, project_avatar, user_id, user_name,
        user_avatar, user_role, role_name, status
    </sql>

    <select id="selectByProjectId" parameterType="java.lang.String" resultMap="BaseResultMap">
        select
        <include refid="baseColumns"/>
        from project_member
        where project_id = #{projectId, jdbcType=VARCHAR}
    </select>
</mapper>

ProjectMemberMapper.java

package com.solo.coderiver.project.mapper;

import com.solo.coderiver.project.dataobject.ProjectMember;
import org.apache.ibatis.annotations.Mapper;

import java.util.List;

@Mapper
public interface ProjectMemberMapper {

    List<ProjectMember> selectByProjectId(String projectId);
}

返回結(jié)果是列表的話劣摇，映射文件的 result 還是只給定 List 內(nèi)的類型即可珠移。

用 <sql> 標(biāo)簽來提出出可復(fù)用的 sql 語句

<sql id="baseColumns">
    id, project_id, project_name, project_avatar, user_id, user_name,
    user_avatar, user_role, role_name, status
</sql>

在需要用到的地方用 <include> 標(biāo)簽引入 sql

<select id="selectByProjectId" parameterType="java.lang.String"         resultMap="BaseResultMap">
    select
    <include refid="baseColumns"/>
    from project_member
    where project_id = #{projectId, jdbcType=VARCHAR}
</select>

然后在 service 中引用 mapper

package com.solo.coderiver.project.service.mybatis;

import com.solo.coderiver.project.dataobject.ProjectMember;
import com.solo.coderiver.project.mapper.ProjectMemberMapper;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

import java.util.List;

@Service
public class ProjectMemberServiceMyBatisImpl {

    @Autowired
    ProjectMemberMapper mapper;

    public List<ProjectMember> findByProjectId(String projectId){
        return mapper.selectByProjectId(projectId);
    }
}

單元測試

package com.solo.coderiver.project.service.mybatis;

import com.solo.coderiver.project.ProjectApplicationTests;
import com.solo.coderiver.project.dataobject.ProjectMember;
import org.junit.Assert;
import org.junit.Test;
import org.springframework.beans.factory.annotation.Autowired;

import java.util.List;

import static org.junit.Assert.*;

public class ProjectMemberServiceMyBatisImplTest extends ProjectApplicationTests {

    @Autowired
    ProjectMemberServiceMyBatisImpl service;

    @Test
    public void findByProjectId() {
        List<ProjectMember> list = service.findByProjectId("1541062468073593543");
        Assert.assertNotEquals(0, list.size());
    }
}

以上就是 MyBatis 在 SpringBoot 中的簡單使用方式介紹。

代碼出自開源項(xiàng)目 coderiver，致力于打造全平臺型全棧精品開源項(xiàng)目钧惧。

coderiver 中文名 河碼暇韧，是一個(gè)為程序員和設(shè)計(jì)師提供項(xiàng)目協(xié)作的平臺。無論你是前端浓瞪、后端锨咙、移動端開發(fā)人員，或是設(shè)計(jì)師追逮、產(chǎn)品經(jīng)理酪刀，都可以在平臺上發(fā)布項(xiàng)目，與志同道合的小伙伴一起協(xié)作完成項(xiàng)目钮孵。

coderiver河碼 類似程序員客棧骂倘，但主要目的是方便各細(xì)分領(lǐng)域人才之間技術(shù)交流，共同成長巴席，多人協(xié)作完成項(xiàng)目历涝。暫不涉及金錢交易。

計(jì)劃做成包含 pc端（Vue漾唉、React）荧库、移動H5（Vue、React）赵刑、ReactNative混合開發(fā)分衫、Android原生、微信小程序般此、java后端的全平臺型全棧項(xiàng)目蚪战，歡迎關(guān)注。

項(xiàng)目地址：https://github.com/cachecats/coderiver

您的鼓勵(lì)是我前行最大的動力铐懊，歡迎點(diǎn)贊邀桑，歡迎送小星星? ~