This commit is contained in:
2025-11-28 16:23:32 +08:00
commit a9e0e16c29
826 changed files with 89805 additions and 0 deletions

View File

@@ -0,0 +1,40 @@
<?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">
<modelVersion>4.0.0</modelVersion>
<parent>
<artifactId>BladeX-Tool</artifactId>
<groupId>org.springblade</groupId>
<version>${revision}</version>
</parent>
<artifactId>blade-starter-cache</artifactId>
<name>${project.artifactId}</name>
<version>${project.parent.version}</version>
<packaging>jar</packaging>
<dependencies>
<!-- Blade -->
<dependency>
<groupId>org.springblade</groupId>
<artifactId>blade-core-tool</artifactId>
</dependency>
<dependency>
<groupId>org.springblade</groupId>
<artifactId>blade-starter-auth</artifactId>
</dependency>
<!-- Ehcache -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-cache</artifactId>
</dependency>
<!-- Auto -->
<dependency>
<groupId>org.springblade</groupId>
<artifactId>blade-core-auto</artifactId>
<scope>provided</scope>
</dependency>
</dependencies>
</project>

View File

@@ -0,0 +1,39 @@
/**
* BladeX Commercial License Agreement
* Copyright (c) 2018-2099, https://bladex.cn. All rights reserved.
* <p>
* Use of this software is governed by the Commercial License Agreement
* obtained after purchasing a license from BladeX.
* <p>
* 1. This software is for development use only under a valid license
* from BladeX.
* <p>
* 2. Redistribution of this software's source code to any third party
* without a commercial license is strictly prohibited.
* <p>
* 3. Licensees may copyright their own code but cannot use segments
* from this software for such purposes. Copyright of this software
* remains with BladeX.
* <p>
* Using this software signifies agreement to this License, and the software
* must not be used for illegal purposes.
* <p>
* THIS SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY. The author is
* not liable for any claims arising from secondary or illegal development.
* <p>
* Author: Chill Zhuang (bladejava@qq.com)
*/
package org.springblade.core.cache.config;
import org.springframework.boot.autoconfigure.AutoConfiguration;
import org.springframework.cache.annotation.EnableCaching;
/**
* Cache配置类
*
* @author Chill
*/
@EnableCaching
@AutoConfiguration
public class CacheConfiguration {
}

View File

@@ -0,0 +1,61 @@
/**
* BladeX Commercial License Agreement
* Copyright (c) 2018-2099, https://bladex.cn. All rights reserved.
* <p>
* Use of this software is governed by the Commercial License Agreement
* obtained after purchasing a license from BladeX.
* <p>
* 1. This software is for development use only under a valid license
* from BladeX.
* <p>
* 2. Redistribution of this software's source code to any third party
* without a commercial license is strictly prohibited.
* <p>
* 3. Licensees may copyright their own code but cannot use segments
* from this software for such purposes. Copyright of this software
* remains with BladeX.
* <p>
* Using this software signifies agreement to this License, and the software
* must not be used for illegal purposes.
* <p>
* THIS SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY. The author is
* not liable for any claims arising from secondary or illegal development.
* <p>
* Author: Chill Zhuang (bladejava@qq.com)
*/
package org.springblade.core.cache.constant;
/**
* 缓存名
*
* @author Chill
*/
public interface CacheConstant {
String BIZ_CACHE = "blade:biz";
String MENU_CACHE = "blade:menu";
String USER_CACHE = "blade:user";
String DICT_CACHE = "blade:dict";
String FLOW_CACHE = "blade:flow";
String SYS_CACHE = "blade:sys";
String RESOURCE_CACHE = "blade:resource";
String PARAM_CACHE = "blade:param";
String DEFAULT_CACHE = "default:cache";
String RETRY_LIMIT_CACHE = "retry:limit:cache";
String HALF_HOUR = "half:hour";
String HOUR = "hour";
String ONE_DAY = "one:day";
}

View File

@@ -0,0 +1,340 @@
/**
* BladeX Commercial License Agreement
* Copyright (c) 2018-2099, https://bladex.cn. All rights reserved.
* <p>
* Use of this software is governed by the Commercial License Agreement
* obtained after purchasing a license from BladeX.
* <p>
* 1. This software is for development use only under a valid license
* from BladeX.
* <p>
* 2. Redistribution of this software's source code to any third party
* without a commercial license is strictly prohibited.
* <p>
* 3. Licensees may copyright their own code but cannot use segments
* from this software for such purposes. Copyright of this software
* remains with BladeX.
* <p>
* Using this software signifies agreement to this License, and the software
* must not be used for illegal purposes.
* <p>
* THIS SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY. The author is
* not liable for any claims arising from secondary or illegal development.
* <p>
* Author: Chill Zhuang (bladejava@qq.com)
*/
package org.springblade.core.cache.utils;
import org.springblade.core.secure.utils.AuthUtil;
import org.springblade.core.tool.constant.BladeConstant;
import org.springblade.core.tool.utils.*;
import org.springframework.cache.Cache;
import org.springframework.cache.CacheManager;
import org.springframework.lang.Nullable;
import java.lang.reflect.Field;
import java.util.List;
import java.util.concurrent.Callable;
/**
* 缓存工具类
*
* @author Chill
*/
public class CacheUtil {
private static CacheManager cacheManager;
private static final Boolean TENANT_MODE = Boolean.TRUE;
/**
* 获取缓存工具
*
* @return CacheManager
*/
private static CacheManager getCacheManager() {
if (cacheManager == null) {
cacheManager = SpringUtil.getBean(CacheManager.class);
}
return cacheManager;
}
/**
* 获取缓存对象
*
* @param cacheName 缓存名
* @return Cache
*/
public static Cache getCache(String cacheName) {
return getCache(cacheName, TENANT_MODE);
}
/**
* 获取缓存对象
*
* @param cacheName 缓存名
* @param tenantMode 租户模式
* @return Cache
*/
public static Cache getCache(String cacheName, Boolean tenantMode) {
return getCacheManager().getCache(formatCacheName(cacheName, tenantMode));
}
/**
* 获取缓存对象
*
* @param cacheName 缓存名
* @param tenantId 租户ID
* @return Cache
*/
public static Cache getCache(String cacheName, String tenantId) {
return getCacheManager().getCache(formatCacheName(cacheName, tenantId));
}
/**
* 根据租户信息格式化缓存名
*
* @param cacheName 缓存名
* @param tenantMode 租户模式
* @return String
*/
public static String formatCacheName(String cacheName, Boolean tenantMode) {
if (!tenantMode) {
return cacheName;
}
return formatCacheName(cacheName, AuthUtil.getTenantId());
}
/**
* 根据租户信息格式化缓存名
*
* @param cacheName 缓存名
* @param tenantId 租户ID
* @return String
*/
public static String formatCacheName(String cacheName, String tenantId) {
return (StringUtil.isBlank(tenantId) ? cacheName : tenantId.concat(StringPool.COLON).concat(cacheName));
}
/**
* 获取缓存
*
* @param cacheName 缓存名
* @param keyPrefix 缓存键前缀
* @param key 缓存键值
* @return Object
*/
@Nullable
public static Object get(String cacheName, String keyPrefix, Object key) {
return get(cacheName, keyPrefix, key, TENANT_MODE);
}
/**
* 获取缓存
*
* @param cacheName 缓存名
* @param keyPrefix 缓存键前缀
* @param key 缓存键值
* @param tenantMode 租户模式
* @return Object
*/
@Nullable
public static Object get(String cacheName, String keyPrefix, Object key, Boolean tenantMode) {
if (Func.hasEmpty(cacheName, keyPrefix, key)) {
return null;
}
Cache.ValueWrapper valueWrapper = getCache(cacheName, tenantMode).get(keyPrefix.concat(String.valueOf(key)));
if (Func.isEmpty(valueWrapper)) {
return null;
}
return valueWrapper.get();
}
/**
* 获取缓存
*
* @param cacheName 缓存名
* @param keyPrefix 缓存键前缀
* @param key 缓存键值
* @param type 类型
* @param <T> 泛型
* @return T
*/
@Nullable
public static <T> T get(String cacheName, String keyPrefix, Object key, @Nullable Class<T> type) {
return get(cacheName, keyPrefix, key, type, TENANT_MODE);
}
/**
* 获取缓存
*
* @param cacheName 缓存名
* @param keyPrefix 缓存键前缀
* @param key 缓存键值
* @param type 类型
* @param tenantMode 租户模式
* @param <T> 泛型
* @return T
*/
@Nullable
public static <T> T get(String cacheName, String keyPrefix, Object key, @Nullable Class<T> type, Boolean tenantMode) {
if (Func.hasEmpty(cacheName, keyPrefix, key)) {
return null;
}
return getCache(cacheName, tenantMode).get(keyPrefix.concat(String.valueOf(key)), type);
}
/**
* 获取缓存
*
* @param cacheName 缓存名
* @param keyPrefix 缓存键前缀
* @param key 缓存键值
* @param valueLoader 重载对象
* @param <T> 泛型
* @return T
*/
@Nullable
public static <T> T get(String cacheName, String keyPrefix, Object key, Callable<T> valueLoader) {
return get(cacheName, keyPrefix, key, valueLoader, TENANT_MODE);
}
/**
* 获取缓存
*
* @param cacheName 缓存名
* @param keyPrefix 缓存键前缀
* @param key 缓存键值
* @param valueLoader 重载对象
* @param tenantMode 租户模式
* @param <T> 泛型
* @return T
*/
@Nullable
public static <T> T get(String cacheName, String keyPrefix, Object key, Callable<T> valueLoader, Boolean tenantMode) {
if (Func.hasEmpty(cacheName, keyPrefix, key)) {
return null;
}
try {
Cache.ValueWrapper valueWrapper = getCache(cacheName, tenantMode).get(keyPrefix.concat(String.valueOf(key)));
Object value = null;
if (valueWrapper == null) {
T call = valueLoader.call();
if (ObjectUtil.isNotEmpty(call)) {
Field field = ReflectUtil.getField(call.getClass(), BladeConstant.DB_PRIMARY_KEY);
if (ObjectUtil.isNotEmpty(field) && ObjectUtil.isEmpty(ClassUtil.getMethod(call.getClass(), BladeConstant.DB_PRIMARY_KEY_METHOD).invoke(call))) {
return null;
}
getCache(cacheName, tenantMode).put(keyPrefix.concat(String.valueOf(key)), call);
value = call;
}
} else {
value = valueWrapper.get();
}
return (T) value;
} catch (Exception ex) {
ex.printStackTrace();
return null;
}
}
/**
* 设置缓存
*
* @param cacheName 缓存名
* @param keyPrefix 缓存键前缀
* @param key 缓存键值
* @param value 缓存值
*/
public static void put(String cacheName, String keyPrefix, Object key, @Nullable Object value) {
put(cacheName, keyPrefix, key, value, TENANT_MODE);
}
/**
* 设置缓存
*
* @param cacheName 缓存名
* @param keyPrefix 缓存键前缀
* @param key 缓存键值
* @param value 缓存值
* @param tenantMode 租户模式
*/
public static void put(String cacheName, String keyPrefix, Object key, @Nullable Object value, Boolean tenantMode) {
getCache(cacheName, tenantMode).put(keyPrefix.concat(String.valueOf(key)), value);
}
/**
* 清除缓存
*
* @param cacheName 缓存名
* @param keyPrefix 缓存键前缀
* @param key 缓存键值
*/
public static void evict(String cacheName, String keyPrefix, Object key) {
evict(cacheName, keyPrefix, key, TENANT_MODE);
}
/**
* 清除缓存
*
* @param cacheName 缓存名
* @param keyPrefix 缓存键前缀
* @param key 缓存键值
* @param tenantMode 租户模式
*/
public static void evict(String cacheName, String keyPrefix, Object key, Boolean tenantMode) {
if (Func.hasEmpty(cacheName, keyPrefix, key)) {
return;
}
getCache(cacheName, tenantMode).evict(keyPrefix.concat(String.valueOf(key)));
}
/**
* 清空缓存
*
* @param cacheName 缓存名
*/
public static void clear(String cacheName) {
clear(cacheName, TENANT_MODE);
}
/**
* 清空缓存
*
* @param cacheName 缓存名
* @param tenantMode 租户模式
*/
public static void clear(String cacheName, Boolean tenantMode) {
if (Func.isEmpty(cacheName)) {
return;
}
getCache(cacheName, tenantMode).clear();
}
/**
* 清空缓存
*
* @param cacheName 缓存名
* @param tenantId 租户ID
*/
public static void clear(String cacheName, String tenantId) {
if (Func.isEmpty(cacheName)) {
return;
}
getCache(cacheName, tenantId).clear();
}
/**
* 清空缓存
*
* @param cacheName 缓存名
* @param tenantIds 租户ID集合
*/
public static void clear(String cacheName, List<String> tenantIds) {
if (Func.isEmpty(cacheName)) {
return;
}
tenantIds.forEach(tenantId -> getCache(cacheName, tenantId).clear());
}
}