[Spring] RESTful API

REST(Representational State Transfer) 

: 자원(Resource)의 표현(Representational)에 의한 상태(State)를 전달(Transfer)

• 페이지 요청에 대한 요청결과를 클라이언트에게 XML이나 JSON 형식의 텍스트 데이터로 응답 처리하는 것을 의미한다.

 

Restful API

: REST 기능을 사용하여 두 컴퓨터의 시스템이 안전하게 값을 주고 받기 위한 프로그램

• 스마트기기의 프로그램(앱) 정보를 전달받아  사용하거나 실행결과를 제공받아 출력하기 위해 사용한다. 

 

 

---

 

일반적인 방법)

 

 

RestfulController

@Controller
@RequestMapping("/rest")
public class RestfulController {
	//회원정보를 입력바딕 위한 JSP 문서의 뷰이름을 반환하는 요청 처리 메소드
	@RequestMapping(value = "/join", method = RequestMethod.GET)
	public String join() {
		return "rest/input";
	}
	
	//전달값을 매개변수로 제공받아 뷰에게 속성값으로 저장하여 출력하기 위한 JSP 문서의 뷰이름을 
	//반환하는 요청 처리 메소드
	// - @RequestParam을 이용해 하나의 전달값을 하나의 매개변수로 제공받아 요청 처리 메소드에서 사용할 수 있도록 만들어 준다.
	@RequestMapping(value = "/join", method = RequestMethod.POST)
	public String join(@RequestParam String id, @RequestParam String name, Model model) {
		model.addAttribute("id", id);
		model.addAttribute("name", name);
		return "rest/output";
	}
}

 

 

input.jsp

	<h1>입력페이지</h1>
	<hr>
	<form method="post">
	<table>
		<tr>
			<td>아이디</td>
			<td><input type="text" name="id"></td>
		</tr>
		<tr>
			<td>이름</td>
			<td><input type="text" name="name"></td>
		</tr>
		<tr>
			<td colspan="2"><button type="submit">제출</button></td>
		</tr>
	</table>	
	</form>

 

output.jsp

	<h1>입력페이지</h1>
	<hr>
	<p>아이디 = ${id }</p>
	<p>이름 = ${name }</p>

 

 

 

---

Restful API를 사용한 프로그램을 만들 것이다

JSON 으로 값을 제공받고, 응답 처리하는 방법에 대해 알아보자

 

 

@ResponseBody 

: 요청 처리 메소드의 반환값(문자열)을 리스폰즈 메세지 몸체부에 저장하여 클라이언트에게 직접 텍스트 데이터로 응답되도록 처리하는 어노테이션 

• 반환값을 ViewResolver 객체를 사용하여 뷰로 변환해 응답하지 않고 요청 처리 메소드가 직접 응답 처리할 수 있도록 한다.
• @ResponseBody 어노테이션 대신 ReponseEntity 클래스를 사용하여 응답 처리가 가능하다. 

@ResquestBody

: 리퀘스트 메세지 몸체부에 저장된 모든 전달값을 문자열로 제공받기 위한 어노테이션

• POST, PUT, PATCH, DELETE 등의 요청방식으로 페이지를 요청한 경우 리퀘스트 메세지 몸체부에 저장된 모든 전달 값을 [이름=값&이름=값&...] 형식의 문자열로 제공받아 사용할 수 있다. 
• GET 방식으로 페이지를 요청한 경우 리퀘스트 메세지 몸체부가 비어 있으므로 @RequestBody 어노테이션 사용이 불가능하다. 
• 페이지 요청시 JSON 형식의 텍스트 데이터를 전달된 값을 매개변수로 제공받아 저장하기 위해 사용한다. 
• @RequestBody 어노테이션 대신 RequestEntity 클래스를 사용하여 요청 처리할 수 있다. 

 

 

RestfulController

@Controller
@RequestMapping("/rest")
public class RestfulController {
	@RequestMapping(value = "/join", method = RequestMethod.GET)
	public String join() {
		return "rest/input";
	}
	
	@RequestMapping(value = "/join", method = RequestMethod.POST)
	@ResponseBody
	public String join(@RequestBody String input) {
		return "input";
	}
}

 

 

---

예제)

 

RestMember(DTO)

@Data
@Builder
public class RestMember {
	private String id;
	private String name;
	private String email;
}

 

 

 

RestfulController

 

@ResponseBody 어노테이션을 사용하여 요청 처리 메소드의 반환값(RestMember 객체)을 리스폰즈 메세지 몸체부에 저장하여 텍스트 데이터로 클라이언트에게 응답되도록 처리하게 되면 문제점이 발생한다.

 

문제점)

리스폰즈 메세지 몸체부에는 Java 객체를 저장하여 응답 처리할 수 없다. 따라서 406 에러 코드가 발생한다.

 

	//@ResponseBody 어노테이션을 사용하여 요청 처리 메소드의 반환값(RestMember 객체)을 리스폰즈 
	//메세지 몸체부에 저장하여 텍스트 데이터로 클라이언트에게 응답되도록 처리
	@RequestMapping(value= "/member")
	@ResponseBody
	public RestMember restMember() {
		//RestMember 객체를 생성하여 반환
		return RestMember.builder().id("abc123").name("홍길동").email("abc@itwill.xyz").build();
	}

 

 

해결법)

요청 처리 메소드에 의해 반환되는 Java 객체를 문자열로 변환하여 리스폰즈 메세지 몸체부에 저장하여 응답처리 할 수 있도록 해준다. 

-> jackson-databind 라이브러리를 프로젝트에 빌드 처리하면 요청 처리 메소드에 의해 반환되는 Java 객체를 JSON 형식의 문자열로 자동 변환하여 응답처리할 수 있다. - 메이븐 : pom.xml

 

 

pom.xml

 

자동으로 변환된다.

 

 

 

@ResponseBody 어노테이션 대신 요청 처리 메소드에서 ResponseEntity 객체를 반환해도 클라이언트에게 텍스트 데이터로 응답 처리할 수 있다. (어노테이션 사용을 더 권장한다.)

-> ResponseEntity 객체의 제네릭에는 응답 처리된 Java 객체의 자료형(클래스)을 설정할 수 있다.

 

	@RequestMapping(value= "/member")
	public ResponseEntity<RestMember> restMember() {
		try {
			RestMember member=RestMember.builder().id("abc123").name("홍길동").email("abc@itwill.xyz").build();
			//클라이언트에게 응답코드 200과 실행결과를 텍스트로 응답 처리
			return new ResponseEntity<RestMember>(member, HttpStatus.OK);
		} catch (Exception e) {
			//클라이언트에게 응답코드 400으로 응답 처리
			return new ResponseEntity<RestMember>(HttpStatus.BAD_REQUEST);
		}
	}

 

 

	@RequestMapping(value= "/member_List")
	@ResponseBody
	public List<RestMember> restMemberList() {
		List<RestMember> memberList=new ArrayList<RestMember>();
		
		memberList.add(RestMember.builder().id("abc123").name("홍길동").email("abc@itwill.xyz").build());
		memberList.add(RestMember.builder().id("opq456").name("임꺽정").email("opq@itwill.xyz").build());
		memberList.add(RestMember.builder().id("xyz789").name("전우치").email("xyz@itwill.xyz").build());
		
		//List 객체를 자바스크립트의 Array 객체의 JSON 형식의 텍스트 데이터로 변환해 응답 처리한다.
		return memberList;
	}

 

 

 

	@RequestMapping(value= "/member_map")
	@ResponseBody
	public Map<String, Object> restMemberMap() {
		Map<String, Object> map=new HashMap<String, Object>();
		
		map.put("id", "abc123");
		map.put("name", "홍길동");
		map.put("email", "abc@itwill.xyz");
		
		//Map 객체를 자바스크립트의 Object 객체의 JSON 형식의 텍스트 데이터로 변환해 응답 처리한다.
		return map;
	}