servlet 3.0十九层-优快云博客

本文介绍 Servlet 3.0 中新增的注解支持特性，包括 @WebServlet 和 @WebFilter 的使用方法及属性配置，展示了如何利用这些注解简化 Web 应用部署。

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

新增的注解支持

Servlet 3.0的部署描述文件web.xml的顶层标签<web-app>有一个metadata-complete属性，该属性指定当前的部署描述文件是否是完全的。如果设置为true，则容器在部署时将只依赖部署描述文件，忽略所有的注解（同时也会跳过web-fragment.xml的扫描，亦即禁用可插性支持，具体请看后文关于可插性支持的讲解）；如果不配置该属性，或者将其设置为false，则表示启用注解支持（和可插性支持）。

@WebServlet

@WebServlet用于将一个类声明为Servlet，该注解将会在部署时被容器处理，容器将根据具体的属性配置将相应的类部署为 Servlet。该注解具有下表给出的一些常用属性（以下所有属性均为可选属性，但是vlaue或者urlPatterns通常是必需的，且二者不能共存，如果同时指定，通常是忽略value的取值）：

属性名类型描述

1.nameString指定Servlet的name属性，等价于<servlet-name>。如果没有显式指定，则该Servlet的取值即为类的全限定名。

2.valueString[]该属性等价于urlPatterns属性。两个属性不能同时使用。

3.urlPatternsString[]指定一组Servlet的URL匹配模式。等价于<url-pattern>标签。

4.loadOnStartupint指定Servlet的加载顺序，等价于<load-on-startup>标签。

5.initParamsWebInitParam[]指定一组Servlet初始化参数，等价于<init-param>标签。

6.asyncSupportedboolean声明Servlet是否支持异步操作模式，等价于<async-supported>标签。

7.descriptionString该Servlet的描述信息，等价于<description>标签。

8.displayNameString该Servlet的显示名，通常配合工具使用，等价于<display-name>标签。

下面是一个简单的示例：

Java代码

@WebServlet (urlPatterns={ "/simple" },asyncSupported= true , loadOnStartup=- 1 ,name= "SimpleServlet" ,displayName= "ss" ,
initParams={@WebInitParam (name= "username" ,value= "tom" )} ) publicclassSimpleServletextendsHttpServlet{…}

@WebServlet(urlPatterns={"/simple"},asyncSupported=true,  loadOnStartup=-1,name="SimpleServlet",displayName="ss",  
initParams={@WebInitParam(name="username",value="tom")}  )  publicclassSimpleServletextendsHttpServlet{…}

如此配置之后，就可以不必在web.xml中配置相应的<servlet>和<servlet-mapping>元素了，容器会在部署时根据指定的属性将该类发布为Servlet。它的等价的web.xml配置形式如下：

Xml代码

< servlet >
< display-name > ss </ display-name >
< servlet-name > SimpleServlet </ servlet-name >
< servlet-class > footmark.servlet.SimpleServlet </ servlet-class >
< load-on-startup > -1 </ load-on-startup >
< async-supported > true </ async-supported >
< init-param >
< param-name > username </ param-name >
< param-value > tom </ param-value >
</ init-param >
</ servlet >
< servlet-mapping >
< servlet-name > SimpleServlet </ servlet-name >
< url-pattern > /simple </ url-pattern >
</ servlet-mapping >

<servlet> 
<display-name>ss</display-name> 
<servlet-name>SimpleServlet</servlet-name> 
<servlet-class>footmark.servlet.SimpleServlet</servlet-class>
 <load-on-startup>-1</load-on-startup> 
<async-supported>true</async-supported> 
<init-param> 
<param-name>username</param-name> 
<param-value>tom</param-value> 
</init-param> 
</servlet>
 <servlet-mapping> 
<servlet-name>SimpleServlet</servlet-name>
 <url-pattern>/simple</url-pattern> 
</servlet-mapping>

@WebInitParam

该注解通常不单独使用，而是配合@WebServlet或者@WebFilter使用。它的作用是为Servlet或者过滤器指定初始化参数，这等价于web.xml中<servlet>和<filter>的<init-param>子标签。 @WebInitParam具有下表给出的一些常用属性：

属性名类型是否可选描述

◆nameString否指定参数的名字，等价于 <param-name>。
◆valueString否指定参数的值，等价于 <param-value>。
◆descriptionString是关于参数的描述，等价于 <description>。

@WebFilter

@WebFilter用于将一个类声明为过滤器，该注解将会在部署时被容器处理，容器将根据具体的属性配置将相应的类部署为过滤器。该注解具有下表给出的一些常用属性(以下所有属性均为可选属性，但是value、urlPatterns、servletNames三者必需至少包含一个，且 value和urlPatterns不能共存，如果同时指定，通常忽略value的取值)：