RESTApi / XML로 데이터 응답하기

---

👀 구구절절 서론

 

RestApi를 이용하여 API를 만드는 업무 도중 xml로 데이터를 반환해야 할 일이 생겼다.

xml방식을 만들어보기는 커녕 사용해본 적도 없었기 때문에 소스를 분석하고 자료를 찾는데에만 거의 하루를 쏟은 것 같다.

 

xml만 응답하는 것이 아니라, 파라미터를 통해 format형식을 받아 xml 또는 json으로 나눠서 반환해줘야 했고,

두가지 방식으로 진행했는데,

1. 설정을 통해서 컨트롤러에서 직접 파라미터를 받지 않고도 모든 api 호출 형식에 format을 나눠서 받아 사용할 수 있도록 해주는 것

2. 컨트롤러에서 직접 파라미터를 받아 xml과 json을 나눠서 각각 응답해주는 것

 

첫번째 방식은 설정싸움이었기 때문에 이해해서 사용한다기 보다는 검색과 기존 소스를 통해서 많은 도움을 받았고, 설정 한번만 해두면 이후 따로 설정해주지 않아도 된다는 부분이 좋았다.

그리고 첫번째 방식을 성공시킨 뒤 두번째 방식을 굳이 할 필요가 없었겠지만 .......^^.....

우리에게는 늘 고객님이 있으니까! ㅎㅎㅎ

 

기존 방식과 동일하게 서비스해야했기 때문에,

소스를 프린트해서 읽어가면서 이해하고 이해 안되는건 또 검색, 문서읽기... 무한반복

(언젠간 모니터로 소스만 훑어도 전체적인 큰 그림이 그려지는 머쨍이 개발자가 돼야지 ...!!!)

xml과 json에 대한 이해 뿐만 아니라 자바 공식문서를 통해 여러 객체나 메소드들에 대해서 많이 알게되었다.

 

아무튼,

이번 포스팅에서는 일단 문서를 직접 생성하여 DOM구조를 만들고 내용을 작성하여 HttpServletResponse를 통해 XML을 내보내는 방법에 대해서 기록해두고자 한다.

 

+ 다음으로는 JSONObject 객체를 이용해서 JSON을 직접 응답하는 방식도 적어둬야겠다..

---

 

0. 사전설정

 (1) @RestController를 사용한 컨트롤러

 (2) @RequestMapping을 이용하여 GET방식의 메소드를 사용할 것임을 선언해둠

 (3) return type은 void

 (4) 파라미터에 HttpServletResponse를 이용하여 응답할 객체 생성해둠

 

1. 시작!

 

(1) XML문서를 파싱하기 위해 DocumentBuilderFactory와 DocumentBuilder 선언, 인스턴스 생성

DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();
DocumentBuilder documentBuilder = factory.newDocumentBuilder();

- XML문서에서 DOM개체트리를 생성하는 파서를 생성하는 것

 

 

(2) Document 생성 후, 독립실행형인지의 여부를 true로 변경

Document document = documentBuilder.newDocument();
document.setXmlStandalone(true);

 

(3) root Element 생성해서 document에 자식요소로 추가해주기

/** root 생성 **/
Element root = document.createElement("root");
		
/** 자식요소 추가 **/
document.appendChild(root);

 

(4) XML문자열로 변환하기 위한 준비

ByteArrayOutputStream out = new ByteArrayOutputStream();
DOMSource source = new DOMSource(document);
StreamResult result = new StreamResult(out);

- ByteArrayOutputStream : 데이터가 바이트배열에 기록되는 출력 스트림 구현

 

(5) 필요한 데이터를 준비!

 

(6) 원하는 DOM 구조로 작성해주기

- xml의 구조가 생소했기 때문에 이해가 어려웠던 것 같다.

- 앞서 root를 생성해서 document에 append시켜 준비해두었던 것 처럼, root 아래로 원하는 Element들을 생성하여 append시켜주면 된다.

 

예를들어,

 

<?xml version="1.0" encoding="UTF-8"?>

<root>

    <resultCount>1</resultCount>

    <item>

        <name>홍길동</name>

        <age>20</age>

    </item>

</root>

 

위과 같은 구조의 xml 문서를 응답하고 싶다면 아래와 같이 작성된다.

//1. 데이터 준비
int resultCnt = 1;
String name_data = "홍길동";
int age_data = "20";

//2. Element 생성
Element resultCount = document.createElement("resultCount");

Element item = document.createElement("item");

Element name = document.createElement("name");
Element age = document.createElement("age");

//3. Element에 Data 세팅
resultCount.setTextContent(Integer.toString(resultCnt));
name.setTextContent(name_data);
age.setTextContent(Integer.toString(age_data));


//4. append

root.appendChild(resultCount);
root.appendChild(item);

item.appendChild(name);
item.appendChild(age);

 

(7) 출력해주기 위한 인스턴스 생성

TransformerFactory transFactory = TransformerFactory.newInstance();
Transformer transformer = transFactory.newTransformer();

 

(8) 원하는 설정 세팅 후, 출력

//출력시 문자 코드: UTF-8
transformer.setOutputProperty(OutputKeys.ENCODING, "UTF-8");
//들여쓰기 있음
transformer.setOutputProperty(OutputKeys.INDENT, "yes");
//출력
transformer.transform(source, result);

response.setContentType("text/xml");
response.setCharacterEncoding("UTF-8");
response.getWriter().println(new String(out.toByteArray(), StandardCharsets.UTF_8));

 

---

일단 이런 방식으로 처리했는데.....

사실 지금 방법은 알겠지만 설정이나 구조는 잘 모르겠는데다가, 이게 너무 비효율적인건 아닌지 고민중 ㅠㅠ

우선 나머지 예외나 잡으러 가야겠다 🔥🔥