上篇文章《深入淺出Mybatis系列(二)---配置簡(jiǎn)介(mybatis源碼篇)》我們通過(guò)對(duì)mybatis源碼的簡(jiǎn)單分析,可看出,在mybatis配置文件中,在configuration根節(jié)點(diǎn)下面,可配置properties、typeAliases、plugins、objectFactory、objectWrapperFactory、settings、environments、databaseIdProvider、typeHandlers、mappers這些節(jié)點(diǎn)。那么本次,就會(huì)先介紹properties節(jié)點(diǎn)和environments節(jié)點(diǎn)。
為了讓大家能夠更好地閱讀mybatis源碼,我先簡(jiǎn)單的給大家示例一下properties的使用方法。
<configuration><!-- 方法一: 從外部指定properties配置文件, 除了使用resource屬性指定外,還可通過(guò)url屬性指定url <properties resource="dbConfig.properties"></properties> --> <!-- 方法二: 直接配置為xml --> <properties> <property name="driver" value="com.MySQL.jdbc.Driver"/> <property name="url" value="jdbc:mysql://localhost:3306/test1"/> <property name="username" value="root"/> <property name="passWord" value="root"/> </properties>那么,我要是 兩種方法都同時(shí)用了,那么哪種方法優(yōu)先?
當(dāng)以上兩種方法都xml配置優(yōu)先, 外部指定properties配置其次。至于為什么,接下來(lái)的源碼分析會(huì)提到,請(qǐng)留意一下。
再看一下envirements元素節(jié)點(diǎn)的使用方法吧:
<environments default="development"> <environment id="development"> <transactionManager type="JDBC"/> <dataSource type="POOLED"> <!-- 如果上面沒(méi)有指定數(shù)據(jù)庫(kù)配置的properties文件,那么此處可以這樣直接配置 <property name="driver" value="com.mysql.jdbc.Driver"/> <property name="url" value="jdbc:mysql://localhost:3306/test1"/> <property name="username" value="root"/> <property name="password" value="root"/> --> <!-- 上面指定了數(shù)據(jù)庫(kù)配置文件, 配置文件里面也是對(duì)應(yīng)的這四個(gè)屬性 --> <property name="driver" value="${driver}"/> <property name="url" value="${url}"/> <property name="username" value="${username}"/> <property name="password" value="${password}"/> </dataSource> </environment> <!-- 我再指定一個(gè)environment --> <environment id="test"> <transactionManager type="JDBC"/> <dataSource type="POOLED"> <property name="driver" value="com.mysql.jdbc.Driver"/> <!-- 與上面的url不一樣 --> <property name="url" value="jdbc:mysql://localhost:3306/demo"/> <property name="username" value="root"/> <property name="password" value="root"/> </dataSource> </environment> </environments>environments元素節(jié)點(diǎn)可以配置多個(gè)environment子節(jié)點(diǎn), 怎么理解呢?
假如我們系統(tǒng)的開發(fā)環(huán)境和正式環(huán)境所用的數(shù)據(jù)庫(kù)不一樣(這是肯定的), 那么可以設(shè)置兩個(gè)environment, 兩個(gè)id分別對(duì)應(yīng)開發(fā)環(huán)境(dev)和正式環(huán)境(final),那么通過(guò)配置environments的default屬性就能選擇對(duì)應(yīng)的environment了, 例如,我將environments的deault屬性的值配置為dev, 那么就會(huì)選擇dev的environment。 至于這個(gè)是怎么實(shí)現(xiàn)的, 下面源碼就會(huì)講。
好啦,上面簡(jiǎn)單給大家介紹了一下properties 和 environments 的配置, 接下來(lái)就正式開始看源碼了:
上次我們說(shuō)過(guò)mybatis 是通過(guò)XMLConfigBuilder這個(gè)類在解析mybatis配置文件的,那么本次就接著看看XMLConfigBuilder對(duì)于properties和environments的解析:
XMLConfigBuilder:
public class XMLConfigBuilder extends BaseBuilder { private boolean parsed; //xml解析器 private XPathParser parser; private String environment; //上次說(shuō)到這個(gè)方法是在解析mybatis配置文件中能配置的元素節(jié)點(diǎn) //今天首先要看的就是properties節(jié)點(diǎn)和environments節(jié)點(diǎn) private void parseConfiguration(XNode root) { try { //解析properties元素 propertiesElement(root.evalNode("properties")); //issue #117 read properties first typeAliasesElement(root.evalNode("typeAliases")); pluginElement(root.evalNode("plugins")); objectFactoryElement(root.evalNode("objectFactory")); objectWrapperFactoryElement(root.evalNode("objectWrapperFactory")); settingsElement(root.evalNode("settings")); //解析environments元素 environmentsElement(root.evalNode("environments")); // read it after objectFactory and objectWrapperFactory issue #631 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); } } //下面就看看解析properties的具體方法 private void propertiesElement(XNode context) throws Exception { if (context != null) { //將子節(jié)點(diǎn)的 name 以及value屬性set進(jìn)properties對(duì)象 //這兒可以注意一下順序,xml配置優(yōu)先, 外部指定properties配置其次 Properties defaults = context.getChildrenasproperties(); //獲取properties節(jié)點(diǎn)上 resource屬性的值 String resource = context.getStringAttribute("resource"); //獲取properties節(jié)點(diǎn)上 url屬性的值, resource和url不能同時(shí)配置 String url = context.getStringAttribute("url"); if (resource != null && url != null) { throw new BuilderException("The properties element cannot specify both a URL and a resource based property file reference. Please specify one or the other."); } //把解析出的properties文件set進(jìn)Properties對(duì)象 if (resource != null) { defaults.putAll(Resources.getResourceAsProperties(resource)); } else if (url != null) { defaults.putAll(Resources.getUrlAsProperties(url)); } //將configuration對(duì)象中已配置的Properties屬性與剛剛解析的融合 //configuration這個(gè)對(duì)象會(huì)裝載所解析mybatis配置文件的所有節(jié)點(diǎn)元素,以后也會(huì)頻頻提到這個(gè)對(duì)象 //既然configuration對(duì)象用有一系列的get/set方法, 那是否就標(biāo)志著我們可以使用java代碼直接配置? //答案是肯定的, 不過(guò)使用配置文件進(jìn)行配置,優(yōu)勢(shì)不言而喻 Properties vars = configuration.getVariables(); if (vars != null) { defaults.putAll(vars); } //把裝有解析配置propertis對(duì)象set進(jìn)解析器, 因?yàn)楹竺婵赡軙?huì)用到 parser.setVariables(defaults); //set進(jìn)configuration對(duì)象 configuration.setVariables(defaults); } } //下面再看看解析enviroments元素節(jié)點(diǎn)的方法 private void environmentsElement(XNode context) throws Exception { if (context != null) { if (environment == null) { //解析environments節(jié)點(diǎn)的default屬性的值 //例如: <environments default="development"> environment = context.getStringAttribute("default"); } //遞歸解析environments子節(jié)點(diǎn) for (XNode child : context.getChildren()) { //<environment id="development">, 只有enviroment節(jié)點(diǎn)有id屬性,那么這個(gè)屬性有何作用? //environments 節(jié)點(diǎn)下可以擁有多個(gè) environment子節(jié)點(diǎn) //類似于這樣: <environments default="development"><environment id="development">...</environment><environment id="test">...</environments> //意思就是我們可以對(duì)應(yīng)多個(gè)環(huán)境,比如開發(fā)環(huán)境,測(cè)試環(huán)境等, 由environments的default屬性去選擇對(duì)應(yīng)的enviroment String id = child.getStringAttribute("id"); //isSpecial就是根據(jù)由environments的default屬性去選擇對(duì)應(yīng)的enviroment if (isSpecifiedEnvironment(id)) { //事務(wù), mybatis有兩種:JDBC 和 MANAGED, 配置為JDBC則直接使用JDBC的事務(wù),配置為MANAGED則是將事務(wù)托管給容器, TransactionFactory txFactory = transactionManagerElement(child.evalNode("transactionManager")); //enviroment節(jié)點(diǎn)下面就是dataSource節(jié)點(diǎn)了,解析dataSource節(jié)點(diǎn)(下面會(huì)貼出解析dataSource的具體方法) DataSourceFactory dsFactory = dataSourceElement(child.evalNode("dataSource")); DataSource dataSource = dsFactory.getDataSource(); Environment.Builder environmentBuilder = new Environment.Builder(id) .transactionFactory(txFactory) .dataSource(dataSource); //老規(guī)矩,會(huì)將dataSource設(shè)置進(jìn)configuration對(duì)象 configuration.setEnvironment(environmentBuilder.build()); } } } } //下面看看dataSource的解析方法 private DataSourceFactory dataSourceElement(XNode context) throws Exception { if (context != null) { //dataSource的連接池 String type = context.getStringAttribute("type"); //子節(jié)點(diǎn) name, value屬性set進(jìn)一個(gè)properties對(duì)象 Properties props = context.getChildrenAsProperties(); //創(chuàng)建dataSourceFactory DataSourceFactory factory = (DataSourceFactory) resolveClass(type).newInstance(); factory.setProperties(props); return factory; } throw new BuilderException("Environment declaration requires a DataSourceFactory."); } }通過(guò)以上對(duì)mybatis源碼的解讀,相信大家對(duì)mybatis的配置又有了一個(gè)深入的認(rèn)識(shí)。
還有一個(gè)問(wèn)題, 上面我們看到,在配置dataSource的時(shí)候使用了 ${driver} 這種表達(dá)式, 這種形式是怎么解析的?其實(shí),是通過(guò)PropertyParser這個(gè)類解析:
PropertyParser:
/** * 這個(gè)類解析${}這種形式的表達(dá)式 */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 + "}"; } }}好啦,以上就是對(duì)于properties 和 environments元素節(jié)點(diǎn)的分析,比較重要的都在對(duì)于源碼的注釋中標(biāo)出。本次文章到此結(jié)束,接下來(lái)的文章會(huì)繼續(xù)分析其他節(jié)點(diǎn)的配置。
新聞熱點(diǎn)
疑難解答
圖片精選
網(wǎng)友關(guān)注