redis-spring-boot-starter

redis-spring-boot-starter

This is a simple spring boot starter to use Jedis.

Features

• Auto configuration.
• JedisPool and RedisClient.
• Distributed re-entering lock - RedisReentrantLock.
• Distributed limiting.

Contact

Github issues

Mail: [email protected]

Quick Start

compile and install:

mvn clean install

maven dependency:

<dependency>
    <groupId>io.github.ionething</groupId>
    <artifactId>redis-spring-boot-starter</artifactId>
    <version>1.0.1</version>
</dependency>

RedisClient and JedisPool

    @Autowired
    private RedisClient redisClient;

    @Autowired
    private JedisPool jedisPool;
    
    // Or from redisClient
    // private JedisPool jedisPool = redisClient.getJedisPool()

RedisReentrantLock

    // Or spring ioc
    RedisReentrantLock lock = new RedisReentrantLock(redisClient.getJedisPool(), "name");
    
    try {
        lock.lock();
        
        // doing something
        
    } finally {
        lock.unlock();
    }

Limiting

    @RedisCommonLimit(name = "login", permits = 500)
    public void login() {
        // do something
    }

If you do not want to use limiting, you can config it.

redis.limit.ignore=true

Default, false if you do not figure it out.

Spring Boot Properties

application.properties

redis.host=127.0.0.1
redis.port=6379
redis.password=  
redis.ssl=false
redis.pool.maxIdle=8
redis.pool.minIdle=0
redis.pool.maxActive=8
redis.pool.maxWait=-1ms
redis.limit.ignore=false

TODO

• support redis cluster.

Tips

• Redisson is a better choice if you use redis in your app in product environment.

custom spring boot starter

spring boot docs