使用Spring Boot注册整合方式整合Servlet三大组件

冷不防 2023-10-10 16:09 8阅读 0赞

在Spring Boot中，使用组件注册方式整合内嵌Servlet容器的Servlet、Filter、Listener三大组件时，只需将这些自定义组件通过ServletRegistrationBean、FilterRegistrationBean、ServletListenerRegistrationBean类注册到容器中即可，这些类相当于将组件配置在web.xml中。

1． 使用组件注册方式整合Servlet

（1）创建自定义Servlet类。在chapter05项目中创建名为com.itheima.servletComponent的包，并在该包下创建一个自定义Servlet类MyServlet，内容如文件1所示。

文件1 MyServlet.java

importorg.springframework.stereotype.Component;importjavax.servlet.ServletException;importjavax.servlet.http.*;importjava.io.IOException;/**
          * 自定义Servlet类
         */@ComponentpublicclassMyServletextendsHttpServlet{@OverrideprotectedvoiddoGet(HttpServletRequest req,HttpServletResponse resp)throwsServletException,IOException{this.doPost(req, resp);}@OverrideprotectedvoiddoPost(HttpServletRequest req,HttpServletResponse resp)throwsServletException,IOException{
                 resp.getWriter().write("hello MyServlet");}}

文件1中，使用@Component注解将MyServlet类作为组件注入Spring容器。MyServlet类继承自HttpServlet，通过HttpServletResponse对象向页面输出“hello MyServlet”。

（2）创建Servlet组件配置类。在项目com.itheima.config包下创建一个Servlet组件配置类ServletConfig，用来对Servlet相关组件进行注册，内容如文件2所示。

文件2 ServletConfig.java

importcom.itheima.servletComponent.MyServlet;importorg.springframework.boot.web.servlet.ServletRegistrationBean;importorg.springframework.context.annotation.Bean;importorg.springframework.context.annotation.Configuration;/**
          * 嵌入式Servlet容器三大组件配置
         */@ConfigurationpublicclassServletConfig{// 注册Servlet组件@BeanpublicServletRegistrationBeangetServlet(MyServlet myServlet){ServletRegistrationBean registrationBean =newServletRegistrationBean(myServlet,"/myServlet");return registrationBean;}}

文件2中，使用@Configuration注解定义了一个Servlet组件配置类ServletConfig，并添加了一个getServlet(MyServlet myServlet)方法，通过组件注册的方式注册自定义的MyServlet组件。在注册自定义的MyServlet组件时，指定了匹配路径为“/myServlet”，并使用@Bean注解将重新组装的ServletRegistrationBean类对象作为Bean组件返回。

启动项目进行测试。项目启动成功后，在浏览器上访问“[http://localhost:8080/myServlet][http_localhost_8080_myServlet]”，效果如图1所示。

![205559f64254c18b5bba3298028ae26f.jpeg][]

图1 自定义Servlet组件访问效果

从图1中可以看出，浏览器能够访问myServlet并正常显示数据，说明Spring Boot成功整合了Servlet组件。

1． 使用组件注册方式整合Filter

（1） 创建自定义Filter类。在com.itheima.servletComponent包下创建一个类MyFilter，内容如文件3所示。

文件3 MyFilter.java

importorg.springframework.stereotype.Component;importjavax.servlet.*;importjava.io.IOException;/**
          *  自定义Filter类
          */@ComponentpublicclassMyFilterimplementsFilter{@Overridepublicvoidinit(FilterConfig filterConfig)throwsServletException{}@OverridepublicvoiddoFilter(ServletRequest servletRequest,ServletResponse servletResponse,FilterChain filterChain)throwsIOException,ServletException{System.out.println("hello MyFilter");
                 filterChain.doFilter(servletRequest,servletResponse);}@Overridepublicvoiddestroy(){}}

文件3中，使用@Component注解将当前MyFilter类作为组件注入到Spring容器中。MyFilter类实现Filter接口，并重写了init()、doFilter()和destroy()方法，在doFilter()方法中向控制台打印了“hello MyFilter”字符串。

（1） 向Servlet组件配置类注册自定义Filter类。打开之前创建的Servlet组件配置类ServletConfig，将该自定义Filter类使用组件注册方式进行注册，示例代码如下。

// 注册Filter组件@BeanpublicFilterRegistrationBeangetFilter(MyFilter filter){FilterRegistrationBean registrationBean =newFilterRegistrationBean(filter);
        registrationBean.setUrlPatterns(Arrays.asList("/toLoginPage","/myFilter"));return registrationBean;}

上述代码中，使用组件注册方式注册自定义的MyFilter类。在getFilter(MyFilter filter)方法中，使用setUrlPatterns(Arrays.asList("/toLoginPage","/myFilter"))方法定义了过滤的请求路径为“/toLoginPage”和“/myFilter”，同时使用@Bean注解将当前组装好的FilterRegistrationBean对象作为Bean组件返回。

完成Filter的自定义配置后启动项目，项目启动成功后，在浏览器上访问“[http://localhost:8080/myFilter][http_localhost_8080_myFilter]”查看控制台打印效果（由于没有编写对应路径的请求处理方法，所以浏览器会出现404错误页面，这里重点关注控制台即可），具体如图2所示。

![2a931dc13124abbc03a316446550bbf4.jpeg][]

图2 自定义Filter组件访问效果

在图2中，浏览器访问“[http://localhost:8080/myFilter][http_localhost_8080_myFilter]”时控制台打印出了自定义Filter中定义的输出语句“hello MyFilter”，这也就说明Spring Boot整合自定义Filter组件成功。

1． 使用组件注册方式整合Listener

（1）创建自定义Listener类。在com.itheima.servletComponent包下创建一个类MyListener，内容如文件4所示。

文件4 MyListener.java

importorg.springframework.stereotype.Component;importjavax.servlet.ServletContextEvent;importjavax.servlet.ServletContextListener;/**
          *  自定义Listener类
         */@ComponentpublicclassMyListenerimplementsServletContextListener{@OverridepublicvoidcontextInitialized(ServletContextEvent servletContextEvent){System.out.println("contextInitialized ...");}@OverridepublicvoidcontextDestroyed(ServletContextEvent servletContextEvent){System.out.println("contextDestroyed ...");}}

文件4中，使用@Component注解将MyListener类作为组件注册到Spring容器中。Listener类实现了ServletContextListener接口，并重写了contextInitialized()和contextDestroyed()方法。

需要说明的是，Servlet容器提供了很多Listener接口，例如ServletRequestListener、HttpSessionListener、ServletContextListener等，我们在自定义Listener类时要根据自身需求选择实现这些接口，这里为了方便演示，直接实现了ServletContextListener接口。

（2）向Servlet组件配置类注册自定义Listener类。打开之前创建的Servlet组件配置类ServletConfig，将该自定义Listener类使用组件注册方式进行注册，示例代码如下。

// 注册Listener组件@BeanpublicServletListenerRegistrationBeangetServletListener(MyListener myListener){ServletListenerRegistrationBean registrationBean =newServletListenerRegistrationBean(myListener);return registrationBean;}

上述代码中，使用组件注册方式注册了一个自定义的MyListener类，在getServletListener()方法中，使用了@Bean注解将当前组装好的FilterRegistrationBean对象作为Bean组件返回。

完成自定义Listener组件注册后启动项目，项目启动成功后查看控制台打印效果，效果如图3所示。

![faaf6235c7803347006ff72d312d77a9.jpeg][]

图3 自定义Listener组件初始化效果

程序启动成功后，控制台会打印出自定义Listener组件中定义的输出语句“contextInitialized ...”。单击图中的【Exit】按钮关闭当前项目（注意，如果直接单击红色按钮会强制关闭程序，浏览器就无法打印关闭监听信息），再次查看控制台打印效果，效果如图4所示。

![41f9ba11345f168ffb300092c3768c3b.jpeg][]

图4 自定义Listener组件关闭效果

程序成功关闭后，控制台打印出了自定义Listener组件中定义的输出语句“contextDestroyed ...”。通过效果演示，说明了Spring Boot整合自定义Listener组件成功。

细心的读者可能发现，将自定义的Servlet组件配置类ServletConfig全部注释并重启项目后，自定义的Servlet、Filter、Listener组件仍然生效。出现这种情况的主要原因是：嵌入式Servlet容器对Servlet、Filter、Listener组件进行了自动化识别和配置，而自定义的Servlet、Filter、Listener都继承/实现了对应的类/接口，同时自定义的Servlet、Filter、Listener组件都使用了@Component注解，这些组件会被自动扫描为Spring组件。

使用ServletRegistrationBean、FilterRegistrationBean、ServletListenerRegistrationBean组件组装配置的根本目的是对一些请求路径和参数进行初始化设置和组装。假设没有组件注册类，那么自定义Servlet虽然生效，但无法确定生效哪个访问路径。自定义的Filter会对所有的请求都进行过滤，不会出现选择性过滤的情况。而自定义的Listener则没有太大影响，因为定制该组件基本不需要设置什么参数。

## 怎样使用Spring Boot项目的单元测试？ ##

在实际开发中，每当完成一个功能接口或业务方法的编写后，通常都会借助单元测试验证该功能是否正确。Spring Boot对项目的单元测试提供了很好的支持，在使用时，需要提前在项目的pom.xml文件中添加spring-boot-starter-test测试依赖启动器，可以通过相关注解实现单元测试。这里，以之前创建的chapter01项目为例对Spring Boot项目的单元测试进行使用演示，具体步骤如下。

1．添加spring-boot-starter-test测试依赖启动器

在项目的pom.xml文件中添加spring-boot-starter-test测试依赖启动器，示例代码如下。

<dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-test</artifactId><scope>test</scope></dependency>

上述代码中，展示了Spring Boot框架集成单元测试提供的依赖启动器，其<scope>范围默认为test。需要说明的是，如果是使用Spring Initializr方式搭建的Spring Boot项目，会自动加入spring-boot-starter-test测试依赖启动器，无需开发者再手动添加。

2．编写单元测试类和测试方法

在项目中添加测试依赖启动器后，可以编写Spring Boot项目中相关方法对应的单元测试。如果是使用Spring Initializr方式搭建的Spring Boot项目，会在src.test.java测试目录下自动创建与项目主程序启动类对应的单元测试类。例如，chapter01项目的Chapter01ApplicationTests是自动生成的单元测试类，内容如文件1所示。

文件1 Chapter01ApplicationTests.java

importorg.junit.Test;importorg.junit.runner.RunWith;importorg.springframework.boot.test.context.SpringBootTest;importorg.springframework.test.context.junit4.SpringRunner;/**
          * 使用Spring Initializr方式自动创建的主程序启动类对应的单元测试类
          */@RunWith(SpringRunner.class)// 测试启动器，并加载Spring Boot测试注解@SpringBootTest// 标记为Spring Boot单元测试类，并加载项目的ApplicationContext上下文环境publicclassChapter01ApplicationTests{// 自动创建的单元测试方法示例@TestpublicvoidcontextLoads(){}}

文件1中，Chapter01ApplicationTests是chapter01项目主程序启动类对应的单元测试类，该类自动生成了一个单元测试方法的示例。第9行代码的@SpringBootTest注解用于标记该类为测试类，并加载项目的ApplicationContext上下文环境；第8行代码的@RunWith注解是一个测试类运行器，用于加载Spring Boot测试注解@SpringBootTest。

下面，在单元测试类Chapter01ApplicationTests中添加HelloController类中hello()请求控制方法对应的单元测试方法，示例代码如下。

@AutowiredprivateHelloController helloController;@TestpublicvoidhelloControllerTest(){String hello = helloController.hello();System.out.println(hello);}

上述代码中，先使用@Autowired注解注入了HelloController实例对象，然后在helloControllerTest()方法中调用了HelloController类中对应的请求控制方法hello()，并输出打印结果。

选中单元测试方法helloControllerTest()，鼠标右键单击“Run ‘helloControllerTest()’”选项启动测试方法，此时控制台的打印信息如图1所示。

![650e31a769bcbc84cc0782a93ef767b5.jpeg][]

图1 helloControllerTest()单元测试方法效果

从图1可以看出，控制台打印出了“hello Spring Boot”信息，说明了控制类HelloController中编写的hello()方法正确，并且单元测试方法执行成功。

[http_localhost_8080_myServlet]: http://localhost:8080/myServlet
[205559f64254c18b5bba3298028ae26f.jpeg]: https://img-blog.csdnimg.cn/img_convert/205559f64254c18b5bba3298028ae26f.jpeg
[http_localhost_8080_myFilter]: http://localhost:8080/myFilter
[2a931dc13124abbc03a316446550bbf4.jpeg]: https://img-blog.csdnimg.cn/img_convert/2a931dc13124abbc03a316446550bbf4.jpeg
[faaf6235c7803347006ff72d312d77a9.jpeg]: https://img-blog.csdnimg.cn/img_convert/faaf6235c7803347006ff72d312d77a9.jpeg
[41f9ba11345f168ffb300092c3768c3b.jpeg]: https://img-blog.csdnimg.cn/img_convert/41f9ba11345f168ffb300092c3768c3b.jpeg
[650e31a769bcbc84cc0782a93ef767b5.jpeg]: https://img-blog.csdnimg.cn/img_convert/650e31a769bcbc84cc0782a93ef767b5.jpeg