목록표에 식품을 추가, 삭제, 수정 할 수 있다.FoodTests에서 목록표를 가져오는 기능을 테스트한다. 테스트 메서드명은 foodList라고 정한다.
@Test
public void foodList() {
}
목록표는 ArrayList로 구현한다. ArrayList를 멤버변수로 가지는 MemoryFoodService 객체를 생성하고, 목록을 가져오는 메서드인 findAll을 테스트해본다.
@Test
public void foodList() {
MemoryFoodService memoryFoodService = new MemoryFoodService();
List<Food> foods = memoryFoodService.findAll();
assertThat(foods.size(), equalTo(0));
}
아직 MemoryFoodService 클래스도 없고, findAll메서드도 없으므로, 컴파일 에러가 난다. 냉장고 가계부 프로젝트 1, 2편에서 보폭을 작게 가져갔다면 이젠 조금 빠르게 진행해도 될것같다. 만약 신호등이 빨간불로 바뀐다면 그때가서 보폭을 줄이면 된다.
바로 구현하고 테스트한다.
package com.poseidon.fridge;
import java.util.ArrayList;
import java.util.List;
public class MemoryFoodService {
private List<Food> foods = new ArrayList<>();
public List<Food> findAll() {
return foods;
}
}
MemoryFoodService 클래스는 foods 라는 멤버변수를 가지고, findAll 메서드가 있다. findAll메서드는 foods 멤버변수를 반환한다. 이제 테스트는 성공한다.
목록표는 구현했으니, 추가 기능을 테스트한다. 추가기능은 수정기능과 통합할 수 있다. 추가하려는 식품이 목록표에 없으면 추가하고, 이미 존재하는 경우 수정하면된다.
메서드명은 save로 정하고, 파라미터는 Food 인스턴스를 받는다. 리턴은 저장된 Food 객체를 돌려준다.
테스트를 작성하고, MemoryFoodService 클래스도 수정한다.
@Test
public void foodList() {
MemoryFoodService memoryFoodService = new MemoryFoodService();
List<Food> foods = memoryFoodService.findAll();
assertThat(foods.size(), equalTo(0));
memoryFoodService.save(milk);
foods = memoryFoodService.findAll();
assertThat(foods.contains(milk), equalTo(true));
Food sameMilk = new Food("파스퇴르 우유 1.8L", 1, "2018-09-28");
memoryFoodService.save(sameMilk);
foods = memoryFoodService.findAll();
assertThat(foods.contains(sameMilk), equalTo(true));
assertThat(foods.size(), equalTo(1));
}
public Food save(Food food) {
if(foods.contains(food)) {
int index = foods.indexOf(food);
foods.set(index, food);
} else {
foods.add(food);
}
return food;
}
이제 테스트를 실행하면 성공할 것이라 예상했지만, 실패한다. save 메서드의 파라미터로 전달되는 식품이 다르기 때문이다. 두 인스턴스가 같다는것은 equals 와 hashCode를 override 해서 구현할 수 있다. 냉장고 가계부에서 식품의 동등성은 각 식품마다 ID를 부여해서 판단한다. Food 클래스를 수정한다.
package com.poseidon.fridge;
public class Food {
private Long id;
private String name;
private int quantity;
private String expiryDate;
public Food(String name, int quantity, String expiryDate) {
this.name = name;
this.quantity = quantity;
this.expiryDate = expiryDate;
}
public Long getId() {
return id;
}
public void setId(Long id) {
this.id = id;
}
public String getName() {
return name;
}
public int getQuantity() {
return quantity;
}
public String getExpiryDate() {
return expiryDate;
}
public void decreaseQuantity(int quantity) {
if (quantity < 0 || this.quantity - quantity < 0) {
throw new IllegalArgumentException("current(" + this.quantity + "), quantity(" + quantity + ")");
}
this.quantity -= quantity;
}
@Override
public int hashCode() {
final int prime = 31;
int result = 1;
result = prime * result + ((id == null) ? 0 : id.hashCode());
return result;
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (getClass() != obj.getClass())
return false;
Food other = (Food) obj;
if (id == null) {
if (other.id != null)
return false;
} else if (!id.equals(other.id))
return false;
return true;
}
}
멤버 변수 id는 Long타입이고, 접근자(getter),수정자(setter)를 가진다. equals 메서드와 hashCode 메서드는 IDE 자동완성 기능을 이용해서 생성했다.
이제 MemoryFoodService 클래스를 수정한다. 목록표에 추가될 때 식품의 고유한 ID가 부여되기 때문에 save메서드에서는 목록에 add될때 id를 부여한다. id생성은 AtomicLong 클래스를 이용한다.
package com.poseidon.fridge;
import java.util.ArrayList;
import java.util.List;
import java.util.concurrent.atomic.AtomicLong;
public class MemoryFoodService {
private List<Food> foods = new ArrayList<>();
private AtomicLong atomicLong = new AtomicLong();
public List<Food> findAll() {
return foods;
}
public Food save(Food food) {
if(foods.contains(food)) {
int index = foods.indexOf(food);
foods.set(index, food);
} else {
foods.add(food);
food.setId(atomicLong.incrementAndGet());
}
return food;
}
}
테스트를 수행하면 실패한다. save파라미터로 전달된 new Food는 milk 인스턴스와 동등하지 않다. id가 부여되지 않았기 때문이다.
new Food에 milk 인스턴스의 id를 부여해서 테스트를 성공시킨다.
@Test
public void foodList() {
MemoryFoodService memoryFoodService = new MemoryFoodService();
List<Food> foods = memoryFoodService.findAll();
assertThat(foods.size(), equalTo(0));
memoryFoodService.save(milk);
foods = memoryFoodService.findAll();
assertThat(foods.contains(milk), equalTo(true));
Food sameMilk = new Food("파스퇴르 우유 1.8L", 1, "2018-09-28");
sameMilk.setId(milk.getId());
memoryFoodService.save(sameMilk);
foods = memoryFoodService.findAll();
assertThat(foods.contains(sameMilk), equalTo(true));
assertThat(foods.size(), equalTo(1));
}
수정 기능도 테스트해본다. 맥주를 생성하고 id값을 기존에 추가되어있는 milk의 값으로 설정한다. 기존에 등록된 우유를 맥주로 수정하는 기능을 테스트한다.
Food beer = new Food("카스 500mL", 6, "2019-09-01");
beer.setId(sameMilk.getId());
memoryFoodService.save(beer);
foods = memoryFoodService.findAll();
assertThat(foods.size(), equalTo(1));
assertThat(foods.get(0).getName(), equalTo("카스 500mL"));
테스트는 성공한다. foodList 테스트 메서드 내의 findAll메서드는 MemoryFoodService 멤버변수 ArrayList 를 반환하기 때문에 여기서 ArrayList의 기능을 이용해도 목록표에 식품을 추가하거나 삭제할 수 있다. 하지만, save메서드를 따로 두는 이유는 별도로 처리할 루틴이 있기 때문이다.
따라서, findAll 메서드의 리턴값을 통해 ArrayList 추가, 삭제 기능을 사용할 수 없도록 불변객체로 만든다.
foods.add(cola);
fail("ArrayList에 바로 접근하면 실패한다.");
fail 정적메서드를 사용해서 성공해서는 안되는 테스트를 표시한다. 이제 MemoryFoodService 클래스의 findAll 메서드의 리턴값을 불변객체로 만든다.
public List<Food> findAll() {
return Collections.unmodifiableList(foods);
}
불변 리스트로 반환하면 테스트 수행시 UnsupportedOperationException 예외가 발생한다. try-catch문으로 감싸면 테스트는 성공한다.
try {
foods.add(cola);
fail("ArrayList에 바로 접근하면 실패한다.");
} catch(UnsupportedOperationException e) {
}
불변 리스트를 만들었지만 리스트내의 Food 객체들은 참조이므로 수정가능하다. 이것을 확인하는 테스트를 진행한다.
foods.get(0).decreaseQuantity(6);
foods = memoryFoodService.findAll();
assertThat(foods.get(0).getQuantity(), equalTo(6));
테스트는 실패한다. save메서드를 통해서만 식품의 수량이 감소하길 기대했기에 6개 그대로 라고 예상했지만, 수량은 0개로 감소했다. 이부분은 Food 클래스에 Cloneable 인터페이스를 상속하여 clone 메서드를 통한 객체복사 기법으로 해결한다.
package com.poseidon.fridge;
public class Food implements Cloneable {
private Long id;
private String name;
private int quantity;
private String expiryDate;
public Food(String name, int quantity, String expiryDate) {
this.name = name;
this.quantity = quantity;
this.expiryDate = expiryDate;
}
public Long getId() {
return id;
}
public void setId(Long id) {
this.id = id;
}
public String getName() {
return name;
}
public int getQuantity() {
return quantity;
}
public String getExpiryDate() {
return expiryDate;
}
public void decreaseQuantity(int quantity) {
if (quantity < 0 || this.quantity - quantity < 0) {
throw new IllegalArgumentException("current(" + this.quantity + "), quantity(" + quantity + ")");
}
this.quantity -= quantity;
}
@Override
public int hashCode() {
final int prime = 31;
int result = 1;
result = prime * result + ((id == null) ? 0 : id.hashCode());
return result;
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (getClass() != obj.getClass())
return false;
Food other = (Food) obj;
if (id == null) {
if (other.id != null)
return false;
} else if (!id.equals(other.id))
return false;
return true;
}
@Override
protected Food clone() {
try {
return (Food)super.clone();
} catch (CloneNotSupportedException e) {
e.printStackTrace();
}
return null;
}
}
그리고 MemoryFoodService 클래스에 findAll메서드의 리턴값을 다음과 같이 복사해서 전달하면 참조의 수정으로 인한 영향을 방어할 수 있다.
public List<Food> findAll() {
List<Food> cloneFoods = new ArrayList<>();
for(Food food : foods) {
cloneFoods.add(food.clone());
}
return ImmutableList.<Food>builder().addAll(cloneFoods).build();
}
테스트를 수행하면 이제 원래의 findAll 메서드의 리턴값은 수정되지 않음을 알 수 있다. 리턴될때마다 Food객체가 복사되기 때문이다.
Collections.unmodifiableList 를 사용하다가 갑자기 ImmutableList로 변경했다. 불변 객체 생성 부분은 Guava 라이브러리로 대체 하면 편하기 때문이다.
Guava 라이브러리를 사용하려면 pom.xml 파일을 열고 dependency 를 추가하면 된다.
<dependency> <groupId>com.google.guava</groupId> <artifactId>guava</artifactId> <version>25.0-jre</version> </dependency>
Guava 라이브러리를 이용하면 hashCode 메서드도 간략하게 표현가능하다.
@Override
public int hashCode() {
return Objects.hashCode(id);
}
foodList 테스트 메서드에 중복을 제거하고 메서드도 정리한다.
package com.poseidon.fridge;
import static org.hamcrest.CoreMatchers.equalTo;
import static org.junit.Assert.assertThat;
import static org.junit.Assert.fail;
import java.util.List;
import org.junit.Before;
import org.junit.Test;
public class FoodTests {
private Food milk;
private Food cola;
private MemoryFoodService memoryFoodService;
private List<Food> foods;
@Before
public void setUp() {
milk = new Food("파스퇴르 우유 1.8L", 1, "2018-09-28");
cola = new Food("코카콜라 500mL", 2, "2018-10-30");
memoryFoodService = new MemoryFoodService();
foods = memoryFoodService.findAll();
}
@Test
public void createFood() {
String name = milk.getName();
int quantity = milk.getQuantity();
String expiryDate = milk.getExpiryDate();
assertThat(name, equalTo("파스퇴르 우유 1.8L"));
assertThat(quantity, equalTo(1));
assertThat(expiryDate, equalTo("2018-09-28"));
assertThat(cola.getName(), equalTo("코카콜라 500mL"));
assertThat(cola.getQuantity(), equalTo(2));
assertThat(cola.getExpiryDate(), equalTo("2018-10-30"));
}
@Test(expected = IllegalArgumentException.class)
public void decreaseQuantity() {
cola.decreaseQuantity(1);
assertThat(cola.getQuantity(), equalTo(1));
cola.decreaseQuantity(1);
assertThat(cola.getQuantity(), equalTo(0));
cola.decreaseQuantity(2);
}
@Test(expected = IllegalArgumentException.class)
public void decreaseQuantityByNegativeQuantity() {
cola.decreaseQuantity(-2);
assertThat(cola.getQuantity(), equalTo(0));
}
@Test
public void findAllAndSave() {
assertThat(foods.size(), equalTo(0));
memoryFoodService.save(milk);
foods = memoryFoodService.findAll();
assertThat(foods.contains(milk), equalTo(true));
}
@Test
public void saveEquals() {
memoryFoodService.save(milk);
Food sameMilk = new Food("파스퇴르 우유 1.8L", 1, "2018-09-28");
sameMilk.setId(milk.getId());
memoryFoodService.save(sameMilk);
foods = memoryFoodService.findAll();
assertThat(foods.contains(sameMilk), equalTo(true));
assertThat(foods.size(), equalTo(1));
Food beer = new Food("카스 500mL", 6, "2019-09-01");
beer.setId(sameMilk.getId());
memoryFoodService.save(beer);
foods = memoryFoodService.findAll();
assertThat(foods.size(), equalTo(1));
assertThat(foods.get(0).getName(), equalTo("카스 500mL"));
}
@Test
public void immutableList_findAll() {
Food beer = new Food("카스 500mL", 6, "2019-09-01");
memoryFoodService.save(beer);
foods = memoryFoodService.findAll();
try {
foods.add(cola);
fail("ArrayList에 바로 접근하면 실패한다.");
} catch(UnsupportedOperationException e) {
}
foods.get(0).decreaseQuantity(6);
foods = memoryFoodService.findAll();
assertThat(foods.get(0).getQuantity(), equalTo(6));
}
}
완벽하지는 않지만 아무것도 안하고 내버려 두는것보다는 정리하는게 좋다.
이제 수정 기능을 테스트하고 삭제기능을 테스트, 구현한다.
@Test
public void modify() {
Food beer = new Food("카스 500mL", 6, "2019-09-01");
memoryFoodService.save(beer);
beer.decreaseQuantity(5);
assertThat(beer.getQuantity(), equalTo(1));
memoryFoodService.save(beer);
foods = memoryFoodService.findAll();
Food first = foods.get(0);
assertThat(first.getName(), equalTo("카스 500mL"));
assertThat(first.getQuantity(), equalTo(1));
}
@Test
public void remove() {
Food beer = new Food("카스 500mL", 6, "2019-09-01");
memoryFoodService.save(beer);
boolean success = memoryFoodService.remove(beer);
assertThat(success, equalTo(true));
assertThat(memoryFoodService.findAll().size(), equalTo(0));
}
수정과 삭제 테스트를 구현했다. 아래는 MemoryFoodService 의 구현이다.
public boolean remove(Food food) {
return foods.remove(food);
}
위의 테스트 메서드들에서 findAll 메서드로 반환된 리스트의 인덱스값으로 저장된 Food를 참조하고 있다.
List에서 찾고자 하는 Food 참조의 위치를 사전에 알 수는 없을것이므로, Food의 ID를 기준으로 하나의 Food 객체만 리턴하는 메서드를 생성한다. 테스트 메서드와 구현은 다음과 같다.
@Test
public void findById() {
memoryFoodService.save(milk);
Food food = memoryFoodService.findById(milk.getId());
assertThat(food, sameInstance(milk));
Food nullFood = memoryFoodService.findById(999L);
assertThat(nullFood, nullValue());
}
public Food findById(Long id) {
for(Food food : foods) {
if(food.getId() == id) {
return food;
}
}
return null;
}
이전글: 냉장고 가계부 프로젝트 2
다음글: 냉장고 가계부 프로젝트 4