Spring Exception

📖 Spring Exception

스프링에서 제공하는 여러가지 예외 처치 방법에 대해 알아보려합니다.

1. @ControllerAdvice

모든 컨트롤러에 대해 전역적으로 예외를 처리하는 중앙 집중식 접근 방식입니다. 해당 어노테이션을 사용하면 Global 예외처리, 특정 package/Controller를 예외 처리를 담당합니다.

2. @ExceptionHandler

특정 예외를 처리할 메서드를 지정하는데 사용합니다. 해당 어노테이션을 사용하면 특정 Controller의 예외 처리를 담당합니다.

스프링 부트에서 예외를 처리하는 일반적인 방법 중 일부이며 적합한 방법을 선택하여 사용할 수 있습니다.

🤔 사용해야 하는 이유는?

1. 중앙 집중식 예외 처리

스프링 부트는 예외 처리에 대한 중앙 집중식 접근 방식을 제공합니다. 각 컨트롤러에서 예외 처리를 반복하지 않고 로직을 분리시켜 정의 할 수 있습니다. 또한 코드 재사용을 하지 않고 일관적인 예외 처리를 응답, 보다 쉬운 유지 관리를 할 수 있습니다.

2. 예외 추가 정보

디버깅 및 문제 해결에 유용할 수 있는 다양한 방법을 제공합니다. 보다 상세한 정보를 제공하므로 개발자가 더 쉽게 이해할 수 있습니다.

👨‍💻 구현

DTO, Controller

class User {
    @NotEmpty
    @Size(min = 1, max = 10)
    private String name;

    @NotNull
    @Min(value = 1)
    private Integer age;

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public int getAge() {
        return age;
    }

    public void setAge(int age) {
        this.age = age;
    }

    @Override
    public String toString() {
        return "User{" +
                "name='" + name + '\'' +
                ", age=" + age +
                '}';
    }
}
@RestController
@RequestMapping("/api")
public class ApiController {
@PostMapping("/user")
    public User post(@Valid @RequestBody User user) {
        System.out.println(user);
        return user;
    }
}

GlobalControllerAdvice

@RestControllerAdvice
public class GlobalControllerAdvice {

    @ExceptionHandler(value = Exception.class)
    public ResponseEntity exception(Exception e) {
        System.out.println("msg : " + e.getLocalizedMessage());
        return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR).body((""));
    }
}

예외 관리의 대한 로직을 따로 구현하기 위해 GlobalControllerAdvice 클래스에 @RestControllerAdvice를 사용하여 @RestController에 대한 예외처리를 명시해줍니다. @RestControllerAdvice의 범위를 지정할 수 있는데 기본 범위는 basePackages이며 원하는 만큼 설정할 수도 있습니다.

@RestControllerAdvice

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Component
public @interface ControllerAdvice {

	/**
	 * Alias for the {@link #basePackages} attribute.
	 * <p>Allows for more concise annotation declarations &mdash; for example,
	 * {@code @ControllerAdvice("org.my.pkg")} is equivalent to
	 * {@code @ControllerAdvice(basePackages = "org.my.pkg")}.
	 * @since 4.0
	 * @see #basePackages
	 */
	@AliasFor("basePackages")
	String[] value() default {};
    
    ...
    
}

예제를 보면 Controller에 @Valid를 사용하여 @NotEmpty, @Min, @NotEmpty와 같은 어노테이션를 모델 클래스에 사용했다는 것을 명시합니다. 실행 결과는 GlobalControllerAdvice에 정의한 내용이 나타나게 됩니다.

만약 controller에서 예외가 발생했고 어드바이스 클래스에 해당하는 예외가 2개이상인 경우 어떻게 될까요?

@ExceptionHandler(value = MethodArgumentNotValidException.class)
    public ResponseEntity methodArgumentNotValidException(MethodArgumentNotValidException e) {
        System.out.println("-----------global MethodArgumentNotValid----------");
        System.out.println("msg : " + e.getLocalizedMessage());
        System.out.println("---------------------------");
        return ResponseEntity.status(HttpStatus.BAD_REQUEST).body(e.getMessage());
    }

해당 메서드를 추가하면 이전에 구현한 Exception.class 보다 더 상세한 예외이기 때문에 해당 코드가 작동됩니다.

그렇다면 GlobalControllerAdvice에 작성한 예외와 Controller에 작성한 예외가 같다면 어떻게 될까요?

위의 코드를 컨트롤러에 그대로 작성하게 되면 컨트롤러에서 작성된 코드만 실행됩니다. 즉, 우선순위는 컨트롤러에 작성한 예외가 먼저라는 것을 알 수 있습니다. 또한 컨트롤러에서 예외를 실행했기 때문에 외부에 있는 같은 코드는 실행되지 않습니다.

✅ 요약

• 스프링에서 제공하는 예외 처리 프로세스는 중앙 집중형으로 재사용과 로직 분리를 하여 코드 품질을 높여줍니다.
• 하나의 메서드에 해당 되는 예외가 2개라면 가장 근접한 예외만 실행합니다.
• Advice와 Controller에서 같은 예외 처리 코드를 실행한다면 컨트롤러에서 예외를 처리하며, Advice에 있는 예외 처리 코드가 같아도 실행되지 않습니다.