web.xml 中以编码方式添加filter并设置初始化参数AbstractAnnotationConfigDispatchServletInitializer

时间：2023-03-08 23:39:57
web.xml 中以编码方式添加filter并设置初始化参数AbstractAnnotationConfigDispatchServletInitializer

web.xml中配置filter

<?xml version="1.0" encoding="UTF-8"?>

<web-app version="2.5"

    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_2_5.xsd">

  <display-name></display-name> 

  <filter>

    <filter-name>testFilter</filter-name>

    <filter-class>com.bolin.core.TestFilter.java</filter-class>

    <init-param>

        <param-name>specialUrl</param-name>

        <param-value>

            /login,/register

        </param-value>

    </init-param>

  </filter>

  <filter-mapping>

    <filter-name>testFilter</filter-name>

    <url-pattern>*.*</url-pattern>

  </filter-mapping>

  <welcome-file-list>

    <welcome-file>index.jsp</welcome-file>

  </welcome-file-list>

</web-app>

假如有以下场景： 
testFilet的初始化参数specialUrl在开发环境，测试环境和生产环境中有所区别，那么在系统提交测试，或者上线前必须要先修改web.xml，这样的话就会比较繁琐，给系统升级或测试增加额外开销。

这样就出现一个需求，希望能在系统启动时读取不同环境的配置信息来初始化web.xml，这个配置信息可以是库中的数据，或者固定的配置文件，最好这些配置信息能够一劳永逸，兼容开发环境，测试环境，生产环境，那以后就省事了。有一个开关去控制是什么环境，那就读取相应环境的配置数据。

编码实现web.xml配置filter

那在这样的需求下，web.xml就需要以编码的方式来实现配置。spring4.0以上的版本支持web.xml的编码配置。实现AbstractAnnotationConfigDispatcherServletInitializer接口,在servlet3.0中web.xml启动时会检测该接口实现类，从能够在实现类中去配置filter。

package com.bolin.core;

import java.io.IOException;

import java.util.EnumSet;

import java.util.Iterator;

import java.util.Properties;

import javax.servlet.DispatcherType;

import javax.servlet.Filter;

import javax.servlet.FilterRegistration;

import javax.servlet.FilterRegistration.Dynamic;

import javax.servlet.ServletContext;

import javax.servlet.ServletException;

import org.apache.commons.lang.StringUtils;

import org.springframework.core.io.ClassPathResource;

import org.springframework.web.servlet.support.AbstractAnnotationConfigDispatcherServletInitializer;

public class WebAppInitializer extends AbstractAnnotationConfigDispatcherServletInitializer{

    @Override

    protected Class<?>[] getRootConfigClasses() {

        return null;

    }

    @Override

    protected Class<?>[] getServletConfigClasses() {

        return null;

    }

    @Override

    protected String[] getServletMappings() {

        return null;

    }

    @Override

    public void onStartup(ServletContext servletContext)

            throws ServletException {

        // 系统启动时注册filter

        FilterRegistration testFilter = servletContext.addFilter("testFilter", TestFilter.class);

        // 设置init param, param可以从properties文件中读取或其他方式获取，提供一个想法

        testFilter.setInitParameter("specialUrl", "/login,/register");

        testFilter.addMappingForUrlPatterns(EnumSet.allOf(DispatcherType.class) , true, "*.*");

        super.onStartup(servletContext);

    }

    @Override

    protected Dynamic registerServletFilter(ServletContext arg0, Filter filter) {

        return super.registerServletFilter(arg0, filter);

    }

}

推荐一篇相同类型的博客：xml零配置之AbstractAnnotationConfigDispatcherServletInitializer

需要注意的是以上的实现，依赖servlet-api-3.0.jar和spring-webmvc-4.0以上版本jar包。

相关文章