Spring RESTful 사용자 관리 프로젝트 (@RequestBody, @ResponseBody, GET, POST, PUT, DELETE, Postman 설치 및 테스트 )

https://hyejin.tistory.com/265

Spring MVC, Mybatis [2] 간단한 사용자 게시판 만들기

이 때 만들었던 간단한 사용자 관리 프로젝트에 대해서 Spring RESTful 기반으로 만들어볼 예정이다. 

 

https://hyejin.tistory.com/271

Spring REST, RESTful API, XML, JSON , Jackson 라이브러리 설치

여기에 나와있는 Jackson 라이브러리를 설치하고, 

Spring Bean Configuration 파일 설정에 몇가지 추가해줘야한다. 

<annotation-driven/> 태그는 Spring MVC에 필요한 Bean들을 자동으로 등록해주는 태그로 

annotation-driven 태그가 JSON과 관련해서 내부적으로 처리해준다. 

 

<default-servlet-handler/> 태그는 DispatcherServlet의 변경된 url-pattern때문에 필요한 태그 설정이다. 

 

 

1. Spring MVC 기반 RESTful 웹 서비스 구현 절차 

1️⃣ RESTful 웹 서비스를 처리할 RestfulController 클래스 작성 및 Spring Bean으로 등록 

2️⃣ 요청을 처리할 메서드에 @RequestMapping, @RequestBody와 @ResponseBody 어노테이션 선언 

3️⃣ REST Client Tool(Postman)을 사용해서 각각의 메서드를 테스트한다. 

4️⃣ Ajax통신을 하여 RESTful 웹 서비스를 호출하는 HTML 페이지 작성 

 

 

2. Postman 설치 및 실행 

https://chrome.google.com/webstore/detail/postman/fhbjgbiflinjbdggehcddcbncdddomop/related

Postman

원래는 앱 실행 대신 설치 였나 추가였나 그런 버튼일 것이다. 

그 버튼을 눌러주고 구글 아이디로 로그인 해주면 Postman을 통해 테스트를 진행할 수 있다. 

 

 

3. 사용자 관리 RESTful 웹 서비스 method 

사용자 목록 조회 - > GET 

특정 사용자 조회 -> GET

사용자 등록 - > POST

사용자 수정 - > PUT

사용자 삭제 - > DELETE 

 

 

4. @RequestBody, @ResponseBody 

: Spring MVC에서는 클라이언트에서 전송한 XML이나 JSON 데이터를 Controller에서 Java 객체로 변환해서 받을 수 있는 기능(수신)을 제공하고 있다. 그리고 Java 객체를 XML이나 JSON으로 변환해서 전송할 수 있는 기능(송신)을 제공하고 있다. 

@RequestBody 

-> HTTP Request Body를 Java 객체로 전달 받을 수 있다. 

@ResponseBody

-> Java 객체를 HTTP Response Body로 전송할 수 있다. 

 

 

5. 사용자 목록 조회

RestFulUserController.java

getUserList 메서드에 @ResponseBody 어노테이션이 있다. 이는 MappingJacksonHttpMessageConverter가 리턴값인 UserModel 객체를 JSON으로 변환하는 작업을 처리한다. 

 

 

6. 특정 사용자 정보 조회 

RestFulController.java

이번에도 ResponseBody 어노테이션이 있기 때문에 UserModel 객체를 JSON형태로 반환하는 작업을 처리한다. 

 

 

7. 사용자 정보 등록 

이번에 사용자 등록을 할 때에는 직접 JSON으로 입력해야하기 때문에 headers를 설정해줘야한다. 

그리고 JSON으로 입력한 사용자를 @RequestBody 어노테이션이 자바 객체로 변환해주는 작업을 처리한다. 

Postman에서 등록이기 때문에 POST으로 바꿔주고 헤더는 다음과 같이 입력해준다.

그리고 이렇게 값 입력 후 send 버튼을 누르면 

 

user10가 등록된걸 확인할 수 있다.

 

 

8. 사용자 정보 수정 

 

정보 수정 역시 값을 입력해줘야하기 때문에 hearder을 설정해줘야하며, 이번엔 수정이라 PUT 메서드를 사용한다. 

 

PUT으로 바꿔주고 헤더를 다음과 같이 작성해준다.

 

그리고 수정할 값들을 작성해주고 SEND 버튼을 누르면 

 

정보가 수정된것을 확인할 수 있다.

 

 

9. 사용자 정보 삭제 

사용자 정보를 삭제할 때는 해당 사용자 id를 url 형식으로 받기 위해 @PathVariable 어노테이션을 사용하며 

method는 DELETE를 사용한다. 

 

user10이 삭제된 것을 확인할 수 있다.