🎨 #1503 微信公众号模块提取redis抽象层、支持key前缀设置

weixin-java-mp/src/main/java/me/chanjar/weixin/mp/config/impl/WxMpRedisConfigImpl.java

@@ -1,12 +1,12 @@
 package me.chanjar.weixin.mp.config.impl;
 
-import me.chanjar.weixin.common.util.locks.JedisDistributedLock;
+import com.sun.istack.internal.NotNull;
+import me.chanjar.weixin.mp.config.redis.JedisWxMpRedisOps;
+import me.chanjar.weixin.mp.config.redis.WxMpRedisOps;
 import me.chanjar.weixin.mp.enums.TicketType;
-import redis.clients.jedis.Jedis;
 import redis.clients.jedis.JedisPool;
 
-import java.util.concurrent.locks.Lock;
+import java.util.concurrent.TimeUnit;
-import java.util.concurrent.locks.ReentrantLock;
 
 /**
  * 基于Redis的微信配置provider.
@@ -20,19 +20,23 @@ import java.util.concurrent.locks.ReentrantLock;
  */
 @SuppressWarnings("hiding")
 public class WxMpRedisConfigImpl extends WxMpDefaultConfigImpl {
-  private static final String ACCESS_TOKEN_KEY = "wx:access_token:";
+  private static final String ACCESS_TOKEN_KEY_TPL = "%s:access_token:%s";
-  private static final String LOCK_KEY = "wx:lock:";
+  private static final String TICKET_KEY_TPL = "%s:ticket:key:%s:%s";
+  private static final String LOCK_KEY_TPL = "%s:lock:%s:";
 
-  /**
+  private final WxMpRedisOps redisOps;
-   * 使用连接池保证线程安全.
+  private final String keyPrefix;
-   */
-  private final JedisPool jedisPool;
 
   private String accessTokenKey;
   private String lockKey;
 
-  public WxMpRedisConfigImpl(JedisPool jedisPool) {
+  public WxMpRedisConfigImpl(@NotNull JedisPool jedisPool) {
-    this.jedisPool = jedisPool;
+    this(new JedisWxMpRedisOps(jedisPool), "wx");
+  }
+
+  public WxMpRedisConfigImpl(@NotNull WxMpRedisOps redisOps, @NotNull String keyPrefix) {
+    this.redisOps = redisOps;
+    this.keyPrefix = keyPrefix;
   }
 
   /**
@@ -41,72 +45,57 @@ public class WxMpRedisConfigImpl extends WxMpDefaultConfigImpl {
   @Override
   public void setAppId(String appId) {
     super.setAppId(appId);
-    this.accessTokenKey = ACCESS_TOKEN_KEY.concat(appId);
+    this.accessTokenKey = String.format(ACCESS_TOKEN_KEY_TPL, this.keyPrefix, appId);
-    this.lockKey = ACCESS_TOKEN_KEY.concat(appId).concat(":");
+    this.lockKey = String.format(LOCK_KEY_TPL, this.keyPrefix, appId);
-    accessTokenLock = new JedisDistributedLock(jedisPool, lockKey.concat("accessTokenLock"));
+    accessTokenLock = this.redisOps.getLock(lockKey.concat("accessTokenLock"));
-    jsapiTicketLock = new JedisDistributedLock(jedisPool, lockKey.concat("jsapiTicketLock"));
+    jsapiTicketLock = this.redisOps.getLock(lockKey.concat("jsapiTicketLock"));
-    sdkTicketLock = new JedisDistributedLock(jedisPool, lockKey.concat("sdkTicketLock"));
+    sdkTicketLock = this.redisOps.getLock(lockKey.concat("sdkTicketLock"));
-    cardApiTicketLock = new JedisDistributedLock(jedisPool, lockKey.concat("cardApiTicketLock"));
+    cardApiTicketLock = this.redisOps.getLock(lockKey.concat("cardApiTicketLock"));
   }
 
   private String getTicketRedisKey(TicketType type) {
-    return String.format("wx:ticket:key:%s:%s", this.appId, type.getCode());
+    return String.format(TICKET_KEY_TPL, this.keyPrefix, appId, type.getCode());
   }
 
   @Override
   public String getAccessToken() {
-    try (Jedis jedis = this.jedisPool.getResource()) {
+    return redisOps.getValue(this.accessTokenKey);
-      return jedis.get(this.accessTokenKey);
-    }
   }
 
   @Override
   public boolean isAccessTokenExpired() {
-    try (Jedis jedis = this.jedisPool.getResource()) {
+    Long expire = redisOps.getExpire(this.accessTokenKey);
-      return jedis.ttl(accessTokenKey) < 2;
+    return expire == null || expire < 2;
-    }
   }
 
   @Override
   public synchronized void updateAccessToken(String accessToken, int expiresInSeconds) {
-    try (Jedis jedis = this.jedisPool.getResource()) {
+    redisOps.setValue(this.accessTokenKey, accessToken, expiresInSeconds - 200, TimeUnit.SECONDS);
-      jedis.setex(this.accessTokenKey, expiresInSeconds - 200, accessToken);
-    }
   }
 
   @Override
   public void expireAccessToken() {
-    try (Jedis jedis = this.jedisPool.getResource()) {
+    redisOps.expire(this.accessTokenKey, 0, TimeUnit.SECONDS);
-      jedis.expire(this.accessTokenKey, 0);
-    }
   }
 
   @Override
   public String getTicket(TicketType type) {
-    try (Jedis jedis = this.jedisPool.getResource()) {
+    return redisOps.getValue(this.getTicketRedisKey(type));
-      return jedis.get(this.getTicketRedisKey(type));
-    }
   }
 
   @Override
   public boolean isTicketExpired(TicketType type) {
-    try (Jedis jedis = this.jedisPool.getResource()) {
+    return redisOps.getExpire(this.getTicketRedisKey(type)) < 2;
-      return jedis.ttl(this.getTicketRedisKey(type)) < 2;
-    }
   }
 
   @Override
   public synchronized void updateTicket(TicketType type, String jsapiTicket, int expiresInSeconds) {
-    try (Jedis jedis = this.jedisPool.getResource()) {
+    redisOps.setValue(this.getTicketRedisKey(type), jsapiTicket, expiresInSeconds - 200, TimeUnit.SECONDS);
-      jedis.setex(this.getTicketRedisKey(type), expiresInSeconds - 200, jsapiTicket);
-    }
   }
 
   @Override
   public void expireTicket(TicketType type) {
-    try (Jedis jedis = this.jedisPool.getResource()) {
+    redisOps.expire(this.getTicketRedisKey(type), 0, TimeUnit.SECONDS);
-      jedis.expire(this.getTicketRedisKey(type), 0);
-    }
   }
 
 }

weixin-java-mp/src/main/java/me/chanjar/weixin/mp/config/redis/BaseWxMpRedisOps.java

@@ -0,0 +1,37 @@
+package me.chanjar.weixin.mp.config.redis;
+
+import java.util.concurrent.TimeUnit;
+import java.util.concurrent.locks.Lock;
+
+/**
+ * 微信公众号redis操作基本类
+ * <p>
+ * 非内置实现redis相关操作, 请实现该类
+ */
+public class BaseWxMpRedisOps implements WxMpRedisOps {
+
+  @Override
+  public String getValue(String key) {
+    throw new UnsupportedOperationException();
+  }
+
+  @Override
+  public void setValue(String key, String value, int expire, TimeUnit timeUnit) {
+    throw new UnsupportedOperationException();
+  }
+
+  @Override
+  public Long getExpire(String key) {
+    throw new UnsupportedOperationException();
+  }
+
+  @Override
+  public void expire(String key, int expire, TimeUnit timeUnit) {
+    throw new UnsupportedOperationException();
+  }
+
+  @Override
+  public Lock getLock(String key) {
+    throw new UnsupportedOperationException();
+  }
+}

weixin-java-mp/src/main/java/me/chanjar/weixin/mp/config/redis/JedisWxMpRedisOps.java

@@ -0,0 +1,51 @@
+package me.chanjar.weixin.mp.config.redis;
+
+import lombok.AllArgsConstructor;
+import me.chanjar.weixin.common.util.locks.JedisDistributedLock;
+import redis.clients.jedis.Jedis;
+import redis.clients.jedis.JedisPool;
+
+import java.util.concurrent.TimeUnit;
+import java.util.concurrent.locks.Lock;
+
+/**
+ * Jedis实现相关操作
+ */
+@AllArgsConstructor
+public class JedisWxMpRedisOps implements WxMpRedisOps {
+
+  private JedisPool jedisPool;
+
+  @Override
+  public String getValue(String key) {
+    try (Jedis jedis = this.jedisPool.getResource()) {
+      return jedis.get(key);
+    }
+  }
+
+  @Override
+  public void setValue(String key, String value, int expire, TimeUnit timeUnit) {
+    try (Jedis jedis = this.jedisPool.getResource()) {
+      jedis.psetex(key, timeUnit.toMillis(expire), value);
+    }
+  }
+
+  @Override
+  public Long getExpire(String key) {
+    try (Jedis jedis = this.jedisPool.getResource()) {
+      return jedis.ttl(key);
+    }
+  }
+
+  @Override
+  public void expire(String key, int expire, TimeUnit timeUnit) {
+    try (Jedis jedis = this.jedisPool.getResource()) {
+      jedis.pexpire(key, timeUnit.toMillis(expire));
+    }
+  }
+
+  @Override
+  public Lock getLock(String key) {
+    return new JedisDistributedLock(jedisPool, key);
+  }
+}

weixin-java-mp/src/main/java/me/chanjar/weixin/mp/config/redis/WxMpRedisOps.java

@@ -0,0 +1,25 @@
+package me.chanjar.weixin.mp.config.redis;
+
+import java.util.concurrent.TimeUnit;
+import java.util.concurrent.locks.Lock;
+
+/**
+ * 微信公众号Redis相关操作
+ * <p>
+ * 该接口不承诺稳定, 外部实现请继承{@link BaseWxMpRedisOps}
+ *
+ * @see BaseWxMpRedisOps 实现需要继承该类
+ * @see JedisWxMpRedisOps jedis实现
+ */
+public interface WxMpRedisOps {
+
+  String getValue(String key);
+
+  void setValue(String key, String value, int expire, TimeUnit timeUnit);
+
+  Long getExpire(String key);
+
+  void expire(String key, int expire, TimeUnit timeUnit);
+
+  Lock getLock(String key);
+}