스프링부트 게시판 API 만들기 (19) - Redis를 사용해 캐시를 적용해보자

 

 

 

 

 

오늘은 Redis를 사용해서 캐시를 적용해보도록 하겠습니다.

사실 이번이 Redis를 처음 사용하는 거라... 살짝은 공부용으로 작성한거라 많이 이상할수도 있습니다.

추가로... 지금 레디스를 이곳저곳에 적용해 보려 하였으나.. 제가 코드를 너무 엉망으로 짜서 그런지... 적용하려면 무언가 대대적인 수정 작업이 필요해 보이더군요... 그래서 일단은... 네.. 뭐 로그인 시에만 적용하도록 해보았습니다..^^

 

 

게다가 테스트코드는... 캐시를 적용하는 순간 멸망해 버렸는데, 테스트 환경에서 레디스를 적용하지 않으려고 온갖 방법을 다 써봤으나 실패했습니다...

 

혹시 여기서 저와 같이 레디스로 캐시 작성하는 것을 따라하신다면... 테스트코드 돌릴 때는 빼고 돌리는 것으로...ㅠㅠㅠ

나중에 꼭 고쳐보겠습니다..ㅠㅠ

 

 

 

• 시큐리티를 이용한 JSON 데이터로 로그인 (완료)
• JWT를 이용한 인증 (완료)
• 도메인, 테이블 설계, 엔티티 생성 (완료)
• 댓글 삭제 로직 구현 (완료)
• 회원가입 + 정보수정 등 회원 서비스 구현 (완료)
• 게시판 서비스 구현 (완료)
• 댓글 서비스 구현 (1댓글 -> *(무한) 대댓글 구조) (완료)
• 예외 처리 (완료)
• 게시글 페이징 (완료)
• 동적인 검색 조건을 사용한 검색 (완료)
• AOP를 통한 로그 (완료)
• 캐시 (진행 중)
• 예외 메세지 국제화
• 카테고리별 게시판 분류
• 사용자 간 쪽지 기능
• 무한 쪽지 스크롤
• 게시물 & 댓글에 대한 알람
• 쪽지에 대한 알람
• 접속한 사용자 간 실시간 채팅
• 회원가입 시 검증(예: XX대학교 XX과가 아니면 가입할 수 없게)
• Swagger를 사용한 API 문서 만들기
• 신고 & 블랙리스트 기능
• 어드민 페이지
• 배포 (+ 무중단 배포)
• 배포 자동화
• 포트와 어댑터 설계를 따르는 패키지 구조 설계하기
• ...

 

 

 

 

 

 

 

 

 

 

 

 

 

 

Redis 설치하기

우선 Redis를 설치해서 사용하도록 하겠습니다.

아래 사이트에 들어가서 Redis를 다운받아 주세요! (맥이라면,, 맥 버전 다운받는 법 치면 나올겁니다..)

https://github.com/microsoftarchive/redis/releases

Releases · microsoftarchive/redis

 

 

설치 경로는 상관 없고,  딱히 어려운 건 없으실거예요 아마..? (저도 했는데요 뭐..)

설치를 완료하셔서 폴더로 들어가시면 다음과 같이 server.exe와 cli.exe가 있으실 겁니다.

 

server를 먼저 실행해 주신 다음에 명령 프롬프트(cmd)로 들어가서 다음 명령어를 쳐주세요

netstat -an | findstr 6379 
(혹시 포트번호를 6379가 아닌 다르게 설정하셨다면 설정하신 포트번호를 쳐주세요)

 

다음과 같이 뜨시면 성공입니다!

참고

Redis 중지 하는 방법

Powershell 을 관리자모드로 실행시킨 후 다음을 입력한다.

net stop redis

 

Redis 실행 시키는 방법

Powershell 을 관리자모드로 실행시킨 후 레디스 폴더로 이동하여 다음을 입력한다.

.\redis-server.exe redis.windows.conf

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

Redis 의존관계 추가 & application.yml 파일 수정

 

build.gradle에 다음과 같이 redis 의존성을 추가해줍니다.

implementation 'org.springframework.boot:spring-boot-starter-data-redis'

 

 

 

application-dev.yml과  application.prod.yml에 다음 설정을 추가해 주도록 하겠습니다.

(dev에만 해주셔도 되고, 파일이 application.yml 하나라면 거기에 해주시면 됩니다!)

spring:
  cache:
    redis:
      time-to-live: 86400000 #mills 단위 -> [1초 : 1000] ->   [1일 : 86400000]

  redis:
    port: 6379 #설정한 포트번호
    host: 127.0.0.1

 

 

그리고 Cache 기능을 사용하려면 다음 애노테이션을 애플리케이션 시작점에 달아주셔야 합니다.

@EnableCaching

 

저의 경우 다음과 같습니다.

 

 

 

 

 

 

 

 

 

 

 

 

어디에 적용할까?

사실 캐시를 어디에 적용하면 좋을까 하다가 마땅한 아이디어가 떠오르지 않아서 맨 처음에는 Post List와 하나의 Post 정보에 대해서 적용하려 했습니다.

 

그런데... 수정과 삭제가 발생하면 캐시를 지우는 코드를 작성했는데... 이게 지금 제가 짠 코드가 너무 엉망이라 이를 적용하려면 정말 다 뜯어 고쳐야 하는 상황이었습니다. (혹은 제가 레디스 사용법을 아직 잘 몰라서 방법이 있지만 모르는 것일 수도 있습니다.)

 

그래서 그냥 로그인 한 유저 정보를 저장해 두어서, 이후 로그인 시에 캐시를 통해 빠르게 로그인 할 수 있도록 코드를 작성하였습니다.

 

회원 정보는 잘 수정되지 않기에, 캐시에 적용해도 문제 없을거라 생각하여 캐시를 이용하게 되었습니다.

 

(추가로 레디스 캐시에 대해 공부할 때, 제가 참고한 사이트입니다. 한번쯤 읽어보시면 좋을 거 같아요!)

https://souljit2.tistory.com/m/72

[#2] Redis 캐시를 통해 읽기 성능 향상하기

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

캐시 적용 - @Cacheable

 

MemberRepsitory - findByUsername()

@Cacheable(value = CacheLogin.USER, key = "#p0")

위의 애노테이션을 달아주었습니다.

 

 

 

 

public interface MemberRepository extends JpaRepository<Member, Long> {

    @Cacheable(value = CacheLogin.USER, key = "#p0")//String 매개변수는 p0, p1,...
    Optional<Member> findByUsername(String username);

    boolean existsByUsername(String username);

    Optional<Member> findByRefreshToken(String refreshToken);
}

 

 

 

 

참고로 CacheLogin은 제가 만들어준 클래스로 다음과 같습니다.

@NoArgsConstructor(access = AccessLevel.PRIVATE)
public final class CacheLogin {
    public static final String USER = "login_user";
}

(에노테이션에 이넘을 쓸 수가 없어서 static final String으로 정의해 주었습니다.)

 

 

 

 

 

저의 코드에서는 AccessToken을 가지고 로그인 시 MemberRepository의 findByUsername 메서드를 통해 회원정보를 가져오므로 findByUsername에 캐시를 적용해 주었습니다.

 

 

 

 

 

 

 

 

캐시 삭제 - @CacheEvict

다음은 회원 정보가 수정되거나, 회원탈퇴를 한 경우 캐시에서 지워주는 코드를 작성해보도록 하겠습니다.

지금 저의 코드 상태로는 진행할 수가 없어 MemberService와 MemberServiceImpl 코드를 수정해 주었습니다.

(update, updatePassword, withdraw 메서드에 username을 받아오도록 코드를 수정하였습니다.)

public interface MemberService {

    /**
     * 회원가입
     * 정보수정
     * 회원탈퇴
     * 정보조회
     */

    void signUp(MemberSignUpDto memberSignUpDto) throws Exception;

    void update(MemberUpdateDto memberUpdateDto, String username) throws Exception;

    void updatePassword(String asIsPassword, String toBePassword, String username) throws Exception;

    void withdraw(String checkPassword, String username) throws Exception;

    MemberInfoDto getInfo(Long id) throws Exception;

    MemberInfoDto getMyInfo() throws Exception;


}

 

 

 

이후 update, updatePassword, withdraw 메서드에 다음 어노테이션을 적용하여 캐시를 삭제하도록 해주었습니다.

@CacheEvict(value = CacheLogin.USER, key = "#pN") // N은 N번째 매개변수의 값

 

 

 

 

 

 

 

MemberServiceImpl은 다음과 같습니다.

@Service
@RequiredArgsConstructor
@Transactional
public class MemberServiceImpl implements MemberService{


    private final MemberRepository memberRepository;
    private final PasswordEncoder passwordEncoder;



    /**
     * 회원정보 수정
     */
    @Override
    @CacheEvict(value = CacheLogin.USER, key = "#p1")
    public void update(MemberUpdateDto memberUpdateDto, String username) throws Exception {
       ...
    }


    /**
     * 비밀번호 변경
     */
    @Override
    @CacheEvict(value = CacheLogin.USER, key = "#p2")
    public void updatePassword(String asIsPassword, String toBePassword, String username) throws Exception {

...
    }


    /**
     * 회원탈퇴
     */
    @Override
    @CacheEvict(value = CacheLogin.USER, key = "#p1")
    public void withdraw(String checkPassword, String username) throws Exception {
        ...
    }
    
    ... 생략

}

사실 MemberServiceImpl이 아니라 MemberService 인터페이스에 어노테이션을 달아도 되지만.. 그냥 Impl에 달아봤습니다.

(혹시 다른 구현체는 캐시 사용을 안 할 수도 있잖아요..? ...ㅎㅎ)

 

 

 

 

 

 

 

위와 같이 코드를 수정하셨다면 MemberController에서 오류가 나실텐데, 다음과 같이 username의 인자 위치에 

SecurityUtil.getLoginUsername()

를 추가해 주시면 됩니다.

(추가로 테스트코드에서도 컴파일 에러가 많이 발생할텐데, 다 위의 코드를 넣어주시면 해결됩니다.)

 

 

 

 

 

 

 

 

 

이제 Member를 직렬화 할 수 있도록 Serializable를 implement 해주면 끝입니다

public class Member extends BaseTimeEntity implements Serializable {
...
}

 

 

한번 실행해 보도록 하겠습니다.

우선 redis를 실행시킨 후 애플리케이션을 실행시켜 주세요

 

 

 

 

 

 

 

 

 

로그인 한번 해보겠습니다.

다음과 같이 DB에 쿼리가 1회 발생합니다.

 

 

 

 

 

이 상태에서 다시 로그인을 해보도록 하겠습니다.

쿼리가 발생하지 않고 바로 로그인이 되었습니다!

(AccessToken을 가지고 인증을 하는 경우에도 마찬가지로 DB 조회 없이 AccessToken만 유효하다면 로그인됩니다!)

 

 

 

 

 

 

 

 

 

 

 

 

 

오늘은 이렇게 정말 간단하게 레디스를 사용해서 캐시를 적용해 보았습니다.

 

전체 코드는 깃허브에서 확인하실 수 있습니다.

 

https://github.com/ShinDongHun1/SpringBoot-Board-API

GitHub - ShinDongHun1/SpringBoot-Board-API

 

 

 

 

 

 

 

 

 

 

 

 

 

회고

요즘 WebFlux 공부해본다고 Reactive Stream부터 토비님 방송 보면서 공부중인데 너무 어렵네요..ㅠㅠ

그리고 스프링 게시판이 조금 뜸한게... 너무 재미가 없달까요...ㅠㅠ

지금 한 네다섯번째로 공부하면서 계속 게시판만 만드는데.. 보이는 것도 없고... 뭔가 그럴듯한 기능도 없이 게시판만 만들다 보니 조금 거리두기 하고 싶어졌습니다..

게다가 이제 개강이라.. ㅎㅎ...

사실 음... 아직 못 한 것 중에 국제화나 어드민 페이지, 알림 같은 경우는 저번에 친구들이랑 대회 나갈때 해보기도 했고 그래서 아마 안할 거 같습니다.(게다가 국제화는 그냥 진짜 단순 노가다라..ㅎ)

카테고리별로 게시판 나누는 것이나 쪽지 등도 별로 어렵지는 않을 거 같으니 .. 나중에 방학이나 시간이 된다면 다시 해보도록 하겠습니다..ㅎ

배포를 시간이 또 된다면 한번 공부해서 해보겠습니다!!!

사실 뭐 책 보고 하면 할 수 있을거 같긴 한데.. DB연결이라던가 그런 부분에서 또 머리아플 거 같아서.. 학교생활 하면서 프로젝트 진행할 때 조금 공부좀 하고 나중에 계속해서 작성해보도록 하겠습니다.

 

게시판 만들기는 끝이 아니지만... 1부의 종료..? 정도라 할까요..?

네 뭐 사실 여기까지 봐주시는 분들도 거의 없을 거 같긴 하지만.. 아무튼!!!

나름의 변명을 하자면, 공부를 하기 싫어서 종료한건 아니라는 점..!!! 

아무튼 네 감사합니다!

 

 

 

 

 

 

 

 

 

Reference

https://goni9071.tistory.com/473

window 10 redis 설치. (2020-03)

https://m.blog.naver.com/PostView.naver?isHttpsRedirect=true&blogId=hulint&logNo=80202537250 

@CacheEvict SPEL 이용 Key

https://yzink.tistory.com/m/31

[Ehcache] 간단한 캐시 구현 (@Cacheable, @CacheEvict)

https://souljit2.tistory.com/m/72

[#2] Redis 캐시를 통해 읽기 성능 향상하기

https://www.baeldung.com/spring-boot-redis-cache

 

https://docs.spring.io/spring-data/data-redis/docs/current/reference/html/#scripting

Spring Data Redis