Tomcat目录部署与Context描述文件context.xml

在Web应用开发完毕后,一些项目有时候采用目录部署的形式,而且是在server.xml中增加Context配置的形式,例如下面这种形式:

<Context path="/test" docBase="/home/abc/test"/>

但是官方并不鼓励这样配置,可以通过两种在外部文件配置的形式,不影响Tomcat主配置来实现同样的效果。

$CATALINA_BASE/conf/[enginename]/[hostname]/[webappname].xml

$CATALINA_BASE/webapps/[webappname]/META-INF/context.xml

前面曾写过Tomcat的应用部署(WEB应用是怎么被部署的?如何在Tomcat中部署应用的多个版本),当时没有详细介绍context.xml。

关于上面提到的这两种形式,内容一样,只是在不同的位置进行配置,例如上面在server.xml中配置的内容,可以在创建一个名为test.xml的文件,将其存放在Tomcat的conf/localhost/test.xml,即上面两项的第一种情况,这里注意应用的名称会直接使用文件名,path的配置会被忽略。

严格来说,第二种并不能直接替换前面server.xml里的情况,所能解决的是对于webapps目录内部署应用的额外配置,例如manager这个应用,要增加远程访问限制(为什么你的Manager登录不成功?),就是通过第二种,在META-INF目录内增加context.xml来实现的。

而实质上这两种统一称为Context的描述文件(Context Descriptor)。这些描述文件里包含一些应用对于Context的特定配置,例如配置Session Manager,指定naming Resrouce,定义SessionCookie名称等。使用描述文件,相当于给Context做了自定义,没提供描述文件的应用,Tomcat就会直接使用默认值初始化应用。

而且还有一点,使用描述文件定义的应用,会先部署。

下面来看源代码

源码

在HostConfig中,所有的部署从这儿开始。

protected void deployApps() {File appBase = host.getAppBaseFile();File configBase = host.getConfigBaseFile();String[] filteredAppPaths = filterAppPaths(appBase.list());// Deploy XML descriptors from configBase deployDescriptors(configBase, configBase.list());// Deploy WARs deployWARs(appBase, filteredAppPaths);// Deploy expanded folders deployDirectories(appBase, filteredAppPaths);}

我们看到部署顺序:
部署XML描述文件

部署WAR应用

部署解压的Web应用

其中读取应用的目录就是各个Host对应的appBase对应的配置,我们常用的webapps目录是虚拟主机localhost默认对应的位置。

部署描述符,即第一种webappname.xml的时候,会从configBase中遍历所有以xml描述文件,然后部署之。

for (int i = 0; i < files.length; i++) {File contextXml = new File(configBase, files[i]);if (files[i].toLowerCase(Locale.ENGLISH).endsWith(".xml")) {ContextName cn = new ContextName(files[i], true);// 看这里if (isServiced(cn.getName()) || deploymentExists(cn.getName()))continue;results.add(es.submit(new DeployDescriptor(this, cn, contextXml)));}}for (Future<?> result : results) {try {result.get();} catch (Exception e) {log.error(sm.getString("hostConfig.deployDescriptor.threaded.error"), e);}}

其中注意ContextName生成那行代码,是直接使用了文件名进行Context的设置,ContextName我们前面文章看过源代码,这里配置的就是path,即实际请求的应用名称。
然后实际部署时,先通过Digester解析文件获取Context对象,再进行属性配置,之后的部署流程和其它的一致。
在StandardContext的初始化流程中,会判断获取之前设置的configFile对象,不为空会解析文件内容。

而我们上面的第二种方式:为应用提供context.xml,在Tomcat代码内,称之为ApplicationContextXml。

这个文件是在第二和第三个部署的时候,解析META-INF目录下是否包含context.xml,然后设置Context的configFile属性。初始化Context的时候,会有如下逻辑
if (context.getConfigFile() != null) {processContextConfig(digester, context.getConfigFile());}

这个就是前面webappname.xml解析时设置configFile之后走的流程,在ContextConfig中。Digester的解析请看前面的文章:Tomcat配置文件解析与Digester

这样一来,我们的自定义配置文件就在Tomcat中生效了。

关注Tomcat那些事儿,发现更多精彩文章!了解各种常见问题背后的原理与答案。深入源码,分析细节,内容原创,欢迎关注。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,542评论 6 493
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,596评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 158,021评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,682评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,792评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,985评论 1 291
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,107评论 3 410
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,845评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,299评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,612评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,747评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,441评论 4 333
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,072评论 3 317
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,828评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,069评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,545评论 2 362
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,658评论 2 350

推荐阅读更多精彩内容