Spring Boot(六)：如何優雅的使用 Mybatis

純潔的微笑發表於2016-11-07
Spring BootMyBatis

這兩天啟動了一個新專案因為專案組成員一直都使用的是 Mybatis，雖然個人比較喜歡 Jpa 這種極簡的模式，但是為了專案保持統一性技術選型還是定了 Mybatis 。到網上找了一下關於 Spring Boot 和 Mybatis 組合的相關資料，各種各樣的形式都有，看的人心累，結合了 Mybatis 的官方 Demo 和文件終於找到了最簡的兩種模式，花了一天時間總結後分享出來。

Orm 框架的本質是簡化程式設計中運算元據庫的編碼，發展到現在基本上就剩兩家了，一個是宣稱可以不用寫一句 Sql 的 Hibernate，一個是可以靈活除錯動態 Sql 的 Mybatis ,兩者各有特點，在企業級系統開發中可以根據需求靈活使用。發現一個有趣的現象：傳統企業大都喜歡使用 Hibernate ,網際網路行業通常使用 Mybatis 。

Hibernate 特點就是所有的 Sql 都用 Java 程式碼來生成，不用跳出程式去寫（看） Sql ，有著程式設計的完整性，發展到最頂端就是 Spring Data Jpa 這種模式了，基本上根據方法名就可以生成對應的 Sql 了，有不太瞭解的可以看我的上篇文章Spring Boot(五)： Spring Data Jpa 的使用。

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

現在想想 Spring Boot 就是牛逼呀，任何東西只要關聯到 Spring Boot 都是化繁為簡。

mybatis-spring-boot-starter

官方說明：MyBatis Spring-Boot-Starter will help you use MyBatis with Spring Boot
其實就是 Mybatis 看 Spring Boot 這麼火熱也開發出一套解決方案來湊湊熱鬧，但這一湊確實解決了很多問題，使用起來確實順暢了許多。mybatis-spring-boot-starter主要有兩種解決方案，一種是使用註解解決一切問題，一種是簡化後的老傳統。

當然任何模式都需要首先引入mybatis-spring-boot-starter的 Pom 檔案，現在最新版本是 2.0.0

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

好了下來分別介紹兩種開發模式

無配置檔案註解版

就是一切使用註解搞定。

1 新增相關 Maven 檔案

<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.0.0</version>
    </dependency>
     <dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
    </dependency>
</dependencies>

完整的 Pom 包這裡就不貼了，大家直接看原始碼

2、application.properties 新增相關配置

mybatis.type-aliases-package=com.neo.model

spring.datasource.url=jdbc:mysql://localhost:3306/test?serverTimezone=UTC&useUnicode=true&characterEncoding=utf-8&useSSL=true
spring.datasource.username=root
spring.datasource.password=root
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver

Spring Boot 會自動載入 spring.datasource.* 相關配置，資料來源就會自動注入到 sqlSessionFactory 中，sqlSessionFactory 會自動注入到 Mapper 中，對了，你一切都不用管了，直接拿起來使用就行了。

在啟動類中新增對 mapper 包掃描@MapperScan

@SpringBootApplication
@MapperScan("com.neo.mapper")
public class MybatisAnnotationApplication {

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

或者直接在 Mapper 類上面新增註解@Mapper，建議使用上面那種，不然每個 mapper 加個註解也挺麻煩的

3、開發 Mapper

第三步是最關鍵的一塊， Sql 生產都在這裡

public interface UserMapper {

    @Select("SELECT * FROM users")
    @Results({
        @Result(property = "userSex",  column = "user_sex", javaType = UserSexEnum.class),
        @Result(property = "nickName", column = "nick_name")
    })
    List<UserEntity> getAll();

    @Select("SELECT * FROM users WHERE id = #{id}")
    @Results({
        @Result(property = "userSex",  column = "user_sex", javaType = UserSexEnum.class),
        @Result(property = "nickName", column = "nick_name")
    })
    UserEntity getOne(Long id);

    @Insert("INSERT INTO users(userName,passWord,user_sex) VALUES(#{userName}, #{passWord}, #{userSex})")
    void insert(UserEntity user);

    @Update("UPDATE users SET userName=#{userName},nick_name=#{nickName} WHERE id =#{id}")
    void update(UserEntity user);

    @Delete("DELETE FROM users WHERE id =#{id}")
    void delete(Long id);

}

為了更接近生產我特地將 user_sex、nick_name 兩個屬性在資料庫加了下劃線和實體類屬性名不一致，另外 user_sex 使用了列舉

  • @Select 是查詢類的註解，所有的查詢均使用這個
  • @Result 修飾返回的結果集，關聯實體類屬性和資料庫欄位一一對應，如果實體類屬性和資料庫屬性名保持一致，就不需要這個屬性來修飾。
  • @Insert 插入資料庫使用，直接傳入實體類會自動解析屬性到對應的值
  • @Update 負責修改，也可以直接傳入物件
  • @delete 負責刪除

瞭解更多屬性參考這裡

注意，使用#符號和$符號的不同：

// This example creates a prepared statement, something like select * from teacher where name = ?;
@Select("Select * from teacher where name = #{name}")
Teacher selectTeachForGivenName(@Param("name") String name);

// This example creates n inlined statement, something like select * from teacher where name = 'someName';
@Select("Select * from teacher where name = '${name}'")
Teacher selectTeachForGivenName(@Param("name") String name);

4、使用

上面三步就基本完成了相關 Mapper 層開發，使用的時候當作普通的類注入進入就可以了

@RunWith(SpringRunner.class)
@SpringBootTest
public class UserMapperTest {

    @Autowired
    private UserMapper userMapper;

    @Test
    public void testInsert() throws Exception {
        userMapper.insert(new User("aa1", "a123456", UserSexEnum.MAN));
        userMapper.insert(new User("bb1", "b123456", UserSexEnum.WOMAN));
        userMapper.insert(new User("cc1", "b123456", UserSexEnum.WOMAN));

        Assert.assertEquals(3, userMapper.getAll().size());
    }

    @Test
    public void testQuery() throws Exception {
        List<User> users = userMapper.getAll();
        System.out.println(users.toString());
    }


    @Test
    public void testUpdate() throws Exception {
        User user = userMapper.getOne(30l);
        System.out.println(user.toString());
        user.setNickName("neo");
        userMapper.update(user);
        Assert.assertTrue(("neo".equals(userMapper.getOne(30l).getNickName())));
    }
}

原始碼中 Controller 層有完整的增刪改查，這裡就不貼了

極簡 xml 版本

極簡 xml 版本保持對映檔案的老傳統，介面層只需要定義空方法，系統會自動根據方法名在對映檔案中找對應的 Sql .

1、配置

pom 檔案和上個版本一樣，只是application.properties新增以下配置

mybatis.config-location=classpath:mybatis/mybatis-config.xml
mybatis.mapper-locations=classpath:mybatis/mapper/*.xml

指定了 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>

這裡也可以新增一些 Mybatis 基礎的配置

2、新增 User 的對映檔案

<mapper namespace="com.neo.mapper.UserMapper" >
    <resultMap id="BaseResultMap" type="com.neo.entity.UserEntity" >
        <id column="id" property="id" jdbcType="BIGINT" />
        <result column="userName" property="userName" jdbcType="VARCHAR" />
        <result column="passWord" property="passWord" jdbcType="VARCHAR" />
        <result column="user_sex" property="userSex" javaType="com.neo.enums.UserSexEnum"/>
        <result column="nick_name" property="nickName" jdbcType="VARCHAR" />
    </resultMap>

    <sql id="Base_Column_List" >
        id, userName, passWord, user_sex, nick_name
    </sql>

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

    <select id="getOne" parameterType="java.lang.Long" resultMap="BaseResultMap" >
        SELECT 
       <include refid="Base_Column_List" />
       FROM users
       WHERE id = #{id}
    </select>

    <insert id="insert" parameterType="com.neo.entity.UserEntity" >
       INSERT INTO 
            users
            (userName,passWord,user_sex) 
        VALUES
            (#{userName}, #{passWord}, #{userSex})
    </insert>

    <update id="update" parameterType="com.neo.entity.UserEntity" >
       UPDATE 
            users 
       SET 
        <if test="userName != null">userName = #{userName},</if>
        <if test="passWord != null">passWord = #{passWord},</if>
        nick_name = #{nickName}
       WHERE 
            id = #{id}
    </update>

    <delete id="delete" parameterType="java.lang.Long" >
       DELETE FROM
             users 
       WHERE 
             id =#{id}
    </delete>
</mapper>

其實就是把上個版本中 Mapper 的 Sql 搬到了這裡的 xml 中了

3、編寫 Mapper 層的程式碼

public interface UserMapper {

    List<UserEntity> getAll();

    UserEntity getOne(Long id);

    void insert(UserEntity user);

    void update(UserEntity user);

    void delete(Long id);

}

對比上一步，這裡只需要定義介面方法

4、使用

使用和上個版本沒有任何區別，大家就看文章對應的示例程式碼吧

如何選擇

兩種模式各有特點，註解版適合簡單快速的模式，其實像現在流行的這種微服務模式，一個微服務就會對應一個自已的資料庫，多表連線查詢的需求會大大的降低，會越來越適合這種模式。

老傳統模式比適合大型專案，可以靈活的動態生成 Sql ，方便調整 Sql ，也有痛痛快快，洋洋灑灑的寫 Sql 的感覺。

文章內容已經升級到 Spring Boot 2.x

示例程式碼-github

示例程式碼-碼雲

相關文章