ibatis配置文件解析过程中对DTD的加载处理

By | 02月16日
Advertisement

一、背景知识

使用JAXP(Java API for XML Parsing)来解析XML文档,支持基于对象和基于事件的两种解析方式。基于对象的解析,目前只支持W3C DOM解析,基于事件的解析,只有SAX解析模式被支持。

SAX是一种基于事件的解析模式,解析文档的时候,当遇到开始标签,结束标签或字符等,SAX都会产生相应的事件。一个SAX解释器解析XML文档的时候,把文档看作为一个流,依次产生相应的事件报告给已注册的content handler(实现org.xml.sax.ContentHandler接口);如果有错误,错误会报告给error handler(实现org.xml.sax.ErrorHandler接口)。如果你不注册一个error handler,那你根本不会知道在解析XML文档的时候有没有出错。SAX解析文档时,一个典型的事件被触发的顺序是:startDocument、startElement、characters、endElement、endDocument。startDocument和endDocument仅仅被触发一次。

DOM解析是基于对象的原理,当用DOM解析XML文档时,它会在内存中生成一个树形的结构来表示一个XML文档。树上的每个节点代表着XML文档的一个节点。大部分DOM解析器允许你抽取XML文档的一部分来生成DOM树,而不是把整个XML文档在内存中建立对应的DOM树。

DTD是XML文档的语法。如果一份XML文档声明了DOCTYPE,并且想在解析的时候根据DTD校验文档,那你必须在适当的factory里启用根据DTD校验文档(validation)这个特性。例如:

       DocumentBuilderFactory dbfactory = DocumentBuilderFactory.newInstance();
       dbfactory.setValidating(true);

或者

       SAXParserFactory spfactory = SAXParserFactory.newInstance();
       spfactory.setValidating(true);

注意,如果XML文档声明了一个DTD ,即使你不启用校验(validation)这个特性,解析器总是试着去读入这个DTD。 这样做的目的是为了保证XML文档中entity reference被正确的扩展了,否则会导致格式不正确的XML文档,只有在XML文档序言部分的声明中standalone属性被置为true时,外部的DTD才会被完全忽略掉。例如:

<?xml version="1.1" encoding="UTF-8" standalone="yes"?>

二、ibatis配置文件解析过程中对DTD的加载处理

ibatis的xml配置文件示例:

<?xml version="1.0" encoding="GB2312" ?>
<!DOCTYPE sqlMap PUBLIC "-//ibatis.apache.org//DTD SQL Map 2.0//EN" "http://ibatis.apache.org/dtd/sql-map-2.dtd">
<sqlMap namespace="mySpace">
     ...
</sqlMap>

在解析该xml文档时,需要获取DTD文件,便于进行验证。由于该DTD文件是通过一个远程的URL获取的,这不但会影响文档解析的速度,而且当没有联网的时候,将导致解析失败。那么是否存在一种方法,在本地提供DTD文件,这样在解析文档的时候,只需要访问本地的DTD文件即可,省去了网络的访问过程? 确实有这样的方法,而且ibatis的代码(以ibatis 2.3.0这个版本为例)在解析其配置文件时,也是这么做的。

ibatis定义了一个类SqlMapClasspathEntityResolver,它负责在解析XML文档时,去加载DTD文件。该类实现了SAX定义的接口:org.xml.sax.EntityResolver。该接口定义如下:

package org.xml.sax;
public interface EntityResolver {
    public InputSource resolveEntity(String publicID, String systemID) throws SAXException;
}

这个接口中的唯一方法resolveEntity,提供了获取外部实体引用的方式。SqlMapClasspathEntityResolver的源代码如下:

/**
 * Offline entity resolver for the iBATIS DTDs
 */
public class SqlMapClasspathEntityResolver implements EntityResolver {

  private static final String SQL_MAP_CONFIG_DTD = "com/ibatis/sqlmap/engine/builder/xml/sql-map-config-2.dtd";
  private static final String SQL_MAP_DTD = "com/ibatis/sqlmap/engine/builder/xml/sql-map-2.dtd";

  private static final Map doctypeMap = new HashMap();

  static {
    doctypeMap.put("http://www.ibatis.com/dtd/sql-map-config-2.dtd".toUpperCase(), SQL_MAP_CONFIG_DTD);
    doctypeMap.put("http://ibatis.apache.org/dtd/sql-map-config-2.dtd".toUpperCase(), SQL_MAP_CONFIG_DTD);
    doctypeMap.put("-//iBATIS.com//DTD SQL Map Config 2.0//EN".toUpperCase(), SQL_MAP_CONFIG_DTD);
    doctypeMap.put("-//ibatis.apache.org//DTD SQL Map Config 2.0//EN".toUpperCase(), SQL_MAP_CONFIG_DTD);

    doctypeMap.put("http://www.ibatis.com/dtd/sql-map-2.dtd".toUpperCase(), SQL_MAP_DTD);
    doctypeMap.put("http://ibatis.apache.org/dtd/sql-map-2.dtd".toUpperCase(), SQL_MAP_DTD);
    doctypeMap.put("-//iBATIS.com//DTD SQL Map 2.0//EN".toUpperCase(), SQL_MAP_DTD);
    doctypeMap.put("-//ibatis.apache.org//DTD SQL Map 2.0//EN".toUpperCase(), SQL_MAP_DTD);
  }

  /**
   * Converts a public DTD into a local one
   *
   * @param publicId Unused but required by EntityResolver interface
   * @param systemId The DTD that is being requested
   * @return The InputSource for the DTD
   * @throws SAXException If anything goes wrong
   */
  public InputSource resolveEntity(String publicId, String systemId)
      throws SAXException {

    if (publicId != null) publicId = publicId.toUpperCase();
    if (systemId != null) systemId = systemId.toUpperCase();

    InputSource source = null;
    try {
      String path = (String) doctypeMap.get(publicId);
      source = getInputSource(path, source);
      if (source == null) {
        path = (String) doctypeMap.get(systemId);
        source = getInputSource(path, source);
      }
    } catch (Exception e) {
      throw new SAXException(e.toString());
    }
    return source;
  }

  private InputSource getInputSource(String path, InputSource source) {
    if (path != null) {
      InputStream in = null;
      try {
        in = Resources.getResourceAsStream(path);
        source = new InputSource(in);
      } catch (IOException e) {
        // ignore, null is ok
      }
    }
    return source;
  }

}

通过源码可以看出,在获取DTD文件的时候,根据映射关系,将远程的url转成本地的DTD文件路径,从而直接从本地jar中获取到DTD文件,而不是通过访问url来获取DTD文件。

ibatis对XML配置文件的解析,是通过com.ibatis.sqlmap.engine.builder.xml.SqlMapConfigParser类的parse方法来完成的。而在构造SqlMapConfigParser对象时,正是通过设置SqlMapClasspathEntityResolver来定位DTD文件的:

  public SqlMapConfigParser(XmlConverter sqlMapConfigConv, XmlConverter sqlMapConv) {
    super(new Variables());
    parser.setValidation(true); // 需要使用DTD文件验证XML是否合法
    parser.setEntityResolver(new SqlMapClasspathEntityResolver()); // 用来定位DTD文件

    vars.sqlMapConfigConv = sqlMapConfigConv;
    vars.sqlMapConv = sqlMapConv;
    vars.delegate = new SqlMapExecutorDelegate();
    vars.typeHandlerFactory = vars.delegate.getTypeHandlerFactory();
    vars.client = new SqlMapClientImpl(vars.delegate);
    registerDefaultTypeAliases();
    addSqlMapConfigNodelets();
    addGlobalPropNodelets();
    addSettingsNodelets();
    addTypeAliasNodelets();
    addTypeHandlerNodelets();
    addTransactionManagerNodelets();
    addSqlMapNodelets();
    addResultObjectFactoryNodelets();
  }

Similar Posts:

  • 【zz】Linux启动过程中硬件模块的加载

    文章来源不详. 阅读Linux内核启动代码的直接动力是我想编写RTL8019AS的网卡驱动程序(2.4.18内核只支持了CS8900A).既然要写驱动,我就想知道它是怎么样被加载的,好奇心驱使我先去搞定这个问题. 拿到2.4.18的软件包,一万多个文件,我不知怎么下手.所幸手头有这么三件工具助我入门: 1,一块移植好linux的开发板,通过它可以看到linux启动过程打印的消息. 2, google,网上关于linux的资料真是太多了!!! 3, Windows文件搜索引擎,通过它可以知道在那些

  • Unity3D的网络游戏中实现资源动态加载

    用Unity3D制作基于web的网络游戏,不可避免的会用到一个技术-资源动态加载.比如想加载一个大场景的资源,不应该在游戏的开始让用户长时间等待全部资源的加载完毕.应该优先加载用户附近的场景资源,在游戏的过程中,不影响操作的情况下,后台加载剩余的资源,直到所有加载完毕. 本文包含一些代码片段讲述实现这个技术的一种方法.本方法不一定是最好的,希望能抛砖引玉.代码是C#写的,用到了Json,还有C#的事件机制. 在讲述代码之前,先想象这样一个网络游戏的开发流程.首先美工制作场景资源的3D建模,游戏设

  • ibatis配置文件解析之总体流程

    配置文件解析是使用iBatis的第一步.那么,ibatis是如何实现其配置文件解析呢?本文将在较高的抽象层次上讲述ibatis配置文件解析的总体流程. 一切都从new SqlMapConfigParser().parse(reader);这条语句开始的.这条语句包含了ibatis配置文件解析的全部内容.这条语句包括两部分内容:创建sqlMapConfigParser对象和执行器parse方法.下面就分别来讲述这两部分内容究竟做了些什么工作. 首先看一下SqlMapConfigParser对象创建

  • .NET配置文件解析过程详解(二)

    .NET配置文件解析过程详解(二) 在上一篇文章的基础上,我们继续我们的解析 以machine.config文件内部定义的部分section handler为例,来分析各个配置节点的工厂是如何产生具体程序对象的. <configuration>下的section handlers IgnoreSectionHandler 在machine.config的<configSections>中有以下section是不在sectiongroup里的,换句话说这些section对应的xml节

  • 【iOS runtime】iOS中函数的动态加载

    iOS runtime 函数的动态加载,以类目的加载为例. ObjC中函数的动态加载很多地方都有涉及,其中最常见的就是类目(category)了,bundle loading里面有这样一句话: The executable code files in loadable bundles hold class (and category) definitions that the NSBundle object can dynamically load while the application r

  • 其原因可能是堆被损坏,这也说明 xxx.exe 中或它所加载的任何 DLL 中有 bug

    1.代码如下: string src ="abcdabcd"; char* dst = new char[8]; strcpy(dst,src.c_str()); delete[] dst; 2.在release模式下,报错 其原因可能是堆被损坏,这也说明 xxx.exe 中或它所加载的任何 DLL 中有 bug. 3.原因是,src的长度为9,包含一个字符结束符0(不是字符0,而是取值为0,也就是NULL),对于dst,new出来的长度不够,copy的时候踩了内存,踩了一个字节的内存

  • WebLogic中应用类库预先加载的设置

    War应用类库预先加载方法: (1)将war包打入ear包中,当然还需要有META-INF文件,带有weblogic-application.xml和application.xml,主要就是在weblogic-application.xml中配置prefer-application-packages,如下: <weblogic-application> <prefer-application-packages> <package-name>antlr.*</pac

  • android中的spinner动态加载内容

    android中的spinner动态加载数据: GroupPurchase.java package jftt.txlong; import java.util.ArrayList; import java.util.List; import android.app.Activity; import android.os.Bundle; import android.util.Log; import android.view.View; import android.widget.Adapter

  • 给.NET中的Windows窗体加载Xp样式

    给.NET中的Windows窗体加载Xp样式 介绍 当Windows XP 带着他特有的可视化样式或者主题发布时,许多人为他拥有的华丽界面而兴奋.然而,当.NET1.0正式版本发布的时候,许多人包括我自己为Windows 窗体不支持Windows XP 的可视化样式而失望.我对可视化样式的API函数和微软的.NET框架开发文档进行了一番研究,而后认识到为.NET应用程序加上Xp样式也不是很难. 下面的将通过一个简单的程序来为你的程序和控件加上Xp样式.内容适用于一些拥有能实现Xp样式的属性的控件

  • 解决动态调用其他APK中的类so加载失败问题

    在一个APK中去加载并调用另一个已安装的APK中类,为了方便描述,调用的APK成为主A,被调用的的B,B中的类需要加载so,B独立运行时so能加载成功,但由A加载调用B时会提示so加载失败,进一步分析是在loadLibrary的时候so查找路径为空,而B自己独立运行时查找路径会包括/data/data/B包名/lib,由此为突破口,发现使用PathLoader加载B中的类时可以传入libraryPath路径,于是传入/data/data/B包名/lib,问题解决 import com.test.

Tags: