Servlet 常见的注解

Serlvet中WebServlet注解

作用: 用于将一个类声明为 Servlet

描述: 该注解将会在部署时被容器处理, 容器将根据具体的属性配置将相应的类部署为 Servlet.

属性详解: 该注解具有下表给出的一些常用属性(以下所有属性均为可选属性, 但是 vlaue 或者 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[]	指定一组初始化参数,等价于 <init-param> 标签.
asyncSupported	boolean	申明servlet是否支持异步操作模式,等价于 <async-supported> 标签.
displayName	String	servlet的显示名,等价于 <display-name> 标签.
description	String	servlet的描述信息,等价于 <description> 标签.

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" }, // url
        loadOnStartup = 1, // 启动项
        initParams = { @WebInitParam(name = "username", value = "张三") }) // 初始化参数
 
public class UserServlet extends HttpServlet {
 
    private String username;
 
    public UserServlet() {
        System.out.println("UserServlet...");
    }
 
    @Override
    public void init(ServletConfig config) throws ServletException {
        // 获取初始化信息：张三
        username = config.getInitParameter("username");
    }
 
    @Override
    protected void doPost(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        // 主要内容操作
    }
 
    @Override
    protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        // 主要内容操作
        System.out.println(username);
    }
}

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

Filter（过滤器）主要对请求到达前进行处理，也可以在请求结束后进行处理，类似于链式。

一个请求可以被多个过滤器拦截到，会依次进入各个Filter中，放行后直至进入Servlet，Servlet处理请求结束后，回到各个Filter继续执行后面的代码，先执行的Filter后执行完。

常用到的地方：

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

@WebFilter 常用属性

属性名	类型	属性描述
asyncSupported	boolean	指定Filter是否支持异步模式
dispatcherTypes	DispatcherType[]	指定Filter对哪种方式的请求进行过滤. 支持的属性：ASYNC、ERROR、FORWARD、INCLUDE、REQUEST； 默认过滤所有方式的请求
filterName	String	Filter名称
initParams	WebInitParam[]	配置参数
displayName	String	Filter显示名
servletNames	String[]	指定对哪些Servlet进行过滤
urlPatterns/value	String[]	两个属性作用相同，指定拦截的路径

用户权限过滤示例：

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

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;
 
    @Override
    public void init(FilterConfig config) throws ServletException {
        this.config = config;
    }
 
    @Override
    public 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);
            }
        }
    }
 
    @Override
    public void destroy() {
        this.config = null;
    }
}

@WebListener 注解

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

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

@WebListener("This is only a demo listener") 
public class SimpleListener implements ServletContextListener{...}

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