냉장고 가계부 프로젝트 26

Fridge 프로젝트 소스코드를 정리한다.
먼저, FridgeRepository에서 findByUserId 메서드를 기존의 Fridge 객체를 리턴타입으로 가지는데
Optional<Fridge> 리턴값으로 변경한다. 그리고 기존에 사용하던 단일 로우를 리턴하는 findOne(long id) 메서드(JpaRepository 에서 제공)를 사용하지 않고 findById라는 메서드를 추가한다. 이 메서드의 리턴값도 Optional<Fridge> 리턴타입으로 한다.

@Repository
public interface FridgeRepository extends JpaRepository<Fridge, Integer> {
    Optional<Fridge> findByUserId(Long userId);
    Optional<Fridge> findById(Integer id);
}

Java8 에서 나온 Optional은 널포인트오류를 처리하기 위한 java.util 유틸리티 클래스이다.
기존코드는 Null이 나올경우 if(data == null) 이런식으로 처리하거나, Null객체를 만들어서 사용했었는데, 이제는 Optional 을 이용해서 Null일경우 어떻게 처리할지를 일관성있게 명시할 수 있다.
FridgeRepository의 findByUserId, findById 두 메서드를 사용하는 곳은 FridgeController 이므로 FridgeController 클래스를 수정한다.

public class FridgeController {
    ...
    @GetMapping("/{id}")
    Resource<Fridge> loadFridgeById(@PathVariable final int id) {
        Fridge fridge = repository.findById(id)
                .orElseThrow(() -> new FridgeNotFoundException(id));
        return assembler.toResource(fridge);
    }

    ...

    @GetMapping("/me/{userId}")
    Resource<Fridge> loadMyFridge(@PathVariable final long userId) {
        Fridge fridge = repository.findByUserId(userId)
                .orElseThrow(() -> new FridgeNotFoundException(userId));
        return assembler.toResource(fridge);
    }

loadFridgeById 컨트롤러 메서드는 uri변수 id를 받아서 repository.findById 메서드에 파라미터로 전달해서 Fridge데이터 단일로우를 리턴받는다. 그런데 리턴타입이 Optional이므로 orElseThrow 메서드를 사용해서 만약 null일 경우, FridgeNotFoundException을 객체를 생성해서 exception을 던진다.
loadMyFridge 메서드도 마찬가지로 findByUserId 메서드의 리턴값이 null일 경우 exception을 던진다.

FridgeNotFoundException 클래스는 RuntimeException을 상속받은 클래스로 내용은 생성자 두개를 부모클래스 생성자의 파라미터로 message를 전달한다.

public class FridgeNotFoundException extends RuntimeException {
    private static final long serialVersionUID = 1L;

    public FridgeNotFoundException(Integer id) {
        super("could not found fridge #" + id);
    }
    
    public FridgeNotFoundException(Long userId) {
        super("could not found fridge by userId #" + userId);
    }
}

두 컨트롤러 메서드에서 FridgeNotFoundException이 발생하면 처리할 클래스를 작성한다. 클래스명은 FridgeNotFoundAdvice이다.

@ControllerAdvice
public class FridgeNotFoundAdvice {
    
    @ResponseBody
    @ExceptionHandler(FridgeNotFoundException.class)
    @ResponseStatus(HttpStatus.NOT_FOUND)
    String fridgeNotFoundHandler(FridgeNotFoundException ex) {
        return ex.getMessage();
    }

}

@ControllerAdvice 애너테이션을 선언한 클래스는 @Controller 애너테이션이 선언된 클래스들에 공유된다. fridgeNotFoundHandler 메서드는 @ResponseBody 애너테이션이 선언되어 있고, @ExceptionHandler 애너테이션으로 FridgeNotFoundException 클래스타입이 선언되어있다. 이 메서드는 FridgeNotFoundException 에러가 발생하면 처리하는 메서드임을 나타낸다. @ResponseStatus 애너테이션은 HttpStatus.NOT_FOUND 응답상태코드를 응답한다고 선언한다.
메서드 파라미터로는 컨트롤러들에서 발생한 FridgeNotFoundException 을 전달받아서 message를 리턴한다. 리턴값은 "could not found fridge #1" 이런식으로 응답할 것이다.

repository에서 생성한 findById 메서드를 이용하는 컨트롤러 메서드는 updateFridge 메서드 하나가 더 있다. 이 메서드는 Fridge 데이터가 존재하면 update 한다는 처리를 위해서 findOne 메서드를 사용했었다. 다음은 수정된 메서드다.

public class FridgeController {
    ...
    @PutMapping("/{id}")
    ResponseEntity<?> updateFridge(@PathVariable final int id, @RequestBody final FridgeRequest fridgeRequest) throws URISyntaxException {
        Fridge updatedFridge = repository.findById(id)
                .map(fridge -> {
                    fridge.setNickname(fridgeRequest.getNickname());
                    return repository.save(fridge);
                })
                .orElseGet(() -> {
                    fridgeRequest.setId(id);
                    return repository.save(fridgeRequest.toFridge());
                });
        Resource<Fridge> resource = assembler.toResource(updatedFridge);
        return ResponseEntity.created(new URI(resource.getId().expand().getHref()))
                .body(resource);
    }
    ...
}

repository.findById 메서드는 Optional타입을 리턴하는데 데이터가 null이 아닌경우 map메서드에 fridge 객체 데이터를 전달한다. map 내부에서는 전달받은 fridge 객체를 컨트롤러 requestBody로 전달받은 FridgeRequest 의 nickname 값만 set해서 save메서드에 전달하고 리턴한다.
orElseGet 은 findById 로 리턴값이 null인경우 fridge 객체를 처리하는 메서드인데, 여기서는 fridgeRequest에 uri 변수로 전달된 id를 set해주고 save메서드에 전달하고 리턴한다.
간단하게 말해서, 데이터가 있으면, update, 없으면, insert해준다. DB의 merge와 같은 기능표현이다.

FoodRepository 인터페이스에도 findById 메서드를 만들고 Optional타입을 리턴하도록 수정한다.

@Repository
public interface FoodRepository extends JpaRepository<Food, Long> {
    Optional<Food> findById(Long id);
}

FoodRepository 수정이 완료되면 FoodController 클래스도 FridgeController 와 동일하게 수정한다.

public class FoodController {
    ...
    @GetMapping("/{id}")
    Resource<Food> findById(@PathVariable final long id) {
        Food food = repository.findById(id)
                .orElseThrow(() -> new FoodNotFoundException(id));
        return assembler.toResource(food);
    }
    
    ...
    
    @PutMapping("/{id}")
    ResponseEntity<?> updateFood(@PathVariable final long id, 
            @RequestBody final FoodRequest foodRequest) throws URISyntaxException {
        Food updatedFood = repository.findById(id)
                .map(food -> {
                    food.setName(foodRequest.getName());
                    food.setQuantity(foodRequest.getQuantity());
                    food.setExpiryDate(foodRequest.getExpiryDate());
                    food.setFridge(foodRequest.getFridge());
                    return repository.save(food);
                })
                .orElseGet(() -> {
                    foodRequest.setId(id);
                    return repository.save(foodRequest.toFood());
                });
        Resource<Food> resource = assembler.toResource(updatedFood);
        return ResponseEntity.created(new URI(resource.getId().expand().getHref()))
                .body(resource);
    }
    
    ...

}

findById, updateFood 컨트롤러 메서드는 FridgeController 수정과 동일한 내용이다.
Fridge, Food 클래스의 양방향(BiDirectional) 관계설정은 Food클래스의 Fridge 필드의 @JsonIgnore 애너테이션으로 무한루프의 고리를 끊었다.
하지만, Fridge 필드가 JSON 마샬링에서 빠져버림으로 UI서버에서 Response Body에 Fridge객체가 null로 전달된다. 이것은 UI에서 Food를 생성하거나 수정할경우 fridge객체의 식별자를 사용하지 못하기 때문에 이 문제를 해결하기 위해 UI에서는 fridgeId 필드를 전달하고, API서버는 FoodRequest 객체(요청 전담 DTO)가 전달받아서 Fridge 객체를 생성하는 것으로 수정했다.
FoodRequest 클래스를 다음과 같이 수정한다.

@Data
@NoArgsConstructor
public class FoodRequest {
    private Long id;
    private String name;
    private Integer quantity;
    private LocalDate expiryDate;
    private Fridge fridge;
    
    public Integer getFridgeId() {
        return fridge.getId();
    }
    public void setFridgeId(Integer fridgeId) {
        if(fridge == null) {
            fridge = new Fridge();
        }

        fridge.setId(fridgeId);
}
    
    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();
    }
    
}

fridgeId 라는 필드는 존재하지 않지만 Getter/Setter 가 존재하므로 UI서버에서 fridgeId JSON 필드가 전달되면, setFridgeId메서드가 호출된다. Fridge 객체는 null이므로 빈객체로 생성하고 파라미터로 전달받은 fridgeId 를 set해준다.
fridge-web 프로젝트의 FoodCommand 클래스는 다음과 같다.

@Data
@NoArgsConstructor
public class FoodCommand {
    
    private Long id;
    
    @NotNull
    @Size(min=1, max=20)
    private String name;
    
    @Min(1)
    @Max(999)
    private Integer quantity;
    
    @DateTimeFormat(pattern="yyyy-MM-dd")
    private LocalDate expiryDate;
    private Integer fridgeId;
    
    public static final int SHOW_EXPIRY_D_DAYS = -3;
    
    @JsonIgnore
    public int getExpiryDays() {
        return Period.between(getExpiryDate(), LocalDate.now()).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;
    }
    
    @Builder
    public FoodCommand(Long id, String name, Integer quantity, LocalDate expiryDate, Integer fridgeId) {
        this.id = id;
        this.name = name;
        this.quantity = quantity;
        this.expiryDate = expiryDate;
        this.fridgeId = fridgeId;
    }

}

기존의 Fridge fridge 필드가 사라지고, Integer fridgeId 필드가 대신한다. Food를 등록,수정할 경우 Fridge 식별자 ID가 이 필드에 담겨서 API서버에 전달된다.

FoodController도 다음과 같이 변경한다.

@Controller
@RequestMapping("/fridges/{fridgeId}/foods")
@SessionAttributes("foodCommand")
@RequiredArgsConstructor
public class FoodController {
    private final FoodRestService service;
    
    @GetMapping("/add")
    public String registerFoodForm(FoodCommand foodCommand, Model model) {
        model.addAttribute("foodCommand", foodCommand);
        return "foods/registerFoodForm";
    }
    
    @PostMapping("/add")
    public String processRegistrationFood(@ModelAttribute @Valid FoodCommand foodCommand, 
            Errors errors, 
            RedirectAttributes ra, 
            SessionStatus sessionStatus) {
        if(errors.hasErrors()) {
            return "foods/registerFoodForm";
        }
        
        if(service.create(foodCommand) != null) {
            ra.addFlashAttribute("message", "식품을 저장했습니다.");
            sessionStatus.setComplete();
        }
        return "redirect:/fridges/me";
    }
    
    @GetMapping("/{id}")
    public String updateFoodForm(@PathVariable("fridgeId") Integer fridgeId, 
            @PathVariable long id, Model model) {
        FoodCommand foodCommand = service.loadById(id);
        foodCommand.setFridgeId(fridgeId);
        model.addAttribute("foodCommand", foodCommand);
        return "foods/updateFoodForm";
    }
    
    @PutMapping("/{id}")
    public String processUpdateFood(@PathVariable long id, 
            @ModelAttribute @Valid FoodCommand foodCommand, 
            Errors errors, 
            RedirectAttributes ra,
            SessionStatus sessionStatus) {
        if(errors.hasErrors()) {
            return "foods/updateFoodForm";
        }
        
        service.update(foodCommand, id);
        ra.addFlashAttribute("message", "식품을 저장했습니다.");
        sessionStatus.setComplete();
        return "redirect:/fridges/me";
    }
    
    @GetMapping("/delete/{id}")
    public String deleteFood(@PathVariable long id, RedirectAttributes ra) {
        service.delete(id);
        ra.addFlashAttribute("message", "식품을 삭제했습니다.");
        return "redirect:/fridges/me";
    }

}

class 선언부에 @RequestMapping을 /fridges/{fridgeId}/foods 로 변경한다. 이제 Food클래스의 모든 메서드들은 /fridges/{fridgeId}/foods URL을 매핑한다. fridgeId uri 변수는 fridge.html에서 링크값을 채워서 호출한다. 컨트롤러 메서드 파라미터에 FoodCommand 객체가 존재할 경우 Spring DataBinder가 uri변수 fridgeId와 이름이 똑같은 foodCommand클래스의 fridgeId 필드에 데이터를 바인딩해준다.
registerFoodForm 메서드의 경우를 예를 들면, 메서드 파라미터에 FoodCommand 객체가 선언되어 있기 때문에, /fridges/1/foods/add 호출되면 foodCommand 객체의 fridgeId 필드에 1 이 값으로 전달된다.
updateFoodForm의 경우 @PathVariable을 사용해서 fridgeId를 가져와서 foodCommand 객체에 set해준다.

Fridge 프로젝트에서 FridgeController, FoodController의 findById repository 메서드를 호출하는 메서드가 null을 반환할 경우, Exception을 발생해서 HttpStatus.NOT_FOUND를 응답상태로 전달하는 ControllerAdvice 클래스가 생김에 따라서, UI서버에서 RestTemplate을 사용한 HTTP통신에서도 NotFound 에러를 핸들링할 필요가 생겼다.
FoodRestService 클래스에 다음과 같이 try-catch 구문으로 감싼다.

@Service
@RequiredArgsConstructor
@Slf4j
public class FoodRestService {
    private final RestTemplate restTemplate;
    
    ...
    
    public FoodCommand loadById(long id) {
        try {
            ResponseEntity<FoodCommand> response = restTemplate.getForEntity("/foods/{id}", FoodCommand.class, id);
            if(response.getStatusCode() == HttpStatus.OK) {
                return response.getBody();
            }
        } catch(HttpClientErrorException ex) {
            log.error("Response error: {} {}", ex.getStatusCode(), ex.getStatusText());
        }
        return null;
    }
    
    ...

}

익셉션이 발생하는 부분은 /foods/{id}를 호출하는 loadById메서드이므로, 해당 메서드를 try-catch 구문으로 감싼다. HttpClientErrorException 에러형태가 발생하면 log를 찍는다.
class 선언부에 @Slf4j 애너테이션은 lombok 라이브러리로 Logger 를 만들어준다.

FridgeRestService도 마찬가지로 수정한다.

public class FridgeRestService {
    private final RestTemplate restTemplate;
    
    private static final String DEFAULT_NICKNAME = "myFridge";
    private static final long USER_ID = 1004L;
    
    public FridgeCommand loadMyFridge() {
        FridgeCommand fridgeCommand = loadByUserId(USER_ID);
        if(fridgeCommand == null) {
            return generate(DEFAULT_NICKNAME, USER_ID);
        }
        return fridgeCommand;
    }
    
    FridgeCommand loadByUserId(long userId) {
        try {
            ResponseEntity<FridgeCommand> response = restTemplate.getForEntity("/fridges/me/" + USER_ID, FridgeCommand.class);
            if(response.getStatusCode() == HttpStatus.OK) {
                return response.getBody();
            }
        } catch(HttpClientErrorException ex) {
            log.error("Response error: {} {}", ex.getStatusCode(), ex.getStatusText());
        }
        return null;
    }
    
    FridgeCommand generate(String nickname, long userId) {
        FridgeCommand fridgeCommand = new FridgeCommand();
        fridgeCommand.setNickname(nickname);
        fridgeCommand.setUserId(userId);
        
        ResponseEntity<FridgeCommand> response = restTemplate.postForEntity("/fridges", fridgeCommand, FridgeCommand.class);
        if(response.getStatusCode() == HttpStatus.CREATED) {
            return response.getBody();
        }
        return null;
    }

}

loadByUserId 메서드를 try-catch 구문으로 감싼다. HTTP상태가 NotFound로 전달되더라도 null을 리턴하도록 해야 Fridge 생성 로직이 진행된다.

전체 테스트를 실행해서 문제가 없는지 확인한다.

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