RedisTemplate常用方法封裝
序列化和配置
package com.gitee.ccsert.mall.common.redis.config;
import com.fasterxml.jackson.annotation.JsonAutoDetect;
import com.fasterxml.jackson.annotation.PropertyAccessor;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.jsontype.impl.LaissezFaireSubTypeValidator;
import com.gitee.ccsert.mall.common.redis.RedisService;
import com.gitee.ccsert.mall.common.redis.impl.RedisServiceImpl;
import org.springframework.context.annotation.Bean;
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;
/**
* ClassName: RedisConfig <br/>
* Description: redis連接配置類 <br/>
*/
@Configuration
public class BaseRedisConfig {
@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);
//必須設置，否則無法將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);
}
@Bean
public RedisService redisService(){
return new RedisServiceImpl();
}
}
接口
package com.gitee.ccsert.mall.common.redis;
import org.springframework.data.domain.Sort;
import org.springframework.data.geo.Distance;
import org.springframework.data.geo.GeoResults;
import org.springframework.data.geo.Point;
import org.springframework.data.redis.connection.RedisGeoCommands;
import java.util.List;
import java.util.Map;
import java.util.Set;
/**
* ClassName: RedisService <br/>
* Description: redis操作接口 <br/>
*/
public interface RedisService {
/**
* 保存屬性
*
* @param key key值
* @param value value值
* @param time 時間戳
*/
void set(String key, Object value, long time);
/**
* 保存屬性
*
* @param key key值
* @param value value值
*/
void set(String key, Object value);
/**
* 獲取屬性
*
* @param key key值
* @return 返回對象
*/
Object get(String key);
/**
* 刪除屬性
*
* @param key key值
* @return 返回成功
*/
Boolean del(String key);
/**
* 批量刪除屬性
*
* @param keys key值集合
* @return 返回刪除數量
*/
Long del(List<String> keys);
/**
* 設置過期時間
*
* @param key key值
* @param time 時間戳
* @return 返回成功
*/
Boolean expire(String key, long time);
/**
* 獲取過期時間
*
* @param key key值
* @return 返回時間戳
*/
Long getExpire(String key);
/**
* 判斷key是否存在
*
* @param key key值
* @return 返回
*/
Boolean hasKey(String key);
/**
* 按delta遞增
*
* @param key key值
* @param delta delta值
* @return 返回遞增后結果
*/
Long incr(String key, long delta);
/**
* 按delta遞減
*
* @param key key值
* @param delta delta值
* @return 返回遞減后結果
*/
Long decr(String key, long delta);
/**
* 獲取Hash結構中的屬性
*
* @param key 外部key值
* @param hashKey 內部key值
* @return 返回內部key的value
*/
Object hGet(String key, String hashKey);
/**
* 向Hash結構中放入一個屬性
*
* @param key 外部key
* @param hashKey 內部key
* @param value 內部key的value
* @param time 過期時間
* @return 返回是否成功
*/
Boolean hSet(String key, String hashKey, Object value, long time);
/**
* 向Hash結構中放入一個屬性
*
* @param key 外部key
* @param hashKey 內部key
* @param value 內部key的value
*/
void hSet(String key, String hashKey, Object value);
/**
* 直接獲取整個Hash結構
*
* @param key 外部key值
* @return 返回hashMap
*/
Map<Object, Object> hGetAll(String key);
/**
* 直接設置整個Hash結構
*
* @param key 外部key
* @param map hashMap值
* @param time 過期時間
* @return 返回是否成功
*/
Boolean hSetAll(String key, Map<String, Object> map, long time);
/**
* 直接設置整個Hash結構
*
* @param key 外部key
* @param map hashMap值
*/
void hSetAll(String key, Map<String, ?> map);
/**
* 刪除Hash結構中的屬性
*
* @param key 外部key值
* @param hashKey 內部key值
*/
void hDel(String key, Object... hashKey);
/**
* 判斷Hash結構中是否有該屬性
*
* @param key 外部key
* @param hashKey 內部key
* @return 返回是否存在
*/
Boolean hHasKey(String key, String hashKey);
/**
* Hash結構中屬性遞增
*
* @param key 外部key
* @param hashKey 內部key
* @param delta 遞增條件
* @return 返回遞增后的數據
*/
Long hIncr(String key, String hashKey, Long delta);
/**
* Hash結構中屬性遞減
*
* @param key 外部key
* @param hashKey 內部key
* @param delta 遞增條件
* @return 返回遞減后的數據
*/
Long hDecr(String key, String hashKey, Long delta);
/**
* 獲取Set結構
*
* @param key key
* @return 返回set集合
*/
Set<Object> sMembers(String key);
/**
* 向Set結構中添加屬性
*
* @param key key
* @param values value集
* @return 返回增加數量
*/
Long sAdd(String key, Object... values);
/**
* 向Set結構中添加屬性
*
* @param key key
* @param time 過期時間
* @param values 值集合
* @return 返回添加的數量
*/
Long sAdd(String key, long time, Object... values);
/**
* 是否為Set中的屬性
*
* @param key key
* @param value value
* @return 返回是否存在
*/
Boolean sIsMember(String key, Object value);
/**
* 獲取Set結構的長度
*
* @param key key
* @return 返回長度
*/
Long sSize(String key);
/**
* 刪除Set結構中的屬性
*
* @param key key
* @param values value集合
* @return 刪除掉的數據量
*/
Long sRemove(String key, Object... values);
/**
* 獲取List結構中的屬性
*
* @param key key
* @param start 開始
* @param end 結束
* @return 返回查詢的集合
*/
List<Object> lRange(String key, long start, long end);
/**
* 獲取List結構的長度
*
* @param key key
* @return 長度
*/
Long lSize(String key);
/**
* 根據索引獲取List中的屬性
*
* @param key key
* @param index 索引
* @return 對象
*/
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 value 集合
* @return 增加后的長度
*/
Long lPushAll(String key, Object... values);
/**
* 向List結構中批量添加屬性
*
* @param key key
* @param time 過期時間
* @param values value集合
* @return 增加后的長度
*/
Long lPushAll(String key, Long time, Object... values);
/**
* 從List結構中移除屬性
*
* @param key key
* @param count 總量
* @param value value
* @return 返回刪除后的長度
*/
Long lRemove(String key, long count, Object value);
/**
* 向bitmap中新增值
*
* @param key key
* @param offset 偏移量
* @param b 狀態
* @return 結果
*/
Boolean bitAdd(String key, int offset, boolean b);
/**
* 從bitmap中獲取偏移量的值
*
* @param key key
* @param offset 偏移量
* @return 結果
*/
Boolean bitGet(String key, int offset);
/**
* 獲取bitmap的key值總和
*
* @param key key
* @return 總和
*/
Long bitCount(String key);
/**
* 獲取bitmap范圍值
*
* @param key key
* @param limit 范圍
* @param offset 開始偏移量
* @return long類型集合
*/
List<Long> bitField(String key, int limit, int offset);
/**
* 獲取所有bitmap
*
* @param key key
* @return 以二進制字節數組返回
*/
byte[] bitGetAll(String key);
/**
* 增加坐標
*
* @param key key
* @param x x
* @param y y
* @param name 地點名稱
* @return 返回結果
*/
Long geoAdd(String key, Double x, Double y, String name);
/**
* 根據城市名稱獲取坐標集合
*
* @param key key
* @param place 地點
* @return 坐標集合
*/
List<Point> geoGetPointList(String key, Object... place);
/**
* 計算兩個城市之間的距離
*
* @param key key
* @param placeOne 地點1
* @param placeTow 地點2
* @return 返回距離
*/
Distance geoCalculationDistance(String key, String placeOne, String placeTow);
/**
* 獲取附該地點附近的其他地點
*
* @param key key
* @param place 地點
* @param distance 附近的范圍
* @param limit 查幾條
* @param sort 排序規則
* @return 返回附近的地點集合
*/
GeoResults<RedisGeoCommands.GeoLocation<Object>> geoNearByPlace(String key, String place, Distance distance, long limit, Sort.Direction sort);
/**
* 獲取地點的hash
*
* @param key key
* @param place 地點
* @return 返回集合
*/
List<String> geoGetHash(String key, String... place);
}
實現
package com.gitee.ccsert.mall.common.redis.impl;
import com.gitee.ccsert.mall.common.redis.RedisService;
import org.springframework.data.domain.Sort;
import org.springframework.data.geo.Distance;
import org.springframework.data.geo.GeoResults;
import org.springframework.data.geo.Point;
import org.springframework.data.redis.connection.BitFieldSubCommands;
import org.springframework.data.redis.connection.RedisGeoCommands;
import org.springframework.data.redis.core.RedisCallback;
import org.springframework.data.redis.core.RedisTemplate;
import javax.annotation.Resource;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.concurrent.TimeUnit;
/**
* ClassName: RedisServiceImpl <br/>
* Description: redis操作的具體時間類 <br/>
*/
public class RedisServiceImpl implements RedisService {
@Resource
private RedisTemplate<String, Object> redisTemplate;
@Override
public void set(String key, Object value, long time) {
redisTemplate.opsForValue().set(key, value, time, TimeUnit.SECONDS);
}
@Override
public void set(String key, Object value) {
redisTemplate.opsForValue().set(key, value);
}
@Override
public Object get(String key) {
return redisTemplate.opsForValue().get(key);
}
@Override
public Boolean del(String key) {
return redisTemplate.delete(key);
}
@Override
public Long del(List<String> keys) {
return redisTemplate.delete(keys);
}
@Override
public Boolean expire(String key, long time) {
return redisTemplate.expire(key, time, TimeUnit.SECONDS);
}
@Override
public Long getExpire(String key) {
return redisTemplate.getExpire(key, TimeUnit.SECONDS);
}
@Override
public Boolean hasKey(String key) {
return redisTemplate.hasKey(key);
}
@Override
public Long incr(String key, long delta) {
return redisTemplate.opsForValue().increment(key, delta);
}
@Override
public Long decr(String key, long delta) {
return redisTemplate.opsForValue().increment(key, -delta);
}
@Override
public Object hGet(String key, String hashKey) {
return redisTemplate.opsForHash().get(key, hashKey);
}
@Override
public Boolean hSet(String key, String hashKey, Object value, long time) {
redisTemplate.opsForHash().put(key, hashKey, value);
return expire(key, time);
}
@Override
public void hSet(String key, String hashKey, Object value) {
redisTemplate.opsForHash().put(key, hashKey, value);
}
@Override
public Map<Object, Object> hGetAll(String key) {
return redisTemplate.opsForHash().entries(key);
}
@Override
public Boolean hSetAll(String key, Map<String, Object> map, long time) {
redisTemplate.opsForHash().putAll(key, map);
return expire(key, time);
}
@Override
public void hSetAll(String key, Map<String, ?> map) {
redisTemplate.opsForHash().putAll(key, map);
}
@Override
public void hDel(String key, Object... hashKey) {
redisTemplate.opsForHash().delete(key, hashKey);
}
@Override
public Boolean hHasKey(String key, String hashKey) {
return redisTemplate.opsForHash().hasKey(key, hashKey);
}
@Override
public Long hIncr(String key, String hashKey, Long delta) {
return redisTemplate.opsForHash().increment(key, hashKey, delta);
}
@Override
public Long hDecr(String key, String hashKey, Long delta) {
return redisTemplate.opsForHash().increment(key, hashKey, -delta);
}
@Override
public Set<Object> sMembers(String key) {
return redisTemplate.opsForSet().members(key);
}
@Override
public Long sAdd(String key, Object... values) {
return redisTemplate.opsForSet().add(key, values);
}
@Override
public Long sAdd(String key, long time, Object... values) {
Long count = redisTemplate.opsForSet().add(key, values);
expire(key, time);
return count;
}
@Override
public Boolean sIsMember(String key, Object value) {
return redisTemplate.opsForSet().isMember(key, value);
}
@Override
public Long sSize(String key) {
return redisTemplate.opsForSet().size(key);
}
@Override
public Long sRemove(String key, Object... values) {
return redisTemplate.opsForSet().remove(key, values);
}
@Override
public List<Object> lRange(String key, long start, long end) {
return redisTemplate.opsForList().range(key, start, end);
}
@Override
public Long lSize(String key) {
return redisTemplate.opsForList().size(key);
}
@Override
public Object lIndex(String key, long index) {
return redisTemplate.opsForList().index(key, index);
}
@Override
public Long lPush(String key, Object value) {
return redisTemplate.opsForList().rightPush(key, value);
}
@Override
public Long lPush(String key, Object value, long time) {
Long index = redisTemplate.opsForList().rightPush(key, value);
expire(key, time);
return index;
}
@Override
public Long lPushAll(String key, Object... values) {
return redisTemplate.opsForList().rightPushAll(key, values);
}
@Override
public Long lPushAll(String key, Long time, Object... values) {
Long count = redisTemplate.opsForList().rightPushAll(key, values);
expire(key, time);
return count;
}
@Override
public Long lRemove(String key, long count, Object value) {
return redisTemplate.opsForList().remove(key, count, value);
}
@Override
public Boolean bitAdd(String key, int offset, boolean b) {
return redisTemplate.opsForValue().setBit(key, offset, b);
}
@Override
public Boolean bitGet(String key, int offset) {
return redisTemplate.opsForValue().getBit(key, offset);
}
@Override
public Long bitCount(String key) {
return redisTemplate.execute((RedisCallback<Long>) con -> con.bitCount(key.getBytes()));
}
@Override
public List<Long> bitField(String key, int limit, int offset) {
return redisTemplate.execute((RedisCallback<List<Long>>) con ->
con.bitField(key.getBytes(),
BitFieldSubCommands.create().get(BitFieldSubCommands.BitFieldType.unsigned(limit)).valueAt(offset)));
}
@Override
public byte[] bitGetAll(String key) {
return redisTemplate.execute((RedisCallback<byte[]>) con -> con.get(key.getBytes()));
}
@Override
public Long geoAdd(String key, Double x, Double y, String name) {
return redisTemplate.opsForGeo().add(key, new Point(x, y), name);
}
@Override
public List<Point> geoGetPointList(String key, Object... place) {
return redisTemplate.opsForGeo().position(key, place);
}
@Override
public Distance geoCalculationDistance(String key, String placeOne, String placeTow) {
return redisTemplate.opsForGeo()
.distance(key, placeOne, placeTow, RedisGeoCommands.DistanceUnit.KILOMETERS);
}
@Override
public GeoResults<RedisGeoCommands.GeoLocation<Object>> geoNearByPlace(String key, String place, Distance distance, long limit, Sort.Direction sort) {
RedisGeoCommands.GeoRadiusCommandArgs args = RedisGeoCommands.GeoRadiusCommandArgs.newGeoRadiusArgs().includeDistance().includeCoordinates();
// 判斷排序方式
if (Sort.Direction.ASC == sort) {
args.sortAscending();
} else {
args.sortDescending();
}
args.limit(limit);
return redisTemplate.opsForGeo()
.radius(key, place, distance, args);
}
@Override
public List<String> geoGetHash(String key, String... place) {
return redisTemplate.opsForGeo()
.hash(key, place);
}
}
