若依多数据源+mybatis-plus+baseMapper

Suddenly, this summer

已于 2024-05-29 15:27:24 修改

阅读量1.1k

点赞数 11

文章标签： mybatis

于 2024-05-22 17:12:27 首次发布

本文链接：https://blog.csdn.net/qq_45856714/article/details/139123151

版权

小白，记录一下项目中使用到的若依多数据源

一、yml

spring:
  datasource:
      type: com.alibaba.druid.pool.DruidDataSource
      druid:
          master:
              driver-class-name: com.mysql.cj.jdbc.Driver
              url: jdbc:mysql://xxx.xxx.xxx.xxx:3306/xxxx?useUnicode=true&characterEncoding=utf8&zeroDateTimeBehavior=convertToNull&useSSL=false&serverTimezone=GMT%2B8
              username: xxxx
              password: xxxx
          slave:
              # 从数据源开关/默认关闭
              enabled: false
              url:
              username:
              password:
          erp:
              # 从数据源开关/默认关闭
              enabled: true
              driver-class-name: com.microsoft.sqlserver.jdbc.SQLServerDriver
              url: jdbc:sqlserver://xxx.xxx.xxx.xxx:1499;databaseName=xxxxx
              username: xxxx
              password: xxxx
          # 初始连接数
          initialSize: 5
          # 最小连接池数量
          minIdle: 10
          # 最大连接池数量
          maxActive: 20
          # 配置获取连接等待超时的时间
          maxWait: 60000
          # 配置间隔多久才进行一次检测，检测需要关闭的空闲连接，单位是毫秒
          timeBetweenEvictionRunsMillis: 60000
          # 配置一个连接在池中最小生存的时间，单位是毫秒
          minEvictableIdleTimeMillis: 300000
          # 配置一个连接在池中最大生存的时间，单位是毫秒
          maxEvictableIdleTimeMillis: 900000
          # 配置检测连接是否有效
          validationQuery: SELECT 1
          testWhileIdle: true
          testOnBorrow: false
          testOnReturn: false
          webStatFilter:
              enabled: true
          statViewServlet:
              enabled: true
              # 设置白名单，不填则允许所有访问
              allow:
              url-pattern: /druid/*
              # 控制台管理用户名和密码
              login-username: admin
              login-password: xxxxx
          filter:
              stat:
                  enabled: true
                  # 慢SQL记录
                  log-slow-sql: true
                  slow-sql-millis: 1000
                  merge-sql: true
              wall:
                  config:
                      multi-statement-allow: true

二、DruidProperties

@Configuration
public class DruidProperties
{
    @Value("${spring.datasource.druid.initialSize}")
    private int initialSize;

    @Value("${spring.datasource.druid.minIdle}")
    private int minIdle;

    @Value("${spring.datasource.druid.maxActive}")
    private int maxActive;

    @Value("${spring.datasource.druid.maxWait}")
    private int maxWait;

    @Value("${spring.datasource.druid.timeBetweenEvictionRunsMillis}")
    private int timeBetweenEvictionRunsMillis;

    @Value("${spring.datasource.druid.minEvictableIdleTimeMillis}")
    private int minEvictableIdleTimeMillis;

    @Value("${spring.datasource.druid.maxEvictableIdleTimeMillis}")
    private int maxEvictableIdleTimeMillis;

    @Value("${spring.datasource.druid.validationQuery}")
    private String validationQuery;

    @Value("${spring.datasource.druid.testWhileIdle}")
    private boolean testWhileIdle;

    @Value("${spring.datasource.druid.testOnBorrow}")
    private boolean testOnBorrow;

    @Value("${spring.datasource.druid.testOnReturn}")
    private boolean testOnReturn;

    public DruidDataSource dataSource(DruidDataSource datasource)
    {
        /** 配置初始化大小、最小、最大 */
        datasource.setInitialSize(initialSize);
        datasource.setMaxActive(maxActive);
        datasource.setMinIdle(minIdle);

        /** 配置获取连接等待超时的时间 */
        datasource.setMaxWait(maxWait);

        /** 配置间隔多久才进行一次检测，检测需要关闭的空闲连接，单位是毫秒 */
        datasource.setTimeBetweenEvictionRunsMillis(timeBetweenEvictionRunsMillis);

        /** 配置一个连接在池中最小、最大生存的时间，单位是毫秒 */
        datasource.setMinEvictableIdleTimeMillis(minEvictableIdleTimeMillis);
        datasource.setMaxEvictableIdleTimeMillis(maxEvictableIdleTimeMillis);

        /**
         * 用来检测连接是否有效的sql，要求是一个查询语句，常用select 'x'。如果validationQuery为null，testOnBorrow、testOnReturn、testWhileIdle都不会起作用。
         */
        datasource.setValidationQuery(validationQuery);
        /** 建议配置为true，不影响性能，并且保证安全性。申请连接的时候检测，如果空闲时间大于timeBetweenEvictionRunsMillis，执行validationQuery检测连接是否有效。 */
        datasource.setTestWhileIdle(testWhileIdle);
        /** 申请连接时执行validationQuery检测连接是否有效，做了这个配置会降低性能。 */
        datasource.setTestOnBorrow(testOnBorrow);
        /** 归还连接时执行validationQuery检测连接是否有效，做了这个配置会降低性能。 */
        datasource.setTestOnReturn(testOnReturn);
        return datasource;
    }
}

三、DynamicDataSource

public class DynamicDataSource extends AbstractRoutingDataSource
{
    public DynamicDataSource(DataSource defaultTargetDataSource, Map<Object, Object> targetDataSources)
    {
        super.setDefaultTargetDataSource(defaultTargetDataSource);
        super.setTargetDataSources(targetDataSources);
        super.afterPropertiesSet();
    }

    @Override
    protected Object determineCurrentLookupKey()
    {
        return DynamicDataSourceContextHolder.getDataSourceType();
    }
}

四、DynamicDataSourceContextHolder

public class DynamicDataSourceContextHolder
{
    public static final Logger log = LoggerFactory.getLogger(DynamicDataSourceContextHolder.class);

    /**
     * 使用ThreadLocal维护变量，ThreadLocal为每个使用该变量的线程提供独立的变量副本，
     *  所以每一个线程都可以独立地改变自己的副本，而不会影响其它线程所对应的副本。
     */
    private static final ThreadLocal<String> CONTEXT_HOLDER = new ThreadLocal<>();

    /**
     * 设置数据源的变量
     */
    public static void setDataSourceType(String dsType)
    {
//        log.info("切换到{}数据源", dsType);
        CONTEXT_HOLDER.set(dsType);
    }

    /**
     * 获得数据源的变量
     */
    public static String getDataSourceType()
    {
        return CONTEXT_HOLDER.get();
    }

    /**
     * 清空数据源变量
     */
    public static void clearDataSourceType()
    {
        CONTEXT_HOLDER.remove();
    }
}

五、DataSource注解

/**
 * 自定义多数据源切换注解
 * <p>
 * 优先级：先方法，后类，如果方法覆盖了类上的数据源类型，以方法的为准，否则以类上的为准
 *
 * @author ruoyi
 */
@Target({ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
public @interface DataSource {
    /**
     * 切换数据源名称
     */
    public DataSourceType value() default DataSourceType.MASTER;
}

六、DataSourceType

/**
 * 数据源
 *
 * @author suntion
 */
public enum DataSourceType {
    /**
     * 主库
     */
    MASTER,

    /**
     * ERP
     */
    ERP

}

七、DruidConfig

到这里配置完毕，已经可以使用动态数据源切换；如果不配置MasterMybatisConfig等，需要开启

@MapperScan("com.suntion.**.mapper")

/**
 * druid 配置多数据源
 *
 * @author ruoyi
 */
@Component
@Configuration
//@MapperScan("com.suntion.**.mapper") 没有配置第八步则开启
public class DruidConfig
{

    @Bean
    @ConfigurationProperties("spring.datasource.druid.master")
    public DataSource masterDataSource(DruidProperties druidProperties)
    {
        DruidDataSource dataSource = DruidDataSourceBuilder.create().build();
        return druidProperties.dataSource(dataSource);
    }


    @Bean
    @ConfigurationProperties("spring.datasource.druid.slave")
    @ConditionalOnProperty(prefix = "spring.datasource.druid.slave", name = "enabled", havingValue = "true")
    public DataSource slaveDataSource(DruidProperties druidProperties)
    {
        DruidDataSource dataSource = DruidDataSourceBuilder.create().build();
        return druidProperties.dataSource(dataSource);
    }


    @Bean
    @ConfigurationProperties("spring.datasource.druid.erp")
    @ConditionalOnProperty(prefix = "spring.datasource.druid.erp", name = "enabled", havingValue = "true")
    public DataSource erpDataSource(DruidProperties druidProperties)
    {
        DruidDataSource dataSource = DruidDataSourceBuilder.create().build();
        return druidProperties.dataSource(dataSource);
    }


    @Bean(name = "dynamicDataSource")
    @Primary
    public DynamicDataSource dataSource(DataSource masterDataSource)
    {
        Map<Object, Object> targetDataSources = new HashMap<>();
        targetDataSources.put(DataSourceType.MASTER.name(), masterDataSource);
        setDataSource(targetDataSources, DataSourceType.ERP.name(), "erpDataSource");
        return new DynamicDataSource(masterDataSource, targetDataSources);
    }


    /**
     * 设置数据源
     *
     * @param targetDataSources 备选数据源集合
     * @param sourceName 数据源名称
     * @param beanName bean名称
     */
    public void setDataSource(Map<Object, Object> targetDataSources, String sourceName, String beanName)
    {
        try
        {
            DataSource dataSource = SpringUtils.getBean(beanName);
            targetDataSources.put(sourceName, dataSource);
        }
        catch (Exception e)
        {
        }
    }

}

八、数据源配置SqlSessionFactory(非必要，BaseMapper)

配置后，数据源切换注解放在类上，可以直接调用BaseMapper或IService中封装的方法，例如selectById等等；

如果不配置也是可以调用用BaseMapper或IService中封装的方法，但是@DataSource(value = DataSourceType.ERP) 要放在具体调用的方法上

MasterMybatisConfig：

@Configuration
@MapperScan(basePackages = "com.suntion.location.mapper.master", sqlSessionFactoryRef = "masterSqlSessionFactory")
public class MasterMybatisConfig {

    @Autowired
    @Qualifier("masterDataSource")
    private DataSource masterDataSource;


    @Bean(name = "masterSqlSessionFactory")
    @Primary
    public SqlSessionFactory masterSqlSessionFactory() throws Exception {
        MybatisSqlSessionFactoryBean sessionFactory = new MybatisSqlSessionFactoryBean();//mybatis-plus
//        SqlSessionFactoryBean sessionFactory = new SqlSessionFactoryBean();//mybatis
        sessionFactory.setDataSource(masterDataSource);
        MybatisConfiguration configuration = new MybatisConfiguration();
        // ... 其他配置，比如MapperLocations等
        configuration.setMapUnderscoreToCamelCase(true);
        configuration.setDefaultFetchSize(100);
        configuration.setDefaultStatementTimeout(30);
        sessionFactory.setMapperLocations(
                new PathMatchingResourcePatternResolver().getResources("classpath*:mapper/**/*.xml"));
        sessionFactory.setConfiguration(configuration);
        return sessionFactory.getObject();
    }

     /**
     * 创建事务管理器
     * 事务参考https://www.jianshu.com/p/2014d9a7b41d
     * @return
     */
    @Bean(name = "mastTransactionManager")
    @Primary
    public DataSourceTransactionManager erpTransactionManager() {
        return new DataSourceTransactionManager(masterDataSource);
    }

    /**
     * 创建sqlSession模板
     * @param sqlSessionFactory
     * @return
     */
    @Bean(name = "masterSqlSessionTemplate")
    public SqlSessionTemplate masterSqlSessionTemplate(@Qualifier("masterSqlSessionFactory") SqlSessionFactory sqlSessionFactory) {
        return new SqlSessionTemplate(sqlSessionFactory);
    }
}

ErpMybatisConfig：

@Configuration
@MapperScan(basePackages = "com.suntion.location.mapper.erp", sqlSessionFactoryRef = "erpSqlSessionFactory")
public class ErpMybatisConfig {

    @Autowired
    @Qualifier("erpDataSource")
    private DataSource erpDataSource;


    @Bean(name = "erpSqlSessionFactory")
    public SqlSessionFactory erpSqlSessionFactory() throws Exception {
        MybatisSqlSessionFactoryBean sessionFactory = new MybatisSqlSessionFactoryBean();//mybatis-plus
//        SqlSessionFactoryBean sessionFactory = new SqlSessionFactoryBean(); //mybatis
        sessionFactory.setDataSource(erpDataSource);
        MybatisConfiguration configuration = new MybatisConfiguration();
        configuration.setMapUnderscoreToCamelCase(true);
        configuration.setDefaultFetchSize(100);
        configuration.setDefaultStatementTimeout(30);
        sessionFactory.setConfiguration(configuration);
        sessionFactory.setMapperLocations(
                new PathMatchingResourcePatternResolver().getResources("classpath*:mapper/**/*.xml"));
        return sessionFactory.getObject();
    }

    /**
     * 创建事务管理器
     * @return
     */
    @Bean(name = "erpTransactionManager")
    public DataSourceTransactionManager erpTransactionManager() {
        return new DataSourceTransactionManager(erpDataSource);
    }

    /**
     * 创建sqlSession模板
     * @param sqlSessionFactory
     * @return
     */
    @Bean(name = "erpSqlSessionTemplate")
    public SqlSessionTemplate erpSqlSessionTemplate(@Qualifier("erpSqlSessionFactory") SqlSessionFactory sqlSessionFactory) {
        return new SqlSessionTemplate(sqlSessionFactory);
    }
}

九、启动类

@SpringBootApplication(exclude = DataSourceAutoConfiguration.class)
public class SuntionLocationServerApplication {

    public static void main(String[] args) {
        SpringApplication.run(SuntionLocationServerApplication.class, args);
    }
}

十、使用

调用erp数据库，@DataSource(value = DataSourceType.ERP)

@DataSource(value = DataSourceType.ERP)
@Mapper
public interface PpTrackJobMapper extends BaseMapper<PpTrackJob> {


    String test(Map<String, Object> map);

}

十一、分页

yml：auto-runtime-dialect: true # 自动识别运行时的方言 # 加上这个

pagehelper:
  #  helper-dialect: mysql # 指定数据库方言 # 注释掉这个
  auto-runtime-dialect: true # 自动识别运行时的数据库方言 # 加上这个
  supportMethodsArguments: true # 从接口获取参数
  params: count=countSql #