主頁 > 後端開發 > （三）MyBatis從入門到入土——使用詳解

（三）MyBatis從入門到入土——使用詳解

2021-02-07 06:19:50 後端開發

這是mybatis系列第3篇，沒看前文的建議先去【Java冢狐】公眾號中查看前文，方便理解和掌握

MyBatis使用詳解

上篇我們手動開發了一個MyBatis專案，但是我們僅僅是撰寫了代碼，對于整個專案是如何運行以及每個代碼的意義都沒有仔細的分析和說明，那么接下來我們就開始分析每個代碼的意義以及如何撰寫這個代碼

配置MyBatis全域組態檔

要使用Mybatis來操作資料庫，那么當然就需要配置資料庫相關資訊，這件需要在mybatis全域組態檔中進行，即全域配置的xml檔案，其對整個MyBatis進行事務的支持、資料庫的配置等資訊的配置，我們一般放在main/resource檔案中，如下所示

<configuration>
    <!-- 環境配置，可以配置多個環境 -->
    <environments default="chat01">
        <!--
            environment用來對某個環境進行配置
            id：環境標識，唯一
         -->
        <environment id="chat01">
            <!-- 事務管理器工廠配置 -->
            <transactionManager type="org.apache.ibatis.transaction.jdbc.JdbcTransactionFactory"/>
            <!-- 資料源工廠配置，使用工廠來創建資料源 -->
            <dataSource type="org.apache.ibatis.datasource.pooled.PooledDataSourceFactory">
                <property name="driver" value="https://www.cnblogs.com/javazhonghu/p/com.mysql.jdbc.Driver"/>
                <property name="url" value="https://www.cnblogs.com/javazhonghu/p/jdbc:mysql://localhost:3306/mybatisdemo?characterEncoding=UTF-8"/>
                <property name="username" value="https://www.cnblogs.com/javazhonghu/p/root"/>
                <property name="password" value="https://www.cnblogs.com/javazhonghu/p/123456"/>
            </dataSource>
        </environment>
    </environments>
</configuration>

configuration元素

這個是mybatis全域組態檔的根元素，每個組態檔只有一個

environments元素

用來配置mybatis的環境資訊，用來配置多個環境的，具體的一個環境使用environment元素進行配置，environment元素有個id用來標識某個具體的環境，

environments元素有個default屬性，用來指定默認使用哪個環境，如上面默認使用的是chat01，

environment元素

用來配置具體的環境資訊，這個元素下面有兩個子元素：transactionManager和dataSource

  • transactionManager元素

用來配置事務工廠的，有個type屬性，type的值必須是org.apache.ibatis.transaction.TransactionFactory介面的實作類，用來創建事務管理器物件的，TransactionFactory介面默認有2個實作：

org.apache.ibatis.transaction.managed.ManagedTransactionFactory
org.apache.ibatis.transaction.jdbc.JdbcTransactionFactory

一般情況下我們使用org.apache.ibatis.transaction.jdbc.JdbcTransactionFactory這個，mybatis和其他框架集成，比如和spring集成，事務交由spring去控制，

  • dataSource元素

這個用來配置資料源的，type屬性的值必須為介面org.apache.ibatis.datasource.DataSourceFactory的實作類，DataSourceFactory也是一個工廠，用來創建資料源javax.sql.DataSource物件的，mybatis中這個介面默認有3個實作類：

org.apache.ibatis.datasource.jndi.JndiDataSourceFactory
org.apache.ibatis.datasource.pooled.PooledDataSourceFactory
org.apache.ibatis.datasource.unpooled.UnpooledDataSourceFactory

我們使用第2個org.apache.ibatis.datasource.pooled.PooledDataSourceFactory，這個用來創建一個資料庫連接池型別的資料源，可以實作資料庫連接共用，減少連接重復創建銷毀的時間，
配置資料源需要指定資料庫連接的屬性資訊，比如：驅動、連接db的url、用戶名、密碼，這個在dataSource元素下面的property中配置，property元素的格式：

<property name="屬性名稱" value="https://www.cnblogs.com/javazhonghu/p/值"/>

創建Mapper xml檔案

在mybatis中一般我們將一個表的所有sql操作寫在一個mapper xml中，一般命名為XXXMapper.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="zhonghu.mybatis.chat01.UserMapper">
</mapper>

mapper xml根元素為mapper，這個元素有個namespace屬性，系統中會有很多表，每個表對應一個Mapper xml，為了防止mapper檔案重復，我們需要給每個mapper xml檔案需要指定一個namespace，通過這個可以區分每個mapper xml檔案，上面我們指定為zhonghu.mybatis.chat01.UserMapper，

一會對user表的所有操作相關的sql，我們都會寫在上面這個xml中，

mybatis全域組態檔中引入Mapper xml檔案

user.xml我們寫好了，如何讓mybatis知道這個檔案呢，此時我們需要在mybatis-config.xml全域組態檔中引入UserMapper.xml，在mybatis-config.xml加入下面配置：

<mappers>
        <mapper resource="mapper/user.xml"/>
    </mappers>

mappers元素下面有多個mapper元素，通過mapper元素的resource屬性可以引入Mapper xml檔案，resource是相對于classes的路徑，

上面說的都是一些組態檔，組態檔都ok了，下面我們就需要將mybatis跑起來了，此時需要使用到mybatis中的一些java物件了，

構建SqlSessionFactory物件

//指定mybatis全域組態檔
String resource = "mybatis-config.xml";
//讀取全域組態檔
InputStream inputStream = Resources.getResourceAsStream(resource);
//構建SqlSessionFactory物件
SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);

SqlSessionFactory是一個介面，是一個重量級的物件，SqlSessionFactoryBuilder通過讀取全域組態檔來創建一個SqlSessionFactory，創建這個物件是比較耗時的，主要耗時在對mybatis全域組態檔的決議上面，全域組態檔中包含很多內容，SqlSessionFactoryBuilder通過決議這些內容，創建了一個復雜的SqlSessionFactory物件，這個物件的生命周期一般和應用的生命周期是一樣的，隨著應用的啟動而創建，隨著應用的停止而結束，所以一般是一個全域物件，一般情況下一個db對應一個SqlSessionFactory物件，

構建SqlSession物件

SqlSession相當于jdbc中的Connection物件，相當于資料庫的一個連接，可以用SqlSession來對db進行操作：如執行sql、提交事務、關閉連接等等，需要通過SqlSessionFactory來創建SqlSession物件，SqlSessionFactory中常用的有2個方法來創建SqlSession物件，如下：

//創建一個SqlSession，默認不會自動提交事務
SqlSession openSession();
//創建一個SqlSession,autoCommit：指定是否自動提交事務
SqlSession openSession(boolean autoCommit);

SqlSession介面中很多方法，直接用來操作db，方法清單如下，大家眼熟一下：

<T> T selectOne(String statement);
<T> T selectOne(String statement, Object parameter);
<E> List<E> selectList(String statement);
<E> List<E> selectList(String statement, Object parameter);
<E> List<E> selectList(String statement, Object parameter, RowBounds rowBounds);
<K, V> Map<K, V> selectMap(String statement, String mapKey);
<K, V> Map<K, V> selectMap(String statement, Object parameter, String mapKey);
<K, V> Map<K, V> selectMap(String statement, Object parameter, String mapKey, RowBounds rowBounds);
<T> Cursor<T> selectCursor(String statement);
<T> Cursor<T> selectCursor(String statement, Object parameter);
<T> Cursor<T> selectCursor(String statement, Object parameter, RowBounds rowBounds);
void select(String statement, Object parameter, ResultHandler handler);
void select(String statement, ResultHandler handler);
void select(String statement, Object parameter, RowBounds rowBounds, ResultHandler handler);
int insert(String statement);
int insert(String statement, Object parameter);
int update(String statement);
int update(String statement, Object parameter);
int delete(String statement);
int delete(String statement, Object parameter);
void commit();
void commit(boolean force);
void rollback();
void rollback(boolean force);
List<BatchResult> flushStatements();
void close();
void clearCache();
Configuration getConfiguration();
<T> T getMapper(Class<T> type);
Connection getConnection();

上面以select開頭的可以對db進行查詢操作，insert相關的可以對db進行插入操作，update相關的可以對db進行更新操作，

引入lombok支持（非必須）

Lombok能以簡單的注解形式來簡化java代碼，提高開發人員的開發效率，例如開發中經常需要寫的javabean，都需要花時間去添加相應的getter/setter，也許還要去寫構造器、equals等方法，而且需要維護，當屬性多時會出現大量的getter/setter方法，這些顯得很冗長也沒有太多技術含量，一旦修改屬性，就容易出現忘記修改對應方法的失誤，

Lombok能通過注解的方式，在編譯時自動為屬性生成構造器、getter/setter、equals、hashcode、toString方法，出現的神奇就是在原始碼中沒有getter和setter方法，但是在編譯生成的位元組碼檔案中有getter和setter方法，這樣就省去了手動重建這些代碼的麻煩，使代碼看起來更簡潔些，

lombok的使用步驟

  • 先在idea中安裝lombok插件
    打開idea，點擊File->Settings->plugins，然后搜索Lombok Plugin，點擊安裝就可以了，
  • maven中引入lombok支持
<dependency>
   <groupId>org.projectlombok</groupId>
   <artifactId>lombok</artifactId>
   <version>1.18.10</version>
   <scope>provided</scope>
</dependency>
  • 代碼中使用lombok相關功能

引入logback（非必須）

為了方便查看mybatis運行程序中產生的日志，比如：執行的sql、sql的引數、sql的執行結果等等除錯資訊，我們需要引入日志框架的支持，logback是一個很好的日志框架，此處我們就使用這個

mybatis中集成logback步驟

  • maven中引入logback支持
<dependency>
   <groupId>ch.qos.logback</groupId>
   <artifactId>logback-classic</artifactId>
   <version>1.2.3</version>
</dependency>
  • src/main/resources中創建logback.xml檔案：
<?xml version="1.0" encoding="UTF-8"?>
<configuration>
   <appender name="STDOUT" >
       <encoder>
           <pattern>%d{mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
       </encoder>
   </appender>
   <logger name="zhonghu" level="debug" additivity="false">
       <appender-ref ref="STDOUT" />
   </logger>
</configuration>

logback.xml具體的寫法不是本文討論的范圍，有興趣的朋友可以去研究一下logback具體的用法，

寫一個測驗用例

上面說了這么多，下面我們就寫一個測驗類來演示一下

內容如下：

package zhonghu.mybatis.chat01;

import lombok.extern.slf4j.Slf4j;
import org.apache.ibatis.io.Resources;
import org.apache.ibatis.session.SqlSession;
import org.apache.ibatis.session.SqlSessionFactory;
import org.apache.ibatis.session.SqlSessionFactoryBuilder;
import org.junit.Before;
import org.junit.Test;

import java.io.IOException;
import java.io.InputStream;

@Slf4j
public class UserMapperTest {
    private SqlSessionFactory sqlSessionFactory;
    @Before
    public void before() throws IOException {
        //指定mybatis全域組態檔
        String resource = "mybatis-config.xml";
        //讀取全域組態檔
        InputStream inputStream = Resources.getResourceAsStream(resource);
        //構建SqlSessionFactory物件
        SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
        this.sqlSessionFactory = sqlSessionFactory;
    }
    @Test
    public void sqlSession() {
        SqlSession sqlSession = this.sqlSessionFactory.openSession();
        log.info("{}", sqlSession);
    }

}

上面代碼中有個@Slf4j注解，這個是lombok提供的，可以在這個類中生成下面代碼：

private static final org.slf4j.Logger log = org.slf4j.LoggerFactory.getLogger(UserTest.class);

運行一下上面的用例：sqlSession方法，輸出如下：

37:52.473 [main] INFO  z.mybatis.chat01.UserMapperTest - org.apache.ibatis.session.defaults.DefaultSqlSession@2d127a61

至此我們就搭建了一個最小化的Mybatis專案，后面就需要我們根據需要撰寫我們的sql檔案

使用SqlSesion執行sql操作

SqlSession常見的用法

SqlSession相當于一個連接，可以使用這個物件對db執行增刪改查操作，操作完畢之后需要關閉，使用步驟：

  • 獲取SqlSession物件：通過該sqlSessionFactory.openSession方法獲取SqlSession物件
  • 對db進行操作：使用SqlSession物件進行db操作
  • 關閉SqlSession物件：sqlSession.close();

如下所示

//獲取SqlSession
SqlSession sqlSession = this.sqlSessionFactory.openSession();
try {
    //執行業務操作，如：增刪改查
} finally {
    //關閉SqlSession
    sqlSession.close();
}

上面我們將SqlSession的關閉放在finally塊中，確保close()一定會執行，

新增操作

需求：傳入UserModel物件，然后將這個物件的資料插入到user表中，

創建一個UserModel

UserModel類，代碼如下：

package zhonghu.mybatis.chat01;

import lombok.*;

@Getter
@Setter
@NoArgsConstructor
@AllArgsConstructor
@Builder
@ToString
public class UserModel {
    private Long id;
    private String name;
    private Integer age;
    private Double salary;
}

這個類的欄位和user表對應，

user.xml中定義插入操作

我們說過了，對user表的所有sql操作，我們都放在user.xml中，我們在user.xml中加入下面配置，使用insert元素定義插入操作：

<!-- insert用來定義一個插入操作
     id：操作的具體標識
     parameterType：指定插入操作接受的引數型別
 -->
<insert id="insertUser" parameterType="zhonghu.mybatis.chat01.UserModel">
    <![CDATA[
    INSERT INTO user (id,name,age,salary) VALUES (#{id},#{name},#{age},#{salary})
     ]]>
</insert>
  • insert元素用來定義了一個對db的insert操作
  • id：是這個操作的一個標識，一會通過mybatis執行操作的時候會通過這個namespace和id參考到這個insert操作，
  • parameterType：用來指定這個insert操作接受的引數的型別，可以是：各種javabean、map、list、collection型別的java物件，我們這個插入接受的是UserModel物件，
  • insert元素內部定義了具體的sql，可以看到是一個insert的sql，向user表插入資料，

需要插入的值從UserModel物件中獲取，取UserModel物件的的欄位，使用#{欄位}這種格式可以獲取到UserModel中欄位的值，

呼叫SqlSession.insert方法執行插入操作

user插入的sql我們已經在UserMapper中寫好，此時我們怎么呼叫呢？

需要呼叫SqlSession.insert方法：

int insert(String statement, Object parameter)

這個方法有2個引數:

  • statement：表示那個操作，值為Mapper xml的namespace.具體操作的id，如需要呼叫UserMapper.xml中的insertUser操作，這個值就是：
zhonghu.mybatis.chat01.UserMapper.insertUser
  • parameter：insert操作的引數，和Mapper xml中的insert中的parameterType指定的型別一致，

回傳值為插入的行數，

UserTest類中新增一個測驗用例：

  @Test
    public void insertUser() {
        try (SqlSession sqlSession = this.sqlSessionFactory.openSession(false);) {
            //創建UserModel物件
            UserModel userModel = UserModel.builder().id(69L).name("Java冢狐").age(30).salary(50000D).build();
            //執行插入操作
            int result = sqlSession.insert("zhonghu.mybatis.chat01.UserMapper.insertUser", userModel);
            log.info("插入影響行數：{}", result);
            //提交事務
            sqlSession.commit();
        }
    }

運行輸出如下：

05:15.831 [main] DEBUG z.m.chat01.UserMapper.insertUser - ==>  Preparing: INSERT INTO user (id,name,age,salary) VALUES (?,?,?,?) 
05:15.853 [main] DEBUG z.m.chat01.UserMapper.insertUser - ==> Parameters: 69(Long), Java冢狐(String), 30(Integer), 50000.0(Double)
05:15.951 [main] DEBUG z.m.chat01.UserMapper.insertUser - <==    Updates: 1
05:15.952 [main] INFO  z.mybatis.chat01.UserMapperTest - 插入影響行數：1

輸出中列印了詳細的sql陳述句，以及sql的引數資訊，可以看到Mapper xml中的#{}被替換為了?，這個使用到了jdbc中的PreparedStatement來對引數設定值，

輸出中的第二行詳細列出了引數的值以及每個值的型別，

第三行輸出了insert的結果為1，表示插入成功了1行記錄，

上面代碼中創建SqlSession，我們使用的是sqlSessionFactory.openSession()創建的，這個方法創建的SqlSession，內部事務是非自動提交的方式，所以需要我們手動提交：

增、刪、改操作都需要提交事務

sqlSession.commit();

如果想自動提交事務，在上面在創建SqlSession的時候改為sqlSessionFactory.openSession(true)，指定事務為自動提交模式，所以最后我們不需要手動提交事務了，

更新操作

需求：傳入UserModel物件，然后通過id更新資料，

UserMapper.xml中定義Update操作

使用update定義更新操作：

<!-- update用來定義一個更新操作
     id：操作的具體標識
     parameterType：指定操作接受的引數型別
 -->
    <update id="updateUser" parameterType="zhonghu.mybatis.chat01.UserModel">
    <![CDATA[
    UPDATE user SET name = #{name},age = #{age},salary = #{salary} WHERE id = #{id}
    ]]>
</update>

寫法和insert操作的寫法類似，指定id標識、parameterType指定操作的引數型別，元素體中是具體的sql陳述句，

呼叫SqlSession.update方法執行更新操作

需要呼叫SqlSession.update方法：

int update(String statement, Object parameter)

這個方法有2個引數:

  • statement：表示哪個操作，值為Mapper xml的namespace.具體操作的id，如需要呼叫UserMapper.xml中的updateUser操作，這個值就是：
zhonghu.mybatis.chat01.UserMapper.updateUser
  • parameter：update操作的引數，和Mapper xml中的update中的parameterType指定的型別一致，

回傳值為update影響行數，

UserTest類中新增一個測驗用例：

    @Test
    public void updateUser() {
        try (SqlSession sqlSession = this.sqlSessionFactory.openSession(true);) {
            //創建UserModel物件
            UserModel userModel = UserModel.builder().id(1L).name("Java冢狐，你好").age(18).salary(5000D).build();
            //執行更新操作
            int result = sqlSession.update("zhonghu.mybatis.chat01.UserMapper.updateUser", userModel);
            log.info("影響行數：{}", result);
        }
    }

運行輸出：

12:17.143 [main] DEBUG z.m.chat01.UserMapper.updateUser - ==>  Preparing: UPDATE user SET name = ?,age = ?,salary = ? WHERE id = ? 
12:17.163 [main] DEBUG z.m.chat01.UserMapper.updateUser - ==> Parameters: Java冢狐，你好(String), 18(Integer), 5000.0(Double), 1(Long)
12:17.258 [main] DEBUG z.m.chat01.UserMapper.updateUser - <==    Updates: 1
12:17.258 [main] INFO  z.mybatis.chat01.UserMapperTest - 影響行數：1

洗掉操作

需求：根據用戶的id洗掉對應的用戶記錄

UserMapper.xml中定義Delete操作

使用update元素定義洗掉操作：

<!-- update用來定義一個洗掉操作
     id：操作的具體標識
     parameterType：指定操作接受的引數型別
 -->
<update id="deleteUser" parameterType="java.lang.Long">
    <![CDATA[
    DELETE FROM user WHERE id = #{id}
    ]]>
</update>

寫法和update操作的寫法類似，指定id標識、parameterType指定操作的引數型別，用戶id為Long型別的，元素體中是具體的delete陳述句，

呼叫SqlSession.update方法執行更新操作

需要呼叫SqlSession.delete方法：

int delete(String statement, Object parameter)

這個方法有2個引數:

  • statement：表示哪個操作，值為Mapper xml的namespace.具體操作的id，如需要呼叫UserMapper.xml中的deleteUser操作，這個值就是：
com.javacode2018.chat02.UserMapper.
  • parameter：delete操作的引數，和Mapper xml中的delete中的parameterType指定的型別一致，

回傳值為delete影響行數，

UserTest類中新增一個測驗用例：

    @Test
    public void deleteUser() {
        try (SqlSession sqlSession = this.sqlSessionFactory.openSession(true);) {
            //定義需要洗掉的用戶id
            Long userId = 1L;
            //執行洗掉操作
            int result = sqlSession.delete("zhonghu.mybatis.chat01.UserMapper.deleteUser", userId);
            log.info("影響行數：{}", result);
        }
    }

運行輸出：

14:26.711 [main] DEBUG z.m.chat01.UserMapper.deleteUser - ==>  Preparing: DELETE FROM user WHERE id = ? 
14:26.729 [main] DEBUG z.m.chat01.UserMapper.deleteUser - ==> Parameters: 1(Long)
14:26.811 [main] DEBUG z.m.chat01.UserMapper.deleteUser - <==    Updates: 1
14:26.812 [main] INFO  z.mybatis.chat01.UserMapperTest - 影響行數：1

執行查詢

select陳述句有恩多屬性可以詳細的配置每一條SQL陳述句

  • SQL陳述句回傳值型別【完整的類名或者別名】
  • 傳入SQL陳述句的引數型別【建議使用萬能的map】
  • 命名空間中的唯一的識別符號
  • 介面中的方法名與映射檔案中的SQL陳述句ID一一對應

需求：查詢所有用戶資訊

UserMapper.xml中定義Select操作

    <!-- select用來定義一個查詢操作
     id：操作的具體標識
     resultType：指定查詢結果保存的型別
 -->
    <select id="getUserList" resultType="zhonghu.mybatis.chat01.UserModel">
    <![CDATA[
    SELECT * FROM user
    ]]>
</select>

寫法和update操作的寫法類似，指定id標識、parameterType指定操作的引數型別，resultType指定查詢結果的型別，元素體中是具體的select陳述句，

呼叫SqlSession.select方法執行更新操作

UserTest添加一個用例：

  @Test
    public void getUserList() {
        try (SqlSession sqlSession = this.sqlSessionFactory.openSession(true);) {
            //執行查詢操作
            List<UserModel> userModelList = sqlSession.selectList("zhonghu.mybatis.chat01.UserMapper.getUserList");
            log.info("結果：{}", userModelList);
        }
    }

多插入幾行，然后運行上面的用例，輸出如下：

16:00.798 [main] DEBUG z.m.chat01.UserMapper.getUserList - ==>  Preparing: SELECT * FROM user 
16:00.817 [main] DEBUG z.m.chat01.UserMapper.getUserList - ==> Parameters: 
16:00.829 [main] DEBUG z.m.chat01.UserMapper.getUserList - <==      Total: 16
16:00.829 [main] INFO  z.mybatis.chat01.UserMapperTest - 結果：[UserModel(id=2, name=修改冢狐, age=23, salary=50000.0), UserModel(id=3, name=修改冢狐, age=24, salary=6666.66), UserModel(id=4, name=Mybatis-1, age=19, salary=10000.0), UserModel(id=5, name=Java冢狐-2, age=25, salary=20000.0), UserModel(id=6, name=Mybatis-2, age=20, salary=20000.0), UserModel(id=7, name=Java冢狐-3, age=26, salary=30000.0), UserModel(id=8, name=Mybatis-3, age=21, salary=30000.0), UserModel(id=9, name=Java冢狐-4, age=27, salary=40000.0), UserModel(id=10, name=Mybatis-4, age=22, salary=40000.0), UserModel(id=11, name=Java冢狐-5, age=28, salary=50000.0), UserModel(id=12, name=Mybatis-5, age=23, salary=50000.0), UserModel(id=13, name=Java冢狐, age=1, salary=0.0), UserModel(id=14, name=冢狐, age=23, salary=50000.0), UserModel(id=59, name=Java冢狐, age=30, salary=50000.0), UserModel(id=69, name=Java冢狐, age=30, salary=50000.0), UserModel(id=89, name=Java冢狐, age=30, salary=50000.0)]

Mapper介面的使用

為什么需要Mapper介面

上面我們講解了對一個表的增刪改查操作，都是通過呼叫SqlSession中的方法來完成的，大家再來看一下SqlSession介面中剛才用到的幾個方法的定義：

int insert(String statement, Object parameter);
int update(String statement, Object parameter);
int delete(String statement, Object parameter);
<E> List<E> selectList(String statement);

這些方法的特點我們來看一下：

  • 呼叫這些方法，需要明確知道statement的值，statement的值為namespace.具體操作的id，這些需要打開Mapper xml中去查看了才知道，寫起來不方便
  • parameter引數都是Object型別的，我們根本不知道這個操作具體型別是什么，需要查看Mapper xml才知道，隨便傳遞個值，可能型別不匹配，但是只有在運行的時候才知道有問題
  • selectList方法回傳的是一個泛型型別的，通過這個方法我們根本不知道回傳的結果的具體型別，也需要去查看Mapper xml才知道

這些都是使用程序中不方便的情況，想要方便的使用，就需要用到mybatis中的Mapper介面，我們可以定義一個interface，然后和Mapper xml關聯起來，Mapper xml中的操作和Mapper介面中的方法會進行系結，當我們呼叫Mapper介面的方法的時候，會間接呼叫到Mapper xml中的操作，介面的完整類名需要和Mapper xml中的namespace一致，

Mapper介面的用法（三步）

步驟1：定義Mapper介面

去看一下，user.xml中的namespace，是：

<mapper namespace="zhonghu.mybatis.chat01.UserMapper">

我們創建的介面完整的名稱需要和上面的namespace的值一樣，下面我們創建一個介面UserMapper，如下：

UserMapper.xml中有4個操作，我們需要在UserMapper介面中也定義4個操作，和UserMapper.xml的4個操作對應，如下：

package zhonghu.mybatis.chat01;
import java.util.List;

public interface UserMapper {
    int insertUser(UserModel model);
    int updateUser(UserModel model);
    int deleteUser(Long userId);
    List<UserModel> getUserList();
}

UserMapper介面中定義了4個方法，方法的名稱需要和UserMapper.xml具體操作的id值一樣，這樣呼叫UserMapper介面中的方法的時候，才會對應的找到UserMapper.xml中具體的操作，

比如呼叫UserMapper介面中的insertUser方法，mybatis查找的規則是：通過介面完整名稱.方法名稱去Mapper xml中找到對應的操作，

步驟2：通過SqlSession獲取Mapper介面物件

SqlSession中有個getMapper方法，可以傳入介面的型別，獲取具體的Mapper介面物件，如下：

/**
   * Retrieves a mapper.
   * @param <T> the mapper type
   * @param type Mapper interface class
   * @return a mapper bound to this SqlSession
   */
  <T> T getMapper(Class<T> type);

如獲取UserMapper介面物件：

UserMapper mapper = sqlSession.getMapper(UserMapper.class);

步驟3：呼叫Mapper介面的方法對db進行操作

如呼叫UserMapper介面的insert操作：

@Test
public void insertUser() {
    try (SqlSession sqlSession = this.sqlSessionFactory.openSession(true);) {
        UserMapper mapper = sqlSession.getMapper(UserMapper.class);
        //創建UserModel物件
        UserModel userModel = UserModel.builder().id(System.currentTimeMillis()).name("Java冢狐").age(30).salary(50000D).build();
        //執行插入操作
        int insert = mapper.insertUser(userModel);
        log.info("影響行數：{}", insert);
    }
}

案例：使用Mapper介面來實作增刪改查

創建一個測驗類，代碼如下：

package zhonghu.mybatis.chat01;
import lombok.extern.slf4j.Slf4j;
import org.apache.ibatis.io.Resources;
import org.apache.ibatis.session.SqlSession;
import org.apache.ibatis.session.SqlSessionFactory;
import org.apache.ibatis.session.SqlSessionFactoryBuilder;
import org.junit.Before;
import org.junit.Test;
import java.io.IOException;
import java.io.InputStream;
import java.util.List;

@Slf4j
public class UserMapperTest {
    private SqlSessionFactory sqlSessionFactory;
    @Before
    public void before() throws IOException {
        //指定mybatis全域組態檔
        String resource = "mybatis-config.xml";
        //讀取全域組態檔
        InputStream inputStream = Resources.getResourceAsStream(resource);
        //構建SqlSessionFactory物件
        SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
        this.sqlSessionFactory = sqlSessionFactory;
    }
    @Test
    public void insertUser() {
        try (SqlSession sqlSession = this.sqlSessionFactory.openSession(true);) {
            UserMapper mapper = sqlSession.getMapper(UserMapper.class);
            //創建UserModel物件
            UserModel userModel = UserModel.builder().id(System.currentTimeMillis()).name("Java冢狐").age(30).salary(50000D).build();
            //執行插入操作
            int insert = mapper.insertUser(userModel);
            log.info("影響行數：{}", insert);
        }
    }
    @Test
    public void updateUser() {
        try (SqlSession sqlSession = this.sqlSessionFactory.openSession(true);) {
            UserMapper mapper = sqlSession.getMapper(UserMapper.class);
            //創建UserModel物件
            UserModel userModel = UserModel.builder().id(1L).name("Java冢狐，你好").age(18).salary(5000D).build();
            //執行更新操作
            int result = mapper.updateUser(userModel);
            log.info("影響行數：{}", result);
        }
    }
    @Test
    public void deleteUser() {
        try (SqlSession sqlSession = this.sqlSessionFactory.openSession(true);) {
            UserMapper mapper = sqlSession.getMapper(UserMapper.class);
            //定義需要洗掉的用戶id
            Long userId = 1L;
            //執行洗掉操作
            int result = mapper.deleteUser(userId);
            log.info("影響行數：{}", result);
        }
    }
    @Test
    public void getUserList() {
        try (SqlSession sqlSession = this.sqlSessionFactory.openSession(true);) {
            UserMapper mapper = sqlSession.getMapper(UserMapper.class);
            //執行查詢操作
            List<UserModel> userModelList = mapper.getUserList();
            userModelList.forEach(item -> {
                log.info("{}", item);
            });
        }
    }
}

大家認真看一下上面的代碼，這次我們使用了UserMapper來間接呼叫UserMapper.xml中對應的操作，可以去運行一下感受一下效果，

Mapper介面使用時注意的幾點

  • Mapper介面的完整類名必須和對應的Mapper xml中的namespace的值一致
  • Mapper介面中方法的名稱需要和Mapper xml中具體操作的id值一致
  • Mapper介面中方法的引數、回傳值可以不和Mapper xml中的一致

Mapper介面的原理

這個使用java中的動態代理實作的，mybatis啟動的時候會加載全域組態檔mybatis-config.xml，然后決議這個檔案中的mapper元素指定的UserMapper.xml，會根據UserMapper.xml的namespace的值創建這個介面的一個動態代理，具體可以去看一下mybatis的原始碼，主要使用java中的Proxy實作的，使用java.lang.reflect.Proxy類中的newProxyInstance方法，我們可以創建任意一個介面的一個代理物件：

public static Object newProxyInstance(ClassLoader loader,
                                          Class<?>[] interfaces,
                                          InvocationHandler h)

我們使用Proxy來模仿Mapper介面的實作：

package zhonghu.mybatis.chat01;

import lombok.extern.slf4j.Slf4j;
import org.apache.ibatis.io.Resources;
import org.apache.ibatis.session.SqlSession;
import org.apache.ibatis.session.SqlSessionFactory;
import org.apache.ibatis.session.SqlSessionFactoryBuilder;
import org.junit.Before;
import org.junit.Test;

import java.io.IOException;
import java.io.InputStream;
import java.lang.reflect.InvocationHandler;
import java.lang.reflect.Method;
import java.lang.reflect.Proxy;
import java.util.List;

@Slf4j
public class UserMapperTest {
    public static class UserMapperProxy implements InvocationHandler {
        private SqlSession sqlSession;
        private Class<?> mapperClass;
        public UserMapperProxy(SqlSession sqlSession, Class<?> mapperClass) {
            this.sqlSession = sqlSession;
            this.mapperClass = mapperClass;
        }
        @Override
        public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
            log.debug("invoke start");
            String statement = mapperClass.getName() + "." + method.getName();
            List<Object> result = sqlSession.selectList(statement);
            log.debug("invoke end");
            return result;
        }
    }
    private SqlSessionFactory sqlSessionFactory;
    @Before
    public void before() throws IOException {
        //指定mybatis全域組態檔
        String resource = "mybatis-config.xml";
        //讀取全域組態檔
        InputStream inputStream = Resources.getResourceAsStream(resource);
        //構建SqlSessionFactory物件
        SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);
        this.sqlSessionFactory = sqlSessionFactory;
    }
    @Test
    public void test1() {
        try (SqlSession sqlSession = this.sqlSessionFactory.openSession(true);) {
            UserMapper userMapper = (UserMapper) Proxy.newProxyInstance(UserMapperTest.class.getClassLoader(), new Class[]{UserMapper.class}, new UserMapperProxy(sqlSession, UserMapper.class));
            log.info("{}", userMapper.getUserList());
        }
    }
}

上面代碼中：UserMapper是沒有實作類的，可以通過Proxy.newProxyInstance給UserMapper介面創建一個代理物件，當呼叫UserMapper介面的方法的時候，會呼叫到UserMapperProxy物件的invoke方法，

運行一下test1用例，輸出如下：

29:37.847 [main] DEBUG z.m.chat01.UserMapper.getUserList - ==>  Preparing: SELECT * FROM user 
29:37.865 [main] DEBUG z.m.chat01.UserMapper.getUserList - ==> Parameters: 
29:37.878 [main] DEBUG z.m.chat01.UserMapper.getUserList - <==      Total: 16
29:37.878 [main] DEBUG z.mybatis.chat01.UserMapperTest - invoke end
29:37.878 [main] INFO  z.mybatis.chat01.UserMapperTest - [UserModel(id=2, name=修改冢狐, age=23, salary=50000.0), UserModel(id=3, name=修改冢狐, age=24, salary=6666.66), UserModel(id=4, name=Mybatis-1, age=19, salary=10000.0), UserModel(id=5, name=Java冢狐-2, age=25, salary=20000.0), UserModel(id=6, name=Mybatis-2, age=20, salary=20000.0), UserModel(id=7, name=Java冢狐-3, age=26, salary=30000.0), UserModel(id=8, name=Mybatis-3, age=21, salary=30000.0), UserModel(id=9, name=Java冢狐-4, age=27, salary=40000.0), UserModel(id=10, name=Mybatis-4, age=22, salary=40000.0), UserModel(id=11, name=Java冢狐-5, age=28, salary=50000.0), UserModel(id=12, name=Mybatis-5, age=23, salary=50000.0), UserModel(id=13, name=Java冢狐, age=1, salary=0.0), UserModel(id=14, name=冢狐, age=23, salary=50000.0), UserModel(id=59, name=Java冢狐, age=30, salary=50000.0), UserModel(id=69, name=Java冢狐, age=30, salary=50000.0), UserModel(id=89, name=Java冢狐, age=30, salary=50000.0)]

注意上面輸出的invoke start和invoke end，可以看到我們呼叫userMapper.getUserList時候，被UserMapperProxy#invoke方法處理了，

Mybatis中創建Mapper介面代理物件使用的是下面這個類，大家可以去研究一下：

public class MapperProxyFactory<T> {
  private final Class<T> mapperInterface;
  private final Map<Method, MapperMethod> methodCache = new ConcurrentHashMap<Method, MapperMethod>();
  public MapperProxyFactory(Class<T> mapperInterface) {
    this.mapperInterface = mapperInterface;
  }
  public Class<T> getMapperInterface() {
    return mapperInterface;
  }
  public Map<Method, MapperMethod> getMethodCache() {
    return methodCache;
  }
  @SuppressWarnings("unchecked")
  protected T newInstance(MapperProxy<T> mapperProxy) {
    return (T) Proxy.newProxyInstance(mapperInterface.getClassLoader(), new Class[] { mapperInterface }, mapperProxy);
  }
  public T newInstance(SqlSession sqlSession) {
    final MapperProxy<T> mapperProxy = new MapperProxy<T>(sqlSession, mapperInterface, methodCache);
    return newInstance(mapperProxy);
  }
}

最后

  • 如果覺得看完有識訓，希望能關注一下，順便給我點個贊，這將會是我更新的最大動力，感謝各位的支持
  • 歡迎各位關注我的公眾號【java冢狐】，專注于java和計算機基礎知識，保證讓你看完有所識訓，不信你打我
  • 求一鍵三連：點贊、轉發、在看，
  • 如果看完有不同的意見或者建議，歡迎多多評論一起交流，感謝各位的支持以及厚愛，

——我是冢狐，和你一樣熱愛編程，

歡迎關注公眾號“Java冢狐”獲取最新訊息

轉載請註明出處，本文鏈接：https://www.uj5u.com/houduan/257311.html

標籤：Java

上一篇：Java基礎語法

下一篇：介面的定義與實作

標籤雲
其他(157675) Python(38076) JavaScript(25376) Java(17977) C(15215) 區塊鏈(8255) C＃(7972) AI(7469) 爪哇(7425) MySQL(7132) html(6777) 基礎類(6313) sql(6102) 熊猫(6058) PHP(5869) 数组(5741) R(5409) Linux(5327) 反应(5209) 腳本語言(PerlPython)(5129) 非技術區(4971) Android(4554) 数据框(4311) css(4259) 节点.js(4032) C語言(3288) json(3245) 列表(3129) 扑(3119) C++語言(3117) 安卓(2998) 打字稿(2995) VBA(2789) Java相關(2746) 疑難問題(2699) 细绳(2522) 單片機工控(2479) iOS(2429) ASP.NET(2402) MongoDB(2323) 麻木的(2285) 正则表达式(2254) 字典(2211) 循环(2198) 迅速(2185) 擅长(2169) 镖(2155) 功能(1967) .NET技术(1958) Web開發(1951) python-3.x(1918) HtmlCss(1915) 弹簧靴(1913) C++(1909) xml(1889) PostgreSQL(1872) .NETCore(1853) 谷歌表格(1846) Unity3D(1843) for循环(1842)

熱門瀏覽
  • 【C++】Microsoft C++、C 和匯編程式檔案

    ......

    uj5u.com 2020-09-10 00:57:23 more
  • 例外宣告

    相比于斷言適用于排除邏輯上不可能存在的狀態，例外通常是用于邏輯上可能發生的錯誤。 例外宣告 Item 1：當函式不可能拋出例外或不能接受拋出例外時，使用noexcept 理由 如果不打算拋出例外的話，程式就會認為無法處理這種錯誤，并且應當盡早終止，如此可以有效地阻止例外的傳播與擴散。 示例 //不可 ......

    uj5u.com 2020-09-10 00:57:27 more
  • Codeforces 1400E Clear the Multiset(貪心 + 分治)

    鏈接：https://codeforces.com/problemset/problem/1400/E 來源：Codeforces 思路：給你一個陣列，現在你可以進行兩種操作，操作1：將一段沒有 0 的區間進行減一的操作，操作2：將 i 位置上的元素歸零。最終問：將這個陣列的全部元素歸零后操作的最少 ......

    uj5u.com 2020-09-10 00:57:30 more
  • UVA11610 【Reverse Prime】

    本人看到此題沒有翻譯，就附帶了一個自己的翻譯版本 思考 這一題，它的第一個要求是找出所有 $7$ 位反向質數及其質因數的個數。 我們應該需要質數篩篩選1~$10^{7}$的所有數，這里就不慢慢介紹了。但是，重讀題，我們突然發現反向質數都是 $7$ 位，而將它反過來后的數字卻是 $6$ 位數，這就說明 ......

    uj5u.com 2020-09-10 00:57:36 more
  • 統計區間素數數量

    1 #pragma GCC optimize(2) 2 #include <bits/stdc++.h> 3 using namespace std; 4 bool isprime[1000000010]; 5 vector<int> prime; 6 inline int getlist(int ......

    uj5u.com 2020-09-10 00:57:47 more
  • C/C++編程筆記：C++中的 const 變數詳解，教你正確認識const用法

    1、C中的const 1、區域const變數存放在堆疊區中，會分配記憶體（也就是說可以通過地址間接修改變數的值）。測驗代碼如下： 運行結果： 2、全域const變數存放在只讀資料段（不能通過地址修改，會發生寫入錯誤）， 默認為外部聯編，可以給其他源檔案使用（需要用extern關鍵字修飾） 運行結果： ......

    uj5u.com 2020-09-10 00:58:04 more
  • 【C++犯錯記錄】VS2019 MFC添加資源不懂如何修改資源宏ID

    1. 首先在資源視圖中，添加資源 2. 點擊新添加的資源，復制自動生成的ID 3. 在解決方案資源管理器中找到Resource.h檔案，編輯，使用整個專案搜索和替換的方式快速替換 宏宣告 4. Ctrl+Shift+F 全域搜索，點擊查找全部，然后逐個替換 5. 為什么使用搜索替換而不使用屬性視窗直 ......

    uj5u.com 2020-09-10 00:59:11 more
  • 【C++犯錯記錄】VS2019 MFC不懂的批量添加資源

    1. 打開資源頭檔案Resource.h，在其中預先定義好宏 ID（不清楚其實ID值應該設定多少，可以先新建一個相同的資源項，再在這個資源的ID值的基礎上遞增即可） 2. 在資源視圖中選中專案資源，按F7編輯資源檔案，按 ID 型別 相對路徑的形式添加 資源。（別忘了先把檔案拷貝到專案中的res檔案 ......

    uj5u.com 2020-09-10 01:00:19 more
  • C/C++編程筆記：關于C++的參考型別，專供新手入門使用

    今天要講的是C++中我最喜歡的一個用法——參考，也叫別名。 參考就是給一個變數名取一個變數名，方便我們間接地使用這個變數。我們可以給一個變數創建N個參考，這N + 1個變數共享了同一塊記憶體區域。(參考型別的變數會占用記憶體空間，占用的記憶體空間的大小和指標型別的大小是相同的。雖然參考是一個物件的別名，但 ......

    uj5u.com 2020-09-10 01:00:22 more
  • 【C/C++編程筆記】從頭開始學習C ++：初學者完整指南

    眾所周知，C ++的學習曲線陡峭，但是花時間學習這種語言將為您的職業帶來奇跡，并使您與其他開發人員區分開。您會更輕松地學習新語言，形成真正的解決問題的技能，并在編程的基礎上打下堅實的基礎。 C ++將幫助您養成良好的編程習慣（即清晰一致的編碼風格，在撰寫代碼時注釋代碼，并限制類內部的可見性），并且由 ......

    uj5u.com 2020-09-10 01:00:41 more
最新发布
  • Rust中的智能指標:Box<T> Rc<T> Arc<T> Cell<T> RefCell<T> Weak

    Rust中的智能指標是什么 智能指標（smart pointers）是一類資料結構，是擁有資料所有權和額外功能的指標。是指標的進一步發展 指標（pointer）是一個包含記憶體地址的變數的通用概念。這個地址參考，或 ” 指向”（points at）一些其 他資料 。參考以 & 符號為標志并借用了他們所 ......

    uj5u.com 2023-04-20 07:24:10 more
  • Java的值傳遞和參考傳遞

    值傳遞不會改變本身，參考傳遞（如果傳遞的值需要實體化到堆里）如果發生修改了會改變本身。 1.基本資料型別都是值傳遞 package com.example.basic; public class Test { public static void main(String[] args) { int ......

    uj5u.com 2023-04-20 07:24:04 more
  • [2]SpinalHDL教程——Scala簡單入門

    第一個 Scala 程式 shell里面輸入 $ scala scala> 1 + 1 res0: Int = 2 scala> println("Hello World!") Hello World! 檔案形式 object HelloWorld { /* 這是我的第一個 Scala 程式 * 以 ......

    uj5u.com 2023-04-20 07:23:58 more
  • 理解函式指標和回呼函式

    理解 函式指標 指向函式的指標。比如： 理解函式指標的偽代碼 void (*p)(int type, char *data); // 定義一個函式指標p void func(int type, char *data); // 宣告一個函式func p = func; // 將指標p指向函式func ......

    uj5u.com 2023-04-20 07:23:52 more
  • Django筆記二十五之資料庫函式之日期函式

    本文首發于公眾號：Hunter后端 原文鏈接：Django筆記二十五之資料庫函式之日期函式 日期函式主要介紹兩個大類，Extract() 和 Trunc() Extract() 函式作用是提取日期，比如我們可以提取一個日期欄位的年份，月份，日等資料 Trunc() 的作用則是截取，比如 2022-0 ......

    uj5u.com 2023-04-20 07:23:45 more
  • 一天吃透JVM面試八股文

    什么是JVM？ JVM，全稱Java Virtual Machine（Java虛擬機），是通過在實際的計算機上仿真模擬各種計算機功能來實作的。由一套位元組碼指令集、一組暫存器、一個堆疊、一個垃圾回收堆和一個存盤方法域等組成。JVM屏蔽了與作業系統平臺相關的資訊，使得Java程式只需要生成在Java虛擬機 ......

    uj5u.com 2023-04-20 07:23:31 more
  • 使用Java接入小程式訂閱訊息！

    更新完微信服務號的模板訊息之后，我又趕緊把微信小程式的訂閱訊息給實作了！之前我一直以為微信小程式也是要企業才能申請，沒想到小程式個人就能申請。 訊息推送平臺🔥推送下發【郵件】【短信】【微信服務號】【微信小程式】【企業微信】【釘釘】等訊息型別。 https://gitee.com/zhongfuch ......

    uj5u.com 2023-04-20 07:22:59 more
  • java -- 緩沖流、轉換流、序列化流

    緩沖流 緩沖流, 也叫高效流, 按照資料型別分類： 位元組緩沖流：BufferedInputStream，BufferedOutputStream 字符緩沖流：BufferedReader，BufferedWriter 緩沖流的基本原理，是在創建流物件時，會創建一個內置的默認大小的緩沖區陣列，通過緩沖 ......

    uj5u.com 2023-04-20 07:22:49 more
  • Java-SpringBoot-Range請求頭設定實作視頻分段傳輸

    老實說，人太懶了，現在基本都不喜歡寫筆記了，但是網上有關Range請求頭的文章都太水了 下面是抄的一段StackOverflow的代碼...自己大修改過的，寫的注釋挺全的，應該直接看得懂，就不解釋了 寫的不好...只是希望能給視頻網站開發的新手一點點幫助吧. 業務場景：視頻分段傳輸、視頻多段傳輸（理 ......

    uj5u.com 2023-04-20 07:22:42 more
  • Windows 10開發教程_編程入門自學教程_菜鳥教程-免費教程分享

    教程簡介 Windows 10開發入門教程 - 從簡單的步驟了解Windows 10開發，從基本到高級概念，包括簡介，UWP，第一個應用程式，商店，XAML控制元件，資料系結，XAML性能，自適應設計，自適應UI，自適應代碼，檔案管理，SQLite資料庫，應用程式到應用程式通信，應用程式本地化，應用程式 ......

    uj5u.com 2023-04-20 07:22:35 more

Copyright © 2010-2020 有解無憂