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

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注解有三个参数

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

复制代码

3.2 代码示例

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

1.             <dependency>
2.                 <groupId>com.baomidou</groupId>
3.                 <artifactId>mybatis-plus-boot-starter</artifactId>
4.                 <version>3.4.3</version>
5.             </dependency>

复制代码

拦截器类

1. @Component
2. @Intercepts({@Signature(method = "query", type = Executor.class, args = {MappedStatement.class, Object.class, RowBounds.class, ResultHandler.class}),
3.         @Signature(
4.                 type = Executor.class,
5.                 method = "update",
6.                 args = {MappedStatement.class, Object.class}
7.         )})
8. public class KeywordInterceptor implements Interceptor {
11.     public DataSourceProperties getDataSourceProperties() {
12.         return SpringContextUtil.getBean(DataSourceProperties.class);
13.     }
15.     private static final Logger logger = LoggerFactory.getLogger(KeywordInterceptor.class);
16.     public static final String DATABASE_TYPE_DM = "dm";
18.     public static final String DATABASE_TYPE_KINGBASE = "kingbase";
20.     public static final String DATABASE_TYPE_GBASE = "gbase";
22.     @Override
23.     public Object intercept(Invocation invocation) throws Throwable {
24.         logger.info("Intercepted target class: {}", invocation.getTarget().getClass().getName());
25.         if (invocation.getTarget() instanceof Executor) {
26.             MappedStatement mappedStatement = (MappedStatement) invocation.getArgs()[0];
27.             Object parameter = invocation.getArgs()[1];
28.             BoundSql boundSql = mappedStatement.getBoundSql(parameter);
29.             String originalSql = boundSql.getSql();
30.             System.out.println("Original SQL: " + originalSql);
31.             if (containsKeyword(originalSql, "关键字") || containsKeyword(originalSql, "关键字")) {
32.                 String databaseId = mappedStatement.getDatabaseId();
33.                 String currentDataSourceType;
34.                 if (StringUtils.isNotEmpty(databaseId)) {
35.                     currentDataSourceType = getCurrentDataSourceType(databaseId);
36.                 } else {
37.                     DataSourceProperties dataSourceProperties = getDataSourceProperties();
38.                     String driverClassName = dataSourceProperties.getDriverClassName();
39.                     currentDataSourceType = getCurrentDataSourceType(driverClassName);
40.                 }
41.                 SqlCommandType sqlCommandType = mappedStatement.getSqlCommandType();
42.                 String modifiedSql = modifySqlForDataSource(originalSql, currentDataSourceType, sqlCommandType);
43.                 logger.info("Modified SQL: {}", modifiedSql);
44.                 // 修改 SQL 语句（注意，这里是简化示例，实际情况可能需要更多处理）
45.                 BoundSql newBoundSql = new BoundSql(mappedStatement.getConfiguration(), modifiedSql, boundSql.getParameterMappings(), boundSql.getParameterObject());
46.                 // 复制其他字段
47.                 copyBoundSqlFields(boundSql, newBoundSql);
48.                 // 创建新的 MappedStatement 对象
49.                 MappedStatement newMappedStatement = newMappedStatement(mappedStatement, new BoundSqlSqlSource(newBoundSql));
50.                 // 替换原始的 MappedStatement 对象
51.                 invocation.getArgs()[0] = newMappedStatement;
53.                 return invocation.proceed();
54.             } else {
55.                 return invocation.proceed();
56.             }
57.             
58.         } else {
59.             return invocation.proceed();
60.         }
61.     }
63.     private void copyBoundSqlFields(BoundSql source, BoundSql target) throws IllegalAccessException {
64.         Field[] fields = BoundSql.class.getDeclaredFields();
65.         for (Field field : fields) {
66.             if (!field.getName().equals("sql")) {
67.                 field.setAccessible(true);
68.                 field.set(target, field.get(source));
69.             }
70.         }
71.     }
74.     private boolean containsKeyword(String sql, String keyword) {
75.         // 使用正则表达式检查 SQL 中是否包含关键字
76.         Matcher matcher = Pattern.compile("\\b" + keyword + "\\b", Pattern.CASE_INSENSITIVE).matcher(sql);
77.         return matcher.find();
78.     }
81.     private MappedStatement newMappedStatement(MappedStatement ms, SqlSource newSqlSource) {
82.         MappedStatement.Builder builder = new MappedStatement.Builder(ms.getConfiguration(), ms.getId(), newSqlSource, ms.getSqlCommandType());
83.         builder.resource(ms.getResource());
84.         builder.fetchSize(ms.getFetchSize());
85.         builder.statementType(ms.getStatementType());
86.         builder.keyGenerator(ms.getKeyGenerator());
87.         if (null != ms.getKeyProperties()) {
88.             builder.keyProperty(String.join(",", ms.getKeyProperties()));
89.         }
90.         builder.timeout(ms.getTimeout());
91.         builder.parameterMap(ms.getParameterMap());
92.         builder.resultMaps(ms.getResultMaps());
93.         builder.resultSetType(ms.getResultSetType());
94.         builder.cache(ms.getCache());
95.         builder.flushCacheRequired(ms.isFlushCacheRequired());
96.         builder.useCache(ms.isUseCache());
97.         return builder.build();
98.     }
100.     private static class BoundSqlSqlSource implements SqlSource {
101.         private BoundSql boundSql;
103.         public BoundSqlSqlSource(BoundSql boundSql) {
104.             this.boundSql = boundSql;
105.         }
107.         @Override
108.         public BoundSql getBoundSql(Object parameterObject) {
109.             return boundSql;
110.         }
111.     }
113.     private String getCurrentDataSourceType(String driverClassName) {
114.         if (StringUtils.contains(driverClassName, DATABASE_TYPE_KINGBASE)) {
115.             return DbType.KINGBASE_ES.getDb();
116.         } else if (StringUtils.contains(driverClassName, DATABASE_TYPE_DM)) {
117.             return DbType.DM.getDb();
118.         } else if (StringUtils.contains(driverClassName, DATABASE_TYPE_GBASE)) {
119.             return DbType.GBASE.getDb();
120.         } else {
121.             return DbType.MYSQL.getDb();
122.         }
123.     }
125.     private String modifySqlForDataSource(String sql, String dataSourceType, SqlCommandType sqlCommandType){
126.         if ("mysql".equalsIgnoreCase(dataSourceType)) {
127.             return sql.replaceAll("\\b关键字\\b", "`关键字`");
128.         } else {
129.             if ("kingbasees".equalsIgnoreCase(dataSourceType)) {
130.                 return sql.replaceAll("\\b关键字\\b", ""关键字"");
131.             } else {
132.                 if ("dm".equals(dataSourceType)) {
133.                     return sql.replaceAll("\\b关键字\\b", ""关键字大写"");
134.                 } else {
135.                     return sql.replaceAll("\\b关键字\\b", ""关键字"");
136.                 }
137.             }
138.         }
139.     }
141.     @Override
142.     public Object plugin(Object target) {
143.         return Plugin.wrap(target, this);
144.     }
146.     @Override
147.     public void setProperties(Properties properties) {
148.         // 可以通过配置文件传递参数
149.     }
150. }

复制代码

DataProperties类

1. @Component
2. @ConfigurationProperties(
3.         prefix = "spring.datasource"
4. )
5. public class DataSourceProperties {
6.     private String driverClassName;
7.     private String url;
8.     private String username;
9.     private String password;
11.     // Getters and Setters
12.     public String getDriverClassName() {
13.         return driverClassName;
14.     }
16.     public void setDriverClassName(String driverClassName) {
17.         this.driverClassName = driverClassName;
18.     }
19. }

复制代码

Mybatis自动设置类

1. @Configuration
2. @EnableAutoConfiguration
3. @MapperScan(value = "扫的类路径", annotationClass = Mapper.class, sqlSessionFactoryRef = "sqlSessionFactory")
4. @MapperScan(value = "扫的类路径", annotationClass = Repository.class, sqlSessionFactoryRef = "sqlSessionFactory")
5. public class DGMybatisAutoConfiguration {
7.     @Autowired
8.     private DataSourceProperties dataSourceProperties;
10.     @Resource
11.     private MultiTenantHandler multiTenantHandler;
13.     public static final String DATABASE_TYPE_MYSQL = "mysql";
15.     public static final String DATABASE_TYPE_DM = "dm";
17.     public static final String DATABASE_TYPE_KINGBASE = "kingbase";
19.     public static final String DATABASE_TYPE_GBASE = "gbase";
21.     @Bean(destroyMethod = "")
22.     public DruidDataSource dataSource() {
24.         DruidDataSource druidDataSource = new DruidDataSource();
26.         druidDataSource.setDriverClassName(dataSourceProperties.getDriverClassName());
27.         druidDataSource.setUrl(dataSourceProperties.getUrl());
28.         druidDataSource.setUsername(dataSourceProperties.getUsername());
29.         druidDataSource.setPassword(dataSourceProperties.getPassword());
31.         druidDataSource.setPoolPreparedStatements(true);
32.         druidDataSource.setTestWhileIdle(true);
33.         druidDataSource.setTestOnBorrow(true);
34.         druidDataSource.setTestOnReturn(true);
35.         druidDataSource.setKeepAlive(true);
36.         druidDataSource.setMinIdle(5);
37.         druidDataSource.setMaxActive(50);
38.         druidDataSource.setMaxWait(60000);
39.         druidDataSource.setMaxPoolPreparedStatementPerConnectionSize(20);
40.         druidDataSource.setInitialSize(5);
41.         druidDataSource.setTimeBetweenEvictionRunsMillis(60000);
42.         druidDataSource.setTimeBetweenConnectErrorMillis(60000);
43.         druidDataSource.setMinEvictableIdleTimeMillis(300000);
44.         druidDataSource.setValidationQueryTimeout(3);
45.         //auto commit
46.         druidDataSource.setDefaultAutoCommit(true);
47.         return druidDataSource;
48.     }
50.     @Bean
51.     public MybatisPlusInterceptor mybatisPlusInterceptor() {
52.         MybatisPlusInterceptor mybatisPlusInterceptor = new MybatisPlusInterceptor();
53.         mybatisPlusInterceptor.addInnerInterceptor(new TenantLineInnerInterceptor(multiTenantHandler));
54.         String driverClassName = dataSourceProperties.getDriverClassName();
55.         // 分页插件
56.         if (StringUtils.contains(driverClassName, DATABASE_TYPE_GBASE)) {
57.             mybatisPlusInterceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.GBASE));
58.         } else if (StringUtils.contains(driverClassName, DATABASE_TYPE_DM)) {
59.             mybatisPlusInterceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.DM));
60.         } else if (StringUtils.contains(driverClassName, DATABASE_TYPE_KINGBASE)) {
61.             mybatisPlusInterceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.KINGBASE_ES));
62.         } else {
63.             mybatisPlusInterceptor.addInnerInterceptor(new PaginationInnerInterceptor());
64.         }
65.         return mybatisPlusInterceptor;
66.     }
69.     @Bean
70.     public SqlSessionFactory sqlSessionFactory() throws Exception {
71.         MybatisConfiguration configuration = new MybatisConfiguration();
72.         configuration.setLogImpl(org.apache.ibatis.logging.stdout.StdOutImpl.class);
73.         configuration.setMapUnderscoreToCamelCase(true);
74.         configuration.setCacheEnabled(false);
75.         configuration.setCallSettersOnNulls(true);
76.         configuration.setJdbcTypeForNull(JdbcType.NULL);
77.         configuration.addInterceptor(mybatisPlusInterceptor());
78.         MybatisSqlSessionFactoryBean sqlSessionFactoryBean = new MybatisSqlSessionFactoryBean();
79.         sqlSessionFactoryBean.setConfiguration(configuration);
80.         sqlSessionFactoryBean.setDataSource(dataSource());
82.         GlobalConfig.DbConfig dbConfig = new GlobalConfig.DbConfig();
83.         dbConfig.setIdType(IdType.AUTO);
84.         GlobalConfig globalConfig = new GlobalConfig();
85.         globalConfig.setDbConfig(dbConfig);
86.         sqlSessionFactoryBean.setPlugins(new KeywordInterceptor());
87.         return sqlSessionFactoryBean.getObject();
88.     }
89. }

复制代码

4. 总结

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

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。