devbox
你好赵伟
这个屌丝很懒，什么也没留下！
关注作者
热门标签
热门文章
当前位置:   article > 正文

个人推荐Redis比较好的一种使用规范

作者：你好赵伟 | 2024-04-04 14:47:25

赞

踩

个人推荐Redis比较好的一种使用规范

随着对个人项目的不断开发、迭代和重构，博主在这个过程中总结出了一套使用redis的较好的规范。主要包含Redis的key命名规范和Redis代码规范。

主要内容

主要包含以下几个内容：

  • 同一应用的key在最前面添加统一的前缀，如应用名；
    • 案例：appName:业务相关的key前缀:具有代表性的字段的值
    • 例如：mhxysy:SEVER:1
  • 所有key的前缀，根据业务功能，以常量的形式保存在同一个接口中；
  • 一个业务的Redis缓存对应一个缓存类，使代码易于维护，把缓存的代码统一编写在一个类里，如果想要取消缓存，只需要修改这个缓存类的代码即可。缓存类可以根据自己的喜好来命名，如XxxRepository；
  • 为了体现面向接口的开发原则，可以让所有Reids得缓存类实现一个代表Reids缓存的顶级接口，如RedisRepository；

代码展示

角色信息的缓存类RoleAccountRepository.java

  1. package cn.edu.sgu.www.mhxysy.redis.repository.impl;
  2.  
  3. import cn.edu.sgu.www.mhxysy.consts.RedisKeyPrefixes;
  4. import cn.edu.sgu.www.mhxysy.entity.role.RoleAccount;
  5. import cn.edu.sgu.www.mhxysy.redis.RedisUtils;
  6. import cn.edu.sgu.www.mhxysy.redis.repository.RedisRepository;
  7. import cn.edu.sgu.www.mhxysy.util.TimerUtils;
  8. import cn.edu.sgu.www.mhxysy.vo.role.RoleAccountVO;
  9. import com.alibaba.fastjson.JSON;
  10. import lombok.extern.slf4j.Slf4j;
  11. import org.springframework.stereotype.Component;
  12.  
  13. import java.util.List;
  14. import java.util.TimerTask;
  15. import java.util.concurrent.TimeUnit;
  16. import java.util.function.Consumer;
  17.  
  18. /**
  19.  * @author heyunlin
  20.  * @version 1.0
  21.  */
  22. @Slf4j
  23. @Component
  24. public class RoleAccountRepository implements RedisRepository {
  25.  
  26.     private final RedisUtils redisUtils;
  27.  
  28.     public RoleAccountRepository(RedisUtils redisUtils) {
  29.         this.redisUtils = redisUtils;
  30.     }
  31.  
  32.     @Override
  33.     public void put(String id, Object value) {
  34.         String key = RedisKeyPrefixes.PREFIX_ROLE_ACCOUNT + id;
  35.  
  36.         redisUtils.set(key, JSON.toJSONString(value));
  37.         redisUtils.expire(key, 7, TimeUnit.DAYS);
  38.     }
  39.  
  40.     @Override
  41.     public RoleAccount get(String id) {
  42.         String key = RedisKeyPrefixes.PREFIX_ROLE_ACCOUNT + id;
  43.         String value = redisUtils.get(key);
  44.  
  45.         if (value != null) {
  46.             log.debug("命中缓存{}", key);
  47.         }
  48.  
  49.         return JSON.parseObject(value, RoleAccount.class);
  50.     }
  51.  
  52.     @Override
  53.     public void putList(Object value) {
  54.         String key = RedisKeyPrefixes.PREFIX_ROLE_ACCOUNTS;
  55.  
  56.         redisUtils.set(key, JSON.toJSONString(value), 7, TimeUnit.DAYS);
  57.     }
  58.  
  59.     @Override
  60.     public List<RoleAccount> getList() {
  61.         String key = RedisKeyPrefixes.PREFIX_ROLE_ACCOUNTS;
  62.         String value = redisUtils.get(key);
  63.  
  64.         if (value != null) {
  65.             log.debug("命中缓存{}", key);
  66.  
  67.             return JSON.parseArray(value, RoleAccount.class);
  68.         }
  69.  
  70.         return null;
  71.     }
  72.  
  73.     @Override
  74.     public void delete() {
  75.         String key = RedisKeyPrefixes.PREFIX_ROLE_ACCOUNTS;
  76.  
  77.         redisUtils.delete(key);
  78.     }
  79.  
  80.     @Override
  81.     public void delete(String primaryKey) {
  82.         redisUtils.delete(RedisKeyPrefixes.PREFIX_ROLE_ACCOUNT + primaryKey);
  83.     }
  84.  
  85.     @Override
  86.     public void delayDoubleDelete(String primaryKey, Consumer<String> consumer) {
  87.         delete();
  88.         delete(primaryKey);
  89.         deleteCache(primaryKey);
  90.  
  91.         consumer.accept(primaryKey);
  92.  
  93.         // 延时双删
  94.         TimerUtils.schedule(new TimerTask() {
  95.             @Override
  96.             public void run() {
  97.                 delete();
  98.                 delete(primaryKey);
  99.                 deleteCache(primaryKey);
  100.             }
  101.         });
  102.     }
  103.  
  104.     public void cacheRole(String roleId, RoleAccountVO roleAccountVO) {
  105.         String key = RedisKeyPrefixes.PREFIX_ROLE_DETAIL + roleId;
  106.  
  107.         redisUtils.set(key, JSON.toJSONString(roleAccountVO));
  108.     }
  109.  
  110.     public RoleAccountVO getCache(String roleId) {
  111.         String key = RedisKeyPrefixes.PREFIX_ROLE_DETAIL + roleId;
  112.         String value = redisUtils.get(key);
  113.  
  114.         if (value != null) {
  115.             log.debug("命中缓存{}...", key);
  116.  
  117.             return JSON.parseObject(value, RoleAccountVO.class);
  118.         }
  119.  
  120.         return null;
  121.     }
  122.  
  123.     public void deleteCache(String roleId) {
  124.         String key = RedisKeyPrefixes.PREFIX_ROLE_DETAIL + roleId;
  125.  
  126.         redisUtils.delete(key);
  127.     }
  128.  
  129. }

具体的角色service层方法

  1. package cn.edu.sgu.www.mhxysy.service.role.impl;
  2.  
  3. import cn.edu.sgu.www.mhxysy.base.Pager;
  4. import cn.edu.sgu.www.mhxysy.dto.role.RoleAccountDTO;
  5. import cn.edu.sgu.www.mhxysy.easyexel.impl.RoleAccountExcelData;
  6. import cn.edu.sgu.www.mhxysy.entity.gang.Gang;
  7. import cn.edu.sgu.www.mhxysy.entity.role.Account;
  8. import cn.edu.sgu.www.mhxysy.entity.role.RoleAccount;
  9. import cn.edu.sgu.www.mhxysy.entity.role.RoleModeling;
  10. import cn.edu.sgu.www.mhxysy.entity.school.School;
  11. import cn.edu.sgu.www.mhxysy.entity.server.Server;
  12. import cn.edu.sgu.www.mhxysy.exception.GlobalException;
  13. import cn.edu.sgu.www.mhxysy.mapper.role.JiadianSchemaMapper;
  14. import cn.edu.sgu.www.mhxysy.mapper.role.RoleAccountMapper;
  15. import cn.edu.sgu.www.mhxysy.mapper.role.RoleAttributeMapper;
  16. import cn.edu.sgu.www.mhxysy.mapper.role.RoleJiadianMapper;
  17. import cn.edu.sgu.www.mhxysy.mapper.school.SchoolSkillCategoryMapper;
  18. import cn.edu.sgu.www.mhxysy.mapper.school.SchoolSkillMapper;
  19. import cn.edu.sgu.www.mhxysy.redis.repository.impl.RoleAccountRepository;
  20. import cn.edu.sgu.www.mhxysy.restful.ResponseCode;
  21. import cn.edu.sgu.www.mhxysy.service.gang.GangService;
  22. import cn.edu.sgu.www.mhxysy.service.role.AccountService;
  23. import cn.edu.sgu.www.mhxysy.service.role.RoleAccountService;
  24. import cn.edu.sgu.www.mhxysy.service.role.RoleModelingService;
  25. import cn.edu.sgu.www.mhxysy.service.school.SchoolService;
  26. import cn.edu.sgu.www.mhxysy.service.server.ServerService;
  27. import cn.edu.sgu.www.mhxysy.vo.role.RoleAccountVO;
  28. import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper;
  29. import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
  30. import org.springframework.beans.factory.annotation.Autowired;
  31. import org.springframework.stereotype.Service;
  32.  
  33. import java.util.HashMap;
  34. import java.util.List;
  35. import java.util.Map;
  36. import java.util.function.Consumer;
  37.  
  38. /**
  39.  * @author heyunlin
  40.  * @version 1.0
  41.  */
  42. @Service
  43. public class RoleAccountServiceImpl implements RoleAccountService {
  44.  
  45. 	private final RoleAccountMapper roleAccountMapper;
  46. 	private final RoleJiadianMapper roleJiadianMapper;
  47. 	private final SchoolSkillMapper schoolSkillMapper;
  48. 	private final JiadianSchemaMapper jiadianSchemaMapper;
  49. 	private final RoleAttributeMapper roleAttributeMapper;
  50. 	private final RoleAccountRepository roleAccountRepository;
  51. 	private final SchoolSkillCategoryMapper schoolSkillCategoryMapper;
  52.  
  53. 	private final GangService gangService;
  54. 	private final ServerService serverService;
  55. 	private final SchoolService schoolService;
  56. 	private final AccountService accountService;
  57. 	private final RoleModelingService roleModelingService;
  58.  
  59. 	@Autowired
  60. 	public RoleAccountServiceImpl(
  61. 			RoleAccountMapper roleAccountMapper,
  62. 			RoleJiadianMapper roleJiadianMapper,
  63. 			SchoolSkillMapper schoolSkillMapper,
  64. 			JiadianSchemaMapper jiadianSchemaMapper,
  65. 			RoleAttributeMapper roleAttributeMapper,
  66. 			RoleAccountRepository roleAccountRepository,
  67. 			SchoolSkillCategoryMapper schoolSkillCategoryMapper,
  68. 			GangService gangService,
  69. 			ServerService serverService,
  70. 			SchoolService schoolService,
  71. 			AccountService accountService,
  72. 			RoleModelingService roleModelingService) {
  73. 		this.roleAccountMapper = roleAccountMapper;
  74. 		this.roleJiadianMapper = roleJiadianMapper;
  75. 		this.schoolSkillMapper = schoolSkillMapper;
  76. 		this.jiadianSchemaMapper = jiadianSchemaMapper;
  77. 		this.roleAttributeMapper = roleAttributeMapper;
  78. 		this.roleAccountRepository = roleAccountRepository;
  79. 		this.schoolSkillCategoryMapper = schoolSkillCategoryMapper;
  80. 		this.gangService = gangService;
  81. 		this.serverService = serverService;
  82. 		this.schoolService = schoolService;
  83. 		this.accountService = accountService;
  84. 		this.roleModelingService = roleModelingService;
  85. 	}
  86.  
  87. 	@Override
  88. 	public RoleAccount selectById(String roleId) {
  89. 		RoleAccount roleAccount  = roleAccountRepository.get(roleId);
  90.  
  91. 		if (roleAccount == null) {
  92. 			roleAccount = roleAccountMapper.selectById(roleId);
  93.  
  94. 			roleAccountRepository.put(roleId, roleAccount);
  95. 		}
  96.  
  97. 		return roleAccount;
  98. 	}
  99.  
  100. }

Redis的key前缀常量接口代码展示

  1. package cn.edu.sgu.www.mhxysy.consts;
  2.  
  3. /**
  4.  * redis的key前缀的常量接口
  5.  * @author heyunlin
  6.  * @version 1.0
  7.  */
  8. public interface RedisKeyPrefixes {
  9.  
  10.     String PREFIX_BASE = "mhxysy:";
  11.  
  12.     /**
  13.      * 用户的邮箱
  14.      */
  15.     String PREFIX_EMAIL = PREFIX_BASE + "EMAIL:";
  16.  
  17.     /**
  18.      * 用户登录的验证码
  19.      */
  20.     String PREFIX_CAPTCHA = PREFIX_BASE + "CAPTCHA:";
  21.  
  22.     /**
  23.      * 用户的侧栏菜单
  24.      */
  25.     String PREFIX_USER_LEFT_MENUS = PREFIX_BASE + "USER_LEFT_MENUS:";
  26.  
  27.     /**
  28.      * 角色的菜单树
  29.      */
  30.     String PREFIX_ROLE_MENU_TREE = PREFIX_BASE + "ROLE_MENU_TREE:";
  31.  
  32.     /**
  33.      * 用户登录的次数
  34.      */
  35.     String PREFIX_USER_LOGIN_TIMES = PREFIX_BASE + "USER_LOGIN_TIMES:";
  36.  
  37.     /**
  38.      * shiro缓存认证管理
  39.      */
  40.     String PREFIX_CACHE_MANAGER = PREFIX_BASE + "AUTHORIZATION:CACHE_MANAGER:";
  41.  
  42.     /**
  43.      * 角色高级属性
  44.      */
  45.     String PREFIX_ADVANCED_PROPERTY = PREFIX_BASE + "ROLE_GJSX:";
  46.  
  47.     /**
  48.      * 角色详情
  49.      */
  50.     String PREFIX_ROLE_DETAIL = PREFIX_BASE + "ROLE_DETAIL:";
  51.  
  52.     /**
  53.      * 角色
  54.      */
  55.     String PREFIX_ROLE_ACCOUNT = PREFIX_BASE + "ROLE_ACCOUNT:";
  56.  
  57.     /**
  58.      * 角色列表
  59.      */
  60.     String PREFIX_ROLE_ACCOUNTS = PREFIX_BASE + "ROLE_ACCOUNTS:";
  61.  
  62.     /**
  63.      * 角色造型
  64.      */
  65.     String PREFIX_ROLE_MODELING = PREFIX_BASE + "ROLE_MODELING:";
  66.  
  67.     /**
  68.      * 角色造型列表
  69.      */
  70.     String PREFIX_ROLE_MODELINGS = PREFIX_BASE + "ROLE_MODELINGS";
  71.  
  72.     /**
  73.      * 帮派
  74.      */
  75.     String PREFIX_GANG = PREFIX_BASE + "GANG:";
  76.  
  77.     /**
  78.      * 帮派列表
  79.      */
  80.     String PREFIX_GANGS = PREFIX_BASE + "GANGS";
  81.  
  82.     /**
  83.      * 帮派职务
  84.      */
  85.     String PREFIX_GANG_JOB = PREFIX_BASE + "GANG_JOB:";
  86.  
  87.     /**
  88.      * 帮派职务列表
  89.      */
  90.     String PREFIX_GANG_JOBS = PREFIX_BASE + "GANG_JOBS";
  91.  
  92.     /**
  93.      * 门派
  94.      */
  95.     String PREFIX_SCHOOL = PREFIX_BASE + "SCHOOL:";
  96.  
  97.     /**
  98.      * 门派列表
  99.      */
  100.     String PREFIX_SCHOOLS = PREFIX_BASE + "SCHOOLS";
  101.  
  102.     /**
  103.      * 宠物
  104.      */
  105.     String PREFIX_CHONGWU = PREFIX_BASE + "CHONGWU:";
  106.  
  107.     /**
  108.      * 宠物列表
  109.      */
  110.     String PREFIX_CHONGWUS = PREFIX_BASE + "CHONGWUS";
  111.  
  112.     /**
  113.      * 宠物类型
  114.      */
  115.     String PREFIX_CHONGWU_CATEGORY = PREFIX_BASE + "CHONGWU_CATEGORY:";
  116.  
  117.     /**
  118.      * 宠物类型列表
  119.      */
  120.     String PREFIX_CHONGWU_CATEGORIES = PREFIX_BASE + "CHONGWU_CATEGORIES";
  121.  
  122.     /**
  123.      * 大区
  124.      */
  125.     String PREFIX_AREA = PREFIX_BASE + "AREA:";
  126.  
  127.     /**
  128.      * 大区列表
  129.      */
  130.     String PREFIX_AREAS = PREFIX_BASE + "AREAS";
  131.  
  132.     /**
  133.      * 服务器
  134.      */
  135.     String PREFIX_SERVER = PREFIX_BASE + "SERVER:";
  136.  
  137.     /**
  138.      * 服务器列表
  139.      */
  140.     String PREFIX_SERVERS = PREFIX_BASE + "SERVERS";
  141.  
  142.     /**
  143.      * 账号
  144.      */
  145.     String PREFIX_ACCOUNT = PREFIX_BASE + "ACCOUNT:";
  146.  
  147.     /**
  148.      * 账号列表
  149.      */
  150.     String PREFIX_ACCOUNTS = PREFIX_BASE + "ACCOUNTS";
  151. }

Redis缓存顶级接口

  1. package cn.edu.sgu.www.mhxysy.redis.repository;
  2.  
  3. import java.util.function.Consumer;
  4.  
  5. /**
  6.  * redis仓库的顶级接口：为了满足开闭原则设计了此接口
  7.  * @author heyunlin
  8.  * @version 1.0
  9.  */
  10. public interface RedisRepository {
  11.  
  12.     void put(String key, Object value);
  13.  
  14.     Object get(String key);
  15.  
  16.     void putList(Object value);
  17.  
  18.     Object getList();
  19.  
  20.     /**
  21.      * 删除数据缓存
  22.      */
  23.     void delete();
  24.  
  25.     /**
  26.      * 删除指定ID的数据缓存
  27.      * @param primaryKey 数据的ID
  28.      */
  29.     void delete(String primaryKey);
  30.  
  31.     /**
  32.      * 延时双删
  33.      * @param primaryKey 数据的ID
  34.      * @param consumer Consumer<String>
  35.      */
  36.     default void delayDoubleDelete(String primaryKey, Consumer<String> consumer) { }
  37.  
  38. }

好了，文章就分享到这里了，后续会持续优化文章内容，感谢大家的支持~

最后，如果看完这篇文章觉得对你有所帮助或者启发，不要忘了点赞+收藏哦~

声明：本文内容由网友自发贡献，不代表【wpsshop博客】立场，版权归原作者所有，本站不承担相应法律责任。如您发现有侵权的内容，请联系我们。转载请注明出处：https://www.wpsshop.cn/w/你好赵伟/article/detail/359331?site
推荐阅读
相关标签

Copyright © 2003-2013 www.wpsshop.cn 版权所有，并保留所有权利。

  

闽ICP备14008679号