web.xmlファイル

web.xml（「サーブレットデプロイメントデスクリプター（Servlet deployment descriptor：配備記述子）」と呼ばれる）は、Javaのウェブアプリケーションの設定を書くファイル。
呼び出すサーブレットの制御等を記述する。

「ウェブアプリのコンテキストルート/WEB-INF/」の直下に置く。
（Tomcat5.5の場合は「webapps/ウェブアプリのコンテキストルート/WEB-INF/」の下となる）

最小構成

web.xml：

<?xml version="1.0"?>
<web-app>
</web-app>

これにDTD・xsd宣言や要素を追加していく。

DTD・XMLスキーマ

web.xmlのDTD・XMLスキーマ（xsd）の宣言方法。[2010-01-12]

<?xml version="1.0" encoding="Shift_JIS" ?>
<!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>
〜
</web-app>

<?xml version="1.0" encoding="Shift_JIS"?>
<web-app xmlns="http://java.sun.com/xml/ns/j2ee"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="http://java.sun.com/xml/ns/j2ee http://java.sun.com/xml/ns/j2ee/web-app_2_4.xsd"
	id="WebApp_ID" version="2.4">
〜
</web-app>

<?xml version="1.0" encoding="Shift_JIS"?>
<web-app xmlns="http://java.sun.com/xml/ns/javaee"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"
	id="WebApp_ID" version="2.5">
〜
</web-app>

web.xmlのxsdファイルでは、JavaEEやJSPのxsdファイルをincludeしている。（したがって、それらのバージョンも1つに定まる）

• Tomcatの対応バージョン

web-appの属性

web.xmlのルート要素であるweb-appに書ける属性。[2010-01-13]

web.xmlの要素

web.xmlの要素は、（当然の事ながら）バージョン毎に書ける内容が異なる。[2010-01-12]
バージョン2.3ではDTDに定義された順序通りに要素を書かないといけないが、2.4以降では（一部のグループを除いて）順番は定義されていない。（ただしTomcatでは互換性の為に順番通りでないといけないんだとか）

サーブレットの呼び出し

ブラウザから指定されたURLに応じてどのサーブレットを呼び出すかをweb.xmlに記述する。

まず、web.xml内でのサーブレットクラスの名前を定義してやる。

web.xml：

<?xml version="1.0"?>
<web-app>
	<servlet>
		<servlet-name>test</servlet-name>
		<servlet-class>jp.hishidama.sample.SampleServlet</servlet-class>
	</servlet>
</web-app>

次に、ブラウザで指定されるURLに対し、どのパターンのときにどのサーブレットを呼び出すかを定義する。

web.xml：

<?xml version="1.0"?>
<web-app>
	〜
	<servlet-mapping>
		<servlet-name>test</servlet-name>
		<url-pattern>/sample.do</url-pattern>
	</servlet-mapping>

	<servlet-mapping>
		<servlet-name>test</servlet-name>
		<url-pattern>/sub/zzz.do</url-pattern>
	</servlet-mapping>
</web-app>

servlet-mappingに、URLのコンテキストルートより後ろの部分に対するマッチ条件を書く。
servlet-mappingを複数書いて同じサーブレットを呼び出しても全然問題ない。というか、それが出来なきゃとっても面倒(爆)

Servlet2.5仕様では、一つのservlet-mappingの中に複数のurl-patternを書いても大丈夫になったんだそうだ。そっちの方が便利だわな。[2008-08-02]

	<servlet-mapping>
		<servlet-name>test</servlet-name>
		<url-pattern>/sample.do</url-pattern>
		<url-pattern>/sub/zzz.do</url-pattern>
	</servlet-mapping>

コンテキストルートがabcのとき、URLは「http://サーバー/abc/sample.do」のようになる。
コンテキストルートより後ろが「/sample.do」であり、上記の例ではservlet-mappingの「sample.do」とマッチするのでそのサーブレットが使われる。

URLに対して直接一致するファイル（jspファイルやhtmlファイル等）が存在していればそのファイルが返され、パターンマッチングは行われない（サーブレットは実行されない）。

初期パラメーター

web.xmlのservlet内にinit-paramを指定しておくと、そのサーブレット向けの初期情報を設定することが出来る。[2008-10-03]

web.xml：

<?xml version="1.0"?>
<web-app>
	<servlet>
		<servlet-name>test</servlet-name>
		<servlet-class>jp.hishidama.sample.SampleServlet</servlet-class>
		<init-param>
			<param-name>property.name</param-name>
			<param-value>value1</param-value>
		</init-param>
	</servlet>
	〜
</web-app>

SampleServlet.java：

public class SampleServlet extends HttpServlet {

	@Override
	public void init() throws ServletException {
		ServletConfig config = super.getServletConfig();
		
		String paramValue = config.getInitParameter("property.name");
		System.out.println(paramValue);
	}
}