rest with spring
DESCRIPTION
Spring 3.2로 살펴보는 REST ServiceTRANSCRIPT
1. REST?
Roy T. FieldingArchitectural Styles and the
Design of Network-based Software architectures
Representational State Transfer
https://www.ics.uci.edu/~fielding/pubs/dissertation/top.htm
The Constaints of REST• 클라이언트-서버 (Client-Server)
• 무상태 (Stateless)
• 캐시 (Cache)
• 균일한 인터페이스 (Uniform Interface)
• 계층 시스템 (Layered System)
• 주문형 코드(Code-on-demand) - optional
Client-Server• 웹의 일관된 인터페이스를 따른다는 전제하에, 클라이언트와 서버는 독립적으로 구현되어야한다.
ServerClient
Stateless• 서버가 클라이언트의 상태를 관리할 필요가 없어야 한다.
Stateless ServerClient
Client
Client
Cache• 웹 서버가 응답 데이터마다 캐시 여부를 선언할 수 있어야 한다.
Stateless Server
Client +
Cache
Client +
Cache
Client +
Cache
Uniform Interface• Identification of resources (자원 식별)
• Manipulation of resource through representations (표현을 통한 자원 처리)
• Self-descriptive messages (자기 서술적 메시지)
• HATEOAS
• 같은 인터페이스 제약에 따라 서로 일관성 있게 상호 운영되어야한다.
a. Resource Identifier
• 구성 요소 사이의 상호 작용에 대한 특정 자원을 식별
• URI로 표현 (URL, URN)
• http://스프링캠프/users/kangwoo
b. Resource Representation• 자원의 상태 표현<xml>
<사용자>
<아이디>kangwoo</아이디>
<이름>강우</이름>
<상태>안좋음</상태>
</사용자>
</xml>
c. Self-descriptive messages
• 요청을 처리하는데 필요한 모든 정보가 포함
GET /users/kangwoo HTTP/1.1
User-Agent: Chrome/18
Host: 스프링캠프
Accept: application/xml
d. HATEOAS• Hypermedia as the Engine of Application State • State transitions (상태 전이)
StateState
State
State
Transition
Transition
Transition
d. HATEOAS• 요청에 대한 응답을 링크 정보를 포함하는 형태로 표현
<사용자들 xmlns:atom=“http://www.w3.org/2005/Atom”> <atom:link href=“http://스프링캠프/users” rel=“self /> <content> <사용자> <links> <atom:link href=“http://스프링캠프/users/kangwoo” rel=“self /> <atom:link href=“http://스프링캠프/session/RWS” rel=“session /> </links> <id>kangwoo</id> <이름>강우</이름> </사용자> … </content> </사용자들>
Layered System• 웹의 일관된 인터페이스를 사용해서 프락시 또는 게이트웨이 같은 네트워크 기반의 중간매체를 사용할 수 있어야 한다.
Stateless ServerClient
Stateless Server
Stateless Server
Load BalancerGateway
Code-On-Demand• 선택사항으로 스크립트나 플러그인 같은 실행 가능한 프로그램을 클라이언트에 전송하여, 클라이언트가 실행 할 수 있도록 해야한다.
Stateless Server
Client !!!Code
REST의 구조
Resource + Operation• Resource : 자원을 나타냄. URI로 표현
• http://스프링캠프/users/kangwoo
• Operation : 자원에 대한 행위를 나타냄. Method로 표현
• GET http://스프링캠프/users/kangwoo
• DELETE http://스프링캠프/users/kangwoo
Resource• 자원을 나타내며, 각각 고유한 URI를 가지고 있다.
• http://스프링캠프/users/kangwoo
• http://스프링캠프/sessions/RWS
• URI는 사람이 이해할 수 있는 형식으로 사용한다.
• 조회시 Query Parameter를 사용할 수 있다.
• http://스프링캠프/sessions?keyword=rest
Operation• HTTP Method를 사용해서 행위(CRUD)를 나타냄
• POST : 새로운 자원을 생성한다. (CREATE)
• POST http://스프링캠프/users
• GET : 자원을 조회한다. (READ)
• GET http://스프링캠프/users
• GET http://스프링캠프/users/kangwoo
• PUT :기존에 존재하는 자원을 수정한다. (UPDATE)
• PUT http://스프링캠프/users/kangwoo
• DELETE : 기존에 존재하는 자원을 삭제한다. (DELETE)
• DELETE http://스프링캠프/users/kangwoo
Non-CRUD Operation• 행위는 CRUD로만 이루어져 있지는 않다.
• 행위 재정의 (메일을 보낸다 -> 메일을 생성한다.)
• POST http://스프링캠프/users/kangwoo/sendmail
• POST http://스프링캠프/users/kangwoo/mail
• 기타 : 내부적인 표준 정의
2. Spring을 이용한 REST Service
Java와 REST
• JSR-311(JAX-RS:The Java API for RESTful Web Service)
• Apache CXF, Jersey, Restlet 등.
Spring과 REST
• ModelAndView
• HTTPMessageConvereter
URITemplate• 하나 또는 두개 이상의 변수를 가지는 URI 서식
• http://스프링캠프/users/kangwoo
• /users/kangwoo -> /user/{id}
@RequestMapping(value = “/{id}”, method = RequestMethod.GET)
@ResponseBody
public User getUser(Model model, @PathVariable(“id”) String id) {
User user = userService.getUser(id);
return user;
}
ModelAndView• 기존의 웹 애플리케이션 개발 방법과 동일
• View를 표현형식에 맞게 변경
• XmlView, JsonView
@RequestMapping(value = “/{id}”, method = RequestMethod.GET)
public String getUser(Model model, @PathVariable(“id”) String id) {
User user = userService.getUser(id);
model.addAttribute(“user”, user);
return “xmlView”;
}
HTTPMessageConverter• 자바 객체와 HTTP 요청/응답 바디를 변환
• @RequestBody / @ResponseBody
• @RestController (Spring 4.0)
@RequestMapping(value = “/{id}”, method = RequestMethod.GET)
@ResponseBody
public User getUser(Model model, @PathVariable(“id”) String id) {
User user = userService.getUser(id);
return user;
}
HTTPMessageConverter• @ResponseStatus
@RequestMapping(method = RequestMethod.POST)
@ResponseStatus(HttpStatus.CREATED)
@ResponseBody
public User createUser(@RequestBody User user) {
userService.createUser(user);
User selectedUser = userService.getUser(user.getId());
return user;
}
HTTPMessageConverter• ResponseEntity<T>
@RequestMapping(value = “/{id}”, method = RequestMethod.GET)
public ResponseEntity<User> getUser(Model model, @PathVariable(“id”)
String id) {
User user = userService.getUser(id);
HttpHeaders responseHeader = new HttpHeaders();
…
return new ResponseEntity<User>(user, responseHeader,
HttpStatus.OK);
}
HTTPMessageConverter• HTTPMessageConverter 구현체
• StringHttpMessageConverter
• FormHttpMessageConverter
• MarshallingHttpMessageConverter
• MappingJackson2HttpMessageConverter
• AtomFeedHttpMessageConverter
• RssChannelHttpMessageConverter
JSON• MappingJackson2HttpMessageConverter
• Jackson (http://wiki.fasterxml.com/JacksonHome)
• Stream API
• Tree Model
• Data Binding
JSON• Jackson 라이브러리 추가
• 설정 파일에 MessageConverter 추가public class RestAppConfig extends WebMvcConfigurerAdapter {
@override
public void configureMessageConverters(List<HttpMessageConverter<?>>
converters) {
converters.add(mappingJacksonHttpMessageConverter());
}
@Bean
public MappingJacksonHttpMessageConverter
mappingJacksonHttpMessageConverter() {
return new MappingJackson2HttpMessageConverter();
}
}
JSON• 조회
• GET http://스프링캠프/users/kangwoo
@RequestMapping(value = “/{id}”, method = RequestMethod.GET)
@ResponseBody
public User getUser(Model model, @PathVariable(“id”) String id) {
User user = userService.getUser(id);
return user;
}
JSON• 등록
• POST http://스프링캠프/users
@RequestMapping(method = RequestMethod.POST)
@ResponseStatus(HttpStatus.CREATED)
@ResponseBody
public User createUser(@RequestBody User user) {
userService.createUser(user);
User selectedUser = userService.getUser(user.getId());
return user;
}
XML• MarshallingHttpMessageConverter
• Spring OXM (Object Xml Mapping)
이름 구현체 참고Castor CastorMarshaller http://www.castor.orgJAXB Jaxb2Marshaller http://jaxb.java.netJiBix JibxMarshaller http://jibx.sourceforget.net
XmlBeans XmlBeansMarshaller http://xmlbeans.apache.orgXStream XStreamMarshaller http://xstream.codehaus.org
XML• Spring OXM와 구현에 관련 라이브러리 추가
• 설정 파일에 MessageConverter 추가
@Bean public Jaxb2Marshaller jaxb2Marshaller() { Jaxb2Marshaller marshaller = new Jaxb2Marshaller(); … return marshaller; } @Bean public MarshallingHtppMessageConverter marshallingHttpMessageConverter() { MarshallingHtppMessageConverter converter = new MarshallingHtppMessageConverter(); converter.setMarshaller(jaxb2Marshaller()); converter.setUnmarshaller(jaxb2Marshaller()); return converter.setMarshaller }
XML• 조회
• GET http://스프링캠프/users/kangwoo
@RequestMapping(value = “/{id}”, method = RequestMethod.GET)
@ResponseBody
public User getUser(Model model, @PathVariable(“id”) String id) {
User user = userService.getUser(id);
return user;
}
XML• 등록
• POST http://스프링캠프/users
@RequestMapping(method = RequestMethod.POST)
@ResponseStatus(HttpStatus.CREATED)
@ResponseBody
public User createUser(@RequestBody User user) {
userService.createUser(user);
User selectedUser = userService.getUser(user.getId());
return user;
}
Content Negotiation
• 하나의 자원에 대해 여러 형태의 Reprentation
• HTTP Request Header : Accept
• application/json -> json
• application/xml -> xml
Content Negotiation
• 고정된 HTTP Header의 Accept 값 (예:웹브라우저)
• PathExtention
• http://스프링캠프/users/kangwoo.xml
• Parameter
• http://스프링캠프/users/kangwoo?format=xml
Content Negotiation• 설정 추가
@Override public void configureContentNegotiation(ContentNegotiationConfigurer configurer) { configurer .useJaf(true) .favorPathExtention(true) .favorParameter(false) .ignoreAcceptHeader(false) .defaultContentType(MediaType.APPLICATION_JSON) .mediaType(“json”, MediaType.APPLICATION_JSON) .mediaType(“xml”, MediaType.APPLICATION_XML); }
HTTP Method Conversion• GET, POST, PUT, DELETE 메소드 • HiddenHttpMethodFilter 클래스
• _method 값을 HTTP Method로 변환
<form method=“post”>
<input type=“hidden” name=“_method” value=“delete”>
<input type=“submit” value=“Delete User”>
</form>
<form:form method=“delete”>
<input type=“submit” value=“Delete User”>
</form:form>
ETag Support
• HTTP 1.1 규약에 추가된 응답 Header
• 웹 서버의 자원이 변경되었는지 확인하는 데 사용
• ETag 값이 동일하다면, 자원이 변경되지 않았음을 의미
• ShallowEtagHeaderFilter
Spring HATEOAS• JAXB / JSON integration
• Linkclass UserResource extends ResourceSupport {
String name;
}
UserResource resource = new UserResource();
resource.name = “kangwoo”;
resource.add(new Link(“http://스프링캠프/users/kangwoo”));
Spring HATEOAS• Link Builder
@Controller @RequestMapping(“users”) class UserController { @RequestMapping(value = “/{id}”, method = RequestMethod.GET) @ResponseBody public UserResource getUser(@PathVariable String id) { … } }
import static org.sfw.hateoas.mvc.ControllerLinkBuilder.*; Link link = linkTo(UserController.class).slash(“kangwoo”).withSelfRel();
Method method = UserController.class.getMethod(“getUser”, String.class); Link link = linkTo(method, “kangwoo”).withSelfRel();
예외처리• @ControllerAdvice
@ControllerAdvice
public class RestResponseEntityExceptionHandler {
@ExceptionHandler(value = {ResourceNotFoundException})
@ResponseStatus(value = HttpStatus.NOT_FOUND)
@ResponseBody
public RestError handleResourceNotFound(ResourceNotFoundException ex) {
return new RestError(“에러 코드”,“해당 자원을 찾을 수 없습니다.”);
}
}
Test• MockMVC@Autowired UserController userController;
…
MockMvc mockMvc =
MockMvcBuilders.standaloneSetup(userController).addFilter(…).build();
…
MockHttpServletRequestBuilder requestBuilder =
MockMvcRequestBuilders.get(“/users/kangwoo”)
.accept(Media.APPLICATION_JSON);
!this.movckMvc.perform(requestBuilder).andDo(print()).andExpect(status().isOk());
Test• JSON : jsonpathMockHttpServletRequestBuilder requestBuilder =
MockMvcRequestBuilders.get(“/users/kangwoo”)
.accept(Media.APPLICATION_JSON);
!this.movckMvc.perform(requestBuilder)
.andDo(print())
.andExpect(status().isOk())
.andExcept(content().contentTypeCompatibleWith(MediaType.APPLICATION_JSO
N)
.andExcept(jsonPath(“$id”, is(“kangwoo”)))
.andExcept(jsonPath(“$name”, is(“강우”)));
Test• XML : xmlpath
MockHttpServletRequestBuilder requestBuilder =
MockMvcRequestBuilders.get(“/users/kangwoo”)
.accept(Media.APPLICATION_XML);
!this.movckMvc.perform(requestBuilder)
.andDo(print())
.andExpect(status().isOk())
.andExcept(content().contentTypeCompatibleWith(MediaType.APPLICATION_XML)
.andExcept(xpath(“/user/id”).string(“kangwoo”))
.andExcept(xpath(“/user/name”).string(“강우”));
RESTful service on the Client
• RestTemplate
• RESTful 서비스 호출과 관련된 메소드를 제공
• HttpMessageConverter
• AsyncRestTemplate (Spring 4.0)
RestTemplate• ResetTemplate methods
String result = restTemplate.getForObject(
“http://스프링캠프/users/{id}”, String. class, “kangwoo”);
User result = restTemplate.getForObject(
“http://스프링캠프/users/{id}”, User. class, “kangwoo”);
HTTP Method RestTemplate Method
DELETE delete
GET getForObject getForEntity
HEAD headForHeaders(String url, String… urlVariables)
OPTIONS optionsForAllow(String url, String… urlVariables)
POST postForLocation(String url, Object request, String… urlVariables) postForObject(String url, Object request,
PUT put(String url, Object request, String…urlVariables)
PATCH and others exchange execute
Async RestTemplateListenableFuture<ResponseEntity<User>> futureEntity = template.getForEntity(
“http://스프링캠프/users/{id}”, User.class, "kangwoo");
!// register a callback
futureEntity.addCallback(new ListenableFutureCallback<ResponseEntity<User>>() {
@Override
public void onSuccess(ResponseEntity<User> entity) {
//...
}
! @Override
public void onFailure(Throwable t) {
//...
}
});
3. 잡담
Not a Protocol
COPECreate Once, Publish Everywhere
감사합니다.