냉장고 가계부 프로젝트 25

유통기한이 임박한 식품을 강조하기 위해서 UI를 이용해서 유통기한 D-Day를 보여준다.
fridge-web 프로젝트의 FoodCommand 객체에 다음과 같이 수정한다.

public class FoodCommand {
    ...
 
    public static final int SHOW_EXPIRY_D_DAYS = -3;
    
    // Get/Set
    
    public int getExpiryDays() {
        return Period.between(LocalDate.now(), getExpiryDate()).getDays();
    }
    
    public String showExpiryDDay() {
        if(getExpiryDays() >= SHOW_EXPIRY_D_DAYS) {
            if(getExpiryDays() == 0) {
                return "D-Day";
            } else if(getExpiryDays() < 0) {
                return "D" + getExpiryDays();
            } else if(getExpiryDays() > 0) {
                return "D+" + getExpiryDays();
            }
        }
        return null;
    }

    // toString
}

SHOW_EXPIRY_D_DAYS 정적변수는 D-Day를 보여줄 기준일수를 의미한다. getExpiryDays 메서드에서는 현재날짜부터 유통기한까지의 일수(D-Day)를 가져온다.
showExpiryDDay 메서드는 D-Day 를 나타내는 문자열을 만들어낸다.

다음은 뷰페이지에서 유통기한 필드를 보여주는 부분이다.

          
<tbody>
  <tr th:each="food, foodStat : ${fridge.foods}">
    <td th:text="${foodStat.count}">number</td>
    <td><a class="btn btn-sm btn-outline-dark" th:href="@{/fridges/foods/{id}(id=${food.id})}" th:text="${food.name}">name</a></td>
    <td th:text="${food.quantity}">1</td>
    <td th:class="${food.getExpiryDays() ge food.SHOW_EXPIRY_D_DAYS}? 'text-danger'" th:text="${#objects.nullSafe(food.showExpiryDDay(), #temporals.format(food.expiryDate, 'yyyy-MM-dd'))}">2018-09-09</td>
    <td>
      <a class="btn btn-outline-dark btn-sm" role="button" th:href="@{/fridges/foods/delete/{id}(id=${food.id})}">
        <i class="fas fa-minus"></i>
      </a>
    </td>
  </tr>
</tbody>

foodCommand 메서드를 호출해서 D-Day 를 표현한다.

수정이 끝났으면 테스트를 실행해서 UI가 잘 표현되는지 확인한다.

fridge 프로젝트의 Fridge, Food 도메인클래스에 Lombok 라이브러리를 사용해서 코드를 정리한다.
lombok 애너테이션을 사용하면 Getter/Setter/Constructor/Builder 를 간단하게 생성해준다.

pom.xml 파일에서 의존성을 추가한다.

<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
    <optional>true</optional>
</dependency>

Fridge 클래스를 다음과 같이 수정한다.

@Data
@NoArgsConstructor
@Entity
public class Fridge {
    private @Id @GeneratedValue Integer id;
    private String nickname;
    private Long userId;
    
    @OneToMany(mappedBy = "fridge", cascade = CascadeType.ALL, orphanRemoval = true)
    private List<Food> foods = new ArrayList<>();
    
    @Builder
    public Fridge(Integer id, String nickname, Long userId, List<Food> foods) {
        this.id = id;
        this.nickname = nickname;
        this.userId = userId;
        if(foods == null) {
            this.foods = new ArrayList<>();
        }
    }
    
    public void addFood(Food food) {
        this.foods.add(food);
        food.setFridge(this);
    }

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

@Data 애너테이션은 Getter/Setter 를 생성하고, private final 필드가 있을경우 파라미터가 존재하는 생성자를 생성하고, hashCode/equals/toString 메서드를 생성한다.
@NoArgConstructor 는 애너테이션 그대로 인자없는 생성자를 생성한다.
생성자에 @Builder 애너테이션이 붙어있는데, 이는 생성자 파라미터로 전달된 필드들(id, nickname, userId, foods) 필드에 대한 빌더를 생성한다.
List<Food foods 필드에 선언된 @JsonIgnore 애너테이션은 삭제한다. JSON으로 파싱될때 Fridge와 Food 클래스의 Bidirectional 관계 설정으로 인한 무한루프에 빠지는것을 막기위한 용도였는데, 소스를 정리하면서 Food 클래스에만 남겨두면 무한루프의 연결고리를 Food쪽에서 끊어주기 때문에 필요없어졌다.

lombok을 사용하므로써, boilerplate를 줄여준다.
Fridge 도메인클래스를 수정했으니, 컴파일 에러가 많이 발생한다. 전부 수정하고 테스트를 수행한다.
수정이 완료되었으면, Food, FridgeRequest, FoodRequest 클래스들도 전부 수정한다.

@Data
@NoArgsConstructor
@Entity
public class Food {
    private @Id @GeneratedValue Long id;
    private String name;
    private int quantity;
    private LocalDate expiryDate;
    
    @ManyToOne
    @JsonIgnore
    private Fridge fridge;
    
    @Builder
    public Food(Long id, String name, int quantity, LocalDate expiryDate, Fridge fridge) {
        this.id = id;
        this.name = name;
        this.quantity = quantity;
        this.expiryDate = expiryDate;
        if(expiryDate == null) {
            setDefaultExpiryDate();
        }
        this.fridge = fridge;
    }
    
    public static final int DEFAULT_EXPIRY_DAYS = 7;
    
    private void setDefaultExpiryDate() {
        this.expiryDate = LocalDate.now().plusDays(DEFAULT_EXPIRY_DAYS);
    }
    
}

@Data
@NoArgsConstructor
public class FridgeRequest {
    private Integer id;
    private String nickname;
    private List<Food> foods;
    private Long userId;
    
    public FridgeRequest(Fridge fridge) {
        this.id = fridge.getId();
        this.nickname = fridge.getNickname();
        this.userId = fridge.getUserId();
        this.foods = fridge.getFoods();
    }
    
    public Fridge toFridge() {
        return Fridge.builder()
                .id(id)
                .nickname(nickname)
                .userId(userId)
                .foods(foods)
                .build();
    }
    
}

@Data
@NoArgsConstructor
public class FoodRequest {
    private Long id;
    private String name;
    private Integer quantity;
    private LocalDate expiryDate;
    private Fridge fridge;
    
    public FoodRequest(Food food) {
        this.id = food.getId();
        this.name = food.getName();
        this.quantity = food.getQuantity();
        this.expiryDate = food.getExpiryDate();
        this.fridge = food.getFridge();
    }
    
    public Food toFood() {
        return Food.builder()
                .id(id)
                .name(name)
                .quantity(quantity)
                .expiryDate(expiryDate)
                .fridge(fridge)
                .build();
    }
    
}

수정을 완료하고 컴파일 에러부분을 다 정리하고나서 보니 클래스 파일이 확실히 코드가 깔끔해졌다.
테스트를 실행해서 문제가 없는지 확인한다.

HATEOAS를 이용하는 부분을 지금은 Resource 클래스로 Fridge 클래스를 wrap하는 부분에서, ResouceSupport 클래스를 상속받은 FridgeResource 클래스와 ResourceAssemblerSupport 클래스를 상속받은 FridgeResourceAssembler 클래스를 이용하고 있다.
사실 객체에 내용은 별것도 없는데 래핑하는 클래스가 두개씩이나 되는것은 좀 오버인것 같아서, 코드의 양을 조금 늘리는 대신에, ResourceSupport 클래스를 상속받은 클래스를 제거하는 방향으로 정한다.
ResourceSupport 클래스를 상속받으면, 편하고 간단하지만, 차후에 생길 모든 POJO 객체가 다 생성되는 것보다는 Resouce클래스 생성자에 넘겨줘서 wrap하는 방식으로 하면, 클래스를 생성하지 않고도, 레거시 POJO 클래스가 Resource에 감싸질 수 있다.

FridgeResource를 삭제하고, FridgeResourceAssembler 클래스를 수정한다.

public class FridgeResourceAssembler implements ResourceAssembler<Fridge, Resource<Fridge>> {

    @Override
    public Resource<Fridge> toResource(Fridge fridge) {
        return new Resource<>(fridge, 
                linkTo(methodOn(FridgeController.class).loadFridgeById(fridge.getId())).withSelfRel(),
                linkTo(methodOn(FridgeController.class).findAllFridges()).withRel("fridges"));
    }

}

상속받던 ResourceAssemblerSupport 클래스 대신 ResourceAssembler 인터페이를 구현한다.
toResource 메서드에서는 Resource 생성자 파라미터로 fridge, self, list link를 전달한다.
다음은 FridgeController 클래스를 수정한다.

@RequiredArgsConstructor
@RestController
@RequestMapping("/fridges")
public class FridgeController {
    
    private final FridgeService service;
    private final JpaFridgeRepository repository;
    
    private FridgeResourceAssembler assembler = new FridgeResourceAssembler();
    
    @PostMapping
    ResponseEntity<?> create(@RequestBody final FridgeRequest fridgeRequest) throws URISyntaxException {
        Fridge fridge = service.create(fridgeRequest.getNickname(), fridgeRequest.getUserId());
        Resource<Fridge> resource = assembler.toResource(fridge);
        return ResponseEntity.created(new URI(resource.getId().expand().getHref()))
                .body(resource);
    }
    
    @GetMapping("/{id}")
    Resource<Fridge> loadFridgeById(@PathVariable final int id) {
        Fridge fridge = repository.findOne(id);
        return assembler.toResource(fridge);
    }
    
    @GetMapping
    Resources<Resource<Fridge>> findAllFridges() {
        List<Resource<Fridge>> fridges = repository.findAll().stream()
                .map(assembler::toResource)
                .collect(Collectors.toList());
        
        return new Resources<>(fridges, 
                linkTo(methodOn(FridgeController.class).findAllFridges()).withSelfRel());
    }
    
    @PutMapping("/{id}")
    ResponseEntity<?> updateFridge(@PathVariable final int id, @RequestBody final FridgeRequest fridgeRequest) {
        if(repository.findOne(id) != null) {
            service.save(fridgeRequest.toFridge());
        }
        return ResponseEntity.noContent().build();
    }
    
    @DeleteMapping("/{id}")
    ResponseEntity<?> deleteFridgeById(@PathVariable final int id) {
        service.remove(id);
        return ResponseEntity.noContent().build();
    }
    
    @DeleteMapping
    ResponseEntity<?> deleteAllFridge() {
        service.removeAll();
        return ResponseEntity.noContent().build();
    }
    
    @GetMapping("/me/{userId}")
    Resource<Fridge> loadMyFridge(@PathVariable final long userId) {
        Fridge fridge = repository.findByUserId(userId);
        return assembler.toResource(fridge);
    }

}

@RequiredArgsConstructor 애너테이션은 final 필드가 있는경우 생성자를 만들어준다. @Autowired로 선언되어 있던 Service, Repository를 생성자로 의존성을 주입하는것으로 변경한다.
create 컨트롤러 메서드에서 변경된 점은 리턴값에 ResponseEntity.created 메서드 파라미터로 URI를 생성하는데 resource 링크의 href 값을 전달하는점이 달라졌다.

loadFridgeById 메서드에서는 리턴타입이 ResponseEntity<ResourceFridge> 에서 Resource<Fridge> 로 변경했다.
findAllFridges 메서드는 List<Resource<Fridge>> 형태의 리턴값을 가지도록 자바8의 컬렉션에 추가된 람다를 사용한다.
map(assembler:toResource) 이부분은 assembler의 toResource를 사용해서 Collection<Fridge> 내부의 아이템 fridge 값들을 Resource<Fridge> 형태로 변경한다.
map(fridge -> { return assembler.toResource(fridge); }) 이렇게 표현해도 동일하다.
collect 를 이용해서 리스트형태로 리턴한다.
findAllFridges 메서드 리턴문장에는 new Resources로 생성자 파라미터에 데이터값을 전달하고, self link를 추가한다.

동일하게 FoodResource, FoodResourceAssembler, FoodController 클래스들도 소스코드를 정리한다.

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