Tomcat源码分析--部署应用程序

Tomcat分为静态部署和动态部署两种。

Tomcat静态部署

所谓静态部署，简单一点可以理解为Tomcat容器未运行时部署应用程序。我们已经知道若将一个war文件放置到webapps目录下，然后启动Tomcat容器，war文件会被解压运行，而这一过程就是静态部署。接下来我们的主要目标就是要学习Tomcat源码是如何书写这一过程的。

在Host容器中有一个HostConfig监听器，它也实现了LifecycleListener接口，所以我们可以在HostConfig类中找到lifecycleEvent方法。当在lifecycleEvent方法中触发START_EVENT事件时就开始进入部署程序的逻辑。START_EVENT最终会调用deployApps(); 我们先来着重看一下deployWARs(appBase, filteredAppPaths)方法。

deployWARs()方法就是用来部署war文件的。在第一次阅读这个方法时你会看到一些重要的if语句，但可能不解其意，没有关系回过头来我们还要来重读这段代码。在第一次阅读该方法的关键是要看到results.add(es.submit(new DeployWar(this, cn, war)));语句。在该语句中会打开一个加载War包的线程。在这个线程中最终会调用deployWAR(ContextName cn, File war)方法。这个方法初看起来会让人云山雾绕，为了便于理解我们需要了解一些额外的知识。

额外知识

第一个额外知识我们需要知道Host组件中的一些重要属性，如下：

xmlBase：此虚拟主机的XML Base目录。这是一个目录的路径名，其中可能包含要部署在此虚拟主机上的上下文 XML 描述符。用户可以设定自定义路径，如果未指定， conf/<engine_name>/<host_name>将使用默认值。

copyXML：boolean值 是否将/META-INF/context.xml文件拷贝到xmlBase所定义的文件路径当中 默认值为 false

unpackWARs：boolean值：true 将war包解压部署，fasle不解压直接部署。默认值是true

deployXML：Boolean值：是否解析/META-INF/context.xml文件 true 解析 fasle 不解析，默认值 true

第二个额外知识是我们需要知道在Tomcat容器中有一个“应用程序上下文"的概念。在这里我们可以将应用程序上下文简单的理解为一个context.xml(这样理解并不准确，但是可以让我们更简单的理解deployWAR()方法)；文件。相对于Tomcat容器来来说，从应用覆盖范围上可以将上下文文件划分为三种，第一种是在我们自己程序中的/META-INF/context.xml下。第二种是适用于一个所有主机下的web程序在$CATALINA_BASE/conf/[enginename]/[hostname]/context.xml.default 文件中，但三种就是适用于当前容器中所有程序的上下文配置在$CATALINA_BASE/conf/context.xml文件中。

第三个额外知识是需要我们知道，我们可以提升某一个应用程序上下文的作用范围，比如我们有一个test-001项目，我们可以将这个项目的context.cml文件拷贝到$CATALINA_BASE/conf/[enginename]/[hostname]/目录下以提升上下文等级。

好了现在我们可以来分析代码了，我们首先来看第一段try-catch代码，在这段代码中主要包含四个重要的if语句

复制代码
try {
    // 从解压后的war包中加载上下文文件
    if (deployThisXML && useXml && !copyXML) {
        synchronized (digesterLock) {
            try {
                context = (Context) digester.parse(xml);
            } catch (Exception e) {
                log.error(sm.getString("hostConfig.deployDescriptor.error", war.getAbsolutePath()), e);
            } finally {
                digester.reset();
                if (context == null) {
                    context = new FailedContext();
                }
            }
        }
        context.setConfigFile(xml.toURI().toURL());
    } else if (deployThisXML && xmlInWar) { // 从war包中加载上下文文件
        synchronized (digesterLock) {
            try (JarFile jar = new JarFile(war)) {
                JarEntry entry = jar.getJarEntry(Constants.ApplicationContextXml);
                try (InputStream istream = jar.getInputStream(entry)) {
                    context = (Context) digester.parse(istream);
                }
            } catch (Exception e) {
                log.error(sm.getString("hostConfig.deployDescriptor.error", war.getAbsolutePath()), e);
            } finally {
                digester.reset();
                if (context == null) {
                    context = new FailedContext();
                }
                context.setConfigFile(UriUtil.buildJarUrl(war, Constants.ApplicationContextXml));
            }
        }
        // 项目中有上下文文件，但是不解析
    } else if (!deployThisXML && xmlInWar) {
        // Block deployment as META-INF/context.xml may contain security
        // configuration necessary for a secure deployment.
        log.error(sm.getString("hostConfig.deployDescriptor.blocked",
                               cn.getPath(), Constants.ApplicationContextXml,
                               new File(host.getConfigBaseFile(), cn.getBaseName() + ".xml")));
    } else {
        // 使用默认配置时，使用默认上下文环境。（这是当下的重点）
        context = (Context) Class.forName(contextClass).getConstructor().newInstance();
    }
} catch (Throwable t) {
    ExceptionUtils.handleThrowable(t);
    log.error(sm.getString("hostConfig.deployWar.error", war.getAbsolutePath()), t);
} finally {
    if (context == null) {
        context = new FailedContext();
    }
}
复制代码

接下来我们看第二段代码，这段代码的主要作用就是在实现刚刚提到的第三个额外知识点，知道了第三点以后以下代码阅读起来就简单很多了。

复制代码
boolean copyThisXml = false;
if (deployThisXML) {
    if (host instanceof StandardHost) {
        copyThisXml = ((StandardHost) host).isCopyXML();
    }

    // If Host is using default value Context can override it.
    // 如果主机使用默认值(默认是false)，则上下文可以覆盖它
    if (!copyThisXml && context instanceof StandardContext) {
        copyThisXml = ((StandardContext) context).getCopyXML();
    }

    if (xmlInWar && copyThisXml) {
        // Change location of XML file to config base
        // 将XML文件的位置更改为config_base
        xml = new File(host.getConfigBaseFile(), cn.getBaseName() + ".xml");
        try (JarFile jar = new JarFile(war)) {
            JarEntry entry = jar.getJarEntry(Constants.ApplicationContextXml);
            try (InputStream istream = jar.getInputStream(entry);
                 FileOutputStream fos = new FileOutputStream(xml);
                 BufferedOutputStream ostream = new BufferedOutputStream(fos, 1024)) {
                byte buffer[] = new byte[1024];
                while (true) {
                    int n = istream.read(buffer);
                    if (n < 0) {
                        break;
                    }
                    ostream.write(buffer, 0, n);
                }
                ostream.flush();
            }
        } catch (IOException e) {
            /* Ignore */
        }
    }
}
复制代码

接下来我们来看最后一段代码(我就不在贴代码了)，最后一段代码又是一段try-catch，这段代码目前对我们来说需要知道两个重点，第一个重点是host.addChild(context);这一行代码。在读到这一行代码时我们必须反应过来这行代码一执行那么随之而来的就是加载Context组件生命周期方法，所以接下来我们需要将重点转移到Context组件当中。第二个重点是finally语句中的代码，在finally语句中主要是在保存当前所部属程序的状态，在这里大家也可以简单思考一下为什么要保存这些状态。

Tomcat动态部署

所谓动态部署，简单理解就是在Tomcat运行时部署应用或更新应用。假设我们有一个名为test.war的程序包正在tomcat中运行，此时我们更新test.war包后程序会被重新加载，在这个过程中一个随之而来的问题就是Tomcat是如何知到我们更新了程序。一种合理的推断是，在Tomcat中可能存在一段类似于永真循坏的代码一直在检查我们的程序是否发生了变更。事实也确实如此。当tomcat触发STARTING_PREP事件时会调用start方法。在ContainerBase类中startInternal()会调用threadStart();该方法大致内容如下。

......
threadDone = false;
String threadName = "ContainerBackgroundProcessor[" + toString() + "]";
thread = new Thread(new ContainerBackgroundProcessor(), threadName);
thread.setDaemon(true);
thread.start();
......

这个方法的关键之处是开启了一个后台线程，来调用ContainerBase类的background()方法。background()方法会发送一个PERIODIC_EVENT事件，而当HostConfig类中监听到该事件类型时会调用HostConfig类的check()方法以来检查我们部署的程序是否发生过变更。在check()方法中当下应重点关注deployed变量，在这个变量中保存的就是我们所部署过的程序，那这个变量是在哪里赋值的呢？还记得deployWAR()方法中第二段try-catch语句中的finally语句吗？大家可以在去看一下那段源码。checkResources()就是在检查我们的程序是否发生过变更，而这个是否发生过变更的判断依据是文件的修改时间。

复制代码
protected void check() {
     if (host.getAutoDeploy()) {
         // Check for resources modification to trigger redeployment
         DeployedApplication[] apps = deployed.values().toArray(new DeployedApplication[0]);
         for (DeployedApplication app : apps) {
             if (tryAddServiced(app.name)) {
                 try {
                     checkResources(app, false);
                 } finally {
                     removeServiced(app.name);
                 }
             }
         }
         ......
             // Hotdeploy applications
             deployApps();
     }
 }
复制代码

这个check()方法最终还是会调用deployApps()方法。这里应当注意到静态部署调用deployApps()方法，动态部署同样调用deployApps()方法，但是在静态部署中分析deployWARs()方法时有一段代码只是一笔带过，现在我们在来看看这段代码。

这是deployWARs()方法的主要代码，现在我们看这段代码要把重点放在if (deploymentExists(cn.getName())) 语句上，当程序已经部署了并且没有发生改变时会执行continue语句，也就是不会在重复部署。

复制代码
...... 
File war = new File(appBase, file);
if (file.toLowerCase(Locale.ENGLISH).endsWith(".war") && war.isFile() && !invalidWars.contains(file)) {
    ContextName cn = new ContextName(file, true);
    if (tryAddServiced(cn.getName())) {
        try {
            if (deploymentExists(cn.getName())) {
                DeployedApplication app = deployed.get(cn.getName());
                boolean unpackWAR = unpackWARs;
                if (unpackWAR && host.findChild(cn.getName()) instanceof StandardContext) {
                    unpackWAR = ((StandardContext) host.findChild(cn.getName())).getUnpackWAR();
                }
                if (!unpackWAR && app != null) {
                    // Need to check for a directory that should not be
                    // there
                    File dir = new File(appBase, cn.getBaseName());
                    if (dir.exists()) {
                        if (!app.loggedDirWarning) {
                            log.warn(sm.getString("hostConfig.deployWar.hiddenDir",
                                                  dir.getAbsoluteFile(), war.getAbsoluteFile()));
                            app.loggedDirWarning = true;
                        }
                    } else {
                        app.loggedDirWarning = false;
                    }
                }
                removeServiced(cn.getName());
                continue;
            }
            ......
复制代码

 

posted @   一十三  阅读(208)  评论(0)  编辑  收藏  举报
相关博文：
·  Tomcat源码分析--类加载器
·  Tomcat源码分析使用NIO接收HTTP请求(六)----变更工程目录
·  Tomcat部署及优化
·  详解Tomcat 配置文件server.xml
·  企业级web应用服务器--Tomcat（二）
阅读排行：
· 震惊！C++程序真的从main开始吗？99%的程序员都答错了
· 单元测试从入门到精通
· 【硬核科普】Trae如何「偷看」你的代码？零基础破解AI编程运行原理
· 上周热点回顾（3.3-3.9）
· winform 绘制太阳，地球，月球 运作规律
点击右上角即可分享
微信分享提示
AI IDE Trae