SpringBoot项目中使用Servlet、过滤器、监听器

忘是亡心i 2021-07-25 00:49 405阅读 0赞

# 1、使用Servlet处理请求 #

Servlet是运行在Web服务器端的Java应用程序，它使用Java语言编写，具有Java语言的优点。与Java程序的区别是，Servlet对象主要封装了对HTTP请求的处理，并且它的运行需要Servlet容器的支持，在Java Web应用方面，Servlet的应用占用十分重要的地位，它在Web请求的处理功能方面也非常强大。

## 1.1 @WebServlet注释 ##

在Servlet3.0中新增了@WebServlet注释，@WebServlet注释定义在Servlet的类声明之前，用于定义Servlet组件。使用该注释，就无须再 web.xml 文件中对Servlet进行配置。@WebServlet注释包含很多属性。

**说明：**使用@WebServlet注释，配置Servlet的name属性与urlPatterns属性，如下代码：

@WebServlet(name = "RegServlet", urlPatterns = "/servlet/RegServlet")

**@WebServlet注释主要属性列表：**

<table> 
 <thead> 
  <tr> 
   <th>属性名</th> 
   <th>类型</th> 
   <th>描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>name</td> 
   <td>String</td> 
   <td>指定Servlet的name属性，等价于&lt;servlet-name&gt;标签。如果没有显示指定，则该Servlet的取值即为类的全限定名。</td> 
  </tr> 
  <tr> 
   <td>value</td> 
   <td>String[]</td> 
   <td>该属性等价于urlPatterns属性。两个属性不能同时使用。</td> 
  </tr> 
  <tr> 
   <td>urlPatterns</td> 
   <td>String[]</td> 
   <td>指定一组Servlet的URL匹配模式，等价于&lt;url-pattern&gt;标签。</td> 
  </tr> 
  <tr> 
   <td>loadOnStartup</td> 
   <td>int</td> 
   <td>指定Servlet的加载顺序，等价于&lt;load-on-startup&gt;标签。</td> 
  </tr> 
  <tr> 
   <td>initParams</td> 
   <td>WebInitParam[]</td> 
   <td>指定一组Servlet初始化参数，等价于&lt;init-param&gt;标签。</td> 
  </tr> 
  <tr> 
   <td>asyncSupported</td> 
   <td>boolean</td> 
   <td>声明Servlet是否支持异步操作，等价于&lt;async-supported&gt;标签。</td> 
  </tr> 
  <tr> 
   <td>smallIcon</td> 
   <td>String</td> 
   <td>此Servlet的小图标。</td> 
  </tr> 
  <tr> 
   <td>largeIcon</td> 
   <td>String</td> 
   <td>此Servlet的大图标。</td> 
  </tr> 
  <tr> 
   <td>description</td> 
   <td>String</td> 
   <td>该Servlet的描述信息，等价于&lt;description&gt;标签。</td> 
  </tr> 
  <tr> 
   <td>displayName</td> 
   <td>String</td> 
   <td>该Servlet的显示名，通常配合工具使用，等价于&lt;display-name&gt;标签。</td> 
  </tr> 
 </tbody> 
</table>

## 1.2 @WebInitParam注释 ##

@WebInitParam注释等价于web.xml文件中的<servlet>和<filter>的<init-param>子标签，该注释通常不单独使用，而是配合@WebServlet或者@WebFilter使用。

**@WebInitParam注释主要属性列表：**

<table> 
 <thead> 
  <tr> 
   <th>属性名</th> 
   <th>类型</th> 
   <th>描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>name</td> 
   <td>String</td> 
   <td>指定参数的名字，等价于&lt;param-name&gt;标签，必填项。</td> 
  </tr> 
  <tr> 
   <td>value</td> 
   <td>String</td> 
   <td>指定参数的值，等价于&lt;param-value&gt;标签，必填项。</td> 
  </tr> 
  <tr> 
   <td>description</td> 
   <td>String</td> 
   <td>关于参数的描述，等价于&lt;description&gt;标签，非必填项。</td> 
  </tr> 
 </tbody> 
</table>

## 1.3 SpringBoot中使用Servlet处理请求 ##

**【示例】**创建CharacterServlet类，实现Servlet类返回字符串。

**（1）注册Servlet类**

import javax.servlet.ServletConfig;
    import javax.servlet.ServletException;
    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;
    import java.io.PrintWriter;
    
    /**
     * 输出字符串Servlet类
     * @author pan_junbiao
     */
    @WebServlet(name="CharacterServlet",urlPatterns = "/Servlet/CharacterServlet",
            initParams = { @WebInitParam(name = "userName", value = "pan_junbiao的博客") })
    public class CharacterServlet extends HttpServlet
    {
        // 用户名称
        String userName = null;
    
        // 初始化方法
        @Override
        public void init(ServletConfig servletConfig) throws ServletException
        {
            // 获取初始化参数
            userName = servletConfig.getInitParameter("userName");
        }
    
        @Override
        public void service(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException
        {
    
            String result = String.format("您好，欢迎访问 %s",userName);
    
            //返回结果
            response.setContentType("text/html");
            response.setCharacterEncoding("UTF-8");
            // 获取PrintWriter对象
            PrintWriter out = response.getWriter();
            out.print(result);
            // 释放PrintWriter对象
            out.flush();
            out.close();
        }
    }

**（2）开启Servlet支持**

在SpringBoot的启动入口类上添加@ServletComponentScan注解，以使Servlet生效。

@SpringBootApplication
    @ServletComponentScan
    public class SpringBootHtmlApplication
    {
        public static void main(String[] args)
        {
            SpringApplication.run(SpringBootHtmlApplication.class, args);
        }
    }

**执行结果：**

![20200420112148146.jpg][]

# 2、使用Filter过滤器 #

Filter过滤器与Servlet十分相似，但它具有拦截客户端（浏览器）请求的功能，Filter过滤器可以改变请求中的内容，来满足实际开发中的需要。对于程序开发人员而言，Filter过滤器实质就是在Web应用服务器上的一个Web应用组件，用于拦截客户端（浏览器）与目标资源的请求，并对这些请求进行一定过滤处理再发送给目标资源。

**【示例】**创建CharactorFilter字符编码过滤器，避免中文乱码现象的产生。

**（1）编写过滤器类**

import java.io.IOException;
    import javax.servlet.Filter;
    import javax.servlet.FilterChain;
    import javax.servlet.FilterConfig;
    import javax.servlet.ServletException;
    import javax.servlet.ServletRequest;
    import javax.servlet.ServletResponse;
    import javax.servlet.annotation.WebFilter;
    import javax.servlet.annotation.WebInitParam;
    
    /**
     * 字符编码过滤器
     * @author pan_junbiao
     */
    @WebFilter(filterName = "CharactorFilter", urlPatterns = "/*",
            initParams = { @WebInitParam(name = "encoding", value = "UTF-8") })
    public class CharactorFilter implements Filter
    {
        // 字符编码
        String encoding = null;
    
        // 初始化方法
        @Override
        public void init(FilterConfig filterConfig) throws ServletException
        {
            // 获取初始化参数
            encoding = filterConfig.getInitParameter("encoding");
        }
    
        // 过滤处理方法
        @Override
        public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
                throws IOException, ServletException
        {
            // 判断字符编码是否为空
            if (encoding != null)
            {
                // 设置request的编码格式
                request.setCharacterEncoding(encoding);
                // 设置response字符编码
                response.setContentType("text/html; charset=" + encoding);
            }
            // 传递给下一过滤器
            chain.doFilter(request, response);
        }
    
        // 销毁方法
        @Override
        public void destroy()
        {
            encoding = null;
        }
    }

**（2）在SpringBoot入口类中注册Filter**

要在SpringBoot入口类中注册Filter，只需要添加@ServletComponentScan注解，以使Filter生效。

# 3、使用Listener监听器 #

Listener监听器的作用是监听Web容器的有效期事件，因此它是由容器管理的。利用Listener接口监听在容器中的某个执行程序，并且根据其应用程序的需求做出适当的响应。

**【示例】**创建ServletContext监听器，监听ServletContext对象。

**（1）创建监听器类**

import javax.servlet.ServletContextEvent;
    import javax.servlet.ServletContextListener;
    import javax.servlet.annotation.WebListener;
    
    /**
     * ServletContext监听器
     * @author pan_junbiao
     **/
    @WebListener
    public class ContextListener implements ServletContextListener
    {
        @Override
        public void contextInitialized(ServletContextEvent servletContextEvent)
        {
            System.out.println("ServletContext初始化");
            System.out.println(servletContextEvent.getServletContext().getServerInfo());
        }
    
        @Override
        public void contextDestroyed(ServletContextEvent servletContextEvent)
        {
            System.out.println("ServletConte销毁");
        }
    }

**（2）开启监听器Bean扫描**

在SpringBoot入口类上，添加@ServletComponentScan注解，以使Listener生效。

**执行结果：**

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3Bhbl9qdW5iaWFv_size_16_color_FFFFFF_t_70][]

[20200420112148146.jpg]: /images/20210724/81721b08b99b4544acfa01ff58b93d53.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3Bhbl9qdW5iaWFv_size_16_color_FFFFFF_t_70]: /images/20210724/dfebe83a0ac74a77a8fbf43b1dad4b83.png