Servlet 基础知识

前置知识：HTTP 相关知识

1. 简述

运行在 web 服务器或应用服务器的程序，用作连接 web 浏览器/其他客户端的 HTTP 请求和数据库的中间处理层。

2. 生命周期

-init(ServletConfig config)：初始化
-service(ServletRequest req, ServletResponse res)：主要处理入口
-destroy()：销毁
调用流程：
浏览器发起 http 请求 -> servlet1.init -> servlet1.service -> servlet1.destroy -> servlet2.init -> servlet2.service -> servlet2.destroy -> 返回

3. 相关的主要类

• Servlet：Servlet 顶级接口类
• HttpServlet：处理 Http 请求的 Servlet，处理 Http 请求的服务端程序只需继承本类即可
• ServletRequest、ServletResponse：请求和响应的顶级接口类
• HttpServletRequest、HttpServletResponse：对 Http 请求的封装，包括对 get、post、put 等不同类型请求的处理

4. 扩展

4.1 过滤器 filter

4.1.1 定义

过滤器是 servlet 的一种扩展，可在处理满足拦截条件的 servlet 前后进行统一处理。如网络中有时需将数据加密后传输，可使用 filter 统一对数据解密，后续 servlet 获取的数据都是明文数据。

public class DecodeFilter implements Filter {
    public void init(FilterConfig filterConfig) throws ServletException {
    }

    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
        String psw  = req.getParameter("psw");
        // 对数据进行解密，后续 servlet 从 request 中获取 psw 将都是解密后的数据
        req.setParameter("psw", decode(psw));
        chain.doFilter(httpServletRequest, httpServletResponse);
    }

    public void destroy() {
    }
}

4.1.2 生命周期

• init(FilterConfig filterConfig)：初始化，可通过 filterConfig 获取 servlet 上下文，获取在 web.xml 中配置的初始化参数等；
• doFilter(ServletRequest request, ServletResponse response, FilterChain chain)：主要实现逻辑，http 请求 ServletRequest 可强转成 HttpServletRequest，获取 http 相关的一些数据，ServletResponse 类似
• destroy()：销毁

结合 servlet，其调用流程大概为：
浏览器发起 http 请求 -> filter1.init -> filter1.doFilter -> filter2.init -> filter2.doFilter -> servlet1 -> servlet2 -> filter2.destroy -> filter1.destroy -> 返回给浏览器

4.1.3 web.xml 配置

在 web.xml 中配置 filter。

<filter>
        <filter-name>decode-filter</filter-name>
        <filter-class>com.cui.DecodeFilter</filter-class>
        <init-param>
            <param-name></param-name>
            <param-value></param-value>
        </init-param>
</filter>
<filter-mapping>
        <filter-name>decode-filter</filter-name>
        <url-pattern>/*</url-pattern> <!--定义拦截的链接-->
        <dispatcher>REQUEST</dispatcher>
        <dispatcher>FORWARD</dispatcher>
    </filter-mapping>

4.2 监听器 listener

4.2.1 定义

用于监听 ServletContext、HttpSession、ServletRequest等的创建、销毁、属性修改等事件。

4.2.2 web.xml 配置

web.xml 配置：

<listener>
    <listener-class>com.cui.SessionChangeLisener</listener-class>
</listener>

4.2.3 分类

• 监听 ServletContext：ServletContextListener、ServletContextAttributeListener
• 监听 HttpSession：HttpSessionListener、HttpSessionAttributeListener
• 监听 ServletRequest：ServletRequestListener、ServletRequestAttributeListener

XXListener 是域对象创建和销毁的监听器，XXAttributeListener 是域对象属性变更的监听器

4.3 HttpServletRequestWrapper 和 HttpServletResponseWrapper

分别是HttpServletRequest 和 HttpServletResponse 的包装类，结合 filter 使用，方便修改 HttpServletRequest 和 HttpServletResponse。
例如很多登录场景里，服务器是返回 token 给页面，用户登录后点击页面会将 token 带到服务器，服务器很多功能都需要通过 token 获取到用户的 userId，根据 userId 获取用户的信息等，我们可通过 filter + HttpServletRequestWrapper 实现。

public final class TokenFilter implements Filter {

    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
    }
    
    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain chain) throws IOException, ServletException {
        HttpServletRequest request = (HttpServletRequest) servletRequest;
        HttpServletResponse response = (HttpServletResponse) servletResponse;
        chain.doFilter(new TokenRequest(request, response), response);
    }

    @Override
    public void destroy() {
    }

public class TokenRequest extends HttpServletRequestWrapper {

    private HttpServletRequest request；

    private HttpServletResponse httpServletResponse;

	private boolean hasCalculated = false;

    public AccountValidationRequest(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse) {
        super(httpServletRequest);
        this.request = httpServletRequest;
        this.httpServletResponse = httpServletResponse;
    }

    @Override
    public Object getAttribute(String name) {
        if (StringUtils.isNotEmpty(name) && name.euqals("userId")) {
                	try {
				        getUserIdFromToken(realRequest, httpServletResponse);
			        } finally {
			        	hasCalculated = true;
					}
        }

        return super.getAttribute(name);
    }

    @Override
    public Enumeration<String> getAttributeNames() {
    	try {
	        getUserIdFromToken(realRequest, httpServletResponse);
	        return super.getAttributeNames();
        } finally {
        	hasCalculated = true;
		}
    }
}

	private void getUserIdFromToken(HttpServletRequest request, HttpServletResponse response) {
		if (hasCalculated) {
			return;
		}
		// 通过 token 获取 userId
		long userId = getUserIdByToken(request.getParameter("token"));
		// userId 设置到 request 中
		requet.setParameter("userId", userId);
    }
}

通过上面的案例可看出 HttpServletRequestWrapper 的用法。

有一点需要说明：直接使用 filter 就可以实现上线的功能，但需在 doFilter 时就立即通过 token 获取 userId，并设置到 request 中。而使用 HttpServletRequestWrapper 其实是延迟获取的，只有用到了才会去获取