HTTP Response Body에 예외 error message 지정해 보내기

Http Response Body에 Exception error message 지정하기

직접 만든 에러메시지를 Http Response의 "message" :에 넣어 줄 수 있다.

먼저 Exception과 에러메시지를 만든다.

DishController.java

// ...
@PutMapping("/{dishId}")
    public ResponseEntity<ResponseDto> orderDish(@PathVariable String dishId, @RequestParam("count") int orderSize) {
        if (dishService.orderDish(dishId, orderSize)) {
            return ResponseEntity.ok().body(new ResponseDto(Status.OK));
        }
        return ResponseEntity.badRequest().body(new ResponseDto(Status.OUT_OF_STOCK));
    }
// ... 

DishService.java

@Service
public class DishService {

    private CategoryRepository categoryRepository;

    public DishService(CategoryRepository categoryRepository) {
        this.categoryRepository = categoryRepository;
    }

    public Category findByDishId(String dishId){
        return categoryRepository.findByDishId(dishId).orElseThrow(() ->
                new NotFoundException(Status.NOTFOUND_DISH.getMessage()));
    }

    public Dish findDishByDishId(String dishId) {
        Category category = findByDishId(dishId);
        return category.getDishByDishId(dishId);
    }

    public boolean orderDish(String dishId, int orderSize) {
        Category category = findByDishId(dishId);
        Dish dish = findDishByDishId(dishId);

        if (dish.checkStock(orderSize)) {
            dish.updateStock(orderSize);
            category.addDish(dish);
            categoryRepository.save(category);
            return true;
        }
        return false;
    }
}

NotFoundException.java

@ResponseStatus(value = HttpStatus.NOT_FOUND)
public class NotFoundException extends RuntimeException {

    private String message;

    public NotFoundException(String message) {
        this.message = message;
    }

    @Override
    public String getMessage() {
        return message;
    }
}

Status.java

public enum Status {
    OK("Success"),
    NOTFOUND_CATEGORY("존재하지 않는 카테고리입니다."),
    NOTFOUND_DISH("존재하지 않는 반찬입니다."),
    OUT_OF_STOCK("반찬 재고 부족");

    private String message;

    Status(String message) {
        this.message = message;
    }

    public String getMessage() {
        return message;
    }
}

마지막으로 application.properties에

server.error.include-message=always 을 추가한다.

참고

https://stackoverflow.com/questions/62561211/spring-responsestatusexception-does-not-return-reason