读书人

ibatis源码学习(4)动态SQL的实现原理

发布时间: 2012-08-02 11:35:25 作者: rapoo

ibatis源码学习(四)动态SQL的实现原理
动态SQL是ibatis框架的一个重要特性,本文将深入分析ibatis框架中动态SQL的实现原理。动态sql的使用参见官方文档:Dynamic SQL。本文使用的ibatis版本为2.3.4。

问题
在介绍动态SQL的实现原理之前,让我们先来思考几个问题。
1. 为什么需要动态SQL?
通过动态sql可以提高运行程序的灵活性,使我们可以方便地实现多条件下的数据库操作。

2. 如何描述动态SQL?
对于变化的数据,通常是封装在配置文件中。对于动态SQL中的不同条件,可以采用不同标签表示其含义。通过各种条件标签的组合,描述需要表达的语义。

3. 如何实现动态SQL?
首先采用条件标签描述需要表达的语义,维护在配置文件中;初始化过程中,解析配置文件中的标签,生成sql配置对应的抽象语法树;请求处理过程中,根据参数对象解释该抽象语法树,生成当前请求的动态SQL语句。

核心类图

1. SqlResource
该接口含义是作为sql对象的来源,通过该接口可以获取sql对象。其唯一的实现类是XmlSqlResource,表示通过xml文件生成sql对象。

2. Sql
该接口可以生成sql语句和获取sql相关的上下文环境(如ParameterMap、ResultMap等),有三个实现类: RawSql表示为原生的sql语句,在初始化即可确定sql语句;SimpleDynamicSql表示简单的动态sql,即sql语句中参数通过$property$方式指定,参数在sql生成过程中会被替换,不作为sql执行参数;DynamicSql表示动态sql,即sql描述文件中包含isNotNull、isGreaterThan等条件标签。

3. SqlChild
该接口表示sql抽象语法树的一个节点,包含sql语句的片段信息。该接口有两个实现类: SqlTag表示动态sql片段,即配置文件中的一个动态标签,内含动态sql属性值(如prepend、property值等);SqlText表示静态sql片段,即为原生的sql语句。每条动态sql通过SqlTag和SqlText构成相应的抽象语法树。

4. SqlTagHandler
该接口表示SqlTag(即不同的动态标签)对应的处理方式。比如实现类IsEmptyTagHandler用于处理<isEmpty>标签,IsEqualTagHandler用于处理<isEqual>标签等。

5. SqlTagContext
用于解释sql抽象语法树时使用的上下文环境。通过解释语法树每个节点,将生成的sql存入SqlTagContext。最终通过SqlTagContext获取完整的sql语句。

从整体上看,动态sql的生成过程包含两步: 初始化过程用于解析sql配置,生成由SqlChild节点组成的抽象语法树;请求处理过程通过运行期的参数对象解释抽象语法树,生成实际的sql语句。下面通过源码分析整个过程。

初始化过程
在初始化和配置文件解析一文中我们提到过,配置文件解析的核心逻辑是: sql配置文件 ->s ql映射文件 -> SqlStatement语句,本文将从SqlStatement的解析过程开始进行分析。

1. SqlStatementParser.parseGeneralStatement()用于解析映射文件中的Sql配置,生成MappedStatement对象。部分源码如下:


这段代码比较长,核心逻辑如下:
依次处理当前节点的每个子节点,判断当前子节点类型,根据不同类型采用不同处理方式:
4.1 处理sql文本节点
对于sql文本节点,生成SqlText对象。这个过程需要解析sql语句,将其中的参数#param#替换为?,生成sql语句和ParameterMapping对象。sql文本解析的核心逻辑是InlineParameterMapParser.parseInlineParameterMap(),这里不再详述。

4.2 处理include标签
SqlMapParaser在处理<sql>标签时,会将处理结果放入XmlParserState.sqlIncludes这个map对象中。 这里主要通过当前include id在sqlIncludes中获取对应的包含节点信息,再递归处理包含节点。

4.3 处理动态标签
首先获取动态标签对应的SqlTagHandler,接着通过动态标签配置生成SqlTag对象,最后递归处理当前节点的每个子节点。

小结
动态sql初始化的核心目标是通过递归方式构—ynamicSql对象,它是一个抽象语法树,由SqlText和SqlTag节点构成。而请求处理过程正是通过参数对象解释该抽象语法树,生成sql语句。

请求处理过程
在整体设计和核心流程一文中的SQL执行过程中,最后通过调用MappedStatement.executeQueryWithCallback()执行sql语句,而正是在这里生成当前请求的sql语句。

1. MappedStatement.executeQueryWithCallback()的部分源码如下:

读书人网 >SQL Server

热点推荐