Servlet 3.0特性详解之注解支持

新增的注解支持


    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>标签。

下面是一个简单的示例:

  • @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配置形式如下:

  • <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的取值):

 

 

属性名类型描述


1.filterNameString指定过滤器的name属性,等价于<filter-name>。

2.valueString[]该属性等价于urlPatterns属性。但是两者不应该同时使用。

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

4.servletNamesString[]指定过滤器将应用于哪些Servlet。取值是@WebServlet中的name属性的取值,或者是web.xml中<servlet-name>的取值。

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

 

◆ASYNC、ERROR、FORWARD、INCLUDE、REQUEST。

◆initParamsWebInitParam[]指定一组过滤器初始化参数,等价于<init-param>标签。

◆asyncSupportedboolean声明过滤器是否支持异步操作模式,等价于<async-supported>标签。

◆descriptionString该过滤器的描述信息,等价于<description>标签。

◆displayNameString该过滤器的显示名,通常配合工具使用,等价于<display-name>标签。/

 

下面是一个简单的示例:

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

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

  • <filter> 
  • <filter-name>SimpleFilter</filter-name> 
  • <filter-class>xxx</filter-class> 
  • </filter> 
  • <filter-mapping> 
  • <filter-name>SimpleFilter</filter-name> 
  • <servlet-name>SimpleServlet</servlet-name> 
  • </filter-mapping> 

@WebListener


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

  • ServletContextListener  
  • ServletContextAttributeListener  
  • ServletRequestListener  
  • ServletRequestAttributeListener  
  • HttpSessionListener  
  • HttpSessionAttributeListener 

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

 

属性名类型是否可选描述

 

valueString是该监听器的描述信息。

一个简单示例如下:

  • @WebListener("Thisisonlyademolistener")  
  • publicclassSimpleListenerimplementsServletContextListener{...} 

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

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

@MultipartConfig


该注解主要是为了辅助Servlet 3.0中HttpServletRequest提供的对上传文件的支持。该注解标注在Servlet上面,以表示该Servlet希望处理的请求的 MIME类型是multipart/form-data。另外,它还提供了若干属性用于简化对上传文件的处理。具体如下:

 

属性名类型是否可选描述


◆fileSizeThresholdint是当数据量大于该值时,内容将被写入文件。

◆locationString是存放生成的文件地址。

◆maxFileSizelong是允许上传的文件最大值。默认值为-1,表示没有限制。

◆maxRequestSizelong是针对该multipart/form-data请求的最大数量,默认值为-1,表示没有限制。

©️2020 CSDN 皮肤主题: 大白 设计师:CSDN官方博客 返回首页