mybatis $和#源代碼分析

JDBC中，主要使用兩種語句，一種是支持參數化和預編譯的PreparedStatement,支持原生sql,支持設置占位符，參數化輸入的參數，防止sql注入攻擊，在mybatis的mapper配置文件中，我們通過使用#和$告訴mybatis我們需要對參數進行怎樣的設置。sql注入指的是利用現有應用程序將惡意的sql命令提交存在安全漏洞。例如在提交表單時加入or拼接語句使其永遠成立。對比JDBC執行流程connection->statement->result,在mybatis中由SqlSession提供給用戶操作的API，Excutor具體執行數據庫的操作。

SqlSession接口主要的實現類有：

先看DefaultSqlSession:

selectOne的方法最終轉化成了selectList方法

最終執行的是箭頭指的selectList方法，該方法中含有變量：MappedSatement和Excutor,MappedSatement是加載mapper.xml時匹配的namespace+id

StrictMap是Configuration類中的一個靜態內部類，繼承了HashMap,看一下selectList方法調用的wrapCollection方法

這就是為什么我們在mapper.xml中foreach用list或array遍歷，再看Excutor執行的query方法，Excutor接口實現類

BaseExcutor的query方法：

由上可知若設置清除緩存，首先會清除緩存，首先會根據CacheKey查找緩存，查找結果為空，則從數據庫查

doQuery:

可見Executor委托給StatementHandler執行查詢，在此之前有一個預編譯的過程（prepareStatement方法），StatementHandler接口的實現類：CallableStatementHandler,PreparedStatementHandler,SimpleStatementHandler對應JDBC中的CallableStatement,PreparedStatement和Statement,分別的執行方法：

看之前提到的prepareStatement方法

handler會對statement參數化設置，PreparedStatementHandler中：

由parameterhandler執行參數設置，上面是簡單分析的查詢流程，回頭說$和#，我們知道，使用$時statement執行的是拼接操作，#的時候statement用的是占位符？，這是mybatis解析的時候造成的，根據測試例子：

SqlSessionFactoryBuilder的build方法：

XMLConfigBuilder負責解析總配置文件，其中方法有：

返回值都為XNode節點類型，看mapperElement:

package掃描包，resource和class掃描指定類和mapper.xml,XMLMapperBuilder:

主要看這兩個方法，根據節點建立statement:

由上可以看出XMLStatementBuilder解析statement,也就是mapper.xml中的一個個statement,快成功了。。。

parseStatementNode解析一條記錄中的各個屬性，例如resultType,parameterType,useCache等等。。。該方法代碼過長，其主要在：

兩處，一個是SqlSource,一個是addMappedStatement,解析的屬性值都對應到MappedStatement對象中

在MappedStatement對象中除這些外，還有個屬性SqlSource,可見該對象決定sql語句的解析

只有一個抽象方法getBoundSql,SqlSource是如何獲取的呢，這就用到了上面prepareStatement方法中的LanguageDriver的createSqlSource方法，繼續跟進：

解析sql語句之前會先解析selectKey和include節點，LanguageDriver的實現類有XMLLanguageDriver和RawLanguageDriver

可以知道createSqlSource方法只在XMLLanguageDriver實現

委托給了XMLScriptBuilder的parseScriptNode方法：

 1 public SqlSource parseScriptNode() {
 2     List<SqlNode> contents = parseDynamicTags(context);
 3     MixedSqlNode rootSqlNode = new MixedSqlNode(contents);
 4     SqlSource sqlSource = null;
 5     if (isDynamic) {
 6       sqlSource = new DynamicSqlSource(configuration, rootSqlNode);
 7     } else {
 8       sqlSource = new RawSqlSource(configuration, rootSqlNode, parameterType);
 9     }
10     return sqlSource;
11   }

根據isDynamic標志確定sqlSource類型，parseDynamicTags方法：

 1  private List<SqlNode> parseDynamicTags(XNode node) {
 2     List<SqlNode> contents = new ArrayList<SqlNode>();
 3     NodeList children = node.getNode().getChildNodes();
 4     for (int i = 0; i < children.getLength(); i++) {
 5       XNode child = node.newXNode(children.item(i));
 6       if (child.getNode().getNodeType() == Node.CDATA_SECTION_NODE || child.getNode().getNodeType() == Node.TEXT_NODE) {
 7         String data = child.getStringBody("");
 8         TextSqlNode textSqlNode = new TextSqlNode(data);
 9         if (textSqlNode.isDynamic()) {
10           contents.add(textSqlNode);
11           isDynamic = true;
12         } else {
13           contents.add(new StaticTextSqlNode(data));
14         }
15       } else if (child.getNode().getNodeType() == Node.ELEMENT_NODE) { // issue #628
16         String nodeName = child.getNode().getNodeName();
17         NodeHandler handler = nodeHandlers.get(nodeName);
18         if (handler == null) {
19           throw new BuilderException("Unknown element <" + nodeName + "> in SQL statement.");
20         }
21         handler.handleNode(child, contents);
22         isDynamic = true;
23       }
24     }
25     return contents;
26   }

返回值是一個list,過程：

?遍歷各個子節點

(1) 如果節點類型是文本或者CDATA，構造一個TextSqlNode或StaticTextSqlNode

(2) 如果節點類型是元素，說明該節點是個動態sql，然后會使用NodeHandler處理各個類型的子節點。這里的NodeHandler是XMLScriptBuilder的一個內部接口，其實現類包括TrimHandler、WhereHandler、SetHandler、IfHandler、ChooseHandler等。看類名也就明白了這個Handler的作用，比如我們分析的trim節點，對應的是TrimHandler；if節點，對應的是IfHandler...，TextSqlNode的isDynamic方法：

1   public boolean isDynamic() {
2     DynamicCheckerTokenParser checker = new DynamicCheckerTokenParser();
3     GenericTokenParser parser = createParser(checker);//建立GenericTokenParser
4     parser.parse(text);//GenericTokenParser解析text
5     return checker.isDynamic();
6   }

createParser方法：

?1 private GenericTokenParser createParser(TokenHandler handler) { 2 return new GenericTokenParser("${", "}", handler); 3 }?

構造方法：

1   public GenericTokenParser(String openToken, String closeToken, TokenHandler handler) {
2     this.openToken = openToken;
3     this.closeToken = closeToken;
4     this.handler = handler;
5   }

根據是否Dynamic,TokenHandler的主要實現類有：DynamicCheckerTokenParser和ParameterMappingTokenHandler,VariableTokenHandler

?1 private GenericTokenParser createParser(TokenHandler handler) { 2 return new GenericTokenParser("${", "}", handler); 3 }?//$的處理方式

DynamicCheckerTokenParser實現的handleToken方法

1  public String handleToken(String content) {
2       this.isDynamic = true;
3       return null;
4     }

ParameterMappingTokenHandler實現的handleToken方法：

1  public String handleToken(String content) {//#的處理方式，返回占位符？
2       parameterMappings.add(buildParameterMapping(content));
3       return "?";
4     }

#的方式大概就是這樣，再看$,$使用的是DynamicCheckerTokenParser，這時候再看返回的DynamicSqlSource,其實現SqlSource接口的getBoundSql方法：

 1 public BoundSql getBoundSql(Object parameterObject) {
 2     DynamicContext context = new DynamicContext(configuration, parameterObject);
 3     rootSqlNode.apply(context);//apply方法實際調用的是TextSqlNode的applay方法
 4     SqlSourceBuilder sqlSourceParser = new SqlSourceBuilder(configuration);
 5     Class<?> parameterType = parameterObject == null ? Object.class : parameterObject.getClass();
 6     SqlSource sqlSource = sqlSourceParser.parse(context.getSql(), parameterType, context.getBindings());//SqlSourceBuilder的parse方法解析
 7     BoundSql boundSql = sqlSource.getBoundSql(parameterObject);
 8     for (Map.Entry<String, Object> entry : context.getBindings().entrySet()) {
 9       boundSql.setAdditionalParameter(entry.getKey(), entry.getValue());
10     }
11     return boundSql;
12   }

TextSqlNode的apply方法：

1 public boolean apply(DynamicContext context) {
2     GenericTokenParser parser = createParser(new BindingTokenParser(context));
3     context.appendSql(parser.parse(text));
4     return true;
5   }

用的是BindingTokenParser的parse方法：

 1  public String parse(String text) {
 2     StringBuilder builder = new StringBuilder();
 3     if (text != null && text.length() > 0) {
 4       char[] src = text.toCharArray();
 5       int offset = 0;
 6       int start = text.indexOf(openToken, offset);
 7       while (start > -1) {
 8         if (start > 0 && src[start - 1] == '\\') {
 9           // the variable is escaped. remove the backslash.
10           builder.append(src, offset, start - 1).append(openToken);
11           offset = start + openToken.length();
12         } else {
13           int end = text.indexOf(closeToken, start);
14           if (end == -1) {
15             builder.append(src, offset, src.length - offset);
16             offset = src.length;
17           } else {
18             builder.append(src, offset, start - offset);
19             offset = start + openToken.length();
20             String content = new String(src, offset, end - offset);
21             builder.append(handler.handleToken(content));//又回到了handleToken方法，此時的handler為BindingTokenParser
22             offset = end + closeToken.length();
23           }
24         }
25         start = text.indexOf(openToken, offset);
26       }
27       if (offset < src.length) {
28         builder.append(src, offset, src.length - offset);
29       }
30     }
31     return builder.toString();
32   }

BindingTokenParser的handleToken:

 1 public String handleToken(String content) {
 2       Object parameter = context.getBindings().get("_parameter");
 3       if (parameter == null) {
 4         context.getBindings().put("value", null);
 5       } else if (SimpleTypeRegistry.isSimpleType(parameter.getClass())) {
 6         context.getBindings().put("value", parameter);//從此處可以看出mapper.xml中$或#中可以用value
 7       }
 8       Object value = OgnlCache.getValue(content, context.getBindings());//此處用了ognl處理
 9       return (value == null ? "" : String.valueOf(value)); // issue #274 return "" instead of "null"
10     }