動(dòng)態(tài)Sql介紹

動(dòng)態(tài) SQL 是 MyBatis 的強(qiáng)大特性之一。如果你使用過(guò) JDBC 或其它類似的框架，你應(yīng)該能理解根據(jù)不同條件拼接 SQL 語(yǔ)句有多痛苦，例如拼接時(shí)要確保不能忘記添加必要的空格，還要注意去掉列表最后一個(gè)列名的逗號(hào)。利用動(dòng)態(tài) SQL，可以徹底擺脫這種痛苦。

使用動(dòng)態(tài) SQL 并非一件易事，但借助可用于任何 SQL 映射語(yǔ)句中的強(qiáng)大的動(dòng)態(tài) SQL 語(yǔ)言，MyBatis 顯著地提升了這一特性的易用性。

Mybatis動(dòng)態(tài)解析里面有2個(gè)核心的類SqlNode、SqlSource、ExpressionEvaluator。Mybatis動(dòng)態(tài)Sql使用分為2個(gè)部分：動(dòng)態(tài)Sql解析、動(dòng)態(tài)Sql拼接執(zhí)行。

封裝SqlNode

SqlNode是在解析Xml文件的時(shí)候?qū)?dòng)態(tài)Sql進(jìn)行解析，并存在MappedStatement的sqlSource屬性中。對(duì)于嵌套動(dòng)態(tài)Sql，mybatis用遞歸調(diào)用來(lái)進(jìn)行解析。這塊東西個(gè)人覺(jué)得還是比較繞，所以這塊博主準(zhǔn)備事例、源碼、執(zhí)行結(jié)果一起講解。

Sql腳本分類

在Mybatis中Sql腳本分為2種類型：靜態(tài)Sql和動(dòng)態(tài)Sql。下面我們通過(guò)具體的源碼來(lái)看下2者區(qū)分。

靜態(tài)Sql和動(dòng)態(tài)Sql

靜態(tài)Sql說(shuō)白了就沒(méi)有太任何判斷了解的Sql腳本。

//Select是查詢的一些屬性

//這條查詢語(yǔ)句select*fromuserwhereid>#{user.id}就是Mybatis中的靜態(tài)Sql
//靜態(tài)Sql就是不太任何條件的Sql語(yǔ)句
select*fromuserwhereid>#{user.id}
//這里有if判斷條件，Mybatis把帶有判斷條件的Sql叫動(dòng)態(tài)Sql。
//動(dòng)態(tài)Sql除了if之外還有foreach、where、trim等。具體自己去mybatis官網(wǎng)看下

ANDname=#{user.name}

SqlNode類結(jié)果體系

看mybatis代碼很多時(shí)候可以看到這種結(jié)構(gòu)。每個(gè)SqlNode負(fù)責(zé)自己那塊功能。職責(zé)單一。SqlNode的核心方法apply就是通過(guò)ExpressionEvaluator來(lái)解析OGNL表達(dá)式數(shù)據(jù)的。接下來(lái)我們看看Mybatis是如何遞歸解析動(dòng)態(tài)sql腳本的。

//解析Sql腳本節(jié)點(diǎn)
publicSqlSourceparseScriptNode(){
//解析靜態(tài)和動(dòng)態(tài)腳本，并存在MixedSqlNode里面
//這行代碼很關(guān)鍵，后面我們會(huì)去分析parseDynamicTags這里就是一層一層遞歸調(diào)用該方法把Sql腳本生成MixedSqlNode對(duì)象。
MixedSqlNoderootSqlNode=parseDynamicTags(context);
SqlSourcesqlSource=null;
//是否為動(dòng)態(tài)Sql
if(isDynamic){
//動(dòng)態(tài)Sql則生成DynamicSqlSource
sqlSource=newDynamicSqlSource(configuration,rootSqlNode);
}else{
//否則為靜態(tài)SqlSource
sqlSource=newRawSqlSource(configuration,rootSqlNode,parameterType);
}
returnsqlSource;
}

//Anhighlightedblock
protectedMixedSqlNodeparseDynamicTags(XNodenode){
//創(chuàng)建個(gè)SqlNode，這個(gè)列表存了當(dāng)前Sql腳本節(jié)點(diǎn)下的所有的SqlNode信息
Listcontents=newArrayList();
NodeListchildren=node.getNode().getChildNodes();
for(inti=0;iinSQLstatement.");
}
//調(diào)用對(duì)應(yīng)的handler進(jìn)行節(jié)點(diǎn)處理，遞歸調(diào)用就在這塊
handler.handleNode(child,contents);
isDynamic=true;
}
}
//創(chuàng)建MixedSqlNode
returnnewMixedSqlNode(contents);
}

//下面我們看下IfHandler是如何處理，IfHandler是XMLScriptBuilder的內(nèi)部類
privateclassIfHandlerimplementsNodeHandler{
publicIfHandler(){
//PreventSyntheticAccess
}
//我們著重分析這個(gè)方法
@Override
publicvoidhandleNode(XNodenodeToHandle,ListtargetContents){
//調(diào)用parseDynamicTags進(jìn)行節(jié)點(diǎn)解析。這里就是遞歸，又調(diào)用了上面的方法。
MixedSqlNodemixedSqlNode=parseDynamicTags(nodeToHandle);
//獲取if對(duì)應(yīng)的表達(dá)式
Stringtest=nodeToHandle.getStringAttribute("test");
//創(chuàng)建IfSqlNode
IfSqlNodeifSqlNode=newIfSqlNode(mixedSqlNode,test);
targetContents.add(ifSqlNode);
}
}

下面我們根據(jù)Sql腳本和執(zhí)行結(jié)果來(lái)分析。

//靜態(tài)Sql腳本和嵌套的動(dòng)態(tài)Sql腳本

select*fromuserwhereid>#{user.id}

ANDname=#{user.name}

ANDname=#{user.name}

ANDname=#{user.name}

下面我們分析下執(zhí)行結(jié)果：

上面遞歸結(jié)果已經(jīng)用不通顏色標(biāo)記了，大家自己看下。特別需要看下IfSqlNode的屬性。

動(dòng)態(tài)Sql解析

動(dòng)態(tài)Sql解析主要是執(zhí)行數(shù)據(jù)庫(kù)操作的時(shí)候把動(dòng)態(tài)Sql轉(zhuǎn)換成JDBC能識(shí)別的Sql腳本。Mybatis中主要是通過(guò)SqlSource來(lái)解析Sql腳本，替換成JDBC能識(shí)別的Sql腳本。我們先看下類圖。

SqlSource：提供了Sql解析的行為。
RawSqlSource：靜態(tài)Sql腳本的編譯，只生成一次StaticSqlSource。
DynamicSqlSource：每次調(diào)用都會(huì)生成StaticSqlSource。每次調(diào)用傳入?yún)?shù)可能不一樣。需要每次生成StaticSqlSource。
ProviderSqlSource：第三方腳本語(yǔ)言的集成。
FreeMarkerSqlSource：對(duì)FreeMarker的支持。
StaticSqlSource：StaticSqlSource只是對(duì)上面4中類型做了層封裝。博主沒(méi)有這個(gè)類會(huì)更清爽些。
我們這次主要對(duì)StaticSqlSource、RawSqlSource、和DynamicSqlSource進(jìn)行分析。

StaticSqlSource

其實(shí)StaticSqlSource就是對(duì)其他幾種類型Sql處理器結(jié)果進(jìn)行包裝。我們看下源碼。

//我們主要分析下getBoundSql
publicclassStaticSqlSourceimplementsSqlSource{

privatefinalStringsql;
privatefinalListparameterMappings;
privatefinalConfigurationconfiguration;

publicStaticSqlSource(Configurationconfiguration,Stringsql){
this(configuration,sql,null);
}

publicStaticSqlSource(Configurationconfiguration,Stringsql,ListparameterMappings){
this.sql=sql;
this.parameterMappings=parameterMappings;
this.configuration=configuration;
}

//getBoundSql就是創(chuàng)建一個(gè)BoundSql對(duì)象。
@Override
publicBoundSqlgetBoundSql(ObjectparameterObject){
returnnewBoundSql(configuration,sql,parameterMappings,parameterObject);
}

}

看完是不是非常簡(jiǎn)單，其實(shí)有些代碼確實(shí)沒(méi)有我們想象中那么難。

RawSqlSource

//我們著重分析RawSqlSource方法
publicclassRawSqlSourceimplementsSqlSource{

privatefinalSqlSourcesqlSource;

publicRawSqlSource(Configurationconfiguration,SqlNoderootSqlNode,ClassparameterType){
this(configuration,getSql(configuration,rootSqlNode),parameterType);
}
//這里實(shí)現(xiàn)了對(duì)靜態(tài)腳本的解析，所謂的靜態(tài)腳本解析就是把#{}解析成？靜態(tài)Sql解析是在解析Mapper.xml的時(shí)候執(zhí)行的
publicRawSqlSource(Configurationconfiguration,Stringsql,ClassparameterType){
SqlSourceBuildersqlSourceParser=newSqlSourceBuilder(configuration);
Classclazz=parameterType==null?Object.class:parameterType;
//通過(guò)調(diào)用SqlSourceBuilder的parse方法來(lái)解析Sql
sqlSource=sqlSourceParser.parse(sql,clazz,newHashMap());
}

privatestaticStringgetSql(Configurationconfiguration,SqlNoderootSqlNode){
DynamicContextcontext=newDynamicContext(configuration,null);
rootSqlNode.apply(context);
returncontext.getSql();
}

@Override
publicBoundSqlgetBoundSql(ObjectparameterObject){
returnsqlSource.getBoundSql(parameterObject);
}

}

下面我們來(lái)看下SqlSourceBuilder的parse方法

publicSqlSourceparse(StringoriginalSql,ClassparameterType,MapadditionalParameters){
ParameterMappingTokenHandlerhandler=newParameterMappingTokenHandler(configuration,parameterType,additionalParameters);
//找到Sql腳本中#{}符號(hào)的腳本用？號(hào)進(jìn)行替代。GenericTokenParser里面代碼比較復(fù)雜，博主也沒(méi)有研究。
//有興趣自己可以研究下。
GenericTokenParserparser=newGenericTokenParser("#{","}",handler);
Stringsql=parser.parse(originalSql);
returnnewStaticSqlSource(configuration,sql,handler.getParameterMappings());
}

DynamicSqlSource

動(dòng)態(tài)Sql解析主要由DynamicSqlSource來(lái)完成。這里面又是通過(guò)遞歸調(diào)進(jìn)行sql解析。我們還是延用上面的Sql給大家講解。

publicclassDynamicSqlSourceimplementsSqlSource{

privatefinalConfigurationconfiguration;
privatefinalSqlNoderootSqlNode;

publicDynamicSqlSource(Configurationconfiguration,SqlNoderootSqlNode){
this.configuration=configuration;
this.rootSqlNode=rootSqlNode;
}

@Override
publicBoundSqlgetBoundSql(ObjectparameterObject){
//動(dòng)態(tài)Sql解析上下文
DynamicContextcontext=newDynamicContext(configuration,parameterObject);
//rootSqlNode就是我們前面講解的，把動(dòng)態(tài)Sql解析成SqlNode對(duì)象。外層為MixedSqlNode節(jié)點(diǎn)，節(jié)點(diǎn)存儲(chǔ)了
//節(jié)點(diǎn)下的所有子節(jié)點(diǎn)。里面遞歸調(diào)用并根據(jù)傳入?yún)?shù)的屬性檢查是否需要拼接sql
rootSqlNode.apply(context);
//這塊代碼和上面靜態(tài)Sql接代碼一致。
SqlSourceBuildersqlSourceParser=newSqlSourceBuilder(configuration);
ClassparameterType=parameterObject==null?Object.class:parameterObject.getClass();
//把我們動(dòng)態(tài)Sql中的#{}替換成？
SqlSourcesqlSource=sqlSourceParser.parse(context.getSql(),parameterType,context.getBindings());
BoundSqlboundSql=sqlSource.getBoundSql(parameterObject);
for(Map.Entryentry:context.getBindings().entrySet()){
boundSql.setAdditionalParameter(entry.getKey(),entry.getValue());
}
returnboundSql;
}

}

動(dòng)態(tài)Sql解析apply方法博主只根據(jù)場(chǎng)景介紹下MixedSqlNode和IfSqlNode的apply方法。其他有興趣自己去研究下。邏輯大體一致，實(shí)現(xiàn)有些區(qū)別。

publicclassMixedSqlNodeimplementsSqlNode{
privatefinalListcontents;

publicMixedSqlNode(Listcontents){
this.contents=contents;
}

//獲取循環(huán)SqlNode列表的所有SqlNode，調(diào)用apply方法根據(jù)傳入?yún)?shù)和條件進(jìn)行靜態(tài)sql的拼接。
//列表中的SqlNode可能是一個(gè)簡(jiǎn)單的SqlNode對(duì)象，也可能是一個(gè)MixedSqlNode或者有更多的嵌套。
//博主的例子就是3個(gè)嵌套If查詢。根據(jù)博主的Sql腳本，這里直接會(huì)調(diào)用IfSqlNode的apply方法。
//我們接下來(lái)看下IfSqlNode是如何實(shí)現(xiàn)的。
@Override
publicbooleanapply(DynamicContextcontext){
for(SqlNodesqlNode:contents){
sqlNode.apply(context);
}
returntrue;
}
}

IfSqlNode的apply

publicclassIfSqlNodeimplementsSqlNode{
//ExpressionEvaluator會(huì)調(diào)用ognl來(lái)對(duì)表達(dá)式進(jìn)行解析
privatefinalExpressionEvaluatorevaluator;
privatefinalStringtest;
privatefinalSqlNodecontents;

publicIfSqlNode(SqlNodecontents,Stringtest){
this.test=test;
this.contents=contents;
this.evaluator=newExpressionEvaluator();
}

@Override
publicbooleanapply(DynamicContextcontext){
//context.getBindings()里面就存儲(chǔ)這請(qǐng)求參數(shù)，這里是一個(gè)HashMap，OGNl里面代碼博主沒(méi)有研究。
//如果條件if成立，直接獲取contents中的SqlNode的apply方法進(jìn)行動(dòng)態(tài)腳本處理。
if(evaluator.evaluateBoolean(test,context.getBindings())){
contents.apply(context);
returntrue;
}
returnfalse;
}

}

這塊代碼很多遞歸調(diào)用，博主自認(rèn)為講的不太透徹，所以大家看完務(wù)必自己去調(diào)試下。

總結(jié)

Mybatis動(dòng)態(tài)Sql從解析到執(zhí)行分為2個(gè)過(guò)程下面對(duì)這個(gè)2個(gè)過(guò)程進(jìn)行簡(jiǎn)單總結(jié)。
1.動(dòng)態(tài)Sql生成SqlNode信息，這個(gè)過(guò)程發(fā)生在對(duì)select、update等Sql語(yǔ)句解析過(guò)程。如果是靜態(tài)Sql直接會(huì)把#{}替換成？。
2.動(dòng)態(tài)Sql解析在獲取BoundSql時(shí)候觸發(fā)。會(huì)調(diào)用SqlNode的apply進(jìn)行Sql解析成靜態(tài)Sql，然后把#{}替換成？，并綁定ParameterMapping映射。