🔀 :: 레디스 캐시 적용 #347

Umjiseung · 2024-09-01T15:48:16Z

💡 배경 및 개요

메인 페이지의 등록된 서비스(PUBLIC) 리스트와 관리자 페이지의 유저 리스트에 레디스를 이용하여 캐시를 적용하였습니다.

등록된 서비스 캐시 적용 전

등록된 서비스 캐시 적용 후

유저 리스트 캐시 적용 전

유저 리스트 캐시 적용 후

Resolves: #346

📃 작업내용

�레디스 캐시에 대한 설정을 추가하였고 유저에 관한 캐시매니저와 서비스에 관한 캐시매니저를 따로 두어 관리하고 유저 리스트를 불러오는 api를 호출하면 캐시에 올라가고 유저 수락 api가 호출되면 올라간 캐시는 사라집니다.

서비스 캐시는 PUBLIC으로 되어있는 서비스를 반환하는 api가 호출되면 캐시에 올라가고 서비스에 관한 모든 CUD api가 호출되면 모든 엔트리는 삭제됩니다.

🙋‍♂️ 리뷰노트

아직 캐시에 대한 이해도가 부족하여 감안하고 코드리뷰 부탁드립니다!
데이터베이스의 이슈로 유저에 관한 캐시 테스트를 하지 못해 pr을 확인해주시면서 브랜치로 이동해주셔서 테스트 한번만 해주시면 감사하겠습니다!

24/9/3
유저 리스트 관한 테스트 진행 후 이상 없음을 확인하였습니다.

✅ PR 체크리스트

템플릿 체크리스트 말고도 추가적으로 필요한 체크리스트는 추가해주세요!

이 작업으로 인해 변경이 필요한 문서가 변경되었나요? (e.g. .env, 노션, README)
이 작업을 하고나서 공유해야할 팀원들에게 공유되었나요? (e.g. "API 개발 완료됐어요", "환경값 추가되었어요")
작업한 코드가 정상적으로 동작하나요?
Merge 대상 브랜치가 올바른가요?
PR과 관련 없는 작업이 있지는 않나요?
이 작업으로 인해 발생한 변경 사항이 Resource 서버에도 반영되었나요?

🎸 기타

KimTaeO · 2024-09-04T13:06:20Z

src/main/kotlin/com/msg/gauth/domain/user/service/GetAcceptedUsersService.kt


 @ReadOnlyService
 class GetAcceptedUsersService(
    private val userRepository: UserRepository,
 ) {
+
+    @Cacheable(value = ["AcceptedUser"], cacheManager = "userCacheManager")


여러개의 엔트리가 존재할 수도 있는 상황이므로 key를 지정하는 방식을 명시해줄 필요가 있어 보이고, 각 엔트리마다 캐싱을 하는 것은 매우 비효율적이며 Redis에 부담을 줄 수 있는 작업으로 보입니다 @Cacheable의 condition 필드를 이용해보는것도 좋겠네요

2fa0c71
말씀하신대로 파라미터에 따라 여러개의 엔트리가 존재할 것 같아요 그래서 각 엔트리마다 캐싱을 하는 것은 비효율적이라고 생각이 들어 condition을 지정하여 첫 요청 시에 보내지는 모든 학생 리스트만 캐싱하기 위해 condition 속성을 추가하였어요

KimTaeO · 2024-09-04T13:07:19Z

src/main/kotlin/com/msg/gauth/domain/user/service/AcceptUserSignUpService.kt


 @TransactionalService
 class AcceptUserSignUpService(
    private val userRepository: UserRepository,
    private val userRoleRepository: UserRoleRepository
 ) {

+    @CacheEvict(value = ["AcceptedUser"], allEntries = true, cacheManager = "userCacheManager")


위의 코멘트에 남긴 key를 통해 엔트리를 삭제하던가 수정을 하는것이 바람직해 보입니다

�위에와 같이 condition을 지정해서 해결하였습니다

KimTaeO · 2024-09-04T13:08:44Z

src/main/kotlin/com/msg/gauth/global/redis/RedisCacheConfig.kt

+    @Bean
+    @Primary
+    fun clientCacheManager(factory: RedisConnectionFactory?): CacheManager {
+        val cacheConfig = RedisCacheConfiguration.defaultCacheConfig()
+            .serializeKeysWith(RedisSerializationContext.SerializationPair.fromSerializer(StringRedisSerializer()))
+            .serializeValuesWith(
+                RedisSerializationContext.SerializationPair.fromSerializer(
+                    GenericJackson2JsonRedisSerializer()
+                )
+            )
+            .entryTtl(Duration.ofMinutes(10))
+
+        return RedisCacheManager
+            .RedisCacheManagerBuilder
+            .fromConnectionFactory(factory!!)
+            .cacheDefaults(cacheConfig)
+            .build()
+    }
+
+    @Bean
+    fun userCacheManager(factory: RedisConnectionFactory?): CacheManager {
+        val cacheConfig = RedisCacheConfiguration.defaultCacheConfig()
+            .serializeKeysWith(RedisSerializationContext.SerializationPair.fromSerializer(StringRedisSerializer()))
+            .serializeValuesWith(
+                RedisSerializationContext.SerializationPair.fromSerializer(
+                    GenericJackson2JsonRedisSerializer()
+                )
+            )
+            .entryTtl(Duration.ofMinutes(10))
+
+        return RedisCacheManager
+            .RedisCacheManagerBuilder
+            .fromConnectionFactory(factory!!)


제가 보기엔 도메인별로 cacheManager를 따로 사용하도록 의도하신 것 같은데 그러한 이유가 있으실까요?

도메인별로 구분해서 사용하면 데이터를 보기에 편할 것 같아서 사용했습니다
별 다른 의미는 없습니다

그렇다면 그냥 도메인별로 나누는것보다 cacheManager를 redisCacheManager로 통일하고 어떤 목적에 의해서 사용되는지 Cache 설정을 다르게 적용하는 식으로 변경하는게 좋을 것 같습니다

좋은 것 같아요 수정하겠습니다

1e03118
4597c4b
수정했습니다

KimTaeO · 2024-09-04T13:10:55Z

src/main/kotlin/com/msg/gauth/domain/client/service/DeleteClientService.kt

@@ -13,6 +14,7 @@ class DeleteClientService(
    private val userUtil: UserUtil,
 ) {

+    @CacheEvict(value = ["Clients"], allEntries = true, cacheManager = "clientCacheManager")


제가 알기로는 캐시 value를 yml에 이름으로 미리 정의해서 캐시 저장소가 첫 요청 시에 동적으로 만들어지는 것이 아닌 정적으로 만들어지도록 하는것이 좋아보입니다

근데 이거 조금더 찾아 보시고 해주셨으면 해요 제가 틀렸을 수도 있습니다

d04c3c5
말씀해주신 방법으로 수정해보았습니다 말씀하신거랑 맞는지 모르겠어서 확인해주세요!

KimTaeO · 2024-09-06T01:02:17Z

src/main/resources/application.yml

+    type: redis
+    cache-names:
+        - Clients
+        - AcceptedUser


이제보니 캐시 이름이 AcceptedUser 보다는 복수형인 AcceptedUsers가 더 적절해 보입니다

df5a677
저도 그런 것 같네요 수정하였습니다

src/main/kotlin/com/msg/gauth/domain/user/service/GetAcceptedUsersService.kt

…sersService.kt Co-authored-by: 김태오 <103710151+KimTaeO@users.noreply.github.com>

src/main/kotlin/com/msg/gauth/domain/admin/service/ExcelParsingService.kt

src/main/kotlin/com/msg/gauth/domain/user/service/AcceptUserSignUpService.kt

src/main/kotlin/com/msg/gauth/domain/user/service/GetAcceptedUsersService.kt

…sersService.kt Co-authored-by: 김태오 <103710151+KimTaeO@users.noreply.github.com>

…gnUpService.kt Co-authored-by: 김태오 <103710151+KimTaeO@users.noreply.github.com>

…gService.kt Co-authored-by: 김태오 <103710151+KimTaeO@users.noreply.github.com>

Umjiseung added 10 commits September 1, 2024 23:26

add :: RedisCacheConfig 추가

bd4efc8

add :: Spring Cache 의존성 추가

10d3c08

add :: CacheEvict 추가

ba8f29f

add :: JsonProperty 추가

1028570

add :: Cacheable 추가

9b3c22d

add :: EnableCaching 추가

447b116

add :: userCacheManager 추가

e3fb033

add :: Cacheable 추가

a259f59

add :: CacheEvict 추가

0f29e9a

add :: Primary 추가

69b46a8

Umjiseung added 2️⃣Priority: Medium 우선순위 중 ✨ Feature 기능 개발 labels Sep 1, 2024

Umjiseung self-assigned this Sep 1, 2024

Umjiseung requested review from dolong2, KimTaeO and baekteun as code owners September 1, 2024 15:48

Umjiseung linked an issue Sep 1, 2024 that may be closed by this pull request

레디스를 이용한 캐시 적용 #346

Closed

Umjiseung added 5 commits September 2, 2024 00:55

delete :: 빈줄 삭제

70d11c6

update :: 코드 스타일에 맞게 수정

3183a00

update :: 1분 -> 10분 변경

091b556

update :: clientCacheManager 1분 -> 10분 변경

6cf0b02

add :: JsonProperty 추가

ded532f

KimTaeO reviewed Sep 4, 2024

View reviewed changes

Umjiseung added 4 commits September 5, 2024 14:43

update :: redisCacheManager로 통일

4597c4b

update :: cacheManager를 redisCacheManager로 변경

1e03118

add :: redis에 정적으로 캐시 저장소가 만들어지게 설정

d04c3c5

delete :: import 삭제

58f6240

KimTaeO reviewed Sep 6, 2024

View reviewed changes

Umjiseung added 2 commits September 6, 2024 10:08

update :: AcceptUser -> AcceptUsers 변경

df5a677

add :: condition 속성 추가

2fa0c71

KimTaeO reviewed Sep 18, 2024

View reviewed changes

src/main/kotlin/com/msg/gauth/domain/user/service/GetAcceptedUsersService.kt Outdated Show resolved Hide resolved

Umjiseung and others added 2 commits September 18, 2024 22:48

Update src/main/kotlin/com/msg/gauth/domain/user/service/GetAcceptedU…

5035b5e

…sersService.kt Co-authored-by: 김태오 <103710151+KimTaeO@users.noreply.github.com>

update :: 실수로 지운 cacheManager 다시 추가

515e287

KimTaeO reviewed Sep 18, 2024

View reviewed changes

Umjiseung and others added 4 commits September 18, 2024 23:28

Update src/main/kotlin/com/msg/gauth/domain/user/service/GetAcceptedU…

51d9ee6

…sersService.kt Co-authored-by: 김태오 <103710151+KimTaeO@users.noreply.github.com>

Update src/main/kotlin/com/msg/gauth/domain/user/service/AcceptUserSi…

702b62b

…gnUpService.kt Co-authored-by: 김태오 <103710151+KimTaeO@users.noreply.github.com>

Update src/main/kotlin/com/msg/gauth/domain/admin/service/ExcelParsin…

2a738f8

…gService.kt Co-authored-by: 김태오 <103710151+KimTaeO@users.noreply.github.com>

update :: cacheManager 변경

ffd00fa

KimTaeO approved these changes Sep 18, 2024

View reviewed changes

Umjiseung merged commit f314ecc into main Sep 18, 2024
1 check passed

Umjiseung deleted the feature/346-redis-used-caching-apply branch September 18, 2024 23:05

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

🔀 :: 레디스 캐시 적용 #347

🔀 :: 레디스 캐시 적용 #347

Umjiseung commented Sep 1, 2024 •

edited

Loading

KimTaeO Sep 4, 2024

Umjiseung Sep 17, 2024

KimTaeO Sep 4, 2024

Umjiseung Sep 17, 2024

KimTaeO Sep 4, 2024

Umjiseung Sep 5, 2024

KimTaeO Sep 5, 2024

Umjiseung Sep 5, 2024

Umjiseung Sep 5, 2024

KimTaeO Sep 4, 2024

Umjiseung Sep 5, 2024

KimTaeO Sep 6, 2024

Umjiseung Sep 6, 2024

🔀 :: 레디스 캐시 적용 #347

🔀 :: 레디스 캐시 적용 #347

Conversation

Umjiseung commented Sep 1, 2024 • edited Loading

💡 배경 및 개요

📃 작업내용

🙋‍♂️ 리뷰노트

✅ PR 체크리스트

🎸 기타

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Umjiseung commented Sep 1, 2024 •

edited

Loading