Exception 컨벤션

[kimhyun5u]

💡 다음 이슈를 해결했어요.

Issue Link - #20

Discussion Link - #14

💡 이슈를 처리하면서 추가된 코드가 있어요.

• HttpStatusException: HttpStatus 와 관련된 Exception
  • 아래는 HttpStatusException 을 상속합니다.
    • BadRequestException: 400 에러에 대한 Exception
    • UnauthorizedException: 401 에러에 대한 Exception
    • ForbiddenException: 403 에러에 대한 Exception
    • NotFoundException: 404 에러에 대한 Exception
    • MethodNotAllowedException: 405 에러에 대한 Exception
    • ConflictException: 409 에러에 대한 Exception
• ErrorCode: 에러 코드를 통해 명시된 에러를 공유한다.
• CustomRestControllerAdvice: ControllerAdvice 기본 생성 우선 순위 문제 때문에 생성한 CustomRestControllerAdvice
  • 기존 RestControllerAdvice 보다 우선 순위가 한 단계 높다.

💡 이런 고민을 했어요.

• RestControllerAdvice 의 우선 순위를 어떻게 관리할까?
• Exception 이 많아지면서 관리하기 더 어려워지는 거 아닐까?

💡 다음 자료를 참고하면 좋아요.

TestNotFoundException.java

package camp.woowak.lab.web.api;

import camp.woowak.lab.common.exception.NotFoundException;

public class TestNotFoundException extends NotFoundException {
	public TestNotFoundException() {
		super(TestErrorCode.PAGE_NOT_FOUND);
	}
}

TestErrorCode.java

package camp.woowak.lab.web.api;

import camp.woowak.lab.common.exception.ErrorCode;

public enum TestErrorCode implements ErrorCode {
	PAGE_NOT_FOUND(404, "C001", "Page Not Found");
	private final int status;
	private final String errorCode;
	private final String message;

	TestErrorCode(int status, String errorCode, String message) {
		this.status = status;
		this.errorCode = errorCode;
		this.message = message;
	}

	@Override
	public int getStatus() {
		return status;
	}

	@Override
	public String getErrorCode() {
		return errorCode;
	}

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

TestExceptionHandler.java

package camp.woowak.lab.web.api;

import org.springframework.http.HttpStatusCode;
import org.springframework.http.ProblemDetail;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.ExceptionHandler;

import camp.woowak.lab.common.advice.CustomRestControllerAdvice;
import camp.woowak.lab.common.exception.NotFoundException;

@CustomRestControllerAdvice(basePackageClasses = TestController.class)
public class TestControllerAdvice {

	@ExceptionHandler(NotFoundException.class)
	public ResponseEntity<ProblemDetail> handlePageNotFoundException(TestNotFoundException e) {
		ProblemDetail problemDetail = ProblemDetail.forStatusAndDetail(
			HttpStatusCode.valueOf(e.errorCode().getStatus()),
			e.errorCode().getMessage());
		problemDetail.setProperty("errorCode", e.errorCode().getErrorCode());

		return ResponseEntity.status(HttpStatusCode.valueOf(e.errorCode().getStatus()))
			.body(problemDetail);
	}
}

✅ 셀프 체크리스트

• 내 코드를 스스로 검토했습니다.
• 필요한 테스트를 추가했습니다.
• 모든 테스트를 통과합니다.
• 브랜치 전략에 맞는 브랜치에 PR을 올리고 있습니다.
• 커밋 메세지를 컨벤션에 맞추었습니다.
• wiki를 수정했습니다.

[Dr-KoKo]

공통적으로 사용되는 클래스라서 네이밍이 고민되시겠네요 ㅎㅎ
전혀 파악되지 않는 네이밍이 아니라면 고민하지 마시고 편안하게 결정지으셔도 될 것 같습니다.

[june-777]

👍👍