Spring-Session源码研究之Start_Servlet3.0

这一部分讲解下Spring-Session在Servlet3.0标准下的配置.

姊妹篇《Spring-Session源码研究之Start》

在经过Servlet3.0研究之ServletContainerInitializer接口的讲解之后, 我们可以猜测spring-session是可以通过实现WebApplicationInitializer来完成功能.

1. 配置

1.1 RedisHttpSessionConfig类

// 关于这个注解, 直接看Java Doc
// 多说一句的是, spring中一般命名为Enablexxxx的注解, 其定义上一般都被会@Import所修饰.
@EnableRedisHttpSession(maxInactiveIntervalInSeconds = 7200)  
public class RedisHttpSessionConfig {  

    // 向Spring容器中注册一个RedisConnectionFactory
    @Bean  
    public RedisConnectionFactory connectionFactory() {  
        JedisConnectionFactory connectionFactory = new JedisConnectionFactory();  
        connectionFactory.setPort(6379);  
        connectionFactory.setHostName("10.18.15.190");  
        return connectionFactory;  
    }  
}

1.2 WebInitializer类

// 1. 基类AbstractAnnotationConfigDispatcherServletInitializer最终实现了WebApplicationInitializer接口
public class WebInitializer extends AbstractAnnotationConfigDispatcherServletInitializer {  

    @Override  
    protected Class<?>[] getRootConfigClasses() {  
    // 这里如果返回一个/多个配置类, 那么你在web.xml中配置的类型为ContextLoaderListener的<listener/>和<context-param>中的spring.xml就失效了
        return new Class[]{RedisHttpSessionConfig.class};  
    }  

    //......  
}  

1. 如果决定启用WebInitializer类, 那么spring.xml文件就失效了(不把话说太死, 也暂时不作更深入的研究——例如自定义一个ApplicationContext实现类去既解析注解又解析xml文件)
2. 而如果不启用WebInitializer类, 就无法获得注解@EnableRedisHttpSession的好处.

1.3 SpringSessionInitializer类

// AbstractHttpSessionApplicationInitializer(实现了WebApplicationInitializer接口)是由Spring-Session提供的一个抽象类, 所以我们需要继承自它,并将子类注入到容器中. 以便被servlet3.0的机制之下被加载
public class SpringSessionInitializer extends AbstractHttpSessionApplicationInitializer {  
    // 不需要重载或实现任何方法, 
    // 就是为了让支持Servlet3.0的容器能执行基类AbstractHttpSessionApplicationInitializer的代码, 因为就功能而言,Spring-session自身的实现足够了
    // 这样也合理, AbstractHttpSessionApplicationInitializer如果是个实体类, 那引入spring-session.jar就默认启用session共享. 

    // 根据配置信息来自定义决定是否载入这个Filter,也就是自主决定是否启用spring-session.
        String isSingleUserLogin = (String) PropertiesUtil.getProperty("login.singleUserLogin");
        if (!("true".equalsIgnoreCase(isSingleUserLogin))) {
            return;
        }

        super.onStartup(servletContext);    
}  

1. WebApplicationInitializer接口的实现类最终会被SpringServletContainerInitializer所回调. 因为SpringServletContainerInitializer会在对servlet3.0的ServletContainerInitializer接口的实现中回调所有的WebApplicationInitializer实现类(也就是说只要编写了上面的SpringSessionInitializer类和WebInitializer`类).
2. 其他的工作就交给Spring和Servlet容器了.

2. AbstractHttpSessionApplicationInitializer 类

然后我们观察该类对onStartup(ServletContext servletContext)方法的实现, 这里我还是给出源码的细节, 大家可以感受下Spring源码的魅力.(相信看过《Clean Code》的读者对这段代码一定非常熟悉)

public void onStartup(ServletContext servletContext) throws ServletException {
    // 核心逻辑之前的操作
    // 没有任何实现细节, 交给子类实现自定义逻辑
    beforeSessionRepositoryFilter(servletContext);

    // 注意这里的configurationClasses要是不为空, 那你在web.xml里配置的spring.xml和ContextLoaderListener就失效了
    // 这里就是对应上面的WebInitializer类中的getRootConfigClasses()方法的返回值
    if (this.configurationClasses != null) {
        // 看看这个类名就明白为啥提供配置类, 配置文件就失效了
        AnnotationConfigWebApplicationContext rootAppContext = new AnnotationConfigWebApplicationContext();
        rootAppContext.register(this.configurationClasses);
        servletContext.addListener(new ContextLoaderListener(rootAppContext));
    }

    // 下面这段逻辑则是web.xml中的配置Filter的模拟
    insertSessionRepositoryFilter(servletContext);
    // 核心逻辑之后的操作
    // 依然没有任何实现细节, 交给子类实现自定义逻辑
    afterSessionRepositoryFilter(servletContext);
}

private void insertSessionRepositoryFilter(ServletContext servletContext) {
    // 这个springSessionRepositoryFilter 是不是很熟悉, 由SpringHttpSessionConfiguration类强制指定, 而这里则是呼应
    // DEFAULT_FILTER_NAME = "springSessionRepositoryFilter"
    String filterName = DEFAULT_FILTER_NAME;
    DelegatingFilterProxy springSessionRepositoryFilter = new DelegatingFilterProxy(
            filterName);
    String contextAttribute = getWebApplicationContextAttribute();
    if (contextAttribute != null) {
        springSessionRepositoryFilter.setContextAttribute(contextAttribute);
    }
    registerFilter(servletContext, true, filterName, springSessionRepositoryFilter);
}

private void registerFilter(ServletContext servletContext,
        boolean insertBeforeOtherFilters, String filterName, Filter filter) {
    Dynamic registration = servletContext.addFilter(filterName, filter);
    if (registration == null) {
        throw new IllegalStateException(
                "Duplicate Filter registration for '" + filterName
                        + "'. Check to ensure the Filter is only configured once.");
    }
    registration.setAsyncSupported(isAsyncSessionSupported());
    EnumSet<DispatcherType> dispatcherTypes = getSessionDispatcherTypes();
    // 相信看到这个, 大家就应该非常熟悉了, 尤其是那个"/*"            
    registration.addMappingForUrlPatterns(dispatcherTypes, !insertBeforeOtherFilters,
            "/*");
}

3. Links

1. http://blog.csdn.net/patrickyoung6625/article/details/45694157
2. http://blog.csdn.net/szwandcj/article/details/50225979