com.litongjava.redis.RedisPlugin Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of java-db Show documentation
Java Database
There is a newer version: 1.4.7
package com.litongjava.redis;

import java.util.function.Consumer;

import com.jfinal.kit.StrKit;
import com.litongjava.db.IPlugin;
import com.litongjava.redis.serializer.FstSerializer;
import com.litongjava.redis.serializer.ISerializer;

import redis.clients.jedis.JedisPool;
import redis.clients.jedis.JedisPoolConfig;
import redis.clients.jedis.Protocol;

/**
 * RedisPlugin.
 * RedisPlugin 支持多个 Redis 服务端，只需要创建多个 RedisPlugin 对象
 * 对应这多个不同的 Redis 服务端即可。也支持多个 RedisPlugin 对象对应同一
 * Redis 服务的不同 database，具体例子见 jfinal 手册
 */
public class RedisPlugin implements IPlugin {

  protected volatile boolean isStarted = false;

  protected String cacheName;

  protected String host;
  protected Integer port = null;
  protected Integer timeout = null;
  protected String password = null;
  protected Integer database = null;
  protected String clientName = null;

  protected ISerializer serializer = null;
  protected IKeyNamingPolicy keyNamingPolicy = null;
  protected JedisPoolConfig jedisPoolConfig = new JedisPoolConfig();

  public RedisPlugin(String cacheName, String host) {
    if (StrKit.isBlank(cacheName))
      throw new IllegalArgumentException("cacheName can not be blank.");
    if (StrKit.isBlank(host))
      throw new IllegalArgumentException("host can not be blank.");
    this.cacheName = cacheName.trim();
    this.host = host;
  }

  public RedisPlugin(String cacheName, String host, int port) {
    this(cacheName, host);
    this.port = port;
  }

  public RedisPlugin(String cacheName, String host, int port, int timeout) {
    this(cacheName, host, port);
    this.timeout = timeout;
  }

  public RedisPlugin(String cacheName, String host, int port, int timeout, String password) {
    this(cacheName, host, port, timeout);
    // 当 password 未指定时 jedis 底层不进行 auth 也可以进行操作
    // if (StrKit.isBlank(password))
    // throw new IllegalArgumentException("password can not be blank.");
    this.password = password;
  }

  public RedisPlugin(String cacheName, String host, int port, int timeout, String password, int database) {
    this(cacheName, host, port, timeout, password);
    this.database = database;
  }

  public RedisPlugin(String cacheName, String host, int port, int timeout, String password, int database,
      String clientName) {
    this(cacheName, host, port, timeout, password, database);
    if (StrKit.isBlank(clientName))
      throw new IllegalArgumentException("clientName can not be blank.");
    this.clientName = clientName;
  }

  public RedisPlugin(String cacheName, String host, int port, String password) {
    this(cacheName, host, port, Protocol.DEFAULT_TIMEOUT, password);
  }

  public RedisPlugin(String cacheName, String host, String password) {
    this(cacheName, host, Protocol.DEFAULT_PORT, Protocol.DEFAULT_TIMEOUT, password);
  }

  public boolean start() {
    if (isStarted) {
      return true;
    }

    JedisPool jedisPool;
    if (port != null && timeout != null && database != null && clientName != null) {
      jedisPool = new JedisPool(jedisPoolConfig, host, port, timeout, password, database, clientName);

    } else if (port != null && timeout != null && database != null) {
      jedisPool = new JedisPool(jedisPoolConfig, host, port, timeout, password, database);

    } else if (port != null && timeout != null) {
      jedisPool = new JedisPool(jedisPoolConfig, host, port, timeout, password);
    }
    // else if (port != null && timeout != null)
    // jedisPool = new JedisPool(jedisPoolConfig, host, port, timeout);
    else if (port != null) {
      jedisPool = new JedisPool(jedisPoolConfig, host, port);
    } else {
      jedisPool = new JedisPool(jedisPoolConfig, host);
    }

    return start(jedisPool);
  }

  public boolean start(JedisPool jedisPool) {
    if (isStarted) {
      return true;
    }
    if (serializer == null) {
      serializer = FstSerializer.me;
    }

    if (keyNamingPolicy == null) {
      keyNamingPolicy = IKeyNamingPolicy.defaultKeyNamingPolicy;
    }

    RedisCache cache = new RedisCache(cacheName, jedisPool, serializer, keyNamingPolicy);
    Redis.addCache(cache);

    isStarted = true;
    return true;
  }

  public boolean stop() {
    RedisCache cache = Redis.removeCache(cacheName);
    if (cache == Redis.mainCache) {
      Redis.mainCache = null;
    }

    cache.jedisPool.destroy();

    isStarted = false;
    return true;
  }

  /**
   * 当RedisPlugin 提供的设置属性仍然无法满足需求时，通过此方法获取到
   * JedisPoolConfig 对象，可对 redis 进行更加细致的配置
   *    * 例如：
   * redisPlugin.getJedisPoolConfig().setMaxTotal(100);
   * 
   */
  public JedisPoolConfig getJedisPoolConfig() {
    return jedisPoolConfig;
  }

  /**
   * lambda 方式配置 JedisPoolConfig
   *    * 例子：
   *   RedisPlugin redisPlugin = new RedisPlugin(...);
   *   redisPlugin.config(c -> {
   *       c.setMaxIdle(123456);
   *   });
   * 
   */
  public void config(Consumer config) {
    config.accept(jedisPoolConfig);
  }

  // ---------

  public void setSerializer(ISerializer serializer) {
    this.serializer = serializer;
    Serializer.serializer = serializer;
  }

  public void setKeyNamingPolicy(IKeyNamingPolicy keyNamingPolicy) {
    this.keyNamingPolicy = keyNamingPolicy;
  }

  // ---------

  public void setTestWhileIdle(boolean testWhileIdle) {
    jedisPoolConfig.setTestWhileIdle(testWhileIdle);
  }

  public void setMinEvictableIdleTimeMillis(int minEvictableIdleTimeMillis) {
    jedisPoolConfig.setMinEvictableIdleTimeMillis(minEvictableIdleTimeMillis);
  }

  public void setTimeBetweenEvictionRunsMillis(int timeBetweenEvictionRunsMillis) {
    jedisPoolConfig.setTimeBetweenEvictionRunsMillis(timeBetweenEvictionRunsMillis);
  }

  public void setNumTestsPerEvictionRun(int numTestsPerEvictionRun) {
    jedisPoolConfig.setNumTestsPerEvictionRun(numTestsPerEvictionRun);
  }
}