[feat] 사용자 로그인 기능 구현 #22

jw427 · 2024-08-25T09:50:39Z

Issue

사용자 로그인 (API) #14

PR 타입(하나 이상의 PR 타입을 선택해주세요)

기능 추가
기능 삭제
버그 수정
의존성, 환경 변수, 빌드 관련 코드 업데이트

반영 브랜치

feat/login -> dev

변경 사항

jwt사용을 위한 dependency와 Spring Security 설정을 위한 Config 파일 수정
로그인 시 accessToken과 refreshToken 발급
토큰 만료시 accessToken과 refreshToken 재발급

테스트 결과

Request

HTTP : `POST`
URL: /user/login

Request Body

{
  "account": "계정",
  "password": "비밀번호"
}

Response : 성공시

{
  "userId": "회원 고유아이디",
  "token": "액세스 토큰"
}

토큰 재발급

Request

HTTP : `POST`
URL: /api/token

Request Header

Authorization: “Bearer XXXXXXXXX”

Request Body

{
  "accessToken": "액세스 토큰",
  "refreshToken": "리프레시 토큰"
}

Response : 성공시

{
  "accessToken": "재발급 받은 액세스 토큰",
  "refreshToken": "재발급 받은 리프레시 토큰"
}

- accessToken을 이용한 로그인 기능 먼저 구현 - UserDetail과 UserDetailService 생성 - UserRepository 작성 - 토큰 생성, 유효성 검증, 토큰에서 필요한 정보 가져오는 TokenProvider 클래스 생성 - 발급받은 토큰을 검증하고 다음 필터로 전달하는 TokenAuthenticationFilter 클래스 생성 - Spring Security 설정을 위한 SecurityConfig 작성 - UserController 작성

- 기존의 로그인시 액세스토큰만 발급되던 코드에 리프레시토큰도 발급되어 저장되는 로직 UserService에 추가 - 로그인해도 토큰이 바뀌지 않는 문제 TokenProvider에서 수정 -- claim에 발급 시간과 만료 시간 추가 - TokenService에서 리프레시 토큰을 검증해 액세스토큰과 리프레시토큰 재발급하는 로직 추가

pie2457

수고하셨습니다~~ 리뷰 읽어보시고 반영 부탁드려요 ㅎㅎ

pie2457 · 2024-08-25T11:36:36Z

src/main/java/wanted/media/user/config/TokenProvider.java

+    @Value("${jwt.secret_key}")
+    private String key;
+
+    private long tokenValidTime = 1000L * 60 * 60; // 1시간


이 부분은 secret.yml에 같이 넣어도 될 것 같아요

토큰 만료 기간 말하는 걸까요?

네! 그리고 .yml 파일들 전부 노션에 올려주세요 ~

yml 파일은 노션 문서 페이지 하단에 올려두었습니다. 빈 값들은 각자 로컬 환경에 맞게 넣어서 사용하시면 될 것 같아요!

pie2457 · 2024-08-25T11:41:26Z

src/main/java/wanted/media/user/config/TokenProvider.java

+        Date now = new Date();
+        long time = type.equals("access") ? tokenValidTime : RefreshTokenValidTime;
+
+        return Jwts.builder()


return Jwts.builder() .setHeaderParam(Header.TYPE, Header.JWT_TYPE) // 헤더 타입 .setClaims(Jwts.claims() .setSubject(account) .setAudience(type) .setIssuedAt(now) .setExpiration(new Date(now.getTime() + time)) ) .signWith(SignatureAlgorithm.HS256, key) // HS256 방식으로 key와 함께 암호화 .compact(); }

메서드 체이닝 방식은 .을 기준으로 내려주시면 가독성이 더 좋은 것 같습니다~!

pie2457 · 2024-08-25T11:46:34Z

src/main/java/wanted/media/user/repository/TokenRepository.java

+import java.util.UUID;
+
+public interface TokenRepository extends JpaRepository<Token, Long> {
+    @Query("SELECT t FROM Token t WHERE t.user.userId = :userId")


여기는 Query를 작성하신 이유가 있나용?

메서드 네이밍 문제인지 회원고유식별값으로 해당 회원의 토큰을 찾는 동작을 제대로 수행하지 못해 쿼리를 작성하게 됐습니다.

왜 userId를 못찾아오는지 확인해보셔도 될 것 같아요 원래라면 되야 하는 메서드니까~!

pie2457 · 2024-08-25T11:48:20Z

src/main/java/wanted/media/user/service/TokenService.java

+        String accessToken = tokenProvider.makeToken(user.getAccount(), "access");
+        String refreshToken = tokenProvider.makeToken(user.getAccount(), "refresh");
+
+        storedToken.updateToken(refreshToken);


updateToken메서드를 여기서만 사용하시는 거라면 updateToken 메서드의 return 타입은 void여도 괜찮을 것 같습니다!

UserService 클래스에서 새 토큰으로 업데이트할 때도 사용하고 있습니다!

src/main/java/wanted/media/user/service/TokenService.java

pie2457 · 2024-08-25T11:54:40Z

src/main/java/wanted/media/user/controller/UserController.java

@@ -11,4 +16,10 @@
 public class UserController {

    private final UserService userService;
+
+    @PostMapping("/login")
+    public ResponseEntity<UserLoginResponseDto> loginUser(@RequestBody UserLoginRequestDto requestDto) {


여기도 User라는 말은 굳이 사용하지 않으셔도 괜찮을 것 같아요 ! 로그인 기능이니까 ㅎㅎ

pie2457 · 2024-08-25T11:55:36Z

src/main/java/wanted/media/user/dto/UserLoginRequestDto.java

+@NoArgsConstructor(access = AccessLevel.PROTECTED)
+@AllArgsConstructor
+public class UserLoginRequestDto {
+


여기도 필드 공백 제거해주세요!

pie2457 · 2024-08-25T11:55:50Z

src/main/java/wanted/media/user/service/TokenService.java

+@Service
+@RequiredArgsConstructor
+public class TokenService {
+


여기도 필드 공백 제거해주세요!

pie2457 · 2024-08-25T11:57:28Z

src/main/java/wanted/media/user/service/UserDetailService.java

+    @Override
+    public UserDetails loadUserByUsername(String account) throws UsernameNotFoundException {
+        User user = userRepository.findByAccount(account)
+                .orElseThrow(() -> new IllegalArgumentException("계정이 존재하지 않습니다."));


여기도 NotFound가 맞을 것 같네요~!

pie2457 · 2024-08-25T11:59:42Z

src/main/java/wanted/media/user/domain/UserDetail.java

+import java.util.Collection;
+import java.util.List;
+
+public class UserDetail implements UserDetails {


이 클래스는 뭐하는 클래스 인가요?
사용하지 않는 메서드를 Override할 필요가 없을 것 같은데..!
필드 공백도 제거 해주세요 ㅎㅎ

Spring Security를 이용한 로그인을 구현하는데 있어서 Spring Security에서 사용자 정보를 담는 인터페이스인 UserDetails를 구현할 필요가 있었습니다. 해당 인터페이스의 기본 오버라이드 메서드들을 구현하느라 코드가 길어지게 됐어요. 필드 공백은 제거하도록 하겠습니다!

음 .. 그럼 다른 방법이 없을까요? 기본 메서드를 전부 사용하지 않는데 구현해 놓는 것은 SOLID 원칙에도 위배가 될 것 같아요 !

흐음 이거에 대해서 저도 찾아보는 중인데 어쩔 수 없나보네요ㅠㅠ secrurity 너무 어렵네요..!

UserDetails 구현을 위해서 메서드들을 사용하지 않더라도 확장성 측면에서 기본적으로 구현하는 것이 낫겠다고 판단해서 메서드들을 구현해놨는데요, 이 부분은 다른 방법을 생각해보지 못해서 고민해보겠습니다.

pie2457 · 2024-08-25T12:45:18Z

src/main/java/wanted/media/user/repository/TokenRepository.java

+
+public interface TokenRepository extends JpaRepository<Token, Long> {
+    @Query("SELECT t FROM Token t WHERE t.user.userId = :userId")
+    Optional<Token> findByUserId(@Param("userId") UUID userID);


@Param 제거하시고 userId로 변경하시면 될 것 같습니당

pie2457 · 2024-08-25T12:46:21Z

src/main/java/wanted/media/user/dto/TokenRequestDto.java

+@Getter
+@NoArgsConstructor(access = AccessLevel.PROTECTED)
+@AllArgsConstructor
+public class TokenRequestDto {


이거는 record 클래스 알아보시고 사용하시면 될 것 같아요~

public record TokenRequestDto(String accessToken, String refreshToken) { }

이렇게 간결하게 만들어줄 수 있습니다!

네 한번 찾아보겠습니다!

pie2457 · 2024-08-25T12:48:16Z

src/main/java/wanted/media/user/repository/TokenRepository.java

+import java.util.UUID;
+
+public interface TokenRepository extends JpaRepository<Token, Long> {
+    @Query("SELECT t FROM Token t WHERE t.user.userId = :userId")


왜 userId를 못찾아오는지 확인해보셔도 될 것 같아요 원래라면 되야 하는 메서드니까~!

pie2457 · 2024-08-25T12:50:13Z

src/main/java/wanted/media/user/service/UserService.java

+        Optional<Token> refreshToken = tokenRepository.findByUserId(user.getUserId()); // 리프레시 토큰 있는지 확인
+        String newRefreshToken = tokenProvider.makeToken(requestDto.getAccount(), "refresh"); // 새 리프레시 토큰
+        if (refreshToken.isPresent()) { // 리프레시 토큰 있을 경우
+            tokenRepository.save(refreshToken.get().updateToken(newRefreshToken)); // 새 토큰으로 업데이트


jpa의 변경 감지 기능을 아시나용? 이거는 따로 save해주지 않아도 됩니다!

이 부분은 생각도 못했네요 감사합니다!

pie2457 · 2024-08-25T13:09:26Z

src/main/java/wanted/media/user/service/TokenService.java

+    private final TokenRepository tokenRepository;
+    private final UserRepository userRepository;
+
+    // 액세스 토큰 재발행


Service 레이어에 전부 @Transaction이 빠져있네요!

- TokenProvider의 makeToken 메서드 가독성을 위한 수정 - 회원이 존재하지 않는 경우의 에러 핸들링 추가

pie2457 · 2024-08-25T13:32:26Z

src/main/java/wanted/media/user/config/TokenProvider.java

+            return e.getClaims().getSubject();
+        }
+    }
+


7같은 매직넘버보다는 위의 "Bearer "를 BEARER_PREFIX같은 상수로 빼서 .length()를 사용하셔도 좋을 것 같아요!

- TokenController과 TokenService의 재발급 메서드 명칭 getToken으로 수정 - 직관성을 위해 URL도 수정

K-0joo

수고하셨습니다!

pie2457

수정해주신거 확인했습니다 👍🏼👍🏼👍🏼👍🏼👍🏼

rhaehf

고생하셨습니다!

jeongeungyeong

수고하셨습니다!

jw427 added 2 commits August 24, 2024 01:22

jw427 added the feat label Aug 25, 2024

jw427 requested review from rhaehf, K-0joo, pie2457, ssunnykku and jeongeungyeong August 25, 2024 09:50

jw427 self-assigned this Aug 25, 2024

pie2457 reviewed Aug 25, 2024

View reviewed changes

refactor : 가독성 위한 코드 수정 및 에러 핸들링 추가

3765657

- TokenProvider의 makeToken 메서드 가독성을 위한 수정 - 회원이 존재하지 않는 경우의 에러 핸들링 추가

pie2457 reviewed Aug 25, 2024

View reviewed changes

jw427 added 9 commits August 25, 2024 22:35

refactor : 토큰 만료시간 수정

d888f83

refactor : 필드 공백 제거

848ce30

refactor : 코드 재발급 메서드 명칭 수정

979198c

- TokenController과 TokenService의 재발급 메서드 명칭 getToken으로 수정 - 직관성을 위해 URL도 수정

refactor : 로그인 메서드 명칭 ㅅ정

e2ff106

refactor : TokenRequestDto record 클래스로 수정

9455bed

refactor : JPA 변경 감지 기능에 따른 save() 메서드 삭제

e21ab02

refactor : Service에 트랜잭션 설정 추가

382d032

refactor :TokenProvider에 상수 변경

720d726

refactor : TokenRepository 쿼리문 삭제

6791477

jw427 linked an issue Aug 25, 2024 that may be closed by this pull request

사용자 로그인 (API) #14

Open

4 tasks

K-0joo approved these changes Aug 26, 2024

View reviewed changes

refactor : yml 파일 추가

e330442

pie2457 approved these changes Aug 26, 2024

View reviewed changes

ssunnykku approved these changes Aug 26, 2024

View reviewed changes

rhaehf approved these changes Aug 26, 2024

View reviewed changes

jeongeungyeong approved these changes Aug 26, 2024

View reviewed changes

jw427 added 3 commits August 26, 2024 14:11

refactor : dev yml파일 수정

ca15823

refactor : 로그인시 비밀번호 암호화 적용 추가

7f57a62

fix : 충돌 해결

4d40bbb

jw427 merged commit c78da78 into dev Aug 26, 2024

jw427 deleted the feat/login branch August 26, 2024 08:55

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[feat] 사용자 로그인 기능 구현 #22

[feat] 사용자 로그인 기능 구현 #22

jw427 commented Aug 25, 2024 •

edited

Loading

pie2457 left a comment

pie2457 Aug 25, 2024

jw427 Aug 25, 2024

pie2457 Aug 25, 2024 •

edited

Loading

jw427 Aug 25, 2024

pie2457 Aug 25, 2024

pie2457 Aug 25, 2024

jw427 Aug 25, 2024

pie2457 Aug 25, 2024

pie2457 Aug 25, 2024

jw427 Aug 25, 2024

pie2457 Aug 25, 2024

pie2457 Aug 25, 2024

pie2457 Aug 25, 2024

pie2457 Aug 25, 2024

pie2457 Aug 25, 2024

jw427 Aug 25, 2024

pie2457 Aug 25, 2024

pie2457 Aug 25, 2024

jw427 Aug 25, 2024

pie2457 Aug 25, 2024

pie2457 Aug 25, 2024

jw427 Aug 25, 2024

pie2457 Aug 25, 2024

pie2457 Aug 25, 2024

jw427 Aug 25, 2024

pie2457 Aug 25, 2024

pie2457 Aug 25, 2024

K-0joo left a comment

pie2457 left a comment

rhaehf left a comment

jeongeungyeong left a comment

[feat] 사용자 로그인 기능 구현 #22

[feat] 사용자 로그인 기능 구현 #22

Conversation

jw427 commented Aug 25, 2024 • edited Loading

Issue

PR 타입(하나 이상의 PR 타입을 선택해주세요)

반영 브랜치

변경 사항

테스트 결과

로그인

Request

Response : 성공시

토큰 재발급

Request

Response : 성공시

pie2457 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

pie2457 Aug 25, 2024 • edited Loading

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

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

K-0joo left a comment

Choose a reason for hiding this comment

pie2457 left a comment

Choose a reason for hiding this comment

rhaehf left a comment

Choose a reason for hiding this comment

jeongeungyeong left a comment

Choose a reason for hiding this comment

jw427 commented Aug 25, 2024 •

edited

Loading

pie2457 Aug 25, 2024 •

edited

Loading