기본 콘텐츠로 건너뛰기

냉장고 가계부 프로젝트 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 3

100자 이내의 짧은 글을 쓸 수 있는 게시판 제공. Dolphin Project에서 가장 메인 서비스는 예적금 시뮬레이터이므로, 다른 기능 구현은 차후로 미뤄뒀지만, 사용자와 소통할 수 있는 최소한의 기능은 제공하는게 맞다는 생각이 들어 아주 단순한 게시판 기능을 제공합니다. 사용자가 글을 쓰려면 로그인을 먼저 해야합니다. 글을 등록 후 삭제할 때 글 작성자를 식별할 수 있어야 하기 때문입니다. 게시판은 Dolphin Frontend Main 페이지에 자리잡았습니다. 사용자가 가장 먼저 만나게 되는 웹페이지이므로 적당하다고 생각합니다. 다음은 로그인을 하기 전 사용자가 볼 수 있는 메인 페이지입니다. 글 상단에는 작성일(MMM-dd-yyyy)과 작성자 고유번호(#numbers)가 노출됩니다. Dolphin 은 네이버 로그인을 사용하기 때문에, 사용자를 식별할 수 있는 정보는 저 고유번호가 됩니다. 하단에는 글 내용이 자리잡습니다. 스크린샷에서는 Hello, world!! 라는 문구가 보이네요. 글은 최대 100자까지 허용합니다. 버튼 두개(Newer, Older) 는 페이징 버튼인데, Newer는 최근페이지로 이동을 하며, Older는 지나간 글을 보는 페이징버튼입니다. 기본 페이지 사이즈는 20개입니다. 오른쪽으로 보이는 글 작성 폼은 현재 로그인 하기 전이므로 textarea 는 disabled 처리되어 있고 Login버튼이 자리잡고 있습니다. 다음은 사용자가 로그인 한 뒤의 메인페이지입니다. 변경된 부분은 사용자 고유번호 뒤에 Remove 버튼이 나타났습니다. 해당 글 작성자가 로그인한 사용자일 경우에만 보이게 됩니다. 오른쪽 글 작성 폼도 이제 활성화 되었습니다. 아주 단순한 Textarea 창과 Submit 버튼이 자리잡고 있습니다. 다음은 작성자가 아닌 다른 사용자가 로그인한 경우 입니다. 사용자 고유번호(#54097272) 옆에 Remove 버튼이...

레거시 코드 활용 전략 - 마이클 C. 페더스

2장. 효과적인 피드백 활용 레거시 코드 변경 알고리즘 변경 지점을 식별한다. 테스트 지점을 찾는다. 의존관계를 깬다. 테스트 루틴을 작성한다. 변경시키고 리팩토링한다. 3장. 감지와 분리 레거시코드를 원자 단위까지 분리하여 변경지점을 식별한다. 의존관계를 가진 객체의 경우 Mock/Fake 객체를 사용하기 위해 인터페이스로 의존성을 깬다. 테스트 루틴을 작성 -> 수정 -> 테스트 성공 -> 리팩토링 단계를 반복한다. 4장. 봉합 자바에서는 클래스패스를 이용한 다른 버전의 클래스를 만들수 있다. 5장. 레거시 코드를 위한 도구 JUnit 6장. 고칠 건 많고 시간은 없고 발아(Sprout) Method / Class: 메서드/클래스를 추가 포장(Wrap) Method / Class: 기존 메서드/클래스를 포장하는 메서드/클래스를 추가(데코레이터 패턴) 7장. 코드 하나 바꾸는데 왜 이리 오래 걸리지? 의존관계 반전 원칙 당신의 코드가 인터페이스에 종속되는 경우, 그 의존관계는 사실 경미한 수준으로 눈에 잘 띄지 않는다. 인터페이스가 변하지 않는 한, 코드를 변경시킬 필요는 없다. 또한 인터페이스들은 그들 아래에 위치한 코드에 비해 훨씬 적은 빈도로 변경된다. 인터페이스를 하나 가지고 있는 경우, 그 인터페이스를 구현하는 클래스들을 편집하거나 그 인터페이스를 구현하기 위한 새로운 클래스들을 추가할 수 있다. 물론 그 인터페이스를 사용하는 코드에 영향을 주지도 않는다. 이런 이유 때문에 구체 클래스보다는 인터페이스나 추상 클래스에 종속되는 편이 좋다. 덜 변하는 것들에 종속됨으로써 특정 변경이 초래할지도 모를 대규모 재컴파일 사태의 위험을 최소화할 수 있다. 8장. 특징, 어떻게 추가할까? 테스트 주도 개발 실패 테스트 케이스를 작성한다. 컴파일되게 만든다. 테스트에 통과하도록 만든다. 중복을 제거한다. 반복한다....

Dolphin 2

별도의 회원가입 없이 소셜 로그인 기능 제공으로 간편한 로그인 가능. Dolphin 프론트엔드는 회원가입 절차가 따로 없고, 간단하게 소셜 로그인 기능을 제공함으로써 회원가입, 인증절차를 생략했습니다. 우선, 간단하게 국내에서 잘 알려진 네이버의 API를 사용합니다. 네이버 개발자센터 웹사이트 에서 네이버 아이디로 로그인 기능을 살펴봅니다. 개발 문서를 자세히 살펴보고 API 신청을 합니다. 애플리케이션의 이름을 정하고 필요한 정보를 필수/선택에 체크합니다. 밑으로 내려보면 로그인 API 서비스 환경 부분에서 환경 추가 셀렉트박스에서 PC 웹을 선택하면 다음과 같은 입력폼이 나타납니다. 서비스 URL은 내 웹애플리케이션의 URL이 될 예정입니다. 지금은 개발상태이므로 localhost를 입력했습니다. Callback URL은 네이버 OAuth 인증 url로 호출하면, 인증절차 후 네이버에서 리다이렉트해줄 url을 뜻합니다. 저는 /naver/login 으로 했습니다. 등록이 완료되면 client-id와 client-secret 값을 제공해줍니다. 이 값을 이용해서 인증처리를 할 수 있습니다. spring.io 웹사이트의 튜토리얼 문서를 보면 Facebook 소셜 로그인 기능에 대한 설명이 자세하게 나와있습니다. 이 부분을 참고합니다. Spring Boot and OAuth2 pom.xml 파일에 의존성을 추가하고 Application 클래스에 @EnableOAuth2Sso 애너테이션을 선언합니다. 튜토리얼대로 application.yaml 파일(application.properties)에 설정 정보를 입력합니다. clientId, clientSecret 값은 네이버 개발자센터에서 받은 대로 입력합니다. accessTokenUri는 네이버의 경우 https://nid.naver.com/oauth2.0/token 입니다. userAuthorizationUri는 네이버의 경우 https://ni...