[缓存工具类.pdf](http://tmpbbs.ztc.ztccloud.com.cn:6875/developers-server/rest/file/group1/2023/02/26/A04ABFCB175FE4E4A3D1B1B7B2AE02F8.pdf) **缓存查询工具类（支持V2.0.5(含)版本及以后）** | **类名** | **类说明** | | ---------------------------------------- | ----------------------------------------------------------------- | | **cn.ztessc.cache.util.CacheUtil** | **会从Redis中获取翻译字段,Redis中如果不存在则会查询数据库** | ## 一.CacheUtil查询缓存 ### 1.根据ID查询缓存 **适用场景：根据主键ID获取数据** ``` /** * 根据ID查询缓存 * * @param cacheDataType 缓存类型 * @param id ID * @return */ public SimpleObjCacheDto findById(CacheDataType cacheDataType, String id); ``` ``` /** * 根据缓存类型+ID集合查询缓存 *

适用于根据ID查询数据的场景，如：根据用户ID查询用户信息

优先从Redis中获取数据，Redis中没有时，从数据库查询并放入Redis

* * @param cacheDataType 缓存类型 * @param ids ID集合 * @return java.util.Map * @author 曾俊 * @date 2021/02/23 */ public Map findByIds(CacheDataType cacheDataType, List ids); ``` ``` /** * 根据缓存类型+ID集合查询缓存 *

适用于根据ID查询数据的场景，如：根据用户ID查询用户信息

优先从Redis中获取数据，Redis中没有时，从数据库查询并放入Redis

* * @param ids 需要查询的ID集合，格式：Map<缓存类型, ID集合> * @return java.util.Map * @author 曾俊 * @date 2021/02/23 */ public Map findByIds(Map> ids) ``` ### 2.根据Code查询缓存 **适用场景：根据编码获取数据，编码+集团ID是唯一的情况下。如：员工、用户** ``` /** * 根据编码+集团ID查询缓存 * * @param cacheDataType 缓存类型 * @param code 编码 * @param groupId 集团ID * @return */ public SimpleObjCacheDto findByCode(CacheDataType cacheDataType, String code, String groupId) ``` ``` /** * 根据缓存类型+CODE集合查询缓存 *

适用于根据编码查询数据的场景，如:根据员工工号查询员工

优先从Redis中获取数据，Redis中没有时，从数据库查询并放入Redis

* * @param cacheDataType 缓存类型 * @param codes 编码集合 * @param groupId 集团ID * @return java.util.Map * @author 曾俊 * @date 2021/02/23 */ public Map findByCodes(CacheDataType cacheDataType, List codes, String groupId) ``` ``` /** * 根据缓存类型+CODE集合查询缓存 *

适用于根据编码查询数据的场景，如:根据员工工号查询员工

优先从Redis中获取数据，Redis中没有时，从数据库查询并放入Redis

* * @param codes 需要查询的编码集合，格式：Map<缓存类型, 编码集合> * @param groupId 集团ID * @return java.util.Map * @author 曾俊 * @date 2021/02/23 */ public Map findByCodes(Map> codes, String groupId) ``` ### 3.根据ParentCode+Code查询缓存 **适用场景：根据父编码+子编码获取数据，父编码+子编码+集团ID是唯一的情况下。如：快速编码** ``` /** * 根据缓存类型+父编码+子编码查询缓存 *

适用于根据父编码+编码查询数据的场景，如：根据快速编码类型+快速编码查询，根据维度类型+维度成员编码查询等

优先从Redis中获取数据，Redis中没有时，从数据库查询并放入Redis

* * @param cacheDataType 缓存类型 * @param parentCode 父编码 * @param code 子编码 * @param groupId 集团ID * @return cn.ztessc.cache.dto.SimpleObjCacheDto * @author 曾俊 * @date 2021/02/23 */ public SimpleObjCacheDto findByParentAndCodes(CacheDataType cacheDataType, String parentCode, String code, String groupId) ``` ``` /** * 根据缓存类型+父编码+子编码集合查询缓存 *

适用于根据父编码+编码查询数据的场景，如：根据快速编码类型+快速编码查询，根据维度类型+维度成员编码查询等

优先从Redis中获取数据，Redis中没有时，从数据库查询并放入Redis

* * @param codes 需要查询的子编码集合，格式：Map<缓存类型, 子编码集合> * @param parentCode 父编码 * @param groupId 集团ID * @return java.util.Map<子编码, SimpleObjCacheDto> * @author 曾俊 * @date 2021/02/23 */ public Map findByParentAndCodes(CacheDataType cacheDataType, String parentCode, List codes, String groupId) ``` ``` /** * 根据缓存类型+父编码+CODE集合查询缓存 *

适用于根据父编码+编码查询数据的场景，如：根据快速编码类型+快速编码查询，根据维度类型+维度成员编码查询等

优先从Redis中获取数据，Redis中没有时，从数据库查询并放入Redis

* * @param codes 需要查询的ID集合，格式：Map<缓存类型, Map<父编码，子编码集合>> * @param groupId 集团ID * @return java.util.Map<父编码_子编码, SimpleObjCacheDto> * @author 曾俊 * @date 2021/02/23 */ public Map findByParentsAndCodes(Map>> codes, String groupId) ``` ### 4.根据Type+Code查询缓存 **适用场景：根据类型+编码获取数据，类型+编码+集团ID是唯一的情况下。如：客商** ``` /** * 根据缓存类型+类型+子编码集合查询缓存 *

适用于根据类型+编码查询数据的场景，如：根据客商类型+客商编码查询客商信息

优先从Redis中获取数据，Redis中没有时，从数据库查询并放入Redis

* * @param cacheDataType 缓存类型 * @param code 需要查询的编码 * @param type 类型 * @param groupId 集团ID * @return cn.ztessc.cache.dto.SimpleObjCacheDto * @author 曾俊 * @date 2021/02/23 */ public SimpleObjCacheDto findByTypeAndCode(CacheDataType cacheDataType, String type, String code, String groupId) ``` ``` /** * 根据缓存类型+类型+子编码集合查询缓存 *

适用于根据类型+编码查询数据的场景，如：根据客商类型+客商编码查询客商信息

优先从Redis中获取数据，Redis中没有时，从数据库查询并放入Redis

* * @param cacheDataType 缓存类型 * @param codes 需要查询的子编码集合，格式：Map<类型, 编码集合> * @param type 类型 * @param groupId 集团ID * @return java.util.Map<子编码, SimpleObjCacheDto> * @author 曾俊 * @date 2021/02/23 */ public Map findByTypeAndCodes(CacheDataType cacheDataType, String type, List codes, String groupId) ``` ``` /** * 根据缓存类型+类型+CODE集合查询缓存 *

适用于根据类型+编码查询数据的场景，如：根据客商类型+客商编码查询等

优先从Redis中获取数据，Redis中没有时，从数据库查询并放入Redis

* * @param codes 需要查询的集合，格式：Map<缓存类型, Map<类型，编码集合>> * @param groupId 集团ID * @return java.util.Map<类型_子编码, SimpleObjCacheDto> * @author 曾俊 * @date 2021/02/23 */ public Map findByTypesAndCodes(Map>> codes, String groupId) ``` ## 二.注解方式查询缓存-BaseDataTranslate **版本支持：（支持V2.0.6(含)及以后）** ### 1.BaseDataTranslate注解使用场景 * **适用于需要基础数据翻译，我们的业务表中存储的都是基础数据对应的ID或CODE，但是查询时需要展示基础数据对应的名称，所以需要用到该注解；** * **注解使用范围cn.ztessc.common.utils.EnumType.CacheDataType和cn.ztessc.prjcommon.cache.PrjCacheDataTypeEnum枚举类中的所有数据** ### 2.注解中的属性含义 ``` /** * 产品预制数据类型，与项目自定义数据类型只要二选一,两者都填则优先取项目自定义数据类型 * */ EnumType.CacheDataType dataType() default EnumType.CacheDataType.DEFAULT; /** * 项目自定义数据类型，必须是PrjCacheDataTypeEnum中的value属性，与产品预制数据类型只要二选一，两者都填则优先取项目自定义数据类型 * * @return */ String prjDataType() default ""; /** * 执行方法,来源于SimpleObjCacheQueryService里面的方法 * * @return */ EnumType.CacheMethod method(); /** * 参数字段,多个逗号分隔(参数字段顺序和方法的参数顺序必须一一对应) * * @return */ String params(); /** * 显示名称的字段名,多个以逗号分隔格式：leCode=code,leName=name * 其中：leCode为Dto中需要赋值的字段，code为缓存中获取的字段，来源于SimpleObjCacheDto类 * @return */ String showCol(); /** * 分隔符,主要用于参数是多个拼接时使用 * 如：ID为 1^2^3^4，需要将1^2^3^4对应的名称获取到 * @return */ String paramDelimiter() default ""; /** * 分隔符,主要用于显示时多个拼接时使用 * 如：ID为 1^2^3^4，需要将1^2^3^4对应的名称获取到，以一,二,三,四显示 * @return */ String showDelimiter() default ""; ``` ### 3.使用 #### A)声明 **1.声明注解，在DTO的字段上（任意字段）加入注解** ``` @BaseDataTranslate(dataType = CacheDataType.FULECC, method = CacheMethod.findById, params = "leId", showCol ="leCode=code,leName=name") private String leId; ``` #### B)使用 ``` // 注入 @Autowired protected BaseDataTranslateUtils baseDataTranslateUtils; // 解析注解，得到结果 baseDataTranslateUtils.baseDataTranslate(list); ``` ### 4.产品如何增加缓存 ``` 在cn.ztessc.common.utils.EnumType.CacheDataType类中增加枚举，如： SYSDICT_BASE("SYSDICT_BASE", AppName.ZFS_PUBLIC, "/dict/loadToCache", "基础平台快速编码", "/dict/initAllToCache"), // 属性说明 /** 编码,无业务意义，能看出是哪个服务的那种数据即可 */ private String value; /** 微服务名 */ private String appName; /** 获取数据接口地址（如果Redis中没有数据，将会调用该接口获取数据) */ private String srcPath; /** 名称，无业务意义，对应编码的中文描述 */ private String name; /** 初始化所有数据到Redis中的接口地址 */ private String initPath; ``` ### 5.项目如何增加缓存 ``` 在cn.ztessc.prjcommon.cache.PrjCacheDataTypeEnum类中增加枚举，如 /** * 预算组织 */ BGTORG("BGTORG", AppNameConstant.ZFS_BASE, "/bgtOrg/loadToCache", "预算组织", "/bgtOrg/initAllToCache"); // 属性说明 /** 编码,无业务意义，能看出是哪个服务的那种数据即可 */ private String value; /** 微服务名 */ private String appName; /** 获取数据接口地址（如果Redis中没有数据，将会调用该接口获取数据) */ private String srcPath; /** 名称，无业务意义，对应编码的中文描述 */ private String name; /** 初始化所有数据到Redis中的接口地址 */ private String initPath; ```

缓存工具类

缓存工具类

关于作者

目录