新增注解支持:简化servlet,filter,listener的声明,使得web.xml不再是必需的了。

@WebServlet

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

表 1. @WebServlet 主要属性列表

属性名类型描述
nameString指定 Servlet 的 name 属性,等价于 <servlet-name>。如果没有显式指定,则该 Servlet 的取值即为类的全限定名。
valueString[]该属性等价于 urlPatterns 属性。两个属性不能同时使用。
urlPatternsString[]指定一组 Servlet 的 URL 匹配模式。等价于 <url-pattern> 标签。
loadOnStartupint指定 Servlet 的加载顺序,等价于 <load-on-startup> 标签。
initParamsWebInitParam[]指定一组 Servlet 初始化参数,等价于 <init-param> 标签。
asyncSupportedboolean声明 Servlet 是否支持异步操作模式,等价于 <async-supported> 标签。
descriptionString该 Servlet 的描述信息,等价于 <description> 标签。
displayNameString该 Servlet 的显示名,通常配合工具使用,等价于 <display-name> 标签。

下面是一个简单的示例:

  1. @WebServlet(urlPatterns = {"/simple"}, asyncSupported = true,

  2. loadOnStartup = -1, name = "SimpleServlet", displayName = "ss",

  3. initParams = {@WebInitParam(name = "username", value = "tom")}

  4. )

  5. public class SimpleServlet extends HttpServlet{ … }

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

  1. <servlet>

  2. <display-name>ss</display-name>

  3. <servlet-name>SimpleServlet</servlet-name>

  4. <servlet-class>footmark.servlet.SimpleServlet</servlet-class>

  5. <load-on-startup>-1</load-on-startup>

  6. <async-supported>true</async-supported>

  7. <init-param>

  8. <param-name>username</param-name>

  9. <param-value>tom</param-value>

  10. </init-param>

  11. </servlet>

  12. <servlet-mapping>

  13. <servlet-name>SimpleServlet</servlet-name>

  14. <url-pattern>/simple</url-pattern>

  15. </servlet-mapping>

  16.  

@WebInitParam

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

表 2. @WebInitParam 的常用属性

 

属性名类型是否可选描述
nameString指定参数的名字,等价于 <param-name>。
valueString指定参数的值,等价于 <param-value>。
descriptionString关于参数的描述,等价于 <description>。

@WebFilter

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

表 3. @WebFilter 的常用属性

属性名类型描述
filterNameString指定过滤器的 name 属性,等价于 <filter-name>
valueString[]该属性等价于 urlPatterns 属性。但是两者不应该同时使用。
urlPatternsString[]指定一组过滤器的 URL 匹配模式。等价于 <url-pattern> 标签。
servletNamesString[]指定过滤器将应用于哪些 Servlet。取值是 @WebServlet 中的 name 属性的取值,或者是 web.xml 中 <servlet-name> 的取值。
dispatcherTypesDispatcherType

指定过滤器的转发模式。具体取值包括:

 

ASYNC、ERROR、FORWARD、INCLUDE、REQUEST。

initParamsWebInitParam[]指定一组过滤器初始化参数,等价于 <init-param> 标签。
asyncSupportedboolean声明过滤器是否支持异步操作模式,等价于 <async-supported> 标签。
descriptionString该过滤器的描述信息,等价于 <description> 标签。
displayNameString该过滤器的显示名,通常配合工具使用,等价于 <display-name> 标签。

下面是一个简单的示例:

  1. @WebFilter(servletNames = {"SimpleServlet"},filterName="SimpleFilter")

  2. public class LessThanSixFilter implements Filter{...}

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

  1. <filter>

  2. <filter-name>SimpleFilter</filter-name>

  3. <filter-class>xxx</filter-class>

  4. </filter>

  5. <filter-mapping>

  6. <filter-name>SimpleFilter</filter-name>

  7. <servlet-name>SimpleServlet</servlet-name>

  8. </filter-mapping>

  9.  

@WebListener

该注解用于将类声明为监听器,被 @WebListener 标注的类必须实现以下至少一个接口:

ServletContextListener

ServletContextAttributeListener

ServletRequestListener

ServletRequestAttributeListener

HttpSessionListener

HttpSessionAttributeListener

该注解使用非常简单,其属性如下:

表 4. @WebListener 的常用属性

属性名类型是否可选描述
valueString该监听器的描述信息。

一个简单示例如下:

 
  1. @WebListener("This is only a demo listener")

  2. public class SimpleListener implements ServletContextListener{...}

如此,则不需要在 web.xml 中配置 <listener> 标签了。它等价的 web.xml 中的配置形式如下:

 
  1. <listener>

  2. <listener-class>footmark.servlet.SimpleListener</listener-class>

  3. </listener>

  4.  

 

Logo

CSDN联合极客时间,共同打造面向开发者的精品内容学习社区,助力成长!

更多推荐