org.redkalex.cache.redis.RedisSource Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of redkale-plugins Show documentation
Show all versions of redkale-plugins Show documentation
Redkale-Plugins -- java framework
/*
* Click nbfs://nbhost/SystemFileSystem/Templates/Licenses/license-default.txt to change this license
* Click nbfs://nbhost/SystemFileSystem/Templates/Classes/Class.java to edit this template
*/
package org.redkalex.cache.redis;
import java.lang.reflect.Type;
import java.nio.charset.StandardCharsets;
import java.util.Arrays;
import java.util.List;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;
import java.util.concurrent.atomic.AtomicInteger;
import java.util.concurrent.locks.ReentrantLock;
import java.util.function.Function;
import org.redkale.annotation.Resource;
import static org.redkale.boot.Application.RESNAME_APP_EXECUTOR;
import static org.redkale.boot.Application.RESNAME_APP_NAME;
import org.redkale.convert.Convert;
import org.redkale.convert.json.JsonConvert;
import org.redkale.inject.ResourceFactory;
import org.redkale.source.AbstractCacheSource;
import org.redkale.util.*;
/**
* @author zhangjx
* @since 2.8.0
*/
public abstract class RedisSource extends AbstractCacheSource {
public static final String CACHE_SOURCE_CRYPTOR = "cryptor";
protected static final long PUBSUB_RETRY_DELAY_MILLS = 1000;
protected static final String SCRIPT_DELEX = "if redis.call('get', KEYS[1]) == ARGV[1] then\n"
+ " redis.call('del', KEYS[1]);\n"
+ " return 1\n"
+ "else\n"
+ " return 0\n"
+ "end\n";
protected static final String SCRIPT_RATELIMIT = "redis.replicate_commands()\n"
+ "\n"
+ "local tokens_key = KEYS[1]\n"
+ "local timestamp_key = KEYS[2]\n"
+ "\n"
+ "local rate = tonumber(ARGV[1])\n"
+ "local capacity = tonumber(ARGV[2])\n"
+ "local requested = tonumber(ARGV[3])\n"
+ "\n"
+ "local fill_time = capacity / rate\n"
+ "local ttl = math.floor(fill_time * 2)\n"
+ "local now = redis.call('TIME')[1]\n"
+ "\n"
+ "local last_tokens = tonumber(redis.call(\"get\", tokens_key))\n"
+ "if last_tokens == nil then\n"
+ " last_tokens = capacity\n"
+ "end\n"
+ "\n"
+ "local last_refreshed = tonumber(redis.call(\"get\", timestamp_key))\n"
+ "if last_refreshed == nil then\n"
+ " last_refreshed = 0\n"
+ "end\n"
+ "\n"
+ "local delta = math.max(0, now-last_refreshed)\n"
+ "local filled_tokens = math.min(capacity, last_tokens+(delta*rate))\n"
+ "local allowed = filled_tokens >= requested\n"
+ "local new_tokens = filled_tokens\n"
+ "local allowed_num = filled_tokens - requested\n"
+ "if allowed then\n"
+ " new_tokens = filled_tokens - requested\n"
+ "end\n"
+ "\n"
+ "if ttl > 0 then\n"
+ " redis.call(\"setex\", tokens_key, ttl, new_tokens)\n"
+ " redis.call(\"setex\", timestamp_key, ttl, now)\n"
+ "end\n"
+ "\n"
+ "return allowed_num";
protected String name;
@Resource(name = RESNAME_APP_NAME, required = false)
protected String appName = "";
@Resource(required = false)
protected ResourceFactory resourceFactory;
@Resource(required = false)
protected JsonConvert defaultConvert;
@Resource(name = Resource.PARENT_NAME + "_convert", required = false)
protected JsonConvert convert;
protected boolean closed;
protected int db;
protected RedisCryptor cryptor;
protected AnyValue conf;
private ExecutorService pubSubExecutor;
private final ReentrantLock pubSubExecutorLock = new ReentrantLock();
@Resource(name = RESNAME_APP_EXECUTOR, required = false)
protected ExecutorService workExecutor;
@Override
public void init(AnyValue conf) {
this.conf = conf;
super.init(conf);
this.name = conf == null ? "" : conf.getValue("name", "");
if (this.convert == null) {
this.convert = this.defaultConvert;
}
if (conf != null) {
String cryptStr = conf.getValue(CACHE_SOURCE_CRYPTOR, "").trim();
if (!cryptStr.isEmpty()) {
try {
Class cryptClass =
(Class) getClass().getClassLoader().loadClass(cryptStr);
RedkaleClassLoader.putReflectionPublicConstructors(cryptClass, cryptClass.getName());
this.cryptor = cryptClass.getConstructor().newInstance();
} catch (ReflectiveOperationException e) {
throw new RedkaleException(e);
}
}
}
if (cryptor != null) {
if (resourceFactory != null) {
resourceFactory.inject(cryptor);
}
cryptor.init(conf);
}
this.closed = false;
}
@Override
public void destroy(AnyValue conf) {
this.closed = true;
super.destroy(conf);
if (cryptor != null) {
cryptor.destroy(conf);
}
}
public boolean acceptsConf(AnyValue config) {
if (config == null) {
return false;
}
return "redis".equalsIgnoreCase(config.getValue(CACHE_SOURCE_TYPE))
|| getClass().getName().equalsIgnoreCase(config.getValue(CACHE_SOURCE_TYPE))
|| config.getValue(CACHE_SOURCE_NODES, config.getValue("url", ""))
.startsWith("redis://")
|| config.getValue(CACHE_SOURCE_NODES, config.getValue("url", ""))
.startsWith("rediss://");
}
protected ExecutorService pubSubExecutor() {
ExecutorService executor = pubSubExecutor;
if (executor != null) {
return executor;
}
pubSubExecutorLock.lock();
try {
if (pubSubExecutor == null) {
String threadNameFormat = "CacheSource-" + resourceName() + "-SubThread-%s";
Function func = Utility.virtualExecutorFunction();
final AtomicInteger counter = new AtomicInteger();
pubSubExecutor = func == null
? Executors.newFixedThreadPool(Utility.cpus(), r -> {
Thread t = new Thread(r);
t.setDaemon(true);
int c = counter.incrementAndGet();
t.setName(String.format(
threadNameFormat, "Virtual-" + (c < 10 ? ("00" + c) : (c < 100 ? ("0" + c) : c))));
return t;
})
: func.apply(threadNameFormat);
}
executor = pubSubExecutor;
} finally {
pubSubExecutorLock.unlock();
}
return executor;
}
protected String getNodes(AnyValue config) {
return config.getValue(CACHE_SOURCE_NODES, config.getValue("url", ""));
}
@Override
public void close() throws Exception { // 在 Application 关闭时调用
destroy(null);
}
@Override
public String resourceName() {
return name;
}
/**
* 令牌桶算法限流， 返回负数表示无令牌， 其他为有令牌
*
*
* 每秒限制请求1次: rate:1, capacity:1, requested:1
* 每秒限制请求10次: rate:10, capacity:10, requested:1
* 每分钟限制请求1次: rate:1, capacity:60, requested:60
* 每分钟限制请求10次: rate:1, capacity:60, requested:6
* 每小时限制请求1次: rate:1, capacity:3600, requested:3600
* 每小时限制请求10次: rate:1, capacity:3600, requested:360
*
*
* @param key 限流的键
* @param rate 令牌桶每秒填充平均速率
* @param capacity 令牌桶总容量
* @param requested 需要的令牌数
* @return 可用令牌数
*/
@Override
public CompletableFuture rateLimitAsync(
final String key, final long rate, final long capacity, final long requested) {
if (capacity < rate || capacity < requested || rate <= 0 || requested < 0) {
return CompletableFuture.failedFuture(new IllegalArgumentException(
"rate=" + rate + ", capacity=" + capacity + ", requested=" + requested));
}
List keys =
List.of("redkale_rate_limiter.{" + key + "}.tokens", "redkale_rate_limiter.{" + key + "}.timestamp");
return evalAsync(
long.class,
SCRIPT_RATELIMIT,
keys,
String.valueOf(rate),
String.valueOf(capacity),
String.valueOf(requested));
}
public abstract CompletableFuture evalAsync(Type type, String script, List keys, String... args);
protected String decryptValue(String key, RedisCryptor cryptor, String value) {
return cryptor != null ? cryptor.decrypt(key, value) : value;
}
protected T decryptValue(String key, RedisCryptor cryptor, Type type, byte[] bs) {
return decryptValue(key, cryptor, convert, type, bs);
}
protected T decryptValue(String key, RedisCryptor cryptor, Convert c, Type type, byte[] bs) {
if (bs == null) {
return null;
}
if (type == byte[].class) {
return (T) bs;
}
if (cryptor == null && type == String.class) {
return (T) new String(bs, StandardCharsets.UTF_8);
}
if (cryptor == null
|| (type instanceof Class
&& (((Class) type).isPrimitive() || Number.class.isAssignableFrom((Class) type)))) {
return (T) (c == null ? this.convert : c).convertFrom(type, bs);
}
String deval = cryptor.decrypt(key, new String(bs, StandardCharsets.UTF_8));
if (type == String.class) {
return (T) deval;
}
return deval == null
? null
: (T) (c == null ? this.convert : c).convertFrom(type, deval.getBytes(StandardCharsets.UTF_8));
}
protected String encryptValue(String key, RedisCryptor cryptor, String value) {
return cryptor != null ? cryptor.encrypt(key, value) : value;
}
protected byte[] encryptValue(String key, RedisCryptor cryptor, Convert c, T value) {
return encryptValue(key, cryptor, null, c, value);
}
protected byte[] encryptValue(String key, RedisCryptor cryptor, Type type, Convert c, T value) {
if (value == null) {
return null;
}
Type t = type == null ? value.getClass() : type;
if (cryptor == null && t == String.class) {
return value.toString().getBytes(StandardCharsets.UTF_8);
}
byte[] bs = (c == null ? this.convert : c).convertToBytes(t, value);
if (bs.length > 1 && t instanceof Class && !CharSequence.class.isAssignableFrom((Class) t)) {
if (bs[0] == '"' && bs[bs.length - 1] == '"') {
bs = Arrays.copyOfRange(bs, 1, bs.length - 1);
}
}
return encryptValue(key, cryptor, t, bs);
}
protected byte[] encryptValue(String key, RedisCryptor cryptor, Type type, byte[] bs) {
if (bs == null) {
return null;
}
if (cryptor == null
|| (type instanceof Class
&& (((Class) type).isPrimitive() || Number.class.isAssignableFrom((Class) type)))) {
return bs;
}
String enval = cryptor.encrypt(key, new String(bs, StandardCharsets.UTF_8));
return enval == null ? null : enval.getBytes(StandardCharsets.UTF_8);
}
protected T decryptScore(Class scoreType, Double score) {
if (score == null) {
return null;
}
if (scoreType == int.class || scoreType == Integer.class) {
return (T) (Number) score.intValue();
} else if (scoreType == long.class || scoreType == Long.class) {
return (T) (Number) score.longValue();
} else if (scoreType == float.class || scoreType == Float.class) {
return (T) (Number) score.floatValue();
} else if (scoreType == double.class || scoreType == Double.class) {
return (T) (Number) score;
} else {
return JsonConvert.root().convertFrom(scoreType, score.toString());
}
}
protected CompletableFuture returnFutureSize(List> futures) {
return futures == null || futures.isEmpty()
? CompletableFuture.completedFuture(0)
: Utility.allOfFutures(futures).thenApply(v -> futures.size());
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy