redistemplate 泛型 redistemplate multi

转载

代码匠人之心 2023-09-09 16:47:44

文章标签 redistemplate 泛型 redis spring boot 缓存 spring 文章分类 Redis 数据库

背景：我们都知道比较新版本的Redis有64个数据库可以使用，在项目中需要用到redis的多个库，每次使用时再去通过一堆代码切换未免觉得太过麻烦，所以直接通过配置注入多个RedisTemplate，需要用到哪个库时直接使用对应的RedisTemplate即可。

第一步：配置文件：

在application.properties中添加redis的相关配置

#redis多数据配置
redis.database.db1=1
redis.database.db2=2
redis.host=127.0.0.1
redis.port=6379
redis.password=root
##连接超时，此处使用单位秒
redis.timeout=180
##连接池配置
redis.pool.max-active=8
redis.pool.max-idle=8
redis.pool.min-idle=0
redis.pool.max-wait=-1


#redis的多实例相关配置
redis:
  host: 172.25.240.207
  port: 6579
  password:
  timeout: 3000
  database:
    db1: 4
    db2: 20
  pool:
    max-wait: -1
    max-idle: 10
    min-idle: 0
    max-active: 10

数据库的选择可根据业务需求配置多个，此处测试只配置了两个。
连接池的配置都是使用的默认值，如有其他需求可自行更改

第二部：通过配置类注入RedisTemplate

package com.hisense.scs.config;

import com.fasterxml.jackson.annotation.JsonAutoDetect;
import com.fasterxml.jackson.annotation.PropertyAccessor;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.commons.pool2.impl.GenericObjectPoolConfig;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Primary;
import org.springframework.data.redis.connection.RedisPassword;
import org.springframework.data.redis.connection.RedisStandaloneConfiguration;
import org.springframework.data.redis.connection.lettuce.LettuceConnectionFactory;
import org.springframework.data.redis.connection.lettuce.LettucePoolingClientConfiguration;
import org.springframework.data.redis.core.RedisTemplate;
import org.springframework.data.redis.core.StringRedisTemplate;
import org.springframework.data.redis.serializer.Jackson2JsonRedisSerializer;
import org.springframework.data.redis.serializer.StringRedisSerializer;

import java.time.Duration;

/**
 * @date 2020/1/21
 * redis配置redistemplate多实例操作多个数据库
 *
 */
@Configuration
public class RedisConfiguration {

    @Value("${redis.database.db1}")
    private int test1Database;

    @Value("${redis.database.db2}")
    private int test2Database;

    @Value("${redis.host}")
    private String host;

    @Value("${redis.port}")
    private int port;

    @Value("${redis.password}")
    private String password;

    @Value("${redis.timeout}")
    private int timeout;

    @Value("${redis.pool.max-active}")
    private int maxActive;

    @Value("${redis.pool.max-idle}")
    private int maxIdle;

    @Value("${redis.pool.min-idle}")
    private int minIdle;

    @Value("${redis.pool.max-wait}")
    private int maxWait;

    @Bean
    public GenericObjectPoolConfig getPoolConfig(){
        // 配置redis连接池
        GenericObjectPoolConfig poolConfig = new GenericObjectPoolConfig();
        poolConfig.setMaxTotal(maxActive);
        poolConfig.setMaxIdle(maxIdle);
        poolConfig.setMinIdle(minIdle);
        poolConfig.setMaxWaitMillis(maxWait);
        return poolConfig;
    }

    @Primary
    @Bean(name = "db1RedisTemplate")
    public  RedisTemplate<String, Object> getTest1RedisTemplate(){

        // 构建工厂对象
        RedisTemplate<String, Object> template = getStringRedisTemplate(test1Database);
        // 自定义 String Object
//        RedisTemplate<String, Object> template = new RedisTemplate();
//        template.setConnectionFactory(redisConnectionFactory);

        // Json 序列化配置
        Jackson2JsonRedisSerializer<Object> objectJackson2JsonRedisSerializer = new Jackson2JsonRedisSerializer<Object>(Object.class);
        // ObjectMapper 转译
        ObjectMapper objectMapper = new ObjectMapper();
        objectMapper.setVisibility(PropertyAccessor.ALL, JsonAutoDetect.Visibility.ANY);
        objectMapper.enableDefaultTyping(ObjectMapper.DefaultTyping.NON_FINAL);
        objectJackson2JsonRedisSerializer.setObjectMapper(objectMapper);

        // String 的序列化
        StringRedisSerializer stringRedisSerializer = new StringRedisSerializer();

        // key 采用String的序列化方式
        template.setKeySerializer(stringRedisSerializer);
        // hash 的key也采用 String 的序列化方式
        template.setHashKeySerializer(stringRedisSerializer);
        // value 序列化方式采用 jackson
        template.setValueSerializer(objectJackson2JsonRedisSerializer);
        // hash 的 value 采用 jackson
        template.setHashValueSerializer(objectJackson2JsonRedisSerializer);
        template.afterPropertiesSet();

        return template;


    }

    @Bean(name = "db2RedisTemplate")
    public  RedisTemplate<String, Object> getTest2RedisTemplate(){

        // 构建工厂对象
        RedisTemplate<String, Object> template = getStringRedisTemplate(test2Database);
        // 自定义 String Object
//        RedisTemplate<String, Object> template = new RedisTemplate();
//        template.setConnectionFactory(redisConnectionFactory);

        // Json 序列化配置
        Jackson2JsonRedisSerializer<Object> objectJackson2JsonRedisSerializer = new Jackson2JsonRedisSerializer<Object>(Object.class);
        // ObjectMapper 转译
        ObjectMapper objectMapper = new ObjectMapper();
        objectMapper.setVisibility(PropertyAccessor.ALL, JsonAutoDetect.Visibility.ANY);
        objectMapper.enableDefaultTyping(ObjectMapper.DefaultTyping.NON_FINAL);
        objectJackson2JsonRedisSerializer.setObjectMapper(objectMapper);

        // String 的序列化
        StringRedisSerializer stringRedisSerializer = new StringRedisSerializer();

        // key 采用String的序列化方式
        template.setKeySerializer(stringRedisSerializer);
        // hash 的key也采用 String 的序列化方式
        template.setHashKeySerializer(stringRedisSerializer);
        // value 序列化方式采用 jackson
        template.setValueSerializer(objectJackson2JsonRedisSerializer);
        // hash 的 value 采用 jackson
        template.setHashValueSerializer(objectJackson2JsonRedisSerializer);
        template.afterPropertiesSet();

        return template;


    }

    private  RedisTemplate<String, Object> getStringRedisTemplate(int database) {
        RedisTemplate<String, Object> template = new RedisTemplate();
        // 构建工厂对象
        RedisStandaloneConfiguration configuration = new RedisStandaloneConfiguration();
        configuration.setHostName(host);
        configuration.setPort(port);
        configuration.setPassword(RedisPassword.of(password));
        LettucePoolingClientConfiguration clientConfiguration = LettucePoolingClientConfiguration.builder()
                .commandTimeout(Duration.ofSeconds(timeout)).poolConfig(getPoolConfig()).build();
        LettuceConnectionFactory factory = new LettuceConnectionFactory(configuration, clientConfiguration);
        // 设置使用的redis数据库
        factory.setDatabase(database);


        // 重新初始化工厂
        factory.afterPropertiesSet();
        template.setConnectionFactory(factory);
        return template;
    }

}

解释几个地方：
SpringBoot 2.x 之后连接redis驱动默认使用的是lettuce，而非之前的jedis，

这里简要说一下两个驱动的区别：
jedis采用的是直连redis server，在多个线程之间共用一个jedis实例时，是线程不安全的。如果想避免线程不安全，可以使用连接池pool，这样每个线程单独使用一个jedis实例。由此带来的问题是，如果线程数过多，带来redis server的负载加大。有点类似于BIO的模式。
lettuce采用netty连接redis server，实例可以在多个线程间共享，不存在线程不安全的情况，这样可以减少线程数量。在特殊情况下，lettuce也可以使用多个实例。有点类似于NIO的模式
翻看源码lettuce驱动的连接池是依赖于apache的commons-pool2中的GenericObjectPoolConfig对象实现的，而SpringBoot对Redis的Starter中未引入该依赖

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-data-redis</artifactId>
</dependency>

所以如果要配置连接池并且项目中未通过其他组件引入commons-pool2依赖时需要手动引入该依赖

<dependency>
    <groupId>org.apache.commons</groupId>
    <artifactId>commons-pool2</artifactId>
    <version>2.8.0</version>
</dependency>

第三部：测试环节

直接使用SpringBoot的Junit测试，分别使用两个RedisTemplate操作Redis

@SpringBootTest
class RedisdemoApplicationTests {

    @Resource(name = "test1RedisTemplate")
    private StringRedisTemplate test1RedisTemplate;

    @Resource(name = "test2RedisTemplate")
    private StringRedisTemplate test2RedisTemplate;

    @Test
    public void testRedisTemplate() {
        // 测试用两个模板向redis中存值
        test1RedisTemplate.opsForValue().set("name", "kong");
        test2RedisTemplate.opsForValue().set("age", "20");
    }

}

查看Redis库看是否操作成功