MyBatis.2剖析

JAVA就業套餐課：https://edu.csdn.net/combo/detail/1230

上次給你們介紹了一下properties 和 environments 的配置， 接下來就正式開始看源碼了：

上次例子中，咱們以 SqlSessionFactoryBuilder 去建立 SqlSessionFactory,  那麼，咱們就先從SqlSessionFactoryBuilder入手， 我們先看看源碼是怎麼實現的：

SqlSessionFactoryBuilder源碼片斷：

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41

1 public class SqlSessionFactoryBuilder {   2   3   //Reader讀取mybatis配置文件，傳入構造方法   4   //除了Reader外，其實還有對應的inputStream做爲參數的構造方法，   5   //這也體現了mybatis配置的靈活性   6   public SqlSessionFactory build(Reader reader) {   7     return build(reader, null , null );   8   }   9 10   public SqlSessionFactory build(Reader reader, String environment) { 11     return build(reader, environment, null ); 12   } 13   14   //mybatis配置文件 + properties, 此時mybatis配置文件中能夠不配置properties，也能使用${}形式 15   public SqlSessionFactory build(Reader reader, Properties properties) { 16     return build(reader, null , properties); 17   } 18   19   //經過XMLConfigBuilder解析mybatis配置，而後建立SqlSessionFactory對象 20   public SqlSessionFactory build(Reader reader, String environment, Properties properties) { 21     try { 22       XMLConfigBuilder parser = new XMLConfigBuilder(reader, environment, properties); 23       //下面看看這個方法的源碼 24       return build(parser.parse()); 25     } catch (Exception e) { 26       throw ExceptionFactory.wrapException( "Error building SqlSession." , e); 27     } finally { 28       ErrorContext.instance().reset(); 29       try { 30         reader.close(); 31       } catch (IOException e) { 32         // Intentionally ignore. Prefer previous error. 33       } 34     } 35   } 36 37   public SqlSessionFactory build(Configuration config) { 38     return new DefaultSqlSessionFactory(config); 39   } 40 41 }

經過源碼，咱們能夠看到SqlSessionFactoryBuilder 經過XMLConfigBuilder 去解析咱們傳入的mybatis的配置文件， 下面就接着看看 XMLConfigBuilder 部分源碼：

 

　　咱們說過mybatis 是經過XMLConfigBuilder這個類在解析mybatis配置文件的，那麼本次就接着看看XMLConfigBuilder對於properties和environments的解析：

 

XMLConfigBuilder：

1 public class XMLConfigBuilder extends BaseBuilder {23     private boolean parsed;4     //xml解析器5     private XPathParser parser;6     private String environment;78     //上次說到這個方法是在解析mybatis配置文件中能配置的元素節點9     //今天首先要看的就是properties節點和environments節點10     private void parseConfiguration(XNode root) {11         try {12           //解析properties元素13           propertiesElement(root.evalNode("properties")); //issue #117 read properties first14           typeAliasesElement(root.evalNode("typeAliases"));15           pluginElement(root.evalNode("plugins"));16           objectFactoryElement(root.evalNode("objectFactory"));17           objectWrapperFactoryElement(root.evalNode("objectWrapperFactory"));18           settingsElement(root.evalNode("settings"));19           //解析environments元素20           environmentsElement(root.evalNode("environments")); // read it after objectFactory and objectWrapperFactory issue #63121           databaseIdProviderElement(root.evalNode("databaseIdProvider"));22           typeHandlerElement(root.evalNode("typeHandlers"));23           mapperElement(root.evalNode("mappers"));24         } catch (Exception e) {25           throw new BuilderException("Error parsing SQL Mapper Configuration. Cause: " + e, e);26         }27     }282930     //下面就看看解析properties的具體方法31     private void propertiesElement(XNode context) throws Exception {32         if (context != null) {33           //將子節點的 name 以及value屬性set進properties對象34           //這兒能夠注意一下順序，xml配置優先， 外部指定properties配置其次35           Properties defaults = context.getChildrenAsProperties();36           //獲取properties節點上 resource屬性的值37           String resource = context.getStringAttribute("resource");38           //獲取properties節點上 url屬性的值, resource和url不能同時配置39           String url = context.getStringAttribute("url");40           if (resource != null && url != null) {41             throw new BuilderException("The properties element cannot specify both a URL and a resource based property file reference.  Please specify one or the other.");42           }43           //把解析出的properties文件set進Properties對象44           if (resource != null) {45             defaults.putAll(Resources.getResourceAsProperties(resource));46           } else if (url != null) {47             defaults.putAll(Resources.getUrlAsProperties(url));48           }49           //將configuration對象中已配置的Properties屬性與剛剛解析的融合50           //configuration這個對象會裝載所解析mybatis配置文件的全部節點元素，之後也會頻頻提到這個對象51           //既然configuration對象用有一系列的get/set方法， 那是否就標誌着咱們可使用java代碼直接配置？52           //答案是確定的， 不過使用配置文件進行配置，優點不言而喻53           Properties vars = configuration.getVariables();54           if (vars != null) {55             defaults.putAll(vars);56           }57           //把裝有解析配置propertis對象set進解析器， 由於後面可能會用到58           parser.setVariables(defaults);59           //set進configuration對象60           configuration.setVariables(defaults);61         }62     }6364     //下面再看看解析enviroments元素節點的方法65     private void environmentsElement(XNode context) throws Exception {66         if (context != null) {67             if (environment == null) {68                 //解析environments節點的default屬性的值69                 //例如: <environments default="development">70                 environment = context.getStringAttribute("default");71             }72             //遞歸解析environments子節點73             for (XNode child : context.getChildren()) {74                 //<environment id="development">, 只有enviroment節點有id屬性，那麼這個屬性有何做用？75                 //environments 節點下能夠擁有多個 environment子節點76                 //相似於這樣： <environments default="development"><environment id="development">...</environment><environment id="test">...</environments>77                 //意思就是咱們能夠對應多個環境，好比開發環境，測試環境等， 由environments的default屬性去選擇對應的enviroment78                 String id = child.getStringAttribute("id");79                 //isSpecial就是根據由environments的default屬性去選擇對應的enviroment80                 if (isSpecifiedEnvironment(id)) {81                     //事務， mybatis有兩種：JDBC 和 MANAGED, 配置爲JDBC則直接使用JDBC的事務，配置爲MANAGED則是將事務託管給容器，82                     TransactionFactory txFactory = transactionManagerElement(child.evalNode("transactionManager"));83                     //enviroment節點下面就是dataSource節點了，解析dataSource節點（下面會貼出解析dataSource的具體方法）84                     DataSourceFactory dsFactory = dataSourceElement(child.evalNode("dataSource"));85                     DataSource dataSource = dsFactory.getDataSource();86                     Environment.Builder environmentBuilder = new Environment.Builder(id)87                           .transactionFactory(txFactory)88                           .dataSource(dataSource);89                     //老規矩，會將dataSource設置進configuration對象90                     configuration.setEnvironment(environmentBuilder.build());91                 }92             }93         }94     }9596     //下面看看dataSource的解析方法97     private DataSourceFactory dataSourceElement(XNode context) throws Exception {98         if (context != null) {99             //dataSource的鏈接池100             String type = context.getStringAttribute("type");101             //子節點 name, value屬性set進一個properties對象102             Properties props = context.getChildrenAsProperties();103             //建立dataSourceFactory104             DataSourceFactory factory = (DataSourceFactory) resolveClass(type).newInstance();105             factory.setProperties(props);106             return factory;107         }108         throw new BuilderException("Environment declaration requires a DataSourceFactory.");109     }110 }

　　經過以上對mybatis源碼的解讀，相信你們對mybatis的配置又有了一個深刻的認識。

　　還有一個問題， 上面咱們看到，在配置dataSource的時候使用了 ${driver} 這種表達式， 這種形式是怎麼解析的？其實，是經過PropertyParser這個類解析：

PropertyParser：

/*** 這個類解析${}這種形式的表達式*/public class PropertyParser {public static String parse(String string, Properties variables) {VariableTokenHandler handler = new VariableTokenHandler(variables);GenericTokenParser parser = new GenericTokenParser("${", "}", handler);return parser.parse(string);}private static class VariableTokenHandler implements TokenHandler {private Properties variables;public VariableTokenHandler(Properties variables) {this.variables = variables;}public String handleToken(String content) {if (variables != null && variables.containsKey(content)) {return variables.getProperty(content);}return "${" + content + "}";}}}

好啦，以上就是對於properties 和 environments元素節點的分析，比較重要的都在對於源碼的註釋中標出。本次文章到此結束，接下來的文章會繼續分析其餘節點的配置。

 

經過以上源碼，咱們就能看出，在mybatis的配置文件中：

1. configuration節點爲根節點。

2. 在configuration節點之下，咱們能夠配置10個子節點， 分別爲：properties、typeAliases、plugins、objectFactory、objectWrapperFactory、settings、environments、databaseIdProvider、typeHandlers、mappers。

上次對於配置文件的方式是使用的是外部文件方式，若是不用外部文件，則可使用下面的方式；

 

<?xml version="1.0" encoding="UTF-8"?><!DOCTYPE configuration  PUBLIC "-//mybatis.org//DTD Config 3.0//EN"  "http://mybatis.org/dtd/mybatis-3-config.dtd"><configuration>  	<environments default="development">  <environment id="development">  <transactionManager type="JDBC" />  <dataSource type="POOLED"> <property name="driver" value="com.microsoft.sqlserver.jdbc.SQLServerDriver"/>			<property name="url" value="jdbc:sqlserver://localhost:1433;DatabaseName=mydb"/>			<property name="username" value="sa"/>			<property name="password" value="1"/></dataSource>  </environment> </environments>  <mappers>  <mapper resource="org/mybatis/example/dao/DeptMapper.xml"/>  </mappers>  </configuration>