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的值,如果没有配置,则使用配置的默认值。

目录
相关文章
|
7天前
|
XML Java 数据库连接
性能提升秘籍:如何高效使用Java连接池管理数据库连接
在Java应用中,数据库连接管理至关重要。随着访问量增加,频繁创建和关闭连接会影响性能。为此,Java连接池技术应运而生,如HikariCP。本文通过代码示例介绍如何引入HikariCP依赖、配置连接池参数及使用连接池高效管理数据库连接,提升系统性能。
30 5
|
10天前
|
关系型数据库 MySQL Linux
Linux环境下MySQL数据库自动定时备份实践
数据库备份是确保数据安全的重要措施。在Linux环境下,实现MySQL数据库的自动定时备份可以通过多种方式完成。本文将介绍如何使用`cron`定时任务和`mysqldump`工具来实现MySQL数据库的每日自动备份。
28 3
|
19天前
|
SQL Java 数据库连接
在Java应用中,数据库访问常成为性能瓶颈。连接池技术通过预建立并复用数据库连接,有效减少连接开销,提升访问效率
在Java应用中,数据库访问常成为性能瓶颈。连接池技术通过预建立并复用数据库连接,有效减少连接开销,提升访问效率。本文介绍了连接池的工作原理、优势及实现方法,并提供了HikariCP的示例代码。
32 3
|
19天前
|
存储 Java 关系型数据库
在Java开发中,数据库连接是应用与数据交互的关键环节。本文通过案例分析,深入探讨Java连接池的原理与最佳实践
在Java开发中,数据库连接是应用与数据交互的关键环节。本文通过案例分析,深入探讨Java连接池的原理与最佳实践,包括连接创建、分配、复用和释放等操作,并通过电商应用实例展示了如何选择合适的连接池库(如HikariCP)和配置参数,实现高效、稳定的数据库连接管理。
36 2
|
19天前
|
Java 数据库连接 数据库
如何构建高效稳定的Java数据库连接池,涵盖连接池配置、并发控制和异常处理等方面
本文介绍了如何构建高效稳定的Java数据库连接池,涵盖连接池配置、并发控制和异常处理等方面。通过合理配置初始连接数、最大连接数和空闲连接超时时间,确保系统性能和稳定性。文章还探讨了同步阻塞、异步回调和信号量等并发控制策略,并提供了异常处理的最佳实践。最后,给出了一个简单的连接池示例代码,并推荐使用成熟的连接池框架(如HikariCP、C3P0)以简化开发。
39 2
|
19天前
|
Java 数据库连接 数据库
深入探讨Java连接池技术如何通过复用数据库连接、减少连接建立和断开的开销,从而显著提升系统性能
在Java应用开发中,数据库操作常成为性能瓶颈。本文通过问题解答形式,深入探讨Java连接池技术如何通过复用数据库连接、减少连接建立和断开的开销,从而显著提升系统性能。文章介绍了连接池的优势、选择和使用方法,以及优化配置的技巧。
17 1
|
19天前
|
Java 数据库连接 数据库
Java连接池在数据库性能优化中的重要作用。连接池通过预先创建和管理数据库连接,避免了频繁创建和关闭连接的开销
本文深入探讨了Java连接池在数据库性能优化中的重要作用。连接池通过预先创建和管理数据库连接,避免了频繁创建和关闭连接的开销,显著提升了系统的响应速度和吞吐量。文章介绍了连接池的工作原理,并以HikariCP为例,展示了如何在Java应用中使用连接池。通过合理配置和优化,连接池技术能够有效提升应用性能。
33 1
|
19天前
|
监控 Java 数据库连接
在Java开发中,数据库连接管理是关键问题之一
在Java开发中,数据库连接管理是关键问题之一。本文介绍了连接池技术如何通过预创建和管理数据库连接,提高数据库操作的性能和稳定性,减少资源消耗,并简化连接管理。通过示例代码展示了HikariCP连接池的实际应用。
18 1
|
9天前
|
SQL 关系型数据库 MySQL
12 PHP配置数据库MySQL
路老师分享了PHP操作MySQL数据库的方法,包括安装并连接MySQL服务器、选择数据库、执行SQL语句(如插入、更新、删除和查询),以及将结果集返回到数组。通过具体示例代码,详细介绍了每一步的操作流程,帮助读者快速入门PHP与MySQL的交互。
24 1
|
11天前
|
SQL 关系型数据库 MySQL
go语言数据库中mysql驱动安装
【11月更文挑战第2天】
26 4

推荐镜像

更多