Mybatis 适配多数据源 关键字查询问题

已于 2024-07-29 14:24:02 修改
阅读量886 收藏 10
点赞数 23
文章标签： mybatis java 数据库
于 2024-07-29 11:59:31 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/jin121380/article/details/140767684
版权

Mybatis 适配多数据源 关键字查询问题

前言

最近项目使用Mybatis拦截器对国产化数据源数据进行关键字处理，以下记录如何将拦截器集成到项目中以及在使用过程中踩过的一些小坑

1.Myabtis拦截器是什么？

MyBatis允许使用者在映射语句执行过程中的某一些指定的节点进行拦截调用，通过织入拦截器，在不同节点修改一些执行过程中的关键属性，从而影响SQL的生成、执行和返回结果，如：来影响Mapper.xml到SQL语句的生成、执行SQL前对预编译的SQL执行参数的修改、SQL执行后返回结果到Mapper接口方法返参POJO对象的类型转换和封装等。

2，Mybatis核心对象

从MyBatis代码实现的角度来看，MyBatis的主要的核心部件有以下几个：

Configuration：初始化基础配置，比如MyBatis的别名等，一些重要的类型对象，如插件，映射器，ObjectFactory和typeHandler对象，MyBatis所有的配置信息都维持在Configuration对象之中。
SqlSessionFactory：SqlSession工厂。
SqlSession：作为MyBatis工作的主要顶层API，表示和数据库交互的会话，完成必要的数据库增删改查功能。
Executor：MyBatis的内部执行器，它负责调用StatementHandler操作数据库，并把结果集通过ResultSetHandler进行自动映射，另外，它还处理二级缓存的操作。
StatementHandler：MyBatis直接在数据库执行SQL脚本的对象。另外它也实现了MyBatis的一级缓存。
ParameterHandler：负责将用户传递的参数转换成JDBC Statement所需要的参数。是MyBatis实现SQL入参设置的对象。
ResultSetHandler：负责将JDBC返回的ResultSet结果集对象转换成List类型的集合。是MyBatis把ResultSet集合映射成POJO的接口对象。
TypeHandler：负责Java数据类型和JDBC数据类型之间的映射和转换。
MappedStatement：MappedStatement维护了一条<select|update|delete|insert>节点的封装。
SqlSource ：负责根据用户传递的parameterObject，动态地生成SQL语句，将信息封装到BoundSql对象中，并返回。
BoundSql：表示动态生成的SQL语句以及相应的参数信息。

3，如何使用
3.1 首先介绍一下mybatis拦截器拦截的类型

在这里插入图片描述

自定义拦截器必须使用@Intercepts注解，并实现Interceptor接口

@Intercepts注解：代表该类是一个拦截器

@Signature注解：表示要拦截哪一个方法

同时@Signature注解有三个参数

type：MyBatis拦截器默认可以拦截的类型只有四种，即四种接口类型Executor、StatementHandler、ParameterHandler和ResultSetHandler，type可以选取四种类型中的一个
method：对应接口中的方法，比图Executor的query方法
args：对应某个接口方法中的参数
3.2 代码示例

代码中使用的mybatis-plus的版本

            <dependency>
                <groupId>com.baomidou</groupId>
                <artifactId>mybatis-plus-boot-starter</artifactId>
                <version>3.4.3</version>
            </dependency>

拦截器类

@Component
@Intercepts({@Signature(method = "query", type = Executor.class, args = {MappedStatement.class, Object.class, RowBounds.class, ResultHandler.class}),
        @Signature(
                type = Executor.class,
                method = "update",
                args = {MappedStatement.class, Object.class}
        )})
public class KeywordInterceptor implements Interceptor {


    public DataSourceProperties getDataSourceProperties() {
        return SpringContextUtil.getBean(DataSourceProperties.class);
    }

    private static final Logger logger = LoggerFactory.getLogger(KeywordInterceptor.class);
    public static final String DATABASE_TYPE_DM = "dm";

    public static final String DATABASE_TYPE_KINGBASE = "kingbase";

    public static final String DATABASE_TYPE_GBASE = "gbase";

    @Override
    public Object intercept(Invocation invocation) throws Throwable {
        logger.info("Intercepted target class: {}", invocation.getTarget().getClass().getName());
        if (invocation.getTarget() instanceof Executor) {
            MappedStatement mappedStatement = (MappedStatement) invocation.getArgs()[0];
            Object parameter = invocation.getArgs()[1];
            BoundSql boundSql = mappedStatement.getBoundSql(parameter);
            String originalSql = boundSql.getSql();
            System.out.println("Original SQL: " + originalSql);
            if (containsKeyword(originalSql, "关键字") || containsKeyword(originalSql, "关键字")) {
                String databaseId = mappedStatement.getDatabaseId();
                String currentDataSourceType;
                if (StringUtils.isNotEmpty(databaseId)) {
                    currentDataSourceType = getCurrentDataSourceType(databaseId);
                } else {
                    DataSourceProperties dataSourceProperties = getDataSourceProperties();
                    String driverClassName = dataSourceProperties.getDriverClassName();
                    currentDataSourceType = getCurrentDataSourceType(driverClassName);
                }
                SqlCommandType sqlCommandType = mappedStatement.getSqlCommandType();
                String modifiedSql = modifySqlForDataSource(originalSql, currentDataSourceType, sqlCommandType);
                logger.info("Modified SQL: {}", modifiedSql);
                // 修改 SQL 语句（注意，这里是简化示例，实际情况可能需要更多处理）
                BoundSql newBoundSql = new BoundSql(mappedStatement.getConfiguration(), modifiedSql, boundSql.getParameterMappings(), boundSql.getParameterObject());
                // 复制其他字段
                copyBoundSqlFields(boundSql, newBoundSql);
                // 创建新的 MappedStatement 对象
                MappedStatement newMappedStatement = newMappedStatement(mappedStatement, new BoundSqlSqlSource(newBoundSql));
                // 替换原始的 MappedStatement 对象
                invocation.getArgs()[0] = newMappedStatement;

                return invocation.proceed();
            } else {
                return invocation.proceed();
            }
            
        } else {
            return invocation.proceed();
        }
    }

    private void copyBoundSqlFields(BoundSql source, BoundSql target) throws IllegalAccessException {
        Field[] fields = BoundSql.class.getDeclaredFields();
        for (Field field : fields) {
            if (!field.getName().equals("sql")) {
                field.setAccessible(true);
                field.set(target, field.get(source));
            }
        }
    }


    private boolean containsKeyword(String sql, String keyword) {
        // 使用正则表达式检查 SQL 中是否包含关键字
        Matcher matcher = Pattern.compile("\\b" + keyword + "\\b", Pattern.CASE_INSENSITIVE).matcher(sql);
        return matcher.find();
    }


    private MappedStatement newMappedStatement(MappedStatement ms, SqlSource newSqlSource) {
        MappedStatement.Builder builder = new MappedStatement.Builder(ms.getConfiguration(), ms.getId(), newSqlSource, ms.getSqlCommandType());
        builder.resource(ms.getResource());
        builder.fetchSize(ms.getFetchSize());
        builder.statementType(ms.getStatementType());
        builder.keyGenerator(ms.getKeyGenerator());
        if (null != ms.getKeyProperties()) {
            builder.keyProperty(String.join(",", ms.getKeyProperties()));
        }
        builder.timeout(ms.getTimeout());
        builder.parameterMap(ms.getParameterMap());
        builder.resultMaps(ms.getResultMaps());
        builder.resultSetType(ms.getResultSetType());
        builder.cache(ms.getCache());
        builder.flushCacheRequired(ms.isFlushCacheRequired());
        builder.useCache(ms.isUseCache());
        return builder.build();
    }

    private static class BoundSqlSqlSource implements SqlSource {
        private BoundSql boundSql;

        public BoundSqlSqlSource(BoundSql boundSql) {
            this.boundSql = boundSql;
        }

        @Override
        public BoundSql getBoundSql(Object parameterObject) {
            return boundSql;
        }
    }

    private String getCurrentDataSourceType(String driverClassName) {
        if (StringUtils.contains(driverClassName, DATABASE_TYPE_KINGBASE)) {
            return DbType.KINGBASE_ES.getDb();
        } else if (StringUtils.contains(driverClassName, DATABASE_TYPE_DM)) {
            return DbType.DM.getDb();
        } else if (StringUtils.contains(driverClassName, DATABASE_TYPE_GBASE)) {
            return DbType.GBASE.getDb();
        } else {
            return DbType.MYSQL.getDb();
        }
    }

    private String modifySqlForDataSource(String sql, String dataSourceType, SqlCommandType sqlCommandType){
        if ("mysql".equalsIgnoreCase(dataSourceType)) {
            return sql.replaceAll("\\b关键字\\b", "`关键字`");
        } else {
            if ("kingbasees".equalsIgnoreCase(dataSourceType)) {
                return sql.replaceAll("\\b关键字\\b", "\"关键字\"");
            } else {
                if ("dm".equals(dataSourceType)) {
                    return sql.replaceAll("\\b关键字\\b", "\"关键字大写\"");
                } else {
                    return sql.replaceAll("\\b关键字\\b", "\"关键字\"");
                }
            }
        }
    }

    @Override
    public Object plugin(Object target) {
        return Plugin.wrap(target, this);
    }

    @Override
    public void setProperties(Properties properties) {
        // 可以通过配置文件传递参数
    }
}

DataProperties类

@Component
@ConfigurationProperties(
        prefix = "spring.datasource"
)
public class DataSourceProperties {
    private String driverClassName;
    private String url;
    private String username;
    private String password;

    // Getters and Setters
    public String getDriverClassName() {
        return driverClassName;
    }

    public void setDriverClassName(String driverClassName) {
        this.driverClassName = driverClassName;
    }
}

Mybatis自动配置类

@Configuration
@EnableAutoConfiguration
@MapperScan(value = "扫的类路径", annotationClass = Mapper.class, sqlSessionFactoryRef = "sqlSessionFactory")
@MapperScan(value = "扫的类路径", annotationClass = Repository.class, sqlSessionFactoryRef = "sqlSessionFactory")
public class DGMybatisAutoConfiguration {

    @Autowired
    private DataSourceProperties dataSourceProperties;

    @Resource
    private MultiTenantHandler multiTenantHandler;

    public static final String DATABASE_TYPE_MYSQL = "mysql";

    public static final String DATABASE_TYPE_DM = "dm";

    public static final String DATABASE_TYPE_KINGBASE = "kingbase";

    public static final String DATABASE_TYPE_GBASE = "gbase";

    @Bean(destroyMethod = "")
    public DruidDataSource dataSource() {

        DruidDataSource druidDataSource = new DruidDataSource();

        druidDataSource.setDriverClassName(dataSourceProperties.getDriverClassName());
        druidDataSource.setUrl(dataSourceProperties.getUrl());
        druidDataSource.setUsername(dataSourceProperties.getUsername());
        druidDataSource.setPassword(dataSourceProperties.getPassword());

        druidDataSource.setPoolPreparedStatements(true);
        druidDataSource.setTestWhileIdle(true);
        druidDataSource.setTestOnBorrow(true);
        druidDataSource.setTestOnReturn(true);
        druidDataSource.setKeepAlive(true);
        druidDataSource.setMinIdle(5);
        druidDataSource.setMaxActive(50);
        druidDataSource.setMaxWait(60000);
        druidDataSource.setMaxPoolPreparedStatementPerConnectionSize(20);
        druidDataSource.setInitialSize(5);
        druidDataSource.setTimeBetweenEvictionRunsMillis(60000);
        druidDataSource.setTimeBetweenConnectErrorMillis(60000);
        druidDataSource.setMinEvictableIdleTimeMillis(300000);
        druidDataSource.setValidationQueryTimeout(3);
        //auto commit
        druidDataSource.setDefaultAutoCommit(true);
        return druidDataSource;
    }

    @Bean
    public MybatisPlusInterceptor mybatisPlusInterceptor() {
        MybatisPlusInterceptor mybatisPlusInterceptor = new MybatisPlusInterceptor();
        mybatisPlusInterceptor.addInnerInterceptor(new TenantLineInnerInterceptor(multiTenantHandler));
        String driverClassName = dataSourceProperties.getDriverClassName();
        // 分页插件
        if (StringUtils.contains(driverClassName, DATABASE_TYPE_GBASE)) {
            mybatisPlusInterceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.GBASE));
        } else if (StringUtils.contains(driverClassName, DATABASE_TYPE_DM)) {
            mybatisPlusInterceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.DM));
        } else if (StringUtils.contains(driverClassName, DATABASE_TYPE_KINGBASE)) {
            mybatisPlusInterceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.KINGBASE_ES));
        } else {
            mybatisPlusInterceptor.addInnerInterceptor(new PaginationInnerInterceptor());
        }
        return mybatisPlusInterceptor;
    }


    @Bean
    public SqlSessionFactory sqlSessionFactory() throws Exception {
        MybatisConfiguration configuration = new MybatisConfiguration();
        configuration.setLogImpl(org.apache.ibatis.logging.stdout.StdOutImpl.class);
        configuration.setMapUnderscoreToCamelCase(true);
        configuration.setCacheEnabled(false);
        configuration.setCallSettersOnNulls(true);
        configuration.setJdbcTypeForNull(JdbcType.NULL);
        configuration.addInterceptor(mybatisPlusInterceptor());
        MybatisSqlSessionFactoryBean sqlSessionFactoryBean = new MybatisSqlSessionFactoryBean();
        sqlSessionFactoryBean.setConfiguration(configuration);
        sqlSessionFactoryBean.setDataSource(dataSource());

        GlobalConfig.DbConfig dbConfig = new GlobalConfig.DbConfig();
        dbConfig.setIdType(IdType.AUTO);
        GlobalConfig globalConfig = new GlobalConfig();
        globalConfig.setDbConfig(dbConfig);
        sqlSessionFactoryBean.setPlugins(new KeywordInterceptor());
        return sqlSessionFactoryBean.getObject();
    }
}
4. 总结

当然也可以使用Mybatis拦截器来做其他事情，比如数据加密脱敏，sql监控报警等功能，这也会额外产生一些性能开销，合理利用拦截器将会大大缩减开发成本。

黯销凝
关注
使用MyBatis-Plus 3.x处理数据库关键字，轻松解决SQL语句冲突问题！
奇妙的Bug之旅
01-04 1330
在本文中，我们介绍了MyBatis-Plus 3.x如何处理数据库关键字的方法。通过给关键字加上反引号，可以避免与SQL语句产生冲突。我们给出了一个完整的实例，展示了MyBatis-Plus 3.x处理数据库关键字的具体步骤。希望本文对你理解MyBatis-Plus 3.x的数据库关键字处理有所帮助。
Mybatis中利用动态SQL对数据库进行优化和安全检查
AI天才研究院
07-29 1928
MyBatis 是一款优秀的持久层框架，它支持自定义 SQL、存储过程以及高级映射。但是 MyBatis 也存在着不少性能和安全方面的问题。Mybatis 本身功能强大且易用，但同时也可能给系统带来很多隐患和风险。为了更好地保障系统的安全性和运行效率，本篇文章将结合 Mybatis 的一些特性，通过动态 SQL 对数据库进行优化和安全检查的方法进行探讨。什么是动态 SQL？
基于MybatisPlus拦截器实现数据库关键字处理及官方做法
qq_42059717的博客
04-23 1169
有些老的数据库当中可能会有些字段和数据库关键字冲突，使用mybatisPlus执行Sql的时候有时候会执行失败，前段时间和群友讨论的时候他说遇到了这个问题，当时我提议让他用我以前写的一个里边的工具类改造一下。他说不能实现，然后找到了官方的配置信息，也就是添加最下边的那个。
mybatis-plus 表字段存在关键字的处理办法
hacker_Lees的博客
04-03 2334
当数据库表中字段出现关键字时，若不做其他处理，mybatis-plus的BaseMapper并不会做其他的处理，最终导致SQL执行时，抛出SQL 语法错误。应用mybatis-plus提供的注解–TableField，就可以很方便的解决此问题。注意：需要在value值里，特别的加上字段’'号。
mybatis之关键字foreach
黑呆呆
10-22 412
中文官方文档 权威的文档当然要看官方的文档说明 上面有一些面试题还有mybatis的各种问题mybatis源码系列 1、场景：循环ArrayList查询对象 2、用法：要判断size>0,collection="传的对象名" ，item="随便一个名称，和#{}一致" <if test="ids != null and ids.size > 0"> AN...
sqlserver 时间段 和 关键字 查询 Mybatis
u011216911的专栏
09-20 2805
where if test="pd.startDate!=null and pd.startDate!='' and pd.endDate!=null and pd.endDate!=''"> a.CREATE_DATE between #{pd.startDate} AND #{pd.endDate} AND if> 1=1 if test="pd.fiel
记一次项目oracle兼容mysql改造基于mybatis
雷X峰
07-25 1717
主要涉及 1. Oracle数据库迁移至MySQL 2. MySQL新增函数兼容程序 3. 程序通用函数的改造 4. 针对序列的处理 5.针对MySQL需要写单独语句的处理
MyBatis中SQL注入攻击和防护——掌握技巧保护应用安全
AI天才研究院
07-28 1241
随着互联网信息化、云计算等技术的发展，网站业务越来越多样化、个性化，对用户输入数据的安全性要求也越来越高。在WEB开发中，常用的一种方式是用SQL作为后台语言，通过ORM工具将数据存储到数据库中并进行相关查询。由于ORM框架本身的特点，容易受到SQL注入攻击。SQL注入（英语：SQL injection）指的是通过向服务器端发送非法的SQL命令，而不是使用有效的查询条件而访问数据库，最终获取不正确的数据。
五、金仓数据库适配记录
空空说技术的博客
05-17 940
人大金仓数据库管理系统KingbaseES（简称：金仓数据库或KingbaseES）是北京人大金仓信息技术股份有限公司自主研制开发的具有自主知识产权的通用关系型数据库管理系统。金仓数据库主要面向事务处理类应用，兼顾各类数据分析类应用，可用做管理信息系统、业务及生产系统、决策支持系统、多维数据分析、全文检索、地理信息系统、图片搜索等的承载数据库。
MyBatis研习录(11)——MyBatis动态SQL
谷哥的小弟
11-27 646
动态SQL是MyBatis 的强大特性，利用动态SQL可以极大的优化SQL语句的编写及其处理。
SpringBoot + Mybatis实现关键字模糊查询
weixin_45390651的博客
09-06 2488
先写一个REST端点——Controller Class: controller/TestController.class package controller; @GetMapping("/search") public List<UserInfo> search(String keyword) { return userInfoService.searchByKeyWord(keyword); } 写业务接口——sevice Class：service/Userinf.
处理Mybatis-plus多数据源不同关键字的兼容问题
最新发布
qq_36912762的博客
04-30 416
最近项目要适配国产化数据库，之前的基于其他种类创建的字段，在国产数据库中如果是关键字会查询报错。（比如达梦数据库中的 comment = =！分享一下在网上查了多种方式，以及最后自己的实现方式。与君共勉，欢迎指正。（菜鸟一枚，大神轻喷。1. 直接修改 @TableField2. 修改 mapper.xml</select>上两种方法是百度搜到的方法，结合项目的情况觉得两种都不适合，因为有可能还要适配别的数据库，主要也懒得排着改 0.03. 最后自己的实现方法。
MyBatis使用or关键字进行数据查询
weixin_34303897的博客
10-22 2642
为什么80%的码农都做不了架构师？>>> ...
mybatis当遇到，用mysql关键字作为的字段的表，如何处理
weixin_30536513的博客
12-16 2294
首先，坑比同事用from，to，day，关键字作为表的字段。 然后今天我在用ibatis的封装的方法，发现报错了，百思不得其解。 最后在自己用mysql的语句试的时候才发现这样啊。 UPDATE load_discharg_item SET load_discharg_id = "1231231231231", description = "12312312", ...
MyBatis、MyBatisPlus转义数据库关键字
QC班长的博客
08-14 5590
需求说明：有的数据库表在设计的时候，表的字段名和数据库的关键字重复了，查询时需要做转义处理。用的是Mybatis-plus自带的方法，需要修改实体类，MySQL解决办法需要给表关键字加反引号。来转义，SQL Server使用。SQLServer是加[]...
MyBatis基本工作原理+核心流程介绍+常用注解+常用关键字(详解)+实现动态SQL的数据修改
m0_71202849的博客
09-09 1281
1.原理:先封装SQL，接着调用JDBC操作数据库，最后把数据库返回的表结果封装成Java类。 2.MyBatis[]简写步骤] 3.四大核心 4.MyBatis常用注解+常用关键字 5.实现动态SQL的修改数据
mybatis自动识别数据库关键字
明明如月的技术博客
05-04 6478
最近在做一个项目的，采用MyBatis Generator生成mapper文件。进行单元测试时提示语法错误。 发现调试信息输出的解析语句中有如：key,value等关键字。 查阅mybatis generator的官方文档，我们发现如下信息： http://www.mybatis.org/generator/configreference/context.html autoDel...
MyBatis 数据查询语句中有关于大于，小于的书写方法 及 查询时相关sql 关键字
YHLSunshine的博客
02-03 1039
MyBatis 数据查询语句中有关于大于，小于的书写方法 及 查询时相关sql 关键字
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值