MyBatis詳解一篇就夠啦

2019 年 10 月 16 日
筆記

第1章MyBatis框架配置文件詳解

1.1 typeHandlers類型轉換器

　　每當MyBatis 設置參數到PreparedStatement 或者從ResultSet 結果集中取得值時，就會使用TypeHandler 來處理數據庫類型與java 類型之間轉換。下表描述了默認

TypeHandlers

1.1.1 自定義類型轉換器

假設表中字段是int類型,而實體類與之對應的屬性是boolean類型,此時可以採用自定義類型轉換器進行對應

(1)實體類

 1 package com.chenyanbin.beans;   2   3 public class Dept {   4     private Integer deptNo;   5     private String dname;   6     private String loc;   7     private boolean flag;   8     public Integer getDeptNo() {   9         return deptNo;  10     }  11     public boolean isFlag() {  12         return flag;  13     }  14     public void setFlag(boolean flag) {  15         this.flag = flag;  16     }  17     public void setDeptNo(Integer deptNo) {  18         this.deptNo = deptNo;  19     }  20     public String getDname() {  21         return dname;  22     }  23     public void setDname(String dname) {  24         this.dname = dname;  25     }  26     public String getLoc() {  27         return loc;  28     }  29     public void setLoc(String loc) {  30         this.loc = loc;  31     }  32 }

(2) 表中字段

(3) 開發自定義類型轉換器：MyTypeHandler.java

繼承並實現接口:TypeHandler.java

 1 package com.chenyanbin.util;   2   3 import java.sql.CallableStatement;   4 import java.sql.PreparedStatement;   5 import java.sql.ResultSet;   6 import java.sql.SQLException;   7   8 import org.apache.ibatis.jdbc.Null;   9 import org.apache.ibatis.type.JdbcType;  10 import org.apache.ibatis.type.TypeHandler;  11 /*  12  * setParameter:這個方法在生成SQL語句時才被調用  13  *  14  * getResult:查詢結束之後，在將ResultSet數據行轉換為實體類對象時，通知TypeHandler將當前數據行某個字段轉換為何種類型  15  *  16  *  17  */  18 public class MyTypeHandler implements TypeHandler {  19  20     public void setParameter(PreparedStatement ps, int i, Object parameter, JdbcType jdbcType) throws SQLException {  21         if (parameter==null) { //dept.flag=null insertsql flag設置0  22             ps.setInt(i, 0);  23             return;  24         }  25         Boolean flag=(Boolean)parameter;  26         if (flag==true) {  27             ps.setInt(i, 1);  28         }  29         else {  30             ps.setInt(i, 0);  31         }  32     }  33  34     public Object getResult(ResultSet rs, String columnName) throws SQLException {  35         int flag = rs.getInt(columnName); //1 or 0  36         Boolean myFlag=Boolean.FALSE;  37         if (flag==1) {  38             myFlag=Boolean.TRUE;  39         }  40         return myFlag;  41     }  42  43     public Object getResult(ResultSet rs, int columnIndex) throws SQLException {  44         // TODO Auto-generated method stub  45         return null;  46     }  47  48     public Object getResult(CallableStatement cs, int columnIndex) throws SQLException {  49         // TODO Auto-generated method stub  50         return null;  51     }  52  53 }

(4) 在MyBatis核心配置文件註冊自定義類型轉換器：

myBatis-config.xml

 1 <?xml version="1.0" encoding="UTF-8"?>   2 <!DOCTYPE configuration   3   PUBLIC "-//mybatis.org//DTD Config 3.0//EN"   4   "http://mybatis.org/dtd/mybatis-3-config.dtd">   5 <configuration>   6     <!-- 屬性配置 -->   7     <properties resource="config.properties"></properties>   8     <!-- 別名配置 -->   9     <typeAliases>  10         <package name="com.chenyanbin.beans" />  11         <package name="com.chenyanbin.dao" />  12     </typeAliases>  13     <!-- 類型處理器 -->  14     <typeHandlers>  15         <!-- 從java中的Boolean轉jdbc中的NUMERIC -->  16         <typeHandler handler="com.chenyanbin.util.MyTypeHandler"  17             javaType="Boolean" jdbcType="NUMERIC" />  18     </typeHandlers>  19     <!-- 環境配置 -->  20     <environments default="development">  21         <!-- 環境配置 -->  22         <environment id="development">  23             <!-- 事務管理器 -->  24             <transactionManager type="JDBC"></transactionManager>  25             <!-- 數據源 -->  26             <dataSource type="pooled">  27                 <property name="driver" value="${jdbc.driver}" />  28                 <property name="url" value="${jdbc.url}" />  29                 <property name="username" value="${jdbc.username}" />  30                 <property name="password" value="${jdbc.password}" />  31             </dataSource>  32         </environment>  33     </environments>  34     <!-- 映射器 -->  35     <mappers>  36         <package name="com.chenyanbin.dao" />  37     </mappers>  38 </configuration>

config.properties

1 jdbc.driver=com.mysql.jdbc.Driver  2 jdbc.url=jdbc:mysql://localhost:3306/sam  3 jdbc.username=root  4 jdbc.password=root

(5) 創建接口:DeptMapper.java

 1 package com.chenyanbin.dao;   2   3 import java.util.List;   4 import com.chenyanbin.beans.Dept;   5   6 public interface DeptMapper {   7     public void deptSave(Dept dept);   8   9     public List<Dept> deptFind();  10 }

(6) DeptMapper.xml

 1 <?xml version="1.0" encoding="UTF-8"?>   2 <!DOCTYPE mapper   3   PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"   4   "http://mybatis.org/dtd/mybatis-3-mapper.dtd">   5 <mapper namespace="com.chenyanbin.dao.DeptMapper">   6     <insert id="deptSave">   7         insert into dept (DEPTNO,DNAME,LOC,flag)   8         values(#{deptNo},#{dname},#{loc},#{flag})   9     </insert>  10     <select id="deptFind" resultType="Dept">  11         select deptNo,dname,loc,flag from dept  12     </select>  13 </mapper>

 1 <?xml version="1.0" encoding="UTF-8"?>   2 <!DOCTYPE configuration   3   PUBLIC "-//mybatis.org//DTD Config 3.0//EN"   4   "http://mybatis.org/dtd/mybatis-3-config.dtd">   5 <configuration>   6     <!-- 屬性配置 -->   7     <properties resource="config.properties"></properties>   8     <!-- 別名配置 -->   9     <typeAliases>  10         <package name="com.chenyanbin.beans" />  11         <package name="com.chenyanbin.dao" />  12     </typeAliases>  13     <!-- 環境配置 -->  14     <environments default="development">  15         <!-- 環境配置 -->  16         <environment id="development">  17             <!-- 事務管理器 -->  18             <transactionManager type="JDBC"></transactionManager>  19             <!-- 數據源 -->  20             <dataSource type="pooled">  21                 <property name="driver" value="${jdbc.driver}" />  22                 <property name="url" value="${jdbc.url}" />  23                 <property name="username" value="${jdbc.username}" />  24                 <property name="password" value="${jdbc.password}" />  25             </dataSource>  26         </environment>  27     </environments>  28     <!-- 映射器 -->  29     <mappers>  30         <package name="com.chenyanbin.dao" />  31     </mappers>  32 </configuration>

方式二：myBatis-config.xml

 1 <?xml version="1.0" encoding="UTF-8"?>   2 <!DOCTYPE mapper   3   PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"   4   "http://mybatis.org/dtd/mybatis-3-mapper.dtd">   5 <mapper namespace="com.chenyanbin.dao.DeptMapper">   6     <insert id="deptSave">   7         insert into dept (DEPTNO,DNAME,LOC,flag)   8         values(#{deptNo},#{dname},#{loc},#{flag})   9     </insert>  10     <resultMap type="dept" id="deptMap">  11     <result column="flag" property="flag" typeHandler="com.chenyanbin.util.MyTypeHandler"/>  12     </resultMap>  13     <select id="deptFind" resultType="Dept">  14         select deptNo,dname,loc,flag from dept  15     </select>  16 </mapper>

方式二：DeptMapper.xml

(7) 執行單元測試:TestMain_01.java

 1 package com.chenyanbin.test;   2   3 import java.io.IOException;   4 import java.io.InputStream;   5 import java.util.List;   6 import org.apache.ibatis.io.Resources;   7 import org.apache.ibatis.session.SqlSession;   8 import org.apache.ibatis.session.SqlSessionFactory;   9 import org.apache.ibatis.session.SqlSessionFactoryBuilder;  10 import org.junit.After;  11 import org.junit.Before;  12 import org.junit.Test;  13 import com.chenyanbin.beans.Dept;  14 import com.chenyanbin.dao.DeptMapper;  15  16 public class TestMain_01 {  17     private SqlSession session;  18  19     @Before  20     public void Start() {  21         try {  22             InputStream inputStream = Resources.getResourceAsStream("myBatis-config.xml");  23             SqlSessionFactory factory = new SqlSessionFactoryBuilder().build(inputStream);  24             session = factory.openSession();  25         } catch (Exception e) {  26             e.printStackTrace();  27         }  28     }  29  30     @After  31     public void end() {  32         if (session == null) {  33             session.close();  34         }  35     }  36  37     @Test  38     public void test01() throws IOException {  39         Dept d2 = new Dept();  40         d2.setDname("上海事業部");  41         d2.setLoc("上海");  42         d2.setFlag(false);  43         session.insert("deptSave", d2);  44         session.commit();  45         session.close();  46     }  47  48     @Test  49     public void test02() {  50           DeptMapper dao=session.getMapper(DeptMapper.class);  51           List<Dept> deptList=dao.deptFind();  52           System.out.println("ok");  53     }  54  55 }

(8) 項目目錄結構

1.2 objectFactory 對象工廠

　　MyBatis 每次創建結果對象的新實例時，它都會使用一個對象工廠（ObjectFactory）實例來完成。默認的對象工廠需要做的僅僅是實例化目標類，要麼通過默認構造方法，要麼在參數映射存在的時候通過參數構造方法來實例化。如果想覆蓋對象工廠的默認行為，則可以通過創建自己的對象工廠來實現。

1.2.1 自定義對象工廠

表結構:dept

實體類:Dept.java

 1 package com.chenyanbin.beans;   2   3 public class Dept {   4     private Integer deptNo;   5     private String dname;   6     private String loc;   7     private Boolean flag;   8     private String country;   9     public String getCountry() {  10         return country;  11     }  12     public void setCountry(String country) {  13         this.country = country;  14     }  15     public Integer getDeptNo() {  16         return deptNo;  17     }  18     public Boolean getFlag() {  19         return flag;  20     }  21     public void setFlag(Boolean flag) {  22         this.flag = flag;  23     }  24     public void setDeptNo(Integer deptNo) {  25         this.deptNo = deptNo;  26     }  27     public String getDname() {  28         return dname;  29     }  30     public void setDname(String dname) {  31         this.dname = dname;  32     }  33     public String getLoc() {  34         return loc;  35     }  36     public void setLoc(String loc) {  37         this.loc = loc;  38     }  39 }

(1) 繼承與DefaultObjectFactory：MyObjectFactory.java

 1 package com.chenyanbin.util;   2   3 import org.apache.ibatis.reflection.factory.DefaultObjectFactory;   4   5 import com.chenyanbin.beans.Dept;   6   7 public class MyObjectFactory extends DefaultObjectFactory {   8   9     @Override  10     public Object create(Class type) {// 重新定義Dept類實例對象創建規則，其他類實例對象創建規則不想改變  11         if (Dept.class == type) {  12             // 依靠父類提供create方法創建Dept對象  13             Dept dept = (Dept) super.create(type);  14             // 設置自定義規則  15             dept.setCountry("China");  16             return dept;  17         }  18         return super.create(type);  19     }  20  21 }

(2) 在MyBatis核心文件中註冊自定義工廠

 1 <?xml version="1.0" encoding="UTF-8"?>   2 <!DOCTYPE configuration   3   PUBLIC "-//mybatis.org//DTD Config 3.0//EN"   4   "http://mybatis.org/dtd/mybatis-3-config.dtd">   5 <configuration>   6     <!-- 屬性配置 -->   7     <properties resource="config.properties"></properties>   8     <!-- 別名配置 -->   9     <typeAliases>  10         <package name="com.chenyanbin.beans" />  11         <package name="com.chenyanbin.dao" />  12     </typeAliases>  13     <!-- ObjectFactory對象工廠 -->  14     <objectFactory type="com.chenyanbin.util.MyObjectFactory"></objectFactory>  15     <!-- 類型處理器 -->  16 <!--     <typeHandlers>  17         從java中的Boolean轉jdbc中的NUMERIC  18         <typeHandler handler="com.chenyanbin.util.MyTypeHandler"  19             javaType="Boolean" jdbcType="NUMERIC" />  20     </typeHandlers> -->  21     <!-- 環境配置 -->  22     <environments default="development">  23         <!-- 環境配置 -->  24         <environment id="development">  25             <!-- 事務管理器 -->  26             <transactionManager type="JDBC"></transactionManager>  27             <!-- 數據源 -->  28             <dataSource type="pooled">  29                 <property name="driver" value="${jdbc.driver}" />  30                 <property name="url" value="${jdbc.url}" />  31                 <property name="username" value="${jdbc.username}" />  32                 <property name="password" value="${jdbc.password}" />  33             </dataSource>  34         </environment>  35     </environments>  36     <!-- 映射器 -->  37     <mappers>  38         <package name="com.chenyanbin.dao" />  39     </mappers>  40 </configuration>

1.3 Plugins 攔截器

　　攔截器的一個作用就是我們可以攔截某些方法的調用，我們可以選擇在這些被攔截的方法執行前後加上某些邏輯，也可以在執行這些被攔截的方法時執行自己的邏輯而不再執行被攔截的方法。Mybatis攔截器設計的一個初衷就是為了供用戶在某些時候可以實現自己的邏輯而不必去動Mybatis固有的邏輯。打個比方，對於Executor，Mybatis中有幾種實現：BatchExecutor、ReuseExecutor、SimpleExecutor和CachingExecutor。這個時候如果你覺得這幾種實現對於Executor接口的query方法都不能滿足你的要求，那怎麼辦呢？是要去改源碼嗎？當然不。我們可以建立一個Mybatis攔截器用於攔截Executor接口的query方法，在攔截之後實現自己的query方法邏輯，之後可以選擇是否繼續執行原來的query方法。

　　對於攔截器Mybatis為我們提供了一個Interceptor接口，通過實現該接口就可以定義我們自己的攔截器。我們先來看一下這個接口的定義：

　　我們可以看到在該接口中一共定義有三個方法，intercept、plugin和setProperties。plugin方法是攔截器用於封裝目標對象的，通過該方法我們可以返回目標對象本身，也可以返回一個它的代理。當返回的是代理的時候我們可以對其中的方法進行攔截來調用intercept方法，當然也可以調用其他方法，這點將在後文講解。setProperties方法是用於在Mybatis配置文件中指定一些屬性的。

定義自己的Interceptor最重要的是要實現plugin方法和intercept方法，在plugin方法中我們可以決定是否要進行攔截進而決定要返回一個什麼樣的目標對象。而intercept方法就是要進行攔截的時候要執行的方法。

對於plugin方法而言，其實Mybatis已經為我們提供了一個實現。Mybatis中有一個叫做Plugin的類，裏面有一個靜態方法wrap(Object target,Interceptor interceptor)，通過該方法可以決定要返回的對象是目標對象還是對應的代理。

對於實現自己的Interceptor而言有兩個很重要的註解，一個是@Intercepts，其值是一個@Signature數組。@Intercepts用於表明當前的對象是一個Interceptor，而@Signature則表明要攔截的接口、方法以及對應的參數類型。

創建自己的攔截器：MySimpleInterceptor.java

 1 package com.chenyanbin.util;   2   3 import java.util.Properties;   4   5 import org.apache.ibatis.executor.Executor;   6 import org.apache.ibatis.mapping.MappedStatement;   7 import org.apache.ibatis.plugin.Interceptor;   8 import org.apache.ibatis.plugin.Intercepts;   9 import org.apache.ibatis.plugin.Invocation;  10 import org.apache.ibatis.plugin.Plugin;  11 import org.apache.ibatis.plugin.Signature;  12 import org.apache.ibatis.session.ResultHandler;  13 import org.apache.ibatis.session.RowBounds;  14  15 @Intercepts({ @Signature(method = "query", type = Executor.class, args = { MappedStatement.class, Object.class,  16         RowBounds.class, ResultHandler.class }) })  17 public class MySimpleInterceptor implements Interceptor {  18     /*  19      * 參數：Invocation {代理對象，被監控的方法對象，當前被監控方法運行時需要實參}  20      */  21     public Object intercept(Invocation invocation) throws Throwable {  22         // TODO Auto-generated method stub  23         System.out.println("被攔截方法執行之前，做的輔助服務。。。。。");  24         Object object = invocation.proceed(); // 執行被攔截方法  25         System.out.println("被攔截方法執行之後，做的輔助服務。。。。。");  26         return object;  27     }  28  29     /*  30      * 參數：target 表示被攔截的對象，應該是Executor接口實例對象 作用： 如果 被攔截的對象所在的類是有實現接口就為當前攔截對象生成一個代理對象  31      * 如果被攔截的對象所在的類沒有指定接口，這個對象之後的行為不會被代理操作  32      */  33     public Object plugin(Object target) {  34         // TODO Auto-generated method stub  35         return Plugin.wrap(target, this);  36     }  37  38     public void setProperties(Properties properties) {  39         // TODO Auto-generated method stub  40  41     }  42  43 }

MyBatis核心配置文件：myBatis-config.xml

 1 <?xml version="1.0" encoding="UTF-8"?>   2 <!DOCTYPE configuration   3   PUBLIC "-//mybatis.org//DTD Config 3.0//EN"   4   "http://mybatis.org/dtd/mybatis-3-config.dtd">   5 <configuration>   6     <!-- 屬性配置 -->   7     <properties resource="config.properties"></properties>   8     <!-- 別名配置 -->   9     <typeAliases>  10         <package name="com.chenyanbin.beans" />  11         <package name="com.chenyanbin.dao" />  12     </typeAliases>  13     <!-- ObjectFactory對象工廠 -->  14     <objectFactory type="com.chenyanbin.util.MyObjectFactory"></objectFactory>  15     <!-- Plugins攔截器 -->  16     <plugins>  17         <plugin interceptor="com.chenyanbin.util.MySimpleInterceptor"></plugin>  18     </plugins>  19     <!-- 類型處理器 -->  20     <!-- <typeHandlers> 從java中的Boolean轉jdbc中的NUMERIC <typeHandler handler="com.chenyanbin.util.MyTypeHandler"  21         javaType="Boolean" jdbcType="NUMERIC" /> </typeHandlers> -->  22     <!-- 環境配置 -->  23     <environments default="development">  24         <!-- 環境配置 -->  25         <environment id="development">  26             <!-- 事務管理器 -->  27             <transactionManager type="JDBC"></transactionManager>  28             <!-- 數據源 -->  29             <dataSource type="pooled">  30                 <property name="driver" value="${jdbc.driver}" />  31                 <property name="url" value="${jdbc.url}" />  32                 <property name="username" value="${jdbc.username}" />  33                 <property name="password" value="${jdbc.password}" />  34             </dataSource>  35         </environment>  36     </environments>  37     <!-- 映射器 -->  38     <mappers>  39         <package name="com.chenyanbin.dao" />  40     </mappers>  41 </configuration>

單元測試

 1 package com.chenyanbin.test;   2   3 import java.io.IOException;   4 import java.io.InputStream;   5 import java.util.List;   6 import org.apache.ibatis.io.Resources;   7 import org.apache.ibatis.plugin.Interceptor;   8 import org.apache.ibatis.session.SqlSession;   9 import org.apache.ibatis.session.SqlSessionFactory;  10 import org.apache.ibatis.session.SqlSessionFactoryBuilder;  11 import org.junit.After;  12 import org.junit.Before;  13 import org.junit.Test;  14 import com.chenyanbin.beans.Dept;  15 import com.chenyanbin.dao.DeptMapper;  16  17 public class TestMain_01 {  18     private SqlSession session;  19  20     @Before  21     public void Start() {  22         try {  23             InputStream inputStream = Resources.getResourceAsStream("myBatis-config.xml");  24             SqlSessionFactory factory = new SqlSessionFactoryBuilder().build(inputStream);  25             session = factory.openSession();  26         } catch (Exception e) {  27             e.printStackTrace();  28         }  29     }  30  31     @After  32     public void end() {  33         if (session == null) {  34             session.close();  35         }  36     }  37  38     @Test  39     public void test01() throws IOException {  40         Dept d2 = new Dept();  41         d2.setDname("上海事業部");  42         d2.setLoc("上海");  43         d2.setFlag(false);  44         session.insert("deptSave", d2);  45         session.commit();  46         session.close();  47     }  48  49     @Test  50     public void test02() {  51         Interceptor ccInterceptor;  52           DeptMapper dao=session.getMapper(DeptMapper.class);  53           List<Dept> deptList=dao.deptFind();  54           System.out.println("ok");  55     }  56  57 }

 1 ##define an appender named console   2 log4j.appender.console=org.apache.log4j.ConsoleAppender   3 #The Target value is System.out or System.err   4 log4j.appender.console.Target=System.out   5 #set the layout type of the apperder   6 log4j.appender.console.layout=org.apache.log4j.PatternLayout   7 #set the layout format pattern   8 log4j.appender.console.layout.ConversionPattern=[%-5p] %m%n   9  10 ##define a logger  11 log4j.rootLogger=debug,console