mybatis-入門

安裝

要使用 MyBatis， 只需將 mybatis-x.x.x.jar 文件置於 classpath 中便可。

若是使用 Maven 來構建項目，則需將下面的 dependency 代碼置於 pom.xml 文件中：

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

從 XML 中構建 SqlSessionFactory

每一個基於 MyBatis 的應用都是以一個 SqlSessionFactory 的實例爲中心的。SqlSessionFactory 的實例能夠經過 SqlSessionFactoryBuilder 得到。而 SqlSessionFactoryBuilder 則能夠從 XML 配置文件或一個預先定製的 Configuration 的實例構建出 SqlSessionFactory 的實例。

從 XML 文件中構建 SqlSessionFactory 的實例很是簡單，建議使用類路徑下的資源文件進行配置。可是也可使用任意的輸入流(InputStream)實例，包括字符串形式的文件路徑或者 file:// 的 URL 形式的文件路徑來配置。MyBatis 包含一個名叫 Resources 的工具類，它包含一些實用方法，可以使從 classpath 或其餘位置加載資源文件更加容易。

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

XML 配置文件（configuration XML）中包含了對 MyBatis 系統的核心設置，包含獲取數據庫鏈接實例的數據源（DataSource）和決定事務範圍和控制方式的事務管理器（TransactionManager）。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>

固然，還有不少能夠在XML 文件中進行配置，上面的示例指出的則是最關鍵的部分。要注意 XML 頭部的聲明，用來驗證 XML 文檔正確性。environment 元素體中包含了事務管理和鏈接池的配置。mappers 元素則是包含一組 mapper 映射器（這些 mapper 的 XML 文件包含了 SQL 代碼和映射定義信息）。

不使用 XML 構建 SqlSessionFactory

若是你更願意直接從 Java 程序而不是 XML 文件中建立 configuration，或者建立你本身的 configuration 構建器，MyBatis 也提供了完整的配置類，提供全部和 XML 文件相同功能的配置項。

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);

注意該例中，configuration 添加了一個映射器類（mapper class）。映射器類是 Java 類，它們包含 SQL 映射語句的註解從而避免了 XML 文件的依賴。不過，因爲 Java 註解的一些限制加之某些 MyBatis 映射的複雜性，XML 映射對於大多數高級映射（好比：嵌套 Join 映射）來講仍然是必須的。有鑑於此，若是存在一個對等的 XML 配置文件的話，MyBatis 會自動查找並加載它（這種狀況下， BlogMapper.xml 將會基於類路徑和 BlogMapper.class 的類名被加載進來）。具體細節稍後討論。

從 SqlSessionFactory 中獲取 SqlSession

既然有了 SqlSessionFactory ，顧名思義，咱們就能夠從中得到 SqlSession 的實例了。SqlSession 徹底包含了面向數據庫執行 SQL 命令所需的全部方法。你能夠經過 SqlSession 實例來直接執行已映射的 SQL 語句。例如：

SqlSession session = sqlSessionFactory.openSession();
try {
  Blog blog = (Blog) session.selectOne("org.mybatis.example.BlogMapper.selectBlog", 101);
} finally {
  session.close();
}

誠然這種方式可以正常工做，而且對於使用舊版本 MyBatis 的用戶來講也比較熟悉，不過如今有了一種更直白的方式。使用對於給定語句可以合理描述參數和返回值的接口（好比說BlogMapper.class），你如今不但能夠執行更清晰和類型安全的代碼，並且還不用擔憂易錯的字符串字面值以及強制類型轉換。

例如：

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

如今咱們來探究一下這裏究竟是怎麼執行的。

探究已映射的 SQL 語句
如今，或許你很想知道 SqlSession 和 Mapper 到底執行了什麼操做，而 SQL 語句映射是個至關大的話題，可能會佔去文檔的大部分篇幅。不過爲了讓你可以瞭解個大概，這裏會給出幾個例子。

在上面提到的兩個例子中，一個語句應該是經過 XML 定義，而另一個則是經過註解定義。先看 XML 定義這個，事實上 MyBatis 提供的所有特性能夠利用基於 XML 的映射語言來實現，這使得 MyBatis 在過去的數年間得以流行。若是你之前用過 MyBatis，這個概念應該會比較熟悉。不過 XML 映射文件已經有了不少的改進，隨着文檔的進行會愈發清晰。這裏給出一個基於 XML 映射語句的示例，它應該能夠知足上述示例中 SqlSession 的調用。

<?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>

對於簡單語句來講，註解使代碼顯得更加簡潔，然而 Java 註解對於稍微複雜的語句就會力不從心而且會顯得更加混亂。所以，若是你須要作很複雜的事情，那麼最好使用 XML 來映射語句。

選擇何種方式以及映射語句的定義的一致性對你來講有多重要這些徹底取決於你和你的團隊。換句話說，永遠不要拘泥於一種方式，你能夠很輕鬆的在基於註解和 XML 的語句映射方式間自由移植和切換。

範圍（Scope）和生命週期

理解咱們目前已經討論過的不一樣範圍和生命週期類是相當重要的，由於錯誤的使用會致使很是嚴重的併發問題。

提示 對象生命週期和依賴注入框架

依賴注入框架能夠建立線程安全的、基於事務的 SqlSession 和映射器（mapper）並將它們直接注入到你的 bean 中，所以能夠直接忽略它們的生命週期。若是對如何經過依賴注入框架來使用 MyBatis 感興趣能夠研究一下 MyBatis-Spring 或 MyBatis-Guice 兩個子項目。

SqlSessionFactoryBuilder

這個類能夠被實例化、使用和丟棄，一旦建立了 SqlSessionFactory，就再也不須要它了。所以 SqlSessionFactoryBuilder 實例的最佳範圍是方法範圍（也就是局部方法變量）。你能夠重用 SqlSessionFactoryBuilder 來建立多個 SqlSessionFactory 實例，可是最好仍是不要讓其一直存在以保證全部的 XML 解析資源開放給更重要的事情。

SqlSessionFactory

SqlSessionFactory 一旦被建立就應該在應用的運行期間一直存在，沒有任何理由對它進行清除或重建。使用 SqlSessionFactory 的最佳實踐是在應用運行期間不要重複建立屢次，屢次重建 SqlSessionFactory 被視爲一種代碼「壞味道（bad smell）」。所以 SqlSessionFactory 的最佳範圍是應用範圍。有不少方法能夠作到，最簡單的就是使用單例模式或者靜態單例模式。

SqlSession

每一個線程都應該有它本身的 SqlSession 實例。SqlSession 的實例不是線程安全的，所以是不能被共享的，因此它的最佳的範圍是請求或方法範圍。絕對不能將 SqlSession 實例的引用放在一個類的靜態域，甚至一個類的實例變量也不行。也毫不能將 SqlSession 實例的引用放在任何類型的管理範圍中，好比 Serlvet 架構中的 HttpSession。若是你如今正在使用一種 Web 框架，要考慮 SqlSession 放在一個和 HTTP 請求對象類似的範圍中。換句話說，每次收到的 HTTP 請求，就能夠打開一個 SqlSession，返回一個響應，就關閉它。這個關閉操做是很重要的，你應該把這個關閉操做放到 finally 塊中以確保每次都能執行關閉。下面的示例就是一個確保 SqlSession 關閉的標準模式：

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

在你的全部的代碼中一致性地使用這種模式來保證全部數據庫資源都能被正確地關閉。

映射器實例（Mapper Instances）

映射器是建立用來綁定映射語句的接口。映射器接口的實例是從 SqlSession 中得到的。所以從技術層面講，映射器實例的最大範圍是和 SqlSession 相同的，由於它們都是從 SqlSession 裏被請求的。儘管如此，映射器實例的最佳範圍是方法範圍。也就是說，映射器實例應該在調用它們的方法中被請求，用過以後便可廢棄。並不須要顯式地關閉映射器實例，儘管在整個請求範圍（request scope）保持映射器實例也不會有什麼問題，可是很快你會發現，像 SqlSession 同樣，在這個範圍上管理太多的資源的話會難於控制。因此要保持簡單，最好把映射器放在方法範圍（method scope）內。下面的示例就展現了這個實踐：

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