MyBatis Java API

MyBatis 大幅簡化你的代碼并力圖保持其簡潔、容易理解和維護。

為了使得 SQL 映射更加優秀,MyBatis 3 引入了許多重要的改進。

1 目錄結構

MyBatis 非常靈活,你可以隨意安排你的文件。

但和其它框架一樣,目錄結構有一種最佳實踐。

/example

? /src/main/java

? ? /org/mybatis/example

? ? ? /action

? ? ? /domain

? ? ? /mapper

? ? ? /service

? /src/main/resources

? ? /org/mybatis/example

? ? ? /mapper

? /src/test/java

? /src/test/resources

? /web

當然,這是推薦的目錄結構,并非強制要求。

但使用一個通用的目錄結構將更有利于大家溝通。

2 SqlSession

使用 MyBatis 的主要 Java 接口就是 SqlSession。

SqlSessions 是由 SqlSessionFactory 實例創建的。

而 SqlSessionFactory 本身是由 SqlSessionFactoryBuilder 創建的。

SqlSessionFactoryBuilder 有五個 build() 方法,每一種都允許你從不同的資源中創建一個 SqlSessionFactory 實例。

SqlSessionFactory build(InputStream inputStream)

SqlSessionFactory build(InputStream inputStream, String environment)

SqlSessionFactory build(InputStream inputStream, Properties properties)

SqlSessionFactory build(InputStream inputStream, String env, Properties props)

SqlSessionFactory build(Configuration config)

第一種方法是最常用的,它接受一個指向 XML 文件(也就是之前討論的 mybatis-config.xml 文件)的 InputStream 實例。

以下給出一個從 mybatis-config.xml 文件創建 SqlSessionFactory 的示例:

String resource = "org/mybatis/builder/mybatis-config.xml";

InputStream inputStream = Resources.getResourceAsStream(resource);

SqlSessionFactoryBuilder builder = new SqlSessionFactoryBuilder();

SqlSessionFactory factory = builder.build(inputStream);

Resources 會從類路徑下、文件系統或一個 web URL 中加載資源文件。 在略讀該類的源代碼后,你會發現一整套相當實用的方法。 這里給出一個簡表:

URL getResourceURL(String resource)

URL getResourceURL(ClassLoader loader, String resource)

InputStream getResourceAsStream(String resource)

InputStream getResourceAsStream(ClassLoader loader, String resource)

Properties getResourceAsProperties(String resource)

Properties getResourceAsProperties(ClassLoader loader, String resource)

Reader getResourceAsReader(String resource)

Reader getResourceAsReader(ClassLoader loader, String resource)

File getResourceAsFile(String resource)

File getResourceAsFile(ClassLoader loader, String resource)

InputStream getUrlAsStream(String urlString)

Reader getUrlAsReader(String urlString)

Properties getUrlAsProperties(String urlString)

Class classForName(String className)

SqlSessionFactory 有六個方法創建 SqlSession 實例。

SqlSession openSession()

SqlSession openSession(boolean autoCommit)

SqlSession openSession(Connection connection)

SqlSession openSession(TransactionIsolationLevel level)

SqlSession openSession(ExecutorType execType, TransactionIsolationLevel level)

SqlSession openSession(ExecutorType execType)

SqlSession openSession(ExecutorType execType, boolean autoCommit)

SqlSession openSession(ExecutorType execType, Connection connection)

Configuration getConfiguration();

默認的 openSession() 方法沒有參數,它會創建具備如下特性的 SqlSession:

事務作用域將會開啟(也就是不自動提交)。

將由當前環境配置的 DataSource 實例中獲取 Connection 對象。

事務隔離級別將會使用驅動或數據源的默認設置。

預處理語句不會被復用,也不會批量處理更新。

正如之前所提到的,SqlSession 在 MyBatis 中是非常強大的一個類。 它包含了所有執行語句、提交或回滾事務以及獲取映射器實例的方法。 SqlSession 類的方法超過了 20 個,為了方便理解,我們將它們分成幾種組別。

語句執行方法

這些方法被用來執行定義在 SQL 映射 XML 文件中的 SELECT、INSERT、UPDATE 和 DELETE 語句。

事務控制方法

有四個方法用來控制事務作用域。

void commit()

void commit(boolean force)

void rollback()

void rollback(boolean force)

確保 SqlSession 被關閉

void close()

SqlSession session = null;

try {

// 從類路徑下加載資源文件mybatis-config.xml

String resource = "org/mybatis/example/mybatis-config.xml";

InputStream inputStream = Resources.getResourceAsStream(resource);

// 由 SqlSessionFactoryBuilder創建SqlSessionFactory

SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);

// 由 SqlSessionFactory創建SqlSession

session = sqlSessionFactory.openSession();

// ...

session.commit();

} catch (IOException e) {

e.printStackTrace();

session.rollback(true);

} finally {

session.close();

}

使用映射器

<T> T getMapper(Class<T> type)

上述的各個 insert、update、delete 和 select 方法都很強大,但也有些繁瑣,它們并不符合類型安全,對你的 IDE 和單元測試也不是那么友好。

因此,使用映射器類來執行映射語句是更常見的做法。

下面的示例展示了一些方法簽名以及它們是如何映射到 SqlSession 上的。

public interface AuthorMapper {

Author selectAuthor(int id);

List<Author> selectAuthors();

int insertAuthor(Author author);

int updateAuthor(Author author);

int deleteAuthor(int id);

}

映射器注解

設計初期的 MyBatis 是一個 XML 驅動的框架。配置信息是基于 XML 的,映射語句也是定義在 XML 中的。

MyBatis 3 構建在全面且強大的基于 Java 語言的配置 API 之上。它是 XML 和注解配置的基礎。

注解提供了一種簡單且低成本的方式來實現簡單的映射語句。

@Insert("insert into author (id, username, password, email, bio, favourite_section) "

+ "values(#{id}, #{username}, #{password}, #{email}, #{bio}, #{favouriteSection})")

int insertAuthorAnnotation(Author author);

@Update("update author set username = #{username}, password = #{password},"

+ " email = #{email}, bio = #{bio}, favourite_section = #{favouriteSection}" + " where id = #{id}")

int updateAuthorAnnotation(Author author);

@Delete("delete from author where id = #{id}")

public void deleteAuthorAnnotation(@Param("id") int id);

?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 227,818評論 6 531
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 98,185評論 3 414
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 175,656評論 0 373
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 62,647評論 1 309
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 71,446評論 6 405
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 54,951評論 1 321
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,041評論 3 440
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 42,189評論 0 287
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 48,718評論 1 333
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 40,602評論 3 354
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 42,800評論 1 369
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,316評論 5 358
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,045評論 3 347
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,419評論 0 26
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 35,671評論 1 281
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 51,420評論 3 390
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 47,755評論 2 371

推薦閱讀更多精彩內容