Spring Boot @ServletComponentScan 掃描 @WebServlet、@WebFilter、@WebListener

目錄

@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

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

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);
    }
}