냉장고 가계부 프로젝트 8

FoodController의 메서드들은 요청 HTTP 방식으로 매핑하며, 응답결과에 HTTP상태코드와 본문을 실어서 보내는 방식을 사용하고 있다.
Spring HATEOAS는 이 응답결과에 서버에 요청을 할 수 있는 URI를 같이 보내주어 클라이언트에서는 정적인 URI를 이용하여 통신을 하지않고, 동적으로 서버에 접근할 수 있다.
서버에서 URI를 제공한다면 클라이언트가 정적으로 서버의 자원에 접근할 때 사용할 URI 들을 가지고 있지 않아도 된다.
Spring HATEOAS 모듈을 사용해서 FoodController를 리팩토링 한다.

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-hateoas</artifactId>
</dependency>

pom.xml 파일에서 spring-boot-starter-web dependency를 위와 같이 변경한다.
Food 클래스의 형태만 베낀 데이터 전달용 객체(DTO, Data Transfer Object)를 작성한다.

package com.poseidon.fridge.model;

import org.springframework.hateoas.ResourceSupport;

import com.fasterxml.jackson.annotation.JsonProperty;

public class FoodResource extends ResourceSupport {
    @JsonProperty
    long id;
    @JsonProperty
    String name;
    @JsonProperty
    int quantity;
    @JsonProperty
    String expiryDate;
    
}

ResourceSupport 클래스를 서브클래스로 하는 FoodResource 클래스를 작성한다. 멤버변수들은 전부 Food 클래스와 동일하다. 다만, 멤버변수에 @JsonProperty 애너테이션이 선언되어 있다.
Json 애너테이션들은 JSON으로 마샬링되는 마크들이다. @JsonProperty 애너테이션은 json 으로 마샬링될때 사용할 수 있는 키 값을 @JsonProperty("id") 이런식으로 표현해 줄 수도 있다.
없으면 기본적으로 변수명을 사용한다.

HATEOAS 모듈에서 기본 클래스를 ResourceSupport 클래스로 자동 객체 생성해주는 기능을 지원하는 ResourceAssemblerSupport 추상클래스를 상속받아서 Food 객체를 FoodResource 객체로 전환하는 Assembler 클래스를 작성한다.

package com.poseidon.fridge.model;

import static org.springframework.hateoas.mvc.ControllerLinkBuilder.linkTo;

import org.springframework.hateoas.mvc.ResourceAssemblerSupport;

import com.poseidon.fridge.controller.FoodController;

public class FoodResourceAssembler extends ResourceAssemblerSupport<Food, FoodResource> {

    public FoodResourceAssembler() {
        super(FoodController.class, FoodResource.class);
    }

    @Override
    public FoodResource toResource(Food food) {
        FoodResource foodResource = new FoodResource();
        foodResource.id = food.getId();
        foodResource.name = food.getName();
        foodResource.quantity = food.getQuantity();
        foodResource.expiryDate = food.getExpiryDate();
        foodResource.add(linkTo(FoodController.class).slash(foodResource.id).withSelfRel());
        return foodResource;
    }
    
}

생성자에서는 컨트롤러 클래스와 Resource 클래스를 파라미터로 전달받는 ResourceAssemblerSupport 클래스의 생성자를 호출한다. 컨트롤러를 입력받는 이유는 ResourceAssemblerSupport 클래스에 createResourceWithId 메서드에서 self 링크를 생성하는데 클래스가 필요하고, instantiateResource 메서드가 reflection으로 resource 클래스를 생성해 주기위해 resource 클래스가 사용되기 때문이다.

Food 객체에 접근자를 이용해서 FoodResource 객체에 멤버변수들을 대입해준다.
FoodResource 인스턴스에 add 메서드는 ResourceSupport 클래스 메서드이다. link를 추가하는 기능이다. linkTo 정적 메서드는 org.springframework.hateoas.mvc.ControllerLinkBuilder 클래스에 선언되어 있다. linkTo 메서드에 컨트롤러 클래스를 전달하고 slash 메서드에 id 값을 전달하면 컨트롤러 클래스에 선언된 RequestMapping URL에 /{id} 형식의 링크를 만들어준다. withSelfRel 메서드는 self 라는 관계를 마킹해주는 메서드이다.

FoodControllerTests 클래스의 findById 메서드를 먼저 수정한다. 변경되는 부분은 응답결과로 전달되는 본문의 내용에서 ResouceSupport 클래스의 link 값들이 추가되므로, 이 부분을 테스트하는 것이다.
다음은 findById 테스트 메서드의 수정 소스코드이다.

    private static final String BASE_PATH = "http://localhost";
    
    @Test
    public void findById() throws Exception {
        given(jpaFoodRepository.findOne(ID)).willReturn(milk);
        final ResultActions result = mvc.perform(get("/foods/" + ID));
        result.andExpect(status().isOk());
        verifyResultContent(result);
    }
    
    private void verifyResultContent(final ResultActions result) throws Exception {
        result
            .andExpect(jsonPath("id", equalTo(milk.getId().intValue())))
            .andExpect(jsonPath("name", equalTo(milk.getName())))
            .andExpect(jsonPath("quantity", equalTo(milk.getQuantity())))
            .andExpect(jsonPath("expiryDate", equalTo(milk.getExpiryDate())))
            .andExpect(jsonPath("_links.self.href", equalTo(BASE_PATH + "/foods/" + milk.getId())));
    }

MockMvc 의 perform 결과를 따로 변수를 선언해서 대입한다. 응답상태코드가 200 ok 인지 확인하고 따로 메서드로 추출한 verifyResultContent 메서드를 호출해서 나머지 검증을 한다.
따로 메서드를 추출한 이유는 검증로직이 다른 테스트 메서드에서도 쓰이게 될 가능성이 높기 때문이다.
verifyResultContent 메서드에서는 jsonPath 정적 메서드를 이용해서 응답결과로 받게된 json 내용을 테스트한다. id 라는 키값은 milk 인스턴스의 id 값의 int 형변환 값과 동일함을 검증한다.
마지막 검증메서드의 json 키값이 _links.self.href는 추가로 HATEOAS 의 클래스를 사용하여 FoodResource 객체에 추가된 link 값들이다.
Link 값에서 self는 요청된 리소스 자신을 뜻하고 href는 링크값을 나타내는 키이다.
값으로는 http://localhost/foods/1 전체 URL이 반환된다.

FoodController 의 수정된 부분을 확인한다.

    FoodResourceAssembler assembler = new FoodResourceAssembler();

    @GetMapping("/{id}")
    public ResponseEntity<FoodResource> findById(@PathVariable final long id) {
        Food food = jpaFoodRepository.findOne(id);
        if(food == null) {
            return ResponseEntity.notFound().build();
        }
        return ResponseEntity.ok(assembler.toResource(food));
    }

메서드 리턴 타입이 ResponseEntity<Food> 에서 ResponseEntity<FoodResource> 로 수정되었다.
repository 로 부터 리턴된 Food 객체를 assembler 를 이용해서 FoodResource 클래스로 변환하고 ResponseEntity에 ok 정적메서드로 HTTP 상태코드를 전달하면서 본문을 넘기고 있다.

findAllFoods 테스트 메서드도 수정한다.

    @Test
    public void findAllFoods() throws Exception {
        List<Food> foods = Arrays.asList(milk);
        given(jpaFoodRepository.findAll()).willReturn(foods);
        
        final ResultActions result = mvc.perform(get("/foods").accept(MediaType.APPLICATION_JSON_UTF8));
        result.andExpect(status().isOk())
            .andExpect(content().contentType(MediaType.APPLICATION_JSON_UTF8))
            .andExpect(jsonPath("_links.self.href", equalTo(BASE_PATH + "/foods")))
            .andExpect(jsonPath("_embedded.foodResourceList[0].id", equalTo(milk.getId().intValue())))
            .andExpect(jsonPath("_embedded.foodResourceList[0].name", equalTo(milk.getName())))
            .andExpect(jsonPath("_embedded.foodResourceList[0].quantity", equalTo(milk.getQuantity())))
            .andExpect(jsonPath("_embedded.foodResourceList[0].expiryDate", equalTo(milk.getExpiryDate())))
            .andExpect(jsonPath("_embedded.foodResourceList[0]._links.self.href", equalTo(BASE_PATH + "/foods/" + milk.getId().intValue())));
    }

verifyResultContent 메서드의 내용과 비슷하게 응답결과의 json에 대한 검증을 하고 있다.
json 루트의 _links 링크 값은 요청한 URI인 /foods URI와 동일하다. findAllFoods 컨트롤러 메서드의 응답은 Food 의 List 형태로 응답되므로, 요청 link 값과 리스트값으로 응답한다.
_embedded 키 값은 Resources 클래스에서 생성하는데 Resources는 HATEOAS 모듈의 클래스로 Collection Entity 값을 쉽게 생성해주는 헬퍼 클래스다.
foodResourceList 키 값은 Resources 클래스의 제네릭으로 FoodResource 클래스를 선언해서 자동으로 생성되는 키값이다.

FoodController 클래스의 findAllFoods 메서드를 구현한다.

    @GetMapping
    public ResponseEntity<Resources<FoodResource>> findAllFoods() {
        List<Food> foods = jpaFoodRepository.findAll();
        if(foods.isEmpty()) {
            return ResponseEntity.notFound().build();
        }
        
        List<FoodResource> foodResources = assembler.toResources(foods);
        Link link = linkTo(methodOn(FoodController.class).findAllFoods()).withSelfRel();
        Resources<FoodResource> resources = new Resources<>(foodResources, link);
        return ResponseEntity.ok(resources);
    }

assembler 에서 제공하는 toResources 메서드를 이용하면 Collection 타입의 source를 Resource 로 변환하여 List 형태로 제공해준다.
다음으로, Link 변수를 선언하여 findAllFoods 메서드의 link값도 생성한다.
Resources 클래스에 생성자로 Resource List 와 Link 를 전달하면 findAllFoods 테스트 메서드의 검증처럼 작성된다.

이전글: 냉장고 가계부 프로젝트 7
다음글: 냉장고 가계부 프로젝트 9