cn.stylefeng.roses.kernel.cache.api.CacheOperatorApi Maven / Gradle / Ivy
/*
* Copyright [2020-2030] [https://www.stylefeng.cn]
*
* 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.
*
* Guns采用APACHE LICENSE 2.0开源协议，您在使用过程中，需要注意以下几点：
*
* 1.请不要删除和修改根目录下的LICENSE文件。
* 2.请不要删除和修改Guns源码头部的版权声明。
* 3.请保留源码和相关描述文件的项目出处，作者声明等。
* 4.分发源码时候，请注明软件出处 https://gitee.com/stylefeng/guns
* 5.在修改包名，模块名称，项目代码等时，请注明软件出处 https://gitee.com/stylefeng/guns
* 6.若您的项目无法满足以上几点，可申请商业授权
*/
package cn.stylefeng.roses.kernel.cache.api;
import cn.hutool.core.util.ObjectUtil;
import cn.hutool.core.util.StrUtil;
import java.util.Collection;
import java.util.Map;
import static cn.stylefeng.roses.kernel.cache.api.constants.CacheConstants.CACHE_DELIMITER;
/**
* 缓存操作的基础接口，可以实现不同种缓存实现
*
* 泛型为cache的值类class类型
*
* @author stylefeng
* @since 2020/7/8 22:02
*/
public interface CacheOperatorApi {
/**
* 添加缓存
*
* @param key 键
* @param value 值
* @author stylefeng
* @since 2020/7/8 22:06
*/
void put(String key, T value);
/**
* 添加缓存（带过期时间，单位是秒）
*
* @param key 键
* @param value 值
* @param timeoutSeconds 过期时间，单位秒
* @author stylefeng
* @since 2020/7/8 22:07
*/
void put(String key, T value, Long timeoutSeconds);
/**
* 通过缓存key获取缓存
*
* @param key 键
* @return 值
* @author stylefeng
* @since 2020/7/8 22:08
*/
T get(String key);
/**
* 删除缓存
*
* @param key 键，多个
* @author stylefeng
* @since 2020/7/8 22:09
*/
void remove(String... key);
/**
* 删除缓存
*
* @param keys 多个键集合
* @author fengshuonan
* @since 2023/7/14 17:35
*/
void remove(Collection keys);
/**
* 删除缓存
*
* @param key 键，多个
* @author stylefeng
* @since 2020/7/8 22:09
*/
void expire(String key, Long expiredSeconds);
/**
* 判断某个key值是否存在于缓存
*
* @param key 缓存的键
* @return true-存在，false-不存在
* @author fengshuonan
* @since 2020/11/20 16:50
*/
boolean contains(String key);
/**
* 获得缓存的所有key列表（不带common prefix的）
*
* @return key列表
* @author stylefeng
* @since 2020/7/8 22:11
*/
Collection getAllKeys();
/**
* 获得缓存的所有值列表
*
* @return 值列表
* @author stylefeng
* @since 2020/7/8 22:11
*/
Collection getAllValues();
/**
* 获取所有的key，value
*
* @return 键值map
* @author stylefeng
* @since 2020/7/8 22:11
*/
Map getAllKeyValues();
/**
* 通用缓存的前缀，用于区分不同业务
*
* 如果带了前缀，所有的缓存在添加的时候，key都会带上这个前缀
*
* @return 缓存前缀
* @author stylefeng
* @since 2020/7/9 11:06
*/
String getCommonKeyPrefix();
/**
* 获取最终的计算前缀
*
* key的组成方式：租户前缀:业务前缀:业务key
*
* @author fengshuonan
* @since 2022/11/9 10:41
*/
default String getFinalPrefix() {
return getCommonKeyPrefix() + CACHE_DELIMITER;
}
/**
* 计算最终插入缓存的key值
*
* key的组成方式：租户前缀:业务前缀:业务key
*
* @param keyParam 用户传递的key参数
* @return 最终插入缓存的key值
* @author fengshuonan
* @since 2021/7/30 21:18
*/
default String calcKey(String keyParam) {
if (StrUtil.isEmpty(keyParam)) {
return getFinalPrefix();
} else {
return getFinalPrefix() + keyParam;
}
}
/**
* 删除缓存key的前缀，返回用户最原始的key
*
* @param finalKey 最终存在CacheOperator的key
* @return 用户最原始的key
* @author fengshuonan
* @since 2022/11/9 10:31
*/
default String removePrefix(String finalKey) {
if (ObjectUtil.isEmpty(finalKey)) {
return "";
}
return StrUtil.removePrefix(finalKey, getFinalPrefix());
}
}