題記:最近在工作之餘分析了一下MyBatis的源碼,促使我閱讀源碼的原因是為了實現MyBatis在物理上的分頁。我們知道,MyBatis是在邏輯上的分頁,透過使用者的查詢,將結果快取下來,在查看是否傳遞了RowBounds對象,在查看裡面的offset和limit值,透過這兩個值,從返回的結果集合中截取位於期間的值。但這樣並不是很好,可以想想,如果假設查詢的資料量很大,但是有用的可以是前幾條,這未免有點太浪費了。在之前,也在網路上查了一下實作分頁的方法,最常用的就是加入MyBatis插件,實作Interceptor接口,攔截StatementHandler介面中的prepare方法,後面會介紹為什麼攔截這個介面的這個方法。在攔截ResultSetHandler介面的handlerResultSet方法,後面也會對其緣由進行介紹。但這中方法雖然可以加入分頁的SQL語句,但並沒有將分頁的offset和limit的值讓Mybatis動態的加入到SQL中去,有人會說,可以在攔截StatementHandler介面的時候我們將它們拼裝上去。但是這樣會容易出現SQL注入的問題。所以這樣不得不使我進一步的了解MyBatis的內部原理。本文將就幾個面向對MyBatis的內部實作進行分析
数据管家——Configuration: MyBatis在运行期的基本上所有的数据都会汇总到这个类。它的初始数据是来自开发人员配置在configuration的xml配置文件。通过用户配置的environments来获得系统运行的数据库环境,如事物管理以及数据源。下面给出了最基本的配置: [html] <configuration> <environments default="development"> <environment id="development"> <transactionManager type="JDBC" /> <dataSource type="POOLED"> <property name="driver" value="com.mysql.jdbc.Driver"/> <property name="url" value="jdbc:mysql://localhost:3306/test?useUnicode=true&characterEncoding=GBK"/> <property name="username" value="root"/> <property name="password" value="root"/> </dataSource> </environment> </environments> <mappers> <mapper resource="com/bieber/mybatis/io/user-mapper.xml"/> </mappers> </configuration>
这些配置对于MyBatis需要做哪些工作呢?通过阅读Configuration的源码会发现,Mybatis其实为configuration标签下面的子标签都有一个对应的变量来进行存储,例如: [java] protected final TypeHandlerRegistry typeHandlerRegistry = new TypeHandlerRegistry();
则是存储<typeHandlers></typeHandlers>标签下面配置的所有信息。其他的也类似可以找到。负责创建Configuration对象的则是XMLConfigurationBuilder,这里将完成从配置的XML数据映射到Configuration对象的数据。通过一下方法完成数据的映射: [java] private void parseConfiguration(XNode root) { try { propertiesElement(root.evalNode("properties")); typeAliasesElement(root.evalNode("typeAliases")); pluginElement(root.evalNode("plugins")); objectFactoryElement(root.evalNode("objectFactory")); objectWrapperFactoryElement(root.evalNode("objectWrapperFactory")); settingsElement(root.evalNode("settings")); 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); } }
可以到,它為每個元素都對應了一個處理方法,這些方法將負責解析我們配置的XML檔。這裡面我主要追蹤了幾個方法的執行 www.2cto.com
(mapperElement,typeHandlerElement,typeAliasesElement,environmentsElement)
mapperElement——ORM
我們知道,MyBatis支援註解形式和XML形式的ORM配置。那當然會有兩個類別來處理這兩種行為,它們分別是XMLMapperBuilder和MapperAnnotationBuilder,它們分別處理什麼類型,我看我就不用說了。透過解析configuration/mappers元素來獲得ORM配置資訊。
1)XML方式的ORM配置和方式,當我們在mappers/mapper的屬性中配置了url或者是resource資訊的時候將觸發MyBatis採用XML的方式進行處理,並讀取你指定的mapper路徑。在XMLMapperBuilder類別中有以下方法:
[java]
private void configurationElement(XNode context) { try { String namespace = context.getStringAttribute("namespace"); builderAssistant.setCurrentNamespace(namespace); cacheRefElement(context.evalNode("cache-ref")); cacheElement(context.evalNode("cache")); parameterMapElement(context.evalNodes("/mapper/parameterMap")); resultMapElements(context.evalNodes("/mapper/resultMap")); sqlElement(context.evalNodes("/mapper/sql")); buildStatementFromContext(context.evalNodes("select|insert|update|delete")); } catch (Exception e) { throw new RuntimeException("Error parsing Mapper XML. Cause: " + e, e); } }
这个方法便是读取你mapper文件中所有制的ORM信息。该方法将通过调用XMLMapperBuilder的parse()方法触发。
2)注解方式配置ORM信息加载,当你配置了mappers/package或者在mapper里面配置了class属性的时候将触发信息的读取,具体的过程我就再描述了,基本和上面差不多,只是读取的是注解的信息。
注意:MyBatis优先处理的是注解形式的方式,并且在mapper配置中,当配置了多个属性时,resource属性优先处理。
那么在这样处理后Configuration会得到怎样的数据呢?通过这些处理在Configuration里面将会获得几个主要的变量值:sqlFragments,resultMaps,mappedStatements。其中sqlFragments就是我们定义在mapper里面的sql标签或者注解的内容,而resultMaps也是定义在mapper里面或者注解的resultMap内容。最重要的是mappedStatements,这是ORM的最关键部分。它里面通过键值对的方式存储,key这是我们配置的id属性加上namespace,而value则是MappedStatement对象,这个对象这就对应了我们配置的select/update/delete/insert标签的值。
MappedStatement对象包含这条slq语句的ID,执行的类型(Inser,update,delte,select),statementType(指定产生Statement的类型,如PreparedStatement),还有一个就是SqlSource接口的子类对象,在MyBatis中有两种SqlSource,一种是动态的,另一种是静态的。不用解释,应该都明白,一个是生成动态SQL用的,另一个这是简单静态的SQL。在SqlSource中,包括你定义的SQL语句,以及引入的外部SQL语句块。MappedStatement最后还要包括一个重要的信息,这就是ParameterMap,这直接关系你定义的SQL语句中通过#{propertyName}定义的动态填充值。如果你的是一个POJO对象,那么MyBatis将会通过反射获得这个对象的属性,并依次填入到对应的propertyName所在的位置。
注意:此时的MappedStatement中的SQL语句还是带有#{propertyName}这样占位符的字符串,还并没有解析成待问号(?)的占位符。要执行该操作是在执行具体的数据库操作的时候才替换成(?),只是为了很好的找到这个propertyName所对应的值所在的位置。
以上就将整个SqlSession的初始化过程所做的操作进行了解剖。完成这些操作之后,那么就等待用户触发对数据库的操作了。
后续将会给出,MyBatis是如何触发用户自定义的插件的过程以及开发自己的TypeHandler。MyBatis允许用户的插件可以拦截ParameterHandler,ResultSetHandler,StatementHandler,Executor接口,从而进行一些操作。
本文到此继续,后续会有新的更新。如有严重不对的地方,还望各位能够及时提出,毕竟对MyBatis的接触也只有一个星期,未免有些地方不对,还望大家谅解。
以上就是MyBatis整体预览(一)的内容,更多相关内容请关注PHP中文网(www.php.cn)!