기본 콘텐츠로 건너뛰기

냉장고 가계부 프로젝트 21

fridge-web 프로젝트의 FridgeCommand 클래스에는 fridge API 서버의 HTTP통신 응답본문에 포함된 foods 컬렉션을 마샬링할 수 있도록 List<FoodCommand> 필드를 추가한다.
반대로, FoodCommand 클래스는 Fridge 필드가 추가되어서 두 클래스의 양방향 관계를 연결한다.
public class FridgeCommand {
    ...
    
    private List<FoodCommand> foods;
    
    // Getter / Setter

    public List<FoodCommand> getFoods() {
        return foods;
    }
    public void setFoods(List<FoodCommand> foods) {
        this.foods = foods;
    }

}

public class FoodCommand {
    ...

    private FridgeCommand fridge;

    // Getter / Setter / Constructor

    public FridgeCommand getFridge() {
        return fridge;
    }
    public void setFridge(FridgeCommand fridge) {
        this.fridge = fridge;
    }

    // toString    
}

Command 객체가 수정되므로 뷰파일들도 수정한다.(UI 관련해서는 github를 참고)
UI 구현이 완료되면 FridgeControllerTests 클래스에 테스트 메서드를 추가한다.
public class FridgeControllerTests extends ControllerBase {
    ...
    
    private FoodCommand food = new FoodCommand("파스퇴르 우유 1.8L", 1, new Date());
    private SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd");
    
    @Test
    public void hasContentsFromFridgesTable() {
        food.setFridge(fridge);
        FoodCommand foodCommand = createFood(food);
        
        browser.get(BASE_URL + "/fridges");
        assertThat(browser.findElement(By.tagName("a")).getText()).isEqualTo(fridge.getNickname());
        
        WebElement table = browser.findElement(By.tagName("table"));
        assertThat(table.isDisplayed()).isTrue();
        
        List<WebElement> tr = table.findElement(By.tagName("tbody")).findElements(By.tagName("tr"));
        assertThat(tr.size()).isEqualTo(1);
        
        List<WebElement> td = tr.get(0).findElements(By.tagName("td"));
        assertThat(td.size()).isEqualTo(3);
        assertThat(td.get(0).getText()).isEqualTo(foodCommand.getName());
        assertThat(td.get(1).getText()).isEqualTo(Integer.toString(foodCommand.getQuantity()));
        assertThat(td.get(2).getText()).isEqualTo(sdf.format(foodCommand.getExpiryDate()));
    }
    
    private FoodCommand createFood(FoodCommand foodCommand) {
        ResponseEntity<FoodCommand> response = restTemplate.postForEntity(CORE_API_URL + "/foods", foodCommand, FoodCommand.class);
        assertThat(response.getStatusCode()).isEqualTo(HttpStatus.CREATED);
        
        FoodCommand food = response.getBody();
        assertThat(food.getId()).isPositive();
        return food;
    }
}

hasContentsFromFridgesTable 메서드는 fridges 뷰페이지에서 생성된 fridge의 nickname과 foods 목록 테이블이 존재하는지 검사한다.
fridge 객체 생성은 setUp메서드에서 실행되므로 추가적으로 작업할 내용은 없다. 생성된 fridge의 식품을 추가하기위해 createFood 메서드를 생성했다. createFood 메서드는 API 서버로 food 객체를 전달한다. 생성이 완료되면 food객체를 리턴한다.
목록 페이지로 브라우져 주소를 입력해서 이동한 뒤 앵커태그의 text가 새로생긴 fridge 객체의 nickname과 동일한지 검사한다.
table태그가 존재하는지 확인한다. foods 컬렉션이 fridge 객체 응답본문에 포함되어 있다면 table태그를 감싸는 div태그가 노출된다.
table태그의 tbody내부에 tr태그의 개수가 1개인지 확인함으로써 등록한 식품의 개수는 1개라는 것을 검사한다.
tr태그 내의 td태그 text는 총 3개이고, 각각 인덱스 순서대로 식품의 이름, 수량, 유통기한을 나타낸다.
해당 테스트를 실행하면 에러가 발생한다.
fridge 프로젝트에서 Food 클래스는 fridge 필드가 @JsonIgnore 애너테이션이 선언되어 있기 때문에 fridge-web 프로젝트에서 fridge객체를 요청바디에 전달해도 마샬링에서 제외되기 때문이다.
이를 위해서는 별도의 Request 전담 DTO 클래스가 필요하다. FoodRequest 클래스를 생성한다.
public class FoodRequest {
    private Long id;
    private String name;
    private Integer quantity;
    private Date expiryDate;
    private Fridge fridge;
    public Long getId() {
        return id;
    }
    public void setId(Long id) {
        this.id = id;
    }
    public String getName() {
        return name;
    }
    public void setName(String name) {
        this.name = name;
    }
    public Integer getQuantity() {
        return quantity;
    }
    public void setQuantity(Integer quantity) {
        this.quantity = quantity;
    }
    public Date getExpiryDate() {
        return expiryDate;
    }
    public void setExpiryDate(Date expiryDate) {
        this.expiryDate = expiryDate;
    }
    public Fridge getFridge() {
        return fridge;
    }
    public void setFridge(Fridge fridge) {
        this.fridge = fridge;
    }
    
    public Food toFood() {
        Food food = new Food(getName(), 
                getQuantity(), 
                getExpiryDate());
        food.setId(getId());
        food.setFridge(getFridge());
        return food;
    }
    
    @Override
    public String toString() {
        return "FoodRequest [id=" + id + ", name=" + name + ", quantity=" + quantity + ", expiryDate=" + expiryDate
                + ", fridge=" + fridge + "]";
    }

}

private 필드와 접근자,수정자로 구성된 DTO이며, 별도로 toFood 메서드를 보유하는데 FoodRequest 객체의 데이터를 새로운 Food 클래스에 담아서 리턴한다.
FoodController 클래스에서 요청바디에 Food를 파라미터로 전달받는 두개의 컨트롤러 메서드(postFood, updateFood)를 FoodRequest로 변경한다.
public class FoodController {
    ...
    @PostMapping
    public ResponseEntity<FoodResource> postFood(@RequestBody final FoodRequest foodRequest) {
        Food newFood = jpaFoodService.save(foodRequest.toFood());
        URI location = MvcUriComponentsBuilder.fromController(getClass())
                .path("/{id}")    
                .buildAndExpand(newFood.getId())
                .toUri();
        return ResponseEntity.created(location).body(assembler.toResource(newFood));
    }
    
    @PutMapping("/{id}")
    public ResponseEntity<?> updateFood(@PathVariable final long id, @RequestBody final FoodRequest foodRequest) {
        if(jpaFoodRepository.findOne(id) != null) {
            jpaFoodService.save(foodRequest.toFood());
        }
        return ResponseEntity.noContent().build();
    }
    ...
}

jpaFoodService.save 메서드의 파라미터로 Food클래스 타입을 받으므로 FoodRequest.toFood 메서드를 호출해서 전달한다.

fridge 프로젝트, fridge-web 프로젝트의 테스트를 수행해서 문제가 없는지 확인한다.
fridge-web 프로젝트에서 FoodControllerTests.fillInFoodRegisterFormAndSubmit
테스트 메서드에서 실패한다.
fridges 뷰페이지에서 식품을 추가할때 fridge의 id를 query 파라미터로 전달하는데, FoodControllerTests 클래스에서는 쿼리스트링도 받지않고, 부모 Fridge 객체가 생성되지 않은 상태로 테스트가 진행되었기 때문이다.
먼저 fillInFoodRegisterFormAndSubmit 메서드에서 브라우져로 등록페이지를 열때 URL 스트링값을 다음과 같이 수정한다.
public class FoodControllerTests extends ControllerBase {
    ...
    @Test
    public void fillInFoodRegisterFormAndSubmit() {
        browser.get(BASE_URL + "/foods/add?fridge.id=1");
        ...
    }
    ...
}

이렇게 해서 테스트하면 fridge API서버에서는 Fridge 데이터가 존재하지 않는다고 에러를 발생한다. 결국 Fridge 객체를 생성하고 그 ID를 전달해야한다. 생성 메서드를 작성한다.
public class FoodControllerTests extends ControllerBase {
    ...
    @Test
    public void fillInFoodRegisterFormAndSubmit() {
        FridgeCommand fridge = createFridge("myFridge");
        browser.get(BASE_URL + "/foods/add?fridge.id=" + fridge.getId());
        
        LocalDateTime expiryDate = LocalDateTime.ofInstant(food.getExpiryDate().toInstant(), ZoneId.systemDefault());
        
        WebElement nameElement = browser.findElement(By.name("name"));
        WebElement quantityElement = browser.findElement(By.name("quantity"));
        WebElement expiryDateElement = browser.findElement(By.name("expiryDate"));
        nameElement.sendKeys(food.getName());
        quantityElement.sendKeys(Integer.toString(food.getQuantity()));
        expiryDateElement.sendKeys(expiryDate.format(DateTimeFormatter.ofPattern("yyyy")));
        expiryDateElement.sendKeys(Keys.TAB);
        expiryDateElement.sendKeys(expiryDate.format(DateTimeFormatter.ofPattern("MMdd")));
        browser.findElementByTagName("form").submit();
        
        WebDriverWait wait = new WebDriverWait(browser, 10);
        wait.until(ExpectedConditions.alertIsPresent());
        
        Alert alert = browser.switchTo().alert();
        assertThat(alert.getText()).isEqualTo("식품을 저장했습니다.");
        alert.accept();
    }
    
    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;
    }
    ...
}

createFridge 메서드는 Fridge 객체를 새로 생성하고 fillInFoodRegisterFormAndSubmit 메서드에서 호출해서 생성된 Fridge의 ID를 쿼리스트링으로 넘겨준다.
이제 다시 전체 테스트를 수행해서 문제가 없는지 확인한다.

테스트가 성공적으로 종료되면 리팩토링 차례다. FridgeControllerTests 클래스에서는 Food객체를 생성하는 메서드가 추가되었고, FoodControllerTests 클래스에서는 Fridge객체를 생성하는 메서드가 추가되었다. 두 메서드를 추상메서드로 옮겨서 중복을 제거한다.
setUp 메서드에서 fridge 더미데이터를 삭제하는 부분도 두 클래스에서 중복되므로 추상메서드로 올린다.
다음은 ControllerBase 추상메서드 소스코드다.
@RunWith(SpringRunner.class)
@SpringBootTest(webEnvironment=WebEnvironment.RANDOM_PORT)
public abstract class ControllerBase {
    ...
    @Before
    public void init() {
        BASE_URL = host + ":" + port;
        restTemplate.delete(CORE_API_URL + "/fridges", Collections.emptyMap());
        setUp();
    }
    
    ...

    protected 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;
    }
    
    protected FoodCommand createFood(FoodCommand foodCommand) {
        ResponseEntity<FoodCommand> response = restTemplate.postForEntity(CORE_API_URL + "/foods", foodCommand, FoodCommand.class);
        assertThat(response.getStatusCode()).isEqualTo(HttpStatus.CREATED);
        
        FoodCommand food = response.getBody();
        assertThat(food.getId()).isPositive();
        return food;
    }

}

createFridge, createFood 메서드를 이동시키고 init 메서드에 더미데이터를 삭제하는 메서드를 옮겼다. FridgeControllerTests 클래스는 다음과 같다. 
public class FridgeControllerTests extends ControllerBase {
    private FridgeCommand fridge;
    
    @Override
    protected void setUp() {
        fridge = createFridge("myFridge");
    }

    ...
    
}

fridge 객체를 생성하는 부분만 setUp 메서드에 남았다. 다음은 FoodControllerTests 클래스다. 
public class FoodControllerTests extends ControllerBase {
    private FoodCommand food;
    private FridgeCommand fridge;
    
    @Override
    protected void setUp() {
        fridge = createFridge("myFridge");
        
        FoodCommand foodCommand = new FoodCommand("파스퇴르 우유 1.8L", 1, new Date());
        foodCommand.setFridge(fridge);
        food = createFood(foodCommand);
    }
    
    ...
        
    @Test
    public void fillInFoodRegisterFormAndSubmit() {
        browser.get(BASE_URL + "/foods/add?fridge.id=" + fridge.getId());
        
        LocalDateTime expiryDate = LocalDateTime.ofInstant(food.getExpiryDate().toInstant(), ZoneId.systemDefault());
        
        WebElement nameElement = browser.findElement(By.name("name"));
        WebElement quantityElement = browser.findElement(By.name("quantity"));
        WebElement expiryDateElement = browser.findElement(By.name("expiryDate"));
        nameElement.sendKeys(food.getName());
        quantityElement.sendKeys(Integer.toString(food.getQuantity()));
        expiryDateElement.sendKeys(expiryDate.format(DateTimeFormatter.ofPattern("yyyy")));
        expiryDateElement.sendKeys(Keys.TAB);
        expiryDateElement.sendKeys(expiryDate.format(DateTimeFormatter.ofPattern("MMdd")));
        browser.findElementByTagName("form").submit();
        
        WebDriverWait wait = new WebDriverWait(browser, 10);
        wait.until(ExpectedConditions.alertIsPresent());
        
        Alert alert = browser.switchTo().alert();
        assertThat(alert.getText()).isEqualTo("식품을 저장했습니다.");
        alert.accept();
    }
    
    @Test
    public void clickAnchorTagFromFood() {
        Long id = food.getId();
        
        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);
    }
    
    ...
    
}

setUp 메서드에서 fridge 객체를 생성하고 food 객체도 생성하는 메서드 파라미터로 전달한다. 다른 테스트 메서드들은 생성된 food 객체 픽스처를 바로 사용한다.
테스트를 수행해서 문제가 없는지 확인한다.

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

이 블로그의 인기 게시물

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 의존라이브러리도 다른곳에서는 사용하지 않으므로 정리한다. 식품에 대한 최소한의 기능은 구현하였다. 이번에는 냉장고 라는 개념을 모델링한다. 식품들이 들어가고 나가는 곳은 냉장고이기 때문에 냉장고라는...
자세한 내용 보기