[JAVA] HttpURLConnection 이용한 POST 호출 방법

   

HttpURLConnection

HttpURLConnection은 서버에서 HTTP 요청을 보내고 HTTP 응답을 받을 수 있도록 하는 Java의 클래스입니다. 

다음은 HttpURLConnection을 사용하여 서버에 POST 요청을 보내고 응답을 읽는 방법의 예입니다.

 

1. URL 객체 생성하기   

url을 나타내는 URL 객체를 생성하고 싶다면 다음과 같이 코드를 작성하면 됩니다.

 URL url = new URL("https://www.google.com"); // 요청을 보낼 URL

 

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

 

 

2. HttpURLConnection 객체 생성

https://www.google.com 의 url에 연결하는 HTTP 연결 객체를 생성하고 싶다면 다음과 같이 코드를 작성하면 됩니다. (예외 처리 생략)

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

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

 

HttpURLConnection 클래스는 HTTP 프로토콜 통신을 위한 클래스입니다.

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

 

 

3. 요청 메소드 설정

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

connection.setRequestMethod("POST");

 

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

method 멤버변수는 기본으로 "GET"으로 초기화되어있습니다.

따라서 setRequestMethod()를 통해 요청 메소드를 설정하지 않으면 GET 요청을 보내게 됩니다.

 

4. 요청 메소드 설정

con.setRequestProperty("Content-Type", "application/json"); // JSON 형식으로 데이터 전송

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

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

 

 

 

5. POST 요청시 데이터 넘겨주기

con.setDoOutput(true); // 출력 스트림을 사용하도록 설정

POST 요청을 할 때에는 OutputStream 객체로 데이터를 전송합니다. 

setDoOutput() 메소드를 통해 OutputStream 객체로 전송할 데이터가 있다는 옵션을 설정해야 합니다.

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

 

6. 문자열 요청데이터 전송

OutputStreamWriter writer = new OutputStreamWriter(con.getOutputStream());
         
// 전송할 JSON 데이터 객체 생성
JSONObject dataJson = new JSONObject();
dataJson.put("text", "전송하는텍스트입니다");

// JSON 문자열로 변환
String jsonString = dataJson.toString();


  // 데이터 전송
  writer.write(jsonString);
  writer.flush();
  writer.close();

 

HTTP POST 요청을 보낼 때, 요청 본문에 데이터를 포함시킬 수 있습니다.

데이터를 포함시키는 방법에는 여러 가지가 있지만, 가장 일반적인 방법은 요청 본문에 문자열로 데이터를 쓰는 것입니다.

 

위 코드는 HttpURLConnection 객체 con의 출력 스트림을 얻어와서 OutputStreamWriter 객체 writer를 생성하는 코드입니다 . 생성된 OutputStreamWriter 객체를 사용하여 HTTP POST 요청의 본문에 문자열로 데이터를 쓸 수 있습니다.

 

flush() 메서드는 버퍼에 남아있는 데이터를 출력하고 출력 스트림을 비우는 역할을 합니다.

close() 메서드는 출력 스트림을 닫는 역할을 합니다.

 

 

7. 응답 코드 얻기

  // 응답 코드 확인
  int responseCode = con.getResponseCode();
  System.out.println("Response Code : " + responseCode);

 

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

 

 

8.응답 데이터 얻기

  // 응답 내용 읽기
  BufferedReader in = new BufferedReader(new InputStreamReader(con.getInputStream()));


  String inputLine;
  StringBuffer response = new StringBuffer();


  while ((inputLine = in.readLine()) != null) {
      response.append(inputLine);
  }
  in.close();
  System.out.println("Response Body : " + response.toString());

getInputStream() 메소드를 통해 응답 데이터를 읽을 수 있는 InputStream객체를 얻을 수 있습니다.

응답을 문자열 타입으로 얻기 위해 BufferedReader 객체를 사용할 수 있습니다.

 

 

예시 전체 코드 :

...
try {
  URL url = new URL("https://nlp.voise.co.kr/sent"); // 요청을 보낼 URL
  HttpURLConnection con = (HttpURLConnection) url.openConnection(); 
  con.setRequestMethod("POST"); // POST 요청 설정
  con.setRequestProperty("Content-Type", "application/json"); // JSON 형식으로 데이터 전송
  con.setDoOutput(true); // 출력 스트림을 사용하도록 설정

  OutputStreamWriter writer = new OutputStreamWriter(con.getOutputStream());

  String resultRx = rx.get("text").toString();

  // 전송할 JSON 데이터 객체 생성
  JSONObject dataJson = new JSONObject();
  dataJson.put("text", "전송하는텍스트입니다");

  // JSON 문자열로 변환
  String jsonString = dataJson.toString();

  // 데이터 전송
  writer.write(jsonString);
  writer.flush();
  writer.close();

  // 응답 코드 확인
  int responseCode = con.getResponseCode();
  System.out.println("Response Code : " + responseCode);

  // 응답 내용 읽기
  BufferedReader in = new BufferedReader(new InputStreamReader(con.getInputStream()));
  String inputLine;
  StringBuffer response = new StringBuffer();
  while ((inputLine = in.readLine()) != null) {
      response.append(inputLine);
  }
  in.close();
  System.out.println("Response Body : " + response.toString());

} catch (Exception e) {
  e.printStackTrace();
}
...

 

 

 

참고 출처 : https://limdevbasic.tistory.com/14

[Java] Java로 HTTP GET, POST 통신하기