MyBatis-Plus中实现全局Schema配置的最佳实践

MyBatis-Plus中实现全局Schema配置的最佳实践

【免费下载链接】mybatis-plus mybatis 增强工具包，简化 CRUD 操作。 文档 http://baomidou.com 低代码组件库 http://aizuda.com 项目地址: https://gitcode.com/baomidou/mybatis-plus

背景介绍

在使用MyBatis-Plus进行数据库操作时，我们经常会遇到多Schema环境下的开发需求。MyBatis-Plus提供了db-config.schema配置项，可以方便地为实体类自动添加Schema前缀。然而，当我们需要在Mapper.xml文件或@Select注解中编写原生SQL时，如何实现同样的Schema自动添加功能呢？

问题分析

MyBatis-Plus的db-config.schema配置主要作用于实体类与数据库表的映射关系，但对于手动编写的SQL语句，这一配置并不会自动生效。这就导致了开发者在混合使用自动生成的SQL和手动编写的SQL时，Schema处理不一致的问题。

解决方案

方案一：使用MyBatis全局变量配置

MyBatis提供了configuration.variables配置项，我们可以利用这一特性实现全局Schema配置：

mybatis-plus:
  configuration:
    variables:
      schema: your_schema_name

在Mapper.xml中使用时：

<select id="selectUser" resultType="User">
    SELECT * FROM ${schema}.user_table
</select>

方案二：自定义SQL拦截器

对于更复杂的需求，可以创建一个SQL拦截器，自动为所有SQL语句添加Schema前缀：

@Intercepts({
    @Signature(type= StatementHandler.class, method="prepare", args={Connection.class, Integer.class})
})
public class SchemaInterceptor implements Interceptor {
    
    private String schema;
    
    public SchemaInterceptor(String schema) {
        this.schema = schema;
    }
    
    @Override
    public Object intercept(Invocation invocation) throws Throwable {
        StatementHandler handler = (StatementHandler) invocation.getTarget();
        BoundSql boundSql = handler.getBoundSql();
        String sql = boundSql.getSql();
        
        // 简单的SQL解析和Schema添加逻辑
        if (!sql.contains(".") && !sql.startsWith(schema + ".")) {
            sql = schema + "." + sql;
        }
        
        // 使用反射修改SQL
        Field field = BoundSql.class.getDeclaredField("sql");
        field.setAccessible(true);
        field.set(boundSql, sql);
        
        return invocation.proceed();
    }
}

然后在配置类中注册这个拦截器：

@Configuration
public class MyBatisConfig {
    
    @Value("${mybatis-plus.global-config.db-config.schema}")
    private String schema;
    
    @Bean
    public SchemaInterceptor schemaInterceptor() {
        return new SchemaInterceptor(schema);
    }
}

方案三：使用MyBatis-Plus的SQL注入器

对于使用MyBatis-Plus的场景，还可以通过自定义SQL注入器来实现：

public class SchemaSqlInjector extends DefaultSqlInjector {
    
    private String schema;
    
    public SchemaSqlInjector(String schema) {
        this.schema = schema;
    }
    
    @Override
    public List<AbstractMethod> getMethodList(Class<?> mapperClass, TableInfo tableInfo) {
        List<AbstractMethod> methodList = super.getMethodList(mapperClass, tableInfo);
        // 自定义方法处理
        methodList.add(new SelectBySchemaMethod(schema));
        return methodList;
    }
}

最佳实践建议

1. 简单场景：如果项目中使用Schema的场景不多，建议直接使用MyBatis全局变量配置，简单易用。

2. 复杂场景：如果项目中有大量手动编写的SQL且需要统一Schema处理，建议使用SQL拦截器方案，可以一劳永逸地解决问题。

3. 混合使用：对于既有自动生成SQL又有手动编写SQL的项目，可以考虑同时使用db-config.schema和全局变量配置，保持一致性。

4. 性能考虑：SQL拦截器会对所有SQL进行处理，可能会带来轻微的性能开销，在性能敏感场景需要评估。

注意事项

1. SQL注入风险：使用字符串拼接Schema时要注意防止SQL注入，确保Schema值来自可信配置。

2. 多数据源场景：在多数据源环境下，需要为每个数据源配置相应的Schema处理逻辑。

3. 动态Schema：如果需要支持运行时动态切换Schema，可以考虑使用ThreadLocal存储当前Schema。

通过以上方案，开发者可以灵活地在MyBatis-Plus项目中实现全局Schema配置，无论是自动生成的SQL还是手动编写的SQL，都能保持一致的Schema处理逻辑，提高代码的可维护性和一致性。

【免费下载链接】mybatis-plus mybatis 增强工具包，简化 CRUD 操作。 文档 http://baomidou.com 低代码组件库 http://aizuda.com 项目地址: https://gitcode.com/baomidou/mybatis-plus