一、創建SqlSessionFactory和SqlSession對象
1.2.什么是SqlSession？
1.3.SqlSessionFactory和SqlSession實現過程（源碼分析）
SqlSessionFactory是Mybatis的關鍵對象，它是個單個數據庫映射關系經過編譯后的內存鏡像。SqlSessionFactory對象的實例可以通過SqlSessionFactoryBuilder對象類獲得，而SqlSessionFactoryBuilder則可以從XML配置文件或者一個預先定制的Configuration的實例構建出SqlSessionFactory的實例。每一個Mybaits的應用給程序都以一個SqlSessionFactory對象的實例為核心，同時SqlSessionFactory也是線程安全的，SqlSessionFactory一旦被創建，應該在應用執行期間都存在，在應用運行期間不要重復創建多次，建議使用單例模式。SqlSessionFactory是創建SqlSession的工廠。
SqlSessionFactory接口源碼如下所示:
package org.apache.ibatis.session; import java.sql.Connection; /** * Creates an {@link SqlSession} out of a connection or a DataSource * * @author Clinton Begin */ public interface SqlSessionFactory { SqlSession openSession(); SqlSession openSession(boolean autoCommit); SqlSession openSession(Connection connection); SqlSession openSession(TransactionIsolationLevel level); SqlSession openSession(ExecutorType execType); SqlSession openSession(ExecutorType execType, boolean autoCommit); SqlSession openSession(ExecutorType execType, TransactionIsolationLevel level); SqlSession openSession(ExecutorType execType, Connection connection); Configuration getConfiguration(); }
二、什么是SqlSession？
SqlSession是MyBatis的關鍵對象，它是應用程序與持久層之間交互操作的一個單線程對象,類似於JDBC中的Connection。SqlSession對象完全包含以數據庫為背景的所有執行SQL操作的方法，它的底層封裝了JDBC連接，可以用SqlSession實例來直接執行被映射的SQL語句。每個線程都應該有它自己的SqlSession實例。SqlSession的實例不能被共享，同時SqlSession也是線程不安全的，絕對不能講SqlSeesion實例的引用放在一個類的靜態字段甚至是實例字段中。也絕不能將SqlSession實例的引用放在任何類型的管理范圍中，比如Servlet當中的HttpSession對象中。使用完SqlSeesion之后關閉Session很重要,應該確保使用finally塊來關閉它。 示例代碼有點多就不貼了，可以自己去看源碼。
三、SqlSessionFactory和SqlSession實現過程
mybatis框架主要是圍繞着SqlSessionFactory進行的，創建過程大概如下：
(1)、定義一個Configuration對象，其中包含數據源、事務、mapper文件資源以及影響數據庫行為屬性設置settings
(2)、通過配置對象，則可以創建一個SqlSessionFactoryBuilder對象
(3)、通過 SqlSessionFactoryBuilder 獲得SqlSessionFactory 的實例。
(4)、SqlSessionFactory 的實例可以獲得操作數據的SqlSession實例，通過這個實例對數據庫進行操作
如果是spring+mybaits項目
application.yml文件數據庫配置
spring: profiles: devnew datasource: url: jdbc:mysql://xx.xx.xxx.xxx:80331/project?useUnicode=true&characterEncoding=UTF-8&serverTimezone=UTC driver-class-name: com.mysql.jdbc.Driver username: xxxxxx password: xxxxxx redis: host: xx.xx.xxx.xxx port: 7000 password: xxxxxx database: 7 lettuce: pool: max-active: 1000 max-wait: 10000ms max-idle: 10
連接數據庫:
/** * 數據源配置 */ @Configuration public class DruidConfig { private Logger logger = LoggerFactory.getLogger(getClass()); @Value("${spring.datasource.url}") private String dbUrl; @Value("${spring.datasource.username}") private String username; @Value("${spring.datasource.password}") private String password; @Value("${spring.datasource.driver-class-name}") private String driverClassName; @Bean @Primary public DataSource druidDataSource() { DruidDataSource datasource = new DruidDataSource(); datasource.setUrl(this.dbUrl); datasource.setUsername(username); datasource.setPassword(password); datasource.setDriverClassName(driverClassName); datasource.setInitialSize(10); datasource.setMinIdle(10); datasource.setMaxActive(200); datasource.setMaxWait(60000); datasource.setTimeBetweenEvictionRunsMillis(45000); datasource.setValidationQuery("SELECT 1"); datasource.setTestWhileIdle(true); datasource.setTestOnBorrow(true); datasource.setTestOnReturn(false); datasource.setRemoveAbandonedTimeout(3600); try { datasource.setFilters("stat"); datasource.init(); } catch (SQLException e) { logger.error("druid configuration initialization filter", e); } return datasource; } }
SqlSessionFactory的創建:
public class SessionFactoryConfig implements TransactionManagementConfigurer { @Autowired private DataSource dataSource; private String mapper = "classpath:com/xx/xxx/mapper/**/*Mapper.xml"; //xml掃描路徑 @Bean public SqlSessionFactory sqlSessionFactory() throws Exception { final SqlSessionFactoryBean sqlSessionFactoryBean = new SqlSessionFactoryBean(); sqlSessionFactoryBean.setDataSource(dataSource); sqlSessionFactoryBean.setMapperLocations(new PathMatchingResourcePatternResolver().getResources(mapper)); return sqlSessionFactoryBean.getObject(); } @Bean public SqlSessionTemplate sqlSessionTemplate(SqlSessionFactory sqlSessionFactory) { return new SqlSessionTemplate(sqlSessionFactory); } @Bean @Override public PlatformTransactionManager annotationDrivenTransactionManager() { return new DataSourceTransactionManager(dataSource); } }
源碼分析：
具體實現過程
第一步： 我們看這個方法sqlSessionFactoryBean.getObject();
/** * {@inheritDoc} */ @Override public SqlSessionFactory getObject() throws Exception { if (this.sqlSessionFactory == null) { afterPropertiesSet(); } return this.sqlSessionFactory; }
接着我們在看 afterPropertiesSet();
@Override public void afterPropertiesSet() throws Exception { notNull(dataSource, "Property 'dataSource' is required"); notNull(sqlSessionFactoryBuilder, "Property 'sqlSessionFactoryBuilder' is required"); state((configuration == null && configLocation == null) || !(configuration != null && configLocation != null), "Property 'configuration' and 'configLocation' can not specified with together"); this.sqlSessionFactory = buildSqlSessionFactory(); }
接着我們在看看buildSqlSessionFactory()
protected SqlSessionFactory buildSqlSessionFactory() throws IOException { Configuration configuration; XMLConfigBuilder xmlConfigBuilder = null; if (this.configuration != null) { configuration = this.configuration; if (configuration.getVariables() == null) { configuration.setVariables(this.configurationProperties); } else if (this.configurationProperties != null) { configuration.getVariables().putAll(this.configurationProperties); } } else if (this.configLocation != null) { xmlConfigBuilder = new XMLConfigBuilder(this.configLocation.getInputStream(), null, this.configurationProperties); configuration = xmlConfigBuilder.getConfiguration(); } else { if (LOGGER.isDebugEnabled()) { LOGGER.debug("Property 'configuration' or 'configLocation' not specified, using default MyBatis Configuration"); } configuration = new Configuration(); if (this.configurationProperties != null) { configuration.setVariables(this.configurationProperties); } } if (this.objectFactory != null) { configuration.setObjectFactory(this.objectFactory); } if (this.objectWrapperFactory != null) { configuration.setObjectWrapperFactory(this.objectWrapperFactory); } if (this.vfs != null) { configuration.setVfsImpl(this.vfs); } if (hasLength(this.typeAliasesPackage)) { String[] typeAliasPackageArray = tokenizeToStringArray(this.typeAliasesPackage, ConfigurableApplicationContext.CONFIG_LOCATION_DELIMITERS); for (String packageToScan : typeAliasPackageArray) { configuration.getTypeAliasRegistry().registerAliases(packageToScan, typeAliasesSuperType == null ? Object.class : typeAliasesSuperType); if (LOGGER.isDebugEnabled()) { LOGGER.debug("Scanned package: '" + packageToScan + "' for aliases"); } } } if (!isEmpty(this.typeAliases)) { for (Class<?> typeAlias : this.typeAliases) { configuration.getTypeAliasRegistry().registerAlias(typeAlias); if (LOGGER.isDebugEnabled()) { LOGGER.debug("Registered type alias: '" + typeAlias + "'"); } } } if (!isEmpty(this.plugins)) { for (Interceptor plugin : this.plugins) { configuration.addInterceptor(plugin); if (LOGGER.isDebugEnabled()) { LOGGER.debug("Registered plugin: '" + plugin + "'"); } } } if (hasLength(this.typeHandlersPackage)) { String[] typeHandlersPackageArray = tokenizeToStringArray(this.typeHandlersPackage, ConfigurableApplicationContext.CONFIG_LOCATION_DELIMITERS); for (String packageToScan : typeHandlersPackageArray) { configuration.getTypeHandlerRegistry().register(packageToScan); if (LOGGER.isDebugEnabled()) { LOGGER.debug("Scanned package: '" + packageToScan + "' for type handlers"); } } } if (!isEmpty(this.typeHandlers)) { for (TypeHandler<?> typeHandler : this.typeHandlers) { configuration.getTypeHandlerRegistry().register(typeHandler); if (LOGGER.isDebugEnabled()) { LOGGER.debug("Registered type handler: '" + typeHandler + "'"); } } } if (this.databaseIdProvider != null) {//fix #64 set databaseId before parse mapper xmls try { configuration.setDatabaseId(this.databaseIdProvider.getDatabaseId(this.dataSource)); } catch (SQLException e) { throw new NestedIOException("Failed getting a databaseId", e); } } if (this.cache != null) { configuration.addCache(this.cache); } if (xmlConfigBuilder != null) { try { xmlConfigBuilder.parse(); if (LOGGER.isDebugEnabled()) { LOGGER.debug("Parsed configuration file: '" + this.configLocation + "'"); } } catch (Exception ex) { throw new NestedIOException("Failed to parse config resource: " + this.configLocation, ex); } finally { ErrorContext.instance().reset(); } } if (this.transactionFactory == null) { this.transactionFactory = new SpringManagedTransactionFactory(); } configuration.setEnvironment(new Environment(this.environment, this.transactionFactory, this.dataSource)); if (!isEmpty(this.mapperLocations)) { for (Resource mapperLocation : this.mapperLocations) { if (mapperLocation == null) { continue; } try { XMLMapperBuilder xmlMapperBuilder = new XMLMapperBuilder(mapperLocation.getInputStream(), configuration, mapperLocation.toString(), configuration.getSqlFragments()); xmlMapperBuilder.parse(); } catch (Exception e) { throw new NestedIOException("Failed to parse mapping resource: '" + mapperLocation + "'", e); } finally { ErrorContext.instance().reset(); } if (LOGGER.isDebugEnabled()) { LOGGER.debug("Parsed mapper file: '" + mapperLocation + "'"); } } } else { if (LOGGER.isDebugEnabled()) { LOGGER.debug("Property 'mapperLocations' was not specified or no matching resources found"); } } return this.sqlSessionFactoryBuilder.build(configuration); }
到此 一個SqlSessionFactory就創建好了。
1.4 SqlSessionFactoryBuilder、SqlSessionFactory、SqlSession生命周期
如果使用依賴注入框架（Spring）可不用在代碼中關心作用域問題，因為依賴注入框架會為我們做好幾乎一切工作。
SqlSessionFactoryBuilder
這個類可以被實例化、使用和丟棄，一旦創建了 SqlSessionFactory，就不再需要它了。因此 SqlSessionFactoryBuilder 實例的最佳范圍是方法范圍（也就是局部方法變量）。你可以重用 SqlSessionFactoryBuilder 來創建多個 SqlSessionFactory 實例，但是最好還是不要讓其一直存在以保證所有的 XML 解析資源開放給更重要的事情。
SqlSessionFactory
SqlSessionFactory 一旦被創建就應該在應用的運行期間一直存在，沒有任何理由對它進行清除或重建。使用 SqlSessionFactory 的最佳實踐是在應用運行期間不要重復創建多次，多次重建 SqlSessionFactory 被視為一種bad smell。因此 SqlSessionFactory 的最佳范圍是應用范圍。有很多方法可以做到，最簡單的就是使用單例模式或者靜態單例模式。
SqlSession
每個線程都應該有它自己的 SqlSession 實例。SqlSession 的實例不是線程安全的，因此是不能被共享的，所以它的最佳的范圍是請求或方法范圍。絕對不能將 SqlSession 實例的引用放在一個類的靜態域，甚至一個類的實例變量也不行。也絕不能將 SqlSession 實例的引用放在任何類型的管理范圍中，比如 Serlvet 架構中的 HttpSession。如果你現在正在使用一種 Web 框架，要考慮 SqlSession 放在一個和 HTTP 請求對象相似的范圍中。換句話說，每次收到的 HTTP 請求，就可以打開一個 SqlSession，返回一個響應，就關閉它。這個關閉操作是很重要的，你應該把這個關閉操作放到 finally 塊中以確保每次都能執行關閉。