feat: 레디스 적용 및 로그아웃 api 추가 #40

eom-tae-in · 2024-07-10T15:25:18Z

📄 Summary

관리자 RT를 레디스에 저장하기 위해 레디스를 적용하였고 저장, 조회, 삭제 기능을 추가하였습니다.
관리자 로그아웃 기능을 추가하였습니다. 로그인한 유저가 로그아웃을 하게되면 저장되어있던 RT가 필요가 없기 때문에 불필요한 DB 낭비가 생기게 되어 로그아웃 기능을 개발하게 되었습니다.

close #38

- AdminTokenProvider.

devholic22

수고하셨습니다! 몇 가지만 확인해주시면 될 것 같습니다 :)

devholic22 · 2024-07-11T12:02:19Z

src/main/java/com/atwoz/admin/infrastructure/auth/AdminJwtAccessTokenProvider.java

@@ -24,9 +26,12 @@

 @NoArgsConstructor
 @Component
-public class AdminJwtTokenProvider implements AdminTokenProvider {
+public class AdminJwtAccessTokenProvider implements AdminAccessTokenProvider,


개인적인 생각으로는 해당 클래스에서 AT와 RT를 모두 만들고 있기 때문에 기존 이름 (AdminJwtTokenProvider)이 더 적합할 것 같은데, 클래스 이름을 변경하신 이유가 있으실까요?

JwtTokenProvider 구조를 변경하면서 이름이 자동으로 변경되었던 것 같습니다 수정하도록 하겠습니다!

devholic22 · 2024-07-11T12:06:27Z

src/main/java/com/atwoz/admin/ui/auth/AdminAuthController.java

@@ -56,6 +57,14 @@ public ResponseEntity<AdminAccessTokenResponse> reGenerateAccessToken(
        return ResponseEntity.ok(adminAuthService.reGenerateAccessToken(refreshToken));
    }

+    @DeleteMapping("/logout")
+    public ResponseEntity<Void> login(@AdminRefreshToken final String refreshToken) {


로그아웃을 하는 메서드인만큼 메서드명을 logout으로 하는 게 더 좋을 것 같습니다!

devholic22 · 2024-07-11T12:21:26Z

src/test/java/com/atwoz/admin/infrastructure/auth/AdminRedisRefreshTokenRepositoryTest.java

+    @Autowired
+    private AdminRedisRefreshTokenRepository adminRedisRefreshTokenRepository;
+
+


공백 제거해주시면 될 것 같습니다!

devholic22 · 2024-07-11T12:23:09Z

src/main/java/com/atwoz/admin/infrastructure/auth/AdminRedisRefreshTokenRepository.java

+
+    private final RedisTemplate<String, Long> redisTemplate;
+
+


공백 있습니다 :)

devholic22 · 2024-07-11T12:26:15Z

src/main/java/com/atwoz/admin/domain/admin/AdminRefreshToken.java

+
+@Builder
+public record AdminRefreshToken(
+        @Id String refreshToken,


@Id가 들어간 이유가 궁금한데, 혹시 고유 식별자 역할로 쓰이게 하시기 위함일까요?

레디스에 사용할 도메인 객체에 키로 사용되는 값을 지정해야 하는 걸로 알고 있었는데 로컬에서 제거해서 테스트를 진행해도 잘 되네요! @id를 지정해줘야되는지 알고 사용한 이유 외에 다른 이유는 없었습니다. @id는 Redis Repository로 구현했을 때만 사용하는 게 맞을까요?

확인해보니 레디스로 관리할 경우에는 말씀하신 것 처럼 @Id (springframework.data의 어노테이션)가 필요한 것으로 나오네요..! 그대로 남겨두시는게 맞지 않을까 생각됩니다. 참고하실만한 글 공유드리겠습니다!

devholic22 · 2024-07-11T12:33:10Z

src/main/java/com/atwoz/admin/domain/admin/service/AdminRefreshTokenProvider.java

@@ -0,0 +1,6 @@
+package com.atwoz.admin.domain.admin.service;


AT 발급 인터페이스는 application/auth, RT 발급 인터페이스는 domain/admin/service에 작성하신 이유가 궁금합니다. 궁극적으로 모두 토큰을 발급하기도 하고, 구현체 또한 AdminJwtAccessTokenProvider에서 모두 구현한만큼 이를 추상화한 인터페이스들의 위치도 통일시키는 게 좋을 것 같은데 어떻게 생각하시나요?

저희가 RT만 레디스에 저장하기 때문에 RT 도메인 객체는 도메인에 위치해야합니다. 하지만 RT의 암호화된 토큰은 JwtTokenProvider에서 만들어집니다. 만약 JwtTokenProvider 통해 서비스 레이어에서 생성해준다면 RT 도메인 객체는 응용 계층에서 만든 암호화된 토큰을 받게 됩니다. 이로 인한 응용 계층의 의존이 생기기 때문에 RTProvider를 팩토리 메서드 인자로 넘겨줘서 내부에서 암호화된 토큰이 만들어지도록 구현해야한다고 생각했습니다. RTProvider는 도메인 서비스이기에 도메인 레이어에 위치해야합니다. 하지만 ATProvider는 도메인에 어떠한 영향도 미치지 않기 때문에 응용 계층에서 생성해서 응답 바디에 넘겨주면 됩니다. 제가 AT, RT 생성 기능을 모두 추상화한 인터페이스로 둔 이유가 바로 이 이유 때문이었습니다. 추가적인 의견 및 제가 잘못 이해해서 설계한 부분이 있다면 댓글로 의견 남겨주시면 감사하겠습니다!

아 이해했습니다. AT 발급 (ATProvider)은 도메인에 영향을 미치지 않고 응용 계층에서만 이용되기 때문에 응용 계층에 인터페이스를 위치시키고, RT 발급 (RTPRovider)을 AT 발급처럼 응용 계층에 둔다면 도메인 계층에 있는 AdminRefreshToken에서 응용 계층에 대한 의존이 발생되기 때문에 도메인 패키지 하위에 서비스 패키지를 별도로 만들어주신거군요.
네 저도 이 방식이 더 나은 방식 같습니다! 태인님의 의견을 들으면서 인터페이스를 둘 위치를 더 깊게 고민할 수 있어서 좋았습니다 :)

devholic22 · 2024-07-11T12:36:23Z

src/main/java/com/atwoz/admin/application/auth/AdminAuthService.java

@@ -33,37 +36,46 @@ public AdminTokenResponse signUp(final AdminSignUpRequest adminSignUpRequest) {
                adminProfileSignUpRequest.phoneNumber()
        );
        Admin savedAdmin = adminRepository.save(admin);
+        AdminRefreshToken adminRefreshToken = createAdminRefreshToken(savedAdmin);
+        adminRefreshTokenRepository.save(adminRefreshToken);
+        String accessToken = adminAccessTokenProvider.createAccessToken(savedAdmin.getId());


AT를 만들기까지의 과정과 RT를 만들기까지의 과정을 메서드 분리하는 것은 어떨지 여쭤보고 싶습니다..! (RT의 경우, 리포지터리에 save하는 것도 createAdminRefreshToken 메서드에 포함시키면 될 것 같습니다.)

또는, Admin을 save하는 것을 메서드 분리해도 좋을 듯 합니다.

public AdminTokenResponse signUp(final AdminSignUpRequest adminSignUpRequest) { Admin savedAdmin = saveAdmin(adminSignUpRequest); String accessToken = adminAccessTokenProvider.createAccessToken(savedAdmin.getId()); AdminRefreshToken adminRefreshToken = createAdminRefreshToken(savedAdmin); return new AdminTokenResponse(accessToken, adminRefreshToken.refreshToken()); } private Admin saveAdmin(final AdminSignUpRequest request) { AdminProfileSignUpRequest adminProfileSignUpRequest = request.adminProfileSignUpRequest(); Admin admin = Admin.createWith( request.email(), request.password(), request.confirmPassword(), adminProfileSignUpRequest.name(), adminProfileSignUpRequest.phoneNumber() ); return adminRepository.save(admin); }

메서드 분리를 굳이 할 필요가 없어보여 하지 않았는데 다른 곳에서 재사용을 하지 않아도 작성하신 코드를 보니 분리하는게 나을 것 같다는 생각이 드네요. 메서드 분리하도록 하겠습니다!

login -> logout

AdminJwtAccessTokenProvider -> AdminJwtTokenProvider

devholic22

수고하셨습니다!

sosow0212

수고하셨습니다 👍 계층 구조 잘 나눠주신 것 같아서 코드리뷰 하기도 너무 편했습니다!
타임아웃도 잘 설정해주시고 딱히 변경해야할 부분이 보이진 않아서 Approve 합니다!

sosow0212 · 2024-07-11T14:06:18Z

src/main/java/com/atwoz/admin/application/auth/AdminAuthService.java

+    public void logout(final String refreshToken) {
+        adminRefreshTokenRepository.delete(refreshToken);
    }


프론트엔드에서 헤더에서 토큰을 제거해주고 동시에 로그아웃 api를 요청해서 리프레쉬 토큰까지 제거해서 로그아웃을 시켜준다라는 의미로 작성하신 코드가 맞을까요?!

네 맞습니다!
프론트에서 로그아웃 처리시 로그아웃 api를 요청해서 서버에 있는 로그인 했던 유저의 RT를 삭제합니다!

eom-tae-in added 20 commits July 10, 2024 23:31

refactor: 기존에 한 클래스에서 사용하던 기능 분리 작업 진행

d9647af

feat: 로그아웃 기능 추가

bd442bf

refactor: 쿠키 헤더 설정 변경

756096a

feat: AdminAuthService 로직 수정 및 로그아웃 기능 구현

522fecd

feat: 관리자 RT가 유효하지 않을 때 발생시킬 예외 클래스 추가

252bc20

feat: 관리자 리프레쉬 토큰의 정보를 저장하고 관리하는 도메인 클래스 생성

6595bc6

feat: 관리자 리프레쉬 토큰을 저장하기 위한 Repository 구현

7d608b1

refactor: TokenProvider의 기능 분리로 인한 코드 수정

2c829ff

remove: 불필요한 클래스 제거

d364000

- AdminTokenProvider.

feat: redis를 추가하기 위한 설정파일 추가

ed7f2f3

test: AdminRedisRefreshTokenRepository를 테스트하기 위한 Fake Repository 구현

05423dc

test: AdminRedisRefreshTokenRepository 테스트 클래스 작성

f4389a2

test: 관리자 RT를 테스트에서 쉽게 사용하기 위해 Fixture 작성

fe68ceb

test: 관리자 로그아웃 기능 테스트 추가

b0e0d5f

test: 프로덕션 코드 수정으로 인한 테스트 수정

2ebf1ee

docs: build.gradle에 redis 설정 추가

95cf36a

docs: application.yml에 redis 설정 추가

a4df6e8

test: application.yml에 redis 설정 추가

fbeb794

docs: 관리자 명세서 최신화

3d29b7c

docs: 토큰 저장시간 암호화

6ec0f14

eom-tae-in added the 기능 추가 label Jul 10, 2024

eom-tae-in requested review from sosow0212 and devholic22 July 10, 2024 15:25

eom-tae-in self-assigned this Jul 10, 2024

eom-tae-in had a problem deploying to test July 10, 2024 15:25 — with GitHub Actions Failure

docs: CI 구성에 레디스 추가

407ea48

eom-tae-in temporarily deployed to test July 11, 2024 11:39 — with GitHub Actions Inactive

devholic22 requested changes Jul 11, 2024

View reviewed changes

eom-tae-in added 2 commits July 11, 2024 22:26

refactor: 메서드명 변경

f463404

login -> logout

refactor: admin 생성하는 로직 메서드 분리

953e5a4

eom-tae-in added 3 commits July 11, 2024 22:27

refactor: 도메인 객체에 불필요하게 존재했던 @id 어노테이션 제거

ce8714e

refactor: 공백 제거

508194d

refactor: 클래스명 변경

a3fb9f4

AdminJwtAccessTokenProvider -> AdminJwtTokenProvider

eom-tae-in temporarily deployed to test July 11, 2024 13:28 — with GitHub Actions Inactive

refactor: AdminRefreshToken 키 값에 @id 추가

b80f3f8

eom-tae-in temporarily deployed to test July 11, 2024 14:07 — with GitHub Actions Inactive

devholic22 approved these changes Jul 11, 2024

View reviewed changes

sosow0212 approved these changes Jul 11, 2024

View reviewed changes

eom-tae-in merged commit 8f51049 into develop Jul 11, 2024
1 check passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: 레디스 적용 및 로그아웃 api 추가 #40

feat: 레디스 적용 및 로그아웃 api 추가 #40

eom-tae-in commented Jul 10, 2024 •

edited by sosow0212

Loading

devholic22 left a comment

devholic22 Jul 11, 2024

eom-tae-in Jul 11, 2024

devholic22 Jul 11, 2024

devholic22 Jul 11, 2024

devholic22 Jul 11, 2024

devholic22 Jul 11, 2024

eom-tae-in Jul 11, 2024

devholic22 Jul 11, 2024

devholic22 Jul 11, 2024

eom-tae-in Jul 11, 2024

devholic22 Jul 11, 2024

devholic22 Jul 11, 2024

eom-tae-in Jul 11, 2024

devholic22 left a comment

sosow0212 left a comment

sosow0212 Jul 11, 2024

eom-tae-in Jul 11, 2024

		@Autowired
		private AdminRedisRefreshTokenRepository adminRedisRefreshTokenRepository;

		@@ -0,0 +1,6 @@
		package com.atwoz.admin.domain.admin.service;

feat: 레디스 적용 및 로그아웃 api 추가 #40

feat: 레디스 적용 및 로그아웃 api 추가 #40

Conversation

eom-tae-in commented Jul 10, 2024 • edited by sosow0212 Loading

📄 Summary

devholic22 left a 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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

devholic22 left a comment

Choose a reason for hiding this comment

sosow0212 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

eom-tae-in commented Jul 10, 2024 •

edited by sosow0212

Loading