Mybatis中自定义实例化SqlSessionFactoryBean问题

目录

• MyBATis自定义实例化SqlSessionFactoryBean
• MyBatis中SqlSessionFactoryBean的作用
• 总结

Mybatis自定义实例化SqlSessionFactoryBean

现在SpringBoot基本成为开发的标配，如果你上司让你搭建一个SpringBoot，然后集成Mybatis+Druid，你可以能百度几下，卡卡就搭建完毕了。

现在项目基本都会使用连接池技术，市面上的连接池有很多，比如：DBCP、c3p0、Druid等，今天我们重点介绍Druid连接池。

application.yml配置文件如下所示：

spring:
 #数据库配置
 datasource:
  druid:
   type: com.alibaba.druid.pool.DruidDataSource
   url: jdbc:mysql://127.0.0.1:3306/test?useUnicode=true&characterEncoding=UTF-8&zeroDateTimeBehavior=round&serverTimezone=GMT%2B8
   username: test
   password: test
   driver-class-name: com.mysql.jdbc.Driver
#   获取连接时最大等待时间，单位毫秒
   max-wait: 60000
#   最大连接池数量
   max-active: 80
#   初始化时建立物理连接的个数
   initial-size: 20
#   最小连接池数量
   min-idle: 40
#Destory线程中如果检测到当前连接的最后活跃时间和当前时间的差值大于minEvictableIdleTimeMillis，则关闭当前连接。
   min-evictable-idle-time-millis: 600000
#   testWhileIdle的判断依据，详细看testWhileIdle属性的说明
   time-between-eviction-runs-millis: 2000
#用来检测连接是否有效的sql，要求是一个查询语句。
   validation-query: select 1
#   申请连接的时候检测，如果空闲时间大于timeBetweenEvictionRunsMillis，执行validationQuery检测连接是否有效。
   test-while-idle: true
#   申请连接时执行validationQuery检测连接是否有效，做了这个配置会降低性能。
   test-on-borrow: false
#   归还连接时执行validationQuery检测连接是否有效，做了这个配置会降低性能
   test-onhttp://www.devze.com-return: false
#   属性类型是字符串，通过别名的方式配置扩展插件
   filters: stat,wall
#   开启慢sql，并设置时间
   filter:
    stat.log-slow-sql: true
    stat.slow-sql-millis: 2000
   web-stat-filter:
    enabled: true
    url-pattern: /*
   stat-view-servlet:
    enabled: true
    url-pattern: /druid/*

使用SpringBoot作为项目框架自然简单，没有很多的XML配置文件，不需要配置额外的tomcat，不管是开发还是部署都非常方便。但高度集成有时候也会带来一些麻烦。

比如你上司要求你在mybatis中集成插件并可以识别common模块的mybatis.xml映射文件。

这个时候你可能首先会百度如何配置mybatis插件、如何配置多模块的mapper-locations，然后有很多博文会说在SqlSessionFactoryBean设置即可。

你可能会这么设置：

@Autowired
private SqlSessionFactoryBean sqlSessionFactoryBean;

但是结果不是那么尽人意，初始化的结果为null。

这是因为高版本的mybatis实现机制做了一些修改，我们没办法通过@Autowired来实例化SqlSessionFactoryBean对象。

所以我们必须自己来实例化SqlSessionFactoryBean对象，而实例化SqlSessionFactoryBean对象的关键就是设置DataSource数据源。

我们可以通过如下代码来实例化过Shttp://www.devze.comqlSessionFactoryBean。

/**
* mybatis配置
* @author linzhiqinag
*/
@Configuration
public class MybatisConfig {
  private Logger logger = LoggerFactory.getLogger(MybatisConfig.class);

  @Value("${mybatis.mapper-locations}")
  private String mapperlocation;

  @Value("${common-mybatis.mapper-locations}")
  private String commonMapperLocation;

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

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

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

  @Value("${spring.datasource.druid.initial-size}")
  private int initialSize;

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

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

  @Value("${spring.datasource.druid.max-wait}")
  private long maxWait;

  @Value("${spring.datasource.druid.driver-class-name}")
  private String driverClassName;

  @Value("${spring.datasource.druid.min-evictable-idle-time-millis}")
  private long minEvictableIdleTimeMillis;

  @Value("${spring.dat编程asource.druid.time-between-eviction-runs-millis}")
  private long timeBetweenEvictionRunsMillis;

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

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

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

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

  @Value("${spring.datasource.druid.filter.stat.log-slow-sql}")
  private boolean logSlowSql;

  @Value("${spring.datasource.druid.filter.stat.slow-sql-millis}")
  private long slowSqlMillis;

  @Bean
  public DruidDataSource dataSource() {
    DruidDataSource druidDataSource = new DruidDataSource();
    try {
      druidDataSource.setUsername(username);
      druidDataSource.setPassword(password);
      druidDataSource.setUrl(dbUrl);
      druidDataSource.setFilters("stat,wall");
      druidDataSource.setInitialSize(initialSize);
      druidDataSource.setMinIdle(minIdle);
      druidDataSource.setMaxActive(maxActive);
      druidDataSource.setMaxWait(maxWait);
      druidDataSource.setMinEvictableIdleTimeMillis(minEvictableIdleTimeMillis);
      druidDataSource.setTimeBetweenEvictionRunsMillis(timeBetweenEvictionRunsMillis);
      druidDataSource.setUseGlobalDataSourceStat(true);
      druidDataSource.setDriverClassName(driverClassName);
      druidDataSource.setValidationQuery(validationQuery);
      druidDataSource.setTestWhileIdle(testWhileIdle);
  javascript    druidDataSource.setTestOnBorrow(testOnBorrow);
      druidDataSource.setTestOnReturn(testOnReturn);
      // 设置需要的过滤
      List<Filter> statFilters =new ArrayList<>();
      StatFilter statFilter = new StatFilter();
      statFilter.setLogSlowSql(logSlowSql);
      statFilter.setSlowSqlMillis(slowSqlMillis);
      statFilters.add(statFilter);
      // 设置慢SQL
      druidDataSource.setProxyFilters(statFilters);
    } catch (Exception e) {
      e.printStackTrace();
    }
    return druidDataSource;
  }

  @Bean
  public SqlSessionFactoryBean mysqlSessionFactory(DataSource dataSource) throws Exception {
    SqlSessionFactoryBean sqlSessionFactoryBean = new SqlSessionFactoryBean();
    sqlSessionFactoryBean.setDataSource(dataSource);
    PathMatchingResourcePatternResolver resolver = new PathMatchingResourcePatternResolver();
    Resource[] resources1 = resolver.getResources(mapperLocation);
    Resource[] resources2 = resolver.getResources(commonMapperLocation);
    Resource[] resources = new Resource[resources1.length+resources2.length];
    for (int i=0;i<resources1.length;i++) {
      resources[i] = resources1[i];
    }
    int initSize = resources1.length;
    for (int i=0;i<resources2.length;i++) {
      resources[initSize+i] = resources2[i];
    }
    sqlSessionFactoryBean.setMapperLocations(resources);
    sqlSessionFactoryBean.setPlugins(new Interceptor[]{new CatMybatisInterceptor(dbUrl)});
    return sqlSessionFactoryBean;
  }
}

这样我们就可以得到SqlSessionFactoryBean对象了，然后我们就可以通过sqlSessionFactoryBean.setMapperLocations()来设置多模块xml映射，通过sqlSessionFactoryBean.setPlugins()来设置指定的插件了。

注意：

这边需要注意的是，如果采用代码的方式实例化SqlSessionFactoryBean，那关于数据库相关的配置将会失效，所以在设置数据源的时候一定要设置全。

MyBatis中SqlSessionFactoryBean的作用

在使用Spring+MyBatis的环境下，我们需要配值一个SqlSessionFactoryBean来充当SqlSessionFactory，这里我们要搞清楚的就是为什么SqlSessionFactoryBean为什么能在Spring IoC容器中以SqlSessionFactory的类型保存并被获取。

我们来看看SqlSessionFactoryBean的定义是怎样的：

public class SqlSessionFactoryBean implements FactoryBean&l编程客栈t;SqlSessionFactory>, InitializingBean, ApplicationListener<ApplicationEvent> {

}

能被Spring IoC容器管理的原因就是继承了FactoryBean这个接口了，这是个支持泛型的接口：

public interface FactoryBean<T> {
 @Nullable
 T getObject() throws Exception;
 
 @Nullable
 Class<?> getObjectType();
 
 defa开发者_JS开发ult boolean isSingleton() {
  return true;
 }
}

当实现了这个接口的Bean在配置为被Spring接管时，存入IoC容器中的实例类型将会是实例化泛型的那个类型，从IoC容器中获取时也是实例化泛型的那个类型，这种情况下,Spring 将会在应用启动时为你创建SqlSessionFactory对象，然后将它以 SqlSessionFactory为名来存储。

当把这个bean注入到Spring中去了以后，IoC容器中的其他类型就可以拿到SqlSession实例了，就可以进行相关的SQL执行任务了。

总结

以上为个人经验，希望能给大家一个参考，也希望大家多多支持我们。