카카오 로그인 API 구현 하기 (REST API 방식)

 

 카카오 로그인 API (OAuth 2.0)

 

 클라이언트 입장에서 수많은 사이트의 모든 아이디 비밀번호를 기억하기는 쉽지 않음

 

또한 서비스를 제공해주는 리소스 오너 또한 안전하게 보관하여야 하기 때문에 부담

 

이런 문제를 해결하기 위해, 카카오 로그인 연동 기능을 사용

 

 

카카오 API를 사용하여 로그인 기능을 구현하는 방법

 

1. 카카오 개발자 사이트에 가입하고 애플리케이션 등록하기

 

카카오 API를 사용하기 위해서는 먼저 카카오 개발자 사이트에 가입해야 합니다.

 

가입 후 애플리케이션을 등록하고, 해당 애플리케이션에서 사용할 기능과 키를 발급받아야 합니다.

 

 

내 애플리케이션 추가하기

 

 

Kakao Developers

 

 

2. SDK 다운로드 및 설정하기

 

카카오 API를 사용하기 위해서는 SDK를 다운로드하여 설정해야 합니다.

 

카카오 개발자 사이트에서 SDK를 다운로드 받고, 설정하는 방법을 확인할 수 있습니다.

 

카카오 REST API는 SDK를 다운로드하지 않아도 사용할 수 있습니다.

 

 

3. 카카오 로그인 기능 구현하기

 

SDK를 설정한 후, 카카오 로그인 기능을 구현할 수 있습니다.

 

이때, 로그인 버튼을 만들고 해당 버튼을 눌렀을 때 카카오 로그인 API를 호출하도록 구현하면 됩니다.

 

 

로그인 버튼 클릭

 

로그인 요청 주소(GET)

GET /oauth/authorize?client_id=${REST_API_KEY}&redirect_uri=${REDIRECT_URI}&response_type=code HTTP/1.1
Host: kauth.kakao.com

<a class="p-2" href="https://kauth.kakao.com/oauth/authorize?client_id=${REST_API_KEY}&redirect_uri=http://localhost:8080/auth/kakao/callback&response_type=code">
    <img th:src="@{/img/kakao_login_medium.jpg}" style="height:60px"/> </a>

 

카카오 로그인 동의 화면을 호출하고, 사용자 동의를 거쳐 인가 코드를 발급합니다.

 

 

 

카카오 로그인 동의 화면

 

Redirect URI : 카카오 로그인을 성공한 뒤에 응답받을 주소를 설정한다.

 

카카오에서 사용자 정보들을 Redirect URI에 전달한다. 

 

 

Response 인가 코드 획득

 

서비스 서버는 redirect_uri로 HTTP 302 리다이렉트된 요청의 Location에서 인가 코드 또는 에러를 확인할 수 있다. 

 

인가 코드는 동의 화면을 통해 인가받은 동의 항목 정보를 갖고 있으며, 인가 코드를 사용해 토큰 받기를 요청할 수 있습니다.

 

 

 

 

4. 로그인 성공 시 사용자 정보 받아오기

 

인가 코드로 토큰 발급을 요청합니다.

 

인가 코드 받기만으로는 카카오 로그인이 완료되지 않으며, 토큰 받기까지 마쳐야 카카오 로그인을 정상적으로 완료할 수 있습니다.

 

카카오 로그인을 성공하면 사용자 정보를 받아올 수 있습니다.

 

이때, 사용자 정보를 받아오기 위해서는 액세스 토큰을 발급받아야 합니다.

 

액세스 토큰을 발급받은 후, 해당 토큰을 사용하여 사용자 정보를 호출할 수 있습니다.

 

 

 

토큰 발급 요청 주소(POST)

curl -v -X POST "https://kauth.kakao.com/oauth/token" \
 -H "Content-Type: application/x-www-form-urlencoded" \
 -d "grant_type=authorization_code" \
 -d "client_id=${REST_API_KEY}" \
 --data-urlencode "redirect_uri=${REDIRECT_URI}" \
 -d "code=${AUTHORIZE_CODE}"

 

필수 파라미터를 포함해 POST로 요청합니다. 

 

POST 방식 - 쿼리스트링(GET방식)이 아닌  http body 에 데이터를 전달 

 

 

//HttpHeader 오브젝트 생성
HttpHeaders headers = new HttpHeaders();
headers.add("Content-type","application/x-www-form-urlencoded;charset=utf-8");

Content-Type: application/x-www-form-urlencoded 

 

-->   http body 데이터가 key=value 형태의 데이터라고 헤더에 알려주는 것이다. 

 

 

Parameter

 

//HttpBody 오브젝트 생성
LinkedMultiValueMap<String, String> params = new LinkedMultiValueMap<>();
params.add("grant_type","authorization_code");
params.add("client_id","{REST_API_KEY}");
params.add("redirect_uri","http://localhost:8080/auth/kakao/callback");
params.add("code",code);

 

HTTP body 에 데이터를 담아서 전달해야 한다. (POST 방식) 

 

 

// HttpHeader와 HttpBody를 하나의 오브젝트에 담기
HttpEntity<MultiValueMap<String,String>> kakaoTokenRequest =
        new HttpEntity<>(params,headers);

 

RestTemplate.exchange() 메서드가 HttpEntity 를 갖기때문에 

 

HttpHeader와 HttpBody를 하나의 오브젝트에 담는다.

 

 

RestTemplate rt = new RestTemplate();

//Http POST 방식 요청 - response 변수 응답
ResponseEntity<String> response = rt.exchange(
        "https://kauth.kakao.com/oauth/token",   // 토큰 발급 요청 주소
        HttpMethod.POST,
        kakaoTokenRequest,
        String.class
);

 

 

RestTemplate.exchange() 메서드를 이용

 

요청 성공 시 응답은 토큰과 토큰 정보를 포함한다.

 

 

# 참고 : RestTemplate

RestTemplate은 Spring 프레임워크에서 제공하는 HTTP 클라이언트 라이브러리입니다.

 

RESTful 웹 서비스와 상호작용하기 위한 기능을 제공합니다.

 

RestTemplate을 사용하면 GET, POST, PUT, DELETE 등의 HTTP 메서드를 사용하여 웹 서비스와 통신할 수 있습니다.

 

또한 HTTP 요청 및 응답을 처리하기 위한 다양한 기능을 제공합니다.

 

예를 들어, 요청 헤더와 응답 헤더, 쿠키, JSON 및 XML 메시지의 변환 등이 있습니다.

 

 

exchange()

 

RestTemplate의 exchange() 메서드는 HTTP 요청을 보내고 그에 대한 HTTP 응답을 받는 기능을 제공합니다.

 

이 메서드는 HTTP 메서드, 요청 URL, 요청 헤더, 요청 본문 데이터 및 응답 데이터 타입 등의

 

매개변수를 받아서 HTTP 요청을 실행하고,

 

HTTP 응답을 받아서 지정된 데이터 타입으로 변환하여 반환합니다.

 

exchange() 메서드는 다양한 HTTP 메서드(GET, POST, PUT, DELETE 등)를 사용하여 요청을 보낼 수 있으며,

 

요청과 응답의 커스터마이징을 위한 매개변수를 지원합니다.

 

예를 들어, 다음과 같이 exchange() 메서드를 사용하여 GET 요청을 보내고 응답을 받을 수 있습니다.

 

RestTemplate restTemplate = new RestTemplate();
String url = "https://api.example.com/user/{userId}";
HttpHeaders headers = new HttpHeaders();
headers.set("Authorization", "Bearer " + accessToken);
HttpEntity<String> entity = new HttpEntity<>(headers);
ResponseEntity<User> response = restTemplate.exchange(url, HttpMethod.GET, entity, User.class, userId);
User user = response.getBody();

 

위 코드에서는 url 변수에 요청할 URL을 지정하고, headers 변수에 요청 헤더를 설정한 후 HttpEntity 객체를 생성합니다.

 

이 HttpEntity 객체는 요청 헤더와 요청 본문 데이터를 포함하는 역할을 합니다.

 

그리고 exchange() 메서드를 호출할 때, 요청 메서드(HttpMethod.GET), HttpEntity 객체, 응답 데이터 타입(User.class),

 

그리고 URL 변수(userId)를 전달합니다.

 

마지막으로, ResponseEntity 객체에서 응답 데이터를 가져와서 user 변수에 할당합니다.

 

 

 

Response 

Response : 토큰과 토큰 정보

 

{
    "token_type":"bearer",
    "access_token":"${ACCESS_TOKEN}",
    "expires_in":43199,
    "refresh_token":"${REFRESH_TOKEN}",
    "refresh_token_expires_in":25184000,
    "scope":"account_email profile"
}

 

Response : JSON 형식 데이터를 응답받음 

 

JSON 데이터를 Java에서 처리하기 위해서 오브젝트에 담는다. (라이브러리 이용 - Gson, Json Simple, ObjectMapper)

 

 

//Gson, Json Simple, ObjectMapper
ObjectMapper objectMapper = new ObjectMapper();
OAuthToken oAuthToken = null;

try {
    oAuthToken = objectMapper.readValue(response.getBody(), OAuthToken.class);
} catch (JsonProcessingException e) {
    throw new RuntimeException(e);
}

 

ObjectMapper 를 이용하여 JSON 데이터를 Java 객체에 매핑

 

 

# 참고 : ObjectMapper (JSON 파싱)

문자로 된 JSON 데이터를 Jackson 라이브러리인 objectMapper 를 사용해서 자바 객체로 변환한다.

 

JSON 파일을 Java 객체로 deserialization 하기 위해서는 ObjectMapper의 readValue() 메서드를 이용한다.

 

ObjectMapper

 

ObjectMapper를 이용하면 JSON을 Java 객체로 변환

 

반대로 Java 객체를 JSON 객체로 serialization 할 수 있다.

 

 

Java Object → JSON

 

Java 객체를 JSON으로 serialization 하기 위해서는 ObjectMapper의 writeValue() 메서드를 이용한다.

 

// Java Object ->  JSON
        Person person = new Person("zooneon", 25, "seoul");
        try {
            objectMapper.writeValue(new File("src/person.json"), person);
        } catch (IOException e) {
            e.printStackTrace();
        }

위와 같이 파라미터로 JSON을 저장할 파일과 직렬화시킬 객체를 넣어주면 된다.

 

JSON → Java Object

 

JSON 파일을 Java 객체로 deserialization 하기 위해서는 ObjectMapper의 readValue() 메서드를 이용한다.

 

// JSON -> Java Object
        String json = "{\"name\":\"zooneon\",\"age\":25,\"address\":\"seoul\"}";
        try {
            Person deserializedPerson = objectMapper.readValue(json, Person.class);
            System.out.println(deserializedPerson);
        } catch (JsonProcessingException e) {
            e.printStackTrace();
        }

위와 같이 파라미터로 JSON 형태의 문자열 or 객체와 역직렬화 시킬 클래스를 넣어주면 된다.

 

 

사용자 정보 가져오기

 

현재 로그인한 사용자의 정보를 불러옵니다.

 

GET/POST /v2/user/me HTTP/1.1
Host: kapi.kakao.com
Authorization: Bearer ${ACCESS_TOKEN}/KakaoAK ${APP_ADMIN_KEY}
Content-type: application/x-www-form-urlencoded;charset=utf-8

 

사용자 액세스 토큰을 헤더(Header)에 담아 GET 또는 POST로 요청합니다.

 

//HttpHeader 오브젝트 생성
HttpHeaders headers2 = new HttpHeaders();
headers2.add("Authorization"," Bearer "+oAuthToken.getAccess_token());
headers2.add("Content-type","application/x-www-form-urlencoded;charset=utf-8");

 

HttpHeader 를 생성후 액세스 토큰과 content-type을 담는다.

 

HttpEntity<MultiValueMap<String,String>> kakaoProfileRequest2 =
        new HttpEntity<>(headers2);

 

RestTemplate.exchange() 메서드가 HttpEntity 를 갖기때문에

 

HttpHeader를 HttpEntity에 담는다. 

 

//Http POST 방식 요청 - response 변수 응답
ResponseEntity<String> response2 = rt2.exchange(
        "https://kapi.kakao.com/v2/user/me",   // 사용자 정보 요청 주소
        HttpMethod.POST,
        kakaoProfileRequest2,
        String.class
);

RestTemplate.exchange() 메서드를 이용

 

사용자 정보 요청 성공 시, 응답 바디(Body)는 사용자 정보를 포함한 JSON 객체를 반환합니다.

 

 

요청 성공 : 사용자 정보를 포함한 JSON 객체

 

JSON 파일을 Java 클래스로 만들자  

 

 

https://www.jsonschema2pojo.org/

jsonschema2pojo

 

 

jsonschema2pojo

 

jsonschema2pojo는 JSON 스키마를 사용하여 자바 클래스를 생성하는 오픈소스 라이브러리입니다.

 

Property word delimiters 가 언더스코어(_)로 설정되어 있다면, 없애도록 하자 

 

 

ObjectMapper objectMapper2 = new ObjectMapper();
KakaoProfile kakaoProfile = null;
try {
    kakaoProfile = objectMapper2.readValue(response2.getBody(), KakaoProfile.class);
} catch (JsonProcessingException e) {
    throw new RuntimeException(e);
}

 

JSON 파일을 jsonschema2pojo 통해서 생성한 Java 클래스 객체로 deserialization 하기 위해서는

 

ObjectMapper의 readValue() 메서드를 이용한다.

 

 

System.out.println(" 사용자 이메일 = " + kakaoProfile.getKakao_account().getEmail());
System.out.println(" 사용자 이름 = " + kakaoProfile.getProperties().getNickname());

 

이제 객체를 통해서 사용자 정보를 얻어올 수 있다. 

 

출력

 

 

 

 

 

5. 로그아웃 기능 구현하기

 

마지막으로, 로그아웃 기능을 구현할 수 있습니다.

 

이때, 카카오 로그아웃 API를 호출하여 로그아웃할 수 있습니다.

 

토큰을 만료시켜 해당 사용자 정보로 더 이상 카카오 API를 호출할 수 없도록 하는 기능

 

카카오계정과 함께 로그아웃 기능은 카카오계정 로그아웃 처리 후

 

Logout Redirect URI로 302 리다이렉트(Redirect)하여 서비스 로그아웃까지 연속해서 수행할 수 있도록 구성돼 있습니다.

 

 

Logout Redirect URI 설정

 

 

href="https://kauth.kakao.com/oauth/logout?client_id=${REST_API_KEY}&logout_redirect_uri=http://localhost:8080/auth/kakao/logout">로그아웃</a>

 

 

 

로그아웃 버튼 클릭 시 카카오 로그아웃 API를 호출

 

 

 

로그아웃 성공 -> 메인 페이지

 

 

REST API를 사용한 카카오 로그인

 

카카오 REST API는 SDK를 다운로드하지 않아도 사용할 수 있습니다.

 

REST API는 웹 기술을 기반으로한 HTTP 프로토콜을 사용하여 서버와 클라이언트 간의 통신을 위한 인터페이스를 제공합니다.

 

따라서, 카카오 REST API를 사용하기 위해서는 HTTP 요청을 구성하고, 응답을 처리할 수 있는 능력이 필요합니다.

 

카카오 REST API는 HTTP 요청에 필요한 URL, HTTP 메소드, 파라미터 등을 제공하고, 응답은 JSON 형태로 제공됩니다.

 

이를 이용하여 사용자 정보 조회, 메시지 전송 등 다양한 기능을 구현할 수 있습니다.

 

 

REST API 를 사용한 카카오 로그인 과정