naver/arcus-spring

사용자 가이드 문서 작성

Closed this issue · 5 comments

uhm0311 commented

1.13.4 버전 기준의 README의 내용을 포함하여 사용자 가이드 문서를 작성한다.

작성할 내용

  • arcus-spring 프로젝트의 개요
  • 의존성 추가 방법 (Maven, Gradle)
  • Bean 생성 방법
    • arcus-spring에서 제공하는 KeyGenerator 구현체 2가지에 대한 설명
  • Cacheable 어노테이션을 사용하는 예시
  • CacheManager를 사용하는 예시
  • FrontCache를 사용하는 예시
    • FrontCache를 사용하지 않을 때와 사용하는 경우의 각 연산에 대한 success, failure 표 작성
    • DefaultArcusFrontCache 사용법
  • 주의 사항
    • spring-devtools 사용 시 ClassLoader에 의한 버그 발생
    • ArcusCache 구현체의 캐시 키 생성 로직에 의한 강제 hash 값 붙임 현상
uhm0311 commented

더 추가해야 할 내용이 있다면 말씀해주시기 바랍니다.

jhpark816 commented

@oliviarla @brido4125
arcus-spring 사용자 가이드 문서에 들어갈 내용을 확인하고, 추가할 사항이 있는 지를 살펴봐 주세요.

oliviarla commented

충분한 것 같습니다.

jhpark816 commented

@uhm0311 항목 리뷰는 끝났으니, 가이드 문서를 작성하시죠.

uhm0311 commented

https://github.com/naver/arcus-spring/pull/59/files

위 PR이 머지되었으므로 이슈 닫습니다.