redis key 네이밍 컨벤션 도입 제안

[jueuunn7]

배경

기존 저희 프로젝트에는 redis key 네이밍 관련 컨벤션이 없었습니다. 그래서 일관성이 없는 key 가 사용되었고, 이 상황을 개선하기 위해 통일된 key 네이밍 컨벤션을 제안합니다.

제안

- ":" 문자로 키의 섹션을 구분한다.

- 기본적인 구조는 entity:id:attribute 구조를 사용한다.
    - user:31:name
    - user:31:order:1234
    
- 너무 길게 사용하지 않는다. (불필요한 키워드를 줄인다)
    - X: app:user:1234:friendship
    - use: user:1234:friendship
    
- 너무 짧게 사용하지 않는다.
    - X: u1234fri
    - use: user:1234:friendships
    
- 소문자와 snake case를 사용한다.
    - user:1:snake_case

장점

• 기존의 큰 규칙이 없던 redis 키들을 정리할 수 있다
• 구조화된 이름으로 해당 키의 의도 파악이 쉬워질 수 있다
• 키가 서로 겹칠 일이 줄어든다

참고

의논이 시작된 pr 리뷰: https://github.com/8percent/eight/pull/21190#discussion_r2513365772 https://github.com/8percent/eight/pull/21190#discussion_r2516447416

더 나은 제안이나 방법등이 있다면 코멘트 남겨주세요.

[ahn-sj]

혹시 attribute에 행동 키워드도 들어갈 수 있을까요?
가령, redis lock을 잡아야 한다거나 서킷이 추가되었을때 상태 공유를 위해 서킷 상태를 저장한다거나 할 때 상태나 속성의 의미보다 행위의 의미도 들어갈 수 있겠다는 생각이 들어서요!

[jueuunn7]

아 넵! 행동 키워드도 가능할 것 같습니다.
제 생각은 attribute에 행동, 이름, 상태 등등을 넣을 수 있게 업데이트 하면 좋을 것 같습니다.
ex) order:1234:semaphore같은 케이스
어떻게 생각하시나요?

[ahn-sj]

레퍼런스와 연결된 PR을 보다가 궁금한 점이 있습니다

https://docs.djangoproject.com/en/6.0/topics/cache/#cache-versioning
:1:은 장고가 기본적으로 붙이는 캐시 버저닝 이라고 합니다.
커스텀 함수 만들어서 :1:을 제거하는 pr을 새로 파서 작업하면 될 것 같습니다.

혹시 캐시 버저닝을 지우시려고 하신 이유가 있으실까요..?

[jueuunn7]

재영님과 오프라인으로 이야기를 했었습니다.
장고에서 기본으로 제공하는 캐시 버저닝은 현재 저희가 사용하고 있지 않는데, 저희의 대부분의 캐시 키에 적용되고 있다 보니 사용하지 않는 기능 + 네이밍 컨벤션에 맞춰야 하는 이유로 제거하려고 했습니다.