Spring Boot （七）： Mybatis極簡配置

時間 2020-04-24

原文原文鏈接

Spring Boot （七）： Mybatis極簡配置

1. 前言

ORM 框架的目的是簡化編程中的數據庫操做，通過這麼多年的發展，基本上活到如今的就剩下兩家了，一個是宣稱能夠不用寫 SQL 的 Hibernate ，一個是對 SQL 很是友好的 Mybaties ，,二者各有特色，在企業級系統開發中能夠根據需求靈活使用。發現一個有趣的現象：傳統企業大都喜歡使用 Hibernate ，互聯網行業一般使用 Mybatis 。html

Hibernate 特色就是全部的 SQL 都用 Java 代碼來生成，不用跳出程序去寫（看） SQL ，有着編程的完整性，發展到最頂端就是 Spring Data Jpa 這種模式了，基本上根據方法名就能夠生成對應的 SQL 了，有不太瞭解的能夠看筆者的前兩篇文章 Spring Boot （三）： ORM 框架 JPA 與鏈接池 Hikari 和 Spring Boot （六）：爲 JPA 插上翅膀的 QueryDSL。java

Mybatis 初期使用比較麻煩，須要各類配置文件、實體類、Dao 層映射關聯、還有一大推其它配置。固然 Mybatis 也發現了這種弊端，初期開發了 generator 能夠根據表結果自動生產實體類、配置文件和 Dao 層代碼，能夠減輕一部分開發量；後期也進行了大量的優化可使用註解了，自動管理 Dao 層和配置文件等，發展到最頂端就是今天要講的這種模式了，mybatis-spring-boot-starter 就是 Spring Boot + Mybatis 能夠徹底註解不用配置文件，也能夠簡單配置輕鬆上手。mysql

2. 工程實戰

首先建立父工程 spring-boot-mybatis，引入全局依賴包，以下：git

代碼清單：spring-boot-mybatis/pom.xmlgithub

<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <dependency>
        <groupId>org.mybatis.spring.boot</groupId>
        <artifactId>mybatis-spring-boot-starter</artifactId>
        <version>2.1.0</version>
    </dependency>

    <dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
        <scope>runtime</scope>
    </dependency>
    <dependency>
        <groupId>org.projectlombok</groupId>
        <artifactId>lombok</artifactId>
        <optional>true</optional>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-test</artifactId>
        <scope>test</scope>
    </dependency>
</dependencies>

mybatis-spring-boot-starter ：目前最新版本爲 2.1.0

2.1 極簡 xml 版

建立子工程 spring-boot-mybatis-xmlweb

2.1.1 配置文件

application.yml 配置文件以下：spring

代碼清單：spring-boot-mybatis/spring-boot-mybatis-xml/src/main/resources/application.ymlsql

server:
  port: 8080
spring:
  application:
    name: spring-boot-mybatis-xml
  datasource:
    url: jdbc:mysql://localhost:3306/test?serverTimezone=Asia/Shanghai&useUnicode=true&characterEncoding=UTF-8&useSSL=false
    username: root
    password: 123456
    driver-class-name: com.mysql.cj.jdbc.Driver
    type: com.zaxxer.hikari.HikariDataSource
    hikari:
      auto-commit: true
      minimum-idle: 2
      idle-timeout: 60000
      connection-timeout: 30000
      max-lifetime: 1800000
      pool-name: DatebookHikariCP
      maximum-pool-size: 5
mybatis:
  type-aliases-package: com.springboot.springbootmybatisxml.model
  config-location: classpath:mybatis/mybatis-config.xml
  mapper-locations: classpath:mybatis/mapper/*.xml

這裏使用 hikari 做爲數據庫鏈接池
Spring Boot 會自動加載 spring.datasource.* 相關配置，數據源會自動注入到 sqlSessionFactory 中， sqlSessionFactory 會自動注入到 Mapper 中。
這裏須要指定基礎配置文件和實體類映射文件的地址

mybatis-config.xml 配置文件以下：數據庫

代碼清單：spring-boot-mybatis/spring-boot-mybatis-xml/src/main/resources/mybatis/mybatis-config.xml編程

<configuration>
    <typeAliases>
        <typeAlias alias="Integer" type="java.lang.Integer" />
        <typeAlias alias="Long" type="java.lang.Long" />
        <typeAlias alias="HashMap" type="java.util.HashMap" />
        <typeAlias alias="LinkedHashMap" type="java.util.LinkedHashMap" />
        <typeAlias alias="ArrayList" type="java.util.ArrayList" />
        <typeAlias alias="LinkedList" type="java.util.LinkedList" />
    </typeAliases>
</configuration>

2.1.2 Mapper 映射文件

代碼清單：spring-boot-mybatis/spring-boot-mybatis-xml/src/main/resources/mybatis/mapper/UserMapper.xml

<mapper namespace="com.springboot.springbootmybatisxml.mapper.UserMapper" >

    <resultMap id="BaseResultMap" type="com.springboot.springbootmybatisxml.model.User" >
        <id column="id" property="id" jdbcType="VARCHAR" />
        <result column="nick_name" property="nickName" jdbcType="VARCHAR" />
        <result column="age" property="age" jdbcType="INTEGER" />
        <result column="create_date" property="createDate" jdbcType="TIME"/>
    </resultMap>

    <sql id="Base_Column_List" >
        id, nick_name, age, create_date
    </sql>

    <select id="getAll" resultMap="BaseResultMap"  >
        SELECT
            <include refid="Base_Column_List" />
        FROM user
    </select>

    <select id="getUser" parameterType="java.lang.String" resultMap="BaseResultMap" >
        SELECT
            <include refid="Base_Column_List" />
        FROM
            user
        WHERE id = #{id}
    </select>

    <insert id="insertUser" parameterType="com.springboot.springbootmybatisxml.model.User">
        <selectKey keyProperty="id" resultType="java.lang.String" order="BEFORE">
            select uuid() as id from dual
        </selectKey>
       INSERT INTO
       		user
       		(id, nick_name, age, create_date)
       	VALUES
       		(#{id}, #{nickName}, #{age}, #{createDate})
    </insert>

    <update id="updateUser" parameterType="com.springboot.springbootmybatisxml.model.User">
        UPDATE
            user
        SET
        <if test="nickName != null">nick_name = #{nickName},</if>
        <if test="age != null">age = #{age},</if>
        <if test="createDate != null">create_date = #{createDate}</if>
        WHERE
            id = #{id}
    </update>

    <delete id="deleteUser" parameterType="java.lang.String">
       DELETE FROM
       		 user
       WHERE
       		 id = #{id}
    </delete>

</mapper>

namespace ：需配置對應的接口
實現了簡單的 CRUD 操做
新增數據時選用 UUID 做爲主鍵
動態條件可以使用 <if> 標籤做判斷

2.1.3 Mapper 層代碼

代碼清單：spring-boot-mybatis/spring-boot-mybatis-xml/src/main/java/com/springboot/springbootmybatisxml/mapper/UserMapper.java

public interface UserMapper {

    List<User> getAll();

    User getUser(String id);

    Long insertUser(User user);

    Long updateUser(User user);

    Long deleteUser(String id);
}

這裏僅需定義接口方法， mybaties 會自動幫咱們調用 xml 映射文件中的代碼。

2.1.4 啓動主類

代碼清單：spring-boot-mybatis/spring-boot-mybatis-xml/src/main/java/com/springboot/springbootmybatisxml/SpringBootMybatisXmlApplication.java

@SpringBootApplication
@MapperScan("com.springboot.springbootmybatisxml.mapper")
public class SpringBootMybatisXmlApplication {

    public static void main(String[] args) {
        SpringApplication.run(SpringBootMybatisXmlApplication.class, args);
    }

}

在啓動主類上配置 @MapperScan 或者直接在 Mapper 類上增長註解 @Mapper ，兩種方法起到的結果是同樣的。不過建議選擇在啓動主類上配置 @MapperScan ，否則在每一個 Mapper 類上加註解也麻煩，還容易漏加。

2.2 無配置文件註解版

2.2.1 配置

配置文件 application.yml 以下：

代碼清單：

mybatis:
  type-aliases-package: com.springboot.springbootmybatisannotation.model

剩餘部分和上面一致， mybatis 的配置僅需配置這一條足夠

2.2.2 Mapper 類

註解版的核心就是這個類，全部的 SQL 都在這個類裏面，代碼以下：

代碼清單：

public interface UserMapper {

    @Select("select * from user")
    @Results({
            @Result(property = "id", column = "id"),
            @Result(property = "nickName", column = "nick_name"),
            @Result(property = "age", column = "age"),
            @Result(property = "createDate", column = "create_date")
    })
    List<User> getAll();

    @Select("SELECT * FROM user WHERE id = #{id}")
    @Results({
            @Result(property = "nickName", column = "nick_name")
    })
    User getUser(String id);

    @Insert("INSERT INTO user(id, nick_name, age, create_date) VALUES(#{id}, #{nickName}, #{age}, #{createDate})")
    @SelectKey(keyProperty = "id", resultType = String.class, before = true, statement = "select uuid() as id from dual")
    Long insertUser(User user);

    @Update("UPDATE user SET nick_name = #{nickName}, age = #{age} WHERE create_date = #{createDate}")
    Long updateUser(User user);

    @Delete("DELETE FROM user WHERE id = #{id}")
    Long deleteUser(String id);
}