Servlet 常见的注解(@WebServlet,@WebListenert,@WebFilter)

1、Serlvet中WebServlet注解

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

属性名类型属性描述nameString指定servlet的name属性,等价于<Servlet-name>.如果没有显示指定，则该servlet的取值即为类的全限定名.valueString[]等价于urlPatterns,二者不能共存.urlPatternsString[]指定一组servlet的url的匹配模式,等价于<url-pattern>标签.loadOnStartupint指定servlet的加载顺序,等价于<load-on-startup>标签.initParamsWebInitParam[]指定一组初始化参数,等价于<init-param>标签.asyncSupportedboolean申明servlet是否支持异步操作模式,等价于<async-supported>标签.displayNameStringservlet的显示名,等价于<display-name>标签.descriptionStringservlet的描述信息,等价于<description>标签.

示例代码：

package cn.sz.servlet;import java.io.IOException;import javax.servlet.ServletConfig;import javax.servlet.ServletException;import javax.servlet.annotation.WebInitParam;import javax.servlet.annotation.WebServlet;import javax.servlet.http.HttpServlet;import javax.servlet.http.HttpServletRequest;import javax.servlet.http.HttpServletResponse;//注解配置  @WebServlet(displayName = "UserServlet", // 描述name = "UserServlet", // servlet名称urlPatterns = { "/user" }, // urlloadOnStartup = 1, // 启动项initParams = { @WebInitParam(name = "username", value = "张三") }) // 初始化参数public class UserServlet extends HttpServlet {private String username;public UserServlet() {System.out.println("UserServlet...");}@Overridepublic void init(ServletConfig config) throws ServletException {// 获取初始化信息：张三username = config.getInitParameter("username");}@Overrideprotected void doPost(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {// 主要内容操作}@Overrideprotected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {// 主要内容操作System.out.println(username);}}

2、@WebFilter注解配置Filter(过滤器)

Filter（过滤器）主要对请求到达前进行处理，也可以在请求结束后进行处理，类似于链式。一个请求可以被多个过滤器拦截到，会依次进入各个Filter中，放行后直至进入Servlet，Servlet处理请求结束后，回到各个Filter继续执行后面的代码，先执行的Filter后执行完。

常用到的地方：

• 用户权限过滤
• 记录日志
• 字符编码处理

@WebFilter常用属性

属性类型是否必需说明asyncSupportedboolean否指定Filter是否支持异步模式dispatcherTypesDispatcherType[]否指定Filter对哪种方式的请求进行过滤。
支持的属性：ASYNC、ERROR、FORWARD、INCLUDE、REQUEST；
默认过滤所有方式的请求filterNameString否Filter名称initParamsWebInitParam[]否配置参数displayNameString否Filter显示名servletNamesString[]否指定对哪些Servlet进行过滤urlPatterns/valueString[]否两个属性作用相同，指定拦截的路径

用户权限过滤示例：

自定义过滤器，实现javax.servlet.Filter接口，通过注解方式配置。拦截所有的请求，放行登录页面、登录操作请求，其余请求需要在登录后才可访问。同时配置参数，指定要放行的路径和请求的字符集。

package cn.sz.servlet;import java.io.IOException;import javax.servlet.Filter;import javax.servlet.FilterChain;import javax.servlet.FilterConfig;import javax.servlet.ServletException;import javax.servlet.ServletRequest;import javax.servlet.ServletResponse;import javax.servlet.annotation.WebFilter;import javax.servlet.annotation.WebInitParam;import javax.servlet.http.HttpServletRequest;import javax.servlet.http.HttpServletResponse;@WebFilter(filterName = "loginFilter", urlPatterns = "/*", initParams = {@WebInitParam(name = "loginUI", value = "/home/loginUI"),@WebInitParam(name = "loginProcess", value = "home/login"),@WebInitParam(name = "encoding", value = "utf-8") })public class LoginFilter implements Filter {private FilterConfig config;@Overridepublic void init(FilterConfig config) throws ServletException {this.config = config;}@Overridepublic void doFilter(ServletRequest req, ServletResponse res, FilterChain chain)throws IOException, ServletException {// 获取配置参数String loginUI = config.getInitParameter("loginUI");String loginProcess = config.getInitParameter("loginProcess");String encoding = config.getInitParameter("encoding");HttpServletRequest request = (HttpServletRequest) req;HttpServletResponse response = (HttpServletResponse) res;// 设置请求的字符集（post请求方式有效）request.setCharacterEncoding(encoding);// 不带http://域名:端口的地址String uri = request.getRequestURI();if (uri.contains(loginUI) || uri.contains(loginProcess)) {// 请求的登录，放行chain.doFilter(request, response);} else {if (request.getSession().getAttribute("user") == null) {// 重定向到登录页面response.sendRedirect(request.getContextPath() + loginUI);} else {// 已经登录，放行chain.doFilter(request, response);}}}@Overridepublic void destroy() {this.config = null;}}

3、@WebListener注解标注监听器

package cn.sz.servlet;import javax.servlet.ServletRequestEvent;import javax.servlet.ServletRequestListener;import javax.servlet.annotation.WebListener;@WebListenerpublic class Test implements ServletRequestListener {    public Test() {    }    public void requestDestroyed(ServletRequestEvent arg0)  {     }    public void requestInitialized(ServletRequestEvent arg0)  {     }}