首页 > 软件编程 > java > mybatis加载mapper文件

mybatis 运行时加载自定义mapper文件方式

2021-07-22 14:55:19 作者：幸福的娃娃菜

这篇文章主要介绍了mybatis 运行时加载自定义mapper文件方式，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教

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>

以上为个人经验，希望能给大家一个参考，也希望大家多多支持脚本之家。

mybatis 运行时加载自定义mapper文件方式