Redis實戰(zhàn)(11)-哈希Hash典型應用場景實戰(zhàn)之系統(tǒng)數(shù)據(jù)字典實時觸發(fā)緩存存儲

作者: 修羅debug
版權聲明:本文為博主原創(chuàng)文章,遵循 CC 4.0 by-sa 版權協(xié)議,轉載請附上原文出處鏈接和本聲明。



摘要:前文我們已經介紹并實戰(zhàn)了Redis的數(shù)據(jù)類型哈希Hash的相關命令行及其對應的Java單元測試的實戰(zhàn)代碼,本文我們將以實際項目中典型的應用場景“系統(tǒng)數(shù)據(jù)字典模塊的實時觸發(fā)存儲”為案例,學以致用,一起踐行哈希Hash在實際項目下的實戰(zhàn)應用,感受感受其在實際業(yè)務場景下的作用!

內容:在前文我們已經簡單介紹了Redis的數(shù)據(jù)類型~哈希Hash的底層存儲結構,很顯然,哈希Hash跟其他的數(shù)據(jù)結構還是有諸多不同之處的。其他的據(jù)結構幾乎都是:Key-Value的存儲,而Hash則是:Key – [Field-Value] 的存儲,也就是說其他數(shù)據(jù)結構的Value一般是確切的值,而Hash的Value是一系列的鍵值對,通常我們是這樣子稱呼Hash的存儲的:大Key為實際的Key,小Key為Field,而具體的取值為Field對應的值。如下圖所示:


說實在的,它的作用還是很強大的,特別是在存儲“同種對象類型”的數(shù)據(jù)列表時哈希Hash更能體現(xiàn)其優(yōu)勢,除此之外,其最大的、直觀上的作用便是“減少了緩存Key的數(shù)量”,而這主要還得得益于哈希Hash底層存儲數(shù)據(jù)時的存儲方式,如上圖所示!

接下來,我們便以實際項目開發(fā)中典型、常見的應用場景“系統(tǒng)數(shù)據(jù)字典實時觸發(fā)緩存存儲”為案例一起來踐行哈希Hash的作用。

對于“數(shù)據(jù)字典模塊”,相信很多小伙伴都有所聽聞過,毫不夸張地講,幾乎每個項目都會有一個獨立的功能模塊,用于管理項目中各個業(yè)務模塊經常出現(xiàn)的“通用化、共性的、需要配置起來的東西”,這些通用化的東西我們可以稱之為“數(shù)據(jù)字典”,對于這些東西我們一般會單獨開辟一個獨立的功能模塊,如“數(shù)據(jù)字典模塊”進行單獨維護管理!

對于上面這個解釋,可能有些小伙伴有點懵,下面我們舉個栗子吧,比如經常可以見到的數(shù)據(jù)字典:“性別Sex~其取值可以有:男=1;女=0;未知=2”;比如“支付狀態(tài)PayStatus~其取值可以有:1=未支付;2=已支付;3=已取消支付;4=已退款…”;再比如“訂單審核狀態(tài)ReviewStatus~1=已保存/未審核;2=已審核;3=審核成功;4=審核失敗…”等等可以將其配置在“數(shù)據(jù)字典功能模塊”中將其維護起來,如下圖所示:


看到上面這張圖,有些機靈的小伙伴可能會立即聯(lián)想到哈希Hash的底層存儲結構(本文開篇的那張圖),會發(fā)現(xiàn)驚人的相似,就拿“性別Sex”這一數(shù)據(jù)字典為例,它的取值為“Female-女性”、“Male-男性”,這不就相當于哈希Hash的底層存儲結構嗎~Key=Sex,F(xiàn)ield-Value對包含兩隊,分別是:Field=Female ~ Value=女性;Field=Male ~ Value=男性。

理解了這種數(shù)據(jù)關聯(lián)以及存儲之后,在后文的實戰(zhàn)中你就會發(fā)現(xiàn)代碼很容易理解,并且在實戰(zhàn)過后你或許會發(fā)出驚嘆:“原來如此!”

除此之外,還有一種現(xiàn)象需要跟小伙伴分享分享,那就是“數(shù)據(jù)字典功能模塊”一旦配置好了某個“數(shù)據(jù)字典”之后,我們基本上會在好幾個月內都不會去重新修改它了,即有點“一勞永逸”的感覺!基于這個前提,我們可以將前端發(fā)起的請求實時訪問數(shù)據(jù)庫DB的“數(shù)據(jù)字典” 優(yōu)化為 基于緩存Redis的哈希Hash進行存儲與訪問,并且這種存儲是“實時”的,那我們就開始吧!

(1)同樣的道理,工欲善其事,必先利其器,我們首先需要建立一個數(shù)據(jù)庫表sys_config用于存儲管理員添加的數(shù)據(jù)字典,其DDL如下所示:

CREATE TABLE `sys_config` (
`id` int(11) NOT NULL AUTO_INCREMENT,
`type` varchar(100) CHARACTER SET utf8mb4 NOT NULL COMMENT '字典類型',
`name` varchar(100) CHARACTER SET utf8mb4 DEFAULT NULL COMMENT '字典名稱',
`code` varchar(100) CHARACTER SET utf8mb4 DEFAULT NULL COMMENT '選項編碼',
`value` varchar(100) CHARACTER SET utf8mb4 DEFAULT NULL COMMENT '選項取值',
`order_by` int(11) DEFAULT '1' COMMENT '排序',
`is_active` tinyint(4) DEFAULT '1' COMMENT '是否有效(1=是;0=否)',
`create_time` datetime DEFAULT CURRENT_TIMESTAMP COMMENT '創(chuàng)建時間',
PRIMARY KEY (`id`),
UNIQUE KEY `idx_type_code` (`type`,`code`) USING BTREE
) ENGINE=InnoDB DEFAULT CHARSET=utf8 COMMENT='字典配置表';

采用Mybatis的逆向工程生成該數(shù)據(jù)庫表的實體類Entity、Mapper操作接口及其對應的用于操作動態(tài)SQL的Mapper.xml,在這里我們只貼出SysConfigMapper接口中一個相當重要的方法吧:  

//查詢目前數(shù)據(jù)字典表中所有可用的-已激活的數(shù)據(jù)字典列表
List<SysConfig> selectActiveConfigs();

其對應的動態(tài)SQL實現(xiàn)如下所示:  

  <select id="selectActiveConfigs" resultType="com.boot.debug.redis.model.entity.SysConfig">
SELECT <include refid="Base_Column_List"/>
FROM sys_config
WHERE is_active = 1
ORDER BY type, order_by ASC
</select>

(2)緊接著,我們建立一個HashController,用于“新增數(shù)據(jù)字典”、“獲取緩存中所有的數(shù)據(jù)字典”以及“獲取特定編碼的數(shù)據(jù)字典取值列表”,其完整的源代碼如下所示:  

/**數(shù)據(jù)類型Hash散列-減少key存儲、類似于map-可以通過鍵取得其 “值” (可以對象列表...)
* @Author:debug (SteadyJack) **/
@RestController
@RequestMapping("hash")
public class HashController extends AbstractController {

@Autowired
private HashService hashService;
//新增數(shù)據(jù)字典
@RequestMapping(value = "put",method = RequestMethod.POST,consumes = MediaType.APPLICATION_JSON_UTF8_VALUE)
public BaseResponse put(@RequestBody @Validated SysConfig config, BindingResult result){
String checkRes= ValidatorUtil.checkResult(result);
if (StrUtil.isNotBlank(checkRes)){
return new BaseResponse(StatusCode.Fail.getCode(),checkRes);
}
BaseResponse response=new BaseResponse(StatusCode.Success);
try {
hashService.addSysConfig(config);

}catch (Exception e){
response=new BaseResponse(StatusCode.Fail.getCode(),e.getMessage());
}
return response;
}
//獲取緩存中所有的數(shù)據(jù)字典
@RequestMapping(value = "get",method = RequestMethod.GET)
public BaseResponse get(){
BaseResponse response=new BaseResponse(StatusCode.Success);
try {
response.setData(hashService.getAll());

}catch (Exception e){
response=new BaseResponse(StatusCode.Fail.getCode(),e.getMessage());
}
return response;
}
//獲取緩存中某個特定編碼下數(shù)據(jù)字典的取值列表
@RequestMapping(value = "get/type",method = RequestMethod.GET)
public BaseResponse getType(@RequestParam String type){
BaseResponse response=new BaseResponse(StatusCode.Success);
try {
response.setData(hashService.getByType(type));

}catch (Exception e){
response=new BaseResponse(StatusCode.Fail.getCode(),e.getMessage());
}
return response;
}
}

(3)其中,hashService下那幾個方法的實現(xiàn)邏輯即為真正要做的事情,其完整源代碼如下所示:  

/**hash數(shù)據(jù)類型-service
* @Author:debug (SteadyJack)
* @Link: weixin-> debug0868 qq-> 1948831260
* @Date: 2019/10/31 21:07
**/
@Service
public class HashService {
private static final Logger log= LoggerFactory.getLogger(HashService.class);

@Autowired
private SysConfigMapper sysConfigMapper;

@Autowired
private HashRedisService hashRedisService;

//TODO:添加數(shù)據(jù)字典及其對應的選項(field-value)
@Transactional(rollbackFor = Exception.class)
public Integer addSysConfig(SysConfig config) throws Exception{
int res=sysConfigMapper.insertSelective(config);
if (res>0){
//TODO:實時觸發(fā)數(shù)據(jù)字典的hash存儲
hashRedisService.cacheConfigMap();
}
return config.getId();
}

//TODO:取出緩存中所有的數(shù)據(jù)字典列表
public Map<String,List<SysConfig>> getAll() throws Exception{
return hashRedisService.getAllCacheConfig();
}

//TODO:取出緩存中特定的數(shù)據(jù)字典列表
public List<SysConfig> getByType(final String type) throws Exception{
return hashRedisService.getCacheConfigByType(type);
}
}

(4)而hashService中實現(xiàn)數(shù)據(jù)字典的實時存取又是交給了HashRedisService相應的方法邏輯進行處理,其對應的完整源代碼如下所示:  

/**hash緩存服務 @Author:debug (SteadyJack)  weixin-> debug0868 qq-> 1948831260**/
@Service
public class HashRedisService {
private static final Logger log= LoggerFactory.getLogger(HashRedisService.class);
@Autowired
private SysConfigMapper sysConfigMapper;

@Autowired
private RedisTemplate redisTemplate;
//TODO:實時獲取所有有效的數(shù)據(jù)字典列表-轉化為map-存入hash緩存中
@Async
public void cacheConfigMap(){
try {
List<SysConfig> configs=sysConfigMapper.selectActiveConfigs();
if (configs!=null && !configs.isEmpty()){
Map<String,List<SysConfig>> dataMap= Maps.newHashMap();

//TODO:所有的數(shù)據(jù)字典列表遍歷 -> 轉化為 hash存儲的map
configs.forEach(config -> {
List<SysConfig> list=dataMap.get(config.getType());
if (list==null || list.isEmpty()){
list= Lists.newLinkedList();
}
list.add(config);
dataMap.put(config.getType(),list);
});
//TODO:存儲到緩存hash中
HashOperations<String,String,List<SysConfig>> hashOperations=redisTemplate.opsForHash();
hashOperations.putAll(Constant.RedisHashKeyConfig,dataMap);
}
}catch (Exception e){
log.error("實時獲取所有有效的數(shù)據(jù)字典列表-轉化為map-存入hash緩存中-發(fā)生異常:",e.fillInStackTrace());
}
}

//TODO:從緩存hash中獲取所有的數(shù)據(jù)字典配置map
public Map<String,List<SysConfig>> getAllCacheConfig(){
Map<String,List<SysConfig>> map=Maps.newHashMap();
try {
HashOperations<String,String,List<SysConfig>> hashOperations=redisTemplate.opsForHash();
map=hashOperations.entries(Constant.RedisHashKeyConfig);
}catch (Exception e){
log.error("從緩存hash中獲取所有的數(shù)據(jù)字典配置map-發(fā)生異常:",e.fillInStackTrace());
}
return map;
}

//TODO:從緩存hash中獲取特定的數(shù)據(jù)字典列表
public List<SysConfig> getCacheConfigByType(final String type){
List<SysConfig> list=Lists.newLinkedList();
try {
HashOperations<String,String,List<SysConfig>> hashOperations=redisTemplate.opsForHash();
list=hashOperations.get(Constant.RedisHashKeyConfig,type);
}catch (Exception e){
log.error("從緩存hash中獲取特定的數(shù)據(jù)字典列表-發(fā)生異常:",e.fillInStackTrace());
}
return list;
}
}

至此,我們已經完成了哈希Hash典型應用場景“系統(tǒng)數(shù)據(jù)字典的實時存取”的代碼實戰(zhàn)了,相應的代碼的含義我們也在代碼中做了相應的注釋!如果有疑問的地方,各位小伙伴可以加Debug的聯(lián)系方式進行交流(代碼中就有我的交流聯(lián)系方式哦!),下面我們基于Postman進行一波測試吧!

A.首先是往數(shù)據(jù)庫中已有的某個數(shù)據(jù)字典添加某些具體的取值列表(Field-Value),如下幾張圖所示:




B.最后是往數(shù)據(jù)庫中添加一個全新的數(shù)據(jù)字典及其對應的取值列表(Field-Value),如下幾張圖所示:




好了,本篇文章我們就介紹到這里了,建議各位小伙伴一定要照著文章提供的樣例代碼擼一擼,只有擼過才能知道這玩意是咋用的,否則就成了“空談者”!

對Redis相關技術棧以及實際應用場景實戰(zhàn)感興趣的小伙伴可以前往Debug搭建的技術社區(qū)的課程中心進行學習觀看:https://www.fightjava.com/web/index/course/detail/12 !

其他相關的技術,感興趣的小伙伴可以關注底部Debug的技術公眾號,或者加Debug的微信,拉你進“微信版”的真正技術交流群!一起學習、共同成長!

補充:

1、本文涉及到的相關的源代碼可以到此地址,check出來進行查看學習:

https://gitee.com/steadyjack/SpringBootRedis

2、目前Debug已將本文所涉及的內容整理錄制成視頻教程,感興趣的小伙伴可以前往觀看學習:https://www.fightjava.com/web/index/course/detail/12

3、關注一下Debug的技術微信公眾號,最新的技術文章、課程以及技術專欄將會第一時間在公眾號發(fā)布哦!