天天看點
傳回

redis實作點贊 取消點贊功能

1.2 Redis 與 SpringBoot 項目的整合

在 pom.xml 中引入依賴

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-data-redis</artifactId>
</dependency>

在啟動類上添加注釋 @EnableCaching

@SpringBootApplication
@EnableDiscoveryClient
@EnableSwagger2
@EnableFeignClients(basePackages = "com.solo.coderiver.project.client")
@EnableCaching
public class UserApplication {

    public static void main(String[] args) {
        SpringApplication.run(UserApplication.class, args);
    }
}

編寫 Redis 配置類 RedisConfig

import com.fasterxml.jackson.annotation.JsonAutoDetect;
import com.fasterxml.jackson.annotation.PropertyAccessor;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.data.redis.connection.RedisConnectionFactory;
import org.springframework.data.redis.core.RedisTemplate;
import org.springframework.data.redis.core.StringRedisTemplate;
import org.springframework.data.redis.serializer.Jackson2JsonRedisSerializer;

import java.net.UnknownHostException;


@Configuration
public class RedisConfig {

    @Bean
    @ConditionalOnMissingBean(name = "redisTemplate")
    public RedisTemplate<String, Object> redisTemplate(
            RedisConnectionFactory redisConnectionFactory)
            throws UnknownHostException {

        Jackson2JsonRedisSerializer<Object> jackson2JsonRedisSerializer = new Jackson2JsonRedisSerializer<Object>(Object.class);
        ObjectMapper om = new ObjectMapper();
        om.setVisibility(PropertyAccessor.ALL, JsonAutoDetect.Visibility.ANY);
        om.enableDefaultTyping(ObjectMapper.DefaultTyping.NON_FINAL);
        jackson2JsonRedisSerializer.setObjectMapper(om);

        RedisTemplate<String, Object> template = new RedisTemplate<String, Object>();
        template.setConnectionFactory(redisConnectionFactory);
        template.setKeySerializer(jackson2JsonRedisSerializer);
        template.setValueSerializer(jackson2JsonRedisSerializer);
        template.setHashKeySerializer(jackson2JsonRedisSerializer);
        template.setHashValueSerializer(jackson2JsonRedisSerializer);
        template.afterPropertiesSet();
        return template;
    }


    @Bean
    @ConditionalOnMissingBean(StringRedisTemplate.class)
    public StringRedisTemplate stringRedisTemplate(
            RedisConnectionFactory redisConnectionFactory)
            throws UnknownHostException {
        StringRedisTemplate template = new StringRedisTemplate();
        template.setConnectionFactory(redisConnectionFactory);
        return template;
    }
}

至此 Redis 在 SpringBoot 項目中的配置已經完成，可以愉快的使用了。

1.3 Redis 的資料結構類型

Redis 可以存儲鍵與 5 種不同資料結構類型之間的映射，這 5 種資料結構類型分别為 String（字元串）、List（清單）、Set（集合）、Hash（散列）和 Zset（有序集合）。

下面來對這 5 種資料結構類型作簡單的介紹：

redis實作點贊 取消點贊功能

1.4 點贊資料在 Redis 中的存儲格式

用 Redis 存儲兩種資料，一種是記錄點贊人、被點贊人、點贊狀态的資料，另一種是每個使用者被點贊了多少次，做個簡單的計數。

由于需要記錄點贊人和被點贊人，還有點贊狀态（點贊、取消點贊），還要固定時間間隔取出 Redis 中所有點贊資料，分析了下 Redis 資料格式中 Hash 最合适。

因為 Hash 裡的資料都是存在一個鍵裡，可以通過這個鍵很友善的把所有的點贊資料都取出。這個鍵裡面的資料還可以存成鍵值對的形式，友善存入點贊人、被點贊人和點贊狀态。

設點贊人的 id 為 likedPostId，被點贊人的 id 為 likedUserId ，點贊時狀态為 1，取消點贊狀态為 0。将點贊人 id 和被點贊人 id 作為鍵，兩個 id 中間用 :: 隔開，點贊狀态作為值。

是以如果使用者點贊，存儲的鍵為：likedUserId::likedPostId，對應的值為 1 。取消點贊，存儲的鍵為：likedUserId::likedPostId，對應的值為 0 。取資料時把鍵用 :: 切開就得到了兩個 id，也很友善。

在可視化工具 RDM 中看到的是這樣子

redis實作點贊 取消點贊功能

1.5 操作 Redis

将具體操作方法封裝到了 RedisService 接口裡

RedisService.java

import com.solo.coderiver.user.dataobject.UserLike;
import com.solo.coderiver.user.dto.LikedCountDTO;

import java.util.List;

public interface RedisService {

    /**
     * 點贊。狀态為1
     * @param likedUserId
     * @param likedPostId
     */
    void saveLiked2Redis(String likedUserId, String likedPostId);

    /**
     * 取消點贊。将狀态改變為0
     * @param likedUserId
     * @param likedPostId
     */
    void unlikeFromRedis(String likedUserId, String likedPostId);

    /**
     * 從Redis中删除一條點贊資料
     * @param likedUserId
     * @param likedPostId
     */
    void deleteLikedFromRedis(String likedUserId, String likedPostId);

    /**
     * 該使用者的點贊數加1
     * @param likedUserId
     */
    void incrementLikedCount(String likedUserId);

    /**
     * 該使用者的點贊數減1
     * @param likedUserId
     */
    void decrementLikedCount(String likedUserId);

    /**
     * 擷取Redis中存儲的所有點贊資料
     * @return
     */
    List<UserLike> getLikedDataFromRedis();

    /**
     * 擷取Redis中存儲的所有點贊數量
     * @return
     */
    List<LikedCountDTO> getLikedCountFromRedis();

}

實作類 RedisServiceImpl.java

import com.solo.coderiver.user.dataobject.UserLike;
import com.solo.coderiver.user.dto.LikedCountDTO;
import com.solo.coderiver.user.enums.LikedStatusEnum;
import com.solo.coderiver.user.service.LikedService;
import com.solo.coderiver.user.service.RedisService;
import com.solo.coderiver.user.utils.RedisKeyUtils;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.data.redis.core.Cursor;
import org.springframework.data.redis.core.RedisTemplate;
import org.springframework.data.redis.core.ScanOptions;
import org.springframework.stereotype.Service;

import java.util.ArrayList;
import java.util.List;
import java.util.Map;

@Service
@Slf4j
public class RedisServiceImpl implements RedisService {

    @Autowired
    RedisTemplate redisTemplate;

    @Autowired
    LikedService likedService;

    @Override
    public void saveLiked2Redis(String likedUserId, String likedPostId) {
        String key = RedisKeyUtils.getLikedKey(likedUserId, likedPostId);
        redisTemplate.opsForHash().put(RedisKeyUtils.MAP_KEY_USER_LIKED, key, LikedStatusEnum.LIKE.getCode());
    }

    @Override
    public void unlikeFromRedis(String likedUserId, String likedPostId) {
        String key = RedisKeyUtils.getLikedKey(likedUserId, likedPostId);
        redisTemplate.opsForHash().put(RedisKeyUtils.MAP_KEY_USER_LIKED, key, LikedStatusEnum.UNLIKE.getCode());
    }

    @Override
    public void deleteLikedFromRedis(String likedUserId, String likedPostId) {
        String key = RedisKeyUtils.getLikedKey(likedUserId, likedPostId);
        redisTemplate.opsForHash().delete(RedisKeyUtils.MAP_KEY_USER_LIKED, key);
    }

    @Override
    public void incrementLikedCount(String likedUserId) {
        redisTemplate.opsForHash().increment(RedisKeyUtils.MAP_KEY_USER_LIKED_COUNT, likedUserId, 1);
    }

    @Override
    public void decrementLikedCount(String likedUserId) {
        redisTemplate.opsForHash().increment(RedisKeyUtils.MAP_KEY_USER_LIKED_COUNT, likedUserId, -1);
    }

    @Override
    public List<UserLike> getLikedDataFromRedis() {
        Cursor<Map.Entry<Object, Object>> cursor = redisTemplate.opsForHash().scan(RedisKeyUtils.MAP_KEY_USER_LIKED, ScanOptions.NONE);
        List<UserLike> list = new ArrayList<>();
        while (cursor.hasNext()){
            Map.Entry<Object, Object> entry = cursor.next();
            String key = (String) entry.getKey();
            //分離出 likedUserId，likedPostId
            String[] split = key.split("::");
            String likedUserId = split[0];
            String likedPostId = split[1];
            Integer value = (Integer) entry.getValue();

            //組裝成 UserLike 對象
            UserLike userLike = new UserLike(likedUserId, likedPostId, value);
            list.add(userLike);

            //存到 list 後從 Redis 中删除
            redisTemplate.opsForHash().delete(RedisKeyUtils.MAP_KEY_USER_LIKED, key);
        }

        return list;
    }

    @Override
    public List<LikedCountDTO> getLikedCountFromRedis() {
        Cursor<Map.Entry<Object, Object>> cursor = redisTemplate.opsForHash().scan(RedisKeyUtils.MAP_KEY_USER_LIKED_COUNT, ScanOptions.NONE);
        List<LikedCountDTO> list = new ArrayList<>();
        while (cursor.hasNext()){
            Map.Entry<Object, Object> map = cursor.next();
            //将點贊數量存儲在 LikedCountDT
            String key = (String)map.getKey();
            LikedCountDTO dto = new LikedCountDTO(key, (Integer) map.getValue());
            list.add(dto);
            //從Redis中删除這條記錄
            redisTemplate.opsForHash().delete(RedisKeyUtils.MAP_KEY_USER_LIKED_COUNT, key);
        }
        return list;
    }
}

用到的工具類和枚舉類

RedisKeyUtils, 用于根據一定規則生成 key

public class RedisKeyUtils {

    //儲存使用者點贊資料的key
    public static final String MAP_KEY_USER_LIKED = "MAP_USER_LIKED";
    //儲存使用者被點贊數量的key
    public static final String MAP_KEY_USER_LIKED_COUNT = "MAP_USER_LIKED_COUNT";

    /**
     * 拼接被點贊的使用者id和點贊的人的id作為key。格式 222222::333333
     * @param likedUserId 被點贊的人id
     * @param likedPostId 點贊的人的id
     * @return
     */
    public static String getLikedKey(String likedUserId, String likedPostId){
        StringBuilder builder = new StringBuilder();
        builder.append(likedUserId);
        builder.append("::");
        builder.append(likedPostId);
        return builder.toString();
    }
}

LikedStatusEnum 使用者點贊狀态的枚舉類

package com.solo.coderiver.user.enums;

import lombok.Getter;

/**
 * 使用者點贊的狀态
 */
@Getter
public enum LikedStatusEnum {
    LIKE(1, "點贊"),
    UNLIKE(0, "取消點贊/未點贊"),
    ;

    private Integer code;

    private String msg;

    LikedStatusEnum(Integer code, String msg) {
        this.code = code;
        this.msg = msg;
    }
}

二、資料庫設計

資料庫表中至少要包含三個字段：被點贊使用者 id，點贊使用者 id，點贊狀态。再加上主鍵 id，建立時間，修改時間就行了。

建表語句

create table `user_like`(
    `id` int not null auto_increment,
    `liked_user_id` varchar(32) not null comment '被點贊的使用者id',
    `liked_post_id` varchar(32) not null comment '點贊的使用者id',
    `status` tinyint(1) default '1' comment '點贊狀态，0取消，1點贊',
    `create_time` timestamp not null default current_timestamp comment '建立時間',
  `update_time` timestamp not null default current_timestamp on update current_timestamp comment '修改時間',
    primary key(`id`),
    INDEX `liked_user_id`(`liked_user_id`),
    INDEX `liked_post_id`(`liked_post_id`)
) comment '使用者點贊表';

對應的對象 UserLike

import com.solo.coderiver.user.enums.LikedStatusEnum;
import lombok.Data;

import javax.persistence.Entity;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;

/**
 * 使用者點贊表
 */
@Entity
@Data
public class UserLike {

    //主鍵id
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Integer id;

    //被點贊的使用者的id
    private String likedUserId;

    //點贊的使用者的id
    private String likedPostId;

    //點贊的狀态.預設未點贊
    private Integer status = LikedStatusEnum.UNLIKE.getCode();

    public UserLike() {
    }

    public UserLike(String likedUserId, String likedPostId, Integer status) {
        this.likedUserId = likedUserId;
        this.likedPostId = likedPostId;
        this.status = status;
    }
}

三、資料庫操作

操作資料庫同樣封裝在接口中

LikedService

import com.solo.coderiver.user.dataobject.UserLike;
import org.springframework.data.domain.Page;
import org.springframework.data.domain.Pageable;

import java.util.List;

public interface LikedService {

    /**
     * 儲存點贊記錄
     * @param userLike
     * @return
     */
    UserLike save(UserLike userLike);

    /**
     * 批量儲存或修改
     * @param list
     */
    List<UserLike> saveAll(List<UserLike> list);


    /**
     * 根據被點贊人的id查詢點贊清單（即查詢都誰給這個人點贊過）
     * @param likedUserId 被點贊人的id
     * @param pageable
     * @return
     */
    Page<UserLike> getLikedListByLikedUserId(String likedUserId, Pageable pageable);

    /**
     * 根據點贊人的id查詢點贊清單（即查詢這個人都給誰點贊過）
     * @param likedPostId
     * @param pageable
     * @return
     */
    Page<UserLike> getLikedListByLikedPostId(String likedPostId, Pageable pageable);

    /**
     * 通過被點贊人和點贊人id查詢是否存在點贊記錄
     * @param likedUserId
     * @param likedPostId
     * @return
     */
    UserLike getByLikedUserIdAndLikedPostId(String likedUserId, String likedPostId);

    /**
     * 将Redis裡的點贊資料存入資料庫中
     */
    void transLikedFromRedis2DB();

    /**
     * 将Redis中的點贊數量資料存入資料庫
     */
    void transLikedCountFromRedis2DB();

}

LikedServiceImpl 實作類

import com.solo.coderiver.user.dataobject.UserInfo;
import com.solo.coderiver.user.dataobject.UserLike;
import com.solo.coderiver.user.dto.LikedCountDTO;
import com.solo.coderiver.user.enums.LikedStatusEnum;
import com.solo.coderiver.user.repository.UserLikeRepository;
import com.solo.coderiver.user.service.LikedService;
import com.solo.coderiver.user.service.RedisService;
import com.solo.coderiver.user.service.UserService;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.data.domain.Page;
import org.springframework.data.domain.Pageable;
import org.springframework.stereotype.Service;
import org.springframework.transaction.annotation.Transactional;

import java.util.List;

@Service
@Slf4j
public class LikedServiceImpl implements LikedService {

    @Autowired
    UserLikeRepository likeRepository;

    @Autowired
    RedisService redisService;

    @Autowired
    UserService userService;

    @Override
    @Transactional
    public UserLike save(UserLike userLike) {
        return likeRepository.save(userLike);
    }

    @Override
    @Transactional
    public List<UserLike> saveAll(List<UserLike> list) {
        return likeRepository.saveAll(list);
    }

    @Override
    public Page<UserLike> getLikedListByLikedUserId(String likedUserId, Pageable pageable) {
        return likeRepository.findByLikedUserIdAndStatus(likedUserId, LikedStatusEnum.LIKE.getCode(), pageable);
    }

    @Override
    public Page<UserLike> getLikedListByLikedPostId(String likedPostId, Pageable pageable) {
        return likeRepository.findByLikedPostIdAndStatus(likedPostId, LikedStatusEnum.LIKE.getCode(), pageable);
    }

    @Override
    public UserLike getByLikedUserIdAndLikedPostId(String likedUserId, String likedPostId) {
        return likeRepository.findByLikedUserIdAndLikedPostId(likedUserId, likedPostId);
    }

    @Override
    @Transactional
    public void transLikedFromRedis2DB() {
        List<UserLike> list = redisService.getLikedDataFromRedis();
        for (UserLike like : list) {
            UserLike ul = getByLikedUserIdAndLikedPostId(like.getLikedUserId(), like.getLikedPostId());
            if (ul == null){
                //沒有記錄，直接存入
                save(like);
            }else{
                //有記錄，需要更新
                ul.setStatus(like.getStatus());
                save(ul);
            }
        }
    }

    @Override
    @Transactional
    public void transLikedCountFromRedis2DB() {
        List<LikedCountDTO> list = redisService.getLikedCountFromRedis();
        for (LikedCountDTO dto : list) {
            UserInfo user = userService.findById(dto.getId());
            //點贊數量屬于無關緊要的操作，出錯無需抛異常
            if (user != null){
                Integer likeNum = 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、 編寫配置檔案

package com.solo.coderiver.user.config;

import com.solo.coderiver.user.task.LikeTask;
import org.quartz.*;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class QuartzConfig {

    private static final String LIKE_TASK_IDENTITY = "LikeTaskQuartz";

    @Bean
    public JobDetail quartzDetail(){
        return JobBuilder.newJob(LikeTask.class).withIdentity(LIKE_TASK_IDENTITY).storeDurably().build();
    }

    @Bean
    public Trigger quartzTrigger(){
        SimpleScheduleBuilder scheduleBuilder = SimpleScheduleBuilder.simpleSchedule()
//                .withIntervalInSeconds(10)  //設定時間周期機關秒
                .withIntervalInHours(2)  //兩個小時執行一次
                .repeatForever();
        return TriggerBuilder.newTrigger().forJob(quartzDetail())
                .withIdentity(LIKE_TASK_IDENTITY)
                .withSchedule(scheduleBuilder)
                .build();
    }
}

3、 編寫執行任務的類繼承自 QuartzJobBean

package com.solo.coderiver.user.task;

import com.solo.coderiver.user.service.LikedService;
import lombok.extern.slf4j.Slf4j;
import org.apache.commons.lang.time.DateUtils;
import org.quartz.JobExecutionContext;
import org.quartz.JobExecutionException;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.scheduling.quartz.QuartzJobBean;

import java.text.SimpleDateFormat;
import java.util.Date;

/**
 * 點贊的定時任務
 */
@Slf4j
public class LikeTask extends QuartzJobBean {

    @Autowired
    LikedService likedService;

    private SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");

    @Override
    protected void executeInternal(JobExecutionContext jobExecutionContext) throws JobExecutionException {

        log.info("LikeTask-------- {}", sdf.format(new Date()));

        //将 Redis 裡的點贊資訊同步到資料庫裡
        likedService.transLikedFromRedis2DB();
        likedService.transLikedCountFromRedis2DB();
    }
}

在定時任務中直接調用 LikedService 封裝的方法完成資料同步。

以上就是點贊功能的設計與實作，不足之處還請各位大佬多多指教。

另外，點贊 / 取消點贊 跟 點贊數 +1/ -1 應該保證是原子操作 , 不然出現并發問題就會有兩條重複的點贊記錄 , 是以要給整個原子操作加鎖 .

同時需要在 Spring Boot 的系統關閉鈎子函數中補充同步 redis 中點贊資料到 mysql 中的過程 . 不然有可能出現距離上一次同步 1 小時 59 分的時候伺服器更新 , 把整整兩小時的點贊資料都給清空了 . 如果點贊設計到比較重要活動業務的話這就很尴尬了。

# redis Redis
上一篇: 點贊子產品設計：Redis緩存 + 定時寫入資料庫實作高性能點贊功能 作者：solocoder 來源：juejin.im/post/5bdc257e6fb9a049ba410098
下一篇: Spring Cloud + Redis 是如何實作點贊、取消點贊的？一、Redis 緩存設計及實作二、資料庫設計三、資料庫操作四、開啟定時任務持久化存儲到資料庫

繼續閱讀