Java【付诸实践 01】使用org.apache.ibatis.plugin.Interceptor拦截器实现全局mapper.xml参数注入(可用于切换数据库实例schema)源码实例分享

简介: Java【付诸实践 01】使用org.apache.ibatis.plugin.Interceptor拦截器实现全局mapper.xml参数注入(可用于切换数据库实例schema)源码实例分享

1. why

项目没有使用MyBatis,进行数据操作时使用的是jdbc中默认的schema,现在项目要加入多租户,同一个数据库下不同租户使用不同的实例schema,这就要在mapper文件内所有的表名称前加上schema,并动态传递其参数值,这样每个SQL都要添加这个参数,如果传递的是对象,也要给对象加相应的属性,这个工作量可想而知。必须想办法,将schema参数传递给所有的SQL,办法就是全局配置。

2. code

2.1 实现拦截器接口并重写方法

拦截器【 1️⃣ SchemaInterceptor】实现(如果用户调用的SQL接口里没有传 schemaName 就用默认值):

@Intercepts({
        @Signature(method = "update",
                args = {MappedStatement.class, Object.class}, type = Executor.class),
        @Signature(method = "query",
                args = {MappedStatement.class, Object.class, RowBounds.class, ResultHandler.class}, type = Executor.class)
})
public class SchemaInterceptor implements Interceptor {
    /**
     * 这里没有打印日志
     */
    private static Log LOG = LogFactory.getLog(SchemaInterceptor.class);
    /**
     * mapper.xml 使用SCHEMA时的参数名称
     */
    private static final String SCHEMA = "schemaName";
    /**
     * 设置默认的schema
     */
    private String schema = "public";
    /**
     * 拦截到的动态SQL处理后放入此对象
     */
    private Set<Integer> sourceStorage = new HashSet<>();
    @Override
    public Object intercept(Invocation invocation) throws Throwable {
        Object[] args = invocation.getArgs();
        MappedStatement mappedStatement = (MappedStatement) args[0];
        SqlSource sqlSource = mappedStatement.getSqlSource();
        // 只拦截动态SQL
        if (sqlSource instanceof DynamicSqlSource) {
            // 获取到sqlNode对象
            Field field = DynamicSqlSource.class.getDeclaredField("rootSqlNode");
            field.setAccessible(true);
            SqlNode sqlNode = (SqlNode) field.get(sqlSource);
            if (!sourceStorage.contains(sqlSource.hashCode())) {
                // 获取动态代理对象
                Map<String, Object> argMap = (HashMap<String, Object>) args[1];
                // 判断是否传递 schemaName或schema 如果已经传递则使用用户传递的值 否则使用默认值
                String schemaNameStr = "schemaName", schemaStr = "schema";
                if (StringUtils.isEmpty(MapUtils.getString(argMap, schemaNameStr)) && StringUtils.isEmpty(MapUtils.getString(argMap, schemaStr))) {
                    SqlNode proxyNode = proxyNode(sqlNode);
                    field.set(sqlSource, proxyNode);
                }
                sourceStorage.add(sqlSource.hashCode());
            }
        }
        return invocation.proceed();
    }
    /**
     * 通过动态代理对象 添加schema参数
     *
     * @param sqlNode SQL节点
     * @return SqlNode
     */
    private SqlNode proxyNode(SqlNode sqlNode) {
        return (SqlNode) Proxy.newProxyInstance(sqlNode.getClass().getClassLoader(),
                new Class[]{SqlNode.class}, new SqlNodeInvocationHandler(sqlNode));
    }
    @Override
    public Object plugin(Object target) {
        return Plugin.wrap(target, this);
    }
    @Override
    public void setProperties(Properties properties) {
        LOG.debug("setProperties====>" + properties);
    }
    private class SqlNodeInvocationHandler implements InvocationHandler {
        private SqlNode target;
        SqlNodeInvocationHandler(SqlNode target) {
            super();
            this.target = target;
        }
        @Override
        public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
            DynamicContext context = (DynamicContext) args[0];
            // 给schema添加.
            setSchema(schema);
            // 设置schema
            context.getBindings().put(SCHEMA, schema);
            return method.invoke(target, args);
        }
    }
    /**
     * 给schema 添加.
     *
     * @param schema schemaName
     */
    private void setSchema(String schema) {
        String pointStr = ".";
        if (StringUtils.isNotBlank(schema)) {
            if (!schema.endsWith(pointStr)) {
                schema += pointStr;
            }
        }
        this.schema = schema;
    }
}

2.2 拦截器注册

拦截器【 2️⃣ 注册】给 SqlSessionFactoryBean 添加插件:

@Bean(name = "sqlSessionFactory_greenplum")
    @Primary
    public SqlSessionFactory sqlSessionFactory(@Qualifier("dataSource_greenplum") DataSource dataSource)
            throws Exception {
        final SqlSessionFactoryBean sessionFactory = new SqlSessionFactoryBean();
        // 设置数据源参数
        sessionFactory.setDataSource(dataSource);
        // mapper路径和mybatis配置文件路径
        sessionFactory.setMapperLocations(new PathMatchingResourcePatternResolver()
                .getResources(GreenplumConfiguration.MAPPER_LOCATION));
        sessionFactory.setConfigLocation(new ClassPathResource(mybatisConfigPath));
        // 添加自定义的schema拦截器【此次配置的重点】
        sessionFactory.setPlugins(new Interceptor[]{new SchemaInterceptor()});
        return sessionFactory.getObject();
    }

2.3 拦截器注入参数使用

注入【 3️⃣ mapper.xml】这里使用 ${schemaName} 获取配置的 schema 的值:

<!--执行插入文件数据SQL-->
<insert id="insertFileData" parameterType="map">
  insert into ${schemaName}${target_table}( ${table_field} ) VALUES ( ${field_value} )
</insert>

3. 总结

首先要注意的是,这里用的不是SpringMVC里的拦截器,而是mybatis的拦截器,拦截器是在执行mapper文件内的SQL前触发的,此时,如果你传递了schema参数,拦截器就不会覆盖schema的值,如果没有配置,则使用配置的默认值。

目录
相关文章
|
10月前
|
SQL 人工智能 数据挖掘
Apache Doris 4.0 AI 能力揭秘(二):为企业级应用而生的 AI 函数设计与实践
Apache Doris 4.0 原生集成 LLM 函数,将大语言模型能力深度融入 SQL 引擎,实现文本处理智能化与数据分析一体化。通过十大函数,支持智能客服、内容分析、金融风控等场景,提升实时决策效率。采用资源池化管理,保障数据一致性,降低传输开销,毫秒级完成 AI 分析。结合缓存复用、并行执行与权限控制,兼顾性能、成本与安全,推动数据库向 AI 原生演进。
1025 0
Apache Doris 4.0 AI 能力揭秘(二):为企业级应用而生的 AI 函数设计与实践
|
11月前
|
SQL 存储 运维
Apache Doris 在菜鸟的大规模湖仓业务场景落地实践
本文介绍了 Apache Doris 在菜鸟的大规模落地的实践经验,菜鸟为什么选择 Doris,以及 Doris 如何在菜鸟从 0 开始,一步步的验证、落地,到如今上万核的规模,服务于各个业务线,Doris 已然成为菜鸟 OLAP 数据分析的最优选型。
646 2
Apache Doris 在菜鸟的大规模湖仓业务场景落地实践
|
安全 Apache 数据库
【倒计时3天】NineData x Apache Doris x 阿里云联合举办数据库技术Meetup,5月24日深圳见!
5月24日,NineData联合Apache Doris与阿里云在深圳举办数据库技术Meetup。活动聚焦「数据实时分析」与「数据同步迁移」两大领域,邀请行业专家分享技术趋势、产品实践及解决方案,助力企业构建高效安全的数据管理体系。时间:14:00-17:30;地点:深圳新一代产业园2栋20楼会议室。线下名额有限(80人),速报名参与深度交流!
368 1
java中一个接口A,以及一个实现它的类B,一个A类型的引用对象作为一个方法的参数,这个参数的类型可以是B的类型吗?
本文探讨了面向对象编程中接口与实现类的关系,以及里氏替换原则(LSP)的应用。通过示例代码展示了如何利用多态性将实现类的对象传递给接口类型的参数,满足LSP的要求。LSP确保子类能无缝替换父类或接口,不改变程序行为。接口定义了行为规范,实现类遵循此规范,从而保证了多态性和代码的可维护性。总结来说,接口与实现类的关系天然符合LSP,体现了多态性的核心思想。
798 0
|
Java Linux 定位技术
Minecraft配置文件参数说明(JAVA服务器篇)
Minecraft JAVA版服务器启动后会生成server.properties配置文件,位于minecraft_server/根目录下。该文件包含多项关键设置,如游戏模式(gamemode)、最大玩家数(max-players)、难度(difficulty)等。此文档详细说明了各配置项的功能与默认值,帮助用户高效管理服务器环境。
4392 62
|
存储 安全 数据挖掘
天翼云:Apache Doris + Iceberg 超大规模湖仓一体实践
天翼云基于 Apache Doris 成功落地项目已超 20 个,整体集群规模超 50 套,部署节点超 3000 个,存储容量超 15PB
1127 2
天翼云:Apache Doris + Iceberg 超大规模湖仓一体实践
|
数据库
【YashanDB知识库】yac修改参数后关闭数据库hang住
【标题】YashanDB yac修改参数后关闭数据库hang住 【简介】修改yac参数后执行`shutdown immediate`时,数据库hang住。原因是Shutdown操作中线程卡在获取信号量,jobManagerStop()和checkRedoFreeSpace()接口导致死循环,且SHM_POOL_SIZE过小影响redo日志使用。需检查配置文件并调整SHM_POOL_SIZE参数。影响范围为23.1 - 23.1.1.200版本。 【关键词】YashanDB, yac, shutdown hang 【修复版本】待定
|
数据库
【YashanDB知识库】YAC修改参数后关闭数据库夯住
【YashanDB知识库】YAC修改参数后关闭数据库夯住
|
数据库连接 PHP 数据库
【YashanDB知识库】PHP使用ODBC使用数据库绑定参数功能异常
【YashanDB知识库】PHP使用ODBC使用数据库绑定参数功能异常
|
PHP 数据库
【YashanDB知识库】PHP使用OCI接口使用数据库绑定参数功能异常
【YashanDB知识库】PHP使用OCI接口使用数据库绑定参数功能异常

推荐镜像

更多