Feat(#15): 카카오 로그인 #18

kimyu0218 · 2025-01-28T08:27:05Z

작업 개요

카카오 로그인을 위한 http 클라이언트, service, controller를 작성했습니다.

작업 사항

카카오 로그인 api 엔드포인트를 호출하기 위한 http 클라이언트 작성
http 클라이언트를 위한 http 프록시 객체 생성 로직 작성
카카오 로그인을 위한 dto 객체, 서비스, 컨트롤러 작성

고민한 점들(필수 X)

프로젝트 구조를 어떻게 가져하야 할지 모르겠습니다..! 더 좋은 방법이 있다면 말씀해주세요.
- common > http, httpinterface
- common > support > model
- domain > auth > restclient
테스트 코드 클래스 외부에 테스트 데이터를 정의하고 싶지 않은데 어떻게 하면 좋을까요? (테스트 코드 내부에 테스트 데이터를 정의해야 테스트 코드를 한눈에 파악하고, 파일 삭제로 인한 테스트 실패가 발생하지 않을 거라고 생각했습니다)
- http interface를 조회할 때 접근 제어자를 고려하지 않아 base package 내 모든 http interface를 조회하고 있습니다
- http interface를 찾는 base package를 수정하여 테스트 클래스가 위치한 클래스에서 http interface를 찾도록 했지만 http interface와 관련된 테스트 클래스가 같은 패키지에 존재하면서 테스트에 실패했습니다 (a와 b 테스트 클래스에 http interface가 존재)
  - HttpInterfaceFinder : @HttpExchange가 붙어있는 인터페이스 조회
  - HttpInterfaceFactory : 찾은 http interface를 위한 프록시 객체 생성 (+ 유효성 검사)
  - HttpInterfaceFactory : http interface 빈 객체 생성
api 문서 작성 시 depth가 많이 깊어지는데 다음과 같이 작성하는 게 좋을까요?

// [MockHttpServletRequestBuilder] 별도 선언
// [ResourceSnippetParameters] 별도 선언

mockMvc.perform([MockHttpServletRequestBuilder])
  .andExpect(status().isOk())
  .andDo([ResourceSnippetParameters]);

api 명명 규칙(ex. 버저닝)도 말씀해주시면 반영하겠습니다. 현재는 /api만 앞에 붙여줬습니다!
ddl은 어디에 어떤 파일명으로 작성하면 좋을까요? 👀

@NaMinhyeok @pythonstrup
jwt provider 호출 로직을 제외하고 작성했습니다. 리베이스 해서 작업하면 될까요? (아니면 작업하시는 동안 리뷰 반영하거나 애플 로그인 공부하고 있겠습니다!!)

kimyu0218 · 2025-01-28T08:30:38Z

...so-core/src/main/java/org/nexters/jaknaesocore/common/httpinterface/HttpInterfaceFinder.java

+  static boolean filterFixture(final BeanDefinition beanDefinition) {
+    try {
+      Class<?> clazz = Class.forName(beanDefinition.getBeanClassName());
+      return !clazz.getPackage().getName().contains("fixture");
+    } catch (ClassNotFoundException e) {
+      return false;
+    }
+  }
+
+  static boolean isTestEnvironment() {
+    StackTraceElement[] stackTrace = Thread.currentThread().getStackTrace();
+    for (StackTraceElement element : stackTrace) {
+      if (element.getClassName().contains("org.springframework.boot.test.context")) {
+        return true;
+      }
+    }
+    return false;
+  }


보내주신 블로그 글에 없던 내용입니다.

HttpInterfaceFinder가 base package를 중심으로 접근제어자, 테스트 파일과 관계없이 모든 http interface를 스캔하기 때문에 넣어줬습니다.

테스트 코드를 작성하지 않는다면 없어도 되는 부분입니다.

https://mangkyu.tistory.com/291

pythonstrup

고생하셨습니다! 금방 하셨네요!
HttpInterface와 RestClient 구성과 카카오 로그인을 나눠서 작업할 걸 그랬나보네요.. 다음부터는 티켓을 좀 더 쪼개볼까요?

질문에 대한 답변

1. 프로젝트 구조

common/http에 모여 있는 게 좋을 것 같습니다!
BaseEntity는 common/model에 들어가도 괜찮을 것 같아요.
domain/auth/http는 어떨까요? common과 일관성있게 하면 코드를 이해하는 데 좋을 것 같아서요.

2. 테스트 코드

테스트 코드 클래스 외부에 테스트 데이터를 정의하지 않는 것이 좋다는 것에는 동의합니다.
이 부분은 조금 더 확인해보고 리뷰 달겠습니다.

3. api 테스트 depth

저는 이정도 depth는 괜찮다고 생각합니다.
보기 불편하시면 변수로 나누는 것도 괜찮다고 생각해요.

4. api versioning

/api/v1로 할까요? @NaMinhyeok 의견 부탁드립니다.

5. ddl 정의

jaknaeso-core에 src/java/resources/sql 디렉토리에 정리해둘까요?
파일명은 {issueNumber}/{순서}_{작업유형}_{대상}.sql 제안드립니다.
ex) 15/001_create_table_member.sql

jaknaeso-core/src/main/java/org/nexters/jaknaesocore/domain/member/model/Member.java

.../src/test/java/org/nexters/jaknaesoserver/domain/member/repository/MemberRepositoryTest.java

.../src/test/java/org/nexters/jaknaesoserver/common/httpinterface/HttpInterfaceFactoryTest.java

jaknaeso-server/build.gradle.kts

jaknaeso-server/src/main/java/org/nexters/jaknaesoserver/controller/AuthController.java

jaknaeso-core/src/main/java/org/nexters/jaknaesocore/domain/auth/dto/KakaoLoginResponse.java

jaknaeso-core/src/main/java/org/nexters/jaknaesocore/domain/auth/dto/KakaoLoginCommand.java

jaknaeso-core/src/main/java/org/nexters/jaknaesocore/common/support/model/BaseEntity.java

NaMinhyeok

고생하셨습니다 ! 엄청 빠르게 하셨네요

일단 리베이스 하지 마시고.. 필요한 부분 수정하시고,제 작업이 너무 늦다면.. 애플로그인 공부 하시면 될 것 같아요 ! 제 작업은 내일아침이 오기전까지 마무리해두겠습니다.. 죄송해여 😭

제가 HttpInterface에 대해서는 잘 몰라서 리뷰를 제대로 못달겠네요 공부를 해보도록 하겠습니다 ㅎㅎ

저는 api 테스트에 대한 뎁스는 근데 깊어져도 크게 가독성을 해친다거나 하진않는다고 생각해요 실제로 mockMvc테스트 시에는 어느부분에서 문제 발생하는지 쉽게 찾을 수 있고 코드가 문서가 된다기보단, 테스트 성공으로 문서가 되기 때문에 가독성 부분은 괜찮은 것 같습니다 !

저는 API 버저닝 api/v1 하면 좋을 것 같습니다 !

jaknaeso-core/src/main/java/org/nexters/jaknaesocore/domain/member/model/Member.java

NaMinhyeok · 2025-01-28T10:34:51Z

jaknaeso-server/src/test/java/org/nexters/jaknaesoserver/controller/AuthControllerTest.java

+  void kakaoLoginFail() throws Exception {
+    KakaoLoginRequest request = new KakaoLoginRequest("invalid access token");
+
+    given(authService.kakaoLogin(request.toServiceDto())).willThrow(RestClientException.class);


이렇게도 예외를 던질 수가 있군요... willThrow로 하는 방법이 있는지 몰랐네요

저는 테스트 할 때 사실 Request 부분에서 예외를 발생시켜서 실제로 프론트한테 내려가는 응답에 대해서 전부 테스트(예외 메시지, 에러코드, http status 코드 등)했었는데 해당 방법도 좋은 것 같네요!

.../src/test/java/org/nexters/jaknaesoserver/domain/member/repository/MemberRepositoryTest.java

jaknaeso-core/src/main/java/org/nexters/jaknaesocore/domain/auth/service/AuthService.java

jaknaeso-core/src/main/java/org/nexters/jaknaesocore/domain/auth/dto/KakaoLoginResponse.java

jaknaeso-core/src/main/java/org/nexters/jaknaesocore/domain/member/model/Member.java

jaknaeso-core/src/main/java/org/nexters/jaknaesocore/common/support/model/BaseEntity.java

- 디렉토리 위치 변경 - 불필요한 Column 어노테이션 삭제 - createdId, updatedId 추가

BaseEntity - BaseTimeEntity - BaseAuditableEntity - BaseEntity : id - BaseTimeEntity : 타임스탬프 추적 - BaseAuditableEntity : 사용자 정보 추적

- org.nexters.jaknaesocore 테스트 실행 시 SpringBootConfiguration 찾지 못함 - 이를 해결하기 위해 루트 레벨에 SpringBootConfig 설정 파일 작성

pythonstrup

고생하셨어요! 제가 언급한 것들 한 번 읽어보시고, 수정할 것 수정하시고! 머지하면 될 것 같습니다!!

jaknaeso-core/src/main/java/org/nexters/jaknaesocore/SpringBootConfig.java

...so-core/src/main/java/org/nexters/jaknaesocore/domain/socialaccount/model/SocialAccount.java

...aeso-server/src/test/java/org/nexters/jaknaesocore/domain/auth/service/OauthServiceTest.java

jaknaeso-server/src/test/java/org/nexters/jaknaesoserver/controller/AuthControllerTest.java

jaknaeso-core/src/main/java/org/nexters/jaknaesocore/domain/auth/service/OauthService.java

NaMinhyeok · 2025-01-30T05:44:40Z

jaknaeso-core/src/main/java/org/nexters/jaknaesocore/common/model/BaseAuditableEntity.java

+  @CreatedBy
+  @Column(updatable = false)
+  private Long createdBy;
+
+  @LastModifiedBy private Long updatedBy;
+}


이런 형태로 @CreatedBy 를 사용하려면 AuditorAware의 구현체를 만들어야된다고 하는데 없이도 사용이 가능한가요 ??

아니면 아직 관련 설정을 안해두신걸까요 ??

제가 @CreatedBy를 처음 사용해봐서 필요한 부분인지 몰랐습니다 😂
구글링 해보니 시큐리티에서 authentication 객체를 가져오고 principal의 username을 사용하는 것 같은데 이렇게 구현하셨었나요??

저는 @CreatedBy를 사용해본 적이 없어서 잘 모르겠지만, 조금 찾아보니 유정님이 제안하신대로 시큐리티에서 authentication 객체를 가져오고 principal의 username을 사용 하면 될 것 같아요!

사실 저도 사용해본적이 없어서 검색해보다가 알게되었는데 없는것 같아서 리뷰남겼습니다 🤣
principal에 username에 userid가 들어있으니 이용하면 될 것 같아요 !!

social account의 member가 null일 수 있으므로 left join fetch 사용

kimyu0218 self-assigned this Jan 28, 2025

github-actions bot requested review from NaMinhyeok and pythonstrup January 28, 2025 08:27

kimyu0218 commented Jan 28, 2025

View reviewed changes

pythonstrup requested changes Jan 28, 2025

View reviewed changes

kimyu0218 linked an issue Jan 28, 2025 that may be closed by this pull request

feat: 카카오 로그인 #15

Closed

NaMinhyeok approved these changes Jan 28, 2025

View reviewed changes

kimyu0218 added 23 commits January 29, 2025 12:54

[#15] feat: MediaTypeBuilder 클래스 작성

5c8ebef

[#15] feat: HttpInterface 프록시 객체 생성을 위한 클래스 작성

ee1fda6

[#15] feat: RestClient 에러 핸들러 등록

b7a2bae

[#15] chore: jaknaesoserver -> jaknaesocore

ee9a828

[#15] feat: basePackage 지정

c91be11

[#15] feat: 카카오 로그인 관련 dto 작성

1e50ab0

[#15] refactor: 불필요한 매개변수 삭제 및 fixture 정의

60636cf

[#15] refactor: RestClientErrorHandler 매개변수 타입 수정

bdaa90d

[#15] feat: 카카오 로그인 API를 호출하는 KakaoClient 정의

5096c41

[#15] chore: 이름 변경 (oauth -> auth)

b568c3a

[#15] chore: 포맷터 적용

3b474d6

[#15] chore: 테스트 함수명 수정

1bfe637

[#15] feat: 멤버 모델, 레포지토리 작성

c13a283

[#15] chore: 테스트 display name 수정

5f62551

[#15] chore: 서비스 계층 dto 파일 위치 변경

25e473f

[#15] chore: default 상태 생략

6ff36fd

[#15] chore: api 버저닝 추가

364a7b2

[#15] chore: 코드 리뷰 반영

132e938

- 디렉토리 위치 변경 - 불필요한 Column 어노테이션 삭제 - createdId, updatedId 추가

[#15] refactor: 로그인 시 멤버 아이디 함께 반환

7d675b5

[#15] chore: 프로젝트 구조 수정

0c0e971

[#15] refactor: base entity 리팩토링

05ef1a8

BaseEntity - BaseTimeEntity - BaseAuditableEntity - BaseEntity : id - BaseTimeEntity : 타임스탬프 추적 - BaseAuditableEntity : 사용자 정보 추적

[#15] refactor: 계정 통합 지원을 위한 social account 분리

b3acf5f

[#15] refactor: assertj -> BDD assertions

3361ef4

kimyu0218 added 7 commits January 29, 2025 13:03

[#15] feat: SpringBootConfig 정의

d0225c5

- org.nexters.jaknaesocore 테스트 실행 시 SpringBootConfiguration 찾지 못함 - 이를 해결하기 위해 루트 레벨에 SpringBootConfig 설정 파일 작성

[#15] chore: ddl 파일 추가

a71e70a

[#15] feat: 토큰 서비스 병합

414e69d

[#15] refactor: 테스트 시 컨텍스트 공유하도록 수정

3e68271

[#15] feat: sample api 퍼블릭 엔드포인트로 등록

b4e7c23

[#15] chore: jwt 관련 환경변수 추가

f040530

[#15] feat: oauth 서비스 단위 테스트 작성

371cf00

kimyu0218 force-pushed the feature/#15-카카오-로그인 branch from 8c325e7 to 371cf00 Compare January 29, 2025 18:23

kimyu0218 requested review from NaMinhyeok and pythonstrup January 30, 2025 04:30

pythonstrup approved these changes Jan 30, 2025

View reviewed changes

NaMinhyeok reviewed Jan 30, 2025

View reviewed changes

kimyu0218 added 5 commits January 30, 2025 15:11

[#15] refactor: eager loading -> lazy loading + fetch join

cca9982

social account의 member가 null일 수 있으므로 left join fetch 사용

[#15] refactor: 테스트 환경 수정

2411341

[#15] chore: 디렉토리 변경

93a42d3

[#15] chore: 테스트 환경 수정

5808d73

[#15] chore: createdBy, updatedBy 삭제

6b3313f

kimyu0218 merged commit 64699ab into main Jan 30, 2025
1 check passed

NaMinhyeok deleted the feature/#15-카카오-로그인 branch February 15, 2025 17:21

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feat(#15): 카카오 로그인 #18

Feat(#15): 카카오 로그인 #18

kimyu0218 commented Jan 28, 2025 •

edited

Loading

kimyu0218 Jan 28, 2025 •

edited

Loading

pythonstrup left a comment •

edited

Loading

NaMinhyeok left a comment

NaMinhyeok Jan 28, 2025

pythonstrup left a comment •

edited

Loading

NaMinhyeok Jan 30, 2025

kimyu0218 Jan 30, 2025

pythonstrup Jan 30, 2025

NaMinhyeok Jan 30, 2025

Feat(#15): 카카오 로그인 #18

Feat(#15): 카카오 로그인 #18

Conversation

kimyu0218 commented Jan 28, 2025 • edited Loading

작업 개요

작업 사항

고민한 점들(필수 X)

kimyu0218 Jan 28, 2025 • edited Loading

Choose a reason for hiding this comment

pythonstrup left a comment • edited Loading

Choose a reason for hiding this comment

질문에 대한 답변

1. 프로젝트 구조

2. 테스트 코드

3. api 테스트 depth

4. api versioning

5. ddl 정의

NaMinhyeok left a comment

Choose a reason for hiding this comment

NaMinhyeok Jan 28, 2025

Choose a reason for hiding this comment

pythonstrup left a comment • edited Loading

Choose a reason for hiding this comment

NaMinhyeok Jan 30, 2025

Choose a reason for hiding this comment

kimyu0218 Jan 30, 2025

Choose a reason for hiding this comment

pythonstrup Jan 30, 2025

Choose a reason for hiding this comment

NaMinhyeok Jan 30, 2025

Choose a reason for hiding this comment

kimyu0218 commented Jan 28, 2025 •

edited

Loading

kimyu0218 Jan 28, 2025 •

edited

Loading

pythonstrup left a comment •

edited

Loading

pythonstrup left a comment •

edited

Loading