6. Spring Session 源码分析-配置初始化

快来打我* 2022-02-18 16:58 350阅读 0赞

Spring Session 官方文档的描述是非常简单的, 很多东西讲的并不是很清楚, 也可能是因为Spring 官方觉得Spring session太简单, 没什么值得多介绍吧. 目前网上关于Spring session的教程并没有太多, 所以笔者决定尝试从源码角度对spring session 的核心步骤做一下简单的分析.

## 1. Spring Session 配置初始化分析 ##

### 1.1 @EnableRedisHttpSession 分析 ###

SpringBoot 整合大部分框架都是通过@Enablexxx作为框架的入口的, 因此笔者也尝试从@EnableRedisHttpSession 配置类开始分析:

*  @EnableRedisHttpSession 注解定义时, 使用@Configuration 修饰, 说明是@EnableRedisHttpSession修饰的类, 会被Spring 当做配置类进行解析
 *  @EnableRedisHttpSession 中使用@Import 注解导入了RedisHttpSessionConfiguration, 那么在应用启动时会向spring 容器中注入RedisHttpSessionConfiguration 实例

@Retention(RetentionPolicy.RUNTIME)
    @Target(ElementType.TYPE)
    @Documented
    @Import(RedisHttpSessionConfiguration.class)
    @Configuration
    public @interface EnableRedisHttpSession { 
    
    	int maxInactiveIntervalInSeconds() default MapSession.DEFAULT_MAX_INACTIVE_INTERVAL_SECONDS;
    
    	String redisNamespace() default RedisOperationsSessionRepository.DEFAULT_NAMESPACE;
    
    	RedisFlushMode redisFlushMode() default RedisFlushMode.ON_SAVE;
    
    	String cleanupCron() default RedisHttpSessionConfiguration.DEFAULT_CLEANUP_CRON;
    
    }

### 1.2 RedisHttpSessionConfiguration 分析 ###

*  RedisHttpSessionConfiguration 本身是一个Spring 配置类, 会向spring 容器注册sessionRepository, redisMessageListenerContainer 等实例
 *  RedisHttpSessionConfiguration 会注册Redis 消息监听器容器RedisMessageListenerContainer, 并将RedisOperationsSessionRepository 作为Redis 消息订阅的监听器, 因为它实现了MessageListener接口. 当Redis 中key 过期或销毁时, 会通知将RedisOperationsSessionRepository 调用其onMessage 方法来处理消息.
 *  RedisHttpSessionConfiguration 继承了RedisHttpSessionConfiguration, 所以会继承RedisHttpSessionConfiguration中的公有方法

@Configuration
    @EnableScheduling
    public class RedisHttpSessionConfiguration extends SpringHttpSessionConfiguration
    		implements BeanClassLoaderAware, EmbeddedValueResolverAware, ImportAware,
    		SchedulingConfigurer { 
    	
    	// 省略部分代码.... 
    		
    	// 初始化Spring session 配置信息, 即解析@EnableRedisHttpSession 注解的参数配置信息
    	@Override
    	public void setImportMetadata(AnnotationMetadata importMetadata) { 
    		Map<String, Object> attributeMap = importMetadata
    				.getAnnotationAttributes(EnableRedisHttpSession.class.getName());
    		AnnotationAttributes attributes = AnnotationAttributes.fromMap(attributeMap);
    		this.maxInactiveIntervalInSeconds = attributes
    				.getNumber("maxInactiveIntervalInSeconds");
    		String redisNamespaceValue = attributes.getString("redisNamespace");
    		if (StringUtils.hasText(redisNamespaceValue)) { 
    			this.redisNamespace = this.embeddedValueResolver
    					.resolveStringValue(redisNamespaceValue);
    		}
    		this.redisFlushMode = attributes.getEnum("redisFlushMode");
    		String cleanupCron = attributes.getString("cleanupCron");
    		if (StringUtils.hasText(cleanupCron)) { 
    			this.cleanupCron = cleanupCron;
    		}
    	}	
    		
    	// 利用Redis 发布订阅机制, 订阅消息的 
    	@Bean
    	public RedisMessageListenerContainer redisMessageListenerContainer() { 
    		RedisMessageListenerContainer container = new RedisMessageListenerContainer();
    		container.setConnectionFactory(this.redisConnectionFactory);
    		if (this.redisTaskExecutor != null) { 
    			container.setTaskExecutor(this.redisTaskExecutor);
    		}
    		if (this.redisSubscriptionExecutor != null) { 
    			container.setSubscriptionExecutor(this.redisSubscriptionExecutor);
    		}
    		// 订阅监听消息销毁/过期
    		container.addMessageListener(sessionRepository(), Arrays.asList(
    				new ChannelTopic(sessionRepository().getSessionDeletedChannel()),
    				new ChannelTopic(sessionRepository().getSessionExpiredChannel())));
    		// 订阅消息创建
    		container.addMessageListener(sessionRepository(),
    				Collections.singletonList(new PatternTopic(
    						sessionRepository().getSessionCreatedChannelPrefix() + "*")));
    		return container;
    	}
    		
    }

### 1.3 RedisHttpSessionConfiguration 分析 ###

*  SpringHttpSessionConfiguration 会将自定义的所有SessionListener 封装为一个SessionEventHttpSessionListenerAdapter
 *  SpringHttpSessionConfiguration 会初始化一个最核心的组件SessionRepositoryFilter, 该过滤器会拦截所有的http 请求, 解析并处理session.

@Configuration
    public class SpringHttpSessionConfiguration implements ApplicationContextAware { 
    
        // 省略部分代码
    
        // 注册SessionListener
        @Bean
    	public SessionEventHttpSessionListenerAdapter sessionEventHttpSessionListenerAdapter() { 
    		return new SessionEventHttpSessionListenerAdapter(this.httpSessionListeners);
    	}
    
        // 向spring 容器注入核心的过滤器
        @Bean
        public <S extends Session> SessionRepositoryFilter<? extends Session> springSessionRepositoryFilter(
        		SessionRepository<S> sessionRepository) { 
        	SessionRepositoryFilter<S> sessionRepositoryFilter = new SessionRepositoryFilter<>(
        			sessionRepository);
        	sessionRepositoryFilter.setServletContext(this.servletContext);
        	sessionRepositoryFilter.setHttpSessionIdResolver(this.httpSessionIdResolver);
        	return sessionRepositoryFilter;
        }
    }