Java--web.xml中的配置servlet，filter，listener的作用和原理

旧城等待， 2023-10-05 12:30 41阅读 0赞

## 首先介绍servlet，filter和listen的原理： ##

servlet可以说是动态页面的基石，现在很多开发都是基于spring等各种框架，所以对servlet的了解可能少点，下面先用简单的例子，说明下servlet的作用

MyFirstServlet.java

class MyFirstServlet implements Servlet{
     
       //该函数用于初始化servelet就是把该servlet装载到内存中
       //该函数只会被调用一次
       public void init(ServletConfig config) throws ServletException{
     
       }
     
       //得到ServeletConfig对象
       public ServletConfig getServletConfig(){
     
          return null;
       }  
     
       //该函数是服务函数，我们的业务逻辑代码就是写在这里
       //该函数每次都会被调用
       public void service(ServletRequest request, ServletResponse response)
     
                 throws ServletException, IOException{
       }
     
       //g该函数使得到servlet配置信息
       public String getServletInfo(){
          return null;
       }
     
       //销毁该servlet，从内存中清除掉，仅会被调用一次
       public void destroy(){
     
       }
     
    }

web中的配置如下

<servlet>
           
            <servlet-name>MyFirstServlet</servlet-name>
            
            <servlet-class>com.hsm.MyFirstServlet</servlet-class>
        </servlet>
     
       
        <servlet-mapping>
             
            <servlet-name>MyFirstServlet</servlet-name>
            
            <url-pattern>/ABC</url-pattern>
        </servlet-mapping>

访问路径如下

http://localhost/\*\*\*\*\*/ABC

这里的ABC对应上面servlet-mapping中url-pattern的属性，所以最终请求会调用MyFirstServlet的service

Servlet中的过滤器Filter是实现了javax.servlet.Filter接口的服务器端程序，主要的用途是过滤字符编码、做一些业务逻辑判断等。其工作原理是，只要你在web.xml文件配置好要拦截的客户端请求，它都会帮你拦截到请求，此时你就可以对请求或响应(Request、Response)统一设置编码，简化操作；同时还可进行逻辑判断，如用户是否已经登陆、有没有权限访问该页面等等工作。它是随你的web应用启动而启动的，只初始化一次，以后就可以拦截相关请求，只有当你的web应用停止或重新部署的时候才销毁，以下通过过滤编码的代码示例来了解它的使用：

package com.hello.web.listener;
     
    import java.io.IOException;
     
    import javax.servlet.*;
    import javax.servlet.http.HttpServletRequest;
    import javax.servlet.http.HttpServletResponse;
     
    // 主要目的：过滤字符编码；其次，做一些应用逻辑判断等.
    // Filter跟web应用一起启动
    // 当web应用重新启动或销毁时，Filter也被销毁
    public class MyCharsetFilter implements Filter
    {
    	private FilterConfig config = null;
    	
    	public void destroy()
    	{
    		System.out.println("MyCharsetFilter准备销毁...");
    	}
     
    	public void doFilter(ServletRequest arg0, ServletResponse arg1,FilterChain chain) throws IOException, ServletException
    	{
    		// 强制类型转换
    		HttpServletRequest request = (HttpServletRequest) arg0;
    		HttpServletResponse response = (HttpServletResponse) arg1;
    		// 获取web.xm设置的编码集，设置到Request、Response中
    		request.setCharacterEncoding(config.getInitParameter("charset"));
    		response.setContentType(config.getInitParameter("contentType"));
    		response.setCharacterEncoding(config.getInitParameter("charset"));
    		// 将请求转发到目的地
    		chain.doFilter(request, response);
    	}
     
    	public void init(FilterConfig arg0) throws ServletException
    	{
    		this.config = arg0;
    		System.out.println("MyCharsetFilter初始化...");
    	}
    }

以下是 MyCharsetFilter.java 在web.xml 中配置:

<filter>
          <filter-name>filter</filter-name>
          <filter-class>dc.gz.filters.MyCharsetFilter</filter-class>
          <init-param>
              <param-name>charset</param-name>
              <param-value>UTF-8</param-value>
          </init-param>
          <init-param>
              <param-name>contentType</param-name>
              <param-value>text/html;charset=UTF-8</param-value>
          </init-param>
      </filter>
      <filter-mapping>
          <filter-name>filter</filter-name>
          
          <url-pattern>/*</url-pattern>
      </filter-mapping>

以上的例子简单的说明了Filter的使用，具体其他的应用可以看具体的场景。

现在来说说Servlet的监听器Listener，它是实现了javax.servlet.ServletContextListener 接口的服务器端程序，它也是随web应用的启动而启动，**只初始化一次**，随web应用的停止而销毁。**主要作用是： 做一些初始化的内容添加工作、设置一些基本的内容、比如一些参数或者是一些固定的对象等等。**下面利用监听器对数据库连接池DataSource的初始化演示它的使用：

MyServletContextListener.java
    package dc.gz.listeners;
    import javax.servlet.ServletContext;
    import javax.servlet.ServletContextEvent;
    import javax.servlet.ServletContextListener;
    import org.apache.commons.dbcp.BasicDataSource;
     
    /**
     * Web应用监听器
     */
    public class MyServletContextListener implements ServletContextListener {
     
        // 应用监听器的销毁方法
        public void contextDestroyed(ServletContextEvent event) {
            ServletContext sc = event.getServletContext();
            // 在整个web应用销毁之前调用，将所有应用空间所设置的内容清空
            sc.removeAttribute("dataSource");
            System.out.println("销毁工作完成...");
        }
     
        // 应用监听器的初始化方法
        public void contextInitialized(ServletContextEvent event) {
            // 通过这个事件可以获取整个应用的空间
            // 在整个web应用下面启动的时候做一些初始化的内容添加工作
            ServletContext sc = event.getServletContext();
            // 设置一些基本的内容；比如一些参数或者是一些固定的对象
            // 创建DataSource对象，连接池技术 dbcp
            BasicDataSource bds = new BasicDataSource();
            bds.setDriverClassName("com.mysql.jdbc.Driver");
            bds.setUrl("jdbc:mysql://localhost:3306/hibernate");
            bds.setUsername("root");
            bds.setPassword("root");
            bds.setMaxActive(10);//最大连接数
            bds.setMaxIdle(5);//最大管理数
            //bds.setMaxWait(maxWait); 最大等待时间
            // 把 DataSource 放入ServletContext空间中，
            // 供整个web应用的使用(获取数据库连接)
            sc.setAttribute("dataSource", bds);
            System.out.println("应用监听器初始化工作完成...");
            System.out.println("已经创建DataSource...");
        }
    }

web.xml中配置如下，很简单：

<listener>
    	<listener-class>dc.gz.listeners.MyServletContextListener</listener-class>
    </listener>

通过如下方式可以获取datasource

WebApplicationContext webApplicationContext = ContextLoader.getCurrentWebApplicationContext();
    ServletContext servletContext = webApplicationContext.getServletContext();
    servletContext.getAttribute("dataSource");

WebApplicationContext webApplicationContext = ContextLoader.getCurrentWebApplicationContext();
    ServletContext servletContext = webApplicationContext.getServletContext();

有了上面的铺垫，更容易理解spring中web.xml所包含的配置和作用

<?xml version="1.0" encoding="UTF-8"?>  
    <web-app version="3.0" xmlns="http://java.sun.com/xml/ns/javaee"  
             xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"  
             xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd">  
     
          
        <filter>  
            <filter-name>characterEncodingFilter</filter-name>  
            <filter-class>org.springframework.web.filter.CharacterEncodingFilter</filter-class>  
            <init-param>  
                <param-name>encoding</param-name>  
                <param-value>UTF-8</param-value>  
            </init-param>  
            <init-param>  
                <param-name>forceEncoding</param-name>  
                <param-value>true</param-value>  
            </init-param>  
        </filter>  
        <filter-mapping>  
            <filter-name>characterEncodingFilter</filter-name>  
            <url-pattern>/*</url-pattern>  
        </filter-mapping>  
          
          
          
        <listener>  
            <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>  
        </listener>  
          
          
        <context-param>  
            <param-name>contextConfigLocation</param-name>  
            <param-value>classpath:spring/applicationContext.xml</param-value>  
        </context-param>  
          
          
          
        <servlet-mapping>  
            <servlet-name>default</servlet-name>  
            <url-pattern>*.css</url-pattern>  
        </servlet-mapping>  
        <servlet-mapping>  
            <servlet-name>default</servlet-name>  
            <url-pattern>*.swf</url-pattern>  
        </servlet-mapping>  
        <servlet-mapping>  
            <servlet-name>default</servlet-name>  
            <url-pattern>*.gif</url-pattern>  
        </servlet-mapping>  
        <servlet-mapping>  
            <servlet-name>default</servlet-name>  
            <url-pattern>*.jpg</url-pattern>  
        </servlet-mapping>  
        <servlet-mapping>  
            <servlet-name>default</servlet-name>  
            <url-pattern>*.png</url-pattern>  
        </servlet-mapping>  
        <servlet-mapping>  
            <servlet-name>default</servlet-name>  
            <url-pattern>*.js</url-pattern>  
        </servlet-mapping>  
        <servlet-mapping>  
            <servlet-name>default</servlet-name>  
            <url-pattern>*.html</url-pattern>  
        </servlet-mapping>  
        <servlet-mapping>  
            <servlet-name>default</servlet-name>  
            <url-pattern>*.xml</url-pattern>  
        </servlet-mapping>  
        <servlet-mapping>  
            <servlet-name>default</servlet-name>  
            <url-pattern>*.json</url-pattern>  
        </servlet-mapping>  
        <servlet-mapping>  
            <servlet-name>default</servlet-name>  
            <url-pattern>*.map</url-pattern>  
        </servlet-mapping>  
          
          
        <servlet>  
            <servlet-name>DispatcherServlet</servlet-name>  
            <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>  
              
            <init-param>  
                <param-name>contextConfigLocation</param-name>  
                  
                  
                  
                  
                  
                <param-value>classpath:spring/dispatcher-servlet.xml</param-value>  
            </init-param>  
            <load-on-startup>1</load-on-startup>  
        </servlet>  
        <servlet-mapping>  
              
              
            <servlet-name>DispatcherServlet</servlet-name>  
              
              
              
            <url-pattern>/</url-pattern>   
        </servlet-mapping>  
        <welcome-file-list>  
            <welcome-file>login.html</welcome-file>  
        </welcome-file-list>  
        <error-page>   
            <error-code>404</error-code>  
            <location>/nopage.html</location>  
        </error-page>  
        <error-page>   
            <exception-type>java.lang.NullPointerException</exception-type>  
            <location>/error.html</location>  
        </error-page>  
        <session-config>  
            <session-timeout>360</session-timeout>  
        </session-config>  
    </web-app>

借鉴：

[https://www.cnblogs.com/wkrbky/p/5929943.html][https_www.cnblogs.com_wkrbky_p_5929943.html]

[https://blog.csdn.net/pg\_guo/article/details/9118633][https_blog.csdn.net_pg_guo_article_details_9118633]

[https_www.cnblogs.com_wkrbky_p_5929943.html]: https://www.cnblogs.com/wkrbky/p/5929943.html
[https_blog.csdn.net_pg_guo_article_details_9118633]: https://blog.csdn.net/pg_guo/article/details/9118633