Spring Boot에서 구글 소셜 로그인 REST 방식으로 구현하기

🌟Goal : Spring boot에서 구글 소셜 로그인의 백엔드 처리 프로세스를 REST API 방식으로 구현한다.

 

1. 구글 OAuth API 프로젝트 환경 구성

⬇️ 구글 API를 사용하기 위해서는 우선 하단의 사이트에서 일련의 구성및 허가 과정을 거쳐야 한다.

https://console.cloud.google.com/apis/dashboard 

Google Cloud Platform

 

1) 우선 사용자에게 보여질 Oauth 동의 화면을 구성한다.

 

2) 구글의 어떤 사용자 데이터까지 접근할 것인지 범위를 지정한다.

3) 테스트 사용자 추가는 우선 생략하고, 완료하면 사용자 Oauth 동의 화면이 구성된다.

 

 

4) OAuth api에 액세스하기 위해 사용자 인증 정보를 발급해야 한다.

• 여기서 중요한 것은 승인된 리디렉션 URI인데, 구글 로그인이 끝나고 난 뒤에 해당 api로 리디렉션되어 액세스 토큰 등을 처리하므로 path를 확인하여 잘 지정해둬야 한다.

5) 해당 과정을 거치면 사용자 인증 정보가 발급된다. 추후에 사용해야 하므로 잘 확인해두자.

 

 

2. REST API 구현

• SNS 소셜 로그인 프로세스
  • 로그인 최초 요청 처리 (”/app/accounts/auth/{SocialLoginType}”)
    • 첫번째로 사용자가 웹사이트의 로그인 화면에서 특정한 소셜 로그인 버튼을 클릭하게 되는데, 먼저 이 요청을 처리해야 한다.
    • 이 요청은 정해진 형식으로 URL을 갖춰( 각 api 각 소셜 로그인 페이지로 리다이렉트해줌으로써 처리한다.
  • 소셜 로그인 페이지에서 로그인한 이후 승인된 리디렉션 URI로 리다이렉트된다.(”/app/accounts/auth/{SocialLoginType}/callback”)
    • 이때 해당 API 서버로부터 1회용 access code를 받게 되는데, 이 코드를 이용해 api 서버로부터 access token과 refresh token을 받게 된다.
  • 이 access token을 이용해서 인가 처리를 실행하며, 소셜 서버로부터 사용자의 추가 정보를 요청할때도 이 access token을 사용하여 정보를 받아올 수 있다.
• 소셜 로그인을 구현하기 위해서는 해당 서드파티와 반드시 정해진 형식에 맞춰서 response/request를 진행해야 한다. 
  • 나같은 경우는 REST API를 구현할 예정이므로 HTTP/REST 규약 부분을 참고해서 개발하였다.

⬇️ 하단 사이트를 반드시 참고하면서 구현할 것.

https://developers.google.com/identity/protocols/oauth2/web-server#libraries

웹 서버 애플리케이션에 OAuth 2.0 사용  |  Google ID 플랫폼  |  Google Developers

 

1) 로그인 최초 요청 처리

  1. 소셜 로그인 타입을 구별하기 위해서 enum 형식을 constant로 만들어준다.

package com.example.demo.config;

public class Constant {
    public enum SocialLoginType{
        GOOGLE,
        KAKAO,
        NAVER
    }
}

 

2. 각 소셜 로그인 클래스가 상속받아 사용할 수 있도록 interface를 하나 생성한다.

package com.example.demo.src.account.social;

public interface SocialOauth {
    /**
     * 각 소셜 로그인 페이지로 redirect할 URL build
     * 사용자로부터 로그인 요청을 받아 소셜 로그인 서버 인증용 코드 요청
     */
    String getOauthRedirectURL();
}

 

3. 소셜 로그인 타입별 클래스를 생성한다.

• 오늘은 구글 로그인을 구현할 예정이므로 구글 클래스만 생성해두도록 하겠다.
• 차후에 다양한 로그인을 구현할 수 있으므로 인터페이스를 만들고 세부 클래스를 구현하는게 유지보수에 좋다.

@Component
@RequiredArgsConstructor
public class GoogleOauth implements SocialOauth {
@Override
    public String getOauthRedirectURL(){
    return "";}
    }

 

4. 로그인 방식에 따라서 해당 클래스를 호출해줄 Service class를 하나 생성한다.

@Service
@RequiredArgsConstructor
public class OAuthService {
    private final GoogleOauth googleOauth;
    private final HttpServletResponse response;

    public void request(Constant.SocialLoginType socialLoginType) throws IOException {
        String redirectURL;
        switch (socialLoginType){
            case GOOGLE:{
                //각 소셜 로그인을 요청하면 소셜로그인 페이지로 리다이렉트 해주는 프로세스이다.
                redirectURL= googleOauth.getOauthRedirectURL();
            }break;
            default:{
                throw new IllegalArgumentException("알 수 없는 소셜 로그인 형식입니다.");
            }

        }

        response.sendRedirect(redirectURL);
    }
}

 

5. 로그인을 주관하는 컨트롤러 클래스(AccountController)에서 소셜 로그인 페이지로 리다이렉트 해줄 API를 구현한다. 

• path로 어떤 값이 들어오느냐에 따라서 이제 service 객체에서 switch문으로 다르게 처리할 것이다.
• localhost:9000/app/acoounts/auth/google로 요청이 들어온다면, googleOauth를 호출하게 될 것이다.

 /**
     * 유저 소셜 로그인으로 리다이렉트 해주는 url
      * [GET] /accounts/auth
     * @return void
     */
    @NoAuth
    @GetMapping("/auth/{socialLoginType}") //GOOGLE이 들어올 것이다.
    public void socialLoginRedirect(@PathVariable(name="socialLoginType") String SocialLoginPath) throws IOException {
             SocialLoginType socialLoginType= SocialLoginType.valueOf(SocialLoginPath.toUpperCase());
             oAuthService.request(socialLoginType);
    }

 

6. GoogleOauth 클래스 상세구현

  1) resource 폴더에 존재하는 applications.yml 에 아까 발급받은 client id, client secret key등을 등록해준다. 이는 노출되면 안되므로 코드에 직접 추가하지 않고 yml 파일에서 불러와서 사용할 것이다.

2) 구글 api 문서를 확인하여 구글 소셜 로그인 페이지로 리디렉션 하려면 어떻게 URL을 구성해야 하는지 확인했다.

• 현재 response.redirect(URL); 함수를 사용하여 곧바로 redirect를 시키고 있으며 url을 controller로 다시 넘겨주기만 하면 로그인 페이지로 리디렉션할 수 있다.

 

3) URL을 구성하기 위해 GoogleOauth class에 코드를 추가했다.

@Component
@RequiredArgsConstructor
public class GoogleOauth implements SocialOauth {

    //applications.yml 에서 value annotation을 통해서 값을 받아온다.
    @Value("${spring.OAuth2.google.url}")
    private String GOOGLE_SNS_LOGIN_URL;

    @Value("${spring.OAuth2.google.client-id}")
    private String GOOGLE_SNS_CLIENT_ID;

    @Value("${spring.OAuth2.google.callback-url}")
    private String GOOGLE_SNS_CALLBACK_URL;

    @Value("${spring.OAuth2.google.client-secret}")
    private String GOOGLE_SNS_CLIENT_SECRET;

    @Value("${spring.OAuth2.google.scope}")
    private String GOOGLE_DATA_ACCESS_SCOPE;

    private final ObjectMapper objectMapper;
    @Override
    public String getOauthRedirectURL(){

        Map<String,Object> params=new HashMap<>();
        params.put("scope",GOOGLE_DATA_ACCESS_SCOPE);
        params.put("response_type","code");
        params.put("client_id",GOOGLE_SNS_CLIENT_ID);
        params.put("redirect_uri",GOOGLE_SNS_CALLBACK_URL);

        //parameter를 형식에 맞춰 구성해주는 함수
        String parameterString=params.entrySet().stream()
                .map(x->x.getKey()+"="+x.getValue())
                .collect(Collectors.joining("&"));
        String redirectURL=GOOGLE_SNS_LOGIN_URL+"?"+parameterString;
        System.out.println("redirectURL = " + redirectURL);

        return redirectURL;
        /*
        * https://accounts.google.com/o/oauth2/v2/auth?scope=profile&response_type=code
        * &client_id="할당받은 id"&redirect_uri="access token 처리")
        * 로 Redirect URL을 생성하는 로직을 구성
        * */
    }

• 이제 해당 메소드에서 url을 구성해 service로 넘겨주면 service->controller를 거쳐 해당 url을 통해서 소셜 로그인 페이지로 리다이렉트됨.

 

7. Postman으로 테스트

• localhost:9000/app/accounts/auth/google 로 request하면 일련의 과정을 거쳐 소셜 로그인 페이지가 렌더링되는 것을 확인할 수 있다.

 

• 구글에 미리 로그인되어 있는 크롬 환경에서 위의 url로 접속해보았다.
• 곧바로 소셜 로그인 페이지로 리다이렉트되어 저장되어있는 프로필 페이지가 렌더링되는 것을 확인할 수 있었다.
• 프로필을 선택하고 나면 이전에 남은 로그인 처리를 진행할 redirect_uri로 지정했던 url로 리다이렉트된다.

이 code 파라미터가 우리가 추후에 사용할 일회성 코드이다.

 

2) 소셜 로그인 이후 요청 처리

1. 이전에 구글에 등록해뒀던 callback api를 controller에서 개발한다.

• 소셜 로그인과 관련된 서비스를 처리하는 oAuthService 으로 소셜 로그인 결과로 받아온 일회성 코드를 보내서 서드파티로부터 액세스 토큰을 받아오고, 그 액세스 토큰을 다시 보내 서드파티에 저장된 사용자 정보를 받아오는 일련의 과정을 거칠 것이다.
• 그 과정의 결과로 다시 서버에 정보를 요청할때 필요한 access_token, 우리 서버에서 회원 인가처리를 할 jwt_token, 그리고 추후에 조회등에 필요한 user_num등의 정보를 받아올 것이다.

  /**
     * Social Login API Server 요청에 의한 callback 을 처리
     * @param socialLoginPath (GOOGLE, FACEBOOK, NAVER, KAKAO)
     * @param code API Server 로부터 넘어오는 code
     * @return SNS Login 요청 결과로 받은 Json 형태의 java 객체 (access_token, jwt_token, user_num 등)
     */

   @NoAuth
    @ResponseBody
    @GetMapping(value = "/auth/{socialLoginType}/callback")
    public BaseResponse<GetSocialOAuthRes> callback (
            @PathVariable(name = "socialLoginType") String socialLoginPath,
            @RequestParam(name = "code") String code)throws IOException,BaseException{
        System.out.println(">> 소셜 로그인 API 서버로부터 받은 code :"+ code);
        SocialLoginType socialLoginType= SocialLoginType.valueOf(socialLoginPath.toUpperCase());
        GetSocialOAuthRes getSocialOAuthRes=oAuthService.oAuthLogin(socialLoginType,code);
        return new BaseResponse<>(getSocialOAuthRes);
    }

 

2. 우선 model을 모아둔 패키지에 서버와 통신하기 위한 여러 자바 클래스를 만든다.

//구글에 일회성 코드를 다시 보내 받아올 액세스 토큰을 포함한 JSON 문자열을 담을 클래스
@AllArgsConstructor
@Getter
@Setter
public class GoogleOAuthToken {
    private String access_token;
    private int expires_in;
    private String scope;
    private String token_type;
    private String id_token;
}

//구글(서드파티)로 액세스 토큰을 보내 받아올 구글에 등록된 사용자 정보
@AllArgsConstructor
@Getter
@Setter
public class GoogleUser {
    public String id;
    public String email;
    public Boolean verifiedEmail;
    public String name;
    public String givenName;
    public String familyName;
    public String picture;
    public String locale;
}

//클라이언트로 보낼 jwtToken, accessToken등이 담긴 객체
@Getter
@Setter
@AllArgsConstructor
public class GetSocialOAuthRes {

    private String jwtToken;
    private int user_num;
    private String accessToken;
    private String tokenType;
}

 

 

3. 이제 oAuthService 클래스에 전반적인 구글과의 통신 프로세스를 처리할 oAuthLogin 메소드를 만들어주도록 하겠다.

 public GetSocialOAuthRes oAuthLogin(Constant.SocialLoginType socialLoginType, String code) throws IOException {

        switch (socialLoginType){
            case GOOGLE:{
                //구글로 일회성 코드를 보내 액세스 토큰이 담긴 응답객체를 받아옴
                ResponseEntity<String> accessTokenResponse= googleOauth.requestAccessToken(code);
               //응답 객체가 JSON형식으로 되어 있으므로, 이를 deserialization해서 자바 객체에 담을 것이다.
               GoogleOAuthToken oAuthToken=googleOauth.getAccessToken(accessTokenResponse);
               
               //액세스 토큰을 다시 구글로 보내 구글에 저장된 사용자 정보가 담긴 응답 객체를 받아온다.
                ResponseEntity<String> userInfoResponse=googleOauth.requestUserInfo(oAuthToken);
                //다시 JSON 형식의 응답 객체를 자바 객체로 역직렬화한다.
                GoogleUser googleUser= googleOauth.getUserInfo(userInfoResponse);

                }

            }
            default:{
                throw new IllegalArgumentException("알 수 없는 소셜 로그인 형식입니다.");
            }

        }

 

4. 구글과 통신하기 위한 여러 메소드를 GoogleOAuth 클래스에 개발한다.

 1) 먼저 일회용 코드를 다시 구글로 보내 액세스 토큰을 포함한 JSON String이 담긴 ResponseEntity를 받아온다.

   - 액세스 토큰을 받아오기 위해 필요한 파라미터들은 구글 공식 문서에서 확인할 수 있다.

public ResponseEntity<String> requestAccessToken(String code) {
        String GOOGLE_TOKEN_REQUEST_URL="https://oauth2.googleapis.com/token";
        RestTemplate restTemplate=new RestTemplate();
        Map<String, Object> params = new HashMap<>();
        params.put("code", code);
        params.put("client_id", GOOGLE_SNS_CLIENT_ID);
        params.put("client_secret", GOOGLE_SNS_CLIENT_SECRET);
        params.put("redirect_uri", GOOGLE_SNS_CALLBACK_URL);
        params.put("grant_type", "authorization_code");

        ResponseEntity<String> responseEntity=restTemplate.postForEntity(GOOGLE_TOKEN_REQUEST_URL,
                params,String.class);

        if(responseEntity.getStatusCode()== HttpStatus.OK){
            return responseEntity;
        }
        return null;
    }

+) RestTemplate

• Spring boot에서는 다른 서버의 API endpoint를 호출할 때 RestTemplate를 많이 쓴다.
• HTTP 서버와의 통신을 단순화하고 RESTful 원칙을 지킨다.(json, xml을 쉽게 응답 받는다.

//우선 RestTemplate를 매번 새로 생성하기 보다 빈으로 만들어서 의존성을 주입받도록 한다.
@Configuration
public class RestTemplateConfig {
    //HTTP get,post 요청을 날릴때 일정한 형식에 맞춰주는 template
    @Bean
    public RestTemplate restTemplate(RestTemplateBuilder restTemplateBuilder) {
        return restTemplateBuilder
                .requestFactory(() -> new BufferingClientHttpRequestFactory(new SimpleClientHttpRequestFactory()))
                .additionalMessageConverters(new StringHttpMessageConverter(Charset.forName("UTF-8")))
                .build();
    }
}

//활용 예시
restTemplate.exchange(url, httpMethod, new HttpEntity<>(body, httpHeaders), class);
restTemplate.postForEntity(url, parameter,class);

responseEntity에 담긴 Body내용이다.

2) responseEntity에 담긴 JSON String을 역직렬화해 자바 객체에 담는다.

 public GoogleOAuthToken getAccessToken(ResponseEntity<String> response) throws JsonProcessingException {
        System.out.println("response.getBody() = " + response.getBody());
        GoogleOAuthToken googleOAuthToken= objectMapper.readValue(response.getBody(),GoogleOAuthToken.class);
        return googleOAuthToken;

    }

 

3) 다시 구글로 액세스 토큰을 보내 구글 사용자 정보를 받아온다.

• 역시 구글 api 문서를 참고해 request 형식을 올바르게 구성해야 한다.
• 이전에 계속 파라미터로 request를 보냈으니, 이번엔 헤더에 access token을 담는 방식으로 구현해 보았다.

 public ResponseEntity<String> requestUserInfo(GoogleOAuthToken oAuthToken) {
        String GOOGLE_USERINFO_REQUEST_URL="https://www.googleapis.com/oauth2/v1/userinfo";

	//header에 accessToken을 담는다.
        HttpHeaders headers = new HttpHeaders();
        headers.add("Authorization","Bearer "+oAuthToken.getAccess_token());
        
        //HttpEntity를 하나 생성해 헤더를 담아서 restTemplate으로 구글과 통신하게 된다.
        HttpEntity<MultiValueMap<String, String>> request = new HttpEntity(headers);
        ResponseEntity<String> response=restTemplate.exchange(GOOGLE_USERINFO_REQUEST_URL, HttpMethod.GET,request,String.class);
        System.out.println("response.getBody() = " + response.getBody());
        return response;
    }

access token을 보냈을 때 돌아오는 response 결과는 다음과 같다.

< 기본 개념 정리>

• HttpHeaders
  • Header에 원하는 방식으로 key-value값을 설정해서 보낼 수 있는 객체이다.
  • Spring.io의 설명은 다음과 같다.

 

• HTTPEntity<T>
  • HTTPEntity는 http 요청/응답에 해당하는 HTTPHeader와 HTTPBody를 포함하는 객체이다.
  • 따라서 HttpEntity를 생성할때 header를 생성자 파라미터로 추가할 수 있다.

public class HttpEntity<T> {
    public static final HttpEntity<?> EMPTY = new HttpEntity();
    private final HttpHeaders headers;
    private final T body;
    ...
}

 

• ResponseEntity
  • 일반적인 API는 반환하는 리소스에 Value만 있지 않으며, 상태 코드, 응답 메세지 등이 포함될 수 있다.
  • 따라서 ResponseEntity는 client가 보내는 여러가지 응답 내용을 규격에 맞게 한번 감싸주는 역할을 한다.
  • 같은 역할로는 @ResponseBody 어노테이션이 있다.
  • HttpEntity를 상속받고 있는 클래스이다.
•  MultiValueMap
  • MultiValueMap은 키 하나의 여러개의 value를 가지게 해주는 map이다. key-value 각각 하나씩이 쌍으로 이뤄지는 map과는 다르다.
  • 중요한 특징중에 하나는 RestTemplate의 exchange 메서드의 세번째 파라미터 request에는 Hashmap을 지원하지 않아 무조건 MultiValueMap을 사용해야 한다는 것이다.
  • HTTP Request시에 URL을 전송할 때 name="jennie"&name="lisa"&name="peter" 와 같이 같은 파라미터에 여러가지 값이 전송되는 사례가 있기 때문이다.

4) 마지막으로, 이 구글 유저 정보가 담긴 JSON 문자열을 파싱하여 GoogleUser 객체에 담아주면 된다.

  public GoogleUser getUserInfo(ResponseEntity<String> userInfoRes) throws JsonProcessingException{
        GoogleUser googleUser=objectMapper.readValue(userInfoRes.getBody(),GoogleUser.class);
        return googleUser;
    }

 

 

5. 이제 마지막으로 구글에서 받아온 유저 정보를 이용해 일련의 정보가 담긴 객체를 컨트롤러로 넘겨준다.

• 위에서 얻은 GoogleUser객체에 담긴 user_id를 추출한다.
• 해당 id를 우리 서버의 db와 검증하고, 회원 가입이 되어있으면 앞으로 인가 처리를 위해 jwtToken을 발급한다.
  • jwtToken을 발급하는 jwtService 개발은 이전 포스팅에서 확인할 수 있다.
  • 회원가입이 되어있지 않으면 클라이언트로 오류를 전송한다.
• 이제 클라이언트에게 보내줄 GetSocialOauthRest 객체를 구성하는데, 담긴 내용은 다음과 같다.
  • 회원 인가처리를 위한 jwtToken
  • 유저의 회원번호
  • 앞으로 구글과 통신할때 사용할 accessToken
  • Token의 타입 

public GetSocialOAuthRes oAuthLogin(Constant.SocialLoginType socialLoginType, String code) throws IOException {

        switch (socialLoginType){
            case GOOGLE:{
                //구글로 일회성 코드를 보내 액세스 토큰이 담긴 응답객체를 받아옴
                ResponseEntity<String> accessTokenResponse= googleOauth.requestAccessToken(code);
               //응답 객체가 JSON형식으로 되어 있으므로, 이를 deserialization해서 자바 객체에 담을 것이다.
               GoogleOAuthToken oAuthToken=googleOauth.getAccessToken(accessTokenResponse);
               
               //액세스 토큰을 다시 구글로 보내 구글에 저장된 사용자 정보가 담긴 응답 객체를 받아온다.
                ResponseEntity<String> userInfoResponse=googleOauth.requestUserInfo(oAuthToken);
                //다시 JSON 형식의 응답 객체를 자바 객체로 역직렬화한다.
                GoogleUser googleUser= googleOauth.getUserInfo(userInfoResponse);

                String user_id=googleUser.getEmail();
              
                //우리 서버의 db와 대조하여 해당 user가 존재하는 지 확인한다.
                int user_num=accountProvider.getUserNum(user_id);
                
                if(user_num!=0){
                //서버에 user가 존재하면 앞으로 회원 인가 처리를 위한 jwtToken을 발급한다.
                String jwtToken=jwtService.createJwt(user_num,user_id);
                //액세스 토큰과 jwtToken, 이외 정보들이 담긴 자바 객체를 다시 전송한다.
                GetSocialOAuthRes getSocialOAuthRes=new GetSocialOAuthRes(jwtToken,user_num,oAuthToken.getAccess_token(),oAuthToken.getToken_type());
                return getSocialOAuthRes;
                }
                else {
                    throw new BaseException(BaseResponseStatus.ACCOUNT_DOESNT_EXISTS);
                }

            }
            default:{
                throw new IllegalArgumentException("알 수 없는 소셜 로그인 형식입니다.");
            }

        }

 

 

3. 실제 소셜 로그인 프로세스

1. localhost:9000/app/accounts/auth/google 로 접근
2. 곧바로 소셜 로그인 페이지로 리다이렉트됨.

    3. 프로필 선택 (로그인) 이후에 미리 지정해둔 callback uri(미리 구글에 등록해야 함)로 리다이렉트되면서 구글에서 내 서버로 일회성 접근 코드 보냄

   4. 일회성 코드를 다시 서드파티로 보내 사용자의 정보를 요청할 수 있는 액세스 토큰을 response에 담아오도록 한다.

  5. 이 액세스 토큰을 다시 서드파티로 보내서 사용자의 정보를 받아온다.

 6. 받아온 구글 사용자의 정보를 내 db와 비교하여 JWT 토큰을 발급하고, 이를 포함해 액세스 토큰, 유저 회원 번호 등이 담긴 객체를 클라이언트에게 응답으로 보내준다.

 

 7.  응답 완료! JSON 형태로 잘 내용이 돌아오는 것을 확인 할 수 있다.

 

 

 

 

+) 생각보다 과정이 많아서 복잡했었지만 개발이 잘 완료되어서 기쁘다! 공식 문서를 잘 읽어보면서 개발하는게 필수적인 것 같고, 다음에는 Spring Security, JPA등을 도입해서 더 안전한 인증 프로세스가 되도록 리팩토링도 해보고 싶다!

 

🙏참고자료 

https://developers.google.com/identity/protocols/oauth2/web-server#libraries

웹 서버 애플리케이션에 OAuth 2.0 사용  |  Google ID 플랫폼  |  Google Developers

https://antdev.tistory.com/70?category=919963 

[Google Login API] 소셜 로그인 요청 Redirect 처리 (Spring Boot 레퍼런스를 보면서 구현해보는 구글 소셜

https://tecoble.techcourse.co.kr/post/2021-05-10-response-entity/

ResponseEntity - Spring Boot에서 Response를 만들자