top.dcenter.ums.security.social.config.RedisCacheAutoConfig Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ums-social-spring-boot-starter Show documentation
The newest version!
package top.dcenter.ums.security.social.config;

import com.fasterxml.jackson.annotation.JsonAutoDetect;
import com.fasterxml.jackson.annotation.PropertyAccessor;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.SerializationFeature;
import com.fasterxml.jackson.databind.jsontype.impl.LaissezFaireSubTypeValidator;
import org.apache.commons.pool2.impl.GenericObjectPoolConfig;
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
import org.springframework.boot.autoconfigure.data.redis.RedisProperties;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.cache.CacheManager;
import org.springframework.cache.annotation.EnableCaching;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.data.redis.cache.RedisCacheConfiguration;
import org.springframework.data.redis.connection.RedisConfiguration;
import org.springframework.data.redis.connection.RedisConnectionFactory;
import org.springframework.data.redis.connection.RedisStandaloneConfiguration;
import org.springframework.data.redis.connection.lettuce.LettuceClientConfiguration;
import org.springframework.data.redis.connection.lettuce.LettuceConnectionFactory;
import org.springframework.data.redis.connection.lettuce.LettucePoolingClientConfiguration;
import org.springframework.data.redis.serializer.Jackson2JsonRedisSerializer;
import org.springframework.data.redis.serializer.RedisSerializationContext;
import org.springframework.data.redis.serializer.StringRedisSerializer;
import top.dcenter.ums.security.social.properties.RedisCacheProperties;
import top.dcenter.ums.security.social.repository.jdbc.cache.RedisHashCacheManager;
import top.dcenter.ums.security.social.repository.jdbc.key.generator.AddConnectionByProviderIdKeyGenerator;
import top.dcenter.ums.security.social.repository.jdbc.key.generator.RemoveConnectionsByConnectionKeyKeyGenerator;
import top.dcenter.ums.security.social.repository.jdbc.key.generator.RemoveConnectionsByConnectionKeyWithProviderUserIdKeyGenerator;
import top.dcenter.ums.security.social.repository.jdbc.key.generator.RemoveConnectionsByProviderIdKeyGenerator;
import top.dcenter.ums.security.social.repository.jdbc.key.generator.RemoveConnectionsByUserIdAndProviderIdKeyGenerator;
import top.dcenter.ums.security.social.repository.jdbc.key.generator.UpdateConnectionByProviderIdAndProviderUserIdKeyGenerator;
import top.dcenter.ums.security.social.repository.jdbc.key.generator.UpdateConnectionByProviderIdKeyGenerator;
import top.dcenter.ums.security.social.repository.jdbc.key.generator.UserIdKeyGenerator;

import java.time.Duration;
import java.util.HashMap;
import java.util.Map;
import java.util.Set;

/**
 * 简单的实现 Redis cache 自定义配置 {@link CacheManager}, 向 IOC 容器中注入 beanName=socialRedisHashCacheManager 的实例. 


 * 此 redis Cache 对 {@link org.springframework.data.redis.cache.RedisCache} 进行了修改, 把缓存的 KV 格式该成了 Hash 格式.
 * @author zyw
 * @version V1.0  Created by  2020-06-11 22:57
 */
@Configuration
@EnableConfigurationProperties({RedisCacheProperties.class})
@ConditionalOnProperty(prefix = "ums.redis", name = "open", havingValue = "true")
@EnableCaching
public class RedisCacheAutoConfig {

    /**
     * redis cache 解析Key：根据分隔符 "__" 来判断是否是 hash 类型
     */
    public static final String REDIS_CACHE_HASH_KEY_SEPARATE = "__";
    public static final String REDIS_CACHE_KEY_SEPARATE = ":";

    public static final String USER_CONNECTION_CACHE_NAME = "UCC";
    public static final String USER_CONNECTION_HASH_CACHE_NAME = "UCHC";
    public static final String USER_CONNECTION_HASH_ALL_CLEAR_CACHE_NAME = "UCHACC";

    private final RedisCacheProperties redisCacheProperties;
    private final RedisConnectionFactory redisConnectionFactory;
    private final RedisProperties redisProperties;

    public RedisCacheAutoConfig(RedisCacheProperties redisCacheProperties, RedisConnectionFactory redisConnectionFactory, RedisProperties redisProperties) {
        this.redisCacheProperties = redisCacheProperties;
        Set cacheNames = redisCacheProperties.getCache().getCacheNames();
        cacheNames.add(USER_CONNECTION_CACHE_NAME);
        cacheNames.add(USER_CONNECTION_HASH_CACHE_NAME);
        cacheNames.add(USER_CONNECTION_HASH_ALL_CLEAR_CACHE_NAME);
        this.redisConnectionFactory = redisConnectionFactory;
        this.redisProperties = redisProperties;
    }

    /**
     * 配置 Jackson2JsonRedisSerializer 序列化器，在配置 redisTemplate需要用来做k,v的
     * 序列化器
     */
    @SuppressWarnings({"rawtypes", "unchecked"})
    private static Jackson2JsonRedisSerializer getJackson2JsonRedisSerializer(){
        Jackson2JsonRedisSerializer jackson2JsonRedisSerializer;
        jackson2JsonRedisSerializer = new Jackson2JsonRedisSerializer(Object.class);
        ObjectMapper om = new ObjectMapper();
        om.setVisibility(PropertyAccessor.ALL, JsonAutoDetect.Visibility.ANY);
        om.activateDefaultTyping(LaissezFaireSubTypeValidator.instance,
                                 ObjectMapper.DefaultTyping.NON_FINAL);
        om.configure(SerializationFeature.FAIL_ON_EMPTY_BEANS, false);
        jackson2JsonRedisSerializer.setObjectMapper(om);
        return jackson2JsonRedisSerializer;
    }

    @SuppressWarnings({"FieldMayBeFinal", "rawtypes"})
    private static Jackson2JsonRedisSerializer jackson2JsonRedisSerializer =
            getJackson2JsonRedisSerializer();


    /**
     * 自定义 LettuceConnectionFactory
     */
    private LettuceConnectionFactory createLettuceConnectionFactory(
            int dbIndex, String hostName, int port, String password,
            int maxIdle, int minIdle, int maxActive,
            Long maxWait, Long timeOut, Duration shutdownTimeOut){

        //redis配置
        RedisConfiguration redisConfiguration = new
                RedisStandaloneConfiguration(hostName, port);
        ((RedisStandaloneConfiguration) redisConfiguration).setDatabase(dbIndex);
        ((RedisStandaloneConfiguration) redisConfiguration).setPassword(password);

        //连接池配置
        //noinspection rawtypes
        GenericObjectPoolConfig genericObjectPoolConfig = new GenericObjectPoolConfig();
        genericObjectPoolConfig.setMaxIdle(maxIdle);
        genericObjectPoolConfig.setMinIdle(minIdle);
        genericObjectPoolConfig.setMaxTotal(maxActive);
        genericObjectPoolConfig.setMaxWaitMillis(maxWait);
        //redis客户端配置
        LettucePoolingClientConfiguration.LettucePoolingClientConfigurationBuilder
                builder =  LettucePoolingClientConfiguration.builder().
                commandTimeout(Duration.ofMillis(timeOut));

        builder.shutdownTimeout(shutdownTimeOut);
        builder.poolConfig(genericObjectPoolConfig);
        LettuceClientConfiguration lettuceClientConfiguration = builder.build();
        //根据配置和客户端配置创建连接
        LettuceConnectionFactory lettuceConnectionFactory = new
                LettuceConnectionFactory(redisConfiguration,lettuceClientConfiguration);

        lettuceConnectionFactory.afterPropertiesSet();
        return lettuceConnectionFactory;
    }


    /**
     * 缓存管理器, 当 IOC 容器中有 beanName=redisCacheManager 时会替换此实例
     * @return CacheManager
     */
    @Bean("socialRedisHashCacheManager")
    @ConditionalOnMissingBean(name = "socialRedisHashCacheManager")
    public CacheManager redisCacheManager() {
        RedisCacheProperties.Cache cache = redisCacheProperties.getCache();

        // 判断是否使用 spring IOC 容器中的 LettuceConnectionFactory
        // 如果使用 spring IOC 容器中的 LettuceConnectionFactory，则要注意 cache.database-index 要与 spring.redis.database 一样。
        RedisConnectionFactory redisConnectionFactory;
        if (redisCacheProperties.getUseIocRedisConnectionFactory() && this.redisConnectionFactory != null)
        {
            redisConnectionFactory = this.redisConnectionFactory;
        } else
        {
            RedisProperties.Lettuce lettuce = redisProperties.getLettuce();
            RedisProperties.Pool lettucePool = lettuce.getPool();
            redisConnectionFactory = createLettuceConnectionFactory
                    (cache.getDatabaseIndex(),
                     redisProperties.getHost(),
                     redisProperties.getPort(),
                     redisProperties.getPassword(),
                     lettucePool.getMaxIdle(),
                     lettucePool.getMinIdle(),
                     lettucePool.getMaxActive(),
                     lettucePool.getMaxWait().getSeconds(),
                     redisProperties.getTimeout().toMillis(),
                     lettuce.getShutdownTimeout());
        }


        RedisCacheConfiguration defaultCacheConfig = RedisCacheConfiguration.defaultCacheConfig();
        // 设置缓存管理器管理的缓存的默认过期时间
        //noinspection unchecked
        defaultCacheConfig = defaultCacheConfig.entryTtl(cache.getDefaultExpireTime())
                // 设置 key为string序列化
                .serializeKeysWith(RedisSerializationContext.SerializationPair.fromSerializer(new StringRedisSerializer()))
                // 设置value为json序列化
                .serializeValuesWith(RedisSerializationContext.SerializationPair.fromSerializer(jackson2JsonRedisSerializer))
                // 不缓存空值
                .disableCachingNullValues();

        Set cacheNames = cache.getCacheNames();

        // 对每个缓存空间应用不同的配置
        Map configMap = new HashMap<>(cacheNames.size());
        for (String cacheName : cacheNames)
        {
            configMap.put(cacheName,
                          defaultCacheConfig.entryTtl(cache.getEntryTtl()));
        }

        //noinspection UnnecessaryLocalVariable
        RedisHashCacheManager cacheManager = RedisHashCacheManager.builder(redisConnectionFactory)
                .cacheDefaults(defaultCacheConfig)
                .initialCacheNames(cacheNames)
                .withInitialCacheConfigurations(configMap)
                .build();
        return cacheManager;
    }

    @Bean("addConnectionByProviderIdKeyGenerator")
    public AddConnectionByProviderIdKeyGenerator addConnectionByProviderIdKeyGenerator() {
        return new AddConnectionByProviderIdKeyGenerator();
    }
    @Bean("removeConnectionsByConnectionKeyKeyGenerator")
    public RemoveConnectionsByConnectionKeyKeyGenerator removeConnectionsByConnectionKeyKeyGenerator() {
        return new RemoveConnectionsByConnectionKeyKeyGenerator();
    }
    @Bean("removeConnectionsByConnectionKeyWithProviderUserIdKeyGenerator")
    public RemoveConnectionsByConnectionKeyWithProviderUserIdKeyGenerator removeConnectionsByConnectionKeyWithProviderUserIdKeyGenerator() {
        return new RemoveConnectionsByConnectionKeyWithProviderUserIdKeyGenerator();
    }
    @Bean("removeConnectionsByProviderIdKeyGenerator")
    public RemoveConnectionsByProviderIdKeyGenerator removeConnectionsByProviderIdKeyGenerator() {
        return new RemoveConnectionsByProviderIdKeyGenerator();
    }
    @Bean("removeConnectionsByUserIdAndProviderIdKeyGenerator")
    public RemoveConnectionsByUserIdAndProviderIdKeyGenerator removeConnectionsByUserIdAndProviderIdKeyGenerator() {
        return new RemoveConnectionsByUserIdAndProviderIdKeyGenerator();
    }
    @Bean("updateConnectionByProviderIdAndProviderUserIdKeyGenerator")
    public UpdateConnectionByProviderIdAndProviderUserIdKeyGenerator updateConnectionByProviderIdAndProviderUserIdKeyGenerator() {
        return new UpdateConnectionByProviderIdAndProviderUserIdKeyGenerator();
    }
    @Bean("updateConnectionByProviderIdKeyGenerator")
    public UpdateConnectionByProviderIdKeyGenerator updateConnectionByProviderIdKeyGenerator() {
        return new UpdateConnectionByProviderIdKeyGenerator();
    }
    @Bean("userIdKeyGenerator")
    public UserIdKeyGenerator userIdKeyGenerator() {
        return new UserIdKeyGenerator();
    }

}