📌 Spring @RestController 활용 및 JSON/XML 반환 예제

📅 날짜

2025-04-28

---

📝 학습 내용

1️⃣ @RestController 개념

• @RestController는 스프링에서 RESTful API를 구현할 때 사용하는 어노테이션.
• 반환 데이터를 View가 아닌, HTTP Response Body로 직접 전송.
• 주로 JSON, XML, Plain Text 형태로 응답.

---

2️⃣ pom.xml 의존성 설정

<!-- RESTCONTROLLER 관련 Jackson 라이브러리 -->
<dependency>
    <groupId>com.fasterxml.jackson.core</groupId>
    <artifactId>jackson-databind</artifactId>
    <version>2.19.0</version>
</dependency>

<dependency>
    <groupId>com.fasterxml.jackson.dataformat</groupId>
    <artifactId>jackson-dataformat-xml</artifactId>
    <version>2.19.0</version>
</dependency>

<dependency>
    <groupId>com.fasterxml.jackson.core</groupId>
    <artifactId>jackson-core</artifactId>
    <version>2.19.0</version>
</dependency>

<dependency>
    <groupId>com.fasterxml.jackson.datatype</groupId>
    <artifactId>jackson-datatype-jsr310</artifactId>
    <version>2.19.0</version>
</dependency>

• 설명
  • JSON, XML 변환을 위한 필수 라이브러리.
  • jackson-datatype-jsr310은 Java 8의 LocalDateTime 지원.

---

3️⃣ RestController 예제 코드 및 호출 방법

컨트롤러 기본 경로:

@RequestMapping("/rest")

⇒ 모든 API 호출 시 /rest로 시작

---

✅ 1. 텍스트 반환 예제

@GetMapping(value = "/getText", produces = MediaType.TEXT_PLAIN_VALUE)
public String f1() {
    return "HELLO WORLD";
}

• 호출 URL

  GET http://localhost:8080/rest/getText
  

• 응답 타입: text/plain
• 응답 결과:

  HELLO WORLD
  

---

✅ 2. JSON 반환 예제

@GetMapping(value = "/getJson", produces = MediaType.APPLICATION_JSON_UTF8_VALUE)
public MemoDto f2() {
    return new MemoDto(11, "ABCD", "FFFF", LocalDateTime.now());
}

• 호출 URL

  GET http://localhost:8080/rest/getJson
  

• 응답 타입: application/json
• 예시 응답

{
  "id": 11,
  "text": "ABCD",
  "writer": "FFFF",
  "createAt": [2025, 4, 28, 10, 39, 23, 310212300]
}

---

✅ 3. 단일 XML 반환 예제

@GetMapping(value = "/getXml", produces = MediaType.APPLICATION_XML_VALUE)
public MemoDto f3() {
    return new MemoDto(11, "ABCD", "FFFF", LocalDateTime.now());
}

• 호출 URL

  GET http://localhost:8080/rest/getXml
  

• 응답 타입: application/xml
• 예시 응답

<MemoDto>
    <id>11</id>
    <text>ABCD</text>
    <writer>FFFF</writer>
    <createAt>2025</createAt>
    ...
</MemoDto>

---

✅ 4. XML 리스트 반환 예제

@GetMapping(value = "/getXmlList", produces = MediaType.APPLICATION_XML_VALUE)
public List<MemoDto> f4() {
    // 리스트 생성 후 반환
}

• 호출 URL

  GET http://localhost:8080/rest/getXmlList
  

• 응답 타입: application/xml
• 예시 응답 (일부)

<List>
  <item>
    <id>0</id>
    <text>A0</text>
    ...
  </item>
  <item>
    <id>1</id>
    <text>A1</text>
    ...
  </item>
</List>

---

✅ 5. ResponseEntity 활용 - 조건부 XML 반환

@GetMapping(value = "/getXmlList2/{show}", produces = MediaType.APPLICATION_XML_VALUE)
public ResponseEntity<List<MemoDto>> f5(@PathVariable("show") boolean show) {
    // 조건부 반환
}

• 호출 URL

  GET http://localhost:8080/rest/getXmlList2/true
  GET http://localhost:8080/rest/getXmlList2/false
  

• 설명
  • /true : HTTP 200 OK + XML 리스트 반환
  • /false : HTTP 502 Bad Gateway 반환

---

✅ 6. 일반 Controller + @ResponseBody 사용

java

@GetMapping("/home/test")
@ResponseBody
public String test() {
    return "{\"message\":\"REST DATA TEST\"}";
}

• 설명: 기존 @Controller에서도 메서드 단위로 REST 방식 구현 가능.
  
• URL 호출: GET http://localhost:8080/home/test
  
• 응답:

json
복사편집
{"message":"REST DATA TEST"}

---

🔥 정리

• API 호출 시 URL 패턴과 produces 설정에 따라 다양한 형식으로 응답 가능.
• 브라우저, Postman, curl 등을 활용해 테스트.
• ResponseEntity를 통해 상태 코드까지 세밀하게 제어.
• JSON, XML 변환 시 날짜 포맷에 주의.

---

🔗 참고 자료

• Spring RestController 공식 문서
• Jackson Databind
• ResponseEntity 활용 가이드

---