SpringBoot注册Servlet的三种方法详解

更新时间：2019年05月07日 10:44:53 作者：Java技术栈

这篇文章主要介绍了SpringBoot注册Servlet的三种方法详解，教你如何Spring Boot 注册 Servlet、Filter、Listener，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧

本文栈长教你如何在 Spring Boot 注册 Servlet、Filter、Listener。

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

}

@Bean
public 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技术栈
 */
@Component
public 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 的方式，大家灵活运用。

以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持脚本之家。

您可能感兴趣的文章:

springboot多文件或者文件夹压缩成zip的方法
最近碰到个需要下载zip压缩包的需求,于是我在网上找了下别人写好的zip工具类,下面通过本文给大家分享springboot多文件或者文件夹压缩成zip的方法,感兴趣的朋友一起看看吧
2024-07-07
Springboot+Jackson自定义注解数据脱敏的项目实践
数据脱敏可以对敏感数据比如手机号、银行卡号等信息进行转换或者修改，本文主要介绍了Springboot+Jackson 自定义注解数据脱敏，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2023-08-08
Ubuntu快速安装jdk的教程
这篇文章主要为大家详细介绍了Ubuntu快速安装jdk的教程，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2017-04-04
java有界类型参数的实例用法
小编给大家整理了一篇关于java有界类型参数的使用的相关文章及扩展实例内容，有需要的朋友们可以学习参考下。
2021-07-07
springboot的controller层的常用注解说明
这篇文章主要介绍了springboot的controller层的常用注解说明,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
2023-10-10
SpringBoot Event实现异步消费机制的示例代码
这篇文章主要介绍了SpringBoot Event实现异步消费机制,ApplicationEvent以及Listener是Spring为我们提供的一个事件监听、订阅的实现,内部实现原理是观察者设计模式,文中有详细的代码示例供大家参考,需要的朋友可以参考下
2024-04-04
SWT(JFace)体验之ApplicationWindow
SWT(JFace)体验之ApplicationWindow
2009-06-06
利用stream sorted进行降序排序
这篇文章主要介绍了利用stream sorted进行降序排序，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧
2021-03-03
Spring运行时手动注入bean的方法实例
spring给我们提供了IOC服务,让我们可以用注解的方式,方便的使用bean的相互引用,下面这篇文章主要给大家介绍了关于Spring运行时手动注入bean的相关资料,需要的朋友可以参考下
2022-05-05
Java任意长度byte数组转换为int数组的方法
这篇文章主要给大家介绍了关于Java任意长度byte数组转换为int数组的相关资料，文中通过示例代码介绍的非常详细，对大家的学习或者使用Java具有一定的参考学习价值，需要的朋友们下面来一起学习学习吧
2020-07-07

SpringBoot注册Servlet的三种方法详解

相关文章

最新评论

大家感兴趣的内容

最近更新的内容

常用在线小工具