解析器模块「基础支持层」-MyBatis

基础支持层中封装了一些通用独立的模块，给MyBatis提供了支持，也可以在合适的场景中使用。解析器模块主要用于对解析XML文件。目前XML解析创建的方式有三种：

• DOM：基于树形结构的XML解析方式，它会将整个XML文档读入内存并构建一个DOM树，基于这棵形结构对各个节点进行操作。
• SAX：基于事件模式的XML解析方式，只需将XML的一部分加载到内存当中。那XML作为一个事件流进行处理
• StAX：和XML解析方式类似，同时也可以同时解析多个文档，应用程序通过调用解析器推进解析的进程。

1.XPath简介

MyBatis解析配置文件或者映射文件时，使用DOM的方式解析XML，XPath就是解析XML的语言。XPath之于XML就好比SQL语言之于数据库。XPath使用路径表达式来选取XML文档中指定的节点或者节点集合，与常见的URL路径有些类似。XPath是JDK1.5推出的，它是一个引擎和对象模型独立的XPath库。

2.XPathParser

封装了XPath、Document、EntityResolver：

public class XPathParser {
  	// Document对象
    private final Document document;
    // 是否开启验证
    private boolean validation;
    // 用于加载本地DTD文件
    private EntityResolver entityResolver;
    // mybatis-config.xml中<properties>标签定义的键值对集合
    private Properties variables;
  	// XPath对象
    private XPath xpath;
}

在实践中会提前设置EntityResolver来进行本地价值DTD文件，而不用联网加载。XMLMapperEntityResolver是MyBatis提供的EntityResolver接口的实现类。resolverEntity()方法加载本地的DTD文件。XPathParser中调用commonConstructor()方法完成初始化后，调用createDocument()方法可以创建一个document对象。XPathParser提供了一系列的eval*()方法用于解析boolean、short、long、int、string等类型的信息。其中evalString()方法，调用了**PropertyParser.parse()**方法处理节点中相应的默认值。

public class PropertyParser {

  private static final String KEY_PREFIX = "org.apache.ibatis.parsing.PropertyParser.";
  // 在config文件中<properties>节点下配置是否开启默认值功能的对应配置项
  public static final String KEY_ENABLE_DEFAULT_VALUE = KEY_PREFIX + "enable-default-value";
  // 配置占位符与默认值之间的默认分隔符的对应配置项
  public static final String KEY_DEFAULT_VALUE_SEPARATOR = KEY_PREFIX + "default-value-separator";
  // 默认情况下，关闭默认值的功能
  private static final String ENABLE_DEFAULT_VALUE = "false";
  // 默认分隔符是冒号
  private static final String DEFAULT_VALUE_SEPARATOR = ":"; 
  // 按顺序查找占位符的字面量，交给TokenHandler进行处理
  public static String parse(String string, Properties variables) {
    VariableTokenHandler handler = new VariableTokenHandler(variables);
    GenericTokenParser parser = new GenericTokenParser("${", "}", handler);
    return parser.parse(string);
  }

}

PropertyParser.parse()方法中会创建GenericTokenParser解析器，并将默认值的处理委托给GenericTokenParser.parse()方法。GenericTokenParser不仅仅用于解析xml中的默认值，也会用于SQL的解析，这里只是查找到了指定的占位符，而具体的解析行为会根据其持有的TokenHandler实现的不同而不同。

public class GenericTokenParser {
  // 占位符开始标记
  private final String openToken;
  // 占位符结束标记
  private final String closeToken;
  // TokenHandler接口的实现会按照一定的逻辑解析占位符
  private final TokenHandler handler;

占位符由TokenHandler接口的实现进行解析，TokenHandler接口共有4个实现，PropertyParser.parse()使用了VariableTokenHandler

  private static class VariableTokenHandler implements TokenHandler {
    // <properties>节点下定义的键值对
    private final Properties variables;
    // 是否支持占位符中使用默认值的功能
    private final boolean enableDefaultValue;
    // 指定占位符和默认值之间的分割符
    private final String defaultValueSeparator;

XPathParser.evalNode()方法返回值类型是XNode,其中也提供了很多get*()方法，获取所需节点的信息。

public class XNode {
  
  private final Node node;
  // 节点名称
  private final String name;
  // 节点的内容
  private final String body;
  // 节点属性集合
  private final Properties attributes;
  // 配置文件中<properties>节点下定义的键值对
  private final Properties variables;
  // 该XNode对象由此XPathParser对象生成
  private final XPathParser xpathParser;

  public XNode(XPathParser xpathParser, Node node, Properties variables) {
    this.xpathParser = xpathParser;
    this.node = node;
    this.name = node.getNodeName();
    this.variables = variables;
    // 初始化属性
    this.attributes = parseAttributes(node);
    // 初始化body
    this.body = parseBody(node);
  }