[싹틔움] 10/31 개발일지 싹틔움 프로젝트 Oauth2.0 적용 ( Kakao, Google, NAVER )

📚 배경

 

기존에 위처럼 application.yml 파일에 kakao 소셜 로그인 설정을 해놨었는데,

 

google 소셜로그인도 구현하기 위해서 

 

//oauth2
implementation 'org.springframework.boot:spring-boot-starter-oauth2-client'

 

build.gradle 에 위와 같이 추가를 해준 후에 다시 돌리니까 각 종 에러들이 발생했다.

 

Error creating bean with name 'org.springframework.security.config.annotation.web.configuration.WebSecurityConfiguration'

Error creating bean with name 'org.springframework.security.config.annotation.web.configuration.HttpSecurityConfiguration'

Error creating bean with name 'OAuth2AuthorizedClientManager'

Failed to instantiate [org.springframework.security.oauth2.client.OAuth2AuthorizedClientManager]: Factory method 'getAuthorizedClientManager' threw exception with message

Provider ID must be specified for client registration 'kakao'

🌱 개요

1. 사용하지 않는 경우: 직접 구현

• 직접 API 호출: RestTemplate이나 WebClient로 Kakao의 로그인 API에 요청을 보내고, 응답으로 받은 access token을 사용해 사용자 정보를 가져오는 방식.
• 수동으로 처리: 요청과 응답을 직접 다루고, 로그인 후 사용자 정보와 인증 처리도 모두 수동으로 구현했을 가능성이 큼.

기본적으로 모든 흐름을 스스로 컨트롤할 수 있는 장점이 있지만, 매번 새로운 소셜 로그인을 추가할 때 같은 과정을 반복해야 해서 번거로울 수 있음.

2. 사용했을 때의 이점: 자동화와 간편함

• 자동 리다이렉트: 로그인 버튼을 누르면 Spring이 자동으로 Kakao의 로그인 페이지로 리다이렉트하고, 사용자가 로그인 후 다시 애플리케이션으로 돌아오도록 설정할 수 있음요.
• 토큰 및 사용자 정보 자동 관리: Spring이 Kakao의 access token과 사용자 정보를 자동으로 가져오고 관리해 주기 때문에, 로그인 후 추가적인 처리가 거의 필요 없음.
• 다른 소셜 로그인과 확장성: Kakao 외에 다른 소셜 로그인을 추가할 때도 설정만 하면 되고, 코드를 거의 수정할 필요가 없음.

즉, spring-boot-starter-oauth2-client를 사용하면 코드가 단순해지고 반복되는 부분을 줄일 수 있어서 확장성과 유지보수 측면에서도 더 편리함.

---

결론

위의 라이브러리를 사용하냐 안 하냐는 내가 상황에 맞게 선택하는 것이고, 기존에 kakao 소셜 로그인 하나만 구현되어있었기 때문에 직접 환경을 구현했던 것이다. 

 

하지만 구글과 네이버까지 소셜로그인을 구현하려는 지금은 해당 라이브러리를 사용하는 것이 더 좋아보였다.

---

🌱 사용법

  security:
    oauth2:
      client:
        registration:
          kakao:
            client-id: ${KAKAO_CLIENT_ID}
            redirect-uri: "http://localhost:8080/ssaktium/signin/kakao"
            authorization-grant-type: authorization_code
            scope: profile_nickname, account_email, birthyear
          google:
            client-id: ${GOOGLE_CLIENT_ID}
            client-secret: ${GOOGLE_CLIENT_SECRET}
            redirect-uri: "http://localhost:8080/ssaktium/signin/google"
            authorization-grant-type: authorization_code
            scope: email, profile, https://www.googleapis.com/auth/user.birthday.read
          naver:
            client-id: ${NAVER_CLIENT_ID}
            client-secret: ${NAVER_CLIENT_SECRET}
            redirect-uri: "http://localhost:8080/ssaktium/signin-naver"
            authorization-grant-type: authorization_code
            scope: name, email, birthyear

        provider:
          kakao:
            authorization-uri: https://kauth.kakao.com/oauth/authorize
            token-uri: https://kauth.kakao.com/oauth/token
            user-info-uri: https://kapi.kakao.com/v2/user/me
            user-name-attribute: id
          google:
            authorization-uri: https://accounts.google.com/o/oauth2/auth
            token-uri: https://oauth2.googleapis.com/token
            user-info-uri: https://www.googleapis.com/oauth2/v3/userinfo
            user-name-attribute: sub
          naver:
            authorization-uri: https://nid.naver.com/oauth2.0/authorize
            token-uri: https://nid.naver.com/oauth2.0/token
            user-info-uri: https://openapi.naver.com/v1/nid/me
            user-name-attribute: response.id

 

해당 라이브러리를 사용하기 위해서는 위처럼 양식을 맞춰서 작성해야한다.

 

Authorization Code Grant Type (승인 코드 방식)

 

OAuth2에는 여러 승인 방식이 있는데, Authorization Code 방식은 가장 일반적인 방식으로, 보안이 강화된 인증 플로우다. 이 방식은 클라이언트 애플리케이션(예: 당신의 웹 애플리케이션)이 외부 인증 제공자(예: Kakao, Google)를 통해 사용자로부터 승인 코드(Authorization Code)를 받아, 이 코드를 통해 액세스 토큰을 얻어오는 구조.

 

---

CustomOauthController

// 소셜로그인
@GetMapping("/ssaktium/signin/{provider}")
public String socialLogin(
        @PathVariable("provider") String provider,
        @RequestParam("code") String code, HttpServletResponse response) throws JsonProcessingException {

    String token = customOauthService.socialLogin(provider, code, response);
    Cookie cookie = new Cookie(JwtUtil.AUTHORIZATION_HEADER, token.substring(7));
    cookie.setPath("/");

 

provider Param 을 받아서 카카오, 네이버, 구글 로 소셜로그인을 진행 했을 때 하나의 컨트롤러에서 진행될 수 있도록 설정했다.

---

CustomOauthInfoDto

@Getter
@NoArgsConstructor
public class CustomOauthInfoDto {
    private String socialId;
    private String userName;
    private String email;
    private String birthYear;


    public CustomOauthInfoDto(String socialId, String userName, String email) {
        this.socialId = socialId;
        this.userName = userName;
        this.email = email;
    }

    public CustomOauthInfoDto(String socialId, String userName, String email, String birthYear) {
        this.socialId = socialId;
        this.userName = userName;
        this.email = email;
        this.birthYear = birthYear;
    }

    public static CustomOauthInfoDto addGoogleId(String socialId, String userName, String email) {
        return new CustomOauthInfoDto(socialId, userName, email);
    }
}

 

소셜로그인 시 제공받는 회원정보 데이터를 socialId, userName, email, birthYear 이 포함된 Dto 로 받아서 Service 에서 다루기 위해 Dto 를 만들어줬다.

---

CustomOauthService

// 소셜 로그인 서비스를 통해 인증을 수행하는 메서드
public String socialLogin(String provider, String code, HttpServletResponse response) throws JsonProcessingException {

    // 1. "인가 코드"로 "액세스 토큰" 요청
    String accessToken = getAccessToken(provider, code);

    // 2. 토큰으로 사용자 정보를 가져오기
    CustomOauthInfoDto UserInfo = fetchUserInfoFromProvider(accessToken, provider);

    // 3. 유저 생성
    User user = registerUserIfNeeded(UserInfo, response, provider);

    // 4. 토큰 발급
    String createToken = jwtUtil.createToken(user.getId(), user.getEmail(), user.getUserRole());

    log.info(createToken);

    // 5. 토큰 반환
    return createToken;
}

 

 

---

CustomOauthService

// AccessToken을 발급받기 위한 공통 메서드
private String getAccessToken(String provider, String code) {
    String redirectUri = "http://localhost:8080/ssaktium/signin/" + provider;
    String url;
    String clientId;
    String clientSecret = null;  // 필요한 경우에만 할당

    // provider 에 따른 URL, clientId, clientSecret 설정
    switch (provider) {
        case "kakao":
            url = "https://kauth.kakao.com/oauth/token";
            clientId = kakaoClientId;
            break;
        case "google":
            url = "https://oauth2.googleapis.com/token";
            clientId = googleClientId;
            clientSecret = googleClientSecret;
            break;
        case "naver":
            url = "https://nid.naver.com/oauth2.0/token";
            clientId = naverClientId;
            clientSecret = naverClientSecret;
            break;
        default:
            throw new NotFoundUserException();
    }

    HttpHeaders headers = new HttpHeaders();
    headers.setContentType(MediaType.APPLICATION_FORM_URLENCODED);

    // 파라미터 설정
    MultiValueMap<String, String> params = new LinkedMultiValueMap<>();
    params.add("grant_type", "authorization_code");
    params.add("client_id", clientId);
    params.add("redirect_uri", redirectUri);
    params.add("code", code);

    // clientSecret 이 존재하는 경우에만 추가
    if (clientSecret != null) {
        params.add("client_secret", clientSecret);
    }

    HttpEntity<MultiValueMap<String, String>> request = new HttpEntity<>(params, headers);
    Map responseBody = restTemplate.postForObject(url, request, Map.class);

    if (responseBody == null || !responseBody.containsKey("access_token")) {
        log.error("Failed to fetch access token from {} provider. Response: {}", provider, responseBody);
        throw new NotFoundUserException();
    }

    return (String) responseBody.get("access_token");
}

 

kakao, Google, Naver 로 부터 Access Token 을 발급 받기 위해 switch 문을 써서 각 각의 케이스에 맞게 Token 을 받아오는 로직을 짰다.

---

CustomOauthService

// 소셜 로그인한 사용자 정보로 로그인/회원가입을 처리하는 메서드
public User registerUserIfNeeded(CustomOauthInfoDto userInfo, HttpServletResponse response, String provider) {
    // 같은 이메일이 있는지 확인
    String changedEmail = userInfo.getEmail() + "_" + provider;
    User existingUser = userRepository.findByEmail(changedEmail).orElse(null);

    if (existingUser == null) {
        // 기존 사용자가 없는 경우 신규 사용자로 등록
        String password = UUID.randomUUID().toString();
        String encodedPassword = passwordEncoder.encode(password);
        String email = userInfo.getEmail() + "_" + provider;
        String birthYear = userInfo.getBirthYear();
        String socialAccountId = userInfo.getSocialId();

        existingUser = User.builder()
                .email(email)
                .userName(userInfo.getUserName())
                .password(encodedPassword)
                .birthYear(birthYear)
                .userRole(UserRole.ROLE_USER)
                .socialAccountId(socialAccountId)
                .build();

        userRepository.save(existingUser);

        // JWT 생성 및 헤더 추가
        addJwtToResponse(existingUser, response);

    }
    return existingUser;
}

 // JWT 토큰을 생성하고, 응답 헤더에 추가하는 메서드

private void addJwtToResponse(User user, HttpServletResponse response) {
    String createToken = jwtUtil.createToken(user.getId(), user.getEmail(), user.getUserRole());

    jwtUtil.addTokenToResponseHeader(createToken, response);
}

 

기존 유저가 있는지 검사하고 있다면 로그인, 없다면 새로 User 객체를 만들어서 DB 에 저장시키는 로직이고, 생성된 Jwt 토큰을 헤더에 추가하기 위해 addJwtToResponse 메서드도 추가해줬다.

---

CustomOauthService

// AccessToken 을 사용하여 소셜 제공자의 사용자 정보를 가져오는 메서드
private CustomOauthInfoDto fetchUserInfoFromProvider(String accessToken, String provider) throws JsonProcessingException {
    return switch (provider) {
        case "kakao" -> fetchKakaoUserInfo(accessToken);
        case "google" -> fetchGoogleUserInfo(accessToken);
        case "naver" -> fetchNaverUserInfo(accessToken);
        default -> throw new NotFoundUserException();
    };
}

 

발급된 Access Token 을 각 플랫폼에 맞게 메서드로 유도시킨다.

---

CustomOauthService

//카카오 사용자 정보를 가져오는 메서드
private CustomOauthInfoDto fetchKakaoUserInfo(String accessToken) throws JsonProcessingException {
    String url = "https://kapi.kakao.com/v2/user/me";

    HttpHeaders headers = new HttpHeaders();
    headers.setBearerAuth(accessToken);
    headers.setContentType(MediaType.APPLICATION_FORM_URLENCODED);

    HttpEntity<String> request = new HttpEntity<>(headers);
    String responseBody = restTemplate.exchange(url, HttpMethod.GET, request, String.class).getBody();

    if (responseBody == null) {
        log.error("Kakao API response body is null.");
        throw new NotFoundUserException();
    }

    JsonNode jsonNode = new ObjectMapper().readTree(responseBody);
    String socialId = jsonNode.get("id").asText();
    String email = jsonNode.get("kakao_account").get("email").asText();
    String birthYear = jsonNode.get("kakao_account")
            .get("birthyear").asText();
    String userName = jsonNode.get("properties").get("nickname").asText();

    log.info("카카오 사용자 정보: " + socialId + ", " + userName + ", " + birthYear + ", " + email);
    return new CustomOauthInfoDto(socialId, userName, email, birthYear);
}

//구글 사용자 정보를 가져오는 메서드
private CustomOauthInfoDto fetchGoogleUserInfo(String accessToken) throws JsonProcessingException {
    String url = "https://www.googleapis.com/oauth2/v3/userinfo";

    HttpHeaders headers = new HttpHeaders();
    headers.setBearerAuth(accessToken);

    HttpEntity<String> request = new HttpEntity<>(headers);
    String responseBody = restTemplate.exchange(url, HttpMethod.GET, request, String.class).getBody();

    if (responseBody == null) {
        log.error("Google API response body is null.");
        throw new NotFoundUserException();
    }

    JsonNode jsonNode = new ObjectMapper().readTree(responseBody);
    log.info(responseBody);
    String socialId = jsonNode.has("sub") ? jsonNode.get("sub").asText() : null;
    String name = jsonNode.has("name") ? jsonNode.get("name").asText() : null; // null 체크
    String email = jsonNode.has("email") ? jsonNode.get("email").asText() : null; // null 체크

    return CustomOauthInfoDto.addGoogleId(socialId, name, email);
}

// 네이버 사용자 정보를 가져오는 메서드
private CustomOauthInfoDto fetchNaverUserInfo(String accessToken) throws JsonProcessingException {
    String url = "https://openapi.naver.com/v1/nid/me";

    HttpHeaders headers = new HttpHeaders();
    headers.setBearerAuth(accessToken);
    headers.setContentType(MediaType.APPLICATION_FORM_URLENCODED);

    HttpEntity<String> request = new HttpEntity<>(headers);
    String responseBody = restTemplate.exchange(url, HttpMethod.GET, request, String.class).getBody();

    if (responseBody == null) {
        log.error("Naver API response body is null.");
        throw new NotFoundUserException();
    }

    JsonNode jsonNode = new ObjectMapper().readTree(responseBody);
    JsonNode responseNode = jsonNode.get("response");
    String socialId = responseNode.has("id") ? responseNode.get("id").asText() : null; // null 체크
    String email = responseNode.has("email") ? responseNode.get("email").asText() : null; // null 체크
    String userName = responseNode.has("name") ? responseNode.get("name").asText() : null; // null 체크
    String birthyear = responseNode.has("birthyear") ? responseNode.get("birthyear").asText() : null; // null 체크

    log.info("네이버 사용자 정보: " + ", " + userName + ", " + birthyear + ", " + email);
    return new CustomOauthInfoDto(socialId, userName, email, birthyear);
}

 

각 플랫폼마다 데이터가 전달되는 양식이 다르기 때문에 각 플랫폼에 맞는 방식으로 각 각 Dto 로 변환하기 위한 메서드를 만들어줬다.

---

전체 코드

@Service
@RequiredArgsConstructor
@Slf4j
public class CustomOauthService {
    private final UserRepository userRepository;
    private final JwtUtil jwtUtil;
    private final RestTemplate restTemplate;
    private final PasswordEncoder passwordEncoder;

    @Value("${spring.security.oauth2.client.registration.kakao.client-id}")
    private String kakaoClientId;

    @Value("${spring.security.oauth2.client.registration.google.client-id}")
    private String googleClientId;

    @Value("${spring.security.oauth2.client.registration.google.client-secret}")
    private String googleClientSecret;

    @Value("${spring.security.oauth2.client.registration.naver.client-id}")
    private String naverClientId;

    @Value("${spring.security.oauth2.client.registration.naver.client-secret}")
    private String naverClientSecret;


    // 소셜 로그인 서비스를 통해 인증을 수행하는 메서드
    public String socialLogin(String provider, String code, HttpServletResponse response) throws JsonProcessingException {

        // 1. "인가 코드"로 "액세스 토큰" 요청
        String accessToken = getAccessToken(provider, code);

        // 2. 토큰으로 사용자 정보를 가져오기
        CustomOauthInfoDto UserInfo = fetchUserInfoFromProvider(accessToken, provider);

        // 3. 유저 생성
        User user = registerUserIfNeeded(UserInfo, response, provider);

        // 4. 토큰 발급
        String createToken = jwtUtil.createToken(user.getId(), user.getEmail(), user.getUserRole());

        log.info(createToken);

        // 5. 토큰 반환
        return createToken;
    }


    // AccessToken을 발급받기 위한 공통 메서드
    private String getAccessToken(String provider, String code) {
        String redirectUri = "http://localhost:8080/ssaktium/signin/" + provider;
        String url;
        String clientId;
        String clientSecret = null;  // 필요한 경우에만 할당

        // provider 에 따른 URL, clientId, clientSecret 설정
        switch (provider) {
            case "kakao":
                url = "https://kauth.kakao.com/oauth/token";
                clientId = kakaoClientId;
                break;
            case "google":
                url = "https://oauth2.googleapis.com/token";
                clientId = googleClientId;
                clientSecret = googleClientSecret;
                break;
            case "naver":
                url = "https://nid.naver.com/oauth2.0/token";
                clientId = naverClientId;
                clientSecret = naverClientSecret;
                break;
            default:
                throw new NotFoundUserException();
        }

        HttpHeaders headers = new HttpHeaders();
        headers.setContentType(MediaType.APPLICATION_FORM_URLENCODED);

        // 파라미터 설정
        MultiValueMap<String, String> params = new LinkedMultiValueMap<>();
        params.add("grant_type", "authorization_code");
        params.add("client_id", clientId);
        params.add("redirect_uri", redirectUri);
        params.add("code", code);

        // clientSecret 이 존재하는 경우에만 추가
        if (clientSecret != null) {
            params.add("client_secret", clientSecret);
        }

        HttpEntity<MultiValueMap<String, String>> request = new HttpEntity<>(params, headers);
        Map responseBody = restTemplate.postForObject(url, request, Map.class);

        if (responseBody == null || !responseBody.containsKey("access_token")) {
            log.error("Failed to fetch access token from {} provider. Response: {}", provider, responseBody);
            throw new NotFoundUserException();
        }

        return (String) responseBody.get("access_token");
    }


    // 소셜 로그인한 사용자 정보로 로그인/회원가입을 처리하는 메서드
    public User registerUserIfNeeded(CustomOauthInfoDto userInfo, HttpServletResponse response, String provider) {
        // 같은 이메일이 있는지 확인
        String changedEmail = userInfo.getEmail() + "_" + provider;
        User existingUser = userRepository.findByEmail(changedEmail).orElse(null);

        if (existingUser == null) {
            // 기존 사용자가 없는 경우 신규 사용자로 등록
            String password = UUID.randomUUID().toString();
            String encodedPassword = passwordEncoder.encode(password);
            String email = userInfo.getEmail() + "_" + provider;
            String birthYear = userInfo.getBirthYear();
            String socialAccountId = userInfo.getSocialId();

            existingUser = User.builder()
                    .email(email)
                    .userName(userInfo.getUserName())
                    .password(encodedPassword)
                    .birthYear(birthYear)
                    .userRole(UserRole.ROLE_USER)
                    .socialAccountId(socialAccountId)
                    .build();

            userRepository.save(existingUser);

            // JWT 생성 및 헤더 추가
            addJwtToResponse(existingUser, response);

        }
        return existingUser;
    }


     // JWT 토큰을 생성하고, 응답 헤더에 추가하는 메서드

    private void addJwtToResponse(User user, HttpServletResponse response) {
        String createToken = jwtUtil.createToken(user.getId(), user.getEmail(), user.getUserRole());

        jwtUtil.addTokenToResponseHeader(createToken, response);
    }


    // AccessToken 을 사용하여 소셜 제공자의 사용자 정보를 가져오는 메서드
    private CustomOauthInfoDto fetchUserInfoFromProvider(String accessToken, String provider) throws JsonProcessingException {
        return switch (provider) {
            case "kakao" -> fetchKakaoUserInfo(accessToken);
            case "google" -> fetchGoogleUserInfo(accessToken);
            case "naver" -> fetchNaverUserInfo(accessToken);
            default -> throw new NotFoundUserException();
        };
    }


    //카카오 사용자 정보를 가져오는 메서드
    private CustomOauthInfoDto fetchKakaoUserInfo(String accessToken) throws JsonProcessingException {
        String url = "https://kapi.kakao.com/v2/user/me";

        HttpHeaders headers = new HttpHeaders();
        headers.setBearerAuth(accessToken);
        headers.setContentType(MediaType.APPLICATION_FORM_URLENCODED);

        HttpEntity<String> request = new HttpEntity<>(headers);
        String responseBody = restTemplate.exchange(url, HttpMethod.GET, request, String.class).getBody();

        if (responseBody == null) {
            log.error("Kakao API response body is null.");
            throw new NotFoundUserException();
        }

        JsonNode jsonNode = new ObjectMapper().readTree(responseBody);
        String socialId = jsonNode.get("id").asText();
        String email = jsonNode.get("kakao_account").get("email").asText();
        String birthYear = jsonNode.get("kakao_account")
                .get("birthyear").asText();
        String userName = jsonNode.get("properties").get("nickname").asText();

        log.info("카카오 사용자 정보: " + socialId + ", " + userName + ", " + birthYear + ", " + email);
        return new CustomOauthInfoDto(socialId, userName, email, birthYear);
    }

    //구글 사용자 정보를 가져오는 메서드
    private CustomOauthInfoDto fetchGoogleUserInfo(String accessToken) throws JsonProcessingException {
        String url = "https://www.googleapis.com/oauth2/v3/userinfo";

        HttpHeaders headers = new HttpHeaders();
        headers.setBearerAuth(accessToken);

        HttpEntity<String> request = new HttpEntity<>(headers);
        String responseBody = restTemplate.exchange(url, HttpMethod.GET, request, String.class).getBody();

        if (responseBody == null) {
            log.error("Google API response body is null.");
            throw new NotFoundUserException();
        }

        JsonNode jsonNode = new ObjectMapper().readTree(responseBody);
        log.info(responseBody);
        String socialId = jsonNode.has("sub") ? jsonNode.get("sub").asText() : null;
        String name = jsonNode.has("name") ? jsonNode.get("name").asText() : null; // null 체크
        String email = jsonNode.has("email") ? jsonNode.get("email").asText() : null; // null 체크

        return CustomOauthInfoDto.addGoogleId(socialId, name, email);
    }

    // 네이버 사용자 정보를 가져오는 메서드
    private CustomOauthInfoDto fetchNaverUserInfo(String accessToken) throws JsonProcessingException {
        String url = "https://openapi.naver.com/v1/nid/me";

        HttpHeaders headers = new HttpHeaders();
        headers.setBearerAuth(accessToken);
        headers.setContentType(MediaType.APPLICATION_FORM_URLENCODED);

        HttpEntity<String> request = new HttpEntity<>(headers);
        String responseBody = restTemplate.exchange(url, HttpMethod.GET, request, String.class).getBody();

        if (responseBody == null) {
            log.error("Naver API response body is null.");
            throw new NotFoundUserException();
        }

        JsonNode jsonNode = new ObjectMapper().readTree(responseBody);
        JsonNode responseNode = jsonNode.get("response");
        String socialId = responseNode.has("id") ? responseNode.get("id").asText() : null; // null 체크
        String email = responseNode.has("email") ? responseNode.get("email").asText() : null; // null 체크
        String userName = responseNode.has("name") ? responseNode.get("name").asText() : null; // null 체크
        String birthyear = responseNode.has("birthyear") ? responseNode.get("birthyear").asText() : null; // null 체크

        log.info("네이버 사용자 정보: " + ", " + userName + ", " + birthyear + ", " + email);
        return new CustomOauthInfoDto(socialId, userName, email, birthyear);
    }
}