一文掌握MyBatis的动态SQL使用与原理

　　本文分享自华为云社区《MyBatis详解动态SQL使用与原理云社区华为云》，作者：龙哥手记。
　　动态SQL是MyBatis的强大特性之一。如果你使用过JDBC或其它类似的框架，你应该能理解根据不同条件拼接SQL语句有多痛苦，例如拼接时要确保不能忘记添加必要的空格，还要注意去掉列表最后一个列名的逗号。利用动态SQL，可以彻底摆脱这种痛苦。
　　使用动态SQL并非一件易事，但借助可用于任何SQL映射语句中的强大的动态SQL语言，MyBatis显著地提升了这一特性的易用性。
　　如果你之前用过JSTL或任何基于类XML语言的文本处理器，你对动态SQL元素可能会感觉似曾相识。在MyBatis之前的版本中，需要花时间了解大量的元素。借助功能强大的基于OGNL的表达式，MyBatis3替换了之前的大部分元素，大大精简了元素种类，现在要学习的元素种类比原来的一半还要少。ifchoose（when，otherwise）trim（where，set）foreachif
　　使用动态SQL最常见情景是根据条件包含where子句的一部分。比如：selectidfindActiveBlogWithTitleLikeresultTypeBlogSELECTFROMBLOGWHEREstate‘ACTIVE’iftesttitle！nullANDtitlelike｛title｝ifselect
　　这条语句提供了可选的查找文本功能。如果不传入title，那么所有处于ACTIVE状态的BLOG都会返回；如果传入了title参数，那么就会对title一列进行模糊查找并返回对应的BLOG结果（细心的读者可能会发现，title的参数值需要包含查找掩码或通配符字符）。
　　如果希望通过title和author两个参数进行可选搜索该怎么办呢？首先，我想先将语句名称修改成更名副其实的名称；接下来，只需要加入另一个条件即可。selectidfindActiveBlogLikeresultTypeBlogSELECTFROMBLOGWHEREstate‘ACTIVE’iftesttitle！nullANDtitlelike｛title｝ififtestauthor！nullandauthor。name！nullANDauthornamelike｛author。name｝ifselect
　　choose、when、otherwise
　　有时候，我们不想使用所有的条件，而只是想从多个条件中选择一个使用。针对这种情况，MyBatis提供了choose元素，它有点像Java中的switch语句。
　　还是上面的例子，但是策略变为：传入了title就按title查找，传入了author就按author查找的情形。若两者都没有传入，就返回标记为featured的BLOG（这可能是管理员认为，与其返回大量的无意义随机Blog，还不如返回一些由管理员挑选的Blog）。selectidfindActiveBlogLikeresultTypeBlogSELECTFROMBLOGWHEREstate‘ACTIVE’choosewhentesttitle！nullANDtitlelike｛title｝whenwhentestauthor！nullandauthor。name！nullANDauthornamelike｛author。name｝whenotherwiseANDfeatured1otherwisechooseselect
　　trim、where、set
　　前面几个例子已经合宜地解决了一个臭名昭著的动态SQL问题。现在回到之前的if示例，这次我们将state‘ACTIVE’设置成动态条件，看看会发生什么。selectidfindActiveBlogLikeresultTypeBlogSELECTFROMBLOGWHEREifteststate！nullstate｛state｝ififtesttitle！nullANDtitlelike｛title｝ififtestauthor！nullandauthor。name！nullANDauthornamelike｛author。name｝ifselect
　　如果没有匹配的条件会怎么样？最终这条SQL会变成这样：SELECTFROMBLOGWHERE
　　这会导致查询失败。如果匹配的只是第二个条件又会怎样？这条SQL会是这样：SELECTFROMBLOGWHEREANDtitlelike‘someTitle’
　　这个查询也会失败。这个问题不能简单地用条件元素来解决。这个问题是如此的难以解决，以至于解决过的人不会再想碰到这种问题。
　　MyBatis有一个简单且适合大多数场景的解决办法。而在其他场景中，可以对其进行自定义以符合需求。而这，只需要一处简单的改动：selectidfindActiveBlogLikeresultTypeBlogSELECTFROMBLOGwhereifteststate！nullstate｛state｝ififtesttitle！nullANDtitlelike｛title｝ififtestauthor！nullandauthor。name！nullANDauthornamelike｛author。name｝ifwhereselect
　　where元素只会在子元素返回任何内容的情况下才插入WHERE子句。而且，若子句的开头为AND或OR，where元素也会将它们去除。
　　如果where元素与你期望的不太一样，你也可以通过自定义trim元素来定制where元素的功能。比如，和where元素等价的自定义trim元素为：trimprefixWHEREprefixOverridesANDOR。。。trim
　　prefixOverrides属性会忽略通过管道符分隔的文本序列（注意此例中的空格是必要的）。上述例子会移除所有prefixOverrides属性中指定的内容，并且插入prefix属性中指定的内容。
　　用于动态更新语句的类似解决方案叫做set。set元素可以用于动态包含需要更新的列，忽略其它不更新的列。比如：updateidupdateAuthorIfNecessaryupdateAuthorsetiftestusername！nullusername｛username｝，ififtestpassword！nullpassword｛password｝，ififtestemail！nullemail｛email｝，ififtestbio！nullbio｛bio｝ifsetwhereid｛id｝update
　　这个例子中，set元素会动态地在行首插入SET关键字，并会删掉额外的逗号（这些逗号是在使用条件语句给列赋值时引入的）。
　　来看看与set元素等价的自定义trim元素吧：trimprefixSETsuffixOverrides，。。。trim
　　注意，我们覆盖了后缀值设置，并且自定义了前缀值。foreach
　　动态SQL的另一个常见使用场景是对集合进行遍历（尤其是在构建IN条件语句的时候）。比如：selectidselectPostInresultTypedomain。blog。PostSELECTFROMPOSTPWHEREIDinforeachitemitemindexindexcollectionlistopen（separator，close）｛item｝foreachselect
　　foreach元素的功能非常强大，它允许你指定一个集合，声明可以在元素体内使用的集合项（item）和索引（index）变量。它也允许你指定开头与结尾的字符串以及集合项迭代之间的分隔符。这个元素也不会错误地添加多余的分隔符，看它多智能！
　　提示你可以将任何可迭代对象（如List、Set等）、Map对象或者数组对象作为集合参数传递给foreach。当使用可迭代对象或者数组时，index是当前迭代的序号，item的值是本次迭代获取到的元素。当使用Map对象（或者Map。Entry对象的集合）时，index是键，item是值。
　　至此，我们已经完成了与XML配置及映射文件相关的讨论。下一章将详细探讨JavaAPI，以便你能充分利用已经创建的映射配置。script
　　要在带注解的映射器接口类中使用动态SQL，可以使用script元素。比如：Update（｛｝）voidupdateAuthorValues（Authorauthor）；bind
　　bind元素允许你在OGNL表达式以外创建一个变量，并将其绑定到当前的上下文。比如：selectidselectBlogsLikeresultTypeBlogbindnamepatternvalueparameter。getTitle（）SELECTFROMBLOGWHEREtitleLIKE｛pattern｝select
　　多数据库支持
　　如果配置了databaseIdProvider，你就可以在动态代码中使用名为databaseId的变量来为不同的数据库构建特定的语句。比如下面的例子：insertidinsertselectKeykeyPropertyidresultTypeintorderBEFOREiftestdatabaseIdoracleselectsequsers。nextvalfromdualififtestdatabaseIddb2selectnextvalforsequsersfromsysibm。sysdummy1ifselectKeyinsertintousersvalues（｛id｝，｛name｝）insert
　　动态SQL中的插入脚本语言
　　MyBatis从3。2版本开始支持插入脚本语言，这允许你插入一种语言驱动，并基于这种语言来编写动态SQL查询语句。
　　可以通过实现以下接口来插入一种语言：publicinterfaceLanguageDriver｛ParameterHandlercreateParameterHandler（MappedStatementmappedStatement，ObjectparameterObject，BoundSqlboundSql）；SqlSourcecreateSqlSource（Configurationconfiguration，XNodescript，C？parameterType）；SqlSourcecreateSqlSource（Configurationconfiguration，Stringscript，C？parameterType）；｝
　　实现自定义语言驱动后，你就可以在mybatisconfig。xml文件中将它设置为默认语言：typeAliasestypeAliastypeorg。sample。MyLanguageDriveraliasmyLanguagetypeAliasessettingssettingnamedefaultScriptingLanguagevaluemyLanguagesettings
　　或者，你也可以使用lang属性为特定的语句指定语言：selectidselectBloglangmyLanguageSELECTFROMBLOGselect
　　或者，在你的mapper接口上添加Lang注解：publicinterfaceMapper｛Lang（MyLanguageDriver。class）Select（SELECTFROMBLOG）ListBlogselectBlog（）；｝
　　提示可以使用ApacheVelocity作为动态语言，更多细节请参考MyBatisVelocity项目。
　　你前面看到的所有xml标签都由默认MyBatis语言提供，而它由语言驱动org。apache。ibatis。scripting。xmltags。XmlLanguageDriver（别名为xml）所提供。动态SQL解析原理
　　我们在使用mybatis的时候，会在xml中编写sql语句。比如这段动态sql代码：updateidupdateparameterTypeorg。format。dynamicproxy。mybatis。bean。UserUPDATEuserstrimprefixSETprefixOverrides，iftestname！nullandname！name｛name｝ififtestage！nullandage！，age｛age｝ififtestbirthday！nullandbirthday！，birthday｛birthday｝iftrimwhereid｛id｝update
　　mybatis底层是如何构造这段sql的？下面带着这个疑问，我们一步一步分析。关于动态SQL的接口和类
　　SqlNode接口，简单理解就是xml中的每个标签，比如上述sql的update，trim，if标签：publicinterfaceSqlNode｛booleanapply（DynamicContextcontext）；｝
　　SqlSourceSql源接口，代表从xml文件或注解映射的sql内容，主要就是用于创建BoundSql，有实现类DynamicSqlSource（动态Sql源），StaticSqlSource（静态Sql源）等：publicinterfaceSqlSource｛BoundSqlgetBoundSql（ObjectparameterObject）；｝
　　BoundSql类，封装mybatis最终产生sql的类，包括sql语句，参数，参数源数据等参数：
　　XNode，一个DomAPI中的Node接口的扩展类：
　　BaseBuilder接口及其实现类（属性，方法省略了，大家有兴趣的自己看），这些Builder的作用就是用于构造sql：
　　下面我们简单分析下其中4个Builder：XMLConfigBuilder：解析mybatis中configLocation属性中的全局xml文件，内部会使用XMLMapperBuilder解析各个xml文件。XMLMapperBuilder：遍历mybatis中mapperLocations属性中的xml文件中每个节点的Builder，比如user。xml，内部会使用XMLStatementBuilder处理xml中的每个节点。XMLStatementBuilder：解析xml文件中各个节点，比如select，insert，update，delete节点，内部会使用XMLScriptBuilder处理节点的sql部分，遍历产生的数据会丢到Configuration的mappedStatements中。XMLScriptBuilder：解析xml中各个节点sql部分的Builder。
　　LanguageDriver接口及其实现类（属性，方法省略了，大家有兴趣的自己看），该接口主要的作用就是构造sql：
　　简单分析下XMLLanguageDriver（处理xml中的sql，RawLanguageDriver处理静态sql）：XMLLanguageDriver内部会使用XMLScriptBuilder解析xml中的sql部分。源码分析走起
　　Spring与Mybatis整合的时候需要配置SqlSessionFactoryBean，该配置会加入数据源和mybatisxml配置文件路径等信息：beanidsqlSessionFactoryclassorg。mybatis。spring。SqlSessionFactoryBeanpropertynamedataSourcerefdataSourcepropertynameconfigLocationvalueclasspath：mybatisConfig。xmlpropertynamemapperLocationsvalueclasspath：orgformatdao。xmlbean
　　我们就分析这一段配置背后的细节：
　　SqlSessionFactoryBean实现了Spring的InitializingBean接口，InitializingBean接口的afterPropertiesSet方法中会调用buildSqlSessionFactory方法该方法内部会使用XMLConfigBuilder解析属性configLocation中配置的路径，还会使用XMLMapperBuilder属性解析mapperLocations属性中的各个xml文件。部分源码如下：
　　由于XMLConfigBuilder内部也是使用XMLMapperBuilder，我们就看看XMLMapperBuilder的解析细节：
　　我们关注一下，增删改查节点的解析：
　　XMLStatementBuilder的解析：
　　默认会使用XMLLanguageDriver创建SqlSource（Configuration构造函数中设置）。
　　XMLLanguageDriver创建SqlSource：
　　XMLScriptBuilder解析sql：
　　得到SqlSource之后，会放到Configuration中，有了SqlSource，就能拿BoundSql了，BoundSql可以得到最终的sql。实例分析
　　以下面的xml解析大概说下parseDynamicTags的解析过程：updateidupdateparameterTypeorg。format。dynamicproxy。mybatis。bean。UserUPDATEuserstrimprefixSETprefixOverrides，iftestname！nullandname！name｛name｝ififtestage！nullandage！，age｛age｝ififtestbirthday！nullandbirthday！，birthday｛birthday｝iftrimwhereid｛id｝update
　　parseDynamicTags方法的返回值是一个List，也就是一个Sql节点集合。SqlNode本文一开始已经介绍，分析完解析过程之后会说一下各个SqlNode类型的作用。
　　首先根据update节点（Node）得到所有的子节点，分别是3个子节点：文本节点UPDATEuserstrim子节点。。。文本节点whereid
　　遍历各个子节点：如果节点类型是文本或者CDATA，构造一个TextSqlNode或StaticTextSqlN如果节点类型是元素，说明该update节点是个动态sql，然后会使用NodeHandler处理各个类型的子节点。这里的NodeHandler是XMLScriptBuilder的一个内部接口，其实现类包括TrimHandler、WhereHandler、SetHandler、IfHandler、ChooseHandler等。看类名也就明白了这个Handler的作用，比如我们分析的trim节点，对应的是TrimHif节点，对应的是IfHandler。。。这里子节点trim被TrimHandler处理，TrimHandler内部也使用parseDynamicTags方法解析节点。
　　遇到子节点是元素的话，重复以上步骤：
　　trim子节点内部有7个子节点，分别是文本节点、if节点、是文本节点、if节点、是文本节点、if节点、文本节点。文本节点跟之前一样处理，if节点使用IfHandler处理。遍历步骤如上所示，下面我们看下几个Handler的实现细节。
　　IfHandler处理方法也是使用parseDynamicTags方法，然后加上if标签必要的属性：privateclassIfHandlerimplementsNodeHandler｛publicvoidhandleNode（XNodenodeToHandle，ListSqlNodetargetContents）｛ListSqlNodecontentsparseDynamicTags（nodeToHandle）；MixedSqlNodemixedSqlNodenewMixedSqlNode（contents）；StringtestnodeToHandle。getStringAttribute（test）；IfSqlNodeifSqlNodenewIfSqlNode（mixedSqlNode，test）；targetContents。add（ifSqlNode）；｝｝
　　TrimHandler处理方法也是使用parseDynamicTags方法，然后加上trim标签必要的属性：privateclassTrimHandlerimplementsNodeHandler｛publicvoidhandleNode（XNodenodeToHandle，ListSqlNodetargetContents）｛ListSqlNodecontentsparseDynamicTags（nodeToHandle）；MixedSqlNodemixedSqlNodenewMixedSqlNode（contents）；StringprefixnodeToHandle。getStringAttribute（prefix）；StringprefixOverridesnodeToHandle。getStringAttribute（prefixOverrides）；StringsuffixnodeToHandle。getStringAttribute（suffix）；StringsuffixOverridesnodeToHandle。getStringAttribute（suffixOverrides）；TrimSqlNodetrimnewTrimSqlNode（configuration，mixedSqlNode，prefix，prefixOverrides，suffix，suffixOverrides）；targetContents。add（trim）；｝｝
　　以上update方法最终通过parseDynamicTags方法得到的SqlNode集合如下：
　　trim节点：
　　由于这个update方法是个动态节点，因此构造出了DynamicSqlSource。DynamicSqlSource内部就可以构造sql了：
　　DynamicSqlSource内部的SqlNode属性是一个MixedSqlNode。然后我们看看各个SqlNode实现类的apply方法。下面分析一下各个SqlNode实现类的apply方法实现：
　　MixedSqlNode：MixedSqlNode会遍历调用内部各个sqlNode的apply方法。publicbooleanapply（DynamicContextcontext）｛for（SqlNodesqlNode：contents）｛sqlNode。apply（context）；｝｝
　　StaticTextSqlNode：直接appendsql文本。publicbooleanapply（DynamicContextcontext）｛context。appendSql（text）；｝
　　IfSqlNode：这里的evaluator是一个ExpressionEvaluator类型的实例，内部使用了OGNL处理表达式逻辑。publicbooleanapply（DynamicContextcontext）｛if（evaluator。evaluateBoolean（test，context。getBindings（）））｛contents。apply（context）；｝｝
　　TrimSqlNode：publicbooleanapply（DynamicContextcontext）｛FilteredDynamicContextfilteredDynamicContextnewFilteredDynamicContext（context）；booleanresultcontents。apply（filteredDynamicContext）；filteredDynamicContext。applyAll（）；｝publicvoidapplyAll（）｛sqlBuffernewStringBuilder（sqlBuffer。toString（）。trim（））；StringtrimmedUppercaseSqlsqlBuffer。toString（）。toUpperCase（Locale。ENGLISH）；if（trimmedUppercaseSql。length（）0）｛applyPrefix（sqlBuffer，trimmedUppercaseSql）；applySuffix（sqlBuffer，trimmedUppercaseSql）；｝delegate。appendSql（sqlBuffer。toString（））；｝privatevoidapplyPrefix（StringBuildersql，StringtrimmedUppercaseSql）｛if（！prefixApplied）｛prefixAif（prefixesToOverride！null）｛for（StringtoRemove：prefixesToOverride）｛if（trimmedUppercaseSql。startsWith（toRemove））｛sql。delete（0，toRemove。trim（）。length（））；｝｝｝if（prefix！null）｛sql。insert（0，）；sql。insert（0，prefix）；｝｝｝
　　TrimSqlNode的apply方法也是调用属性contents（一般都是MixedSqlNode）的apply方法，按照实例也就是7个SqlNode，都是StaticTextSqlNode和IfSqlNode。最后会使用FilteredDynamicContext过滤掉prefix和suffix。
　　点击下方，第一时间了解华为云新鲜技术
　　华为云博客大数据博客AI博客云计算博客开发者中心华为云