javax.servlet.annotation
注释类型 WebFilter

@Target(value=TYPE)
@Retention(value=RUNTIME)
@Documented
public @interface WebFilter

Annotation used to declare a servlet filter.

This annotation is processed by the container at deployment time, and the corresponding filter applied to the specified URL patterns, servlets, and dispatcher types.

从以下版本开始：

Servlet 3.0

另请参见：

Filter

可选元素摘要

boolean	asyncSupported Declares whether the filter supports asynchronous operation mode.
String	description The description of the filter
DispatcherType[]	dispatcherTypes The dispatcher types to which the filter applies
String	displayName The display name of the filter
String	filterName The name of the filter
WebInitParam[]	initParams The init parameters of the filter
String	largeIcon The large-icon of the filter
String[]	servletNames The names of the servlets to which the filter applies.
String	smallIcon The small-icon of the filter
String[]	urlPatterns The URL patterns to which the filter applies
String[]	value The URL patterns to which the filter applies

description

public abstract String description

The description of the filter

默认值：

""

displayName

public abstract String displayName

The display name of the filter

默认值：

""

initParams

public abstract WebInitParam[] initParams

The init parameters of the filter

默认值：

{}

filterName

public abstract String filterName

The name of the filter

默认值：

""

smallIcon

public abstract String smallIcon

The small-icon of the filter

默认值：

""

largeIcon

public abstract String largeIcon

The large-icon of the filter

默认值：

""

servletNames

public abstract String[] servletNames

The names of the servlets to which the filter applies.

默认值：

{}

value

public abstract String[] value

The URL patterns to which the filter applies

默认值：

{}

urlPatterns

public abstract String[] urlPatterns

The URL patterns to which the filter applies

默认值：

{}

dispatcherTypes

public abstract DispatcherType[] dispatcherTypes

The dispatcher types to which the filter applies

默认值：

javax.servlet.DispatcherType.REQUEST

asyncSupported

public abstract boolean asyncSupported

Declares whether the filter supports asynchronous operation mode.

另请参见：

ServletRequest.startAsync(), ServletRequest.startAsync(ServletRequest, ServletResponse)

默认值：

false