[SpringBoot3/Kotlin] SNS 로그인 (Rest API)

💡 SNS 로그인(카카오)을 위한 Rest API 생성

➡️ 1탄 바로가기: 설정 및 회원가입

➡️ 2탄 바로가기: JWT 로그인 및 회원 정보 조회

➡️ 3탄 바로가기: Refresh Token

---

SNS 로그인 Flow

해당 프로젝트에서는 모바일 어플리케이션을 위한 Rest API를 구현한다.

1. Client SDK에서 카카오 로그인 완료 후 3rd로부터 전해받는 accesToken을 Server에 전달한다.
2. 해당 AccessToken으로 다시한번 3rd에 조회하여, 회원 정보를 가져온다.
3. 조회한 회원 정보가 있을 경우, 바로 로그인 로직을 실행하여 성공 응답을 보낸다.
4. 조회한 회원 정보가 없을 경우, 회원 정보를 새로 저장(회원가입)하고 로그인까지 성공시켜 응답을 보낸다.

---

개발 환경

• Spring Boot 3.x.x / Kotlin
• Spring Security 3.1.4
• JWT 0.11.5
• Kakao Developers

Member Entity

기존 member entity에 social 회원을 위한 필드 추가

@Entity
@Table(name = "member")
class Member(
    @Id
    @GeneratedValue(strategy = GenerationType.UUID)
    val id: UUID? = null,    

    @Column(nullable = false, unique = true)    
    val email: String,       

    @Column(nullable = false)
    val password: String,

    val name: String,    

    @Enumerated(value = EnumType.STRING)
    val type: MemberType = MemberType.MEMBER,    

    @Enumerated(value = EnumType.STRING)
    val socialType: SocialType? = null,    // ADD: 소셜 회원일 시, 타입을 저장한다

    val createdAt: LocalDateTime = LocalDateTime.now()
) {
    fun toInfoDto() = MemberInfoResponse(
        email,
        name
    )
}

enum class SocialType(val value: String){
    KAKAO("kakao");

    companion object {
        fun from(value: String): SocialType = SocialType.values().first { it.value == value }
    }
}

SocialAuthController

Client로부터 SNS 로그인에 필요한 정보를 받음

@RestController
@RequestMapping("/auth")
class AuthController(
    private val socialAuthService: SocialAuthService
) {
    @GetMapping("/sns/{type}")
    fun loginSocialUser(
        @RequestHeader("Authorization") token: String, @PathVariable("type") type: String
    ): BaseResponse<TokenInfo> = socialAuthService.signInWithSocial(token, type).let {
        BaseResponse(data = it)
    }
}

• `token`: 클라이언트에서 진행된 ‘SNS 로그인’ 결과로 반환된 토큰
• `type`: 로그인한 ‘SNS’ 타입 (kakao, naver …)

SocialAuthService

SNS 회원을 위한 Authentication 로직을 담당

@Service
class SocialAuthService(
    private val memberRepository: MemberRepository
) {
    fun signInWithSocial(token: String, type: String): TokenInfo {
        val socialType = SocialType.from(type)
        val socialUser = getSocialUserFromType(token, socialType)

        val member = memberRepository.findByEmailAndSocialType(socialUser.email, socialType) 
			        ?: signUpWithSocial(socialUser, socialType)

        return createTokenWithMember(member)
    }
}

1. 클라이언트로부터 받은 type 과 token 으로 해당 sns에 유저 정보 조회
2. 조회된 멤버의 이메일과 SNS 타입이 동일한 유저가 이미 등록되어있는지 확인
   1. 이미 등록되어 있다면, 바로 로그인 토큰 발급
   2. 등록되어있지 않다면, 회원가입 로직 선행 후 로그인 토큰 발급

Social Type에 따라서 유저 정보를 가져오는 Client를 호출

private fun getSocialUserFromType(token: String, type: SocialType): SocialUser {
    return when (type) {
        SocialType.KAKAO -> {
            socialClient.getKakaoUser(token).run {
                if (kakaoAccount == null) throw AuthenticationCredentialsNotFoundException("kakao 계정이 존재하지 않습니다.")
                else SocialUser(
                    email = kakaoAccount.email, name = kakaoAccount.name
                )
            }
        }
    }
}

1. 각 SNS Client 호출 후 SNS 유저 정보를 받아옴
2. 해당 유저 정보로 SocialUser를 생성 후 반환

SNS 회원 가입 로직

private fun signUpWithSocial(socialUser: SocialUser, socialType: SocialType): Member {
    memberRepository.findByEmail(socialUser.email)?.let {
        throw DuplicateKeyException("Already Exists")
    }

    val member = Member(
        email = socialUser.email,
        name = socialUser.name, 
        socialType = socialType,
        password = passwordEncoder.encode(
            listOf(
                socialType, socialUser.email, socialUser.name
            ).joinToString("")
        )
    )
    memberRepository.save(member)

    return member
}

• SNS 회원은 password로 로그인 진행이 불가함 → 회원 정보로 임의의 패스워드 생성 후 저장

SNS 회원 정보 로그인

private fun createTokenWithMember(member: Member): TokenInfo {
    val authorities = listOf(SimpleGrantedAuthority("ROLE_${member.type}"))
    val principal = CustomUser(UUID.fromString(member.id.toString()), member.email, member.password, authorities)

    val authenticationToken = PreAuthenticatedAuthenticationToken(principal, "", authorities)

    val accessToken = tokenProvider.createAccessToken(authenticationToken)
    val refreshToken = tokenProvider.createRefreshToken(authenticationToken)

    return TokenInfo(accessToken = accessToken, refreshToken = refreshToken)
}

💡 이미 회원 가입 여부가 인증된 사용자의 authentication을 발급하는 과정이기 때문에,
일반 로그인 과정 중 하나인 `authenticate()` 로직을 진행할 필요가 없음

• `authenticationToken` : 이미 인증된 사용자의 정보이므로 PreAuthenticatedAuthenticationToken 을 생성

서비스 전체 코드

@Service
class SocialAuthService(
    private val memberRepository: MemberRepository,
    private val passwordEncoder: PasswordEncoder,
    private val tokenProvider: TokenProvider,
    private val socialClient: SocialClient
) {
    fun signInWithSocial(token: String, type: String): TokenInfo {
        val socialType = SocialType.from(type)
        val socialUser = getSocialUserFromType(token, socialType)

        val member = memberRepository.findByEmailAndSocialType(socialUser.email, socialType) ?: signUpWithSocial(
            socialUser, socialType
        )

        return createTokenWithMember(member)
    }

    private fun getSocialUserFromType(token: String, type: SocialType): SocialUser {
        return when (type) {
            SocialType.KAKAO -> {
                socialClient.getKakaoUser(token).run {
                    if (kakaoAccount == null) throw AuthenticationCredentialsNotFoundException("kakao 계정이 존재하지 않습니다.")
                    else SocialUser(
                        email = kakaoAccount.email, name = kakaoAccount.name
                    )
                }
            }
        }
    }

    private fun signUpWithSocial(socialUser: SocialUser, socialType: SocialType): Member {
        memberRepository.findByEmail(socialUser.email)?.let {
            throw DuplicateKeyException("Already Exists")
        }

        val member = Member(
            email = socialUser.email, password = passwordEncoder.encode(
                listOf(
                    socialType, socialUser.email, socialUser.name
                ).joinToString("")
            ), name = socialUser.name, socialType = socialType
        )
        memberRepository.save(member)

        return member
    }

    private fun createTokenWithMember(member: Member): TokenInfo {
        val authorities = listOf(SimpleGrantedAuthority("ROLE_${member.type}"))
        val principal = CustomUser(UUID.fromString(member.id.toString()), member.email, member.password, authorities)

        val authenticationToken = PreAuthenticatedAuthenticationToken(principal, "", authorities)

        val accessToken = tokenProvider.createAccessToken(authenticationToken)
        val refreshToken = tokenProvider.createRefreshToken(authenticationToken)

        return TokenInfo(accessToken = accessToken, refreshToken = refreshToken)
    }

Social Client

@Component
class SocialClient(
    private val webClient: WebClient
) {
    // <https://developers.kakao.com/docs/latest/ko/kakaologin/rest-api#req-user-info>
    fun getKakaoUser(token: String): KakaoSocialUser = runBlocking {
        webClient.post().apply {
            uri("<https://kapi.kakao.com/v2/user/me>")
            headers {
                it.set("Authorization", "Bearer ${token}")
            }
            bodyValue("property_keys=[\\"kakao_account.name\\", \\"kakao_account.email\\"]")
        }.retrieve().awaitBody()
    }
}

• 카카오 유저 정보 조회 API (주소)
  • 클라이언트로부터 받은 토큰을 Header에 저장
  • bodyValue : 필요한 property 설정하여 응답으로 받을 수 있음 (가이드)
• `runBlocking`
  • `awaitBody`는 coroutine 일시 중단 함수로 코루틴 영역에서만 실행 가능
  • 다만, 현 프로젝트에서는 `suspend fun`(일시 중단 함수)를 사용하지 않는 구조이기 때문에
    `coroutineScope`을 열어주기 위한 `runBlocking`을 사용

---

결과

• 이렇게 가입된 SNS 유저는 해당 SNS 로그인을 통해서만 회원 로그인 가능
• 유저가 Email 및 Password(임의로 만든 pw를 정확히) 입력하여 로그인 시도할 경우에도 로그인 불가

개선 Task

• 기존 회원과 SNS 회원을 연동 → 여러 경로로 로그인을 할 수 있도록 지원

---

✔️코드는 아래에서✔️

https://github.com/jeongum/spring-security-kotlin

GitHub - jeongum/spring-security-kotlin