spring-redis-plugin

本项目是Jedis基于spring的增强版,实现了自动获取连接和关闭连接,提供基于redis的分布式锁实现.

1 Maven POM 配置

使用Jitpack仓库

1.1 添加仓库地址

<repositories>
    <repository>
        <id>jitpack.io</id>
        <url>https://jitpack.io</url>
    </repository>
</repositories>

1.2 添加依赖

<dependency>
    <groupId>com.github.fangzy</groupId>
    <artifactId>spring-redis-plugin</artifactId>
    <version>1.5.1</version>
</dependency>

1.3 依赖`spring-context`项目

<dependency>
    <groupId>org.springframework</groupId>
    <artifactId>spring-context</artifactId>
    <version>4.X.X.RELEASE</version>
    <exclusions>
        <exclusion>
            <groupId>commons-logging</groupId>
            <artifactId>commons-logging</artifactId>
        </exclusion>
    </exclusions>
</dependency>

2 Jedis使用方法

2.1 Spring Configuration配置文件

直接使用默认配置

@Configuration
@PropertySource("classpath:redisPool.properties")
@Import(DefaultRedisConfiguration.class)
public class RedisConfig {
}

自定义配置参见DefaultRedisConfiguration、DefaultShardedRedisConfiguration

2.2 Spring XML配置文件

<context:property-placeholder location="classpath:your-redis-settings.properties" file-encoding="UTF-8"></context:property-placeholder>
<!--redis pool-->
<bean id="jedisPoolFactoryConfig" class="redis.clients.jedis.JedisPoolConfig">
    <property name="maxTotal" value="${redis.maxTotal}"></property>
    <property name="maxIdle" value="${redis.maxIdle}"></property>
    <property name="maxWaitMillis" value="${redis.maxWait}"></property>
    <property name="minIdle" value="${redis.minIdle}"></property>
    <property name="numTestsPerEvictionRun" value="${redis.numTestsPerEvictionRun}"></property>
    <property name="testOnBorrow" value="${redis.testOnBorrow}"></property>
    <property name="testOnReturn" value="${redis.testOnReturn}"></property>
    <property name="testWhileIdle" value="${redis.testWhileIdle}"></property>
</bean>
<bean id="default" class="redis.clients.jedis.JedisPool" destroy-method="destroy">
    <constructor-arg ref="jedisPoolFactoryConfig" name="poolConfig"></constructor-arg>
    <constructor-arg value="${redis.ip}" name="host" type="java.lang.String"></constructor-arg>
    <constructor-arg value="${redis.port}" name="port" type="int"></constructor-arg>
</bean>
<bean id="jedisPool6380" class="redis.clients.jedis.JedisPool" destroy-method="destroy">
    <constructor-arg ref="jedisPoolFactoryConfig" name="poolConfig"></constructor-arg>
    <constructor-arg value="${redis.ip}" name="host" type="java.lang.String"></constructor-arg>
    <constructor-arg value="6380" name="port" type="int"></constructor-arg>
</bean>
<!-- shard redis -->
<bean id="jedisShardInfo1" class="redis.clients.jedis.JedisShardInfo">
    <constructor-arg value="${redis.ip}" name="host" type="java.lang.String"></constructor-arg>
    <constructor-arg value="${redis.port}" name="port" type="int"></constructor-arg>
</bean>
<bean id="jedisShardInfo2" class="redis.clients.jedis.JedisShardInfo">
    <constructor-arg value="${redis.ip}" name="host" type="java.lang.String"></constructor-arg>
    <constructor-arg value="6380" name="port" type="int"></constructor-arg>
</bean>
<bean id="shardedJedisPool" class="redis.clients.jedis.ShardedJedisPool" destroy-method="destroy">
    <constructor-arg ref="jedisPoolFactoryConfig" name="poolConfig"></constructor-arg>
    <constructor-arg name="shards">
        <list>
            <ref bean="jedisShardInfo1"></ref>
            <ref bean="jedisShardInfo2"></ref>
        </list>
    </constructor-arg>
</bean>
<context:component-scan base-package="org.reindeer.reids" ></context:component-scan>
<!--使用@Redis注解时必须加上-->
<aop:aspectj-autoproxy proxy-target-class="true"></aop:aspectj-autoproxy>

请按照需要选择配置

2.3 依赖注入

@Service
public class JedisDemo {
    @Autowired
    private Jedis jedis;
    public void setAndGet(String key,int times) {
        for (int i=0;i<times;i++) {
            jedis.set(key, "test1");
            jedis.get(key);
        }
        jedis.del(key);
    }
}

如果需要使用pipelined,watch,unwatch,multi 方法必须开启注解,详见2.4

2.4 使用注解

jedisPool的default为默认数据源，必须存在

@Service
public class JedisDemo {
    @Autowired
    private Jedis jedis;
    @Redis
    public void incr(String key,int times) {
        Pipeline pipeline = jedis.pipelined();
        pipeline.set(key, "1");
        for (int i = 0; i < times; i++) {
            pipeline.incr(key);
        }
        Response<String> response = pipeline.get(key);
        pipeline.sync();
        jedis.del(key);
    }
}

2.5 使用JedisProxy

public class JedisDemo {
    public static void setAndGet(String key,int times) {
        Jedis jedis = JedisProxy.create();
        for (int i=0;i<times;i++) {
            jedis.set(key, "test1");
            jedis.get(key);
        }
        jedis.del(key);
    }
}

JedisProxy 通常用于静态方法,但是需要在spring容器全部加载完毕后使用
如果需要使用pipelined,watch,unwatch,multi 方法必须开启注解,详见2.4

2.6 使用多数据源

@Service
public class JedisDemo {
    @Autowired
    private Jedis jedis;
    @Redis("anotherRedis")
    public void incr(String key,int times) {
        Pipeline pipeline = jedis.pipelined();
        pipeline.set(key, "1");
        for (int i = 0; i < times; i++) {
            pipeline.incr(key);
        }
        Response<String> response = pipeline.get(key);
        pipeline.sync();
        jedis.del(key);
    }
}

java config 使用@Bean(name="anotherRedis")来定义数据源名称

@Configuration
public class RedisConfiguration {
    @Bean(name = "default", destroyMethod = "destroy")
    public JedisPool defaultJedisPool() {
            return new JedisPool(defaultJedisPoolConfig(),
                    env.getProperty("redis.host", "127.0.0.1"),
                    env.getProperty("redis.port", Integer.class, 6379),
                    Protocol.DEFAULT_TIMEOUT,
                    StringUtils.isEmpty(env.getProperty("redis.password")) ? null : env.getProperty("redis.password"));
    }
    @Bean(name = "anotherRedis", destroyMethod = "destroy")
    public JedisPool testJedisPool() {
        return new JedisPool(defaultJedisPoolConfig(),
                env.getProperty("redis.host2", "127.0.0.1"),
                env.getProperty("redis.port2", Integer.class, 6379),
                Protocol.DEFAULT_TIMEOUT,
                StringUtils.isEmpty(env.getProperty("redis.password2")) ? null : env.getProperty("redis.password2"));
    }
}

xml配置

<bean id="default" class="redis.clients.jedis.JedisPool" destroy-method="destroy">
    <constructor-arg ref="jedisPoolFactoryConfig" name="poolConfig"></constructor-arg>
    <constructor-arg value="${redis.ip}" name="host" type="java.lang.String"></constructor-arg>
    <constructor-arg value="${redis.port}" name="port" type="int"></constructor-arg>
</bean>
<bean id="anotherRedis" class="redis.clients.jedis.JedisPool" destroy-method="destroy">
    <constructor-arg ref="jedisPoolFactoryConfig" name="poolConfig"></constructor-arg>
    <constructor-arg value="${redis.ip}" name="host" type="java.lang.String"></constructor-arg>
    <constructor-arg value="6380" name="port" type="int"></constructor-arg>
</bean>

jedisPool的default为默认数据源，必须存在

2.7 使用shard

@Service
public class ShardedJedisDemo {
    @Autowired
    private ShardedJedis shardedJedis;
    @Redis(shard = true)
    public void incr(String key, int times) {
        ShardedJedisPipeline pipeline = shardedJedis.pipelined();
        for (int i = 0; i < times; i++) {
            pipeline.incr(key + i);
        }
        Response<String> response = pipeline.get(key + 1);
        pipeline.sync();
        LOGGER.info(response.get());
    }
}

java config配置

@Configuration
public class RedisConfiguration {
    @Bean(destroyMethod = "destroy")
    public ShardedJedisPool defaultShardedJedisPool() {
        String hoststr = env.getProperty("redis.sharded.hosts", "127.0.0.1");
        String portstr = env.getProperty("redis.sharded.ports", "6379");
        List<String> hosts = Arrays.asList(hoststr.split(","));
        List<Integer> ports = Stream.of(portstr.split(",")).map(Integer::new).collect(Collectors.toList());
        List<JedisShardInfo> list = IntStream.range(0, hosts.size()).mapToObj(i -> new JedisShardInfo(hosts.get(i), ports.get(i))).collect(Collectors.toList());
        return new ShardedJedisPool(defaultJedisPoolConfig(), list);
    }
}

xml配置

<bean id="jedisShardInfo1" class="redis.clients.jedis.JedisShardInfo">
    <constructor-arg value="${redis.ip}" name="host" type="java.lang.String"></constructor-arg>
    <constructor-arg value="${redis.port}" name="port" type="int"></constructor-arg>
</bean>
<bean id="jedisShardInfo2" class="redis.clients.jedis.JedisShardInfo">
    <constructor-arg value="${redis.ip}" name="host" type="java.lang.String"></constructor-arg>
    <constructor-arg value="6380" name="port" type="int"></constructor-arg>
</bean>
<bean id="shardedJedisPool" class="redis.clients.jedis.ShardedJedisPool" destroy-method="destroy">
    <constructor-arg ref="jedisPoolFactoryConfig" name="poolConfig"></constructor-arg>
    <constructor-arg name="shards">
        <list>
            <ref bean="jedisShardInfo1"></ref>
            <ref bean="jedisShardInfo2"></ref>
        </list>
    </constructor-arg>
</bean>

3 JLock分布式锁

void waitLock(String key) 一直等待解锁
boolean getLock(String key) 获得锁,超时退出
boolean checkLock(String key) 检查锁是否存在,立即返回
void releaseLock(String key) 手动释放锁

spring-redis-plugin

1 Maven POM 配置

1.1 添加仓库地址

1.2 添加依赖

1.3 依赖spring-context项目

2 Jedis使用方法

2.1 Spring Configuration配置文件

2.2 Spring XML配置文件

2.3 依赖注入

2.4 使用注解

2.5 使用JedisProxy

2.6 使用多数据源

2.7 使用shard

3 JLock分布式锁

1.3 依赖`spring-context`项目