Mybatis mapper.xml使用全局变量的三种实现方法

 更新时间:2025年02月08日 09:16:19   作者:lijiabin417  
文章介绍了在Mybatis的Mapper.xml文件中使用全局变量来动态配置数据库库名的实现方案,包括使用mybaits自带全局变量、使用@value和mybatis进行全局变量定义以及使用@value和mybatis进行全局变量定义并减少形参的方案

Mybatis mapper.xml使用全局变量

一、概述

开发中的遇到一个有关于统计需求,而这个需求需要根据两个数据库才能实现,而如果直接通过两个模块之间的交互也可以实现,但是这样一来,如果加入了搜索条件,而这搜索条件又分散在不同的库中,这样依赖数据处理起来就很复杂,而且还没有对数据进行有效的分页处理,考虑目前数据库都放再一台服务器中,还没有不同数据库放在不同服务器的需求,在sql中引入了库名。

虽然引入了库名,对应的业务能跑起来了,但是也遇到过一个比较奇特的问题,也就是数据库中存在了同名的库,因为之前的sql中引入了库名,在不改变代码的情况下,直接修改配置文件和数据库的库名会导致引入了库名的sql无法使用,为此,引入了.xml文件中动态修改数据库库名的功能,具体的话通过mybatis的全局变量实现。

二、实现方案

经过摸索,大致的得到了三种实现方案

2.1 mybaits自带全局变量定义

在springboot中yml文件中加入如下全局变量配置

mybatis:
  configuration:
    variables:
      myConfigName: "`base1`"

然后再sql中

  <select id="selectTest" resultType="java.util.Map">
      select * from ${myConfigName}.table1
  </select>

需要注意的是反引号 " ` ",如果不再库名上加上反引号,那么sql就无法顺利的跑起来,此外占位符要使用$,因为$才获取到全局变量

这样,就可以动态的配置库名,但是这样的话,有一个缺点,无法设置默认值,如果myConfigName没有进行配置,那么这个sql就无法执行

2.2 使用@value和mybatis进行全局变量的定义

使用@value为java的一个成员变量复制,并且实则hi默认值,这样我们通过yml文件配置对应库名了

    /**
     * 数据库名称
     */
    public static String dataBaseName;
	//注意引号
    @Value("${data-conf.dataBaseName:`test`}")
    private void setUserDataBaseName(String name){
        dataBaseName=name;
    }

mapper定义和对应的sql调用

List<Object> getInfoFromtaba(@Param("dataBaseName") String dataBaseName);
List<Object> result=xxxmapper.getInfoFromtaba(xxx.dataBaseName)

.xml写法

<!-- 注意,这里可以使用#占位符 --->
  <select id="selectTest" resultType="java.util.Map">
      select * from #{dataBaseName}.table1
  </select>

这种方式解决了默认数据库名的问题,但是也存在一个问题,就是mapper的接口中多了数据库名作为参数,这种形参的设置看着很别扭。

2.3 使用@value和mybatis进行全局变量的定义

这种方式类似于上述2.2 的方案,只是他能减少mapper接口的不必要的数据库名形参,只要不去细看sql,一般情况,开发人员感受不到库名的动态配置

    /**
     * 数据库名称
     */
    public static String dataBaseName;
	//注意引号
    @Value("${data-conf.dataBaseName:`test`}")
    private void setUserDataBaseName(String name){
        dataBaseName=name;
    }
<!-- 注意,这里可以使用#占位符 --->
  <select id="selectTest" resultType="java.util.Map">
      select * from 
      <choose>
           <when test="null !=  @com.project.mapper.config.TestClass@dataBaseName">
               ${@com.project.mapper.config.TestClass@dataBaseName}.table1 AS tu
           </when>
           <otherwise>
               `pre-base`.table1 AS tu
           </otherwise>
       </choose>
  </select>

注:这里@com.project.mapper.config.TestClass@dataBaseName 的第一个@com.project.mapper.config.TestClass是类的路径,后面的@dataBaseName是库名。

注意再test中boolean表达式子中不需要$占位符,而后续具体数据的位置需要展示位符号$,使用<chose>的原因一是为了保险,这样就是对应的变量的默认值丢失了,也能使用默认库,二是为了避免${}报变量过长的错

总结

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

相关文章

  • Spring AOP 中 JoinPoint 使用详解

    Spring AOP 中 JoinPoint 使用详解

    JoinPoint是Spring AOP中获取方法运行时信息的核心接口,可以获取方法参数、类名、方法名、Method对象、注解等,下面就来介绍一下Spring AOP  JoinPoint 使用,感兴趣的可以了解一下
    2026-02-02
  • Java中的拦截器、过滤器、监听器用法详解

    Java中的拦截器、过滤器、监听器用法详解

    这篇文章主要介绍了Java中的拦截器、过滤器、监听器用法,详细分析了Java拦截器、过滤器、监听器的功能、使用方法及相关注意事项,需要的朋友可以参考下
    2017-05-05
  • java多线程之停止线程的方法实例代码详解

    java多线程之停止线程的方法实例代码详解

    这篇文章主要介绍了java多线程之停止线程的方法实例代码详解,非常不错,具有一定的参考借鉴价值,需要的朋友可以参考下
    2019-05-05
  • SpringBoot中的定时任务和异步调用详解

    SpringBoot中的定时任务和异步调用详解

    这篇文章主要介绍了SpringBoot中的定时任务和异步调用详解,SpringBoot 定时任务是一种在SpringBoot应用中自动执行任务的机制,通过使用Spring框架提供的@Scheduled注解,我们可以轻松地创建定时任务,需要的朋友可以参考下
    2023-10-10
  • Springboot整合spring-boot-starter-data-elasticsearch的过程

    Springboot整合spring-boot-starter-data-elasticsearch的过程

    本文详细介绍了Springboot整合spring-boot-starter-data-elasticsearch的过程,包括版本要求、依赖添加、实体类添加、索引的名称、分片、副本设置等,同时,还介绍了如何使用ElasticsearchRepository类进行增删改查操作
    2024-10-10
  • springboot如何根据不同的日志级别显示不同的颜色

    springboot如何根据不同的日志级别显示不同的颜色

    这篇文章主要介绍了springboot如何根据不同的日志级别显示不同的颜色问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2023-08-08
  • Nacos注册中心的部署与用法示例详解

    Nacos注册中心的部署与用法示例详解

    注册中心是微服务架构中的纽带,类似于“通讯录”,它记录了服务和服务地址的映射关系,本文通过示例代码给大家介绍Nacos注册中心的部署与用法,感兴趣的朋友跟随小编一起看看吧
    2022-02-02
  • 10种java数组合并的常用方法总结

    10种java数组合并的常用方法总结

    在Java中,合并(或连接)数组是常见的任务,这篇文章主要为大家整理了10个java中常用的数组合并方法,文中的示例代码简洁易懂,需要的小伙伴可以参考下
    2023-12-12
  • 解决SpringBoot中MultipartResolver和ServletFileUpload的冲突问题

    解决SpringBoot中MultipartResolver和ServletFileUpload的冲突问题

    这篇文章主要介绍了解决SpringBoot中MultipartResolver和ServletFileUpload的冲突问题,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-10-10
  • Maven 本地仓库替代私仓配置指南

    Maven 本地仓库替代私仓配置指南

    本文主要介绍了Maven 本地仓库替代私仓配置指南,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2026-04-04

最新评论