MyBatis3原始碼解析之如何獲取資料來源詳解

2022-06-26 14:04:46

前言

上文講的MyBatis部署執行且根據官網執行了一個demo：一步到位部署執行MyBatis3原始碼<保姆級>

jdbc

再貼一個JDBC執行的測試方法，流程為：

載入JDBC驅動；
獲取資料庫連線；
建立JDBC Statements物件；
設定SQL語句的傳入引數；
執行SQL語句並獲得查詢結果;
對查詢結果進行轉換處理並將處理結果返回;
釋放相關資源(關閉Connection,關閉Statement,關閉ResultSet);

    @Test
    public void jdbcTest(){
        String driver = "com.mysql.cj.jdbc.Driver";
        String url = "jdbc:mysql://localhost:3306/news?characterEncoding=utf8&serverTimezone=Asia/Shanghai&useSSL=false&allowPublicKeyRetrieval=true";
        String user = "root";
        String pwd = "root123456";
        Connection connection=null;
        ResultSet rs=null;
        PreparedStatement stmt=null;
        try {
            Class.forName(driver);
            //獲取資料庫連線
            connection = DriverManager.getConnection(url,user,pwd);
            String sql = "select * from t_level where name=?";
            //建立Statement物件(每一個Statement為一次資料庫執行請求)
            stmt=connection.prepareStatement(sql);
            //設定傳入引數
            stmt.setString(1,"zhangsan");
            //執行SQL語句
            rs = stmt.executeQuery(sql);
            ResultSetMetaData metaData =rs.getMetaData();
            //處理查詢結果-----此處未做操作
            int columnCount= metaData.getColumnCount();
            System.out.println(columnCount);
        } catch (Exception e) {
            e.printStackTrace();
        }finally {
            try{
                //關閉結果集
                if(rs!=null){
                    rs.close();
                    rs=null;
                }
                //關閉執行
                if(stmt!=null){
                    stmt.close();
                    stmt=null;
                }
                if(connection!=null){
                    connection.close();
                    connection=null;
                }
            }catch(SQLException e){
                e.printStackTrace();
            }
        }
    }

傳統JDBC弊端

JDBC 底層沒有用連線池，運算元據庫需要頻繁的建立和關閉連線，消耗很大的資源；
原生的 JDBC 程式碼在 Java 中，一旦需要修改 SQL，Java 需要整體編譯，不利於系統維護；
使用 PreparedStatement 預編譯的話，對變數進行設定 1、2、3 等數位，這樣的序號不利於維護；
返回 result 結果集也需要寫死。

思考

拿JDBC測試用例和上文mybatis的測試用例對比，可以發現哪些些共同點？

    @Test
    public void test() throws IOException {
        InputStream input = Resources.getResourceAsStream("SqlSessionConfig.xml");
        SqlSessionFactory sessionFactory = new SqlSessionFactoryBuilder().build(input);
        SqlSession sqlSession = sessionFactory.openSession();
        LevelDao dao = sqlSession.getMapper(LevelDao.class);
        List<Level> all = dao.findAll();
    }

首先他們都要有資料來源，這是毋庸置疑的。其次還要有執行sql語句，再有就是執行操作。

原始碼分析

接下來進入到原始碼分析階段。

由於我們是根據官網 Building SqlSessionFactory from XML的方式來測試demo的，接下來我們的解析就按照XML檔案設定形式來講解。

獲取資料來源

資料來源4大元素包括：驅動、 url、使用者名稱、密碼。

在看程式碼之前，先看一下我們的組態檔結構。

mybatis是什麼時候獲取到資料來源的呢？要從測試方法生成SqlSessionFactory說起。

通過斷點進入到SqlSessionFactoryBuilder的build方法中，方法體就兩行關鍵程式碼，首先new了一個XML 設定生成器，接著呼叫了其parse()生成一個Configuration物件。

  public SqlSessionFactory build(Reader reader, String environment, Properties properties) {
    try {
      XMLConfigBuilder parser = new XMLConfigBuilder(reader, environment, properties);
      return build(parser.parse());
    } catch (Exception e) {
      throw ExceptionFactory.wrapException("Error building SqlSession.", e);
    } finally {
      ErrorContext.instance().reset();
      try {
        reader.close();
      } catch (IOException e) {
      }
    }
  }
  public SqlSessionFactory build(Configuration config) {
    return new DefaultSqlSessionFactory(config);
  }

parse方法執行了下面這條語句：

parseConfiguration(parser.evalNode("/configuration"));

parser.evalNode會生成一個mybatis封裝的XNode物件，copy後發現就是我們組態檔中<configuration>標籤中的內容。

進入到parseConfiguration方法中，可以看出好多方法的字串引數都和我們<configuration>標籤中的一些標籤名稱相同。沒錯，每一步都是去掃描到對應引數的標籤內容從而進行一些設定處理。

  private void parseConfiguration(XNode root) {
    try {
      //issue #117 read properties first
      propertiesElement(root.evalNode("properties"));
      Properties settings = settingsAsProperties(root.evalNode("settings"));
      loadCustomVfs(settings);
      loadCustomLogImpl(settings);
      typeAliasesElement(root.evalNode("typeAliases"));
      pluginElement(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"));
      typeHandlerElement(root.evalNode("typeHandlers"));
      mapperElement(root.evalNode("mappers"));
    } catch (Exception e) {
      throw new BuilderException("Error parsing SQL Mapper Configuration. Cause: " + e, e);
    }
  }

我們此處不研究其他處內容，直接看environmentsElement方法的內容。root.evalNode("environments")返回的XNode物件的value就是我們的environments標籤內容。

進入到environmentsElement方法中，會迴圈遍歷下一級的environment，此處便是解析xml設定多資料來源的地方。

  private void environmentsElement(XNode context) throws Exception {
    if (context != null) {
      if (environment == null) {
        environment = context.getStringAttribute("default");
      }
      //xml設定多資料來源
      for (XNode child : context.getChildren()) {
        String id = child.getStringAttribute("id");
        if (isSpecifiedEnvironment(id)) {
          TransactionFactory txFactory = transactionManagerElement(child.evalNode("transactionManager"));
          //<dataSource></dataSource>
          DataSourceFactory dsFactory = dataSourceElement(child.evalNode("dataSource"));
          //獲得到資料庫源
          DataSource dataSource = dsFactory.getDataSource();
          Environment.Builder environmentBuilder = new Environment.Builder(id)
              .transactionFactory(txFactory)
              .dataSource(dataSource);
          configuration.setEnvironment(environmentBuilder.build());
        }
      }
    }
  }

dataSourceElement方法會拿到dataSource標籤的內容生成一個DataSourceFactory ，並根據我們的設定給其屬性賦值。

通過getDataSource()方法便可以拿到我們的資料來源。

最後呼叫configuration.setEnvironment給到全域性設定中的。

執行流程圖如下：