Mybatis中自定義實例化SqlSessionFactoryBean問題

更新時間：2023年02月27日 09:31:24 作者：林老師帶你學編程

這篇文章主要介紹了Mybatis中自定義實例化SqlSessionFactoryBean問題，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教

Mybatis自定義實例化SqlSessionFactoryBean

現(xiàn)在SpringBoot基本成為開發(fā)的標配，如果你上司讓你搭建一個SpringBoot，然后集成Mybatis+Druid，你可以能百度幾下，卡卡就搭建完畢了。

現(xiàn)在項目基本都會使用連接池技術，市面上的連接池有很多，比如：DBCP、c3p0、Druid等，今天我們重點介紹Druid連接池。

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

spring:
? #數(shù)據(jù)庫配置
? 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
# ? ? ?最大連接池數(shù)量
? ? ? max-active: 80
# ? ? ?初始化時建立物理連接的個數(shù)
? ? ? initial-size: 20
# ? ? ?最小連接池數(shù)量
? ? ? min-idle: 40
#Destory線程中如果檢測到當前連接的最后活躍時間和當前時間的差值大于minEvictableIdleTimeMillis，則關閉當前連接。
? ? ? min-evictable-idle-time-millis: 600000
# ? ? ?testWhileIdle的判斷依據(jù)，詳細看testWhileIdle屬性的說明
? ? ? time-between-eviction-runs-millis: 2000
#用來檢測連接是否有效的sql，要求是一個查詢語句。
? ? ? validation-query: select 1
# ? ? ?申請連接的時候檢測，如果空閑時間大于timeBetweenEvictionRunsMillis，執(zhí)行validationQuery檢測連接是否有效。
? ? ? test-while-idle: true
# ? ? ?申請連接時執(zhí)行validationQuery檢測連接是否有效，做了這個配置會降低性能。
? ? ? test-on-borrow: false
# ? ? ?歸還連接時執(zhí)行validationQuery檢測連接是否有效，做了這個配置會降低性能
? ? ? test-on-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，不管是開發(fā)還是部署都非常方便。但高度集成有時候也會帶來一些麻煩。

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

這個時候你可能首先會百度如何配置mybatis插件、如何配置多模塊的mapper-locations，然后有很多博文會說在SqlSessionFactoryBean設置即可。

你可能會這么設置：

@Autowired
private SqlSessionFactoryBean sqlSessionFactoryBean;

但是結果不是那么盡人意，初始化的結果為null。

這是因為高版本的mybatis實現(xiàn)機制做了一些修改，我們沒辦法通過@Autowired來實例化SqlSessionFactoryBean對象。

所以我們必須自己來實例化SqlSessionFactoryBean對象，而實例化SqlSessionFactoryBean對象的關鍵就是設置DataSource數(shù)據(jù)源。

我們可以通過如下代碼來實例化過SqlSessionFactoryBean。

/**
?* 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.datasource.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);
? ? ? ? ? ? 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，那關于數(shù)據(jù)庫相關的配置將會失效，所以在設置數(shù)據(jù)源的時候一定要設置全。

MyBatis中SqlSessionFactoryBean的作用

在使用Spring+MyBatis的環(huán)境下，我們需要配值一個SqlSessionFactoryBean來充當SqlSessionFactory，這里我們要搞清楚的就是為什么SqlSessionFactoryBean為什么能在Spring IoC容器中以SqlSessionFactory的類型保存并被獲取。

我們來看看SqlSessionFactoryBean的定義是怎樣的：

public class SqlSessionFactoryBean implements FactoryBean<SqlSessionFactory>, InitializingBean, ApplicationListener<ApplicationEvent> {
?
}

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

public interface FactoryBean<T> {
?? ?@Nullable
?? ?T getObject() throws Exception;
?? ?
?? ?@Nullable
?? ?Class<?> getObjectType();
?? ?
?? ?default boolean isSingleton() {
?? ??? ?return true;
?? ?}
}

當實現(xiàn)了這個接口的Bean在配置為被Spring接管時，存入IoC容器中的實例類型將會是實例化泛型的那個類型，從IoC容器中獲取時也是實例化泛型的那個類型，這種情況下,Spring 將會在應用啟動時為你創(chuàng)建SqlSessionFactory對象，然后將它以 SqlSessionFactory為名來存儲。

當把這個bean注入到Spring中去了以后，IoC容器中的其他類型就可以拿到SqlSession實例了，就可以進行相關的SQL執(zhí)行任務了。