Java HTTP 통신

Java HTTP 통신에 대해서 알아보자

 

java.net 패키지내에 있는 HttpUrlConnection 클래스와 URL 클래스를 활용하여 HTTP 통신을  할 수 있다.

 

1. URL 클래스 

https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/net/URL.html

URL (Java SE 11 & JDK 11 )

 

URL 클래스는 자원을 요청할 주소를 나타내는 클래스이다. URL 클래스를 살펴보면 Serializable 인터페이스를 구현하고 있어, 직렬화를 위한 조건을 갖추고 있다.

 

public final class URL implements java.io.Serializable {}

 

직렬화 (serialize)란 자바 언어에서 사용되는 Object 또는 Data를 다른 컴퓨터의 자바 시스템에서도 사용 할 수 있도록 바이트 스트림 (Stream of bytes) 형태로 연속적인(serial) 데이터로 변환하는 포맷 변환 기술을 말한다. 반대인 역직렬화는(Deserialize) 는 바이트로 변환된 데이터를 원래대로 자바 시스템의 Ojbect 또는 Data로 변환하는 기술이다.

 

* 바이트 스트림 이란?

 스트림은 클라이언트나 서버 간에 출발지 목적지로 입출력하기 위한 데이터가 흐르는 통로를 말한다. 자바는 스트림의 기본 단위를 바이트로  두고 있기 때문에, 네트워크, 데이터베이스로 전송하기 위해 최소 단위인 바이트 스트림으로 변환하여 처리한다.

 

그런데 JSON을 사용하지 않고 왜 직렬화하여 사용할까?

 첫번째는 직렬화는 자바의 고유 기술인 만큼 당연히 자바 시스템에서 개발에 최적화되어 있다.

두번째는, 자바의 광활한 레퍼런스 타입에 대해 제약 없이 외부에 내보낼 수 있다는 것이다.

 

 

 1) URL 객체 생성하기

 URL 클래스의 생성자는 다양한 형태로 선언되어 있다. 그 중에 가장 많이 이용되는 생성자는 URL을 문자열 형태로 나타낸 객체의 레퍼런스를 인자로 전달받는 생성자이다.

 

public URL(Stirng spec) throws MalformedURLException {,,,}

 

예를들어 https://www.naver.com 의 URL을 나타내는 URL 객체를 생성하고 싶다면 아래와 같이 작성하면 된다.

 

import java.net.URL;
...

URL url = new URL("https://wwww.naver.com");

 

공식 Java API 문서를 보면,  생성자를 비롯하여 모든 URL 클래스 객체의 생성자는 MalformedURLException 예외를 throws 하여 예외처리에 대한 책임을 전가하고 있다. MalformedURLException은 생성자의 인자로 받은 URL 문자열이 null 이거나 프로토콜을 알 수 없을 때 등의 상황에 발생한다. 따라서 URL 객체를 생성한 클래스에서 그 예외를 처리해주어야 한다.

 

try {
	URL url = new URL("https://www.naver.com");
} catch (MalformedURLException e) {
	e.printStackTrace();
}

 

 

2) 연결 객체 얻기

URL 클래스에 선언된 openConnection() 메소드는 URL 객체에 대한 연결을 담당하는 URLConnection 객체를 반환한다.

 

위에서 생성한 URL 객체에 대한 연결 객체를 얻으려면 아래와 같이 하면된다.

 

URLConnection connection = url.openConnection();

 

 

 

2. HttpURLConnection 클래스

https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/net/HttpURLConnection.html

HttpURLConnection (Java SE 11 & JDK 11 )

 

HttpURLConnection 클래스는 HTTP 프로토콜 통신을 위한 클래스이다. 각각의 객체들은 하나의 요청을 위해 사용된다.

HttpURLConnection 클래스를 살펴보면 URLConnection 클래스를 확장한(상속받은) 추상클래스임을 알 수 있다.

 

1) HttpURLConnection 객체 생성

위에서 URL 객체의 openConnection() 메소드를 통해 URLConnection 객체를 얻을 수 있었다. HttpURLConnection 객체는 URLConnection 객체를 확장하고(상속받고)있기 때문에 Type Casting 을 통해 HttpURLConnection객체를 쉽게 얻을 수 있다.

 

URL에 연결하는 HTTP 연결 객체를 생성하고 싶다면 다음과 같이 코드를 작성하면 된다.

 

import java.net.URL;
import java.net.HttpURLConnection;
...

URL url = new URL("https://www.naver.com");
HttpURLConnection connection = (HttpURLConnection) url.openConnection();

 

 

2) 요청 메소드 설정

HTTP 요청을 위해서는 요청 메소드를 설정해야 한다. setRequestMethod() 메소드는 요청 메소드를 문자열 파라미터로 받아서 유요한 요청 메소드면 method 멤버 변수에 요청 메소드를 저장하고, 아니면 ProtocolException 예외를 발생시킨다. 처리 가능한 요청 메소드로는 GET, POST, HEAD, OPTIONS, PUT, DELETE, TRACE 가 있다.

public void setRequestMethod(String method) throws ProtocolException {
        if (connected) {
            throw new ProtocolException("Can't reset method: already connected");
        }
        // This restriction will prevent people from using this class to
        // experiment w/ new HTTP methods using java.  But it should
        // be placed for security - the request String could be
        // arbitrarily long.

        for (int i = 0; i < methods.length; i++) {
            if (methods[i].equals(method)) {
                if (method.equals("TRACE")) {
                    SecurityManager s = System.getSecurityManager();
                    if (s != null) {
                        s.checkPermission(new NetPermission("allowHttpTrace"));
                    }
                }
                this.method = method;
                return;
            }
        }
        throw new ProtocolException("Invalid HTTP method: " + method);
    }

 

method 멤버변수는 기본으로 "GET"으로 초기화되어있다. 따라서 setRequestMethod()를 통해 요청 메소드를 설정하지 않으면 GET 요청을 보내게 된다.

 

위에서 생성한 HttpURLConnection 객체로 POST 요청을 하고 싶다면 다음과 코드를 작성하면 된다.

connection.setReuqestMethod("POST");

 

 

3) 요청 헤더 설정

HttpURLConnection 클래스가 확장(상속)하는 URLConnection 클래스에 정의된 setRequestProperty() 메소드로 요청 헤더를 설정할 수 있다.

 

public void setRequestProperty(String key, String value) {
        checkConnected();
        if (key == null)
            throw new NullPointerException ("key is null");

        if (requests == null)
            requests = new MessageHeader();

        requests.set(key, value);
}

 

setRequestProperty() 메소드는 String 타입의 key, value 파라미터를 받는다. 각 파라미터를 통해 요청 헤더의 이름과 값을 설정할 수 있다. 만약 key값이 null 이라면 NullPointerException 예외를 발생시킨다.

 

Content-Type 및 HTTP 요청을 하는 사용자의 애플리케이션 타입, 운영 체제, 소프트웨어 벤더 또는 소프트웨어 버전 등을 식별할 수 있는 User-Agent 헤더를 설정하고 싶다면 다음과 같이 코드를 작성하면 된다.

 

private static final String USER_AGENT = "Mozilla/5.0 (X11; Ubuntu; Linux x86_64; rv:35.0) Gecko/20100101 Firefox/35.0";

...

connection.setRequestProperty("User-Agent", USER_AGENT);
connection.setReuqestProperty("Content-Type", "application/json; charset=utf-8");

 

 

4) POST 요청시 데이터 넘겨주기

POST 요청을 할 때에는 OutputStream 객체로 데이터를 전송한다. setDoOutPut() 메소드를 통해 OutputStream 객체로 전송할 데이터가 있다는 옵션을 설정해야 한다. checkConnected() 메소드에서는 연결 객체가 연결되어있는지 확인하고, 이미 연결되어있다면 IllegalStateException 예외를 발생시킨다.

 

public void setDoOutput(boolean dooutput) {
    checkConnected();
    doOutput = dooutput;
}

 

위처럼 setDoOutput() 메소드는 boolean 타입의 dooutput 파라미터를 받으 doOutput 멤버 변수에 저장한다. doOutput 변수가 true 이면 OutputStream 으로 데이터를 전송한다는 뜻이고, false이면 하지 않는다는 뜻인데, 기본적으로 false로 초기화되어있기 때문에 POST로 데이터를 전송하려면 꼭 옵션을 설정해줘야 한다.

 

getOutputStream() 메소드를 통해 연결에 사용할 OutputStream 객체를 얻을 수 있다. 프로토콜이 출력을 지원하지 않는다면 UnknownServiceException 예외를 발생시킨다.

 

public OutputStream getOutputStream() throws IOException {
     throw new UnknownServiceException("protocol doesn't support output");
}

 

전송할 데이터가 문자열일 경우는 OutputStream 클래스를 확장하는 DataOutputStream 클래스의 writebytes() 메소드를 활용하여 쉽게 데이터를 설정할 수 있습니다. DataOutputStream 클래스는 생성자에 OutptStream 객체를 전달하여 생성할 수 있습니다. 따라서 위에서 getOutputSteam() 메소드를 통해 얻은 객체를 바로 넣어줄 수 있다.

 

5) 응답 코드 얻기

getResponseCode() 메소드를 통해 응답 코드를 얻을 수 있습니다. 정상적인 응답일 경우 200이 반환됩니다.

 

 

6) 응답 데이터 얻기

getInputStream() 메소드를 통해 응답 데이터를 읽을 수 있는 InputStream객체를 얻을 수 있습니다. 응답을 문자열 타입으로 얻기 위해 BufferedReader 객체를 사용할 수 있습니다.

 

BufferedReader bufferedReader = new BufferedReader(new InputStreamReader(connection.getInputStream()));
StringBuffer stringBuffer = new StringBuffer();
String inputLine;

while ((inputLine = bufferedReader.readLine()) != null)  {
     stringBuffer.append(inputLine);
}
bufferedReader.close();

String response = stringBuffer.toString();