Tomcat修行之路-5.读取xml文件之Digester对象

于 2020-12-21 21:57:46 发布
阅读量174 收藏
点赞数
分类专栏： Tomcat修行之路 文章标签： tomcat java
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.youkuaiyun.com/weixin_44836755/article/details/111500870
版权
本文详细介绍了Tomcat启动过程中的核心组件Digester的工作原理及配置文件解析流程，通过解析xml配置文件生成一系列对象，如StandardServer、StandardService等。

摘要生成于 C知道 ，由 DeepSeek-R1 满血版支持， 前往体验 >

概述

Digester

在Tomcat源码中org.apache.catalina.startup.Catalina对象的load方法里面，有一个xml文件的解析器。如下图：

public void load() {

    if (loaded) {
        return;
    }
    loaded = true;

    long t1 = System.nanoTime();

    initDirs();

    // Before digester - it may be needed
    initNaming();

    // Create and execute our Digester
    // xml配置文件的解析器
    Digester digester = createStartDigester();

    InputSource inputSource = null;
    InputStream inputStream = null;
    File file = null;
    try {
        try {
            file = configFile();
            inputStream = new FileInputStream(file);
            inputSource = new InputSource(file.toURI().toURL().toString());
        } catch (Exception e) {
            if (log.isDebugEnabled()) {
                log.debug(sm.getString("catalina.configFail", file), e);
            }
        }
        if (inputStream == null) {
            try {
                inputStream = getClass().getClassLoader()
                    .getResourceAsStream(getConfigFile());
                inputSource = new InputSource
                    (getClass().getClassLoader()
                     .getResource(getConfigFile()).toString());
            } catch (Exception e) {
                if (log.isDebugEnabled()) {
                    log.debug(sm.getString("catalina.configFail",
                            getConfigFile()), e);
                }
            }
        }

        // This should be included in catalina.jar
        // Alternative: don't bother with xml, just create it manually.
        if (inputStream == null) {
            try {
                inputStream = getClass().getClassLoader()
                        .getResourceAsStream("server-embed.xml");
                inputSource = new InputSource
                (getClass().getClassLoader()
                        .getResource("server-embed.xml").toString());
            } catch (Exception e) {
                if (log.isDebugEnabled()) {
                    log.debug(sm.getString("catalina.configFail",
                            "server-embed.xml"), e);
                }
            }
        }


        if (inputStream == null || inputSource == null) {
            if  (file == null) {
                log.warn(sm.getString("catalina.configFail",
                        getConfigFile() + "] or [server-embed.xml]"));
            } else {
                log.warn(sm.getString("catalina.configFail",
                        file.getAbsolutePath()));
                if (file.exists() && !file.canRead()) {
                    log.warn("Permissions incorrect, read permission is not allowed on the file.");
                }
            }
            return;
        }

        try {
            inputSource.setByteStream(inputStream);
            digester.push(this);
            digester.parse(inputSource);
        } catch (SAXParseException spe) {
            log.warn("Catalina.start using " + getConfigFile() + ": " +
                    spe.getMessage());
            return;
        } catch (Exception e) {
            log.warn("Catalina.start using " + getConfigFile() + ": " , e);
            return;
        }
    } finally {
        if (inputStream != null) {
            try {
                inputStream.close();
            } catch (IOException e) {
                // Ignore
            }
        }
    }

    getServer().setCatalina(this);
    getServer().setCatalinaHome(Bootstrap.getCatalinaHomeFile());
    getServer().setCatalinaBase(Bootstrap.getCatalinaBaseFile());

    // Stream redirection
    initStreams();

    // Start the new server
    try {
        getServer().init();
    } catch (LifecycleException e) {
        if (Boolean.getBoolean("org.apache.catalina.startup.EXIT_ON_INIT_FAILURE")) {
            throw new java.lang.Error(e);
        } else {
            log.error("Catalina.start", e);
        }
    }

    long t2 = System.nanoTime();
    if(log.isInfoEnabled()) {
        log.info("Initialization processed in " + ((t2 - t1) / 1000000) + " ms");
    }
}

在第17行，有一个获取配置文件的方法。实现如下：

protected Digester createStartDigester() {
    long t1=System.currentTimeMillis();
    // Initialize the digester
    Digester digester = new Digester();
    digester.setValidating(false);
    digester.setRulesValidation(true);
    Map<Class<?>, List<String>> fakeAttributes = new HashMap<>();
    List<String> objectAttrs = new ArrayList<>();
    objectAttrs.add("className");
    fakeAttributes.put(Object.class, objectAttrs);
    // Ignore attribute added by Eclipse for its internal tracking
    List<String> contextAttrs = new ArrayList<>();
    contextAttrs.add("source");
    fakeAttributes.put(StandardContext.class, contextAttrs);
    digester.setFakeAttributes(fakeAttributes);
    digester.setUseContextClassLoader(true);

    // Configure the actions we will be using
    digester.addObjectCreate("Server",
                             "org.apache.catalina.core.StandardServer",
                             "className");
    digester.addSetProperties("Server");
    digester.addSetNext("Server",
                        "setServer",
                        "org.apache.catalina.Server");

    digester.addObjectCreate("Server/GlobalNamingResources",
                             "org.apache.catalina.deploy.NamingResourcesImpl");
    digester.addSetProperties("Server/GlobalNamingResources");
    digester.addSetNext("Server/GlobalNamingResources",
                        "setGlobalNamingResources",
                        "org.apache.catalina.deploy.NamingResourcesImpl");

    digester.addObjectCreate("Server/Listener",
                             null, // MUST be specified in the element
                             "className");
    digester.addSetProperties("Server/Listener");
    digester.addSetNext("Server/Listener",
                        "addLifecycleListener",
                        "org.apache.catalina.LifecycleListener");

    digester.addObjectCreate("Server/Service",
                             "org.apache.catalina.core.StandardService",
                             "className");
    digester.addSetProperties("Server/Service");
    digester.addSetNext("Server/Service",
                        "addService",
                        "org.apache.catalina.Service");

    digester.addObjectCreate("Server/Service/Listener",
                             null, // MUST be specified in the element
                             "className");
    digester.addSetProperties("Server/Service/Listener");
    digester.addSetNext("Server/Service/Listener",
                        "addLifecycleListener",
                        "org.apache.catalina.LifecycleListener");

    //Executor
    digester.addObjectCreate("Server/Service/Executor",
                     "org.apache.catalina.core.StandardThreadExecutor",
                     "className");
    digester.addSetProperties("Server/Service/Executor");

    digester.addSetNext("Server/Service/Executor",
                        "addExecutor",
                        "org.apache.catalina.Executor");


    digester.addRule("Server/Service/Connector",
                     new ConnectorCreateRule());
    digester.addRule("Server/Service/Connector",
                     new SetAllPropertiesRule(new String[]{"executor", "sslImplementationName"}));
    digester.addSetNext("Server/Service/Connector",
                        "addConnector",
                        "org.apache.catalina.connector.Connector");

    digester.addObjectCreate("Server/Service/Connector/SSLHostConfig",
                             "org.apache.tomcat.util.net.SSLHostConfig");
    digester.addSetProperties("Server/Service/Connector/SSLHostConfig");
    digester.addSetNext("Server/Service/Connector/SSLHostConfig",
            "addSslHostConfig",
            "org.apache.tomcat.util.net.SSLHostConfig");

    digester.addRule("Server/Service/Connector/SSLHostConfig/Certificate",
                     new CertificateCreateRule());
    digester.addRule("Server/Service/Connector/SSLHostConfig/Certificate",
                     new SetAllPropertiesRule(new String[]{"type"}));
    digester.addSetNext("Server/Service/Connector/SSLHostConfig/Certificate",
                        "addCertificate",
                        "org.apache.tomcat.util.net.SSLHostConfigCertificate");

    digester.addObjectCreate("Server/Service/Connector/SSLHostConfig/OpenSSLConf",
                             "org.apache.tomcat.util.net.openssl.OpenSSLConf");
    digester.addSetProperties("Server/Service/Connector/SSLHostConfig/OpenSSLConf");
    digester.addSetNext("Server/Service/Connector/SSLHostConfig/OpenSSLConf",
                        "setOpenSslConf",
                        "org.apache.tomcat.util.net.openssl.OpenSSLConf");

    digester.addObjectCreate("Server/Service/Connector/SSLHostConfig/OpenSSLConf/OpenSSLConfCmd",
                             "org.apache.tomcat.util.net.openssl.OpenSSLConfCmd");
    digester.addSetProperties("Server/Service/Connector/SSLHostConfig/OpenSSLConf/OpenSSLConfCmd");
    digester.addSetNext("Server/Service/Connector/SSLHostConfig/OpenSSLConf/OpenSSLConfCmd",
                        "addCmd",
                        "org.apache.tomcat.util.net.openssl.OpenSSLConfCmd");

    digester.addObjectCreate("Server/Service/Connector/Listener",
                             null, // MUST be specified in the element
                             "className");
    digester.addSetProperties("Server/Service/Connector/Listener");
    digester.addSetNext("Server/Service/Connector/Listener",
                        "addLifecycleListener",
                        "org.apache.catalina.LifecycleListener");

    digester.addObjectCreate("Server/Service/Connector/UpgradeProtocol",
                              null, // MUST be specified in the element
                              "className");
    digester.addSetProperties("Server/Service/Connector/UpgradeProtocol");
    digester.addSetNext("Server/Service/Connector/UpgradeProtocol",
                        "addUpgradeProtocol",
                        "org.apache.coyote.UpgradeProtocol");

    // Add RuleSets for nested elements
    digester.addRuleSet(new NamingRuleSet("Server/GlobalNamingResources/"));
    digester.addRuleSet(new EngineRuleSet("Server/Service/"));
    digester.addRuleSet(new HostRuleSet("Server/Service/Engine/"));
    digester.addRuleSet(new ContextRuleSet("Server/Service/Engine/Host/"));
    addClusterRuleSet(digester, "Server/Service/Engine/Host/Cluster/");
    digester.addRuleSet(new NamingRuleSet("Server/Service/Engine/Host/Context/"));

    // When the 'engine' is found, set the parentClassLoader.
    digester.addRule("Server/Service/Engine",
                     new SetParentClassLoaderRule(parentClassLoader));
    addClusterRuleSet(digester, "Server/Service/Engine/Cluster/");

    long t2=System.currentTimeMillis();
    if (log.isDebugEnabled()) {
        log.debug("Digester for server.xml created " + ( t2-t1 ));
    }
    return digester;

}

ps：代码比较长
先介绍下Digester的一些基础知识。一般来说，Java里解析xml文件的方式有俩种：一种是Dom4J之类将文件全部读取到内存中，在内存中构造一颗Dom树的方式来解析。
一种是SAX的读取文件流的方式，在流中碰到相应的xml节点触发相应的节点事件回调相应方法，基于事件的解析方法，优点是按需加载，不需要先将文件读取到内存中。
Digester本身就是采用SAX的解析方式，在上层提供了一层包装，对于使用者更加友好。刚开始是在Struts1里面用的，后来独立出来。Tomcat又把它封装了一层。
使用步骤一般来说有四步：

  1. 实例化一个Digester对象，并在对象里设置相应节点的解析规则
  2. 设置要解析的文件作为输入源，这里输入源与SAX里的一样，用以表示一个xml实体
  3. 将当前对象压入栈
  4. 调用Digester的parse方法解析xml，生成相应对象
    注：第 3 步中将当前对象压入栈中的作用是可以保存一个到 Digester 生成的一系列对象直接的引用，方便后续使用而已，所以不必是当前对象，只要有一个地方存放这个引用即可。

这样经过对 xml 文件的解析将会产生org.apache.catalina.core.StandardServer、org.apache.catalina.core.StandardService、org.apache.catalina.connector.Connector、org.apache.catalina.core.StandardEngine、org.apache.catalina.core.StandardHost、org.apache.catalina.core.StandardContext 等等一系列对象，这些对象从前到后前一个包含后一个对象的引用（一对一或一对多的关系）。
解析完 xml 之后关闭文件流，接着设置 StandardServer 对象（该对象在上面解析 xml 时）的 catalina 的引用为当前对象，这种对象间的双向引用在 Tomcat 的很多地方都会碰到。

Digester解析XML文件
weixin_45324483的博客
11-10 900
这是我的第一篇博客，基本都是从多个博客中借鉴过来，然后按照自己的理解整理了一下写的，第一次写博客不知道该注意什么，有不好的地方请指出，非常感谢 一、前言 SAX是基于文件流来解析xml文件的，在读取xml文件流时，SAX会通过节点来触发相应的操作，也可以说SAX是基于文件流的事情触发机制来解析xml文件的。 Digeter是apache的common项目，作用是将XML转化成对象，使...
从入门到放弃(1)-tomcat -spring web.xml
li_yan_sring的博客
01-28 305
不知不觉，转行已经四年了，感谢当时的选择，开启了我的新的世界。如果没有当初的选择，可能现在在老家工地上搬砖。在这几年里，也渐渐从小白变成所谓中高级后端开发工程师。走过坑 ，趟过泥，写过屎山代码。言归正传，开始从入门到放弃的系列。 最近也在看tomcat源码，也在逐渐理解一个http请求的来龙去脉。现在不写这个，先写tomcat是如何初始化spring。 先理解一下spring ContextLoa...
如何在tomcat服务器中读取xml文件(路径问题)
Kindle_code的专栏
08-22 3494
因为之前用的dom4j读取的都是本地的xml文件，所以一旦在服务器中就不能再像之前那样获取xml路径了。 可以通过反射获得项目的src的路径。问题：如何在服务器中读取xml文件(路径问题)读取product.xml文件 解决方案: 解决代码://获得Document对象 Document doc = null; try { InputSt
Tomcat中是如何解析xml文件的？---Digester库
weixin_45127611的博客
09-29 433
XML文件解析的两种方案。 Java解析XML文件有两个主要的思想，分别是： 1. 预加载DOM树 该方法的思路是：将整个XML文件读取到内存中，在内容中构造一个DOM树，也叫对象模型集合，然后java代码只需要操作这个树就可以。 例子：spring中解析xml库：dom4j 该方法的主要实现为DOM解析，在此基础上有两个扩展：JDOM解析，DOM4J解析。这两种方法的思路都是一样的，只不过一个是官方出的，一个是社区出的，好不好用的问题。Java很奇怪，都是社区出的更好用，即DOM4J。 该思想的优点和缺点
Tomcat源码分析(三)--连接器是如何与容器关联的？
海海人生
07-06 189
这篇文章要弄懂一个问题，我们知道，一个链接器是跟一个容器关联的，容器跟链接器是在什么时候关联上的？ 　 在明白这个问题前要先了解一下Digester库，这个库简单的说就是解析xml文件，这里有两个概念：模式和规则，所谓模式就是一个xml的标签，规则就是遇到一个xml标签需要做什么，看一下他主要的三个方法： 1：addObjectCreate(String pattern, Strin...
Tomcat源码分析之ClassLoader部分的设计详细分析
fjs的专栏
03-16 3721
读Tomcat的源码也算是有一段时间了吧，感觉读的也是断断续续的，这次写一篇比较综合性的吧，来看看Tomcat的整体ClassLoader体系的设计。。。。 在具体的涉及到源码之前，先来一张图来整体的描述一下整体的结构吧：
Digester在tomcat中的使用
weixin_30345055的博客
08-28 177
上一篇文章我们了解了Digester的基本使用方法，今天这篇文章我们来看下Digester类在tomcat中的具体使用，tomcat使用Digester类来解析相关的xml文件，包括web.xml和server.xml，我们先讨论下server.xml，web.xml下次讨论。 在之前的tomcat启动过程源码讲解的时候，我们讲过Catalina类实例的load()，源码如下 /** * Sta...
Java代码解析XML文件实践：Digester应用详解
3. 使用Digester的parse方法读取XML文件并应用规则。 4. Digester会自动创建对象并将它们组织成对象树，根据规则填充属性和调用方法。 ### 关键规则定义方法 - `addObjectCreateRule`：创建新的对象。 - `...
Tomcat原理系列之四：Tomat如何启动spring(加载web.xml)
2017年
08-14 2879
Tomcat如何启动spring。我们为啥要配置ContextLoaderListener监听器。Tomcat如何加载web.xml文件
Tomcat7.0源码分析——server.xml文件的加载与解析
热门推荐
beliefer的博客
04-01 1万+
作为Java程序员，对于tomcat的server.xml想必都不陌生。本文基于Tomcat7.0的Java源码，对server.xml文件是如何加载和解析进行分析。
Tomcat启动部分源代码分析(三) -- 载入
臭美
10-28 274
二. 载入 2. Bootstrap的#Bootstrap#load(String[] arguments)方法。 方法的源代码如下述所示： [code="java"] private void load(String[] arguments) throws Exception { // 要调用的方法名 String methodName = "load"; /...
tomcat源码分析-Container初始化与加载
weixin_34128411的博客
07-03 184
我们谈到tomcat时，第一印象是它是一种servlet容器，这个概念是相当抽象和本质的，我们仍然对tomcat的内幕很陌生。我们知道，tomcat由Connector和Container两大组件构成，Connector在前面的文章已经介绍过了，今天我们就来看看Container是怎么回事。 一、Container基本结构 前文中有讲到，Co...
Tomcat启动停止慢问题查找解决
井底之蛙
03-01 1万+
Tomcat启动停止慢问题查找解决 一、概述   使用封装的tomcat组件进行web服务部署时，导致tomcat服务在服务启动和停止中用时比较长，结合tomcat的运行日志进行问题分析。 运行日志如下：   二、tomcat服务停止慢问题 1、现象 根据tomcat的运行日志发现，进行了3次tomcat停止操作过程中，第一次tomcat服务停止用时接近5分钟，第二次和第三次tomc...
tomcat源码解读一 Digester的解析方式
jack_Zheng的博客
11-13 1534
1    Digester Digester在tomcat中的作用是对conf下的server.xml文件进行实例化，其是从Catalian这个组件开始，创建Digester实例，再添加对应的规则，然后将其实例化，通过setServer方法，将其实例话的对象作为当前Catalian实例的句柄。这样就实现了对象句柄之间的关联引用，从而实现整个平台的递进启动。   1.1    UML类图
tomcat源码研读笔记—tomcat的启动之四 StandardHost的启动
plkkoko的专栏
03-21 781
我们首先了解下standardHost的继承关系：然后查看start代码如下： public synchronized void start() throwsLifecycleException {       // Set error report valve       if ((errorReportValveClass != null)           &amp;&amp; (!err...
Digester简介和使用
leileibest_437147623的专栏
01-13 8772
一、Digester简介                   1、sax简单介绍，对于XML的解析java有很多种实现，如DOM、SAX等，degister就是基于SAX实现，SAX提供了文件读取的底层接口，它是基于事件驱动类型。在解析XML的过程中，元素通过匹配模式(matching pattern)进行识别，比如当扫描到文节点元素(element)开始或者结束这些地方的时候会通知事件处理函数...
tomcat7中Digester的使用以及对server.xml的解析过程分析
chijunmei7041的博客
05-17 174
原文链接 tomcat在启动的时候，会调用Catalina的load的方法启动一个新的Server实例，在这里会有关于Digester的使用，以及对server.xml的解析过程。 load方法的代码如下： public void load() { ... // Creat...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值