基本用法回顧:
SQL語句存儲在XML文件或Java 註解中。一個MaBatis映射的示例(其中用到了Java接口和MyBatis註解):
package org.mybatis.example;public interface BlogMapper { @Select("select * from Blog where id = #{id}") Blog selectBlog(int id);}執行的示例:
BlogMapper mapper = session.getMapper(BlogMapper.class);Blog blog = mapper.selectBlog(101);
SQL語句和映射也可以外化到一個XML文件中:
<?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" parameterType="int" resultType="Blog"> select * from Blog where id = #{id} </select></mapper>也可以使用MyBatis API執行語句:
Blog blog = session.selectOne("org.mybatis.example.BlogMapper.selectBlog", 101);詳細信息可以參考MyBatis網站所提供的用戶手冊。
與Spring集成
MyBatis與Spring Framework集成。 Spring Framework允許MyBatis參與Spring事務,創建了MyBatis映射器和會話,並把他們注入到其他bean中。
如下是一個基本的XML配置示例:創建了映射器,並註入到“BlogService”bean中。
<bean id="sqlSessionFactory"> <property name="dataSource" ref="dataSource" /></bean><bean id="blogMapper"> <property name="sqlSessionFactory" ref="sqlSessionFactory" /> <property name="mapperInterface" value="org.mybatis.example.BlogMapper" /></bean><bean id="blogService"> <property name="blogMapper" ref="blogMapper" /></bean>
現在調用MyBatis只需要調用一個bean:
public class BlogServiceImpl implements BlogService { private BlogMapper blogMapper; public void setBlogMapper(BlogMapper blogMapper) { this.blogMapper = blogMapper; } public void doSomethingWithABlog(int blogId) { Blog blog = blogMapper.selectBlog(blogId); ... }} SqlSessionFactory
每一個MyBatis 的應用程序都以一個SqlSessionFactory 對象的實例為核心。 SqlSessionFactory本身是由SqlSessionFactoryBuilder創建的,一般而言,在一個應用中,一個數據庫只會對應一個SqlSessionFactory,所以一般我們都把SqlSessionFactory定義成單例模式,或通過Spring等進行注入。
SqlSessionFactoryBuilder創建SqlSessionFactory的方法有:
這些方法主要設計到的參數有InputStream,environment,properties,其中InputStream是從配置文件中獲取的一個輸入流;environment表示在配置文件裡面配置的眾多的environment中,當前要使用的是哪一個environment,包括數據源和事務,缺省則使用默認的environment;使用properties,MyBatis則會加載對應的屬性或文件,它們可以在配置文件中使用。
從XML中構建SqlSessionFactory
private static SqlSessionFactory sqlSessionFactory = null; static { try { InputStream is = Resources.getResourceAsStream("config/mybatis_config.xml"); sqlSessionFactory = new SqlSessionFactoryBuilder().build(is); } catch (IOException e) { // TODO Auto-generated catch block e.printStackTrace(); } } public static SqlSessionFactory getSqlSessionFactory() { return sqlSessionFactory; }
下面講講配置文件的基本結構:
mybatis的配置文件一般包括如下幾個部分:
<environments default="development"> <environment id="development"> <transactionManager type="JDBC" /> <dataSource type="POOLED"> <property name="driver" value="${jdbc.driver}" /> <property name="url" value="${jdbc.url}" /> <property name="username" value="${jdbc.username}" /> <property name="password" value="${jdbc.password}" /> </dataSource> </environment> </environments>由於MyBatis可以配置多個environment,所以可以在創建SqlSessionFactory的時候指定具體的環境來創建特定的環境下的SqlSessionFactory, 不指定則使用默認的環境。
transactionManager
在MyBatis 中有兩種事務管理器類型(也就是type=”[JDBC|MANAGED]”):
JDBC 這個配置直接簡單使用了JDBC 的提交和回滾設置。 它依賴於從數據源得到的連接來管理事務範圍。
MANAGED 這個配置幾乎沒做什麼。它從來不提交或回滾一個連接。而它會讓容器來管理事務的整個生命週期(比如Spring 或JEE 應用服務器的上下文) 默認情況下它會關閉連接。 然而一些容器並不希望這樣, 因此如果你需要從連接中停止它,將closeConnection 屬性設置為false。
dataSource
dataSource 元素使用基本的JDBC 數據源接口來配置JDBC 連接對象的資源。
許多MyBatis 的應用程序將會按示例中的例子來配置數據源。 然而它並不是必須的。 要知道為了方便使用延遲加載,數據源才是必須的。
有三種內建的數據源類型(也就是type=”???”):
UNPOOLED 這個數據源的實現是每次被請求時簡單打開和關閉連接。它有一點慢, 這是對簡單應用程序的一個很好的選擇, 因為它不需要及時的可用連接。 不同的數據庫對這個的表現也是不一樣的, 所以對某些數據庫來說配置數據源並不重要, 這個配置也是閒置的。 UNPOOLED 類型的數據源僅僅用來配置以下5 種屬性:
作為可選項,你可以傳遞數據庫驅動的屬性。要這樣做,屬性的前綴是以“driver.”開頭的,例如:
driver.encoding=UTF8
這樣就會傳遞以值“ UTF8 ” 來傳遞屬性“ encoding ”, 它是通過DriverManager.getConnection(url,driverProperties)方法傳遞給數據庫驅動。
POOLED 這是JDBC 連接對象的數據源連接池的實現,用來避免創建新的連接實例時必要的初始連接和認證時間。這是一種當前Web 應用程序用來快速響應請求很流行的方法。
除了上述(UNPOOLED)的屬性之外,還有很多屬性可以用來配置POOLED 數據源:
其中JNDI 這個數據源配置只需要兩個屬性:
(1)initial_context 這個屬性用來從初始上下文中尋找環境( 也就是initialContext.lookup(initial――context) 。這是個可選屬性,如果被忽略,那麼data_source 屬性將會直接以initialContext 為背景再次尋找。
(2)data_source 這是引用數據源實例位置的上下文的路徑。它會以由initial_context 查詢返回的環境為背景來查找,如果initial_context 沒有返回結果時,直接以初始上下文為環境來查找。
再之後就是Mapper了,Mapper就是映射SQL語句的,首先要告訴mybatis要到哪裡去找這些SQL語句,即指定資源位置。
<mappers> <mapper resource="com/tiantian/mybatis/model/BlogMapper.xml"/> </mappers>
下面是我在測試過程中的一個簡單的配置文件:
<?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> <properties resource="config/jdbc.properties"></properties> <typeAliases> <typeAlias alias="Blog" type="com.tiantian.mybatis.model.Blog"/> </typeAliases> <environments default="development"> <environment id="development"> <transactionManager type="JDBC" /> <dataSource type="POOLED"> <property name="driver" value="${jdbc.driver}" /> <property name="url" value="${jdbc.url}" /> <property name="username" value="${jdbc.username}" /> <property name="password" value="${jdbc.password}" /> </dataSource> </environment> </environments> <mappers> <mapper resource="com/tiantian/mybatis/model/BlogMapper.xml"/> </mappers> </configuration>
在上面配置文件中導入了一個外部的屬性文件,MyBatis配置文件中的屬性引入可以是直接包含在properties元素中的,也可以是利用properties元素從外部引入的,還可以是在創建SqlSessionFactory的時候,作為一個參數properties傳入。既然MyBatis配置文件中的屬性可以從這麼多地方引入,那就牽涉到一個優先級的問題,MyBatis將會按照下面的順序來尋找它們:
先是配置文件中,properties元素體中的屬性被讀取再是利用properties元素從外部引入的屬性文件中的屬性被讀取,會覆蓋前面讀取的相同的屬性最後是創建SqlSessionFactory時傳入的properties中的屬性被讀取,同樣會覆蓋前面相同的屬性
在有了SqlSessionFactory之後就是獲取特定的SqlSession了,在使用mybatis的過程中每一個操作都是離不開SqlSession的,所以獲取SqlSession是相當重要的。此外,SqlSession是不能被共享、線程不安全的,所以在每次需要SqlSession的時候都應該打開一個,然後在用完了之後再把它關上。
SqlSession session = sqlSessionFactory.openSession();
SqlSessionFactory中湖區SqlSession的方法有:
它們的主要區別在於:
默認的opensession方法沒有參數,它會創建有如下特性的SqlSession:
ExecutorType有三個值:
mybatis的基本操作就是增、刪、改、查,即insert、delete、update和select。在進行這些基本的操作的時候可以直接利用SqlSession訪問Mapper配置文件裡面的映射來進行,也可以利用與Mapper配置文件相對應的Mapper接口來進行操作,條件是Mapper接口中定義的方法的參數和返回值要與Mapper配置文件中定義的參數和返回值相同。此外,在使用Mapper接口的時候,對應的SQL語句是可以寫在Mapper配置文件中的,也可以直接利用對應的註解在Mapper接口中對應的方法上進行標明,這將在下面的示例代碼中看到。
下面是一系列的示例代碼:
先貼一個用於獲取SqlSessionFactory的工具類:
import java.io.IOException; import java.io.InputStream; import org.apache.ibatis.io.Resources; import org.apache.ibatis.session.SqlSessionFactory; import org.apache.ibatis.session.SqlSessionFactoryBuilder; public class Util { private static SqlSessionFactory sqlSessionFactory = null; static { try { InputStream is = Resources.getResourceAsStream("config/mybatis_config.xml"); sqlSessionFactory = new SqlSessionFactoryBuilder().build(is); } catch (IOException e) { // TODO Auto-generated catch block e.printStackTrace(); } } public static SqlSessionFactory getSqlSessionFactory() { return sqlSessionFactory; } }
mybatis的配置文件:
<?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> <properties resource="config/jdbc.properties"></properties> <typeAliases> <typeAlias alias="Blog" type="com.tiantian.mybatis.model.Blog"/> </typeAliases> <environments default="development"> <environment id="development"> <transactionManager type="JDBC" /> <dataSource type="POOLED"> <property name="driver" value="${jdbc.driver}" /> <property name="url" value="${jdbc.url}" /> <property name="username" value="${jdbc.username}" /> <property name="password" value="${jdbc.password}" /> </dataSource> </environment> </environments> <mappers> <mapper resource="com/tiantian/mybatis/model/BlogMapper.xml"/> </mappers> </configuration>
BlogMapper.xml
<?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="com.tiantian.mybatis.model.BlogMapper"> <!-- 新增記錄--> <insert id="insertBlog" parameterType="Blog"> insert into t_blog(title,content,owner) values(#{title},#{content},#{owner}) </insert> <!-- 查詢單條記錄--> <select id="selectBlog" parameterType="int" resultType="Blog"> select * from t_blog where id = #{id} </select> <!-- 修改記錄--> <update id="updateBlog" parameterType="Blog"> update t_blog set title = #{title},content = #{content},owner = #{owner} where id = #{id} </update> <!-- 查詢所有記錄,查詢多條記錄即返回結果是一個集合的時候,resultType不是集合類型,而是集合所包含的類型--> <select id="selectAll" resultType="Blog"> select * from t_blog </select> <!-- 模糊查詢--> <select id="fuzzyQuery" resultType="Blog" parameterType="java.lang.String"> select * from t_blog where title like "%"#{title}"%" </select> <!-- 刪除記錄--> <delete id="deleteBlog" parameterType="int"> delete from t_blog where id = #{id} </delete> </mapper>SQL映射語句中一些應該注意的問題:
Blog.java
package com.tiantian.mybatis.model; public class Blog { private int id; private String title; private String content; private String owner; public int getId() { return id; } public void setId(int id) { this.id = id; } public String getTitle() { return title; } public void setTitle(String title) { this.title = title; } public String getContent() { return content; } public void setContent(String content) { this.content = content; } public String getOwner() { return owner; } public void setOwner(String owner) { this.owner = owner; } @Override public String toString() { return "id: " + id + ", title: " + title + ", content: " + content + ", owner: " + owner; } }
BlogMapper.java
package com.tiantian.mybatis.model; import java.util.List; import org.apache.ibatis.annotations.Delete; import org.apache.ibatis.annotations.Insert; import org.apache.ibatis.annotations.Select; import org.apache.ibatis.annotations.Update; /** * 以下的操作1都是把SQL寫在配置文件裡面的,而操作2都是直接用註解標明要執行的SQL語句* 因為該Mapper的全名跟BlogMapper.xml文件裡面的namespace是一樣的,所以不能在這裡面* 用註解定義一個與BlogMapper.xml文件裡面同名的映射* @author andy * */ public interface BlogMapper { public Blog selectBlog(int id); @Select("select * from t_blog where id = #{id}") public Blog selectBlog2(int id); public void insertBlog(Blog blog); @Insert("insert into t_blog(title,content,owner) values(#{title},#{content},#{owner})") public void insertBlog2(Blog blog); public void updateBlog(Blog blog); @Update("update t_blog set title=#{title},content=#{content},owner=#{owner} where id=#{id}") public void updateBlog2(Blog blog); public void deleteBlog(int id); @Delete("delete from t_blog where id = #{id}") public void deleteBlog2(int id); public List<Blog> selectAll(); @Select("select * from t_blog") public List<Blog> selectAll2(); public List<Blog> fuzzyQuery(String title); @Select("select * from t_blog where title like /"%/"#{title}/"%/"") public List<Blog> fuzzyQuery2(String title); }
Test1.java
package com.tiantian.mybatis.test; import java.util.List; import org.apache.ibatis.session.SqlSession; import org.junit.Test; import com.tiantian.mybatis.model.Blog; import com.tiantian.mybatis.util.Util; /** * 該系列操作是通過把SQL寫在配置文件裡面, * 然後利用SqlSession進行操作的* @author andy * */ public class Test1 { /** * 新增記錄*/ @Test public void testInsertBlog() { SqlSession session = Util.getSqlSessionFactory().openSession(); Blog blog = new Blog(); blog.setTitle("中國人"); blog.setContent("五千年的風和雨啊藏了多少夢"); blog.setOwner("天天"); session.insert("com.tiantian.mybatis.model.BlogMapper.insertBlog", blog); session.commit(); session.close(); } /** * 查詢單條記錄*/ @Test public void testSelectOne() { SqlSession session = Util.getSqlSessionFactory().openSession(); Blog blog = (Blog)session.selectOne("com.tiantian.mybatis.model.BlogMapper.selectBlog", 8); System.out.println(blog); session.close(); } /** * 修改記錄*/ @Test public void testUpdateBlog() { SqlSession session = Util.getSqlSessionFactory().openSession(); Blog blog = new Blog(); blog.setId(7);//需要修改的Blog的id blog.setTitle("中國人2");//修改Title blog.setContent("黃色的臉,黑色的眼,不變是笑容");//修改Content blog.setOwner("天天2");//修改Owner session.update("com.tiantian.mybatis.model.BlogMapper.updateBlog", blog); session.commit(); session.close(); } /** * 查詢所有的記錄*/ @Test public void testSelectAll() { SqlSession session = Util.getSqlSessionFactory().openSession(); List<Blog> blogs = session.selectList("com.tiantian.mybatis.model.BlogMapper.selectAll"); for (Blog blog:blogs) System.out.println(blog); session.close(); } /** * 模糊查詢*/ @Test public void testFuzzyQuery() { SqlSession session = Util.getSqlSessionFactory().openSession(); String title = "中國"; List<Blog> blogs = session.selectList("com.tiantian.mybatis.model.BlogMapper.fuzzyQuery", title); for (Blog blog:blogs) System.out.println(blog); session.close(); } /** * 刪除記錄*/ @Test public void testDeleteBlog() { SqlSession session = Util.getSqlSessionFactory().openSession(); session.delete("com.tiantian.mybatis.model.BlogMapper.deleteBlog", 8); session.commit(); session.close(); } }
Test2.java
package com.tiantian.mybatis.test; import java.util.List; import org.apache.ibatis.session.SqlSession; import org.junit.Test; import com.tiantian.mybatis.model.Blog; import com.tiantian.mybatis.model.BlogMapper; import com.tiantian.mybatis.util.Util; /** * 該系列操作是將SQL語句寫在配置文件裡面, * 然後通過對應Mapper接口來進行操作的* @author andy * */ public class Test2 { /** * 新增記錄*/ @Test public void testInsertBlog() { SqlSession session = Util.getSqlSessionFactory().openSession(); Blog blog = new Blog(); blog.setTitle("中國人"); blog.setContent("五千年的風和雨啊藏了多少夢"); blog.setOwner("天天"); BlogMapper blogMapper = session.getMapper(BlogMapper.class); blogMapper.insertBlog(blog); session.commit(); session.close(); } /** * 查詢單條記錄*/ @Test public void testSelectOne() { SqlSession session = Util.getSqlSessionFactory().openSession(); BlogMapper blogMapper = session.getMapper(BlogMapper.class); Blog blog = blogMapper.selectBlog(7); System.out.println(blog); session.close(); } /** * 修改記錄*/ @Test public void testUpdateBlog() { SqlSession session = Util.getSqlSessionFactory().openSession(); Blog blog = new Blog(); blog.setId(9);// 需要修改的Blog的id blog.setTitle("中國人2");// 修改Title blog.setContent("黃色的臉,黑色的眼,不變是笑容");// 修改Content blog.setOwner("天天2");// 修改Owner BlogMapper blogMapper = session.getMapper(BlogMapper.class); blogMapper.updateBlog(blog); session.commit(); session.close(); } /** * 查詢所有記錄*/ @Test public void testSelectAll() { SqlSession session = Util.getSqlSessionFactory().openSession(); BlogMapper blogMapper = session.getMapper(BlogMapper.class); List<Blog> blogs = blogMapper.selectAll(); for (Blog blog : blogs) System.out.println(blog); session.close(); } /** * 模糊查詢*/ @Test public void testFuzzyQuery() { SqlSession session = Util.getSqlSessionFactory().openSession(); BlogMapper blogMapper = session.getMapper(BlogMapper.class); String title = "中國"; List<Blog> blogs = blogMapper.fuzzyQuery(title); for (Blog blog : blogs) System.out.println(blog); session.close(); } /** * 刪除記錄*/ @Test public void testDeleteBlog() { SqlSession session = Util.getSqlSessionFactory().openSession(); BlogMapper blogMapper = session.getMapper(BlogMapper.class); blogMapper.deleteBlog(10); session.commit(); session.close(); } }
Test3.java
package com.tiantian.mybatis.test; import java.util.List; import org.apache.ibatis.session.SqlSession; import org.junit.Test; import com.tiantian.mybatis.model.Blog; import com.tiantian.mybatis.model.BlogMapper; import com.tiantian.mybatis.util.Util; /** * 該系列操作是利用Mapper接口來進行的* ,然而其相應的SQL語句是通過對應的* 註解Annotation在Mapper中對應的方法上定義的* @author andy * */ public class Test3 { /** * 新增記錄*/ @Test public void testInsert() { SqlSession session = Util.getSqlSessionFactory().openSession(); BlogMapper blogMapper = session.getMapper(BlogMapper.class); Blog blog = new Blog(); blog.setTitle("title2"); blog.setContent("content2"); blog.setOwner("owner2"); blogMapper.insertBlog2(blog); session.commit(); session.close(); } /** * 查找單條記錄*/ @Test public void testSelectOne() { SqlSession session = Util.getSqlSessionFactory().openSession(); BlogMapper blogMapper = session.getMapper(BlogMapper.class); Blog blog = blogMapper.selectBlog2(1); System.out.println(blog); session.close(); } /** * 查找多條記錄,返回結果為一集合*/ @Test public void testSelectAll() { SqlSession session = Util.getSqlSessionFactory().openSession(); BlogMapper blogMapper = session.getMapper(BlogMapper.class); List<Blog> blogs = blogMapper.selectAll2(); for (Blog blog:blogs) System.out.println(blog); session.close(); } /** * 修改某條記錄*/ @Test public void testUpdate() { SqlSession session = Util.getSqlSessionFactory().openSession(); BlogMapper blogMapper = session.getMapper(BlogMapper.class); Blog blog = new Blog(); blog.setId(3); blog.setTitle("title3"); blog.setContent("content3"); blog.setOwner("owner3"); blogMapper.updateBlog2(blog); session.commit(); session.close(); } /** * 刪除記錄*/ @Test public void testDelete() { SqlSession session = Util.getSqlSessionFactory().openSession(); BlogMapper blogMapper = session.getMapper(BlogMapper.class); blogMapper.deleteBlog2(5); session.commit(); session.close(); } @Test public void testFuzzyQuery() { SqlSession session = Util.getSqlSessionFactory().openSession(); BlogMapper blogMapper = session.getMapper(BlogMapper.class); List<Blog> blogs = blogMapper.fuzzyQuery2("中國"); for (Blog blog:blogs) System.out.println(blog); session.close(); } }對應的建表語句:
CREATE TABLE `t_blog` ( `id` int(11) NOT NULL AUTO_INCREMENT, `title` varchar(255) DEFAULT NULL, `content` varchar(255) DEFAULT NULL, `owner` varchar(50) DEFAULT NULL, PRIMARY KEY (`id`) )