Servlet3.0

三、新增注解支持

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

1.@WebServlet注解

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

属性名

类型

描述

name

String

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

value

String[]

该属性等价于 urlPatterns 属性。两个属性不能同时使用。

urlPatterns

String[]

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

loadOnStartup

int

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

initParams

WebInitParam[]

指定一组 Servlet 初始化参数,等价于 <init-param> 标签。

asyncSupported

boolean

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

description

String

该 Servlet 的描述信息,等价于 <description> 标签。

displayName

String

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

 

@WebServlet(

urlPatterns = {“/simple”},

asyncSupported = true,

loadOnStartup = -1,

name = “SimpleServlet”,

displayName = “ss”,

initParams = {@WebInitParam(name = “username”, value = “tom”)}

)

public class SimpleServlet extends HttpServlet{ … }

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

<servlet>

    <display-name>ss</display-name>

    <servlet-name>SimpleServlet</servlet-name>

    <servlet-class>com.atguigu.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>

2.@WebInitParam

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

属性名

类型

是否可选

描述

name

String

指定参数的名字,等价于 <param-name>。

value

String

指定参数的值,等价于 <param-value>。

description

String

关于参数的描述,等价于 <description>。

3.@WebFilter

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

属性名

类型

描述

filterName

String

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

value

String[]

该属性等价于 urlPatterns 属性。但是两者不应该同时使用。

urlPatterns

String[]

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

servletNames

String[]

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

dispatcherTypes

DispatcherType

指定过滤器的转发模式。具体取值包括:
ASYNC、ERROR、FORWARD、INCLUDE、REQUEST。

initParams

WebInitParam[]

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

asyncSupported

boolean

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

description

String

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

displayName

String

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

示例

@WebFilter(servletNames = {“SimpleServlet”},filterName=”SimpleFilter”)

public class LessThanSixFilter implements Filter{…}

如此配置之后,就可以不必在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>

注意:此时Filter链的顺序是根据Filter类名的字母排序决定的。例如:CharsetFilter将先于UserFilter执行。如果要改变这个顺序,可以修改类名为:Filter01_UserFilter和Filter02_CharsetFilter

  1. @WebListener

该注解用于将类声明为监听器。

属性名

类型

是否可选

描述

value

String

该监听器的描述信息。

示例

@WebListener(“This is only a demo listener”)

public class SimpleListener implements ServletContextListener{…}

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

<listener>

    <listener-class>com.atguigu.SimpleListener</listener-class>

</listener>

4.@MultipartConfig

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

属性名

类型

是否可选

描述

fileSizeThreshold

int

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

location

String

存放生成的文件地址。

maxFileSize

long

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

maxRequestSize

long

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


上一篇:
下一篇:
关于尚硅谷
教育理念
名师团队
学员心声
资源下载
视频下载
资料下载
工具下载
加入我们
招聘岗位
岗位介绍
招贤纳师
联系我们
电话:010-56253825
邮箱:info@atguigu.com
地址:北京市昌平区宏福科技园综合楼6层(北京校区)

 深圳市宝安区西部硅谷大厦B座C区一层(深圳校区)

上海市松江区谷阳北路166号大江商厦6层(上海校区)