SpringBoot中注入Servlet&Filter&Listener

末蓝、 2023-09-25 18:54 8阅读 0赞

### 1.基本介绍 ###

> [文档：SpringBoot中注入Servlet&Filter&Listener][SpringBoot_Servlet_Filter_Listener]

1.  考虑到实际开发业务非常复杂和兼容问题，SpringBoot支持将Servlet、Filter、Listener注入spring容器中，成为Spring Bean
2.  也就是说，SpringBoot开放了和原生WEB组件（Servlet、Filter、Listener）的兼容
3.  SpringBoot注入Servlet、Filter、Listener，有两种方式：
    
     *  通过注解方式注入
     *  使用RegistrationBean方式注入

### 2.通过注解方式注入 ###

#### 2.1@WebServlet ####

<table> 
 <thead> 
  <tr> 
   <th>属性名</th> 
   <th>对应标签</th> 
   <th>描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>name</td> 
   <td><code>&lt;servlet-name&gt;</code></td> 
   <td>指定 Servlet 的 name 属性。 如果没有显式指定，则取值为该 Servlet 的完全限定名，即包名+类名</td> 
  </tr> 
  <tr> 
   <td>value</td> 
   <td><code>&lt;url-pattern&gt;</code></td> 
   <td>该属性等价于 urlPatterns 属性，两者不能同时指定。 如果同时指定，通常是忽略 value 的取值</td> 
  </tr> 
  <tr> 
   <td>urlPatterns</td> 
   <td><code>&lt;url-pattern&gt;</code></td> 
   <td>指定一组 Servlet 的 URL 匹配模式</td> 
  </tr> 
  <tr> 
   <td>loadOnStartup</td> 
   <td><code>&lt;load-on-startup&gt;</code></td> 
   <td>指定 Servlet 的加载顺序</td> 
  </tr> 
  <tr> 
   <td>initParams</td> 
   <td><code>&lt;init-param&gt;</code></td> 
   <td>指定一组 Servlet 初始化参数</td> 
  </tr> 
  <tr> 
   <td>asyncSupported</td> 
   <td><code>&lt;async-supported&gt;</code></td> 
   <td>声明 Servlet 是否支持异步操作模式</td> 
  </tr> 
  <tr> 
   <td>description</td> 
   <td><code>&lt;description&gt;</code></td> 
   <td>指定该 Servlet 的描述信息</td> 
  </tr> 
  <tr> 
   <td>displayName</td> 
   <td><code>&lt;display-name&gt;</code></td> 
   <td>指定该 Servlet 的显示名</td> 
  </tr> 
 </tbody> 
</table>

> 例子--使用@WebServlet注入Servlet

（1）MyServlet.java

1.  通过继承HttpServlet来开发原生的Servlet
2.  使用@WebServlet，表示将其标识的对象注入到Spring容器中
3.  urlPatterns = \{"servlet01","servlet02"\} 对此servlet配置了映射路径
4.  对于开发的原生的Servlet，需要使用@ServletComponentScan在SpringBoot主程序中，指定要扫描的原生Servlet，这样该Servlet才能注入容器

<table> 
 <tbody> 
  <tr> 
   <td></td> 
   <td><code>package com.li.thymeleaf.servlet;</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>import javax.servlet.ServletException;</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>import javax.servlet.annotation.WebServlet;</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>import javax.servlet.http.HttpServlet;</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>import javax.servlet.http.HttpServletRequest;</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>import javax.servlet.http.HttpServletResponse;</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>import java.io.IOException;</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>/**</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>* @author 李</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>* @version 1.0</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>*/</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>@WebServlet(urlPatterns = {"/servlet01", "/servlet02"})</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>public class MyServlet extends HttpServlet { </code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>@Override</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException { </code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>resp.getWriter().write("Hello,MyServlet!");</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>}</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>}</code></td> 
  </tr> 
 </tbody> 
</table>

（2）Application.java主程序

<table> 
 <tbody> 
  <tr> 
   <td></td> 
   <td><code>package com.li.thymeleaf;</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>import org.springframework.boot.SpringApplication;</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>import org.springframework.boot.autoconfigure.SpringBootApplication;</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>import org.springframework.boot.web.servlet.ServletComponentScan;</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>/**</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>* @author 李</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>* @version 1.0</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>*/</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>//指定扫描Servlet</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>@ServletComponentScan(basePackages = "com.li.thymeleaf")</code></td> 
  </tr> 
  <tr> 
   <td></td> 
   <td><code>@SpringBootApplication</code></td> 
  </tr> 
 </tbody> 
</table>

[SpringBoot_Servlet_Filter_Listener]: https://docs.spring.io/spring-boot/docs/current/reference/html/features.html#features.developing-web-applications.embedded-container.servlets-filters-listeners