feat: 관리자 인증 기능을 구현한다 #37

eom-tae-in · 2024-07-06T08:15:47Z

📄 Summary

관리자 인증 기능을 구현하였습니다.

관리자의 회원가입은 이메일, 비밀번호, 비밀번호 확인, 프로필 정보를 올바르게 입력하면 회원가입이 되게 됩니다.
AT가 만료되면 쿠키에 답긴 RT를 이용하여 AT를 재발급해주게 됩니다.

🙋🏻 More

이번에 개발을 진행하며 회원과 관리자의 테이블 구조의 다른 점이 많아 하나의 바운디드 컨텍스트로 관리되는데 문제가 있는 것 같다고 판단하여 분리하는 작업을 진행하였습니다.

기존 방식에서는 관리자와 회원을 하나의 테이블로 관리하여, 토큰 검증 시 ID만 확인하면 되는 이점이 있었습니다. 또한, 인증에 사용되는 여러 기능을 재사용할 수 있었습니다. 예를 들어, 토큰 암호화 및 Argument Resolver에서 필요한 URI 검증 기능을 재사용할 수 있었습니다. 그러나 관리자와 회원을 하나의 테이블로 관리할 때, 서로 다른 컬럼들이 null 값이나 기본 값으로 남겨지는 단점이 있었습니다.
이를 해결하기 위해 테이블을 분리하고, 각각 다른 도메인으로 개발해 보았습니다. 그 결과, 관리자와 회원 테이블을 null 값 없이 관리할 수 있었고, 서로 다른 인증 방식을 같은 루트 도메인에서 개발할 필요가 없어졌습니다.

이 외에 발생할 수 있는 문제점이나 고려하지 못한 사항이 있다면 댓글로 남겨주시면 감사하겠습니다.
추가적으로 관리자와 회원의 도메인을 따로 개발하는 것에 대한 의견을 남겨주시면 감사하겠습니다!

- AdminAccessTokenResponse - AdminTokenResponse

- AdminAuthArgumentResolver - AdminAuthConfig - AdminAuthenticationContext - AdminAuthenticationContext - AdminLoginValidCheckerInterceptor - AdminRefreshTokenExtractionArgumentResolver

- AdminExceptionHandler - AdminLoginInvalidException - AdminNotFoundException - InvalidPasswordException - PasswordMismatchException - UnauthorizedAccessToAdminException

- AdminRepository - AdminJpaRepository - AdminRepositoryImpl

- AdminTokenProvider - AdminJwtTokenProvider

- AdminAuthService

- AdminAuthController

- AdminSignUpRequest - AdminProfileSignUpRequest - AdminLoginRequest

- Department: 관리자의 부서 - AdminStatus: 관리자 계정 사용 가능 여부 - Authority: 관리자의 권한

…기 위해 어노테이션 생성 - AdminRefreshToken

- AuthAdmin

- AdminFixture - AdminRequestFixture - AdminTokenResponseFixture

sosow0212

아주 최고네요~ Approve 해도 될 것 같아서 누릅니다! 다만 리뷰 내용 확인해보시고 고쳐도 될 것 같다라고 생각하시면 그 부분만 고쳐주세요! 잘못된 패키징 고친 것도 그렇고 수고 많으셨습니다 👍

sosow0212 · 2024-07-06T10:11:14Z

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

+    private final AdminRepository adminRepository;
+    private final AdminTokenProvider adminTokenProvider;
+
+    public AdminTokenResponse signUp(final AdminSignUpRequest adminSignUpRequest) {


dto로의 변환은 레이어드 아키텍처에서 컨트롤러에서 해주는 것이 책임이라고 생각하는데 어떻게 생각하시나요?

응용레이어에서 AT와 RT를 만들어서 컨트롤러로 넘겨주기 때문에 이를 컨트롤러에서 받기 위한 DTO를 만들어서 사용했습니다. 응답 바디에 담기는 DTO 타입은 저도 컨트롤러에서 하는게 맞다고 생각합니다! 하지만 지금은 응용 레이어에서 컨트롤러로 넘겨주기 위한 DTO이기 때문에 큰 문제가 없어보이는데 어떻게 생각하시나요? 컨트롤러에서 응답 바디에 넘겨주는 DTO의 타입은 AdminAccessTokenResponse입니다!

sosow0212 · 2024-07-06T10:11:46Z

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

+import com.atwoz.admin.application.auth.dto.AdminTokenResponse;
+import com.atwoz.admin.domain.admin.Admin;
+import com.atwoz.admin.domain.admin.AdminRepository;
+import com.atwoz.admin.domain.admin.AdminTokenProvider;


토큰을 주는 것은 도메인 보다는 서비스가 낫지 않을까 조심스럽게 의견 드려봅니다..! 다르게 생각한다면 편하게 말씀해주세요!

저는 토큰을 암호화하는 부분이 외부라이브러리를 이용해서 인프라 레이어로 두고 이를 인터페이스화시킨 것을 도메인 레이어에서 둬서 응용 계층에서 호출해서 사용하도록 구현하려고 했는데 혹시 서비스 레이어에 두는게 더 좋은 것 같다고 생각한 이유를 알 수 있을까요?

sosow0212 · 2024-07-06T10:12:35Z

src/main/java/com/atwoz/admin/application/auth/dto/AdminProfileSignUpRequest.java

@@ -0,0 +1,7 @@
+package com.atwoz.admin.application.auth.dto;
+
+public record AdminProfileSignUpRequest(


여기도 validation 추가 해주세요!

sosow0212 · 2024-07-06T10:14:44Z

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

+
+    String createRefreshToken(Long id);
+
+    <T> T extract(String token, String claimName, Class<T> classType);


제네릭을 사용하신 이유가 따로 있을까요?!

클레임에는 문자열(이메일), 숫자(id)등이 들어값니다. 그래서 추출할 때 만약 문자열 값과 숫자 값을 모두 추출할 일이 있으면 해당 메서드를 여러개 만들어야 해서 중복을 최소한해보고자 제네릭을 이용해서 구현해보았습니다.

sosow0212 · 2024-07-06T10:15:17Z

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

+    private static final String ID = "id";
+    private static final String TOKEN_TYPE = "token type";
+    private static final String REFRESH_TOKEN = "refresh token";
+    private static final String ACCESS_TOKEN = "access token";
+    private static final String ROLE = "role";
+    private static final String ADMIN = "admin";


sosow0212 · 2024-07-06T10:16:25Z

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

+    @PostMapping("/access-token-regeneration")
+    public ResponseEntity<AdminAccessTokenResponse> reGenerateAccessToken(
+            @AdminRefreshToken final String refreshToken) {
+        System.out.println("hihi : " + refreshToken);


Suggested change

System.out.println("hihi : " + refreshToken);

sosow0212 · 2024-07-06T10:18:28Z

src/main/java/com/atwoz/global/config/interceptor/PathMatcherInterceptor.java

@@ -1,5 +1,7 @@
-package com.atwoz.member.ui.auth.interceptor;
+package com.atwoz.global.config.interceptor;


이거 항상 거슬렸는데 👍

sosow0212 · 2024-07-06T10:19:10Z

src/main/java/com/atwoz/member/application/auth/MemberAuthService.java


    private static final String DEFAULT_PHONE_NUMBER = "01011111111";

-    private final TokenProvider tokenProvider;
+    private final MemberTokenProvider memberTokenProvider;


어차피 토큰 주는게 똑같다면 기존과 같이 같은 인터페이스를 사용하고 DI하는 시점에만 다른 빈이 주입되도록 하는 건 어떻게 생각하시나요?

오 좋은 방법인 것 같습니다. 한번 고민해보겠습니다!

sosow0212 · 2024-07-06T10:20:48Z

src/main/java/com/atwoz/member/ui/auth/interceptor/MemberLoginValidCheckerInterceptor.java

+                .orElseThrow(MemberLoginInvalidException::new);
+        Long extractedId = memberTokenProvider.extract(token, MEMBER_ID, Long.class);
+        memberAuthenticationContext.setAuthentication(extractedId);
+


토큰의 형식은 일치하는데 id를 추출할 수 없으면 어떻게 될까요?

음 그 부분은 고려해본 적이 없는 것 같습니다. 찾아보고 수정해보겠습니다!

eom-tae-in added 30 commits July 6, 2024 16:16

feat: 관리자 정보를 저장하고 관리하는 Admin 엔티티 생성

443a56f

feat: 관리자 인증 응답 dto 생성

e554ca1

- AdminAccessTokenResponse - AdminTokenResponse

feat: 특정 uri를 관리자에게만 허용되도록 설정하기 위해 필요한 기능 구현

0a3a813

- AdminAuthArgumentResolver - AdminAuthConfig - AdminAuthenticationContext - AdminAuthenticationContext - AdminLoginValidCheckerInterceptor - AdminRefreshTokenExtractionArgumentResolver

feat: 관리자 인증시 발생할 수 있는 예외 클래스 구현

ab4b26f

- AdminExceptionHandler - AdminLoginInvalidException - AdminNotFoundException - InvalidPasswordException - PasswordMismatchException - UnauthorizedAccessToAdminException

feat: 관리자 repository 구현

6d66b4a

- AdminRepository - AdminJpaRepository - AdminRepositoryImpl

feat: 토큰을 생성하고 토큰의 claim을 찾아주는 기능 구현

2c9eef7

- AdminTokenProvider - AdminJwtTokenProvider

feat: Admin Auth 서비스 구현

b0ca1fc

- AdminAuthService

feat: Admin Auth 컨트롤러 구현

93e4724

- AdminAuthController

feat: 관리자 인증 요청 dto 생성

7ead965

- AdminSignUpRequest - AdminProfileSignUpRequest - AdminLoginRequest

feat: 관리자의 역할과 상태를 저장하는 enum 클래스 구현

be5a429

- Department: 관리자의 부서 - AdminStatus: 관리자 계정 사용 가능 여부 - Authority: 관리자의 권한

feat: AT가 만료되었을 때 요청하는 유저의 RT를 Argument Resolver를 통해 손쉽게 받을 수 있도록 구현하…

6c929ba

…기 위해 어노테이션 생성 - AdminRefreshToken

feat: 검증된 관리자의 id 값을 argument resolver를 이용해 쉽게 넘겨받기 위해 어노테이션 구현

55b13a1

- AuthAdmin

remove: 불필요해진 클래스 제거

d02be3b

move: 파일 경로 변

b62f73d

refactor: 한 바운디드 컨텍스트안에 존재하던 관리자와 유저를 서로 다른 컨텍스트로 분리

b8ddb8d

refactor: Member 바운디드 컨텍스트 변경으로 인한 코드 수정

99a5b5e

test: AdminAuthController 테스트 작성

41788fc

test: AdminAuthenticationContext 테스트 작성

c072bd6

test: AdminAuthenticationExtractor 테스트 작성

3115b3c

test: AdminAuthService 테스트 작성

48b6564

test: 테스트를 위한 AdminFakeRepository 구현

1ab3e4d

test: 테스트를 편하게 하기 위해 Fixture 구현

c63397c

- AdminFixture - AdminRequestFixture - AdminTokenResponseFixture

test: AdminJpaRepository 테스트 작성

fe6d42f

test: AdminLoginValidCheckerInterceptor 테스트 작성

cba1d28

test: Admin 테스트 작성

2912e1e

test: Member 바운디드 컨텍스트 변경으로 인한 테스트 코드 변경

2b0b85f

docs: member와 auth로 나누어져 있던 member 문서를 하나로 합침

db2dc41

docs: auth 문서 제거

0af78a7

docs: admin api 문서 작성

a74eabb

docs: 토큰과 쿠키 만료 시간 설정

ea9ee8c

eom-tae-in added 23 commits July 6, 2024 17:30

remove: 불필요해진 클래스 제거

ce994a9

move: 파일 경로 변

10cf2e7

refactor: 한 바운디드 컨텍스트안에 존재하던 관리자와 유저를 서로 다른 컨텍스트로 분리

6eb2887

refactor: Member 바운디드 컨텍스트 변경으로 인한 코드 수정

99553e8

test: AdminAuthController 테스트 작성

ab57bc3

test: AdminAuthenticationContext 테스트 작성

ffc72da

test: AdminAuthenticationExtractor 테스트 작성

dc412d0

test: AdminAuthService 테스트 작성

0b72297

test: 테스트를 위한 AdminFakeRepository 구현

7e5d3bd

test: 테스트를 편하게 하기 위해 Fixture 구현

46fb99a

- AdminFixture - AdminRequestFixture - AdminTokenResponseFixture

test: AdminJpaRepository 테스트 작성

213b5a7

test: AdminLoginValidCheckerInterceptor 테스트 작성

782cb53

test: Admin 테스트 작성

b9aa487

test: Member 바운디드 컨텍스트 변경으로 인한 테스트 코드 변경

fccd653

docs: develop 브랜치와 변황 문제로 인한 문서 수정

ebbfec8

refactor: 클래스명 변경으로 인한 코드 수정

58160b3

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

2df5b04

docs: 쿠키, 토큰 만료시간 설정

c08ec60

docs: develop 브랜치와의 병합 충돌로 인해 발생한 문서 수정

c78c9ea

docs: admin api 문서 작성

b85000f

docs: 토큰과 쿠키 만료 시간 설정

bd171df

docs: 공백 제거

edc1577

remove: 불필요한 클래스 제거

9f21e41

eom-tae-in temporarily deployed to test July 6, 2024 09:35 — with GitHub Actions Inactive

sosow0212 approved these changes Jul 6, 2024

View reviewed changes

eom-tae-in removed the request for review from devholic22 July 6, 2024 11:19

eom-tae-in added 2 commits July 6, 2024 20:20

refactor: dto에 validation 추가

0741feb

refactor: 불필요한 로직 제거

15e5a93

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

eom-tae-in merged commit 6245b56 into develop Jul 6, 2024
1 check passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: 관리자 인증 기능을 구현한다 #37

feat: 관리자 인증 기능을 구현한다 #37

eom-tae-in commented Jul 6, 2024

sosow0212 left a comment

sosow0212 Jul 6, 2024

eom-tae-in Jul 6, 2024

sosow0212 Jul 6, 2024

eom-tae-in Jul 6, 2024

sosow0212 Jul 6, 2024

sosow0212 Jul 6, 2024

eom-tae-in Jul 6, 2024

sosow0212 Jul 6, 2024

sosow0212 Jul 6, 2024

sosow0212 Jul 6, 2024

sosow0212 Jul 6, 2024

eom-tae-in Jul 6, 2024

sosow0212 Jul 6, 2024

eom-tae-in Jul 6, 2024

		@@ -0,0 +1,7 @@
		package com.atwoz.admin.application.auth.dto;

		public record AdminProfileSignUpRequest(


		String createRefreshToken(Long id);

		<T> T extract(String token, String claimName, Class<T> classType);

		@@ -1,5 +1,7 @@
		package com.atwoz.member.ui.auth.interceptor;
		package com.atwoz.global.config.interceptor;

feat: 관리자 인증 기능을 구현한다 #37

feat: 관리자 인증 기능을 구현한다 #37

Conversation

eom-tae-in commented Jul 6, 2024

📄 Summary

🙋🏻 More

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

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