轉(zhuǎn)載自??mybatis源碼閱讀(二)：mybatis初始化上

1.初始化入口

//Mybatis 通過(guò)SqlSessionFactory獲取SqlSession, 然后才能通過(guò)SqlSession與數(shù)據(jù)庫(kù)進(jìn)行交互 private static SqlSessionFactory getSessionFactory() {SqlSessionFactory sessionFactory = null;String resource = "configuration.xml";try {sessionFactory = new SqlSessionFactoryBuilder().build(Resources.getResourceAsReader(resource));} catch (IOException e) {e.printStackTrace();}return sessionFactory; }

那么，我們就先從SqlSessionFactoryBuilder入手， 咱們先看看源碼是怎么實(shí)現(xiàn)的

SqlSessionFactoryBuilder

public SqlSessionFactory build(InputStream inputStream, String environment, Properties properties) {try {// 讀取配置文件XMLConfigBuilder parser = new XMLConfigBuilder(inputStream, environment, properties);//解析配置得到Configuration對(duì)象，創(chuàng)建DefaultSqlSessionFactory對(duì)象return build(parser.parse());} catch (Exception e) {throw ExceptionFactory.wrapException("Error building SqlSession.", e);} finally {//關(guān)閉讀取配置文件的輸入流對(duì)象ErrorContext.instance().reset();try {inputStream.close();} catch (IOException e) {// Intentionally ignore. Prefer previous error.}} }

XMLConfigBuilder

XMLConfigBuilder是BaseBuilder的眾多子類之一，核心字段如下

//表示是否已經(jīng)解析過(guò)了 private boolean parsed; //用于解析配置文件的對(duì)象 private final XPathParser parser; //配置文件中表示<environment>的名稱 默認(rèn)讀取default屬性 private String environment; // 負(fù)責(zé)和創(chuàng)建Reflector對(duì)象 private final ReflectorFactory localReflectorFactory = new DefaultReflectorFactory();

XMLConfigBuilder.parse()方法是解析mybatis-config.xml配置文件的如。它調(diào)用parseConfiguration（）方法實(shí)現(xiàn)整個(gè)解析過(guò)程。具體實(shí)現(xiàn)如下：

/*** 解析配置文件的入口* @return*/ public Configuration parse() {if (parsed) {throw new BuilderException("Each XMLConfigBuilder can only be used once.");}parsed = true;parseConfiguration(parser.evalNode("/configuration"));return configuration; }/*** 對(duì)配置文件每個(gè)節(jié)點(diǎn)具體的解析過(guò)程* configuration節(jié)點(diǎn)為根節(jié)點(diǎn)。* 在configuration節(jié)點(diǎn)之下，我們可以配置11 個(gè)子節(jié)點(diǎn)，* 分別為：properties、settings、typeAliases、plugins、objectFactory、objectWrapperFactory、reflectorFactory、* environments、databaseIdProvider、typeHandlers、mappers。* @param root 根節(jié)點(diǎn)*/ private void parseConfiguration(XNode root) {try {// 解析properties節(jié)點(diǎn)propertiesElement(root.evalNode("properties"));//解析settings節(jié)點(diǎn)Properties settings = settingsAsProperties(root.evalNode("settings"));loadCustomVfs(settings);//設(shè)置vfsImpl字段//解析typeAliases節(jié)點(diǎn)typeAliasesElement(root.evalNode("typeAliases"));//解析plugins節(jié)點(diǎn)pluginElement(root.evalNode("plugins"));//解析objectFactory節(jié)點(diǎn)objectFactoryElement(root.evalNode("objectFactory"));//解析objectWrapperFactory節(jié)點(diǎn)objectWrapperFactoryElement(root.evalNode("objectWrapperFactory"));//解析reflectorFactory節(jié)點(diǎn)reflectorFactoryElement(root.evalNode("reflectorFactory"));settingsElement(settings);//解析environments節(jié)點(diǎn)environmentsElement(root.evalNode("environments"));//解析databaseIdProvider節(jié)點(diǎn)databaseIdProviderElement(root.evalNode("databaseIdProvider"));//解析typeHandlers節(jié)點(diǎn)typeHandlerElement(root.evalNode("typeHandlers"));//解析mappers節(jié)點(diǎn)mapperElement(root.evalNode("mappers"));} catch (Exception e) {throw new BuilderException("Error parsing SQL Mapper Configuration. Cause: " + e, e);} }

propertiesElement()方法會(huì)解析配置文件中的properties節(jié)點(diǎn)并形成Java.util.Properties對(duì)象，之后將改對(duì)象設(shè)置到XpathParse和Configguration的variables字段中，占位符就是用Properties中的信息替換的，具體實(shí)現(xiàn)如下：

/*** 解析properties的具體方法* @param context* @throws Exception*/ 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) {//url 和resource不能同時(shí)配置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ì)象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);} }

settings節(jié)點(diǎn)下的配飾是mybatis的全局性配置，修改的是configuration對(duì)象的屬性，具體說(shuō)明參考官方文檔

/*** settings標(biāo)簽就是設(shè)置configuration對(duì)象的各種屬性，* 具體屬性說(shuō)明可以參考mybatis官方文檔* @param props* @throws Exception*/ private void settingsElement(Properties props) throws Exception {configuration.setAutoMappingBehavior(AutoMappingBehavior.valueOf(props.getProperty("autoMappingBehavior", "PARTIAL")));configuration.setAutoMappingUnknownColumnBehavior(AutoMappingUnknownColumnBehavior.valueOf(props.getProperty("autoMappingUnknownColumnBehavior", "NONE")));configuration.setCacheEnabled(booleanValueOf(props.getProperty("cacheEnabled"), true));configuration.setProxyFactory((ProxyFactory) createInstance(props.getProperty("proxyFactory")));configuration.setLazyLoadingEnabled(booleanValueOf(props.getProperty("lazyLoadingEnabled"), false));configuration.setAggressiveLazyLoading(booleanValueOf(props.getProperty("aggressiveLazyLoading"), false));configuration.setMultipleResultSetsEnabled(booleanValueOf(props.getProperty("multipleResultSetsEnabled"), true));configuration.setUseColumnLabel(booleanValueOf(props.getProperty("useColumnLabel"), true));configuration.setUseGeneratedKeys(booleanValueOf(props.getProperty("useGeneratedKeys"), false));configuration.setDefaultExecutorType(ExecutorType.valueOf(props.getProperty("defaultExecutorType", "SIMPLE")));configuration.setDefaultStatementTimeout(integerValueOf(props.getProperty("defaultStatementTimeout"), null));configuration.setDefaultFetchSize(integerValueOf(props.getProperty("defaultFetchSize"), null));configuration.setMapUnderscoreToCamelCase(booleanValueOf(props.getProperty("mapUnderscoreToCamelCase"), false));configuration.setSafeRowBoundsEnabled(booleanValueOf(props.getProperty("safeRowBoundsEnabled"), false));configuration.setLocalCacheScope(LocalCacheScope.valueOf(props.getProperty("localCacheScope", "SESSION")));configuration.setJdbcTypeForNull(JdbcType.valueOf(props.getProperty("jdbcTypeForNull", "OTHER")));configuration.setLazyLoadTriggerMethods(stringSetValueOf(props.getProperty("lazyLoadTriggerMethods"), "equals,clone,hashCode,toString"));configuration.setSafeResultHandlerEnabled(booleanValueOf(props.getProperty("safeResultHandlerEnabled"), true));configuration.setDefaultScriptingLanguage(resolveClass(props.getProperty("defaultScriptingLanguage")));@SuppressWarnings("unchecked")Class<? extends TypeHandler> typeHandler = (Class<? extends TypeHandler>)resolveClass(props.getProperty("defaultEnumTypeHandler"));configuration.setDefaultEnumTypeHandler(typeHandler);configuration.setCallSettersOnNulls(booleanValueOf(props.getProperty("callSettersOnNulls"), false));configuration.setUseActualParamName(booleanValueOf(props.getProperty("useActualParamName"), true));configuration.setReturnInstanceForEmptyRow(booleanValueOf(props.getProperty("returnInstanceForEmptyRow"), false));configuration.setLogPrefix(props.getProperty("logPrefix"));@SuppressWarnings("unchecked")Class<? extends Log> logImpl = (Class<? extends Log>)resolveClass(props.getProperty("logImpl"));configuration.setLogImpl(logImpl);configuration.setConfigurationFactory(resolveClass(props.getProperty("configurationFactory"))); }

environments元素節(jié)點(diǎn)主要配置數(shù)據(jù)庫(kù)事物，數(shù)據(jù)源。可以配置多個(gè)environment子節(jié)點(diǎn)，假如我們系統(tǒng)的開(kāi)發(fā)環(huán)境和正式環(huán)境所用的數(shù)據(jù)庫(kù)不一樣（這是肯定的）， 那么可以設(shè)置兩個(gè)environment, 兩個(gè)id分別對(duì)應(yīng)開(kāi)發(fā)環(huán)境（development）和正式環(huán)境（final），那么通過(guò)配置environments的default屬性就能選擇對(duì)應(yīng)的environment了， 例如，我將environments的deault屬性的值配置為development, 那么就會(huì)選擇dev的environment。具體實(shí)現(xiàn)如下

/*** 解析enviroments元素節(jié)點(diǎn)的方法* @param context* @throws Exception*/ private void environmentsElement(XNode context) throws Exception {if (context != null) {if (environment == null) {//獲取 <environments default="development"> 中的default值environment = context.getStringAttribute("default");}// 循環(huán)environments的子節(jié)點(diǎn)for (XNode child : context.getChildren()) {// 獲取 <environment id="development"> z中的idString id = child.getStringAttribute("id");if (isSpecifiedEnvironment(id)) {//根據(jù)由environments的default屬性去選擇對(duì)應(yīng)的enviroment// 事物 mybatis有兩種：JDBC 和 MANAGED, 配置為JDBC則直接使用JDBC的事務(wù)，配置為MANAGED則是將事務(wù)托管給容器// <transactionManager type="JDBC"/>TransactionFactory txFactory = transactionManagerElement(child.evalNode("transactionManager"));//enviroment節(jié)點(diǎn)下面就是dataSource節(jié)點(diǎn)了，解析dataSource節(jié)點(diǎn)DataSourceFactory dsFactory = dataSourceElement(child.evalNode("dataSource"));DataSource dataSource = dsFactory.getDataSource();Environment.Builder environmentBuilder = new Environment.Builder(id).transactionFactory(txFactory).dataSource(dataSource);// 將dataSource設(shè)置進(jìn)configuration對(duì)象configuration.setEnvironment(environmentBuilder.build());}}} }

typeAliases節(jié)點(diǎn)主要用來(lái)設(shè)置別名，其實(shí)這是挺好用的一個(gè)功能， 通過(guò)配置別名，我們不用再指定完整的包名

/*** 解析typeAliases 節(jié)點(diǎn)* <typeAliases>* <!--<package name="com.lpf.entity"></package>-->* <typeAlias alias="UserEntity" type="com.lpf.entity.User"/>* </typeAliases>* @param parent*/ private void typeAliasesElement(XNode parent) {if (parent != null) {for (XNode child : parent.getChildren()) {//如果子節(jié)點(diǎn)是package, 那么就獲取package節(jié)點(diǎn)的name屬性， mybatis會(huì)掃描指定的packageif ("package".equals(child.getName())) {String typeAliasPackage = child.getStringAttribute("name");//TypeAliasRegistry 負(fù)責(zé)管理別名， 這兒就是通過(guò)TypeAliasRegistry 進(jìn)行別名注冊(cè)configuration.getTypeAliasRegistry().registerAliases(typeAliasPackage);} else {//如果子節(jié)點(diǎn)是typeAlias節(jié)點(diǎn)，那么就獲取alias屬性和type的屬性值String alias = child.getStringAttribute("alias");String type = child.getStringAttribute("type");try {Class<?> clazz = Resources.classForName(type);if (alias == null) {typeAliasRegistry.registerAlias(clazz);} else {typeAliasRegistry.registerAlias(alias, clazz);}} catch (ClassNotFoundException e) {throw new BuilderException("Error registering typeAlias for '" + alias + "'. Cause: " + e, e);}}}} }

具體的別名注冊(cè)類

public class TypeAliasRegistry {// 別名通過(guò)一個(gè)HashMap來(lái)實(shí)現(xiàn)， key為別名， value就是別名對(duì)應(yīng)的類型（class對(duì)象）private final Map<String, Class<?>> TYPE_ALIASES = new HashMap<String, Class<?>>();/*** mybatis默認(rèn)為我們注冊(cè)的別名*/public TypeAliasRegistry() {registerAlias("string", String.class);registerAlias("byte", Byte.class);registerAlias("long", Long.class);registerAlias("short", Short.class);registerAlias("int", Integer.class);registerAlias("integer", Integer.class);registerAlias("double", Double.class);registerAlias("float", Float.class);registerAlias("boolean", Boolean.class);registerAlias("byte[]", Byte[].class);registerAlias("long[]", Long[].class);registerAlias("short[]", Short[].class);registerAlias("int[]", Integer[].class);registerAlias("integer[]", Integer[].class);registerAlias("double[]", Double[].class);registerAlias("float[]", Float[].class);registerAlias("boolean[]", Boolean[].class);registerAlias("_byte", byte.class);registerAlias("_long", long.class);registerAlias("_short", short.class);registerAlias("_int", int.class);registerAlias("_integer", int.class);registerAlias("_double", double.class);registerAlias("_float", float.class);registerAlias("_boolean", boolean.class);registerAlias("_byte[]", byte[].class);registerAlias("_long[]", long[].class);registerAlias("_short[]", short[].class);registerAlias("_int[]", int[].class);registerAlias("_integer[]", int[].class);registerAlias("_double[]", double[].class);registerAlias("_float[]", float[].class);registerAlias("_boolean[]", boolean[].class);registerAlias("date", Date.class);registerAlias("decimal", BigDecimal.class);registerAlias("bigdecimal", BigDecimal.class);registerAlias("biginteger", BigInteger.class);registerAlias("object", Object.class);registerAlias("date[]", Date[].class);registerAlias("decimal[]", BigDecimal[].class);registerAlias("bigdecimal[]", BigDecimal[].class);registerAlias("biginteger[]", BigInteger[].class);registerAlias("object[]", Object[].class);registerAlias("map", Map.class);registerAlias("hashmap", HashMap.class);registerAlias("list", List.class);registerAlias("arraylist", ArrayList.class);registerAlias("collection", Collection.class);registerAlias("iterator", Iterator.class);registerAlias("ResultSet", ResultSet.class);}/*** 處理別名， 直接從保存有別名的hashMap中取出即可*/@SuppressWarnings("unchecked")// throws class cast exception as well if types cannot be assignedpublic <T> Class<T> resolveAlias(String string) {try {if (string == null) {return null;}// issue #748String key = string.toLowerCase(Locale.ENGLISH);Class<T> value;if (TYPE_ALIASES.containsKey(key)) {value = (Class<T>) TYPE_ALIASES.get(key);} else {value = (Class<T>) Resources.classForName(string);}return value;} catch (ClassNotFoundException e) {throw new TypeException("Could not resolve type alias '" + string + "'. Cause: " + e, e);}}/*** 配置文件中配置為package的時(shí)候，掃描包下的Javabean ，然后自動(dòng)注冊(cè)別名* 默認(rèn)會(huì)使用 Bean 的首字母小寫的非限定類名來(lái)作為它的別名* 也可在javabean 加上注解@Alias 來(lái)自定義別名， 例如： @Alias(user)*/public void registerAliases(String packageName){registerAliases(packageName, Object.class);}public void registerAliases(String packageName, Class<?> superType){ResolverUtil<Class<?>> resolverUtil = new ResolverUtil<Class<?>>();resolverUtil.find(new ResolverUtil.IsA(superType), packageName);Set<Class<? extends Class<?>>> typeSet = resolverUtil.getClasses();for(Class<?> type : typeSet){// Ignore inner classes and interfaces (including package-info.java)// Skip also inner classes. See issue #6if (!type.isAnonymousClass() && !type.isInterface() && !type.isMemberClass()) {registerAlias(type);}}}public void registerAlias(Class<?> type) {String alias = type.getSimpleName();Alias aliasAnnotation = type.getAnnotation(Alias.class);if (aliasAnnotation != null) {alias = aliasAnnotation.value();} registerAlias(alias, type);}//向hashMap中注冊(cè)別名public void registerAlias(String alias, Class<?> value) {if (alias == null) {throw new TypeException("The parameter alias cannot be null");}// issue #748String key = alias.toLowerCase(Locale.ENGLISH);if (TYPE_ALIASES.containsKey(key) && TYPE_ALIASES.get(key) != null && !TYPE_ALIASES.get(key).equals(value)) {throw new TypeException("The alias '" + alias + "' is already mapped to the value '" + TYPE_ALIASES.get(key).getName() + "'.");}TYPE_ALIASES.put(key, value);}public void registerAlias(String alias, String value) {try {registerAlias(alias, Resources.classForName(value));} catch (ClassNotFoundException e) {throw new TypeException("Error registering type alias "+alias+" for "+value+". Cause: " + e, e);}}/*** 獲取保存別名的HashMap, Configuration對(duì)象持有對(duì)TypeAliasRegistry的引用，* 因此，如果需要，我們可以通過(guò)Configuration對(duì)象獲取*/public Map<String, Class<?>> getTypeAliases() {return Collections.unmodifiableMap(TYPE_ALIASES);}}

typeHandlers節(jié)點(diǎn)的解析和typeAlianses節(jié)點(diǎn)的解析類似

/*** 解析typeHandlers節(jié)點(diǎn)* 無(wú)論是 MyBatis 在預(yù)處理語(yǔ)句（PreparedStatement）中設(shè)置一個(gè)參數(shù)時(shí)，* 還是從結(jié)果集中取出一個(gè)值時(shí)，都會(huì)用類型處理器將獲取的值以合適的方式轉(zhuǎn)換成 Java 類型。* Mybatis默認(rèn)為我們實(shí)現(xiàn)了許多TypeHandler, 當(dāng)我們沒(méi)有配置指定TypeHandler時(shí)，* Mybatis會(huì)根據(jù)參數(shù)或者返回結(jié)果的不同，默認(rèn)為我們選擇合適的TypeHandler處理。* @param parent* @throws Exception*/ private void typeHandlerElement(XNode parent) throws Exception {if (parent != null) {for (XNode child : parent.getChildren()) {//子節(jié)點(diǎn)為package時(shí)，獲取其name屬性的值，然后自動(dòng)掃描package下的自定義typeHandlerif ("package".equals(child.getName())) {String typeHandlerPackage = child.getStringAttribute("name");typeHandlerRegistry.register(typeHandlerPackage);} else {//子節(jié)點(diǎn)為typeHandler時(shí)， 可以指定javaType屬性， 也可以指定jdbcType, 也可兩者都指定//javaType 是指定java類型//jdbcType 是指定jdbc類型（數(shù)據(jù)庫(kù)類型： 如varchar）String javaTypeName = child.getStringAttribute("javaType");String jdbcTypeName = child.getStringAttribute("jdbcType");//handler就是我們配置的typeHandlerString handlerTypeName = child.getStringAttribute("handler");Class<?> javaTypeClass = resolveClass(javaTypeName);//JdbcType是一個(gè)枚舉類型，resolveJdbcType方法是在獲取枚舉類型的值JdbcType jdbcType = resolveJdbcType(jdbcTypeName);Class<?> typeHandlerClass = resolveClass(handlerTypeName);//注冊(cè)typeHandler, typeHandler通過(guò)TypeHandlerRegistry這個(gè)類管理if (javaTypeClass != null) {if (jdbcType == null) {typeHandlerRegistry.register(javaTypeClass, typeHandlerClass);} else {typeHandlerRegistry.register(javaTypeClass, jdbcType, typeHandlerClass);}} else {typeHandlerRegistry.register(typeHandlerClass);}}}} }

插件是mybatis提供的擴(kuò)展機(jī)制，用戶可以通過(guò)添加自定義插件在SQL語(yǔ)句執(zhí)行的過(guò)程中某一環(huán)節(jié)進(jìn)行攔截，mybatis中的自定義插件只需實(shí)現(xiàn)Interceptor接口，并通過(guò)注解指定攔截的方法簽名，這個(gè)后面具體介紹。

/*** 解析plugins標(biāo)簽* mybatis中的plugin其實(shí)就是個(gè)interceptor，* 它可以攔截Executor 、ParameterHandler 、ResultSetHandler 、StatementHandler 的部分方法，處理我們自己的邏輯。* @param parent* @throws Exception*/ private void pluginElement(XNode parent) throws Exception {if (parent != null) {for (XNode child : parent.getChildren()) {String interceptor = child.getStringAttribute("interceptor");Properties properties = child.getChildrenAsProperties();// 我們?cè)诙x一個(gè)interceptor的時(shí)候，需要去實(shí)現(xiàn)InterceptorInterceptor interceptorInstance = (Interceptor) resolveClass(interceptor).newInstance();interceptorInstance.setProperties(properties);// 向configuration對(duì)象中注冊(cè)攔截器configuration.addInterceptor(interceptorInstance);}} }

mybatis初始化時(shí)，出了加載mybatis-config.xml的全局配置文件，還會(huì)加載全部的映射配置文件，即mappers節(jié)點(diǎn)配置的mapper.

/*** 解析mapper文件，mapper可以理解為dao的實(shí)現(xiàn)* @param parent* @throws Exception*/ private void mapperElement(XNode parent) throws Exception {if (parent != null) {for (XNode child : parent.getChildren()) {//如果mappers節(jié)點(diǎn)的子節(jié)點(diǎn)是package, 那么就掃描package下的文件, 注入進(jìn)configurationif ("package".equals(child.getName())) {String mapperPackage = child.getStringAttribute("name");configuration.addMappers(mapperPackage);} else {String resource = child.getStringAttribute("resource");String url = child.getStringAttribute("url");String mapperClass = child.getStringAttribute("class");//resource, url, class 三選一if (resource != null && url == null && mapperClass == null) {ErrorContext.instance().resource(resource);InputStream inputStream = Resources.getResourceAsStream(resource);//mapper映射文件都是通過(guò)XMLMapperBuilder解析XMLMapperBuilder mapperParser = new XMLMapperBuilder(inputStream, configuration, resource, configuration.getSqlFragments());mapperParser.parse();} else if (resource == null && url != null && mapperClass == null) {ErrorContext.instance().resource(url);InputStream inputStream = Resources.getUrlAsStream(url);//同上XMLMapperBuilder mapperParser = new XMLMapperBuilder(inputStream, configuration, url, configuration.getSqlFragments());mapperParser.parse();} else if (resource == null && url == null && mapperClass != null) {Class<?> mapperInterface = Resources.classForName(mapperClass);configuration.addMapper(mapperInterface);} else {throw new BuilderException("A mapper element may only specify a url, resource or class, but not more than one.");}}}} }

mybatis初始化過(guò)程中對(duì)mybatis-config.xml配置文件的解析過(guò)程到這吧，下一個(gè)就叫啥mapper配置文件的解析過(guò)程。

總結(jié)

以上是生活随笔為你收集整理的mybatis源码阅读(二)：mybatis初始化上的全部?jī)?nèi)容，希望文章能夠幫你解決所遇到的問(wèn)題。

如果覺(jué)得生活随笔網(wǎng)站內(nèi)容還不錯(cuò)，歡迎將生活随笔推薦給好友。