2. 程式人生 > 程式設計 >SpringBoot系列教程web篇Servlet 註冊的四種姿勢

SpringBoot系列教程web篇Servlet 註冊的四種姿勢

阿新 • • 發佈：2020-06-24

原文： 191122-SpringBoot系列教程web篇Servlet 註冊的四種姿勢

前面介紹了 java web 三要素中 filter 的使用指南與常見的易錯事項，接下來我們來看一下 Servlet 的使用姿勢，本篇主要帶來在 SpringBoot 環境下，註冊自定義的 Servelt 的四種姿勢

  • @WebServlet 註解
  • ServletRegistrationBean bean 定義
  • ServletContext 動態新增
  • 普通的 spring bean 模式

I. 環境配置

1. 專案搭建

首先我們需要搭建一個 web 工程，以方便後續的 servelt 註冊的例項演示，可以通過 spring boot 官網建立工程，也可以建立一個 maven 工程，在 pom.xml 中如下配置

<parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>2.2.1.RELEASE</version>
    <relativePath/> <!-- lookup parent from repository -->
</parent>

<properties>
    <project.build.sourceEncoding
 
>UTF-8</project.build.sourceEncoding>
    <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
    <java.version>1.8</java.version>
</properties>

<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId
 
>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
</dependencies>

<build>
    <pluginManagement>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </pluginManagement>
</build>
<repositories>
    <repository>
        <id>spring-snapshots</id>
        <name>Spring Snapshots</name>
        <url>https://repo.spring.io/libs-snapshot-local</url>
        <snapshots>
            <enabled>true</enabled>
        </snapshots>
    </repository>
    <repository>
        <id>spring-milestones</id>
        <name>Spring Milestones</name>
        <url>https://repo.spring.io/libs-milestone-local</url>
        <snapshots>
            <enabled>false</enabled>
        </snapshots>
    </repository>
    <repository>
        <id>spring-releases</id>
        <name>Spring Releases</name>
        <url>https://repo.spring.io/libs-release-local</url>
        <snapshots>
            <enabled>false</enabled>
        </snapshots>
    </repository>
</repositories>
複製程式碼

特別說明：

為了緊跟 SpringBoot 的最新版本，從本篇文章開始，博文對應的示例工程中 SpringBoot 版本升級到2.2.1.RELEASE

II. Servlet 註冊

自定義一個 Servlet 比較簡單，一般常見的操作是繼承HttpServlet，然後覆蓋doGet,doPost等方法即可；然而重點是我們自定義的這些 Servlet 如何才能被 SpringBoot 識別並使用才是關鍵，下面介紹四種註冊方式

1. @WebServlet

在自定義的 servlet 上新增 Servlet3+的註解@WebServlet，來宣告這個類是一個 Servlet

和 Fitler 的註冊方式一樣，使用這個註解，需要配合 Spring Boot 的@ServletComponentScan，否則單純的新增上面的註解並不會生效

/**
 * 使用註解的方式來定義並註冊一個自定義Servlet
 * Created by @author yihui in 19:08 19/11/21.
 */
@WebServlet(urlPatterns = "/annotation")
public class AnnotationServlet extends HttpServlet {
    @Override
    protected void doGet(HttpServletRequest req,HttpServletResponse resp) throws ServletException,IOException {
        String name = req.getParameter("name");
        PrintWriter writer = resp.getWriter();
        writer.write("[AnnotationServlet] welcome " + name);
        writer.flush();
        writer.close();
    }
}
複製程式碼

上面是一個簡單的測試 Servlet，接收請求引數name,並返回 welcome xxx；為了讓上面的的註解生效，需要設定下啟動類

@ServletComponentScan
@SpringBootApplication
public class Application {
    public static void main(String[] args) {
        SpringApplication.run(Application.class);
    }
}
複製程式碼

然後啟動測試，輸出結果如:

➜  ~ curl http://localhost:8080/annotation\?name\=yihuihui
# 輸出結果
[AnnotationServlet] welcome yihuihui%
複製程式碼

2. ServletRegistrationBean

在 Filter 的註冊中，我們知道有一種方式是定義一個 Spring 的 Bean FilterRegistrationBean來包裝我們的自定義 Filter，從而讓 Spring 容器來管理我們的過濾器；同樣的在 Servlet 中，也有類似的包裝 bean: ServletRegistrationBean

自定義的 bean 如下，注意類上沒有任何註解

/**
 * Created by @author yihui in 19:17 19/11/21.
 */
public class RegisterBeanServlet extends HttpServlet {
    @Override
    protected void doGet(HttpServletRequest req,IOException {
        String name = req.getParameter("name");
        PrintWriter writer = resp.getWriter();
        writer.write("[RegisterBeanServlet] welcome " + name);
        writer.flush();
        writer.close();
    }
}
複製程式碼

接下來我們需要定義一個ServletRegistrationBean，讓它持有RegisterBeanServlet的例項

@Bean
public ServletRegistrationBean servletBean() {
    ServletRegistrationBean registrationBean = new ServletRegistrationBean();
    registrationBean.addUrlMappings("/register");
    registrationBean.setServlet(new RegisterBeanServlet());
    return registrationBean;
}
複製程式碼

測試請求輸出如下:

➜  ~ curl 'http://localhost:8080/register?name=yihuihui'
# 輸出結果
[RegisterBeanServlet] welcome yihuihui%
複製程式碼

3. ServletContext

這種姿勢，在實際的 Servlet 註冊中，其實用得並不太多，主要思路是在 ServletContext 初始化後，藉助javax.servlet.ServletContext#addServlet(java.lang.String,java.lang.Class<? extends javax.servlet.Servlet>)方法來主動新增一個 Servlet

所以我們需要找一個合適的時機，獲取ServletContext例項，並註冊 Servlet，在 SpringBoot 生態下，可以藉助ServletContextInitializer

ServletContextInitializer 主要被 RegistrationBean 實現用於往 ServletContext 容器中註冊 Servlet,Filter 或者 EventListener。這些 ServletContextInitializer 的設計目的主要是用於這些例項被 Spring IoC 容器管理

/**
 * Created by @author yihui in 19:49 19/11/21.
 */
public class ContextServlet extends HttpServlet {

    @Override
    protected void doGet(HttpServletRequest req,IOException {
        String name = req.getParameter("name");
        PrintWriter writer = resp.getWriter();
        writer.write("[ContextServlet] welcome " + name);
        writer.flush();
        writer.close();
    }
}


/**
 * Created by @author yihui in 19:50 19/11/21.
 */
@Component
public class SelfServletConfig implements ServletContextInitializer {
    @Override
    public void onStartup(ServletContext servletContext) throws ServletException {
        ServletRegistration initServlet = servletContext.addServlet("contextServlet",ContextServlet.class);
        initServlet.addMapping("/context");
    }
}
複製程式碼

測試結果如下

➜  ~ curl 'http://localhost:8080/context?name=yihuihui'
# 輸出結果
[ContextServlet] welcome yihuihui%
複製程式碼

4. bean

接下來的這種註冊方式，並不優雅，但是也可以實現 Servlet 的註冊目的，但是有坑，請各位大佬謹慎使用

看過我的前一篇博文191016-SpringBoot 系列教程 web 篇之過濾器 Filter 使用指南的同學，可能會有一點映象，可以在 Filter 上直接新增@Component註解，Spring 容器掃描 bean 時，會查詢所有實現 Filter 的子類，並主動將它包裝到FilterRegistrationBean，實現註冊的目的

我們的 Servlet 是否也可以這樣呢？接下來我們實測一下

@Component
public class BeanServlet1 extends HttpServlet {
    @Override
    protected void doGet(HttpServletRequest req,IOException {
        String name = req.getParameter("name");
        PrintWriter writer = resp.getWriter();
        writer.write("[BeanServlet1] welcome " + name);
        writer.flush();
        writer.close();
    }
}
複製程式碼

現在問題來了，上面這個 Servlet 沒有定義 urlMapping 規則，怎麼請求呢？

為了確定上面的 Servlet 被註冊了，藉著前面 Filter 的原始碼分析的關鍵鏈路，我們找到了實際註冊的地方ServletContextInitializerBeans#addAsRegistrationBean

// org.springframework.boot.web.servlet.ServletContextInitializerBeans#addAsRegistrationBean(org.springframework.beans.factory.ListableBeanFactory,java.lang.Class<T>,java.lang.Class<B>,org.springframework.boot.web.servlet.ServletContextInitializerBeans.RegistrationBeanAdapter<T>)

@Override
public RegistrationBean createRegistrationBean(String name,Servlet source,int totalNumberOfSourceBeans) {
	String url = (totalNumberOfSourceBeans != 1) ? "/" + name + "/" : "/";
	if (name.equals(DISPATCHER_SERVLET_NAME)) {
		url = "/"; // always map the main dispatcherServlet to "/"
	}
	ServletRegistrationBean<Servlet> bean = new ServletRegistrationBean<>(source,url);
	bean.setName(name);
	bean.setMultipartConfig(this.multipartConfig);
	return bean;
}
複製程式碼

從上面的原始碼上可以看到，這個 Servlet 的 url 要麼是/,要麼是/beanName/

接下來進行實測，全是 404

➜  ~ curl 'http://localhost:8080/?name=yihuihui'
{"timestamp":"2019-11-22T00:52:00.448+0000","status":404,"error":"Not Found","message":"No message available","path":"/"}%

➜  ~ curl 'http://localhost:8080/beanServlet1?name=yihuihui'
{"timestamp":"2019-11-22T00:52:07.962+0000","path":"/beanServlet1"}%

➜  ~ curl 'http://localhost:8080/beanServlet1/?name=yihuihui'
{"timestamp":"2019-11-22T00:52:11.202+0000","path":"/beanServlet1/"}%
複製程式碼

然後再定義一個 Servlet 時

@Component
public class BeanServlet2 extends HttpServlet {
    @Override
    protected void doGet(HttpServletRequest req,IOException {
        String name = req.getParameter("name");
        PrintWriter writer = resp.getWriter();
        writer.write("[BeanServlet2] welcome " + name);
        writer.flush();
        writer.close();
    }
}
複製程式碼

再次測試

➜  ~ curl 'http://localhost:8080/beanServlet1?name=yihuihui'
{"timestamp":"2019-11-22T00:54:12.692+0000","path":"/beanServlet1"}%

➜  ~ curl 'http://localhost:8080/beanServlet1/?name=yihuihui'
[BeanServlet1] welcome yihuihui%

➜  ~ curl 'http://localhost:8080/beanServlet2/?name=yihuihui'
[BeanServlet2] welcome yihuihui%
複製程式碼

從實際的測試結果可以看出，使用這種定義方式時，這個 servlet 相應的 url 為beanName + '/'

注意事項

然後問題來了，只定義一個 Servlet 的時候，根據前面的原始碼分析，這個 Servlet 應該會相應http://localhost:8080/的請求，然而測試的時候為啥是 404？

這個問題也好解答，主要就是 Servlet 的優先順序問題，上面這種方式的 Servlet 的相應優先順序低於 Spring Web 的 Servelt 優先順序，相同的 url 請求先分配給 Spring 的 Servlet 了，為了驗證這個也簡單，兩步

  • 先註釋BeanServlet2類上的註解@Component
  • 在BeanServlet1的類上，新增註解@Order(-10000)

然後再次啟動測試,輸出如下

➜  ~ curl 'http://localhost:8080/?name=yihuihui'
[BeanServlet1] welcome yihuihui%

➜  ~ curl 'http://localhost:8080?name=yihuihui'
[BeanServlet1] welcome yihuihui%
複製程式碼

5. 小結

本文主要介紹了四種 Servlet 的註冊方式，至於 Servlet 的使用指南則靜待下篇

常見的兩種註冊 case:

  • @WebServlet註解放在 Servlet 類上，然後啟動類上新增@ServletComponentScan，確保 Serlvet3+的註解可以被 Spring 識別
  • 將自定義 Servlet 例項委託給 bean ServletRegistrationBean

不常見的兩種註冊 case:

  • 實現介面ServletContextInitializer，通過ServletContext.addServlet來註冊自定義 Servlet
  • 直接將 Serlvet 當做普通的 bean 註冊給 Spring
    • 當專案中只有一個此種 case 的 servlet 時，它響應 url: '/',但是需要注意不指定優先順序時，預設場景下 Spring 的 Servlet 優先順序更高，所以它接收不到請求
    • 當專案有多個此種 case 的 servlet 時，響應的 url 為beanName + '/'， 注意後面的'/'必須有

II. 其他

0. 專案

web 系列博文

專案原始碼

1. 一灰灰 Blog

盡信書則不如，以上內容，純屬一家之言，因個人能力有限，難免有疏漏和錯誤之處，如發現 bug 或者有更好的建議，歡迎批評指正，不吝感激

下面一灰灰的個人部落格，記錄所有學習和工作中的博文，歡迎大家前去逛逛

一灰灰blog

相關推薦

SpringBoot系列教程web篇Servlet 註冊的四種姿勢

原文： 191122-SpringBoot系列教程web篇Servlet 註冊的四種姿勢 前面介紹了 java web 三要素中 filter 的使用指南與常見的易錯事項，接下來我們來看一下 Servlet 的使用姿勢，本篇主要帶來在 SpringBoot 環境下，註

SpringBoot系列教程Web篇之開啟GZIP資料壓縮

本篇可以歸納在效能調優篇，雖然內容非常簡單，但效果可能出乎預料的好；

SpringBoot系列教程web篇之全域性異常處理

當我們的後端應用出現異常時，通常會將異常狀況包裝之後再返回給呼叫方或者前端，在實際的專案中，不可能對每一個地方都做好異常處理，再優雅的程式碼也可能丟擲異常，那麼在 Spring 專案中，可以怎樣優雅的處理這些

SpringBoot系列教程web篇之404、500異常頁面配置

接著前面幾篇web處理請求的博文，本文將說明，當出現異常的場景下，如404請求url不存在，，403無權，500伺服器異常時，我們可以如何處理

SpringBoot系列教程web篇之重定向

原文地址: SpringBoot系列教程web篇之重定向 前面介紹了spring web篇資料返回的幾種常用姿勢，當我們在相應一個http請求時，除了直接返回資料之外，還有另一種常見的case -> 重定向；

SpringBoot系列教程web篇之自定義異常處理HandlerExceptionResolver

關於Web應用的全域性異常處理，上一篇介紹了ControllerAdvice結合@ExceptionHandler的方式來實現web應用的全域性異常管理；

SpringBoot系列教程web篇之過濾器Filter使用指南擴充套件篇

前面一篇博文介紹了在 SpringBoot 中使用 Filter 的兩種使用方式，這裡介紹另外一種直接將 Filter 當做 Spring 的 Bean 來使用的方式，並且在這種使用方式下，Filter 的優先順序可以直接通過@Order註解來指定；最後將

SpringBoot系列教程web篇之過濾器Filter使用指南

web三大元件之一Filter，可以說是很多小夥伴學習java web時最早接觸的知識點了，然而學得早不代表就用得多。基本上，如果不是讓你從0到1寫一個web應用（或者說即便從0到1寫一個web應用），在你的日常業務開發中不太可

SpringBoot系列教程web篇之Beetl環境搭建

前面兩篇分別介紹了目前流行的模板引擎Freemaker和Thymeleaf構建web應用的方式，接下來我們看一下號稱效能最好的國產模板引擎Beetl，如何搭建web環境

SpringBoot系列教程web篇之Freemaker環境搭建

現在的開發現狀比較流行前後端分離，使用springboot搭建一個提供rest介面的後端服務特別簡單，引入spring-boot-starter-web依賴即可。那麼在不分離的場景下，比如要開發一個後端使用的控制檯，這時候可能並沒有前端資

SpringBoot系列教程web篇之Thymeleaf環境搭建

上一篇博文介紹瞭如何使用Freemaker引擎搭建web專案，這一篇我們則看一下另外一個常見的頁面渲染引擎Thymeleaf如何搭建一個web專案

SpringBoot系列教程web篇之Get請求引數解析姿勢彙總

一般在開發web應用的時候，如果提供http介面，最常見的http請求方式為GET/POST，我們知道這兩種請求方式的一個顯著區別是GET請求的引數在url中，而post請求可以不在url中；那麼一個SpringBoot搭建的web應用可以如何

SpringBoot系列教程web篇之Post請求引數解析姿勢彙總

作為一個常年提供各種Http介面的後端而言，如何獲取請求引數可以說是一項基本技能了，本篇為《190824-SpringBoot系列教程web篇之Get請求引數解析姿勢彙總》之後的第二篇，對於POST請求方式下，又可以怎樣獲取請求引數

SpringBoot系列教程web篇之如何自定義引數解析器

SpringMVC提供了各種姿勢的http引數解析支援，從前面的GET/POST引數解析篇也可以看到，加一個@RequsetParam註解就可以將方法引數與http引數繫結，看到這時自然就會好奇這是怎麼做到的,我們能不能自己定義一種引數解析

爆破專欄丨Spring Security系列教程之Spring Security的四種許可權控制方式

前言 在前面的章節中，一一哥已經給大家介紹了Spring Security的很多功能，在這些眾多功能中，我們知道其核心功能其實就是認證+授權。

SpringBoot系列教程JPA之query使用姿勢詳解之基礎篇

前面的幾篇文章分別介紹了CURD中的增刪改，接下來進入最最常見的查詢篇，看一下使用jpa進行db的記錄查詢時，可以怎麼玩

SpringBoot系列教程JPA之指定id儲存

原文連結: 191119-SpringBoot系列教程JPA之指定id儲存 前幾天有位小夥伴問了一個很有意思的問題，使用 JPA 儲存資料時，即便我指定了主鍵 id，但是新插入的資料主鍵卻是 mysql 自增的 id；那麼是什麼原因導致的呢？

SpringBoot系列教程之Redis叢集環境配置

之前介紹的幾篇redis的博文都是基於單機的redis基礎上進行演示說明的，然而在實際的生產環境中，使用redis叢集的可能性應該是大於單機版的redis的，那麼叢集的redis如何操作呢？它的配置和單機的有什麼區別，又有什麼

SpringBoot系列教程之Bean載入順序之錯誤使用姿勢闢謠

在網上查詢 Bean 的載入順序時，看到了大量的文章中使用@Order註解的方式來控制 bean 的載入順序，不知道寫這些的博文的同學自己有沒有實際的驗證過，本文希望通過指出這些錯誤的使用姿勢，讓觀文的小夥伴可以知道@O

SpringBoot系列教程之Bean之指定初始化順序的若干姿勢

上一篇博文介紹了@Order註解的常見錯誤理解，它並不能指定 bean 的載入順序，那麼問題來了，如果我需要指定 bean 的載入順序，那應該怎麼辦呢？