目录

@WebServlet

@WebFilter 过滤器

@WebListener 监听器

@ServletComponentScan

---

1、Servlet 三大组件 Servlet、Filter、Listener 在传统项目中需要在 web.xml 中进行相应的配置。Servlet 3.0 开始在 javax.servlet.annotation 包下提供 3 个对应的 @WebServlet、@WebFilter、@WebListener 注解来简化操作。

2、@WebServlet、@WebFilter、@WebListener 写在对应的 Servlet、Filter、Listener 类上作为标识，从而不需要在 web.xml 中进行配置了。

3、Spring Boot 应用中这三个注解默认是不被扫描的，需要在项目启动类上添加 @ServletComponentScan 注解, 表示对 Servlet 组件扫描。

4、注解的方式相比《Spring Boot 注册 Servlet 三大组件 Servlet、Filter、Listener》更加方便。

@WebServlet

import javax.servlet.ServletException;
import javax.servlet.annotation.WebServlet;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;

/**
 * 标准的 Servlet ，实现 javax.servlet.http.HttpServlet. 重写其 doGet 、doPost 方法
 * name :表示 servlet 名称，可以不写，默认为空
 * urlPatterns: 表示请求的路径，如 http://ip:port/context-path/userServlet
 */
@WebServlet(name = "UserServlet", urlPatterns = {"/userServlet"})
public class UserServlet extends HttpServlet {
    @Override
    protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        this.doPost(req, resp);
    }

    @Override
    protected void doPost(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        StringBuffer requestURL = req.getRequestURL();
        System.out.println("com.wmx.servlet.UserServlet -- " + requestURL);
        resp.sendRedirect("/index.html");//浏览器重定向到服务器下的 index.html 页面
    }
}

@WebFilter 过滤器

• 过滤器是在 web 应用启动的时候初始化一次, 在 web 应用停止的时候销毁

• 可以对请求的 URL 进行过滤, 对敏感词过滤

• 挡在拦截器的外层

• 实现的是 javax.servlet.Filter 接口 ，是 Servlet 规范的一部分

• 在请求进入容器后，但在进入servlet之前进行预处理，请求结束是在 servlet 处理完以后

• 依赖 Web 容器

• 会多次执行

import javax.servlet.*;
import javax.servlet.annotation.WebFilter;
import javax.servlet.http.HttpServletRequest;
import java.io.IOException;

/**
 * 标准 Servlet 过滤器，实现 javax.servlet.Filter 接口，并重现它的 3 个方法
 * filterName：表示过滤器名称，可以不写
 * value：配置请求过滤的规则，如 "/*" 表示过滤所有请求，包括静态资源，如 "/user/*" 表示 /user 开头的所有请求
 */
@WebFilter(filterName = "SystemFilter", value = {"/*"})
public class SystemFilter implements Filter {

    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        System.out.println("com.wmx.servlet.SystemFilter -- 系统启动...");
    }

    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
        //转为 HttpServletRequest 输出请求路径
        HttpServletRequest request = (HttpServletRequest) servletRequest;
        System.out.println("com.wmx.servlet.SystemFilter -- 过滤器放行前...." + request.getRequestURL());
        filterChain.doFilter(servletRequest, servletResponse);
        System.out.println("com.wmx.servlet.SystemFilter -- 过滤器返回后...." + request.getRequestURL());
    }

    @Override
    public void destroy() {
        System.out.println("com.wmx.servlet.SystemFilter -- 系统关闭...");
    }
}

@WebListener 监听器

• 实现 javax.servlet.ServletRequestListener, javax.servlet.http.HttpSessionListener, javax.servlet.ServletContextListener 等等接口

• 主要用来监听对象的创建与销毁的发生, 比如 session 的创建销毁, request 的创建销毁, ServletContext 创建销毁

import javax.servlet.ServletContextEvent;
import javax.servlet.ServletContextListener;
import javax.servlet.annotation.WebListener;

/**
 * 标准 Servlet 监听器，实现 javax.servlet.ServletContextListener 接口，并重写方法
 * ServletContextListener 属于 Servlet 应用启动关闭监听器，监听容器初始化与销毁。常用的监听器还有：
 * ServletRequestListener：HttpServletRequest 对象的创建和销毁监听器
 * HttpSessionListener：HttpSession 数据对象创建和销毁监听器
 * HttpSessionAttributeListener 监听HttpSession中属性变化
 * ServletRequestAttributeListener 监听ServletRequest中属性变化
 */
@WebListener
public class SystemListener implements ServletContextListener {
    @Override
    public void contextInitialized(ServletContextEvent sce) {
        System.out.println("com.wmx.servlet.SystemListener -- 服务器启动.");
    }

    @Override
    public void contextDestroyed(ServletContextEvent sce) {
        System.out.println("com.wmx.servlet.SystemListener -- 服务器关闭.");
    }
}

@ServletComponentScan

Spring Boot 应用中这三个注解默认是不被扫描的，需要在项目启动类上添加 @ServletComponentScan 注解, 表示对 Servlet 组件扫描。

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.web.servlet.ServletComponentScan;

@SpringBootApplication
@ServletComponentScan //对 servlet 注解进行扫描
public class RedisStuWebApplication {
    public static void main(String[] args) {
        SpringApplication.run(RedisStuWebApplication.class, args);
    }
}

本文演示源码：wmx-redis: redis 练习 - Gitee.com