Java持久層框架Mybatis入門

自動化程式碼美學發表於2021-06-19
Java框架MyBatis

MyBatis是什麼

MyBatis是Java的持久層框架，GitHub的star數高達15.8k，是Java技術棧中最熱門的ORM框架之一。它支援自定義SQL、儲存過程以及高階對映，可以通過XML或註解來配置和對映原始型別、介面和Java POJOs為資料庫中的記錄。

POJOs，Plain Old Java Objects，純的傳統意義的Java物件，最基本的Java Bean只有屬性加上屬性的get和set方法。

MyBatis logo

安裝

Maven pom.xml：

<dependency>
  <groupId>org.mybatis</groupId>
  <artifactId>mybatis</artifactId>
  <version>x.x.x</version>
</dependency>

版本查詢：https://mvnrepository.com/artifact/org.mybatis/mybatis

SqlSessionFactory

SqlSessionFactory的例項是每個MyBatis應用的核心，通過SqlSessionFactoryBuilder建立，能基於XML配置，也能使用Configuration類。

基於XML配置：

String resource = "org/mybatis/example/mybatis-config.xml";
InputStream inputStream = Resources.getResourceAsStream(resource);
SqlSessionFactory sqlSessionFactory =
  new SqlSessionFactoryBuilder().build(inputStream);

實際專案中不會手動設定XML檔案路徑，而是直接讀取classpath去找XML。

使用Configuration類：

DataSource dataSource = BlogDataSourceFactory.getBlogDataSource();
TransactionFactory transactionFactory =
  new JdbcTransactionFactory();
Environment environment =
  new Environment("development", transactionFactory, dataSource);
Configuration configuration = new Configuration(environment);
configuration.addMapper(BlogMapper.class);
SqlSessionFactory sqlSessionFactory =
  new SqlSessionFactoryBuilder().build(configuration);

由於Java註解的一些限制以及某些MyBatis對映的複雜性，MyBatis會優先選擇XML配置。在上面的示例中，MyBatis會根據classpath和BlogMapper.class去找BlogMapper.xml。

SqlSession

SqlSessionFactory能建立SqlSession例項，SqlSession提供了在資料庫執行SQL的所有方法。比如：

try (SqlSession session = sqlSessionFactory.openSession()) {
  BlogMapper mapper = session.getMapper(BlogMapper.class);
  Blog blog = mapper.selectBlog(101);
}

背後的SQL語句

隱藏在mapper.selectBlog()方法背後的SQL語句是配置在XML檔案裡面的。

一般XML的配置資訊如下：

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE configuration
  PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
  "http://mybatis.org/dtd/mybatis-3-config.dtd">
<configuration>
  <environments default="development">
    <environment id="development">
      <transactionManager type="JDBC"/>
      <dataSource type="POOLED">
        <property name="driver" value="${driver}"/>
        <property name="url" value="${url}"/>
        <property name="username" value="${username}"/>
        <property name="password" value="${password}"/>
      </dataSource>
    </environment>
  </environments>
  <mappers>
    <mapper resource="org/mybatis/example/BlogMapper.xml"/>
  </mappers>
</configuration>

environment配置了資料來源和連線池。

mapper包含了SQL語句：

<?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="org.mybatis.example.BlogMapper">
  <select id="selectBlog" resultType="Blog">
    select * from Blog where id = #{id}
  </select>
</mapper>

mapper.selectBlog()方法對映到了XML裡面的id selectBlog。

值得注意的是，對於簡單SQL來說，可以直接使用Java註解：

package org.mybatis.example;
public interface BlogMapper {
  @Select("SELECT * FROM blog WHERE id = #{id}")
  Blog selectBlog(int id);
}

但是對於複雜SQL還是寫XML更方便。

作用域與生命週期

從前面幾個小節我們知道了SqlSessionFactoryBuilder→SqlSessionFactory→SqlSession→Mapper Instances的例項物件產生鏈路，接下來看看它們各自的作用域與生命週期：

  • SqlSessionFactoryBuilder

    作用域是method，用完就釋放，避免XML解析資源佔用。

  • SqlSessionFactory

    作用域是application，只要建立就一直存在，可以通過單例模式來實現。

  • SqlSession

    作用域是request或method，每個執行緒獨一份，每次收到HTTP請求，開啟一個SqlSession，返回響應後，就關閉它。以下程式碼能確保每次關閉：

    try (SqlSession session = sqlSessionFactory.openSession()) {
  // do work
}

  • Mapper Instances

    它是由SqlSession建立的，作用域類似，不過更建議放到method，用完就釋放，比如：

    try (SqlSession session = sqlSessionFactory.openSession()) {
  BlogMapper mapper = session.getMapper(BlogMapper.class);
  // do work
}

小結

本文首先介紹了MyBatis是什麼，然後通過SqlSessionFactoryBuilder→SqlSessionFactory→SqlSession→Mapper Instances鏈路闡述了MyBatis是如何從資料庫查詢SQL對映到程式碼裡面的，最後給出了這幾個類例項的作用域的使用建議。

參考資料：

https://mybatis.org/mybatis-3/getting-started.html

https://www.jianshu.com/p/b934b0d72602

相關文章