This commit is contained in:
2023-07-13 17:30:09 +08:00
parent 672f66b40e
commit 6ed1224410
373 changed files with 566 additions and 409 deletions

View File

@ -0,0 +1,58 @@
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<parent>
<artifactId>qiaoba-common</artifactId>
<groupId>com.qiaoba</groupId>
<version>1.0</version>
</parent>
<modelVersion>4.0.0</modelVersion>
<artifactId>qiaoba-common-redis</artifactId>
<description>通用-Redis模块</description>
<dependencies>
<!-- lock4j -->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>lock4j-redisson-spring-boot-starter</artifactId>
<exclusions>
<exclusion>
<groupId>org.redisson</groupId>
<artifactId>redisson</artifactId>
</exclusion>
<exclusion>
<groupId>org.redisson</groupId>
<artifactId>redisson-spring-data-30</artifactId>
</exclusion>
</exclusions>
</dependency>
<!--redisson-->
<dependency>
<groupId>org.redisson</groupId>
<artifactId>redisson-spring-boot-starter</artifactId>
<exclusions>
<exclusion>
<groupId>org.redisson</groupId>
<artifactId>redisson-spring-data-30</artifactId>
</exclusion>
</exclusions>
</dependency>
<dependency>
<groupId>org.redisson</groupId>
<artifactId>redisson-spring-data-27</artifactId>
</dependency>
<dependency>
<groupId>com.qiaoba</groupId>
<artifactId>qiaoba-common-base</artifactId>
</dependency>
<!-- Jackson -->
<dependency>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-databind</artifactId>
</dependency>
</dependencies>
</project>

View File

@ -0,0 +1,71 @@
package com.qiaoba.common.redis.config;
import com.fasterxml.jackson.annotation.JsonAutoDetect;
import com.fasterxml.jackson.annotation.PropertyAccessor;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.jsontype.impl.LaissezFaireSubTypeValidator;
import org.springframework.boot.autoconfigure.AutoConfigureBefore;
import org.springframework.boot.autoconfigure.data.redis.RedisAutoConfiguration;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.data.redis.cache.RedisCacheConfiguration;
import org.springframework.data.redis.cache.RedisCacheManager;
import org.springframework.data.redis.cache.RedisCacheWriter;
import org.springframework.data.redis.connection.RedisConnectionFactory;
import org.springframework.data.redis.core.RedisTemplate;
import org.springframework.data.redis.serializer.Jackson2JsonRedisSerializer;
import org.springframework.data.redis.serializer.RedisSerializationContext;
import org.springframework.data.redis.serializer.RedisSerializer;
import org.springframework.data.redis.serializer.StringRedisSerializer;
import java.time.Duration;
/**
* Redis 基础配置
*
* @author ailanyin
* @version 1.0
* @since 2021/10/2 0003 下午 17:44
*/
@Configuration
@AutoConfigureBefore(RedisAutoConfiguration.class)
public class RedisConfig {
@Bean
public RedisTemplate<String, Object> redisTemplate(RedisConnectionFactory redisConnectionFactory) {
RedisSerializer<Object> serializer = redisSerializer();
RedisTemplate<String, Object> redisTemplate = new RedisTemplate<>();
redisTemplate.setConnectionFactory(redisConnectionFactory);
redisTemplate.setKeySerializer(new StringRedisSerializer());
redisTemplate.setValueSerializer(serializer);
redisTemplate.setHashKeySerializer(new StringRedisSerializer());
redisTemplate.setHashValueSerializer(serializer);
redisTemplate.afterPropertiesSet();
return redisTemplate;
}
@Bean
public RedisSerializer<Object> redisSerializer() {
//创建JSON序列化器
Jackson2JsonRedisSerializer<Object> serializer = new Jackson2JsonRedisSerializer<>(Object.class);
ObjectMapper objectMapper = new ObjectMapper();
objectMapper.setVisibility(PropertyAccessor.ALL, JsonAutoDetect.Visibility.ANY);
//实体类存在子类继承父类,必须设置
objectMapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);
//必须设置,否则无法将JSON转化为对象会转化成Map类型
objectMapper.activateDefaultTyping(LaissezFaireSubTypeValidator.instance, ObjectMapper.DefaultTyping.NON_FINAL);
serializer.setObjectMapper(objectMapper);
return serializer;
}
@Bean
public RedisCacheManager redisCacheManager(RedisConnectionFactory redisConnectionFactory) {
RedisCacheWriter redisCacheWriter = RedisCacheWriter.nonLockingRedisCacheWriter(redisConnectionFactory);
//设置Redis缓存有效期为1天
RedisCacheConfiguration redisCacheConfiguration = RedisCacheConfiguration.defaultCacheConfig()
.serializeValuesWith(RedisSerializationContext.SerializationPair.fromSerializer(redisSerializer())).entryTtl(Duration.ofDays(1));
return new RedisCacheManager(redisCacheWriter, redisCacheConfiguration);
}
}

View File

@ -0,0 +1,403 @@
package com.qiaoba.common.redis.service;
import com.qiaoba.common.base.entity.BasePage;
import java.util.Collection;
import java.util.List;
import java.util.Map;
import java.util.Set;
/**
* 自定义Redis接口
*
* @author ailanyin
* @version 1.0
* @since 2021/10/2 0002 下午 17:41
*/
public interface RedisService {
/**
* 保存为 Set
*
* @param key key
* @param value value
* @param time 存活时间 单位秒
*/
void set(String key, Object value, long time);
/**
* 保存为 Set, 永久
*
* @param key key
* @param value value
*/
void set(String key, Object value);
/**
* 通过 key 获取值
*
* @param key key
* @return Object
*/
Object get(String key);
/**
* 删除 key
*
* @param key key
* @return Boolean
*/
Boolean del(String key);
/**
* 批量删除
*
* @param keys keys
*/
void del(Collection<String> keys);
/**
* 设置过期时间
*
* @param key key
* @param time 存活时间 单位秒
* @return Boolean
*/
Boolean expire(String key, long time);
/**
* 获取过期时间
*
* @param key key
* @return long 单位秒
*/
Long getExpire(String key);
/**
* 判断是否有该属性
*
* @param key key
* @return Boolean
*/
Boolean hasKey(String key);
/**
* 按 delta 递增
* <p>
* value = value + delta
*
* @param key key
* @param delta 值
* @return Long 操作后的值
*/
Long incr(String key, long delta);
/**
* 按 delta 递减
* <p>
* value = value - delta
*
* @param key key
* @param delta 值
* @return Long 操作后的值
*/
Long decr(String key, long delta);
/**
* 获取Hash结构中的属性
*
* @param key key
* @param hashKey hashKey
* @return Object
*/
Object hGet(String key, String hashKey);
/**
* 向Hash结构中放入一个属性
*
* @param key key
* @param hashKey hashKey
* @param value value
* @param time 存活时间 单位秒
* @return Boolean
*/
Boolean hSet(String key, String hashKey, Object value, long time);
/**
* 向Hash结构中放入一个属性 永久
*
* @param key key
* @param hashKey hashKey
* @param value value
*/
void hSet(String key, String hashKey, Object value);
/**
* 直接获取整个Hash结构
*
* @param key key
* @return Map<Object, Object>
*/
Map<Object, Object> hGetAll(String key);
/**
* 获取整个hash结构的大小
*
* @param key key
* @return size
*/
Long hSize(String key);
/**
* 直接设置整个Hash结构
*
* @param key key
* @param map map
* @param time 存活时间 单位秒
* @return Boolean
*/
Boolean hSetAll(String key, Map<String, Object> map, long time);
/**
* 直接设置整个Hash结构
*
* @param key key
* @param map map
*/
void hSetAll(String key, Map<String, ?> map);
/**
* 删除Hash结构中的属性
*
* @param key key
* @param hashKey hashKey
*/
void hDel(String key, Object... hashKey);
/**
* 判断Hash结构中是否有该属性
*
* @param key key
* @param hashKey hashKey
* @return Boolean
*/
Boolean hHasKey(String key, String hashKey);
/**
* Hash结构中属性递增
*
* @param key key
* @param hashKey hashKey
* @param delta 数值
* @return 操作后最终的值
*/
Long hIncr(String key, String hashKey, Long delta);
/**
* Hash结构中属性递减
*
* @param key key
* @param hashKey hashKey
* @param delta 数值
* @return 操作后最终的值
*/
Long hDecr(String key, String hashKey, Long delta);
/**
* 获取Set结构
*
* @param key key
* @return Set<Object>
*/
Set<Object> sMembers(String key);
/**
* 向Set结构中添加属性
*
* @param key key
* @param values values
* @return 被添加到集合中的新元素的数量,不包括被忽略的元素
*/
Long sAdd(String key, Object... values);
/**
* 向Set结构中添加属性
*
* @param key key
* @param time 存活时间 单位秒
* @param values values
* @return 被添加到集合中的新元素的数量,不包括被忽略的元素
*/
Long sAdd(String key, long time, Object... values);
/**
* 是否为Set中的属性
*
* @param key key
* @param value value
* @return Boolean
*/
Boolean sIsMember(String key, Object value);
/**
* 获取Set结构的长度
*
* @param key key
* @return Set结构的长度
*/
Long sSize(String key);
/**
* 删除Set结构中的属性
*
* @param key key
* @param values values
* @return 被成功移除的元素的数量,不包括被忽略的元素
*/
Long sRemove(String key, Object... values);
/**
* 获取List结构中的属性
*
* @param key key
* @param start 开始索引
* @param end 结束索引
* @return List<Object>
*/
List<Object> lRange(String key, long start, long end);
/**
* 获取List结构的长度
*
* @param key key
* @return list.size
*/
Long lSize(String key);
/**
* 根据索引获取List中的属性
*
* @param key key
* @param index 索引
* @return Object
*/
Object lIndex(String key, long index);
/**
* 向List结构中添加属性
*
* @param key key
* @param value value
* @return 执行命令后,列表的长度
*/
Long lPush(String key, Object value);
/**
* 向List结构中添加属性
*
* @param key key
* @param value value
* @param time 存活时间 单位秒
* @return 执行命令后,列表的长度
*/
Long lPush(String key, Object value, long time);
/**
* 向List结构中批量添加属性
*
* @param key key
* @param values values
* @return 执行命令后,列表的长度
*/
Long lPushAll(String key, Object... values);
/**
* 向List结构中批量添加属性
*
* @param key key
* @param time 存活时间 单位秒
* @param values values
* @return 执行命令后,列表的长度
*/
Long lPushAll(String key, Long time, Object... values);
/**
* 从List结构中移除属性
*
* @param key key
* @param count 数量
* count > 0 : 从表头开始向表尾搜索,移除与 VALUE 相等的元素,数量为 COUNT 。
* count < 0 : 从表尾开始向表头搜索,移除与 VALUE 相等的元素,数量为 COUNT 的绝对值。
* count = 0 : 移除表中所有与 VALUE 相等的值。
* @param value value
* @return 被移除元素的数量
*/
Long lRemove(String key, long count, Object value);
/**
* 分页查询
*
* @param key key
* @param pageNumber pageNumber
* @param pageSize pageSize
* @return // List<clazz>
*/
BasePage getPageList(String key, long pageNumber, long pageSize);
/**
* 模糊查询所有key
*
* @param key key
* @return keys
*/
Collection<String> getKeys(String key);
/**
* get object
*
* @param key key
* @param clazz clazz
* @param <T> T
* @return clazz
*/
<T> T getObject(String key, Class<T> clazz);
/**
* get list
*
* @param key key
* @param clazz clazz
* @param <T> T
* @return // List<clazz>
*/
<T> List<T> getObjectList(String key, Class<T> clazz);
/**
* hGetObject
*
* @param key key
* @param hashKey hashKey
* @param clazz clazz
* @param <T> T
* @return clazz
*/
<T> T hGetObject(String key, String hashKey, Class<T> clazz);
/**
* key添加租户前缀
*
* @param key key
* @return newKey
*/
String addTenantPrefix(String key);
/**
* key去除租户前缀
*
* @param key key
* @return newKey
*/
String removeTenantPrefix(String key);
}

View File

@ -0,0 +1,276 @@
package com.qiaoba.common.redis.service.impl;
import com.qiaoba.common.base.constant.BaseConstant;
import com.qiaoba.common.base.constant.TenantConstant;
import com.qiaoba.common.base.context.BaseContext;
import com.qiaoba.common.base.entity.BasePage;
import com.qiaoba.common.redis.service.RedisService;
import lombok.RequiredArgsConstructor;
import lombok.extern.slf4j.Slf4j;
import org.springframework.data.redis.core.RedisTemplate;
import org.springframework.stereotype.Service;
import java.util.*;
import java.util.concurrent.TimeUnit;
import java.util.stream.Collectors;
/**
* 自定义Redis接口实现类
*
* @author ailanyin
* @version 1.0
* @since 2021/10/2 0003 下午 17:44
*/
@Service
@RequiredArgsConstructor
@Slf4j
public class RedisServiceImpl implements RedisService {
private final RedisTemplate<String, Object> redisTemplate;
@Override
public void set(String key, Object value, long time) {
redisTemplate.opsForValue().set(addTenantPrefix(key), value, time, TimeUnit.SECONDS);
}
@Override
public void set(String key, Object value) {
redisTemplate.opsForValue().set(addTenantPrefix(key), value);
}
@Override
public Object get(String key) {
return redisTemplate.opsForValue().get(addTenantPrefix(key));
}
@Override
public Boolean del(String key) {
return redisTemplate.delete(addTenantPrefix(key));
}
@Override
public void del(Collection<String> keys) {
List<String> list = keys.stream().map(key -> key = addTenantPrefix(key)).collect(Collectors.toList());
redisTemplate.delete(list);
}
@Override
public Boolean expire(String key, long time) {
return redisTemplate.expire(key, time, TimeUnit.SECONDS);
}
@Override
public Long getExpire(String key) {
return redisTemplate.getExpire(addTenantPrefix(key), TimeUnit.SECONDS);
}
@Override
public Boolean hasKey(String key) {
return redisTemplate.hasKey(addTenantPrefix(key));
}
@Override
public Long incr(String key, long delta) {
return redisTemplate.opsForValue().increment(addTenantPrefix(key), delta);
}
@Override
public Long decr(String key, long delta) {
return redisTemplate.opsForValue().increment(addTenantPrefix(key), -delta);
}
@Override
public Object hGet(String key, String hashKey) {
return redisTemplate.opsForHash().get(addTenantPrefix(key), hashKey);
}
@Override
public Boolean hSet(String key, String hashKey, Object value, long time) {
String newKey = addTenantPrefix(key);
redisTemplate.opsForHash().put(newKey, hashKey, value);
return expire(newKey, time);
}
@Override
public void hSet(String key, String hashKey, Object value) {
redisTemplate.opsForHash().put(addTenantPrefix(key), hashKey, value);
}
@Override
public Map<Object, Object> hGetAll(String key) {
return redisTemplate.opsForHash().entries(addTenantPrefix(key));
}
@Override
public Long hSize(String key) {
return redisTemplate.opsForHash().size(addTenantPrefix(key));
}
@Override
public Boolean hSetAll(String key, Map<String, Object> map, long time) {
String newKey = addTenantPrefix(key);
redisTemplate.opsForHash().putAll(newKey, map);
return expire(newKey, time);
}
@Override
public void hSetAll(String key, Map<String, ?> map) {
redisTemplate.opsForHash().putAll(addTenantPrefix(key), map);
}
@Override
public void hDel(String key, Object... hashKey) {
redisTemplate.opsForHash().delete(addTenantPrefix(key), hashKey);
}
@Override
public Boolean hHasKey(String key, String hashKey) {
return redisTemplate.opsForHash().hasKey(addTenantPrefix(key), hashKey);
}
@Override
public Long hIncr(String key, String hashKey, Long delta) {
return redisTemplate.opsForHash().increment(addTenantPrefix(key), hashKey, delta);
}
@Override
public Long hDecr(String key, String hashKey, Long delta) {
return redisTemplate.opsForHash().increment(addTenantPrefix(key), hashKey, -delta);
}
@Override
public Set<Object> sMembers(String key) {
return redisTemplate.opsForSet().members(addTenantPrefix(key));
}
@Override
public Long sAdd(String key, Object... values) {
return redisTemplate.opsForSet().add(addTenantPrefix(key), values);
}
@Override
public Long sAdd(String key, long time, Object... values) {
String newKey = addTenantPrefix(key);
Long count = redisTemplate.opsForSet().add(newKey, values);
expire(newKey, time);
return count;
}
@Override
public Boolean sIsMember(String key, Object value) {
return redisTemplate.opsForSet().isMember(addTenantPrefix(key), value);
}
@Override
public Long sSize(String key) {
return redisTemplate.opsForSet().size(addTenantPrefix(key));
}
@Override
public Long sRemove(String key, Object... values) {
return redisTemplate.opsForSet().remove(addTenantPrefix(key), values);
}
@Override
public List<Object> lRange(String key, long start, long end) {
return redisTemplate.opsForList().range(addTenantPrefix(key), start, end);
}
@Override
public Long lSize(String key) {
return redisTemplate.opsForList().size(addTenantPrefix(key));
}
@Override
public Object lIndex(String key, long index) {
return redisTemplate.opsForList().index(addTenantPrefix(key), index);
}
@Override
public Long lPush(String key, Object value) {
return redisTemplate.opsForList().rightPush(addTenantPrefix(key), value);
}
@Override
public Long lPush(String key, Object value, long time) {
String newKey = addTenantPrefix(key);
Long index = redisTemplate.opsForList().rightPush(newKey, value);
expire(newKey, time);
return index;
}
@Override
public Long lPushAll(String key, Object... values) {
return redisTemplate.opsForList().rightPushAll(addTenantPrefix(key), values);
}
@Override
public Long lPushAll(String key, Long time, Object... values) {
String newKey = addTenantPrefix(key);
Long count = redisTemplate.opsForList().rightPushAll(newKey, values);
expire(newKey, time);
return count;
}
@Override
public Long lRemove(String key, long count, Object value) {
return redisTemplate.opsForList().remove(addTenantPrefix(key), count, value);
}
@Override
@SuppressWarnings("unchecked")
public BasePage getPageList(String key, long pageNumber, long pageSize) {
//获取数据总量
Long totalCount = redisTemplate.opsForSet().size(key);
if (Objects.isNull(totalCount)) {
return new BasePage(new ArrayList(), 0);
}
//获取当前要取分页数据的游标位置
long start = (pageNumber - 1) * pageSize;
long end = start + pageSize - 1;
//获取当前页分页数据
List<Object> list = redisTemplate.opsForList().range(key, start, end);
return new BasePage(list, totalCount);
}
@Override
public Collection<String> getKeys(String key) {
return redisTemplate.keys(addTenantPrefix(key));
}
@Override
@SuppressWarnings("unchecked")
public <T> T getObject(String key, Class<T> clazz) {
return (T) get(key);
}
@Override
@SuppressWarnings("unchecked")
public <T> List<T> getObjectList(String key, Class<T> clazz) {
return (List<T>) get(key);
}
@Override
@SuppressWarnings("unchecked")
public <T> T hGetObject(String key, String hashKey, Class<T> clazz) {
return (T) hGet(key, hashKey);
}
@Override
public String addTenantPrefix(String key) {
StringBuilder sb = new StringBuilder();
sb.append(TenantConstant.TENANT_KEY_PREFIX).append(BaseContext.getTenantId()).append(BaseConstant.COLON_JOIN_STR).append(key);
log.debug("拼接后的RedisKey: {}", sb.toString());
return sb.toString();
}
@Override
public String removeTenantPrefix(String key) {
StringBuilder sb = new StringBuilder();
sb.append(TenantConstant.TENANT_KEY_PREFIX).append(BaseContext.getTenantId()).append(BaseConstant.COLON_JOIN_STR);
log.debug("去除拼接后的RedisKey: {}", key.replace(sb.toString(), ""));
return key.replace(sb.toString(), "");
}
}

View File

@ -0,0 +1,5 @@
org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
com.qiaoba.common.redis.config.RedisConfig,\
com.qiaoba.common.redis.service.impl.RedisServiceImpl