Spring Boot 注冊 Servlet 的三種方法，真是太有用了！

本文棧長教你如何在 Spring Boot 注冊 Servlet、Filter、Listener。

你所需具備的基礎

什麼是 Spring Boot?

Spring Boot 核心配置檔案詳解

Spring Boot 開啟的 2 種方式

Spring Boot 自動配置原理、實戰

Spring Boot 2.x 啟動全過程源碼分析

更多請在Java技術棧微信公衆号背景回複關鍵字：boot。

一、Spring Boot 注冊

Spring Boot 提供了 ServletRegistrationBean, FilterRegistrationBean, ServletListenerRegistrationBean 三個類分别用來注冊 Servlet, Filter, Listener，下面是 Servlet 的示例代碼。

import javax.servlet.http.HttpServlet;import javax.servlet.http.HttpServletRequest;import javax.servlet.http.HttpServletResponse;import java.io.IOException;/** * @author Java技術棧 */public class RegisterServlet extends HttpServlet {    @Override    protected void service(HttpServletRequest req, HttpServletResponse resp) throws IOException {        String name = getServletConfig().getInitParameter("name");        String sex = getServletConfig().getInitParameter("sex");        resp.getOutputStream().println("name is " + name);        resp.getOutputStream().println("sex is " + sex);    }}@Beanpublic ServletRegistrationBean registerServlet() {    ServletRegistrationBean servletRegistrationBean = new ServletRegistrationBean(            new RegisterServlet(), "/registerServlet");    servletRegistrationBean.addInitParameter("name", "javastack");    servletRegistrationBean.addInitParameter("sex", "man");    return servletRegistrationBean;}      

二、元件掃描注冊

Servlet 3.0 之前，Servlet、Filter、Listener 這些元件都需要在 web.xml 中進行配置，3.0 之後開始不再需要 web.xml 這個配置檔案了，所有的元件都可以通過代碼配置或者注解來達到目的。

如下圖所示，截圖自 Servlet 3.1。

Servlet 3.0 開始提供了這 3 個注解來代替。

@WebServlet => 代替 servlet 配置

@WebFilter => 代替 filter 配置

@WebListener => 代替 listener 配置

配置 Servlet 示例

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;import java.io.IOException;/** * @author Java技術棧 */@WebServlet(name = "javaServlet", urlPatterns = "/javastack.cn", asyncSupported = true,        initParams = {        @WebInitParam(name = "name", value = "javastack"),        @WebInitParam(name = "sex", value = "man") })public class JavaServlet extends HttpServlet {    @Override    protected void service(HttpServletRequest req, HttpServletResponse resp) throws IOException {        String name = getServletConfig().getInitParameter("name");        String sex = getServletConfig().getInitParameter("sex");        resp.getOutputStream().println("name is " + name);        resp.getOutputStream().println("sex is " + sex);    }}      

配置 Filter 示例

/** * @author Java技術棧 */@WebFilter(filterName = "javaFilter", urlPatterns = "/*", initParams = {        @WebInitParam(name = "name", value = "javastack"),        @WebInitParam(name = "code", value = "123456") })public class JavaFilter implements Filter {    @Override    public void init(FilterConfig filterConfig) throws ServletException {        System.out.println("java filter init.");        String name = filterConfig.getInitParameter("name");        String code = filterConfig.getInitParameter("code");        System.out.println("name is " + name);        System.out.println("code is " + code);    }    @Override    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)            throws IOException, ServletException {        System.out.println("java filter processing.");        chain.doFilter(request, response);    }    @Override    public void destroy() {        System.out.println("java filter destroy.");    }}      

Listener 配置方式類似，上面的示例代碼一看就懂，這裡不再詳述。

需要注意的是，為了安全考慮，内嵌伺服器不會直接執行 Servlet 3.0 裡面的 javax.servlet.ServletContainerInitializer 接口，或者 Spring 中的 org.springframework.web.WebApplicationInitializer 接口，否則會導緻終止 Spring Boot 應用。

是以，如果使用的是 Spring Boot 内嵌伺服器，需要在配置類上面添加額外的 @ServletComponentScan 注解來開啟 Servlet 元件掃描功能，如果使用的是獨立的伺服器，則不需要添加，會使用伺服器内部的自動發現機制。

三、動态注冊

如果你想在 Spring Boot 中完成 Servlet、Filter、Listener 的初始化操作，你需要在 Spring 中實作下面這個接口，并注冊為一個 bean。

org.springframework.boot.web.servlet.ServletContextInitializer

ServletContext 提供了幾個動态注冊的方法，如下所示。

以下為動态添加 Servlet 示例代碼。

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;import java.io.IOException;/** * @author Java技術棧 */@WebServlet(name = "javaServlet", urlPatterns = "/javastack.cn", asyncSupported = true,        initParams = {        @WebInitParam(name = "name", value = "javastack"),        @WebInitParam(name = "sex", value = "man") })public class JavaServlet extends HttpServlet {    @Override    protected void service(HttpServletRequest req, HttpServletResponse resp) throws IOException {        String name = getServletConfig().getInitParameter("name");        String sex = getServletConfig().getInitParameter("sex");        resp.getOutputStream().println("name is " + name);        resp.getOutputStream().println("sex is " + sex);    }}import cn.javastack.springbootbestpractice.servlet.InitServlet;import org.springframework.boot.web.servlet.ServletContextInitializer;import org.springframework.stereotype.Component;import javax.servlet.ServletContext;import javax.servlet.ServletRegistration;/** * @author Java技術棧 */@Componentpublic class ServletConfig implements ServletContextInitializer {    @Override    public void onStartup(ServletContext servletContext) {        ServletRegistration initServlet = servletContext                .addServlet("initServlet", InitServlet.class);        initServlet.addMapping("/initServlet");        initServlet.setInitParameter("name", "javastack");        initServlet.setInitParameter("sex", "man");    }}      

總結

本文介紹了在 Spring Boot 下的 3 種注冊 Servlet、Filter、Listener 的方式，大家靈活運用。