mybatis 運行時加載自定義mapper文件方式

Posted on 2021-07-22 by WalkonNet

mybatis 運行時加載自定義mapper文件

用mybatis一定要寫mapper文件，這是使用mybatis的常識，但有時候應用需求，mapper文件中的節點需要動態生成，或者根據業務場景進行組裝，那這個時候的SQL語句直接寫在mapper文件顯然不可取，又或者采用動態SQL完成，今天介紹一種方式，支行時加載自定義mapper配置文件。

我首先介紹一種mapper文件存在的寫法，也是大傢常用的，至於spring-mybatis配置方法，我這裡就不列瞭：

dao接口：

package com.springmvc.mybatis.dao;
import java.util.List;
public interface DatabaseObjectQueryDao { 
 List<String> getAllSequence(); 
}

mapper文件：

<?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.springmvc.mybatis.dao.DatabaseObjectQueryDao">
 <select id="getAllSequence" resultType="String">
  select sysdate from dual
 </select> 
</mapper>

好，大傢註意瞭，下面開始分享無mapper動態加載寫法！

dao接口：

package com.springmvc.mybatis.dao;
/**
 * Discript：
 *
 * @author 
 * @date 創建時間：2018/10/11 15:33
 */
public interface LoadMapperFileDao {
    String getAllSequence();
}

這裡沒有mapper文件，怎麼辦？沒有我們就給他造：

package com.springmvc.mybatis.test;
import org.apache.ibatis.builder.xml.XMLMapperBuilder;
import org.apache.ibatis.session.Configuration;
import org.apache.ibatis.session.SqlSessionFactory;
import org.springframework.beans.factory.InitializingBean;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
import java.io.ByteArrayInputStream;
import java.io.InputStream;
/**
 * Discript：
 *
 * @author  
 * @date 創建時間：2018/10/11 15:01
 */
@Service
public class LoadMapperFileTest implements InitializingBean{
    @Autowired
    private SqlSessionFactory sqlSessionFactory;
    private Configuration mapperConfig;
    public void afterPropertiesSet() throws Exception {
    //mapper文件的實際內容，此處可根據業務需求進行拼裝文件內容
        String contextXml = "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n" +
                "<!DOCTYPE mapper PUBLIC \"-//mybatis.org//DTD Mapper 3.0//EN\"  \n" +
                "\"http://mybatis.org/dtd/mybatis-3-mapper.dtd\">\n" +
                "<mapper namespace=\"com.springmvc.mybatis.dao.LoadMapperFileDao\">\n" +
                "\t<select id=\"getAllSequence\" resultType=\"String\">\n" +
                "\t\tselect sysdate from dual \n" +
                "\t</select>\n" +
                "</mapper>";
         //一般與namespace相同
        String mapperId = "com.springmvc.mybatis.dao.LoadMapperFileDao";
        mapperConfig = sqlSessionFactory.getConfiguration();
        try {
            InputStream is = new ByteArrayInputStream(contextXml.getBytes());
            XMLMapperBuilder xmlMapperBuilder = new XMLMapperBuilder(is, this.mapperConfig, mapperId, this.mapperConfig.getSqlFragments());
            xmlMapperBuilder.parse();
            System.out.println("自定義加載完畢!");
        }catch (Exception e){
        }
    }
}

總體測試效果及結果代碼如下，大傢可以看到DatabaseObjectQueryDao 調用的方法返回值是list所以結果有中括號。

而LoadMapperFileDao調用方法返回的是string所以隻看見一串時間：

在這裡插入圖片描述

mybatis 加載 mapper 映射文件的三種方式

有一段時間沒用過 mybatis 瞭，今天重溫瞭一下 mybatis，來瞭解下 mybatis 加載映射文件的三種方式。

第一種：通過資源路徑加載

如果你的 mapper 文件在如圖所示的地方

在這裡插入圖片描述

你在 mybatis 的配置文件中可以這樣加載 mapper

<mappers>
	<mapper resource="com/yangtao9898/jungle_war_server/mapper/UserDao.xml"/>
</mappers>

記住，通過 resource 加載，中間是斜杠 “/” 而不是點 “.” 哦。

第二種：通過加載接口類來加載映射文件

如果你的 mapper 文件和接口文件在同一個包下且同名

在這裡插入圖片描述

就可以通過加載接口類來加載映射文件

在配置文件中這樣寫

<mappers>
	<mapper class="com.yangtao9898.jungle_war_server.dao.UserDao"/>
</mappers>

第三種：批量加載類接口和映射文件

用此種方式批量加載，也需要接口類名和 mapper 名稱相同

在這裡插入圖片描述

配置如下，這樣就可以掃描整個包的 mapper 文件

<mappers>
	<package name="com.yangtao9898.jungle_war_server.dao"/>
</mappers>

以上為個人經驗，希望能給大傢一個參考，也希望大傢多多支持WalkonNet。

mybatis 運行時加載自定義mapper文件方式