作者：solocoder
juejin.im/post/5bdc257e6fb9a049ba410098
本文基于 SpringCloud, 用户发起点赞、取消点赞后先存入 Redis 中，再每隔两小时从 Redis 读取点赞数据写入数据库中做持久化存储。
点赞功能在很多系统中都有，但别看功能小，想要做好需要考虑的东西还挺多的。
点赞、取消点赞是高频次的操作，若每次都读写数据库，大量的操作会影响数据库性能，所以需要做缓存。
至于多久从 Redis 取一次数据存到数据库中，根据项目的实际情况定吧，我是暂时设了两个小时。
项目需求需要查看都谁点赞了，所以要存储每个点赞的点赞人、被点赞人，不能简单的做计数。
文章分四部分介绍：
Redis 缓存设计及实现
数据库设计
数据库操作
开启定时任务持久化存储到数据库
一、Redis 缓存设计及实现
1.1 Redis 安装及运行
Redis 安装请自行查阅相关教程。
说下Docker 安装运行 Redis
dockerrun-d-p6379:6379redis:4.0.8
如果已经安装了 Redis，打开命令行，输入启动 Redis 的命令
redis-server
1.2 Redis 与 SpringBoot 项目的整合
1.在 pom.xml 中引入依赖
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-data-redis</artifactId>
</dependency>
2.在启动类上添加注释 @EnableCaching
@SpringBootApplication
@EnableDiscoveryClient
@EnableSwagger2
@EnableFeignClients(basePackages="com.solo.coderiver.project.client")
@EnableCaching
publicclassUserApplication{
publicstaticvoidmain(String[]args){
SpringApplication.run(UserApplication.class,args);
}
}
3.编写 Redis 配置类 RedisConfig
importcom.fasterxml.jackson.annotation.JsonAutoDetect;
importcom.fasterxml.jackson.annotation.PropertyAccessor;
importcom.fasterxml.jackson.databind.ObjectMapper;
importorg.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
importorg.springframework.context.annotation.Bean;
importorg.springframework.context.annotation.Configuration;
importorg.springframework.data.redis.connection.RedisConnectionFactory;
importorg.springframework.data.redis.core.RedisTemplate;
importorg.springframework.data.redis.core.StringRedisTemplate;
importorg.springframework.data.redis.serializer.Jackson2JsonRedisSerializer;
.UnknownHostException;
@Configuration
publicclassRedisConfig{
@Bean
@ConditionalOnMissingBean(name="redisTemplate")
publicRedisTemplate<String,Object>redisTemplate(
RedisConnectionFactoryredisConnectionFactory)
throwsUnknownHostException{
Jackson2JsonRedisSerializer<Object>jackson2JsonRedisSerializer=newJackson2JsonRedisSerializer<Object>(Object.class);
ObjectMapperom=newObjectMapper();
om.setVisibility(PropertyAccessor.ALL,JsonAutoDetect.Visibility.ANY);
om.enableDefaultTyping(ObjectMapper.DefaultTyping.NON_FINAL);
jackson2JsonRedisSerializer.setObjectMapper(om);
RedisTemplate<String,Object>template=newRedisTemplate<String,Object>();
template.setConnectionFactory(redisConnectionFactory);
template.setKeySerializer(jackson2JsonRedisSerializer);
template.setValueSerializer(jackson2JsonRedisSerializer);
template.setHashKeySerializer(jackson2JsonRedisSerializer);
template.setHashValueSerializer(jackson2JsonRedisSerializer);
template.afterPropertiesSet();
returntemplate;
}
@Bean
@ConditionalOnMissingBean(StringRedisTemplate.class)
publicStringRedisTemplatestringRedisTemplate(
RedisConnectionFactoryredisConnectionFactory)
throwsUnknownHostException{
StringRedisTemplatetemplate=newStringRedisTemplate();
template.setConnectionFactory(redisConnectionFactory);
returntemplate;
}
}
至此 Redis 在 SpringBoot 项目中的配置已经完成，可以愉快的使用了。
1.3 Redis 的数据结构类型
Redis 可以存储键与5种不同数据结构类型之间的映射，这5种数据结构类型分别为String（字符串）、List（列表）、Set（集合）、Hash（散列）和 Zset（有序集合）。
下面来对这5种数据结构类型作简单的介绍：
1.4 点赞数据在 Redis 中的存储格式
用 Redis 存储两种数据，一种是记录点赞人、被点赞人、点赞状态的数据，另一种是每个用户被点赞了多少次，做个简单的计数。
由于需要记录点赞人和被点赞人，还有点赞状态（点赞、取消点赞），还要固定时间间隔取出 Redis 中所有点赞数据，分析了下 Redis 数据格式中 Hash 最合适。
因为 Hash 里的数据都是存在一个键里，可以通过这个键很方便的把所有的点赞数据都取出。这个键里面的数据还可以存成键值对的形式，方便存入点赞人、被点赞人和点赞状态。
设点赞人的 id 为 likedPostId，被点赞人的 id 为 likedUserId ，点赞时状态为 1，取消点赞状态为 0。将点赞人 id 和被点赞人 id 作为键，两个 id 中间用 :: 隔开，点赞状态作为值。
所以如果用户点赞，存储的键为：likedUserId::likedPostId，对应的值为 1 。取消点赞，存储的键为：likedUserId::likedPostId，对应的值为 0 。取数据时把键用 :: 切开就得到了两个id，也很方便。(Redis常见面试题，可以参考这里)
在可视化工具 RDM 中看到的是这样子
1.5 操作 Redis
将具体操作方法封装到了 RedisService 接口里
RedisService.java
importcom.solo.coderiver.user.dataobject.UserLike;
importcom.solo.coderiver.user.dto.LikedCountDTO;
importjava.util.List;
publicinterfaceRedisService{
/**
*点赞。状态为1
*@paramlikedUserId
*@paramlikedPostId
*/
voidsaveLiked2Redis(StringlikedUserId,StringlikedPostId);
/**
*取消点赞。将状态改变为0
*@paramlikedUserId
*@paramlikedPostId
*/
voidunlikeFromRedis(StringlikedUserId,StringlikedPostId);
/**
*从Redis中删除一条点赞数据
*@paramlikedUserId
*@paramlikedPostId
*/
voiddeleteLikedFromRedis(StringlikedUserId,StringlikedPostId);
/**
*该用户的点赞数加1
*@paramlikedUserId
*/
voidincrementLikedCount(StringlikedUserId);
/**
*该用户的点赞数减1
*@paramlikedUserId
*/
voiddecrementLikedCount(StringlikedUserId);
/**
*获取Redis中存储的所有点赞数据
*@return
*/
List<UserLike>getLikedDataFromRedis();
/**
*获取Redis中存储的所有点赞数量
*@return
*/
List<LikedCountDTO>getLikedCountFromRedis();
}
实现类 RedisServiceImpl.java
importcom.solo.coderiver.user.dataobject.UserLike;
importcom.solo.coderiver.user.dto.LikedCountDTO;
importcom.solo.coderiver.user.enums.LikedStatusEnum;
importcom.solo.coderiver.user.service.LikedService;
importcom.solo.coderiver.user.service.RedisService;
importcom.solo.coderiver.user.utils.RedisKeyUtils;
importlombok.extern.slf4j.Slf4j;
importorg.springframework.beans.factory.annotation.Autowired;
importorg.springframework.data.redis.core.Cursor;
importorg.springframework.data.redis.core.RedisTemplate;
importorg.springframework.data.redis.core.ScanOptions;
importorg.springframework.stereotype.Service;
importjava.util.ArrayList;
importjava.util.List;
importjava.util.Map;
@Service
@Slf4j
publicclassRedisServiceImplimplementsRedisService{
@Autowired
RedisTemplateredisTemplate;
@Autowired
LikedServicelikedService;
@Override
publicvoidsaveLiked2Redis(StringlikedUserId,StringlikedPostId){
Stringkey=RedisKeyUtils.getLikedKey(likedUserId,likedPostId);
redisTemplate.opsForHash().put(RedisKeyUtils.MAP_KEY_USER_LIKED,key,LikedStatusEnum.LIKE.getCode());
}
@Override
publicvoidunlikeFromRedis(StringlikedUserId,StringlikedPostId){
Stringkey=RedisKeyUtils.getLikedKey(likedUserId,likedPostId);
redisTemplate.opsForHash().put(RedisKeyUtils.MAP_KEY_USER_LIKED,key,LikedStatusEnum.UNLIKE.getCode());
}
@Override
publicvoiddeleteLikedFromRedis(StringlikedUserId,StringlikedPostId){
Stringkey=RedisKeyUtils.getLikedKey(likedUserId,likedPostId);
redisTemplate.opsForHash().delete(RedisKeyUtils.MAP_KEY_USER_LIKED,key);
}
@Override
publicvoidincrementLikedCount(StringlikedUserId){
redisTemplate.opsForHash().increment(RedisKeyUtils.MAP_KEY_USER_LIKED_COUNT,likedUserId,1);
}
@Override
publicvoiddecrementLikedCount(StringlikedUserId){
redisTemplate.opsForHash().increment(RedisKeyUtils.MAP_KEY_USER_LIKED_COUNT,likedUserId,-1);
}
@Override
publicList<UserLike>getLikedDataFromRedis(){
Cursor<Map.Entry<Object,Object>>cursor=redisTemplate.opsForHash().scan(RedisKeyUtils.MAP_KEY_USER_LIKED,ScanOptions.NONE);
List<UserLike>list=newArrayList<>();
while(cursor.hasNext()){
Map.Entry<Object,Object>entry=cursor.next();
Stringkey=(String)entry.getKey();
//分离出likedUserId，likedPostId
String[]split=key.split("::");
StringlikedUserId=split[0];
StringlikedPostId=split[1];
Integervalue=(Integer)entry.getValue();
//组装成UserLike对象
UserLikeuserLike=newUserLike(likedUserId,likedPostId,value);
list.add(userLike);
//存到list后从Redis中删除
redisTemplate.opsForHash().delete(RedisKeyUtils.MAP_KEY_USER_LIKED,key);
}
returnlist;
}
@Override
publicList<LikedCountDTO>getLikedCountFromRedis(){
Cursor<Map.Entry<Object,Object>>cursor=redisTemplate.opsForHash().scan(RedisKeyUtils.MAP_KEY_USER_LIKED_COUNT,ScanOptions.NONE);
List<LikedCountDTO>list=newArrayList<>();
while(cursor.hasNext()){
Map.Entry<Object,Object>map=cursor.next();
//将点赞数量存储在LikedCountDT
Stringkey=(String)map.getKey();
LikedCountDTOdto=newLikedCountDTO(key,(Integer)map.getValue());
list.add(dto);
//从Redis中删除这条记录
redisTemplate.opsForHash().delete(RedisKeyUtils.MAP_KEY_USER_LIKED_COUNT,key);
}
returnlist;
}
}
用到的工具类和枚举类
RedisKeyUtils, 用于根据一定规则生成 key
publicclassRedisKeyUtils{
//保存用户点赞数据的key
publicstaticfinalStringMAP_KEY_USER_LIKED="MAP_USER_LIKED";
//保存用户被点赞数量的key
publicstaticfinalStringMAP_KEY_USER_LIKED_COUNT="MAP_USER_LIKED_COUNT";
/**
*拼接被点赞的用户id和点赞的人的id作为key。格式 222222::333333
*@paramlikedUserId被点赞的人id
*@paramlikedPostId点赞的人的id
*@return
*/
publicstaticStringgetLikedKey(StringlikedUserId,StringlikedPostId){
StringBuilderbuilder=newStringBuilder();
builder.append(likedUserId);
builder.append("::");
builder.append(likedPostId);
returnbuilder.toString();
}
}
LikedStatusEnum 用户点赞状态的枚举类
packagecom.solo.coderiver.user.enums;
importlombok.Getter;
/**
*用户点赞的状态
*/
@Getter
publicenumLikedStatusEnum{
LIKE(1,"点赞"),
UNLIKE(0,"取消点赞/未点赞"),
;
privateIntegercode;
privateStringmsg;
LikedStatusEnum(Integercode,Stringmsg){
this.code=code;
this.msg=msg;
}
}
二、数据库设计
数据库表中至少要包含三个字段：被点赞用户id，点赞用户id，点赞状态。再加上主键id，创建时间，修改时间就行了。
建表语句
createtable`user_like`(
`id`intnotnullauto_increment,
`liked_user_id`varchar(32)notnullcomment"被点赞的用户id",
`liked_post_id`varchar(32)notnullcomment"点赞的用户id",
`status`tinyint(1)default"1"comment"点赞状态，0取消，1点赞",
`create_time`timestampnotnulldefaultcurrent_timestampcomment"创建时间",
`update_time`timestampnotnulldefaultcurrent_timestamponupdatecurrent_timestampcomment"修改时间",
primarykey(`id`),
INDEX`liked_user_id`(`liked_user_id`),
INDEX`liked_post_id`(`liked_post_id`)
)comment"用户点赞表";
对应的对象 UserLike
importcom.solo.coderiver.user.enums.LikedStatusEnum;
importlombok.Data;
importjavax.persistence.Entity;
importjavax.persistence.GeneratedValue;
importjavax.persistence.GenerationType;
importjavax.persistence.Id;
/**
*用户点赞表
*/
@Entity
@Data
publicclassUserLike{
//主键id
@Id
@GeneratedValue(strategy=GenerationType.IDENTITY)
privateIntegerid;
//被点赞的用户的id
privateStringlikedUserId;
//点赞的用户的id
privateStringlikedPostId;
//点赞的状态.默认未点赞
privateIntegerstatus=LikedStatusEnum.UNLIKE.getCode();
publicUserLike(){
}
publicUserLike(StringlikedUserId,StringlikedPostId,Integerstatus){
this.likedUserId=likedUserId;
this.likedPostId=likedPostId;
this.status=status;
}
}
三、数据库操作
操作数据库同样封装在接口中
LikedService
importcom.solo.coderiver.user.dataobject.UserLike;
importorg.springframework.data.domain.Page;
importorg.springframework.data.domain.Pageable;
importjava.util.List;
publicinterfaceLikedService{
/**
*保存点赞记录
*@paramuserLike
*@return
*/
UserLikesave(UserLikeuserLike);
/**
*批量保存或修改
*@paramlist
*/
List<UserLike>saveAll(List<UserLike>list);
/**
*根据被点赞人的id查询点赞列表（即查询都谁给这个人点赞过）
*@paramlikedUserId被点赞人的id
*@parampageable
*@return
*/
Page<UserLike>getLikedListByLikedUserId(StringlikedUserId,Pageablepageable);
/**
*根据点赞人的id查询点赞列表（即查询这个人都给谁点赞过）
*@paramlikedPostId
*@parampageable
*@return
*/
Page<UserLike>getLikedListByLikedPostId(StringlikedPostId,Pageablepageable);
/**
*通过被点赞人和点赞人id查询是否存在点赞记录
*@paramlikedUserId
*@paramlikedPostId
*@return
*/
UserLikegetByLikedUserIdAndLikedPostId(StringlikedUserId,StringlikedPostId);
/**
*将Redis里的点赞数据存入数据库中
*/
voidtransLikedFromRedis2DB();
/**
*将Redis中的点赞数量数据存入数据库
*/
voidtransLikedCountFromRedis2DB();
}
LikedServiceImpl 实现类
importcom.solo.coderiver.user.dataobject.UserInfo;
importcom.solo.coderiver.user.dataobject.UserLike;
importcom.solo.coderiver.user.dto.LikedCountDTO;
importcom.solo.coderiver.user.enums.LikedStatusEnum;
importcom.solo.coderiver.user.repository.UserLikeRepository;
importcom.solo.coderiver.user.service.LikedService;
importcom.solo.coderiver.user.service.RedisService;
importcom.solo.coderiver.user.service.UserService;
importlombok.extern.slf4j.Slf4j;
importorg.springframework.beans.factory.annotation.Autowired;
importorg.springframework.data.domain.Page;
importorg.springframework.data.domain.Pageable;
importorg.springframework.stereotype.Service;
importorg.springframework.transaction.annotation.Transactional;
importjava.util.List;
@Service
@Slf4j
publicclassLikedServiceImplimplementsLikedService{
@Autowired
UserLikeRepositorylikeRepository;
@Autowired
RedisServiceredisService;
@Autowired
UserServiceuserService;
@Override
@Transactional
publicUserLikesave(UserLikeuserLike){
returnlikeRepository.save(userLike);
}
@Override
@Transactional
publicList<UserLike>saveAll(List<UserLike>list){
returnlikeRepository.saveAll(list);
}
@Override
publicPage<UserLike>getLikedListByLikedUserId(StringlikedUserId,Pageablepageable){
returnlikeRepository.findByLikedUserIdAndStatus(likedUserId,LikedStatusEnum.LIKE.getCode(),pageable);
}
@Override
publicPage<UserLike>getLikedListByLikedPostId(StringlikedPostId,Pageablepageable){
returnlikeRepository.findByLikedPostIdAndStatus(likedPostId,LikedStatusEnum.LIKE.getCode(),pageable);
}
@Override
publicUserLikegetByLikedUserIdAndLikedPostId(StringlikedUserId,StringlikedPostId){
returnlikeRepository.findByLikedUserIdAndLikedPostId(likedUserId,likedPostId);
}
@Override
@Transactional
publicvoidtransLikedFromRedis2DB(){
List<UserLike>list=redisService.getLikedDataFromRedis();
for(UserLikelike:list){
UserLikeul=getByLikedUserIdAndLikedPostId(like.getLikedUserId(),like.getLikedPostId());
if(ul==null){
//没有记录，直接存入
save(like);
}else{
//有记录，需要更新
ul.setStatus(like.getStatus());
save(ul);
}
}
}
@Override
@Transactional
publicvoidtransLikedCountFromRedis2DB(){
List<LikedCountDTO>list=redisService.getLikedCountFromRedis();
for(LikedCountDTOdto:list){
UserInfouser=userService.findById(dto.getId());
//点赞数量属于无关紧要的操作，出错无需抛异常
if(user!=null){
IntegerlikeNum=user.getLikeNum()+dto.getCount();
user.setLikeNum(likeNum);
//更新点赞数量
userService.updateInfo(user);
}
}
}
}
数据库的操作就这些，主要还是增删改查。
四、开启定时任务持久化存储到数据库
定时任务 Quartz 很强大，就用它了。
Quartz 使用步骤：
1.添加依赖
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-quartz</artifactId>
</dependency>
2.编写配置文件
packagecom.solo.coderiver.user.config;
importcom.solo.coderiver.user.task.LikeTask;
importorg.quartz.*;
importorg.springframework.context.annotation.Bean;
importorg.springframework.context.annotation.Configuration;
@Configuration
publicclassQuartzConfig{
privatestaticfinalStringLIKE_TASK_IDENTITY="LikeTaskQuartz";
@Bean
publicJobDetailquartzDetail(){
returnJobBuilder.newJob(LikeTask.class).withIdentity(LIKE_TASK_IDENTITY).storeDurably().build();
}
@Bean
publicTriggerquartzTrigger(){
SimpleScheduleBuilderscheduleBuilder=SimpleScheduleBuilder.simpleSchedule()
//.withIntervalInSeconds(10)//设置时间周期单位秒
.withIntervalInHours(2)//两个小时执行一次
.repeatForever();
returnTriggerBuilder.newTrigger().forJob(quartzDetail())
.withIdentity(LIKE_TASK_IDENTITY)
.withSchedule(scheduleBuilder)
.build();
}
}
3.编写执行任务的类继承自 QuartzJobBean
packagecom.solo.coderiver.user.task;
importcom.solo.coderiver.user.service.LikedService;
importlombok.extern.slf4j.Slf4j;
mons.lang.time.DateUtils;
importorg.quartz.JobExecutionContext;
importorg.quartz.JobExecutionException;
importorg.springframework.beans.factory.annotation.Autowired;
importorg.springframework.scheduling.quartz.QuartzJobBean;
importjava.text.SimpleDateFormat;
importjava.util.Date;
/**
*点赞的定时任务
*/
@Slf4j
publicclassLikeTaskextendsQuartzJobBean{
@Autowired
LikedServicelikedService;
privateSimpleDateFormatsdf=newSimpleDateFormat("yyyy-MM-ddHH:mm:ss");
@Override
protectedvoidexecuteInternal(JobExecutionContextjobExecutionContext)throwsJobExecutionException{
log.info("LikeTask--------{}",sdf.format(newDate()));
//将Redis里的点赞信息同步到数据库里
likedService.transLikedFromRedis2DB();
likedService.transLikedCountFromRedis2DB();
}
}
在定时任务中直接调用 LikedService 封装的方法完成数据同步。
以上就是点赞功能的设计与实现，不足之处还请各位大佬多多指教。
如有更好的实现方案欢迎在评论区交流…
代码出自开源项目 CodeRiver，欢迎围观：
/cachecats/coderiver
