기본 콘텐츠로 건너뛰기

냉장고 가계부 프로젝트 20

Bootstrap UI를 적용해서 소스를 github로 올렸다.(UI는 변경가능성이 높기때문에 설명은 생략)
fridge-web 프로젝트의 테스트 클래스 FoodControllerTests, FridgeControllerTests 클래스에서 리팩토링을 한다.
API 서버의 URL을 표현하는 FOOD_API_URL, FRIDGE_API_URL 은 ControllerBase 추상클래스로 옮기고 변수명을 CORE_API_URL로 변경한다. RestTemplate 인스턴스도 자식클래스에서 동일하게 쓰이므로 추상클래스로 올린다.
FoodControllerTests 클래스에서 Food 객체가 동일하게 반복되므로 픽스처로 만든다.
FridgeControllerTests 클래스에서 Fridge 객체는 createFridge메서드를 이용해서 만든다.
ControllerBase 추상클래스는 다음의 코드가 추가되었다.
@Autowired
protected RestTemplate restTemplate;
    
protected static final String CORE_API_URL = "http://localhost:8081";

FoodControllerTests, FridgeControllerTests 클래스는 다음과 같이 변경되었다.
public class FoodControllerTests extends ControllerBase {
    private FoodCommand food = new FoodCommand("파스퇴르 우유 1.8L", 1, new Date());
    
    @Override
    protected void setUp() {
        restTemplate.delete(CORE_API_URL + "/foods", Collections.emptyMap());
    }

    ...

    @Test
    public void clickAnchorTagFromFood() {
        Long id = registrationFood(food);
        
        browser.get(BASE_URL + "/foods");
        
        String viewPageUrl = BASE_URL + "/foods/" + id;
        
        List<WebElement> anchors = browser.findElementsByLinkText(food.getName());
        assertThat(anchors).filteredOn(new Condition<WebElement>() {
            @Override
            public boolean matches(WebElement element) {
                return element.getAttribute("href").equals(viewPageUrl);
            }
        });
        
        WebElement anchorTag = anchors.stream()
                .filter(element -> element.getAttribute("href").equals(viewPageUrl))
                .findAny()
                .orElse(null);
        
        anchorTag.click();
        
        assertThat(browser.getCurrentUrl()).isEqualTo(viewPageUrl);
    }

    ...
}

public class FridgeControllerTests extends ControllerBase {
    private FridgeCommand fridge;
    
    @Override
    protected void setUp() {
        restTemplate.delete(CORE_API_URL + "/fridges", Collections.emptyMap());
        fridge = createFridge("myFridge");
    }
    
    private FridgeCommand createFridge(String nickname) {
        ResponseEntity<FridgeCommand> response = restTemplate.postForEntity(CORE_API_URL + "/fridges", nickname, FridgeCommand.class);
        assertThat(response.getStatusCode()).isEqualTo(HttpStatus.CREATED);
        FridgeCommand fridge = response.getBody();
        assertThat(fridge.getId()).isPositive();
        return fridge;
    }

    ...

    @Test
    public void clickDeleteFridgeButton() {
        browser.get(BASE_URL + "/fridges/" + fridge.getId());
        
        WebElement deleteBtn = browser.findElement(By.linkText("삭제"));
        assertThat(deleteBtn.getAttribute("href")).isEqualTo(BASE_URL + "/fridges/delete/" + fridge.getId());
        deleteBtn.click();
        
        WebDriverWait wait = new WebDriverWait(browser, 10);
        wait.until(ExpectedConditions.alertIsPresent());
        Alert alert = browser.switchTo().alert();
        assertThat(alert.getText()).isEqualTo("삭제했습니다.");
        alert.accept();
        
        ResponseEntity<FridgeCommand> response = restTemplate.getForEntity(CORE_API_URL + "/fridges/" + fridge.getId(), FridgeCommand.class);
        assertThat(response.getStatusCode()).isEqualTo(HttpStatus.NO_CONTENT);
    }
}

정리가 다 끝나면 테스트를 실행해서 문제가 없는지 확인한다.

Fridge 객체는 냉장고를 표현하는 모델인데, 냉장고는 식품을 보관하는 저장소이다. 따라서, 가계부에 등록한 식품들은 냉장고에 보관되어 있다는 전제조건이 있다. 이 부분을 표현려면 Fridge 객체는 멤버변수로 Food 의 컬렉션을 가지면 된다.
FridgeTests 테스트 클래스는 다음과 같다.

public class FridgeTests {
    
    ...
    
    @Test
    public void newFridgeWithFoods() {
        String nickname = "myFridge";
        List<Food> foods = Arrays.asList(new Food("파스퇴르 우유 1.8L", 1, new Date()));
        Fridge fridge = new Fridge(nickname, foods);
        assertThat(fridge.getFoods()).containsOnlyElementsOf(foods);
        assertThat(fridge.hasFood()).isTrue();
        assertThat(fridge.getFoods().size()).isEqualTo(1);
        
        Food coke = new Food("코카콜라 500mL", 2, new Date());
        fridge.addFood(coke);
        assertThat(fridge.getFoods().size()).isGreaterThanOrEqualTo(2);
        assertThat(fridge.getFoods()).contains(coke);

        fridge.removeFood(coke);
        assertThat(fridge.getFoods().size()).isEqualTo(1);
        assertThat(fridge.getFoods()).containsOnlyElementsOf(foods);
    }

}

newFridgeWithFoods 메서드는 Fridge객체를 생성하는데 생성자에 Food 컬렉션을 두번째 파라미터로 전달한다. 그리고, getFoods, hasFood, addFood, removeFood 4개의 새로운 fridge 메서드가 호출된다. 간단한 테스트이므로 바로 모델객체를 구현하고 테스트를 수행한다.
@Entity
public class Fridge {
    @Id
    @GeneratedValue(strategy=GenerationType.IDENTITY)
    private Integer id;
    private String nickname;
    private List<Food> foods = new ArrayList<>();
    
    protected Fridge() {}
    
    public Fridge(String nickname) {
        this(nickname, Collections.emptyList());
    }
    
    public Fridge(String nickname, List<Food> foods) {
        this.nickname = nickname;
        this.foods.addAll(foods);
    }

    public Integer getId() {
        return id;
    }
    
    public void setId(Integer id) {
        this.id = id;
    }
    
    public String getNickname() {
        return nickname;
    }

    public List<Food> getFoods() {
        return foods;
    }

    public boolean hasFood() {
        return !foods.isEmpty();
    }

    public void addFood(Food food) {
        this.foods.add(food);
    }

    public void removeFood(Food food) {
        this.foods.remove(food);
    }
    
}

foods 컬렉션 멤버변수를 작성하고, 생성자 오버로드로 foods 멤버변수를 할당하는 코드가 있다.

Fridge클래스를 관계형 데이터베이스로 모델링하려면 Fridge테이블과 Food테이블 간의 관계를 나타낼 컬럼 또는 테이블이 필요하다. 두 테이블을 참조할 식별자 컬럼만 존재하는 매핑테이블을 별도로 생성할 수도 있고, 자식테이블에 부모 식별키를 참조키로 하는 컬럼추가 방식을 사용할 수도 있다.
여기서는 자식테이블(food)에 부모테이블 식별자(fridge_id) 컬럼을 생성해서 사용한다.

다음은 테이블 생성 스키마다.
CREATE TABLE food (
    id BIGINT GENERATED BY DEFAULT AS IDENTITY(START WITH 1, INCREMENT BY 1) PRIMARY KEY,
    fridge_id INTEGER,
    name VARCHAR(32) NOT NULL,
    quantity INTEGER DEFAULT 0 NOT NULL,
    expiry_date DATE
);

food 테이블에 fridge_id 컬럼을 추가한다. 하이버네이트의 연관 설정 API를 사용해서 Fridge 모델의 Food 컬렉션이 영속성 관리를 받을 수 있도록 한다.
public class Fridge {
    // Variables/Constructors

    @JsonIgnore
    @OneToMany(mappedBy = "fridge", cascade = CascadeType.ALL, orphanRemoval = true)
    private List<Food> foods = new ArrayList<>();

    // Get/Set
    
    public void addFood(Food food) {
        this.foods.add(food);
        food.setFridge(this);
    }

    public void removeFood(Food food) {
        this.foods.remove(food);
        food.setFridge(null);
    }
}

@OneToMany 애너테이션을 foods멤버변수에 선언한다. @JsonIgnore 애너테이션을 선언해서 모델이 JSON형태로 표현 될 경우 foods 필드는 파싱에서 제외시킨다.
mappedBy 값은 fridge 문자열로 입력한다. fridge는 양방향 연결을 위해서 mappedBy 값에 관계를 맺을 클래스의 필드명이다.
cascade 값은 CascadeType Enum값으로 상태변화에 따른 전파유형을 나타낸다. ALL로 설정했으므로 모든 상태변경을 전파한다.
orphanRemoval 은 링크테이블(매핑테이블)에 부모가 삭제될경우 자식들도 삭제할것인지 여부를 나타낸다.
addFood 메서드에서 foods 컬렉션에 food 객체를 add한 후에 food 객체의 setFridge 메서드에 Fridge 인스턴스를 파라미터로 전달한다.
removeFood 메서드에서 foods 컬렉션에 remove메서드를 실행한 후 해당 food객체의 setFridge 메서드에 null을 전달한다.
Fridge클래스와 Food클래스의 양방향 관계를 설정할 때는, 유틸리티 메서드들(addFood, removeFood)에 항상 싱크를 맞춰주어야한다.
다음은 FridgeControllerTests 클래스이다. 
@RunWith(SpringRunner.class)
@WebMvcTest(FridgeController.class)
public class FridgeControllerTests {
    ...
    @Before
    public void setUp() {
        myFridge = new Fridge("myFridge");
        myFridge.setId(ID);
        myFridge.addFood(new Food("파스퇴르 우유 1.8L", 1, new Date()));
    }
    ...
    private void verifyResultActions(final ResultActions resultAction) throws Exception {
        resultAction.andExpect(jsonPath("nickname", equalTo(myFridge.getNickname())));
        resultAction.andExpect(jsonPath("foods[0].name", equalTo(myFridge.getFoods().get(0).getName())));
        resultAction.andExpect(jsonPath("foods[0].quantity", equalTo(myFridge.getFoods().get(0).getQuantity())));
        resultAction.andExpect(jsonPath("foods[0].expiryDate", equalTo(myFridge.getFoods().get(0).getExpiryDate().getTime())));
    }
    ...
    @Test
    public void findAllFridges() throws Exception {
        List<Fridge> fridges = Arrays.asList(myFridge);
        given(fridgeRepository.findAll()).willReturn(fridges);
        
        final ResultActions result = mvc.perform(get("/fridges").accept(MediaType.APPLICATION_JSON_UTF8));
        result.andExpect(status().isOk())
            .andExpect(content().contentType(MediaType.APPLICATION_JSON_UTF8))
            .andExpect(jsonPath("_links.self.href", equalTo(BASE_PATH + "/fridges")))
            .andExpect(jsonPath("_embedded.fridgeResourceList[0].id", equalTo(myFridge.getId().intValue())))
            .andExpect(jsonPath("_embedded.fridgeResourceList[0].nickname", equalTo(myFridge.getNickname())))
            .andExpect(jsonPath("_embedded.fridgeResourceList[0].foods[0].name", equalTo(myFridge.getFoods().get(0).getName())))
            .andExpect(jsonPath("_embedded.fridgeResourceList[0].foods[0].quantity", equalTo(myFridge.getFoods().get(0).getQuantity())))
            .andExpect(jsonPath("_embedded.fridgeResourceList[0].foods[0].expiryDate", equalTo(myFridge.getFoods().get(0).getExpiryDate().getTime())))
            .andExpect(jsonPath("_embedded.fridgeResourceList[0]._links.self.href", equalTo(BASE_PATH + "/fridges/" + myFridge.getId().intValue())));
    }
    ...
}

setUp 메서드의 myFridge 객체 생성 후 addFood 메서드를 추가한다. 그리고 verifyResultActions 메서드에서 응답 본문의 json 값에 foods 컬렉션을 검증하는 부분을 추가한다.
findAllFridges 메서드에서도 마찬가지로 fridge 컬렉션에 foods 컬렉션이 같이 전달된다.
실제로 Fridge 컨트롤러에서 응답본문을 생성하는 클래스는 FridgeResource와 FridgeResourceAssembler 이므로 두 클래스에서 Food 컬렉션 필드를 추가한다.
public class FridgeResource extends ResourceSupport {
    @JsonProperty
    Integer id;
    @JsonProperty
    String nickname;
    @JsonProperty
    List<Food> foods;
}

FridgeResource 클래스는 Food 컬렉션을 추가한다. 
public class FridgeResourceAssembler extends ResourceAssemblerSupport<Fridge, FridgeResource> {

    ...

    @Override
    public FridgeResource toResource(Fridge fridge) {
        FridgeResource resource = new FridgeResource();
        resource.id = fridge.getId();
        resource.nickname = fridge.getNickname();
        resource.foods = fridge.getFoods();
        resource.add(linkTo(FridgeController.class).slash(resource.id).withSelfRel());
        return resource;
    }

}

FridgeResourceAssembler 클래스에 toResource 메서드에서 fridge 객체의 Food컬렉션을 FoodResource 객체에 할당한다.
양방향 연관관계이므로 Food 엔티티에도 Fridge 객체를 가진다. 다음 소스코드는 수정한 Food 클래스이다. 
@Entity(name="food")
public class Food {
    @Id
    @GeneratedValue(strategy=GenerationType.IDENTITY)
    private Long id;
    
    @ManyToOne
    @JsonIgnore
    private Fridge fridge;
    
    ...
    public Fridge getFridge() {
        return fridge;
    }

    public void setFridge(Fridge fridge) {
        this.fridge = fridge;
    }

    ...

}

@ManyToOne 애너테이션을 fridge 멤버변수에 선언한다. @JsonIgnore 애너테이션도 앞에서 설명한것처럼 Json 파싱에서 제외하기 위해서 선언한다. Getter/Setter도 생성한다.
다음은 FoodControllerTests 클래스이다. 
@RunWith(SpringRunner.class)
@WebMvcTest(FoodController.class)
public class FoodControllerTests {
    ...
    @Before
    public void setUp() throws ParseException {
        milk = new Food("파스퇴르 우유 1.8L", 1, sdf.parse("2018-09-28"));
        milk.setId(ID);
        milk.setFridge(new Fridge("myFridge"));
    }

    @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().getTime())))
            .andExpect(jsonPath("_embedded.foodResourceList[0].fridge.nickname", equalTo(milk.getFridge().getNickname())))
            .andExpect(jsonPath("_embedded.foodResourceList[0]._links.self.href", equalTo(BASE_PATH + "/foods/" + milk.getId().intValue())));
    }
    ...
    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().getTime())))
            .andExpect(jsonPath("_links.self.href", equalTo(BASE_PATH + "/foods/" + milk.getId())))
            .andExpect(jsonPath("fridge.nickname", equalTo(milk.getFridge().getNickname())));
    }
}

setUp 메서드에서 Fridge 더미객체를 setFridge 메서드로 전달한다. FridgeControllerTests 클래스와 동일한 방식으로 응답본문에 fridge 가 같이 넘어오는지 검증한다.
FoodResource, FoodResourceAssembler 클래스도 Fridge 프로퍼티를 가지도록 수정한다.
public class FoodResource extends ResourceSupport {
    @JsonProperty
    long id;
    @JsonProperty
    String name;
    @JsonProperty
    int quantity;
    @JsonProperty
    Date expiryDate;
    @JsonProperty
    Fridge fridge; 
}

public class FoodResourceAssembler extends ResourceAssemblerSupport<Food, FoodResource> {

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

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

FoodControllerTests 클래스의 테스트를 실행하면 postFood 테스트 메서드가 실패한다.
fridge가 응답본문에 없다고 하는데 이부분은 Food 파라미터로 전달할때 final 로 불변객체이기 때문에 save 메서드의 리턴되는 Food객체를 응답본문에 실어주도록 수정한다.
    @PostMapping
    public ResponseEntity<FoodResource> postFood(@RequestBody final Food food) {
        Food newFood = jpaFoodService.save(food);
        URI location = MvcUriComponentsBuilder.fromController(getClass())
                .path("/{id}")    
                .buildAndExpand(newFood.getId())
                .toUri();
        return ResponseEntity.created(location).body(assembler.toResource(newFood));
    }

수정이 완료되면 전체 테스트를 수행해서 오류가 없는지 확인한다.

이전글: 냉장고 가계부 프로젝트 19
다음글: 냉장고 가계부 프로젝트 21
라벨:

이 블로그의 인기 게시물

Dolphin 1

금융감독원 OPEN API를 사용하여 데이터 수집 금융감독원 금융상품통합비교공시 사이트에서 제공하는 OPEN API 를 사용합니다. 먼저, API 키를 신청합니다. https://finlife.fss.or.kr/PageLink.do?link=openapi/certification&menuId=2000119  로 접속합니다. 약관에 동의하고 본인인증 후, 신상정보를 넘기면 바로 API 키를 받을 수 있습니다. 상세 및 테스트 페이지를 들어가보면 요청 파라미터와 응답 API 형태를 확인할 수 있습니다. 요청은 다음과 같습니다. 읽어보면 서비스 명에 따라 url이 달라지는 부분을 제외하면 요청 URL은 크게 달라지지 않습니다. 파라미터에 인증키, 권역코드, 페이지번호를 전달하면 됩니다. 응답부분은 서비스마다 다르지만 공통 응답 형태는 다음과 같습니다. 에러코드, 에러메시지, 전체 개수, 전체 페이지, 현재 페이지 번호 입니다. 예금상품 조회 서비스나 적금상품 조회 서비스의 경우 공통적으로 금융회사 코드와 이름을 전달해주는데 해당 금융회사의 상세한 정보를 보려면 금융회사 조회 서비스도 호출하는게 나중에 좋을것 같습니다. Spring으로 HTTP 통신을 위해서 Apache HttpComponent 라이브러리를 사용합니다. 메이븐에 다음과 같이 의존성을 추가합니다. <dependency> <groupId>org.apache.httpcomponents</groupId> <artifactId>httpclient</artifactId> </dependency> 다음은 API를 호출하는 간단한 소스코드 조각입니다. CloseableHttpClient httpClient = HttpClients.createDefault(); URI uri = new URIBuilder() .setScheme("http") .setHos...
자세한 내용 보기

Effective Java

생성자 대신 정적 팩터리 메서드를 사용할 수 없는지 생각해 보라 생성자 인자가 많을 때는 Builder 패턴 적용을 고려하라 private 생성자나 enum 자료형은 싱글턴 패턴을 따르도록 설계하라 객체 생성을 막을 때는 private 생성자를 사용하라 불필요한 객체는 만들지 말라 유효기간이 지난 객체 참조는 폐기하라 종료자 사용을 피하라 equals를 재정의할 때는 일반 규약을 따르라 equals를 재정의할 때는 반드시 hashCode도 재정의하라 toString은 항상 재정의하라 clone을 재정의할 때는 신중하라 Comparable 구현을 고려하라 클래스와 멤버의 접근 권한은 최소화하라 public 클래스 안에는 public 필드를 두지 말고 접근자 메서드를 사용하라 변경 가능성을 최소화하라 계승하는 대신 구성하라 계승을 위한 설계와 문서를 갖추거나, 그럴 수 없다면 계승을 금지하라 추상 클래스 대신 인터페이스를 사용하라 인터페이스는 자료형을 정의할 때만 사용하라 태그 달린 클래스 대신 클래스 계층을 활용하라 전략을 표현하고 싶을 때는 함수 객체를 사용하라 멤버 클래스는 가능하면 static으로 선언하라 새 코드에는 무인자 제네릭 자료형을 사용하지 마라 무점검 경고(unchecked warning)를 제거하라 배열 대신 리스트를 써라 가능하면 제네릭 자료형으로 만들 것 가능하면 제네릭 메서드로 만들 것 한정적 와일드카드를 써서 API 유연성을 높여라 형 안전 다형성 컨테이너를 쓰면 어떨지 따져보라 int 상수 대신 enum을 사용하라 ordinal 대신 객체 필드를 사용하라 비트 필드(bit field) 대신 EnumSet을 사용하라 ordinal을 배열 첨자로 사용하는 대신 EnumMap을 이용하라 확장 가능한 enum을 만들어야 한다면 인터페이스를 이용하라 작명 패턴 대신 어노테이션을 사용하라 Override 어노테이션은 일관되게 사용하라 자료형을 정의할 때 표식 인터페이스를 사용하라...
자세한 내용 보기

냉장고 가계부 프로젝트 14

fridge-web 프로젝트에서 api 서버와 통신할때 URL을 매번 중복해서 입력하는 부분을 제거하기 위해 RestTemplate 빈 등록메서드를 수정한다. @Bean public RestTemplate restTemplate(RestTemplateBuilder builder) { return builder.rootUri("http://localhost:8081").build(); } builder에 rootUri 메서드를 호출해서 api 서버 url을 미리 설정하고 build해서 RestTemplate 객체를 반환하면 RestTemplate을 사용하는 부분에서는 root 다음 경로만 넘겨주면 된다. WebFoodController 클래스의 restTemplate 사용부분을 전부 수정한다. @GetMapping public String foods(Model model) { ResponseEntity<Resources<FoodCommand>> response = restTemplate.exchange("/foods", HttpMethod.GET, null, new ParameterizedTypeReference<Resources<FoodCommand>>() {}, Collections.emptyMap()); .... 다른 메서드들도 동일하게 수정한다. Food 클래스에서도 이제 더이상 사용하지 않는 Cloneable과 hashCode, equals 메서드를 정리한다. Guava 의존라이브러리도 다른곳에서는 사용하지 않으므로 정리한다. 식품에 대한 최소한의 기능은 구현하였다. 이번에는 냉장고 라는 개념을 모델링한다. 식품들이 들어가고 나가는 곳은 냉장고이기 때문에 냉장고라는...
자세한 내용 보기