redis工具类封装

各位读者，大家好！

    本次给大家带来redis的封装类，可以很优雅的操作redis，本工具结合了springframework中的部分注解和类，适用于spring框架的项目使用。

    首先，创建一个配置类ConstantConfig，可以很方便读取配置文件：

package com.cheng2839.config;

import lombok.Data;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Configuration;

/**
 * 配置文件包装类
 * @author cheng2839
 * @date 2018年11月16日
 */
@Data
@Configuration
public class ConstantConfig {

    /////////////////// redis配置  ///////////////////
    @Value("${spring.redis.host}")
    private String redisHost;

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

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

    @Value("${spring.redis.database}")
    private int redisDatabase;

}

创建配置文件application.properties如下：

# REDIS配置
spring.redis.database=0
spring.redis.host=127.0.0.1
spring.redis.port=6379
spring.redis.password=
spring.redis.pool.max-active=200
spring.redis.pool.max-wait=10000
spring.redis.pool.max-idle=50
spring.redis.pool.min-idle=5
spring.redis.timeout=10000

最后，redis配置类RedisConfig如下：

package com.cheng2839.config;

import com.fasterxml.jackson.annotation.JsonAutoDetect;
import com.fasterxml.jackson.annotation.PropertyAccessor;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.context.annotation.Bean;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.cache.annotation.CachingConfigurerSupport;
import org.springframework.data.redis.connection.jedis.JedisConnectionFactory;
import org.springframework.data.redis.core.RedisTemplate;
import org.springframework.data.redis.serializer.Jackson2JsonRedisSerializer;
import org.springframework.data.redis.serializer.StringRedisSerializer;
import org.springframework.context.annotation.Configuration;

import java.util.concurrent.TimeUnit;

/**
 * Redis配置及基础方法实现封装类
 * @author cheng2839
 * @date 2018年11月16日
 */
@Configuration
public class RedisConfig extends CachingConfigurerSupport {

    private static final Logger logger = LoggerFactory.getLogger(RedisConfig.class);

    @Autowired
    private ConstantConfig config;

    private RedisTemplate<String, Object> redisTemplate;

    /**
     * 创建JedisConnectionFactory
     * @return
     * @author cheng2839
     * @date 2018年11月16日
     */
    @Bean(name = "factory")
    public JedisConnectionFactory createFactory() {
        JedisConnectionFactory factory = new JedisConnectionFactory();
        factory.setHostName(config.getRedisHost());
        factory.setPort(config.getRedisPort());
        factory.setPassword(config.getRedisPassword());
        factory.setDatabase(config.getRedisDatabase());
        return factory;
    }

    /**
     * 创建RedisTemplate
     * @param factory
     * @return
     */
    @Bean(name = "redisTemplate")
    public RedisTemplate<String, Object> createRedisTemplate(JedisConnectionFactory factory) {
        redisTemplate = new RedisTemplate<>();
        redisTemplate.setConnectionFactory(factory);

        //设置序列化/反序列化方式
        Jackson2JsonRedisSerializer serializer = new Jackson2JsonRedisSerializer(Object.class);
        ObjectMapper mapper = new ObjectMapper();
        mapper.setVisibility(PropertyAccessor.ALL, JsonAutoDetect.Visibility.ANY);
        mapper.enableDefaultTyping(ObjectMapper.DefaultTyping.NON_FINAL);
        serializer.setObjectMapper(mapper);

        redisTemplate.setValueSerializer(serializer);
        redisTemplate.setKeySerializer(new StringRedisSerializer());
        redisTemplate.afterPropertiesSet();
        return redisTemplate;
    }


    //////////////////   下面为 Redis基础操作方法 可根据情况扩展  //////////////////

    /**
     * 添加一个key，无过期时间
     * @param key
     * @param value
     * @author cheng2839
     * @date 2018年11月16日
     */
    public void set(String key, Object value) {
        logger.info("[redis.set:({},{})]", key, value);
        redisTemplate.opsForValue().set(key, value);
    }

    /**
     * 添加一个key，并设置过期时间
     * @param key
     * @param value
     * @param time
     * @param timeUnit
     * @author cheng2839
     * @date 2018年11月16日
     */
    public void set(String key, Object value, long time, TimeUnit timeUnit) {
        logger.info("[redis.set:({},{})-({} {})]", key, value, time, timeUnit);
        redisTemplate.opsForValue().set(key, value, time, timeUnit);
    }

    /**
     * get redis value
     * @param key
     * @return
     * @author cheng2839
     * @date 2018年11月16日
     */
    public Object get(String key) {
        logger.info("[redis.get:({})]", key);
        return redisTemplate.opsForValue().get(key);
    }

    /**
     * 设置key的过期时间
     * @param key
     * @param time
     * @param timeUnit
     * @author cheng2839
     * @date 2018年11月16日
     */
    public void expire(String key, long time, TimeUnit timeUnit) {
        logger.info("[redis.expire:({})-({} {})]", key, time, timeUnit);
        redisTemplate.expire(key, time, timeUnit);
    }

    /**
     * 删除key
     * @param key
     * @author cheng2839
     * @date 2018年11月16日
     */
    public void delete(String key){
        logger.info("[redis.delete:({})]", key);
        redisTemplate.delete(key);
    }

    /**
     * 判断key是否存在
     * @param key
     * @return
     * @author cheng2839
     * @date 2018年11月16日
     */
    public boolean hasKey(String key) {
        logger.info("[redis.hasKey:({})]", key);
        return redisTemplate.hasKey(key);
    }

    //////////////////   上面为 Redis基础操作方法 可根据情况扩展  //////////////////

}

使用也很方便，我们创建一个RedisTest测试类来测试一下：

package com.cheng2839.test;

import org.springframework.beans.factory.annotation.Autowired;
import com.cheng2839.config.RedisConfig;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class RedisTest {

    public Logger logger = LoggerFactory.getLogger(this.getClass());

    @Autowired
    private RedisConfig redisConfig;

    public static void main(String[] args) {
        String key = "cheng2839";
        redisConfig.set(key, "这是我的博客");
        Object val = redisConfig.get(key);
        logger.info("查询redis中的值：key：" + key + "	value：" + val);

        boolean hasKey = redisConfig.hasKey(key);
        logger.info("查询redis中key：" + key + "：" + hasKey);

        redisConfig.delete(key);
        val = redisConfig.get(key);
        logger.info("查询redis中的值：key：" + key + "	value：" + val);
    }

}

package com.cheng2839.test;

import org.springframework.beans.factory.annotation.Autowired;
import com.cheng2839.config.RedisConfig;

public class RedisTest {

    @Autowired
    private RedisConfig redisConfig;

    public static void main(String[] args) {
        String key = "cheng2839";
        redisConfig.set(key, "这是我的博客");
        Object val = redisConfig.get(key);
        System.out.println("查询redis中的值：key：" + key + "	value：" + val);

        boolean hasKey = redisConfig.hasKey(key);
        System.out.println("查询redis中key：" + key + "：" + hasKey);

        redisConfig.delete(key);
        val = redisConfig.get(key);
        System.out.println("查询redis中的值：key：" + key + "	value：" + val);
    }

测试打印日志如下：

2018-11-16 13:56:33.217 [redis.set:(cheng2839,这是我的博客)]
2018-11-16 13:56:33.222 [redis.get:(cheng2839)]
2018-11-16 13:56:33.225 查询redis中的值：key：cheng2839    value：这是我的博客
2018-11-16 13:56:33.225 [redis.hasKey:(cheng2839)]
2018-11-16 13:56:33.228 查询redis中key：cheng2839：true
2018-11-16 13:56:33.228 [redis.delete:(cheng2839)]
2018-11-16 13:56:33.230 [redis.get:(cheng2839)]
2018-11-16 13:56:33.233 查询redis中的值：key：cheng2839    value：null

      后续给大家带来redis的安装、部署、配置；包括集群的设置等