Springboot+redis 整合

运行环境：

JDK1.7.

SpringBoot1.4.7

redis3.0.4

1.生成Springboot项目，分别添加web，redis依赖，具体的maven依赖如下

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

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>

数据源

使用spring的默认配置

在 src/main/resources/application.properties 中配置数据源信息。

server.context-path=/redis
server.port=9099

# REDIS (RedisProperties)
# Redis数据库索引（默认为0）
spring.redis.database=0
# Redis服务器地址
spring.redis.host=192.168.0.106
# Redis服务器连接端口
spring.redis.port=6379
# Redis服务器连接密码（默认为空）
#Sspring.redis.password=
# 连接池最大连接数（使用负值表示没有限制）
spring.redis.pool.max-active=8
# 连接池最大阻塞等待时间（使用负值表示没有限制）
spring.redis.pool.max-wait=-1
# 连接池中的最大空闲连接
spring.redis.pool.max-idle=8
# 连接池中的最小空闲连接
spring.redis.pool.min-idle=0
# 连接超时时间（毫秒）
spring.redis.timeout=10

然后我们需要一个配置类，将配置文件与对象进行关联

新建一个RedisConfig类

@Configuration
@EnableAutoConfiguration
public class RedisConfig extends CachingConfigurerSupport {}

通过

@ConfigurationProperties

注解，将属性文件注入进来

@Bean
    @ConfigurationProperties(prefix = "spring.redis")
    public JedisPoolConfig getRedisConfig() {
        JedisPoolConfig config = new JedisPoolConfig();
        //System.out.println(config.getMaxWaitMillis());
        return config;
    }

这里需要注意的是，我们的属性文件并没有全部的注入进来，这里只是配置连接池的属性

我们还需要将redis的host,port等信息也注入进来

@Autowired
    private Environment env;

@Bean
    @ConfigurationProperties(prefix = "spring.redis")
    public JedisConnectionFactory getConnectionFactory() {
        JedisConnectionFactory factory = new JedisConnectionFactory();
        JedisPoolConfig config = getRedisConfig();
        factory.setPoolConfig(config);
        factory.setHostName(env.getProperty("spring.redis.host"));
        factory.setPort(Integer.parseInt(env.getProperty("spring.redis.port").trim()));
        factory.setDatabase(Integer.parseInt(env.getProperty("spring.redis.database").trim()));
        logger.info("JedisConnectionFactory bean init success.");
        return factory;
    }

这样我们的属性信息就都配置好了

我们就要开始连接redis服务器，实现我们的业务了，这里我们先介绍下 RedisTemplate

spring 封装了 RedisTemplate 对象来进行对redis的各种操作，它支持所有的 redis 原生的 api。

RedisTemplate中定义了对5种数据结构操作

redisTemplate.opsForValue();//操作字符串
redisTemplate.opsForHash();//操作hash
redisTemplate.opsForList();//操作list
redisTemplate.opsForSet();//操作set
redisTemplate.opsForZSet();//操作有序set

StringRedisTemplate与RedisTemplate

• 两者的关系是StringRedisTemplate继承RedisTemplate。

• 两者的数据是不共通的；也就是说StringRedisTemplate只能管理StringRedisTemplate里面的数据，RedisTemplate只能管理RedisTemplate中的数据。

• SDR默认采用的序列化策略有两种，一种是String的序列化策略，一种是JDK的序列化策略。

  StringRedisTemplate默认采用的是String的序列化策略，保存的key和value都是采用此策略序列化保存的。

  RedisTemplate默认采用的是JDK的序列化策略，保存的key和value都是采用此策略序列化保存的。

我们先来写一个简单的例子，来看看RedisTemplate是怎么操作的

还是在RedisConfig类里面

@Bean
    public RedisTemplate<String, ?> getRedisTemplate() {
        RedisTemplate<String, ?> template = new RedisTemplate();
        template.setConnectionFactory(getConnectionFactory());

        return template;
    }

然后我们新建一个service类，注入redisTemplate，操作相关的api，将键值对写入到redis服务器

@Autowired
    private RedisTemplate<String, Object> redisTemplate; 6 
    public void setKey(Map<String, Map<?, ?>> map) {
        ValueOperations<String, Object> opsForValue = redisTemplate.opsForValue();
        for (Map.Entry<String, Map<?, ?>> entry : map.entrySet()) {
            String jsonStringFromMap = JsonUtils.getJsonStringFromMap(entry.getValue());
            opsForValue.set(entry.getKey(), jsonStringFromMap);
        }
    }

再写一个controller类，注入service

@RequestMapping(value = "set")
    public ResponseVo setKey() {
        ResponseVo responseVo = new ResponseVo();
        try {
            Map<String, Map<?, ?>> map = new HashMap<String, Map<?, ?>>();
            Map<String, String> map2 = new HashMap<>();
            map2.put("value", "2");
            map.put("boxUid", map2);
            demoService.setKey(map);
            responseVo.setInfo("操作成功");
            responseVo.setData(map);
        } catch (Exception e) {
            responseVo.setInfo("操作失败");
            responseVo.setData(e.getMessage());
        }

        return responseVo;
    }

请求：http://localhost:9099/redis/demo/set

数据就写到redis数据库了。

---

序列化

RedisTemplate对象默认使用jdkSerializer实现序列化，如果想要更换序列化的实现方式，例如使用json实现value的序列化，可以进行如下配置

@Bean
    Jackson2JsonRedisSerializer<Object> jackson2JsonRedisSerializer(ObjectMapper objectMapper) {
        Jackson2JsonRedisSerializer<Object> jackson2JsonRedisSerializer = new Jackson2JsonRedisSerializer<Object>(
                Object.class);
        jackson2JsonRedisSerializer.setObjectMapper(objectMapper);
        return jackson2JsonRedisSerializer;
    }

    @Bean
    RedisTemplate<String, Object> objRedisTemplate(JedisConnectionFactory connectionFactory,
            Jackson2JsonRedisSerializer<Object> jackson2JsonRedisSerializer) {
        RedisTemplate<String, Object> redisTemplate = new RedisTemplate<String, Object>();
        redisTemplate.setConnectionFactory(getConnectionFactory());
        redisTemplate.setDefaultSerializer(jackson2JsonRedisSerializer);
        StringRedisSerializer stringRedisSerializer = new StringRedisSerializer();
        redisTemplate.setKeySerializer(stringRedisSerializer);
        redisTemplate.setHashKeySerializer(stringRedisSerializer);
        return redisTemplate;
    }

redis的value将会以jason形式保存

对象序列化

除了String类型，实战中我们还经常会在Redis中存储对象，这时候我们就会想是否可以使用类似RedisTemplate<String, User>来初始化并进行操作。但是Spring Boot并不支持直接使用，需要我们自己实现RedisSerializer<T>接口来对传入对象进行序列化和反序列化，下面我们通过一个实例来完成对象的读写操作。

• 创建要存储的对象：User

public class User implements Serializable {

    /**
     * 
     */
    private static final long serialVersionUID = -8289770787953160443L;

    private String username;
    private Integer age;

    public User() {
        super();
        // TODO Auto-generated constructor stub
    }

    public User(String username, Integer age) {
        this.username = username;
        this.age = age;
    }

    public String getUsername() {
        return username;
    }

    public void setUsername(String username) {
        this.username = username;
    }

    public Integer getAge() {
        return age;
    }

    public void setAge(Integer age) {
        this.age = age;
    }

}

• 实现对象的序列化接口

public class RedisObjectSerializer implements RedisSerializer<Object> {
    // private Converter<Object, byte[]> serializer = new SerializingConverter();
    // private Converter<byte[], Object> deserializer = new
    // DeserializingConverter();
    static final byte[] EMPTY_ARRAY = new byte[0];

    @Override
    public Object deserialize(byte[] bytes) {
        if (isEmpty(bytes)) {
            return null;
        }
        ObjectInputStream oii = null;
        ByteArrayInputStream bis = null;
        bis = new ByteArrayInputStream(bytes);
        try {
            oii = new ObjectInputStream(bis);
            Object obj = oii.readObject();
            return obj;
        } catch (Exception e) {

            e.printStackTrace();
        }
        return null;
    }

    @Override
    public byte[] serialize(Object object) {
        if (object == null) {
            return EMPTY_ARRAY;
        }
        ObjectOutputStream obi = null;
        ByteArrayOutputStream bai = null;
        try {
            bai = new ByteArrayOutputStream();
            obi = new ObjectOutputStream(bai);
            obi.writeObject(object);
            byte[] byt = bai.toByteArray();
            return byt;
        } catch (IOException e) {
            e.printStackTrace();
        }
        return null;
    }

    private boolean isEmpty(byte[] data) {
        return (data == null || data.length == 0);
    }
}

• 配置针对User的RedisTemplate实例

@Bean
    public RedisTemplate<String, User> redisTemplate(RedisConnectionFactory factory) {
        RedisTemplate<String, User> template = new RedisTemplate<String, User>();
        template.setConnectionFactory(getConnectionFactory());
        template.setKeySerializer(new StringRedisSerializer());
        template.setValueSerializer(new RedisObjectSerializer());
        return template;
    }

• 完成了配置工作后，编写测试用例实验效果

@Autowired
    private RedisTemplate<String, User> redisUserTemplate;

public void setUser(User user) {
        ValueOperations<String, User> opsForValue = redisUserTemplate.opsForValue();
        opsForValue.set(user.getUsername(), user);
        Integer age = opsForValue.get(user.getUsername()).getAge();
        String username = opsForValue.get(user.getUsername()).getUsername();
        System.out.println(age + " " + username);
    }

最后的结果是会输出年龄和姓名。

源代码

相关示例代码在redisBoot