로컬에서 @Cacheable이 동작하지 않는 문제

[ray-yhc]

Describe the bug

• 제 작업환경에서 레디스 캐싱이 동작하지 않는 문제가 지속적으로 발생합니다.(배포환경에서는 잘 동작합니다!)
• 원인과 해결방법을 하단에 정리해놓았습니다. 요점만 읽고 싶다면 결론으로 내려가주세요!

상황

• 에러 메시지는 다음과 같습니다.(아래 에러는 TechTag에 관한 에러이지만, 다른 Repository에서도 동일하게 발생합니다.)

  2023-08-21T12:48:40.962+09:00  WARN 16240 --- [nio-8080-exec-1] ocalVariableTableParameterNameDiscoverer : Using deprecated '-debug' fallback for parameter name resolution. Compile the affected code with '-parameters' instead or avoid its introspection: swm.hkcc.LGTM.app.modules.tag.repository.TechTagRepository
  2023-08-21T12:48:40.987+09:00  INFO 16240 --- [nio-8080-exec-1] s.h.L.a.g.advice.ApiExceptionHandler     : exception occurred from java.lang.IllegalArgumentException class : Null key returned for cache operation (maybe you are using named params on classes without debug info?) Builder[public abstract boolean swm.hkcc.LGTM.app.modules.tag.repository.TechTagRepository.existsByName(java.lang.String)] caches=[tech_tag_exist] | key='#name' | keyGenerator='' | cacheManager='' | cacheResolver='' | condition='' | unless='' | sync='false'
  2023-08-21T12:48:40.988+09:00  INFO 16240 --- [nio-8080-exec-1] s.h.L.a.g.advice.ApiExceptionHandler     : exception occurred from java.lang.IllegalArgumentException class : Null key returned for cache operation (maybe you are using named params on classes without debug info?) Builder[public abstract boolean swm.hkcc.LGTM.app.modules.tag.repository.TechTagRepository.existsByName(java.lang.String)] caches=[tech_tag_exist] | key='#name' | keyGenerator='' | cacheManager='' | cacheResolver='' | condition='' | unless='' | sync='false'

• 발생 장소

  @Cacheable(value = "tech_tag_exist", key = "#name")
  boolean existsByName(String name);

원인

조사해 본 결과, 원인은 다음과 같습니다.

• 공식 문서에 따르면, .class 파일은 파라미터 명을 저장하지 않습니다. 보안과 메모리 용량 절약을 위해서라고 합니다.
  • 출처 : 오라클 공식문서
• @Cacheable 적용 과정에서 자바 리플렉션이 사용됩니다. 리플렉션에서 파라미터를 가져올 때, 파라미터의 이름은 arg0, arg1, ...의 형식입니다.
• 코드 상에서 name으로 전달된 파라미터는 리플렉션에서는 arg0로 전달됩니다. 따라서 #name에서 제대로 된 파라미터 값을 가져올 수 없습니다.

해결 방법

해결 방법에는 크게 두 가지가 있습니다.

1. #name 대신 #p0를 사용합니다. 첫 번째 인자를 가져온다는 뜻입니다.

   • 이렇게 작성할 경우 로컬에서도 정상 동작합니다.

     @Cacheable(value = "tech_tag_exist", key = "#p0")
     boolean existsByName(String name);

2. 컴파일 옵션에 -parameters를 추가합니다.

   • 하지만 옵션을 적용하기 위한 두 가지 방법을 모두 적용해보았음에도, 모듈 실행에서 해당 옵션이 적용되지 않습니다.
   • 옵션 적용을 위한 방법을 고민해봐야 할 것 같습니다.

결론

둘 중 하나의 방법을 생각해 봐야 할 것 같습니다.

1. 프로젝트 전체에서 #name 대신 #p0를 사용
2. 로컬에서 -parameters를 적용시킬 방법을 찾는다. 둘 중 어떤 방법을 쓸지 고민해주시면 감사하겠습니다!

[great-park]

1번 방법이 더 좋을 것 같네요! 하나 궁금한 점이 있는데, 저렇게 수정했을때 redis에서 key값이 이전 방식과 동일하게 저장되나요??

[ray-yhc]

1번 방법이 더 좋을 것 같네요! 하나 궁금한 점이 있는데, 저렇게 수정했을때 redis에서 key값이 이전 방식과 동일하게 저장되나요??

문제 없이 잘 동작하네요!

[great-park]

아 추가로 Member, Senior 그리고 Junior에 @ToString을 적용했는데 이게 실제로 사용할 때 무한 루프가 발생하더라구요.. 서로 필드에서 참조해서 발생하는 문제 같은데, lombok 대신 ToString 메소드를 오버라이드해서 구현해야될ㅈ것 같습니다 이건 따로 이슈 발행하겠습니다

[ray-yhc]

앗 그건 자식 객체에서 이런 방식으로 처리 하시면? 해결될것같네요!

@ToString(exclude = "member")