MyBatis連接數據庫配置的基本步驟和機制

更新時間：2024年05月16日 08:42:10 作者：鄧磊DL

MyBatis 是一個流行的持久層框架,它通過使用XML或注解的方式將SQL語句、存儲過程和Java方法進行綁定,從而避免了手寫大量的JDBC代碼和手動設置參數與結果集,本文給大家介紹了MyBatis連接數據庫配置的基本步驟和機制,需要的朋友可以參考下

前言

MyBatis 是一個流行的持久層框架，它通過使用XML或注解的方式將SQL語句、存儲過程和Java方法進行綁定，從而避免了手寫大量的JDBC代碼和手動設置參數與結果集。以下是 MyBatis 連接數據庫的基本步驟和機制：

MyBatis源碼版本：3.5.16

MyBatis-config.xml 示例

<environments default="development">  
    <environment id="development">  
        <transactionManager type="JDBC"/>  
        <dataSource type="POOLED">  
            <property name="driver" value="${db.driver}"/>  
            <property name="url" value="${db.url}"/>  
            <property name="username" value="${db.username}"/>  
            <property name="password" value="${db.password}"/>  
        </dataSource>  
    </environment>  
</environments>

1. 讀取配置文件

MyBatis 通過 Resources 類讀取配置文件。配置文件通常是 XML 格式，如 mybatis-config.xml。

關鍵代碼

String resource = "mybatis-config.xml";
Reader reader = Resources.getResourceAsReader(resource)

2. 解析配置文件

SqlSessionFactoryBuilder 使用 XMLConfigBuilder 解析配置文件，將 XML 配置轉換為 Java 對象。

關鍵代碼

SqlSessionFactory sqlSessionFactory = new SqlSessionFactoryBuilder().build(inputStream);

XMLConfigBuilder parser = new XMLConfigBuilder(reader, environment, properties);

XMLConfigBuilder 源碼片段

private void parseConfiguration(XNode root) {  
  try {  
    // issue #117 先讀取屬性 
    propertiesElement(root.evalNode("properties"));  
    Properties settings = settingsAsProperties(root.evalNode("settings"));  
    loadCustomVfsImpl(settings);  
    loadCustomLogImpl(settings);  
    typeAliasesElement(root.evalNode("typeAliases"));  
    pluginsElement(root.evalNode("plugins"));  
    objectFactoryElement(root.evalNode("objectFactory"));  
    objectWrapperFactoryElement(root.evalNode("objectWrapperFactory"));  
    reflectorFactoryElement(root.evalNode("reflectorFactory"));  
    settingsElement(settings);  
    // read it after objectFactory and objectWrapperFactory issue #631  
    environmentsElement(root.evalNode("environments"));  
    databaseIdProviderElement(root.evalNode("databaseIdProvider"));  
    typeHandlersElement(root.evalNode("typeHandlers"));  
    mappersElement(root.evalNode("mappers"));  
  } catch (Exception e) {  
    throw new BuilderException("Error parsing SQL Mapper Configuration. Cause: " + e, e);  
  }  
}

XMLConfigBuilder解析XML配置，并生成Configuration對象。

3. 創(chuàng)建 SqlSessionFactory

Configuration 對象包含了所有配置信息，包括環(huán)境配置、數據源配置等。SqlSessionFactoryBuilder 使用 Configuration 創(chuàng)建 DefaultSqlSessionFactory。

關鍵代碼

public SqlSessionFactory build(Configuration config) {  
  return new DefaultSqlSessionFactory(config);  
}

4. 建立數據庫連接

DefaultSqlSessionFactory 創(chuàng)建 SqlSession 時，通過 Environment 配置和 DataSource 獲取數據庫連接。

DefaultSqlSessionFactory 源碼片段

public SqlSession openSession() {  
  return openSessionFromDataSource(configuration.getDefaultExecutorType(), null, false);  
}

openSessionFromDataSource 方法中，DataSource 被用于獲取數據庫連接。

關鍵代碼

private SqlSession openSessionFromDataSource(ExecutorType execType, TransactionIsolationLevel level,  
    boolean autoCommit) {  
  //環(huán)境配置  
  final Environment environment = configuration.getEnvironment();  
  //事務工廠  
  final TransactionFactory transactionFactory = getTransactionFactoryFromEnvironment(environment);  
  //創(chuàng)建事務  
  Transaction tx = transactionFactory.newTransaction(environment.getDataSource(), level, autoCommit);  
  //創(chuàng)建執(zhí)行器  
  final Executor executor = configuration.newExecutor(tx, execType);  
  //返回SqlSession  
  return new DefaultSqlSession(configuration, executor, autoCommit);
}

5. 數據源配置

DataSource 配置在 mybatis-config.xml 文件中，通過 DataSourceFactory 創(chuàng)建具體的數據源實例。

關鍵代碼

// 獲取數據源工廠
String type = context.getStringAttribute("type");  
Properties props = context.getChildrenAsProperties();  
DataSourceFactory factory = (DataSourceFactory) resolveClass(type).getDeclaredConstructor().newInstance();  
factory.setProperties(props);    
// 獲取數據源
DataSource dataSource = factory.getDataSource();

總結

MyBatis連接數據庫的步驟包括：

讀取配置文件：通過 Resources 類讀取 XML 文件。
解析配置文件：使用 XMLConfigBuilder 解析 XML，生成 Configuration 對象。
創(chuàng)建 SqlSessionFactory：使用 SqlSessionFactoryBuilder 和 Configuration 創(chuàng)建 DefaultSqlSessionFactory。
建立數據庫連接：DefaultSqlSessionFactory 創(chuàng)建 SqlSession，使用 DataSource 獲取數據庫連接。