Merge pull request #247 from 7-umc-GrowIT/feat/#245

[#245] Feat: 로그아웃 api 구현

Author: Jinseong01

src/main/java/umc/GrowIT/Server/converter/UserConverter.java

@@ -1,6 +1,7 @@
 package umc.GrowIT.Server.converter;
 
 import umc.GrowIT.Server.domain.User;
+import umc.GrowIT.Server.web.dto.AuthDTO.AuthResponseDTO;
 import umc.GrowIT.Server.web.dto.OAuthDTO.OAuthApiResponseDTO;
 import umc.GrowIT.Server.web.dto.OAuthDTO.OAuthResponseDTO;
 import umc.GrowIT.Server.web.dto.TokenDTO.TokenResponseDTO;
@@ -50,4 +51,11 @@ public static OAuthResponseDTO.KakaoLoginDTO toKakaoLoginDTO(Boolean signupRequi
                 .tokens(tokens)
                 .build();
     }
+
+    public static AuthResponseDTO.LogoutResponseDTO toLogoutDTO(){
+
+        return AuthResponseDTO.LogoutResponseDTO.builder()
+                .message("로그아웃이 완료되었습니다.")
+                .build();
+    }
 }

src/main/java/umc/GrowIT/Server/service/authService/AuthService.java

@@ -1,6 +1,5 @@
 package umc.GrowIT.Server.service.authService;
 
-import jakarta.validation.Valid;
 import umc.GrowIT.Server.domain.enums.AuthType;
 import umc.GrowIT.Server.web.dto.AuthDTO.AuthRequestDTO;
 import umc.GrowIT.Server.web.dto.AuthDTO.AuthResponseDTO;
@@ -9,4 +8,6 @@ public interface AuthService {
     AuthResponseDTO.SendAuthEmailResponseDTO sendAuthEmail(AuthType type, AuthRequestDTO.SendAuthEmailRequestDTO request);
 
     AuthResponseDTO.VerifyAuthCodeResponseDTO verifyAuthCode(AuthRequestDTO.VerifyAuthCodeRequestDTO request);
+
+    AuthResponseDTO.LogoutResponseDTO logout(Long userId);
 }

src/main/java/umc/GrowIT/Server/service/authService/AuthServiceImpl.java

@@ -8,18 +8,22 @@
 import org.apache.commons.lang3.RandomStringUtils;
 import org.springframework.mail.javamail.JavaMailSender;
 import org.springframework.stereotype.Service;
+import org.springframework.transaction.annotation.Transactional;
 import org.thymeleaf.TemplateEngine;
 import org.thymeleaf.context.Context;
 import umc.GrowIT.Server.apiPayload.code.status.ErrorStatus;
 import umc.GrowIT.Server.apiPayload.exception.AuthHandler;
 import umc.GrowIT.Server.apiPayload.exception.UserHandler;
 import umc.GrowIT.Server.converter.AuthenticationCodeConverter;
+import umc.GrowIT.Server.converter.UserConverter;
 import umc.GrowIT.Server.domain.AuthenticationCode;
+import umc.GrowIT.Server.domain.RefreshToken;
 import umc.GrowIT.Server.domain.User;
 import umc.GrowIT.Server.domain.enums.AuthType;
 import umc.GrowIT.Server.domain.enums.CodeStatus;
 import umc.GrowIT.Server.repository.AuthenticationCodeRepository;
 import umc.GrowIT.Server.repository.UserRepository;
+import umc.GrowIT.Server.service.refreshTokenService.RefreshTokenCommandService;
 import umc.GrowIT.Server.service.userService.UserCommandService;
 import umc.GrowIT.Server.web.dto.AuthDTO.AuthRequestDTO;
 import umc.GrowIT.Server.web.dto.AuthDTO.AuthResponseDTO;
@@ -29,8 +33,6 @@
 
 import org.springframework.beans.factory.annotation.Value;
 
-import static umc.GrowIT.Server.domain.enums.UserStatus.INACTIVE;
-
 @Service
 @RequiredArgsConstructor
 public class AuthServiceImpl implements AuthService {
@@ -40,6 +42,7 @@ public class AuthServiceImpl implements AuthService {
     private final JavaMailSender javaMailSender;
     private final TemplateEngine templateEngine;
     private final AuthenticationCodeRepository authenticationCodeRepository;
+    private final RefreshTokenCommandService refreshTokenCommandService;
 
     @Value("${spring.mail.username}")
     private String fromEmail;
@@ -149,4 +152,30 @@ private AuthenticationCode saveAuthenticationCode(String email, String authentic
         AuthenticationCode newAuthenticationCode = AuthenticationCodeConverter.toAuthenticationCode(email, authenticationCode);
         return authenticationCodeRepository.save(newAuthenticationCode);
     }
+
+    @Override
+    @Transactional
+    public AuthResponseDTO.LogoutResponseDTO logout(Long userId){
+
+        // 1. 사용자 조회
+        User user = userRepository.findById(userId)
+                .orElseThrow(()-> new UserHandler(ErrorStatus.USER_NOT_FOUND));
+
+        // 2. RefreshToken이 있는 경우에만 삭제 처리
+        if (user.getRefreshToken() != null) {
+            // RefreshToken DB에서 삭제
+            RefreshToken refreshToken = user.getRefreshToken();
+            user.deleteRefreshToken(); // User 엔티티의 refreshToken 필드를 null로 설정
+            userRepository.save(user);
+
+            // RefreshToken 엔티티 삭제
+            refreshTokenCommandService.deleteRefreshToken(refreshToken);
+        }
+
+        // 3. 성공 응답 반환 (이미 로그아웃된 상태여도 성공으로 처리)
+        return UserConverter.toLogoutDTO();
+
+
+    }
+
 }

src/main/java/umc/GrowIT/Server/service/refreshTokenService/RefreshTokenCommandService.java

@@ -13,5 +13,5 @@ public interface RefreshTokenCommandService {
 
     TokenResponseDTO.AccessTokenDTO reissueToken(TokenRequestDTO.ReissueDTO reissueDTO);
 
-
+    void deleteRefreshToken(RefreshToken refreshToken);
 }

src/main/java/umc/GrowIT/Server/service/refreshTokenService/RefreshTokenCommandServiceImpl.java

@@ -66,4 +66,9 @@ public TokenResponseDTO.AccessTokenDTO reissueToken(TokenRequestDTO.ReissueDTO r
 
     }
 
+    @Override
+    @Transactional
+    public void deleteRefreshToken(RefreshToken refreshToken) {
+        refreshTokenRepository.delete(refreshToken);
+    }
 }

src/main/java/umc/GrowIT/Server/web/controller/AuthController.java

@@ -4,6 +4,8 @@
 import jakarta.validation.Valid;
 import lombok.RequiredArgsConstructor;
 import lombok.extern.slf4j.Slf4j;
+import org.springframework.security.core.Authentication;
+import org.springframework.security.core.context.SecurityContextHolder;
 import org.springframework.web.bind.annotation.*;
 import umc.GrowIT.Server.apiPayload.ApiResponse;
 import umc.GrowIT.Server.domain.enums.AuthType;
@@ -92,4 +94,17 @@ public ApiResponse<TokenResponseDTO.TokenDTO> signupSocial(@RequestBody @Valid O
         TokenResponseDTO.TokenDTO tokenDTO = oAuthService.signupSocial(oAuthUserInfoAndUserTermsDTO);
         return ApiResponse.onSuccess(tokenDTO);
     }
+    @Override
+    @PostMapping("/logout")
+    public ApiResponse<AuthResponseDTO.LogoutResponseDTO> logout() {
+        // AccessToken에서 userId 추출
+        Authentication authentication = SecurityContextHolder.getContext().getAuthentication();
+        Long userId = (Long) authentication.getPrincipal();
+
+        // 로그아웃 처리
+        AuthResponseDTO.LogoutResponseDTO result = authService.logout(userId);
+
+        return ApiResponse.onSuccess(result);
+    }
+
 }

src/main/java/umc/GrowIT/Server/web/controller/specification/AuthSpecification.java

@@ -16,7 +16,6 @@
 import umc.GrowIT.Server.web.dto.TokenDTO.TokenRequestDTO;
 import umc.GrowIT.Server.web.dto.TokenDTO.TokenResponseDTO;
 import umc.GrowIT.Server.web.dto.UserDTO.UserRequestDTO;
-import umc.GrowIT.Server.web.dto.UserDTO.UserResponseDTO;
 
 public interface AuthSpecification {
 
@@ -100,4 +99,16 @@ ApiResponse<AuthResponseDTO.SendAuthEmailResponseDTO> sendAuthEmail(
             @io.swagger.v3.oas.annotations.responses.ApiResponse(responseCode = "TERM4003", description = "❌ 전체 약관 정보를 주세요.", content = @Content(schema = @Schema(implementation = ApiResponse.class)))
     })
     ApiResponse<TokenResponseDTO.TokenDTO> signupSocial(@RequestBody @Valid OAuthRequestDTO.OAuthUserInfoAndUserTermsDTO oAuthUserInfoAndUserTermsDTO);
+
+    @PostMapping("/logout")
+    @Operation(summary = "로그아웃 API", description = "사용자 로그아웃을 처리하는 API입니다. AccessToken을 무효화하고 RefreshToken을 삭제합니다.")
+    @ApiResponses({
+            @io.swagger.v3.oas.annotations.responses.ApiResponse(responseCode = "COMMON200", description = "⭕ SUCCESS"),
+            @io.swagger.v3.oas.annotations.responses.ApiResponse(responseCode = "USER4002", description = "❌ 이메일 또는 패스워드가 일치하지 않습니다.", content = @Content(schema = @Schema(implementation = ApiResponse.class))),
+            @io.swagger.v3.oas.annotations.responses.ApiResponse(responseCode = "USER4004", description = "❌ 탈퇴한 회원입니다.", content = @Content(schema = @Schema(implementation = ApiResponse.class))),
+            @io.swagger.v3.oas.annotations.responses.ApiResponse(responseCode = "AUTH4011", description = "❌ 유효하지 않은 토큰입니다.", content = @Content(schema = @Schema(implementation = ApiResponse.class))),
+            @io.swagger.v3.oas.annotations.responses.ApiResponse(responseCode = "AUTH4012", description = "❌ 만료된 토큰입니다.", content = @Content(schema = @Schema(implementation = ApiResponse.class))),
+            @io.swagger.v3.oas.annotations.responses.ApiResponse(responseCode = "AUTH4015", description = "❌ 토큰이 제공되지 않았습니다.", content = @Content(schema = @Schema(implementation = ApiResponse.class)))
+    })
+    ApiResponse<AuthResponseDTO.LogoutResponseDTO> logout();
 }

src/main/java/umc/GrowIT/Server/web/dto/AuthDTO/AuthResponseDTO.java

@@ -31,4 +31,12 @@ public static class VerifyAuthCodeResponseDTO {
         // TODO 디테일하게 결정 필요
         private String message; // ex) 인증이 완료되었습니다, 인증번호가 올바르지 않습니다
     }
+
+    @Getter
+    @Builder
+    @NoArgsConstructor
+    @AllArgsConstructor
+    public static class LogoutResponseDTO {
+        private String message; // "로그아웃이 완료되었습니다."
+    }
 }