??xml version="1.0" encoding="utf-8" standalone="yes"?>
作者:Jack Shirazi
了解最常用的集合类型之一 Map 的基知识以及如何针对(zhn)应用程序特有的数据优化 Map?/span>
本文相关下蝲Q?/span> · Jack ?HashMap 试 · Oracle JDeveloper 10g |
java.util 中的集合cd?Java 中某些最常用的类?最常用的集合类?List ?Map?List 的具体实现包?ArrayList ?VectorQ它们是可变大小的列表,比较适合构徏、存储和操作Mcd对象的元素列表?List 适用于按数值烦引访问元素的情Ş?/span>
Map 提供了一个更通用的元素存储方法?Map 集合cȝ于存储元素对Q称?#8220;?#8221;?#8220;?#8221;Q,其中每个键映到一个倹{?从概念上而言Q?zhn)可以?List 看作是具有数值键?Map?而实际上Q除?List ?Map 都在定义 java.util 中外Q两者ƈ没有直接的联pR本文将着重介l核?Java 发行套g中附带的 MapQ同时还介l如何采用或实现更适用于?zhn)应用E序特定数据的专?Map?/span>
了解 Map 接口和方?/span>
Java 核心cM有很多预定义?Map cR?在介l具体实C前,我们先介l一?Map 接口本nQ以便了解所有实现的共同炏V?Map 接口定义了四U类型的Ҏ(gu)Q每?Map 都包含这些方法?下面Q我们从两个普通的Ҏ(gu)Q?a >?1Q开始对q些Ҏ(gu)加以介绍?/span>
?1Q?覆盖的方法?我们这 Object 的这两个Ҏ(gu)覆盖Q以正确比较 Map 对象的等h?/span>
Map 构徏 Map 定义了几个用于插入和删除元素的变换方法(?2Q?/span> ?2Q?Map 更新Ҏ(gu)Q?可以更改 Map 内容?/span>
管(zhn)可能注意到Q纵然假讑ֿ略构Z个需要传递给 putAll() ?Map 的开销Q?putAll() 通常也ƈ不比使用大量?put() 调用更有效率Q但 putAll() 的存在一点也不稀奇?q是因ؓQputAll() 除了q代 put() 所执行的将每个键值对d?Map 的算法以外,q需要P代所传递的 Map 的元素?但应注意QputAll() 在添加所有元素之前可以正调?Map 的大,因此如果(zhn)未亲自调整 Map 的大(我们对此进行简单介l)Q则 putAll() 可能比预期的更有效?/span> 查看 Map q代 Map 中的元素不存在直接了当的Ҏ(gu)?如果要查询某?Map 以了解其哪些元素满特定查询Q或如果要P代其所有元素(无论原因如何Q,则?zhn)首先需要获取该 Map ?#8220;视图”?有三U可能的视图Q参?a >?3Q?/span>
前两个视囑֝q回 Set 对象Q第三个视图q回 Collection 对象?p两种情况而言Q问题到q里q没有结束,q是因ؓ(zhn)无法直接P?Collection 对象?Set 对象。要q行q代Q?zhn)必须获得一?Iterator 对象?因此Q要q代 Map 的元素,必须q行比较烦琐的编?/span>
值得注意的是Q这些对象(Set、Collection ?IteratorQ实际上是基 Map 的视图,而不是包含所有元素的副本?q它们的用效率很高?另一斚wQCollection ?Set 对象?toArray() Ҏ(gu)却创建包?Map 所有元素的数组对象Q因此除了确实需要用数l中元素的情形外Q其效率q不高?/span> 我运行了一个小试Q随附文件中?Test1Q,该测试用了 HashMapQƈ使用以下两种Ҏ(gu)对P?Map 元素的开销q行了比较:
Oracle JDeveloper 包含一个嵌入的监测器,它测量内存和执行旉Q(zhn)能够快速识别代码中的瓶颈?我曾使用 Jdeveloper 的执行监器监测 HashMap ?containsKey() ?containsValue() Ҏ(gu)Qƈ很快发现 containsKey() Ҏ(gu)的速度?containsValue() Ҏ(gu)慢很多(实际上要慢几个数量Q)?Q参?a >?1 ?a >?2Q以及随附文件中?Test2 c)?/span> ?3Q?q回视图?Map Ҏ(gu)Q?使用q些Ҏ(gu)q回的对象,(zhn)可以遍?Map 的元素,q可以删?Map 中的元素?/span>
讉K元素 ?4 中列Z Map 讉KҎ(gu)。Map 通常适合按键Q而非按|q行讉K?Map 定义中没有规定这肯定是真的,但通常(zhn)可以期望这是真的?例如Q?zhn)可以期?containsKey() Ҏ(gu)?get() Ҏ(gu)一样快?另一斚wQcontainsValue() Ҏ(gu)很可能需要扫?Map 中的|因此它的速度可能比较慢?/span> ?4Q?Map 讉K和测试方法: q些Ҏ(gu)索有?Map 内容的信息但不更?Map 内容?/span>
对?containsKey() ?containsValue() 遍历 HashMap 中所有元素所需旉的测试表明,containsValue() 所需的时间要长很多?实际上要长几个数量Q?Q参?a >?1 ?a >?2Q以及随附文件中?Test2Q?因此Q如?containsValue() 是应用程序中的性能问题Q它?yu)很快显现出来,q可以通过监测(zhn)的应用E序L地将其识别?q种情况下,我相信?zhn)能够惛_一个有效的替换Ҏ(gu)来实?containsValue() 提供的等效功能?但如果想不出办法Q则一个可行的解决Ҏ(gu)是再创徏一?MapQƈ第一?Map 的所有g为键?q样Q第一?Map 上的 containsValue() 成为第二个 Map 上更有效?containsKey()?/span> 核心 Map Java 自带了各U?Map cR?q些 Map cd归ؓ三种cdQ?
内部哈希Q?哈希映射技?/span> 几乎所有通用 Map 都用哈希映?q是一U将元素映射到数l的非常单的机制Q?zhn)应了解哈希映的工作原理Q以便充分利?Map?/span> 哈希映射l构׃个存储元素的内部数组l成?׃内部采用数组存储Q因此必然存在一个用于确定Q意键讉K数组的烦引机制?实际上,该机刉要提供一个小于数l大的整数索引倹{?该机制称作哈希函数??Java Z哈希?Map 中,哈希函数对象{换ؓ一个适合内部数组的整数?(zhn)不必ؓL一个易于用的哈希函数而大伤脑{: 每个对象都包含一个返回整数值的 hashCode() Ҏ(gu)?要将该值映到数组Q只需其转换Z个正|然后在将该值除以数l大后取余数即可?以下是一个简单的、适用于Q何对象的 Java 哈希函数
Q? 二进制运符Q称作模Q将左侧的值除以右侧的|然后q回整数形式的余数。) 实际上,?1.4 版发布之前,q就是各U基于哈希的 Map cL使用的哈希函数?但如果?zhn)查看一下代码,(zhn)将看到
它实际上是用更快机制获取正值的同一函数??1.4 版中QHashMap cdC用一个不同且更复杂的哈希函数Q该函数Z Doug Lea ?util.concurrent E序包(E后我将更详l地再次介绍 Doug Lea 的类Q?/span> 该图介绍了哈希映的基本原理Q但我们q没有对其进行详l介l?我们的哈希函数将L对象映射C个数l位|,但如果两个不同的键映到相同的位|,情况会如何Q?q是一U必然发生的情况?在哈希映的术语中,q称作冲H?Map 处理q些冲突的方法是在烦引位|处插入一个链接列表,q简单地元素添加到此链接列表?因此Q一个基于哈希的 Map 的基?put() Ҏ(gu)可能如下所C?/span>
如果看一下各U基于哈希的 Map 的源代码Q?zhn)发现这基本上就是它们的工作原理?此外Q还有一些需要进一步考虑的事,如处理空键和g及调整内部数l?此处定义?put() Ҏ(gu)q包含相?get() 的算法,q是因ؓ插入包括搜烦映射索引处的以查明该键是否已经存在?Q即 get() Ҏ(gu)?put() Ҏ(gu)h相同的算法,?get() 不包含插入和覆盖代码。) 使用链接列表q不是解军_H的唯一Ҏ(gu)Q某些哈希映用另一U?#8220;开攑ּd”Ҏ(gu)Q本文对其不予介l?/span> 优化 Hasmap 如果哈希映射的内部数l只包含一个元素,则所有项映到此数l位|,从而构成一个较长的链接列表?׃我们的更新和讉K使用了对链接列表的线性搜索,而这要比 Map 中的每个数组索引只包含一个对象的情Ş要慢得多Q因此这样做的效率很低?讉K或更新链接列表的旉与列表的大小U性相养I而用哈希函数访问或更新数组中的单个元素则与数组大小无关 ?渐q性质QBig-O 表示法)而言Q前者ؓ O(n)Q而后者ؓ O(1)?因此Q用一个较大的数组而不是让太多的项聚集在太的数组位置中是有意义的?/span> 调整 Map 实现的大?/span> 在哈希术语中Q内部数l中的每个位|称?#8220;存储?#8221;(bucket)Q而可用的存储桶数Q即内部数组的大)UC定w (capacity)?Z Map 对象有效地处理Q意数目的,Map 实现可以调整自n的大?但调整大的开销很大?调整大小需要将所有元素重新插入到新数l中Q这是因Z同的数组大小意味着对象现在映射C同的索引倹{?先前冲突的键可能不再冲突Q而先前不冲突的其他键现在可能冲突?q显然表明,如果?Map 调整得够大Q则可以减少甚至不再需要重新调整大,q很有可能显著提高速度?/span> 使用 1.4.2 JVM q行一个简单的试Q即用大量的(数目过一百万Q填?HashMap??5 昄了结果,q将所有时间标准化为已预先讄大小的服务器模式Q关联文件中?Test3Q?对于已预先设|大的 JVMQ客L和服务器模式 JVM q行旉几乎相同Q在攑ּ JIT ~译阶段后)?但?Map 的默认大将引发多次调整大小操作Q开销很大Q在服务器模式下要多?50% 的时_而在客户端模式下几乎要多用两倍的旉Q?/span> ?5Q?填充已预先设|大的 HashMap 与填充默认大的 HashMap 所需旉的比?/span>
使用负蝲因子 为确定何时调整大,而不是对每个存储桶中的链接列表的深度q行记数Q基于哈希的 Map 使用一个额外参数ƈ_略计算存储桶的密度?Map 在调整大之前,使用名ؓ“负蝲因子”的参数指C?Map 承担的“负蝲”量,卛_的负载程度?负蝲因子、项敎ͼMap 大小Q与定w之间的关pȝ单明了:
例如Q如果默认负载因子ؓ 0.75Q默认容量ؓ 11Q则 11 x 0.75 = 8.25Q该值向下取整ؓ 8 个元素?因此Q如果将W?8 个项d到此 MapQ则?Map 自w的大小调整Z个更大的倹{?相反Q要计算避免调整大小所需的初始容量,用将要添加的Ҏ(gu)除以负蝲因子Qƈ向上取整Q例如,
奇数个存储桶?map 能够通过减少冲突数来提高执行效率?虽然我所做的试Q关联文件中?a target=_blank>Test4Qƈ未表明质数可以始l获得更好的效率Q但理想情Ş是容量取质数?1.4 版后的某?MapQ如 HashMap ?LinkedHashMapQ而非 Hashtable ?IdentityHashMapQ用需?2 的幂定w的哈希函敎ͼ但下一个最?2 的幂定wp?Map 计算Q因此?zhn)不必亲自计算?/span> 负蝲因子本n是空间和旉之间的调整折街?较小的负载因子将占用更多的空_但将降低冲突的可能性,从而将加快讉K和更新的速度?使用大于 0.75 的负载因子可能是不明智的Q而用大?1.0 的负载因子肯定是不明知的Q这是因必定会引发一ơ冲H?使用于 0.50 的负载因子好处ƈ不大Q但只要(zhn)有效地调整 Map 的大,应不会对负载因子造成性能开销Q而只会造成内存开销?但较?yu)的负蝲因子意味着如果(zhn)未预先调整 Map 的大,则导致更频繁的调整大,从而降低性能Q因此在调整负蝲因子时一定要注意q个问题?/span> 选择适当?Map 应用哪U?MapQ?它是否需要同步? 要获得应用程序的最x能Q这可能是所面的两个最重要的问题?当用通用 Map Ӟ调整 Map 大小和选择负蝲因子늛?Map 调整选项?/span> 以下是一个用于获得最?Map 性能的简单方?/span>
q(zhn)能够只更改一行代码即可非常轻村֜替换M特定?Map 实例?/span> Map 选择 也许(zhn)曾期望更复杂的考量Q而这实际上是否显得太Ҏ(gu)Q?好的Q让我们慢慢来?首先Q?zhn)应用哪U?MapQ?{案很简单: 不要为?zhn)的设计选择M特定?MapQ除非实际的设计需要指定一个特D类型的 Map?设计旉常不需要选择具体?Map 实现?(zhn)可能知道自己需要一?MapQ但不知道用哪U?而这恰恰是使用 Map 接口的意义所在?直到需要时再选择 Map 实现 ?如果随处使用“Map”声明的变量,则更改应用程序中MҎ(gu) Map ?Map 实现只需要更改一行,q是一U开销很少的调整选择?是否要用默认的 Map 实现Q?我很快将谈到q个问题?/span> 同步 Map 同步与否有何差别Q?Q对于同步,(zhn)既可以使用同步?MapQ也可以使用 Collections.synchronizedMap() 未同步?Map 转换为同步的 Map?后者?#8220;同步的包装器”Q这是一个异常复杂的选择Q完全取决于(zhn)如何根据多U程q发讉K和更C?MapQ同时还需要进行维护方面的考虑?例如Q如果?zhn)开始时未ƈ发更新特?MapQ但它后来更改ؓq发更新Q情况将如何Q?在这U情况下Q很Ҏ(gu)在开始时使用一个未同步?MapQƈ在后来向应用E序中添加ƈ发更新线E时忘记此未同步的 Map 更改为同步的 Map?q将使?zhn)的应用程序容易崩溃(一U要定和跟t的最p糕的错误)?但如果默认ؓ同步Q则因随之而来的可怕性能而序列化执行多线E应用程序?看v来,我们需要某U决{树来帮助我们正选择?/span> Doug Lea 是纽U州立大学奥斯威戈分校计机U学pȝ教授?他创Z一l公共领域的E序包(l称 util.concurrentQ,该程序包包含许多可以化高性能q行~程的实用程序类?q些cM包含两个 MapQ即 ConcurrentReaderHashMap ?ConcurrentHashMap?q些 Map 实现是线E安全的Qƈ且不需要对q发讉K或更新进行同步,同时q适用于大多数需?Map 的情c?它们q远比同步的 MapQ如 HashtableQ或使用同步的包装器更具伸羃性,q且?HashMap 相比Q它们对性能的破坏很?util.concurrent E序包构成了 JSR166 的基QJSR166 已经开发了一个包含在 Java 1.5 版中的ƈ发实用程序,?Java 1.5 版将把这?Map 包含在一个新?java.util.concurrent E序包中?/span>
下蝲 Oracle JDeveloper 10gQ?span class=bodycopy>改变(zhn)对 Java 开发的看法 Oracle JDeveloper 10g 中的监测?/font>Q?该监器利用 Java 虚拟Z的某些特性,使?zhn)能够发现应用E序代码中的~程~陷、性能问题以及内存泄漏?可以监器与调试器?CodeCoach 一起用来q行功能强大且有效的应用E序代码故障排除?了解更多有关事g监测、执行监以及内存监的信息? l束?/span> 通过 Oracle JDeveloper 可以非常L地创Z个用于比较各U?Map 性能的测试类?更重要的是,集成良好的监器可以在开发过E中快速、轻村֜识别性能瓉 - 集成?IDE 中的监测器通常被较频繁C用,以便帮助构徏一个成功的工程?现在Q?zhn)已经拥有了一个监器q了解了有关通用 Map 及其性能的基知识Q可以开始运行?zhn)自己的测试,以查明(zhn)的应用程序是否?Map 而存在瓶颈以及在何处需要更Ҏ(gu)使用?Map? 以上内容介绍了通用 Map 及其性能的基知识?当然Q有关特?Map 实现以及如何Ҏ(gu)不同的需求用它们还存在更多复杂和值得x的事,q些在本文W?2 部分中介l?/span>
equals(Object o)
比较指定对象与此 Map 的等h?/span>
hashCode()
q回?Map 的哈希码
clear()
?Map 中删除所有映?/span>
remove(Object key)
?Map 中删除键和关联的?/span>
put(Object key, Object value)
指定g指定键相兌
clear()
?Map 中删除所有映?/span>
putAll(Map t)
指?Map 中的所有映复制到?map
Iterator keyValuePairs = aMap.entrySet().iterator();
Iterator keys = aMap.keySet().iterator();
Iterator values = aMap.values().iterator();
int mapsize = aMap.size();
Iterator keyValuePairs1 = aMap.entrySet().iterator();
for (int i = 0; i < mapsize; i++)
{
Map.Entry entry = (Map.Entry) keyValuePairs1.next();
Object key = entry.getKey();
Object value = entry.getValue();
...
}
Object[] keyValuePairs2 = aMap.entrySet().toArray();
for (int i = 0; i < rem; i++) {
{
Map.Entry entry = (Map.Entry) keyValuePairs2[i];
Object key = entry.getKey();
Object value = entry.getValue();
...
}
此测试用了两种量Ҏ(gu)Q?一U是量q代元素的时_另一U测量?toArray 调用创徏数组的其他开销?W一U方法(忽略创徏数组所需的时_表明Q用已?toArray 调用中创建的数组q代元素的速度要比使用 Iterator 的速度大约?30%-60%?但如果将使用 toArray Ҏ(gu)创徏数组的开销包含在内Q则使用 Iterator 实际上要?10%-20%?因此Q如果由于某U原因要创徏一个集合元素的数组而非q代q些元素Q则应用该数组q代元素?但如果?zhn)不需要此中间数组Q则不要创徏它,而是使用 Iterator q代元素?/span>
entrySet()
q回 Map 中所包含映射?Set 视图?Set 中的每个元素都是一?Map.Entry 对象Q可以?getKey() ?getValue() Ҏ(gu)Q还有一?setValue() Ҏ(gu)Q访问后者的键元素和值元?/span>
keySet()
q回 Map 中所包含键的 Set 视图?删除 Set 中的元素q将删除 Map 中相应的映射Q键和|
values()
q回 map 中所包含值的 Collection 视图?删除 Collection 中的元素q将删除 Map 中相应的映射Q键和|
get(Object key)
q回与指定键兌的?/span>
containsKey(Object key)
如果 Map 包含指定键的映射Q则q回 true
containsValue(Object value)
如果?Map 一个或多个键映到指定|则返?true
isEmpty()
如果 Map 不包含键-值映,则返?true
size()
q回 Map 中的?值映的数目
int hashvalue = Maths.abs(key.hashCode()) % table.length;
int hashvalue = (key.hashCode() & 0x7FFFFFFF) % table.length;
public Object put(Object key, Object value) {
//我们的内部数l是一?Entry 对象数组
//Entry[] table;
//获取哈希码,q映到一个烦?
int hash = key.hashCode();
int index = (hash & 0x7FFFFFFF) % table.length;
//循环遍历位于 table[index] 处的链接列表Q以查明
//我们是否拥有此键??如果拥有Q则覆盖?
for (Entry e = table[index] ; e != null ; e = e.next) {
//必须查键是否相等Q原因是不同的键对象
//可能拥有相同的哈?
if ((e.hash == hash) && e.key.equals(key)) {
//q是相同键,覆盖该?
//q从该方法返?old ?
Object old = e.value;
e.value = value;
return old;
}
}
//仍然在此处,因此它是一个新键,只需d一个新 Entry
//Entry 对象包含 key 对象?value 对象、一个整型的 hash?
//和一个指向列表中的下一?Entry ?next Entry
//创徏一个指向上一个列表开头的?EntryQ?
//q将此新 Entry 插入表中
Entry e = new Entry(hash, key, value, table[index]);
table[index] = e;
return null;
}
客户端模?/span>
服务器模?/span>
预先讄的大?/span>
100%
100%
默认大小
294%
157%
Map criticalMap = new HashMap(); //?
HashMap criticalMap = new HashMap(); //?
所有这一切意味着(zhn)不需要一个决{树来决定是使用同步?Map q是使用非同步的 MapQ?而只需使用 ConcurrentHashMap?当然Q在某些情况下,使用 ConcurrentHashMap q不合适?但这些情况很见Qƈ且应具体情况具体处理?q就是监的用途?/span>
Jack Shirazi ?O'Reilly ?#8220;Java 性能调整”的作者,以及受欢q的 JavaPerformanceTuning.com |站Q提?Java 性能信息的全球知名站点)的ȝ?Jack ?Java 性能领域提供咨询q著书立说?他还监督 JavaPerformanceTuning.com 提供的信息,其中包括每年大约发布 1000 条性能技巧以及许多有x能工具、讨论组{内容的文章?Jack 早年q曾发布有关蛋白质结构预以及黑z热力学斚w的文章,而且在其I闲时还Ҏ(gu)?Perl5 核心模块作出了A献?/span>
]]>
]]>
部v描述W文件就像所有XML文g一P必须以一个XML头开始。这个头声明可以使用的XML版本q给出文件的字符~码?br />DOCYTPE声明必须立即出现在此头之后。这个声明告诉服务器适用的servlet规范的版本(?.2?.3Qƈ指定理此文件其余部分内容的语法的DTD(Document Type DefinitionQ文档类型定??br />所有部|描q符文g的顶层(根)元素为web-app。请注意QXML元素不像HTMLQ他们是大小写敏感的。因此,web-App和WEB-APP都是不合法的Qweb-app必须用小写?br />
2 部v描述W文件内的元素次?br />
XML 元素不仅是大写敏感的,而且它们q对出现在其他元素中的次序敏感。例如,XML头必L文g中的W一,DOCTYPE声明必须是第二项Q而web- app元素必须是第三项。在web-app元素内,元素的次序也很重要。服务器不一定强制要求这U次序,但它们允许(实际上有些服务器是q样做的Q完全拒l执行含有次序不正确的元素的Web应用。这表示使用非标准元素次序的web.xml文g是不可移植的?br />下面的列表给Z所有可直接出现在web-app元素内的合法元素所必需的次序。例如,此列表说明servlet元素必须出现在所有servlet-mapping元素之前。请注意Q所有这些元素都是可选的。因此,可以省略掉某一元素Q但不能把它放于不正的位置?br />l icon icon元素指出IDE和GUI工具用来表示Web应用的一个和两个囑փ文g的位|?br />l display-name display-name元素提供GUI工具可能会用来标记这个特定的Web应用的一个名U?br />l description description元素l出与此有关的说明性文本?br />l context-param context-param元素声明应用范围内的初始化参数?br />l filter qo器元素将一个名字与一个实现javax.servlet.Filter接口的类相关联?br />l filter-mapping 一旦命名了一个过滤器Q就要利用filter-mapping元素把它与一个或多个servlet或JSP面相关联?br />l listener servlet API的版?.3增加了对事g监听E序的支持,事g监听E序在徏立、修改和删除会话或servlet环境时得到通知。Listener元素指出事g监听E序cR?br />l servlet 在向servlet或JSP面制定初始化参数或定制URLӞ必须首先命名servlet或JSP面。Servlet元素是用来完成此项d的?br />l servlet-mapping 服务器一般ؓservlet提供一个缺省的URLQhttp://host/webAppPrefix/servlet/ServletName。但是,常常会更改这个URLQ以便servlet可以讉K初始化参数或更容易地处理相对URL。在更改~省URLӞ使用servlet-mapping元素?br />l session -config 如果某个会话在一定时间内未被讉KQ服务器可以抛弃它以节省内存。可通过使用HttpSession?setMaxInactiveIntervalҎ(gu)明确讄单个会话对象的超时|或者可利用session-config元素制定~省时倹{?br />l mime-mapping 如果Web应用h惛_Ҏ(gu)的文Ӟ希望能保证给他们分配特定的MIMEcdQ则mime-mapping元素提供q种保证?br />l welcom-file-list welcome-file-list元素指示服务器在收到引用一个目录名而不是文件名的URLӞ使用哪个文g?br />l error-page error-page元素使得在返回特定HTTP状态代码时Q或者特定类型的异常被抛出时Q能够制定将要显C的面?br />l taglib taglib元素Ҏ(gu)记库描述W文ӞTag Libraryu Descriptor fileQ指定别名。此功能使你能够更改TLD文g的位|,而不用编辑用这些文件的JSP面?br />l resource-env-ref resource-env-ref元素声明与资源相关的一个管理对象?br />l resource-ref resource-ref元素声明一个资源工厂用的外部资源?br />l security-constraint security-constraint元素制定应该保护的URL。它与login-config元素联合使用
l login-config 用login-config元素来指定服务器应该怎样l试图访问受保护面的用h权。它与sercurity-constraint元素联合使用?br />l security-role security-role元素l出安全角色的一个列表,q些角色出现在servlet元素内的security-role-ref元素的role-name子元素中。分别地声明角色可高IDE处理安全信息更ؓҎ(gu)?br />l env-entry env-entry元素声明Web应用的环境项?br />l ejb-ref ejb-ref元素声明一个EJB的主目录的引用?br />l ejb-local-ref ejb-local-ref元素声明一个EJB的本C目录的应用?br />
3 分配名称和定制的UL
在web.xml中完成的一个最常见的Q务是对servlet或JSP面l出名称和定制的URL。用servlet元素分配名称Q用servlet-mapping元素定制的URL与刚分配的名U相兌?br />3.1 分配名称
Z提供初始化参敎ͼ对servlet或JSP面定义一个定制URL或分配一个安全角Ԍ必须首先lservlet或JSP面一个名U。可通过 servlet元素分配一个名U。最常见的格式包括servlet-name和servlet-class子元素(在web-app元素内)Q如下所C:
<servlet>
<servlet-name>Test</servlet-name>
<servlet-class>moreservlets.TestServlet</servlet-class>
</servlet>
q表CZ于WEB-INF/classes/moreservlets/TestServlet的servlet已经得到了注册名Test。给 servlet一个名U具有两个主要的含义。首先,初始化参数、定制的URL模式以及其他定制通过此注册名而不是类名引用此servlet。其?可在 URL而不是类名中使用此名U。因此,利用刚才l出的定义,URL http://host/webAppPrefix/servlet/Test 可用?http://host/webAppPrefix/servlet/moreservlets.TestServlet 的场所?br />误住:XML元素不仅是大写敏感的,而且定义它们的次序也很重要。例如,web-app元素内所有servlet元素必须位于所有servlet- mapping元素Q下一节介绍Q之前,而且q要位于5.6节和5.11节讨论的与过滤器或文档相关的元素Q如果有的话Q之前。类似地Q?servlet 的servlet-name子元素也必须出现在servlet-class之前?.2?部v描述W文件内的元素次?详l介l这U必需的次序?br />例如Q程序清?-1l出了一个名为TestServlet的简单servletQ它ȝ在moreservletsE序包中。因为此servlet是扎根在一个名为deployDemo的目录中的Web应用的组成部分,所以TestServlet.class攑֜ deployDemo/WEB- INF/classes/moreservlets中。程序清?-2l出放|在deployDemo/WEB- INF/内的web.xml文g的一部分。此web.xml文g使用servlet-name和servlet-class元素名UTest?TestServlet.class相关联。图 5-1和图5-2分别昄利用~省URL和注册名调用TestServlet时的l果?br />
E序清单5-1 TestServlet.java
package moreservlets;
import java.io.*;
import javax.servlet.*;
import javax.servlet.http.*;
/** Simple servlet used to illustrate servlet naming
* and custom URLs.
*
* Taken from More Servlets and JavaServer Pages
* from Prentice Hall and Sun Microsystems Press,
* http://www.moreservlets.com/.
* © 2002 Marty Hall; may be freely used or adapted.
*/
public class TestServlet extends HttpServlet {
public void doGet(HttpServletRequest request,
HttpServletResponse response)
throws ServletException, IOException {
response.setContentType("text/html");
PrintWriter out = response.getWriter();
String uri = request.getRequestURI();
out.println(ServletUtilities.headWithTitle("Test Servlet") +
"<BODY BGCOLOR=\"#FDF5E6\">\n" +
"
URI: " + uri + "
\n" +
"</BODY></HTML>");
}
}
E序清单5-2 web.xmlQ说明servlet名称的摘录)
<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE web-app
PUBLIC "-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN"
"http://java.sun.com/dtd/web-app_2_3.dtd">
<web-app>
<!-- ?-->
<servlet>
<servlet-name>Test</servlet-name>
<servlet-class>moreservlets.TestServlet</servlet-class>
</servlet>
<!-- ?-->
</web-app>
3.2 定义定制的URL
大多数服务器h一个缺省的serlvet URLQ?br />http: //host/webAppPrefix/servlet/packageName.ServletName。虽然在开发中使用q个URL很方便,但是我们常常会希望另一个URL用于部v。例如,可能会需要一个出现在Web应用层的URLQ如Qhttp: //host/webAppPrefix/AnynameQ,q且在此URL中没有servletV位于顶层的URL化了相对URL的用。此外,对许多开发h员来_层URL看上L更长更麻烦的~省URL更简短?br />事实上,有时需要用定制的URL。比如,你可能想关闭~省URL映射Q以便更好地强制实施安全限制或防止用h外地讉K无初始化参数的servlet。如果你止了缺省的URLQ那么你怎样讉Kservlet呢?q时只有使用定制的URL了?br />Z分配一个定制的URLQ可使用servlet-mapping元素及其servlet-name和url-pattern子元素。Servlet- name元素提供了一个Q意名Uͼ可利用此名称引用相应的servletQurl-pattern描述了相对于Web应用的根目录的URL。url- pattern元素的值必M斜杠Q?Qv始?br />下面l出一个简单的web.xml摘录Q它允许使用URL http://host/webAppPrefix/UrlTest而不是http://host/webAppPrefix/servlet/Test?/a>
http: //host/webAppPrefix/servlet/moreservlets.TestServlet。请注意Q仍焉要XML头?DOCTYPE声明以及web-app闭元素。此外,可回忆一下,XML元素出现地次序不是随意的。特别是Q需要把所有servlet元素攑֜所?servlet-mapping元素之前?br /><servlet>
<servlet-name>Test</servlet-name>
<servlet-class>moreservlets.TestServlet</servlet-class>
</servlet>
<!-- ... -->
<servlet-mapping>
<servlet-name>Test</servlet-name>
<url-pattern>/UrlTest</url-pattern>
</servlet-mapping>
URL模式q可以包含通配W。例如,下面的小E序指示服务器发送所有以Web应用的URL前缀开始,?.aspl束的请求到名ؓBashMS的servlet?br /><servlet>
<servlet-name>BashMS</servlet-name>
<servlet-class>msUtils.ASPTranslator</servlet-class>
</servlet>
<!-- ... -->
<servlet-mapping>
<servlet-name>BashMS</servlet-name>
<url-pattern>/*.asp</url-pattern>
</servlet-mapping>
3.3 命名JSP面
因ؓJSP面要{换成sevletQ自然希望就像命名servlet一样命名JSP面。毕竟,JSP面可能会从初始化参数、安全设|或定制的URL中受益,正如普通的serlvet那样。虽然JSP面的后台实际上是servletq句话是正确的,但存在一个关键的猜疑Q即Q你不知道JSP面的实际类名(因ؓpȝ自己挑选这个名字)。因此,Z命名JSP面Q可jsp-file元素替换为servlet-calss元素Q如下所C:
<servlet>
<servlet-name>Test</servlet-name>
<jsp-file>/TestPage.jsp</jsp-file>
</servlet>
命名JSP面的原因与命名servlet的原因完全相同:即ؓ了提供一个与定制讄Q如Q初始化参数和安全设|)一起用的名称Qƈ且,以便能更Ҏ(gu)z?JSP面的URLQ比方说Q以便多个URL通过相同面得以处理Q或者从URL中去?jsp扩展名)。但是,在设|初始化参数Ӟ应该注意QJSP 面是利用jspInitҎ(gu)Q而不是initҎ(gu)d初始化参数的?br />例如Q程序清?-3l出一个名为TestPage.jsp的简单JSP面Q它的工作只是打印出用来Ȁzd的URL的本地部分。TestPage.jsp攄在deployDemo应用的顶层。程序清?-4l出了用来分配一个注册名PageNameQ然后将此注册名与http://host/webAppPrefix/UrlTest2/anything 形式的URL相关联的web.xml文gQ即QdeployDemo/WEB-INF/web.xmlQ的一部分?br />
E序清单5-3 TestPage.jsp
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<HTML>
<HEAD>
</HEAD>
<BODY BGCOLOR="#FDF5E6">URI: <%= request.getRequestURI() %>
</BODY>
</HTML>
E序清单5-4 web.xmlQ说明JSP命名的摘录Q?br /><?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE web-app
PUBLIC "-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN"
"http://java.sun.com/dtd/web-app_2_3.dtd">
<web-app>
<!-- ... -->
<servlet>
<servlet-name>PageName</servlet-name>
<jsp-file>/TestPage.jsp</jsp-file>
</servlet>
<!-- ... -->
<servlet-mapping>
<servlet-name> PageName </servlet-name>
<url-pattern>/UrlTest2/*</url-pattern>
</servlet-mapping>
<!-- ... -->
</web-app>
4 止Ȁzdservlet
对servlet 或JSP面建立定制URL的一个原因是Q这样做可以注册?initQservletQ或jspInitQJSP面Q方法中d得初始化参数。但是,初始化参数只在是利用定制URL模式或注册名讉K servlet或JSP面时可以用,用缺省URL http: //host/webAppPrefix/servlet/ServletName 讉K时不能用。因此,你可能会希望关闭~省URLQ这样就不会有h意外地调用初始化servlet了。这个过E有时称为禁止激zdservletQ因为多数服务器h一个用~省的servlet URL注册的标?servletQƈȀzȝ省的URL应用的实际servlet?br />有两U禁止此~省URL的主要方法:
l 在每个Web应用中重新映?servlet/模式?br />l 全局关闭Ȁzdservlet?br />重要的是应该注意刎ͼ虽然重新映射每个Web应用中的/servlet/模式比彻底禁止激zservlet所做的工作更多Q但重新映射可以用一U完全可UL的方式来完成。相反,全局止Ȁzdservlet完全是针对具体机器的Q事实上有的服务器(如ServletExecQ没有这L选择。下面的讨论Ҏ(gu)个Web应用重新映射/servlet/ URL模式的策略。后面提供在Tomcat中全局止Ȁzdservlet的详l内宏V?br />4.1 重新映射/servlet/URL模式
在一个特定的Web应用中禁止以http://host/webAppPrefix/servlet/ 开始的URL的处理非常简单。所需做的事情是建立一个错误消息servletQƈ使用前一节讨论的url-pattern元素所有匹配请求{向该 servlet。只要简单地使用Q?br /><url-pattern>/servlet/*</url-pattern>
作ؓservlet-mapping元素中的模式卛_?br />例如Q程序清?-5l出了将SorryServlet servletQ程序清?-6Q与所有以http://host/webAppPrefix/servlet/ 开头的URL相关联的部v描述W文件的一部分?br />
E序清单5-5 web.xmlQ说明JSP命名的摘录Q?br /><?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE web-app
PUBLIC "-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN"
"http://java.sun.com/dtd/web-app_2_3.dtd">
<web-app>
<!-- ... -->
<servlet>
<servlet-name>Sorry</servlet-name>
<servlet-class>moreservlets.SorryServlet</servlet-class>
</servlet>
<!-- ... -->
<servlet-mapping>
<servlet-name> Sorry </servlet-name>
<url-pattern>/servlet/*</url-pattern>
</servlet-mapping>
<!-- ... -->
</web-app>
E序清单5-6 SorryServlet.java
package moreservlets;
import java.io.*;
import javax.servlet.*;
import javax.servlet.http.*;
/** Simple servlet used to give error messages to
* users who try to access default servlet URLs
* (i.e., http://host/webAppPrefix/servlet/ServletName)
* in Web applications that have disabled this
* behavior.
*
* Taken from More Servlets and JavaServer Pages
* from Prentice Hall and Sun Microsystems Press,
* http://www.moreservlets.com/.
* © 2002 Marty Hall; may be freely used or adapted.
*/
public class SorryServlet extends HttpServlet {
public void doGet(HttpServletRequest request,
HttpServletResponse response)
throws ServletException, IOException {
response.setContentType("text/html");
PrintWriter out = response.getWriter();
String title = "Invoker Servlet Disabled.";
out.println(ServletUtilities.headWithTitle(title) +
"<BODY BGCOLOR=\"#FDF5E6\">\n" +
"
" + title + "
\n" +
"Sorry, access to servlets by means of\n" +
"URLs that begin with\n" +
"http://host/webAppPrefix/servlet/\n" +
"has been disabled.\n" +
"</BODY></HTML>");
}
public void doPost(HttpServletRequest request,
HttpServletResponse response)
throws ServletException, IOException {
doGet(request, response);
}
}
4.2 全局止ȀzdQTomcat
Tomcat 4中用来关闭缺省URL的方法与Tomcat 3中所用的很不相同。下面介l这两种Ҏ(gu)Q?br />1Q禁止激zdQ?Tomcat 4
Tomcat 4 用与前面相同的方法关闭激zdservletQ即利用web.xml中的url-mapping元素q行关闭。不同之处在于Tomcat使用了放?install_dir/conf中的一个服务器专用的全局web.xml文gQ而前面用的是存攑֜每个Web应用的WEB-INF目录中的标准 web.xml文g?br />因此Qؓ了在Tomcat 4中关闭激zdservletQ只需在install_dir/conf/web.xml中简单地注释?servlet/* URL映射即可,如下所C:
<!--
<servlet-mapping>
<servlet-name>invoker</servlet-name>
<url-pattern>/servlet/*</url-pattern>
</servlet-mapping>
-->
再次提醒Q应该注意这个项是位于存攑֜install_dir/conf的Tomcat专用的web.xml文g中的Q此文g不是存放在每个Web应用的WEB-INF目录中的标准web.xml?br />2Q禁止激zdQTomcat3
在Apache Tomcat 的版?中,通过在install_dir/conf/server.xml中注释出InvokerInterceptor全局止~省 servlet URL。例如,下面是禁止用缺省servlet URL的server.xml文g的一部分?br /><!--
<RequsetInterceptor
className="org.apache.tomcat.request.InvokerInterceptor"
debug="0" prefix="/servlet/" />
-->
5 初始化和预装载servlet与JSP面
q里讨论控制servlet和JSP面的启动行为的Ҏ(gu)。特别是Q说明了怎样分配初始化参C及怎样更改服务器生存期中装载servlet和JSP面的时刅R?br />5.1 分配servlet初始化参?br />利用init-param元素向servlet提供初始化参敎ͼinit-param元素hparam-name和param-value子元素。例如,在下面的例子中,如果initServlet servlet是利用它的注册名QInitTestQ访问的Q它?yu)能够从其方法中调?getServletConfig(). getInitParameter("param1")获得"Value 1"Q调?getServletConfig().getInitParameter("param2")获得"2"?br /><servlet>
<servlet-name>InitTest</servlet-name>
<servlet-class>moreservlets.InitServlet</servlet-class>
<init-param>
<param-name>param1</param-name>
<param-value>value1</param-value>
</init-param>
<init-param>
<param-name>param2</param-name>
<param-value>2</param-value>
</init-param>
</servlet>
在涉及初始化参数Ӟ有几炚w要注意:
l q回倹{GetInitParameter的返回值L一个String。因此,在前一个例子中Q可对param2使用Integer.parseInt获得一个int?br />l JSP中的初始化。JSP面使用jspInit而不是init。JSP面q需要用jsp-file元素代替servlet-class?br />l ~省URL。初始化参数只在通过它们的注册名或与它们注册名相关的定制URL模式讉KServlet时可以用。因此,在这个例子中Qparam1?param2初始化参数将能够在用URL http://host/webAppPrefix/servlet/InitTest 时可用,但在使用 URL http://host/webAppPrefix/servlet/myPackage.InitServlet 时不能用?br />例如Q程序清?-7l出一个名为InitServlet的简单servletQ它使用initҎ(gu)讄firstName和emailAddress字段。程序清?-8l出分配名称InitTestlservlet的web.xml文g?br />E序清单5-7 InitServlet.java
package moreservlets;
import java.io.*;
import javax.servlet.*;
import javax.servlet.http.*;
/** Simple servlet used to illustrate servlet
* initialization parameters.
*
* Taken from More Servlets and JavaServer Pages
* from Prentice Hall and Sun Microsystems Press,
* http://www.moreservlets.com/.
* © 2002 Marty Hall; may be freely used or adapted.
*/
public class InitServlet extends HttpServlet {
private String firstName, emailAddress;
public void init() {
ServletConfig config = getServletConfig();
firstName = config.getInitParameter("firstName");
emailAddress = config.getInitParameter("emailAddress");
}
public void doGet(HttpServletRequest request,
HttpServletResponse response)
throws ServletException, IOException {
response.setContentType("text/html");
PrintWriter out = response.getWriter();
String uri = request.getRequestURI();
out.println(ServletUtilities.headWithTitle("Init Servlet") +
"<BODY BGCOLOR=\"#FDF5E6\">\n" +
"
Init Parameters:
\n" +
"
\n" +
\n" +
"
"
"
"</BODY></HTML>");
}
}
E序清单5-8 web.xmlQ说明初始化参数的摘录)
<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE web-app
PUBLIC "-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN"
"http://java.sun.com/dtd/web-app_2_3.dtd">
<web-app>
<!-- ... -->
<servlet>
<servlet-name>InitTest</servlet-name>
<servlet-class>moreservlets.InitServlet</servlet-class>
<init-param>
<param-name>firstName</param-name>
<param-value>Larry</param-value>
</init-param>
<init-param>
<param-name>emailAddress</param-name>
<param-value>Ellison@Microsoft.com</param-value>
</init-param>
</servlet>
<!-- ... -->
</web-app>
5.2 分配JSP初始化参?br />lJSP面提供初始化参数在三个斚w不同于给servlet提供初始化参数?br />1Q用jsp-file而不是servlet-class。因此,WEB-INF/web.xml文g的servlet元素如下所C:
<servlet>
<servlet-name>PageName</servlet-name>
<jsp-file>/RealPage.jsp</jsp-file>
<init-param>
<param-name>...</param-name>
<param-value>...</param-value>
</init-param>
...
</servlet>
2) 几乎L分配一个明的URL模式。对servletQ一般相应地使用以http://host/webAppPrefix/servlet/ 开始的~省URL。只需CQ用注册名而不是原名称卛_。这对于JSP面在技术上也是合法的。例如,在上面给出的例子中,可用URL http: //host/webAppPrefix/servlet/PageName 讉KRealPage.jsp的对初始化参数具有访问权的版本。但在用?JSP面Ӟ许多用户g不喜Ƣ应用常规的servlet的URL。此外,如果 JSP面位于服务器ؓ其提供了目录清单的目录中Q如Q一个既没有 index.html也没有index.jsp文g的目录)Q则用户可能会连接到?JSP面Q单dQ从而意外地ȀzL初始化的面。因此,好的办法是用url-patternQ?.3节)JSP面的原URL与注册的 servlet名相兌。这P客户机可使用JSP面的普通名Uͼ但仍然激zd制的版本。例如,l定来自目1的servlet定义Q可使用下面?servlet-mapping定义Q?br /><servlet-mapping>
<servlet-name>PageName</servlet-name>
<url-pattern>/RealPage.jsp</url-pattern>
</servlet-mapping>
3QJSP用jspInit而不是init。自动从JSP面建立的servlet或许已经使用了intiҎ(gu)。因此,使用JSP声明提供一个initҎ(gu)是不合法的,必须制定jspInitҎ(gu)?br />Z说明初始化JSP面的过E,E序清单5-9l出了一个名为InitPage.jsp的JSP面Q它包含一个jspInitҎ(gu)且放|于 deployDemo Web应用层次l构的顶层。一般,http://host/deployDemo/InitPage.jsp 形式的URL激zL面的不h初始化参数访问权的版本,从而将对firstName和emailAddress变量昄null。但是, web.xml文gQ程序清?-10Q分配了一个注册名Q然后将该注册名与URL模式/InitPage.jsp相关联?br />
E序清单5-9 InitPage.jsp
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<HTML>
<HEAD></HEAD>
<BODY BGCOLOR="#FDF5E6">Init Parameters:
</BODY></HTML>
<%!
private String firstName, emailAddress;
public void jspInit() {
ServletConfig config = getServletConfig();
firstName = config.getInitParameter("firstName");
emailAddress = config.getInitParameter("emailAddress");
}
%>
E序清单5-10 web.xmlQ说明JSP面的init参数的摘录)
<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE web-app
PUBLIC "-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN"
"http://java.sun.com/dtd/web-app_2_3.dtd">
<web-app>
<!-- ... -->
<servlet>
<servlet-name>InitPage</servlet-name>
<jsp-file>/InitPage.jsp</jsp-file>
<init-param>
<param-name>firstName</param-name>
<param-value>Bill</param-value>
</init-param>
<init-param>
<param-name>emailAddress</param-name>
<param-value>gates@oracle.com</param-value>
</init-param>
</servlet>
<!-- ... -->
<servlet-mapping>
<servlet-name> InitPage</servlet-name>
<url-pattern>/InitPage.jsp</url-pattern>
</servlet-mapping>
<!-- ... -->
</web-app>
5.3 提供应用范围内的初始化参?br />一般,对单个地servlet或JSP面分配初始化参数。指定的servlet或JSP面利用ServletConfig?getInitParameterҎ(gu)dq些参数。但是,在某些情形下Q希望提供可׃Q意servlet或JSP面借助ServletContext 的getInitParameterҎ(gu)d的系l范围内的初始化参数?br />可利用context-param元素声明q些pȝ范围内的初始化倹{context-param元素应该包含param-name、param-value以及可选的description子元素,如下所C:
<context-param>
<param-name>support-email</param-name>
<param-value>blackhole@mycompany.com</param-value>
</context-param>
可回忆一下,Z保证可移植性,web.xml内的元素必须以正的ơ序声明。但q里应该注意Qcontext-param元素必须出现L与文档有关的元素Qicon、display-name或descriptionQ之后及filter、filter-mapping、listener?servlet元素之前?br />5.4 在服务器启动时装载servlet
假如servlet或JSP面有一个要花很长时间执行的 init QservletQ或jspInitQJSPQ方法。例如,假如init或jspInitҎ(gu)从某个数据库或ResourceBundle查找产量。这U情况下Q在W一个客hh时装载servlet的缺省行为将对第一个客h产生较长旉的gq。因此,可利用servlet的load-on - startup元素规定服务器在W一ơ启动时装蝲servlet。下面是一个例子?br /><servlet>
<servlet-name> ?</servlet-name>
<servlet-class> ?</servlet-class> <!-- Or jsp-file -->
<load-on-startup/>
</servlet>
可以为此元素体提供一个整数而不是用一个空的load-on-startup。想法是服务器应该在装蝲较大数目的servlet或JSP面之前装蝲较少数目的servlet或JSP面。例如,下面的servlet(攄在Web应用的WEB-INF目录下的web.xml文g中的web-app元素内)指C服务器首先装蝲和初始化SearchServletQ然后装载和初始化由位于Web应用的result目录中的index.jsp文g产生?servlet?br /><servlet>
<servlet-name>Search</servlet-name>
<servlet-class>myPackage.SearchServlet</servlet-class> <!-- Or jsp-file -->
<load-on-startup>1</load-on-startup>
</servlet>
<servlet>
<servlet-name>Results</servlet-name>
<servlet-class>/results/index.jsp</servlet-class> <!-- Or jsp-file -->
<load-on-startup>2</load-on-startup>
</servlet>
6 声明qo?br />
servlet版本2.3引入了过滤器的概c虽然所有支持servlet API版本2.3的服务器都支持过滤器Q但Z使用与过滤器有关的元素,必须在web.xml中用版?.3的DTD?br />qo器可截取和修改进入一个servlet或JSP面的请求或从一个servlet或JSP面发出的相应。在执行一个servlet或JSP面之前Q必L行第一个相关的qo器的doFilterҎ(gu)。在该过滤器对其FilterChain对象调用doFilterӞ执行链中的下一个过滤器。如果没有其他过滤器Qservlet或JSP面被执行。过滤器h对到来的ServletRequest对象的全部访问权Q因此,它们可以查看客户机名、查扑ֈ来的cookie{。ؓ了访问servlet或JSP面的输出,qo器可响应对象包裹在一个替w对象(stand-in objectQ中Q比方说把输出篏加到一个缓冲区。在调用FilterChain对象的doFilterҎ(gu)之后Q过滤器可检查缓冲区Q如有必要,对它进行修改,然后传送到客户机?br />例如Q程序清?-11帝国难以了一个简单的qo器,只要讉K相关的servlet或JSP面Q它?yu)截取请求ƈ在标准输Z打印一个报告(开发过E中在桌面系l上q行Ӟ大多数服务器都可以用这个过滤器Q?br />
E序清单5-11 ReportFilter.java
package moreservlets;
import java.io.*;
import javax.servlet.*;
import javax.servlet.http.*;
import java.util.*;
/** Simple filter that prints a report on the standard output
* whenever the associated servlet or JSP page is accessed.
*
* Taken from More Servlets and JavaServer Pages
* from Prentice Hall and Sun Microsystems Press,
* http://www.moreservlets.com/.
* © 2002 Marty Hall; may be freely used or adapted.
*/
public class ReportFilter implements Filter {
public void doFilter(ServletRequest request,
ServletResponse response,
FilterChain chain)
throws ServletException, IOException {
HttpServletRequest req = (HttpServletRequest)request;
System.out.println(req.getRemoteHost() +
" tried to access " +
req.getRequestURL() +
" on " + new Date() + ".");
chain.doFilter(request,response);
}
public void init(FilterConfig config)
throws ServletException {
}
public void destroy() {}
}
一旦徏立了一个过滤器Q可以在web.xml中利用filter元素以及filter-nameQQ意名Uͼ、file-classQ完全限定的cdQ和Q可选的Qinit-params子元素声明它。请注意Q元素在web.xml的web-app元素中出现的ơ序不是L的;允许服务器(但不是必需的)强制所需的次序,q且实际中有些服务器也是q样做的。但q里要注意,所有filter元素必须出现在Q意filter-mapping元素之前Q?filter-mapping元素又必d现在所有servlet或servlet-mapping元素之前?br />例如Q给定上q的ReportFilterc,可在web.xml中作Z面的filter声明。它把名UReporter与实际的cReportFilterQ位于moreservletsE序包中Q相兌?br /><filter>
<filter-name>Reporter</filter-name>
<filter-class>moresevlets.ReportFilter</filter-class>
</filter>
一旦命名了一个过滤器Q可利用filter-mapping元素把它与一个或多个servlet或JSP面相关联。关于此工作有两种选择?br />首先Q可使用filter-name和servlet-name子元素把此过滤器与一个特定的servlet名(此servlet名必ȝ后在相同?web.xml文g中用servlet元素声明Q关联。例如,下面的程序片断指C系l只要利用一个定制的URL讉K名ؓ SomeServletName 的servlet或JSP面Q就q行名ؓReporter的过滤器?br /><filter-mapping>
<filter-name>Reporter</filter-name>
<servlet-name>SomeServletName</servlet-name>
</filter-mapping>
其次Q可利用filter-name和url-pattern子元素将qo器与一lservlet、JSP面或静态内容相兌。例如,盔R的程序片D|C系l只要访问Web应用中的LURLQ就q行名ؓReporter的过滤器?br /><filter-mapping>
<filter-name>Reporter</filter-name>
<url-pattern>/*</url-pattern>
</filter-mapping>
例如Q程序清?-12l出了将ReportFilterqo器与名ؓPageName的servlet相关联的web.xml文g的一部分。名?PageName依次又与一个名为TestPage.jsp的JSP面以及以模式http: //host/webAppPrefix/UrlTest2/ 开头的URL相关联。TestPage.jsp的源代码已经JSP面命名的谈论在前面??分配名称和定制的URL"中给出。事实上Q程序清?- 12中的servlet和servlet-name从该节原封不动地拿q来的。给定这些web.xml,可看C面的标准输出形式的调试报告(换行是ؓ了容易阅读)?br />audit.irs.gov tried to access
http://mycompany.com/deployDemo/UrlTest2/business/tax-plan.html
on Tue Dec 25 13:12:29 EDT 2001.
E序清单5-12 Web.xmlQ说明filter用法的摘录)
<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE web-app
PUBLIC "-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN"
"http://java.sun.com/dtd/web-app_2_3.dtd">
<web-app>
<filter>
<filter-name>Reporter</filter-name>
<filter-class>moresevlets.ReportFilter</filter-class>
</filter>
<!-- ... -->
<filter-mapping>
<filter-name>Reporter</filter-name>
<servlet-name>PageName</servlet-name>
</filter-mapping>
<!-- ... -->
<servlet>
<servlet-name>PageName</servlet-name>
<jsp-file>/RealPage.jsp</jsp-file>
</servlet>
<!-- ... -->
<servlet-mapping>
<servlet-name> PageName </servlet-name>
<url-pattern>/UrlTest2/*</url-pattern>
</servlet-mapping>
<!-- ... -->
</web-app>
7 指定Ƣ迎?br />
假如用户提供了一个像http: //host/webAppPrefix/directoryName/ q样的包含一个目录名但没有包含文件名?URLQ会发生什么事情呢Q用戯得到一个目录表Q一个错误?q是标准文g的内容?如果得到标准文g内容Q是 index.html?index.jsp、default.html、default.htm或别的什么东西呢Q?br />Welcome-file-list 元素及其辅助?welcome-file元素解决了这个模p的问题。例如,下面的web.xmlҎ(gu)出,如果一个URLl出一个目录名但未l出文g名,服务器应该首先试用index.jspQ然后再试用index.html。如果两者都没有扑ֈQ则l果有赖于所用的服务器(如一个目录列表)?br /><welcome-file-list>
<welcome-file>index.jsp</welcome-file>
<welcome-file>index.html</welcome-file>
</welcome-file-list>
虽然许多服务器缺省遵循这U行为,但不一定必这栗因此,明确C用welcom-file-list保证可移植性是一U良好的习惯?br />
8 指定处理错误的页?br />
现在我了解到Q你在开发servlet和JSP面时从不会犯错误,而且你的所有页面是那样的清晎ͼ一般的E序员都不会被它们的搞糊涂。但是,是hM犯错误的Q用户可能会提供不合规定的参敎ͼ使用不正的URL或者不能提供必需的表单字D倹{除此之外,其它开发h员可能不那么l心Q他们应该有些工h克服自己的不?br />error-page元素是用来克服q些问题的。它有两个可能的子元素,分别是:error-code和exception- type。第一个子元素error-code指出在给定的HTTP错误代码出现时用的URL。第二个子元素excpetion-type指出在出现某个给定的Java异常但未捕捉到时使用的URL。error-code和exception-type都利用location元素指出相应的URL。此 URL必须?开始。location所指出的位|处的页面可通过查找HttpServletRequest对象的两个专门的属性来讉K关于错误的信息,q两个属性分别是Qjavax.servlet.error.status_code和javax.servlet.error.message?br />可回忆一下,在web.xml内以正确的次序声明web-app的子元素很重要。这里只要记住,error-page出现在web.xml文g的末Nq,servlet、servlet-name和welcome-file-list之后卛_?br />
8.1 error-code元素
Z更好C解error-code元素的|可考虑一下如果不正确地输入文件名Q大多数站点会作Z么反映。这样做一般会出现一?04错误信息Q它表示不能扑ֈ该文Ӟ但几乎没提供更多有用的信息。另一斚wQ可以试一下在www.microsoft.com、www.ibm.com 处或者特别是?www.bea.com 处输出未知的文g名。这是会得出有用的消息,q些消息提供可选择的位|,以便查找感兴的面。提供这h用的错误面对于 Web应用来说是很有h(hun)值得。事实上rm-error-page子元素)。由form-login-pagel出的HTML表单必须h一?j_security_check?ACTION属性、一个名为j_username的用户名文本字段以及一个名为j_password的口令字Dc?br />例如Q程序清?-19指示服务器用基于表单的验证。Web应用的顶层目录中的一个名为login.jsp的页面将攉用户名和口oQƈ且失败的登陆由相同目录中名为login-error.jsp的页面报告?br />
E序清单5-19 web.xmlQ说明login-config的摘录)
<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE web-app
PUBLIC "-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN"
"http://java.sun.com/dtd/web-app_2_3.dtd">
<web-app>
<!-- ... -->
<security-constraint> ... </security-constraint>
<login-config>
<auth-method> FORM </auth-method>
<form-login-config>
<form-login-page>/login.jsp</form-login-page>
<form-error-page>/login-error.jsp</form-error-page>
</form-login-config>
</login-config>
<!-- ... -->
</web-app>
9.2 限制对Web资源的访?br />现在Q可以指C服务器使用何种验证Ҏ(gu)了?了不P"你说道,"除非我能指定一个来收到保护?URLQ否则没有多大用处?没错。指些URLq说明他们应该得CU保护正是security-constriaint元素的用途。此元素?web.xml中应该出现在login-config的紧前面。它包含是个可能的子元素Q分别是Qweb-resource-collection?auth-constraint、user-data- constraint和display-name。下面各节对它们进行介l?br />l web-resource-collection
此元素确定应该保护的资源。所有security-constraint元素都必d含至一个web-resource-collectionV此元素׃个给ZQ意标识名U的web-resource-name元素、一个确定应该保护的URL的url-pattern元素、一个指出此保护所适用?HTTP命oQGET、POST{,~省为所有方法)的http-method元素和一个提供资料的可选description元素l成。例如,下面?Web-resource-collection(在security-constratint元素内)指出Web应用的proprietary目录中所有文档应该受C护?br /><security-constraint>
<web-resource-coolection>
<web-resource-name>Proprietary</web-resource-name>
<url-pattern>/propritary/*</url-pattern>
</web-resource-coolection>
<!-- ... -->
</security-constraint>
重要的是应该注意刎ͼurl-pattern仅适用于直接访问这些资源的客户机。特别是Q它不适合于通过MVC体系l构利用 RequestDispatcher来访问的面Q或者不适合于利用类似jsp:forward的手D|讉K的页面。这U不匀U如果利用得当的话很有好处。例如,servlet可利用MVC体系l构查找数据Q把它放到bean中,发送请求到从bean中提取数据的JSP面q显C它。我们希望保证决不直接访问受保护的JSP面Q而只是通过建立该页面将使用的bean的servlet来访问它。url-pattern和auth-contraint元素可通过声明不允怓Q何用L接访问JSP面来提供这U保证。但是,q种不匀U的行ؓ可能让开发h员放松警惕,使他们偶然对应受保护的资源提供不受限制的讉K?
l auth-constraint
管web-resource-collention元素质出了哪些URL应该受到保护Q但是auth-constraint元素却指出哪些用户应该具有受保护资源的访问权。此元素应该包含一个或多个标识h讉K权限的用L别role- name元素Q以及包含(可选)一个描q角色的description元素。例如,下面web.xml中的security-constraint元素部门规定只有指定为Administrator或Big KahunaQ或两者)的用户具有指定资源的讉K权?br /><security-constraint>
<web-resource-coolection> ... </web-resource-coolection>
<auth-constraint>
<role-name>administrator</role-name>
<role-name>kahuna</role-name>
</auth-constraint>
</security-constraint>
重要的是认识刎ͼ到此为止Q这个过E的可移植部分结束了。服务器怎样定哪些用户处于M角色以及它怎样存放用户的口令,完全有赖于具体的pȝ?br />例如QTomcat使用install_dir/conf/tomcat-users.xml用户名与角色名和口令相兌Q正如下面例子中所C,它指出用户joeQ口令bigshotQ和janeQ口令enajQ属于administrator和kahuna角色?br /><tomcat-users>
<user name="joe" password="bigshot" roles="administrator,kahuna" />
<user name="jane" password="enaj" roles="kahuna" />
</tomcat-users>
l user-data-constraint
q个可选的元素指出在访问相兌源时使用M传输层保护。它必须包含一个transport-guarantee子元素(合法gؓNONE?INTEGRAL或CONFIDENTIALQ,q且可选地包含一个description元素。transport-guarantee为NONE值将Ҏ(gu)用的通讯协议不加限制。INTEGRALDC数据必M一U防止截取它的h阅读它的方式传送。虽然原理上Qƈ且在未来的HTTP版本中)Q在 INTEGRAL和CONFIDENTIAL之间可能会有差别Q但在当前实践中Q他们都只是单地要求用SSL。例如,下面指示服务器只允许对相兌源做 HTTPSq接Q?br /><security-constraint>
<!-- ... -->
<user-data-constraint>
<transport-guarantee>CONFIDENTIAL</transport-guarantee>
</user-data-constraint>
</security-constraint>
l display-name
security-constraint的这个很用的子元素给予可能由GUI工具使用的安全约束项一个名U?br />9.3 分配角色?br />q今为止Q讨论已l集中到完全由容器(服务器)处理的安全问题之上了。但servlet以及JSP面也能够处理它们自q安全问题?br />例如Q容器可能允许用户从bigwig或bigcheese角色讉K一个显CZh员额外紧贴的面Q但只允许bigwig用户修改此页面的参数。完成这U更l致的控制的一U常见方法是调用HttpServletRequset的isUserInRoleҎ(gu)Qƈ据此修改讉K?br />Servlet?security-role-ref子元素提供出现在服务器专用口令文件中的安全角色名的一个别名。例如,假如~写了一个调?request.isUserInRoleQ?boss"Q的servletQ但后来该servlet被用在了一个其口o文g调用角色manager而不是boss的服务器中。下面的E序D该servlet能够使用q两个名UC的Q何一个?br /><servlet>
<!-- ... -->
<security-role-ref>
<role-name>boss</role-name> <!-- New alias -->
<role-link>manager</role-link> <!-- Real name -->
</security-role-ref>
</servlet>
也可以在web-app内利用security-role元素提供出现在role-name元素中的所有安全角色的一个全局列表。分别地生命角色佉KUIDEҎ(gu)处理安全信息?br />
10 控制会话时
如果某个会话在一定的旉内未被访问,服务器可把它扔掉以节U内存。可利用HttpSession的setMaxInactiveIntervalҎ(gu)直接讄个别会话对象的超时倹{如果不采用q种Ҏ(gu)Q则~省的超时值由具体的服务器军_。但可利用session-config和session- timeout元素来给Z个适用于所有服务器的明的时倹{超时值的单位为分钟,因此Q下面的例子讄~省会话时gؓ三个时Q?80分钟Q?br /><session-config>
<session-timeout>180</session-timeout>
</session-config>
11 Web应用的文档化
来多的开发环境开始提供servlet和JSP的直接支持。例子有Borland Jbuilder Enterprise Edition?Macromedia UltraDev、Allaire JRun StudioQ写此文Ӟ已被Macromedia收购Q以?IBM VisuaAge for Java{?br />大量的web.xml元素不仅是ؓ服务器设计的Q而且q是为可视开发环境设计的。它们包括icon、display-name和discription{?br />可回忆一下,在web.xml内以适当地次序声明web-app子元素很重要。不q,q里只要Cicon、display-name和description是web.xml的web-app元素内的前三个合法元素即可?br />l icon
icon元素指出GUI工具可用来代表Web应用的一个和两个囑փ文g。可利用small-icon元素指定一q?6 x 16的GIF或JPEG囑փQ用large-icon元素指定一q?2 x 32的图像。下面D一个例子:
<icon>
<small-icon>/images/small-book.gif</small-icon>
<large-icon>/images/tome.jpg</large-icon>
</icon>
l display-name
display-name元素提供GUI工具可能会用来标记此Web应用的一个名U。下面是个例子?br /><display-name>Rare Books</display-name>
l description
description元素提供解释性文本,如下所C:
<description>
This Web application represents the store developed for
rare-books.com, an online bookstore specializing in rare
and limited-edition books.
</description>
12 兌文g与MIMEcd
服务器一般都h一U让Web站点理员将文g扩展名与媒体相关联的Ҏ(gu)。例如,会自动l予名ؓmom.jpg的文件一个image/jpeg?MIME cd。但是,假如你的Web应用h几个不寻常的文gQ你希望保证它们在发送到客户机时分配为某UMIMEcd。mime-mapping元素Q具?extension和mime-type子元素)可提供这U保证。例如,下面的代码指C服务器application/x-fubar?MIMEcd分配l所有以.fool尾的文件?br /><mime-mapping>
<extension>foo</extension>
<mime-type>application/x-fubar</mime-type>
</mime-mapping>
或许Q你的Web应用希望重蝲QoverrideQ标准的映射。例如,下面的代码将告诉服务器在发送到客户机时指定.ps文g作ؓU文本(text/plainQ而不是作为PostScriptQapplication/postscriptQ?br /><mime-mapping>
<extension>ps</extension>
<mime-type>application/postscript</mime-type>
</mime-mapping>
13 定位TLD
JSP taglib 元素h一个必要的uri属性,它给Z个TLDQTag Library DescriptorQ文件相对于Web应用的根的位|。TLD文g的实际名U在发布新的标签库版本时可能会改变,但我们希望避免更Ҏ(gu)有现有JSP面。此外,可能q希望用保持taglib元素的简l性的一个简短的uri。这是部v描述W文件的taglib元素z场的所在了。Taglib包含两个子元素:taglib-uri和taglib-location?taglib-uri元素应该与用于JSP taglib元素的uri属性的东西相匹配。Taglib-location元素l出TLD文g的实际位|。例如,假如你将文gchart-tags- 1.3beta.tld攑֜WebApp/WEB-INF/tlds中。现在,假如web.xml在web- app元素内包含下列内宏V?br /><taglib>
<taglib-uri>/charts.tld</taglib-uri>
<taglib-location>
/WEB-INF/tlds/chart-tags-1.3beta.tld
</taglib-location>
</taglib>
l出q个说明后,JSP面可通过下面的简化Ş式用标{ֺ?br /><%@ taglib uri="/charts.tld" prefix="somePrefix" %>
14 指定应用事g监听E序
应用事g监听器程序是建立或修改servlet环境或会话对象时通知的类。它们是servlet规范的版?.3中的新内宏V这里只单地说明用来向Web应用注册一个监听程序的web.xml的用法?br />注册一个监听程序涉及在web.xml的web-app元素内放|一个listener元素。在listener元素内,listener-class元素列出监听E序的完整的限定cdQ如下所C:
<listener>
<listener-class>package.ListenerClass</listener-class>
</listener>
虽然listener元素的结构很单,但请不要忘记Q必L地l出web-app元素内的子元素的ơ序。listener元素位于所有的 servlet 元素之前以及所有filter-mapping元素之后。此外,因ؓ应用生存期监听程序是serlvet规范?.3版本中的新内容,所以必M?web.xml DTD?.3版本Q而不?.2版本?br />例如Q程序清?-20l出一个名为ContextReporter的简单的监听E序Q只要Web应用的Servlet-Context建立Q如装蝲Web应用Q或消除Q如服务器关闭)Ӟ它就在标准输Z昄一条消息。程序清?-21l出此监听程序注册所需要的web.xml文g的一部分?br />
E序清单5-20 ContextReporterjava
package moreservlets;
import javax.servlet.*;
import java.util.*;
/** Simple listener that prints a report on the standard output
* when the ServletContext is created or destroyed.
*
* Taken from More Servlets and JavaServer Pages
* from Prentice Hall and Sun Microsystems Press,
* http://www.moreservlets.com/.
* © 2002 Marty Hall; may be freely used or adapted.
*/
public class ContextReporter implements ServletContextListener {
public void contextInitialized(ServletContextEvent event) {
System.out.println("Context created on " +
new Date() + ".");
}
public void contextDestroyed(ServletContextEvent event) {
System.out.println("Context destroyed on " +
new Date() + ".");
}
}
E序清单5-21 web.xmlQ声明一个监听程序的摘录Q?br /><?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE web-app
PUBLIC "-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN"
"http://java.sun.com/dtd/web-app_2_3.dtd">
<web-app>
<!-- ... -->
<filter-mapping> ?</filter-mapping>
<listener>
<listener-class>package.ListenerClass</listener-class>
</listener>
<servlet> ... </servlet>
<!-- ... -->
</web-app>
15 J2EE元素
本节描述用作J2EE环境l成部分的Web应用的web.xml元素。这里将提供一个简明的介绍Q详l内容可以参阅http: //java.sun.com/j2ee/j2ee-1_3-fr-spec.pdf?Java 2 Plantform Enterprise Edition版本1.3规范的第5章?br />l distributable
distributable 元素指出QWeb应用是以q样的方式编E的Q即Q支持集的服务器可安全地在多个服务器上分布Web应用。例如,一个可分布的应用必d使用 Serializable对象作ؓ其HttpSession对象的属性,而且必须避免用实例变量(字段Q来实现持箋性。distributable元素直接出现在discription元素之后Qƈ且不包含子元素或数据Q它只是一个如下的标志?br /><distributable />
l resource-env-ref
resource -env-ref元素声明一个与某个资源有关的管理对象。此元素׃个可选的description元素、一个resource-env-ref- name元素Q一个相对于java:comp/env环境的JNDI名)以及一个resource-env-type元素Q指定资源类型的完全限定的类Q,如下所C:
<resource-env-ref>
<resource-env-ref-name>
jms/StockQueue
</resource-env-ref-name>
<resource-env-ref-type>
javax.jms.Queue
</resource-env-ref-type>
</resource-env-ref>
l env-entry
env -entry元素声明Web应用的环境项。它׃个可选的description元素、一个env-entry-name元素Q一个相对于java: comp/env环境JNDI名)、一个env-entry-value元素Q项|以及一个env-entry-type元素Qjava.langE序包中一个类型的完全限定cdQjava.lang.Boolean、java.lang.String{)l成。下面是一个例子:
<env-entry>
<env-entry-name>minAmout</env-entry-name>
<env-entry-value>100.00</env-entry-value>
<env-entry-type>minAmout</env-entry-type>
</env-entry>
l ejb-ref
ejb -ref元素声明对一个EJB的主目录的应用。它׃个可选的description元素、一个ejb-ref-name元素Q相对于java: comp/env的EJB应用Q、一个ejb-ref-type元素Qbean的类型,Entity或SessionQ、一个home元素Qbean的主目录接口的完全限定名Q、一个remote元素Qbean的远E接口的完全限定名)以及一个可选的ejb-link元素Q当前bean链接的另一?bean的名Uͼl成?br />l ejb-local-ref
ejb-local-ref元素声明一个EJB的本C目录的引用。除了用local-home代替home外,此元素具有与ejb-ref元素相同的属性ƈ以相同的方式使用
]]>