[Springboot] '최근 읽은 글' Dto로 Redis에 저장하고 조회하기 AtoZ (2) - 수정, 삭제 편

2021.06.18 - [🌱 Develop/Server] - [Springboot] '최근 읽은 글' Dto로 Redis에 저장하고 조회하기 AtoZ

[Springboot] '최근 읽은 글' Dto로 Redis에 저장하고 조회하기 AtoZ

이전 글에서는 간단하게 redis에 list로 조회한 글 Dto를 저장하였습니다. 하지만 실제로 프론트에 배포를 하고 나니, 크게 두 가지 이슈를 간과하고 있어서 두 번째 글을 쓰게 되었습니다.

현재 로직으로는 postIdx 를 통해 해당 post 조회 값을 Dto로 변환하고, 이 Dto를 list에 저장하는 방식인데, "조회 내용 결과"를 저장하기 때문에 다음과 같은 문제가 생깁니다.

• post 원 글이 수정, 삭제되었을 때 내용이 반영되지 않는다.
• list는 중복을 허용하기 때문에 같은 글을 여러 번 읽으면 똑같은 글이 redis에 쌓인다.

그래서 다음과 같이 변경하였습니다.

📌 List 타입에서 '정렬이 가능한 set 타입'인 zSet 로 중복을 제거하고, 최근 읽은 순서대로 정렬하도록 변경

📌 조회 내용 결과 저장이 아니라 postIdx를 redis에 저장

1. RecentLog 수정

먼저 recentLog 도메인부터 수정해야합니다. 이전에는 userIdx와 postDto.ListDto 를 저장하도록 했지만, 지금은 postIdx를 저장할 것이기 때문에 Long 타입으로 수정해줍니다.

 

📂  domain/RecentLog

@RedisHash("userIdx")
@Getter @ToString @NoArgsConstructor @AllArgsConstructor @Builder
public class RecentLog {

    @Id
    private  Long userIdx;
    private  Long postIdx;

}

2. Service

1️⃣ Redis에 저장하기

RedisTemplate 도 <String, PostDto.List> 에서 <String, RecentLog> 로 변경하고, opsForList() 를 opsForZSet() 으로 변경해줍니다. RedisTemplate 에는 다양한 메소드들 준비되어 있는데, RedisTemplate로 들어가면 다음과 같은 메소드들을 확인할 수 있습니다.

앞서 말했듯이, Set이 아니라 ZSet을 고른 이유는 '순서'가 있고 없고의 차이가 있기 때문입니다.

예를 들어서 Set으로 postIdx를 저장하면 읽은 순서와 상관없이 저장이 됩니다. 하지만 '최근 읽은 글'은 내가 가장 최근에 읽은 순서대로 정렬이 되어야 하기 때문에, ZSet으로 설정해주었습니다.

📂 listService

    private final PostMapper postMapper;
    private final PostRepository postRepository;
    private final RedisTemplate<String, RecentLog> redisTemplate;

    // 최근 읽은 글 저장 -> set으로 변경, postIdx 저장
    @Transactional
    public void saveRecentReadPosts(Long userIdx, Long postIdx){
        ZSetOperations<String, RecentLog> zSetOps = redisTemplate.opsForZSet();
        RecentLog recentLog = RecentLog.builder().userIdx(userIdx).postIdx(postIdx).build();
        zSetOps.add(setKey(userIdx), recentLog, new java.util.Date().getTime()); // score은 타임스탬프(최신 읽은 순대로 정렬위해)
        redisTemplate.expireAt(setKey(userIdx), Date.from(ZonedDateTime.now().plusDays(7).toInstant())); // 유효기간 TTL 일주일 설정
    }

• zSetOps에는 add를 할 때 (key 값, 저장할 값, score) 가 필요합니다. 이전과 달리 score이란 값이 추가되었습니다. 여기서 score은 값을 정렬상태로 유지하기 위해 필요한 값으로, 쉽게 설명하자면 userIdx::2라는 "key"로 조회하면 key(recentLog) : value (score)의 set 값을 조회합니다.
• list 때와 동일하게 redisTemplate로 유효기간을 7일로 설정합니다.

2️⃣ Redis에서 조회하기

다음은 조회하는 기능을 수정해보겠습니다.

📂 listService

  // 최근 읽은 글 조회
    @Transactional
    public List<PostDto.ListResponse> findRecentPosts(Long userIdx) {
        ZSetOperations<String, RecentLog> zSetOps = redisTemplate.opsForZSet();
        ObjectMapper objectMapper = new ObjectMapper(); // linkedHashMap으로 저장된 redis 값들을 List로 변환해줌
        List<RecentLog> result = objectMapper.convertValue(Objects.requireNonNull(zSetOps.reverseRange(setKey(userIdx), 0, -1)),
                new TypeReference<List<RecentLog>>() {
        });
        return result.stream().map(x -> postMapper.postToListResponse(findPostById(x.getPostIdx()), userIdx)).collect(Collectors.toList());

    }


     private String setKey(Long userIdx){
        return "userIdx::"+userIdx;
    }

• zSetOps에서 reverseRange를 사용하여 가장 나중에 추가된 글( == 가장 최근에 읽은 글)을 먼저 오도록 값을 가져옵니다. reverseRange(key값, 시작 인덱스, 끝 인덱스)를 설정하여 한꺼번에 값을 가져왔습니다.
• 하지만 이대로 Redis에서 조회한 값을 map으로 dto 변환하려하면 해당 에러가 납니다.
  java.util.LinkedHashMap cannot be cast to ......List나 dto.....해당 에러가 나는 이유는 redis에서는 LinkedHashMap으로 값이 저장되는데, zSetOperations 로 저장하면 [ {하나}, {둘}, {셋} ]... 이런 식으로 저장되어 조회됩니다. 그래서 이 배열을 갖고와서 dto로 변환하려고 하면,에러를 맞이하는 것입니다.
• 그래서 objectMapper을 사용해서 LinkedHashMap을 list로 변환한 뒤, dto로 다시 바꿔주어야합니다.
• ObjectMapper objectMapper = new ObjectMapper(); // linkedHashMap으로 저장된 redis 값들을 List로 변환해줌 List<RecentLog> result = objectMapper.convertValue(Objects.requireNonNull(zSetOps.reverseRange(setKey(userIdx), 0, -1)), new TypeReference<List<RecentLog>>() { });
• 이 이후로는 평소 하던대로 list를 dto로 바꾸어 리턴해주면 됩니다.

 

3️⃣ 원글 삭제 시 redis에서도 값 삭제 

원글의 수정사항이 반영되지 않는 문제 외에도, 글이 삭제되면 "최근 조회한 글" 목록에서도 자연스럽게 삭제되어야 합니다. 그래서 이번에는 postService를 같이 수정해주겠습니다. 

 

📂 postService

  // 회고글 삭제
    @Transactional
    public boolean deletePosts(Long userIdx,Long postIdx) {
        Post post = postRepository.findById(postIdx)
                .orElseThrow(() -> new EntityNullException(ErrorInfo.POST_NULL));
        if (isWriter(post.getUser().getUserIdx(), userIdx)){
            postRepository.deleteById(postIdx);
            if (listService.isPostsExist(userIdx, postIdx)) listService.deleteRedisPost(userIdx, postIdx); // redis 에서도 삭제
            return true;
        }
        return false;
    }

• isPostExist 메소드로 "Redis에 해당 postIdx" 가 있는지 검사합니다. 
• 만약 글이 있으면 원글이 삭제될 때 Redis에서도 같이 삭제해주는 deleteRedisPost 를 실행합니다.

📂 listService

Redis에 값이 존재하는지 체크하는 메소드입니다. "최근 읽은 글 조회" 와 동일하게 Redis에 있는 목록들을 가져와서 해당 postIdx를 포함하고 있는지 판별합니다. 

 public boolean isPostsExist(Long userIdx, Long postIdx){
        ZSetOperations<String, RecentLog> zSetOps = redisTemplate.opsForZSet();
        RecentLog recentLog = RecentLog.builder().userIdx(userIdx).postIdx(postIdx).build();
        ObjectMapper objectMapper = new ObjectMapper();
        List<RecentLog> result = objectMapper.convertValue(Objects.requireNonNull(zSetOps.reverseRange(setKey(userIdx), 0, -1)),
                new TypeReference<List<RecentLog>>() {
                });
        return result.contains(recentLog);
    }

삭제할 때는 RecentLog 값을 실제 key로 저장했으므로, key를 찾아 삭제하는 remove 메소드를 사용해줍니다.

    // redis에서 value 삭제
    public void deleteRedisPost(Long userIdx,Long postIdx){
        ZSetOperations<String, RecentLog> zSetOps = redisTemplate.opsForZSet();
        RecentLog recentLog = RecentLog.builder().userIdx(userIdx).postIdx(postIdx).build();
        zSetOps.remove(setKey(userIdx), recentLog);
    }

 

3. 결과

swagger에서 테스트해보겠습니다. 현재 userIdx는 accessToken에서 받고 있기 때문에 따로 넘겨주는 값 없이 실행만 시켜주었습니다.

{
  "statusCode": 200,
  "responseMessage": "최근 읽은 글 조회 성공",
  "data": [
    {
      "postIdx": 67,
      "title": "KB 카드 공모전을 하면서 진행했던 회의들을 회고하고자한다.",
      "category": "plan",
      "contents": "<div contenteditable=\"true\" class=\"tui-editor-contents\" style=\"min-height: 168px;\"><h1><div>1. Drop<br></div></h1><ul><li><span class=\"colour\" style=\"color: rgb(0, 0, 0);\">늘어지는 회의시간</span><br></li><li><span class=\"colour\" style=\"color: rgb(0, 0, 0);\">미숙한 준비상태</span><br></li><li><span class=\"colour\" style=\"color: rgb(0, 0, 0);\">감정적인 반응들</span><br></li><li><span class=\"colour\" style=\"color: rgb(0, 0, 0);\">개개인의 피곤한 상태</span><br><br></li></ul><h1><div>2. Add<br></div></h1><ul><li><span class=\"colour\" style=\"color: rgb(0, 0, 0);\">회의 안건을 제작하여 간결하게 회의 진행</span><br></li></ul><div><br></div><h1><div>3. Keep<br></div></h1><ul><li><span class=\"colour\" style=\"color: rgb(0, 0, 0);\">편하게 의견을 공유하는 분위기</span><br></li><li><span class=\"colour\" style=\"color: rgb(0, 0, 0);\">회의 후 빠른 정리 및 피드백</span><br></li></ul><div><br></div><h1><div>4. Improve<br></div></h1><ul><li><span class=\"colour\" style=\"color: rgb(0, 0, 0);\">편하게 의견을 공유하지만, 준비는 철저하게할 것</span><br></li><li><span class=\"colour\" style=\"color: rgb(0, 0, 0);\">​</span><span class=\"colour\" style=\"color: rgb(0, 0, 0);\">회의 후 정리가 빠른 만큼 중간 자료 공유때도 체계적으로 정리하기</span><br><br></li></ul><div><br></div><div><br></div></div><div><br></div>",
      "nickname": "잼민",
      "profile": "https://s3doraboda.s3.ap-northeast-2.amazonaws.com/images/7/profiles/%EA%B3%A0%EC%96%91%EC%9D%B4.jpg",
      "tagList": [
        {
          "tag": "페르소나에서시작하기"
        }
      ],
      "view": 242,
      "createdAt": "May 30, 2021",
      "commentCnt": 3,
      "scrapCnt": 4,
      "scrap": true
    },
    {
      "postIdx": 153,
      "title": "이미지 임시저장 테스트입니다.",
      "category": "develop",
      "contents": "서버!열정!열정!열정!통신!통신!통신!으아아!",
      "nickname": "쩡",
      "profile": "https://s3doraboda.s3.ap-northeast-2.amazonaws.com/images/2/profiles/%E1%84%8B%E1%85%AE%E1%86%BA%E1%84%8B%E1%85%A5%3F.jpeg",
      "tagList": [
        {
          "tag": "살려줘"
        },
        {
          "tag": "할 수 있어"
        }
      ],
      "view": 18,
      "createdAt": "Jun 11, 2021",
      "commentCnt": 0,
      "scrapCnt": 0,
      "scrap": false
    },
    {
      "postIdx": 120,
      "title": "sdf",
      "category": "marketing",
      "contents": "<div class=\"tui-editor-contents\" style=\"min-height: 168px;\"><h1><div>1. Plus<br></div></h1><div><br></div><div><br></div><h1><div>2. Minus<br></div></h1><div><br></div><div><br></div><h1><div>3. Interesting<br></div></h1><div><br></div><div><br></div><div><br></div><div><br></div><div><br></div></div>",
      "nickname": "젠득이",
      "profile": "https://s3doraboda.s3.ap-northeast-2.amazonaws.com/images/3/profiles/img_20190529_001242.jpg",
      "tagList": [
        {
          "tag": "lala"
        }
      ],
      "view": 85,
      "createdAt": "Jun 11, 2021",
      "commentCnt": 3,
      "scrapCnt": 1,
      "scrap": false
    }
  ]
}

웹 페이지 적용 화면

🤔 최근 읽은 글 기능을 개발하면서 현재 리팩토링이 필요하다고 생각한 부분은, redis에 값이 존재하는지 체크하는 부분에서 "최근 읽은 글 조회" 기능과 동일하게 들어간다는 점입니다. 이외에도 중복되는 요소들이 생각보다 많이 있어서 메소드로 따로 빼는 것이 더 나은지 보고,동아리 발표 이후로 수정해볼 예정입니다.

 

 

 

 

📚 참고문헌

http://blog.zepinos.com/java-redis/2017/09/09/Redis-ZSET-01.html

zepinos BLOG

https://effectivesquid.tistory.com/entry/Spring%EC%97%90%EC%84%9C-Redis-ZSET%EA%B5%AC%EC%A1%B0-%EC%9D%B4%EC%9A%A9%ED%95%98%EA%B8%B0

Spring에서 Redis ZSET구조 이용하기

https://docs.spring.io/spring-data/redis/docs/current/api/org/springframework/data/redis/core/ZSetOperations.html

ZSetOperations (Spring Data Redis 2.5.2 API)