• Home
• io.github.panxiaochao
• pxc-framework-redis
• 2.0.4
• source code
• RedissonUtil.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

io.github.panxiaochao.redis.utils.RedissonUtil Maven / Gradle / Ivy

/*
 * Copyright © 2022-2023 Lypxc ([email protected])
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package io.github.panxiaochao.redis.utils;

import io.github.panxiaochao.core.utils.JacksonUtil;
import io.github.panxiaochao.core.utils.SpringContextUtil;
import io.github.panxiaochao.core.utils.StrUtil;
import io.github.panxiaochao.core.utils.StringPools;
import io.github.panxiaochao.redis.utils.function.RLockTryFail;
import io.github.panxiaochao.redis.utils.function.RLockTrySuccess;
import org.redisson.api.*;
import org.redisson.api.geo.GeoSearchArgs;
import org.redisson.codec.JsonJacksonCodec;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.time.Duration;
import java.util.*;
import java.util.concurrent.TimeUnit;
import java.util.function.Consumer;

/**
 * 

 * Redisson 工具类
 * 
 *
 * @author Lypxc
 * @since 2023-06-27
 */
public class RedissonUtil {

	/**
	 * LOGGER RedissonUtil.class
	 */
	private static final Logger LOGGER = LoggerFactory.getLogger(RedissonUtil.class);

	/**
	 * constructor private
	 */
	private RedissonUtil() {
	}

	/**
	 * 初始化
	 */
	private static final RedissonUtil REDISSON_UTIL = new RedissonUtil();

	/**
	 * RedissonClient properties
	 */
	private RedissonClient redissonClient;

	/**
	 * 自己手动初始化 RedissonClient Bean instance
	 * @param redissonClient RedissonClient
	 * @return RedissonUtil
	 */
	public RedissonUtil initRedissonClient(RedissonClient redissonClient) {
		this.redissonClient = redissonClient;
		return this;
	}

	/**
	 * Obtain static RedissonUtil instance
	 * @return RedissonUtil
	 */
	public static RedissonUtil INSTANCE() {
		return REDISSON_UTIL;
	}

	/**
	 * Obtain RedissonClient
	 * @return RedissonClient
	 */
	public RedissonClient ofRedissonClient() {
		final RedissonClient redissonClient = Optional.ofNullable(this.redissonClient)
			.orElseGet(() -> SpringContextUtil.getBean(RedissonClient.class));
		Objects.requireNonNull(redissonClient,
				"RedissonClient is null, check env is a web application or iniRedissonClient ！");
		return redissonClient;
	}

	/**
	 * Returns id of this Redisson instance ID
	 * @return String
	 */
	public String getRedissonId() {
		return ofRedissonClient().getId();
	}

	// ------------------------------- Object 类型操作 --------------------------------

	/**
	 * set the value
	 * @param key key
	 * @param value T value
	 */
	public  void set(String key, T value) {
		set(key, value, Duration.ofMillis(0));
	}

	/**
	 * Obtain the v
	 * @param key key
	 * @return value
	 */
	public  T get(String key) {
		RBucket rBucket = getRBucket(key);
		return rBucket.get();
	}

	/**
	 * Sets value with defined duration only if object holder doesn't exist.
	 * @param key key
	 * @param value value to set
	 * @param duration expiration duration
	 * @return {@code true} if successful, or {@code false} if element was already set
	 */
	public  boolean setIfAbsent(String key, T value, Duration duration) {
		return getRBucket(key).setIfAbsent(value, duration);
	}

	/**
	 * Set the value.
	 * @param key key
	 * @param value T value
	 * @param duration expiration duration
	 */
	public  void set(String key, T value, Duration duration) {
		if (duration.toMillis() <= 0) {
			getRBucket(key).set(value);
		}
		else {
			RBatch batch = ofRBatch();
			RBucketAsync bucket = batch.getBucket(key);
			bucket.setAsync(value);
			bucket.expireAsync(duration);
			batch.execute();
		}
	}

	/**
	 * delete the object from the key.
	 * @param key key
	 * @return true or false
	 */
	public boolean delete(String key) {
		return getRBucket(key).delete();
	}

	/**
	 * delete the Collection object from the key
	 * @param collection collection
	 */
	public void delete(Collection collection) {
		RBatch batch = ofRBatch();
		collection.forEach(key -> {
			batch.getBucket(key.toString()).deleteAsync();
		});
		batch.execute();
	}

	/**
	 * Obtain the RBucket.
	 * @param name name of object
	 * @return RBucket
	 */
	private  RBucket getRBucket(String name) {
		return ofRedissonClient().getBucket(name);
	}

	// ------------------------------- 管道 类型操作 --------------------------------

	/**
	 * Obtain the RBatch
	 * @return RBatch
	 */
	private RBatch ofRBatch() {
		return ofRedissonClient().createBatch();
	}

	// ------------------------------- 限流 类型操作 --------------------------------

	/**
	 * 限流.
	 * @param key 限流key
	 * @param rateType 限流类型
	 * @param rate 速率
	 * @param rateInterval 速率间隔
	 * @return -1 表示失败
	 */
	public long setRateLimiter(String key, RateType rateType, long rate, long rateInterval) {
		RRateLimiter rateLimiter = getRRateLimiter(key);
		boolean trySetRateSuccess = rateLimiter.trySetRate(rateType, rate, rateInterval, RateIntervalUnit.SECONDS);
		// 第一次成功 拿锁后进行设置过期时间
		if (trySetRateSuccess) {
			// 设置过期时间，和速率一样，防止缓存残留
			rateLimiter.expire(Duration.ofSeconds(rateInterval));
		}
		if (rateLimiter.tryAcquire()) {
			return rateLimiter.availablePermits();
		}
		else {
			return -1L;
		}
	}

	/**
	 * Obtain the RRateLimiter.
	 * @param name name of object
	 * @return RRateLimiter
	 */
	private RRateLimiter getRRateLimiter(String name) {
		return ofRedissonClient().getRateLimiter(name);
	}

	// ------------------------------- 二进制流 类型操作 --------------------------------

	/**
	 * Obtain the RBinaryStream.
	 * @param name name of object
	 * @return RBinaryStream
	 */
	private RBinaryStream getRBinaryStream(String name) {
		return ofRedissonClient().getBinaryStream(name);
	}

	// ------------------------------- List 类型操作 --------------------------------

	/**
	 * Obtain the getRList.
	 * @param name name of object
	 * @return getRList
	 */
	private  RList getRList(String name) {
		return ofRedissonClient().getList(name);
	}

	// ------------------------------- Set 类型操作 --------------------------------

	/**
	 * Obtain the RSet.
	 * @param name name of object
	 * @return RSet
	 */
	private  RSet getRSet(String name) {
		return ofRedissonClient().getSet(name);
	}

	// ------------------------------- Map 类型操作 --------------------------------

	/**
	 * Obtain the RMap.
	 * @param name name of object
	 * @return RMap
	 */
	private  RMap getRMap(String name) {
		return ofRedissonClient().getMap(name);
	}

	// ------------------------------- MapCache 类型操作 --------------------------------

	/**
	 * Obtain the RMapCache.
	 * @param name name of object
	 * @return RMapCache
	 */
	private  RMapCache getRMapCache(String name) {
		return ofRedissonClient().getMapCache(name);
	}

	// ------------------------------- 原子Long 类型操作 --------------------------------

	/**
	 * Obtain the RAtomicLong.
	 * @param name name of object
	 * @return RAtomicLong
	 */
	private RAtomicLong getRAtomicLong(String name) {
		return ofRedissonClient().getAtomicLong(name);
	}

	// ------------------------------- 字节 类型操作 --------------------------------

	/**
	 * Obtain the RBitSet.
	 * @param name name of object
	 * @return RBitSet
	 */
	private RBitSet getRBitSet(String name) {
		return ofRedissonClient().getBitSet(name);
	}

	// ------------------------------- 地理位置GEO 类型操作 --------------------------------

	/**
	 * 将指定的地理空间位置（纬度、经度、名称）添加到指定的key中.
	 * @param key 名称KEY
	 * @param lng 经度
	 * @param lat 纬度
	 * @param member 成员名称
	 * @return 添加元素个数
	 */
	public Long geoAdd(String key, double lng, double lat, Object member) {
		RGeo