RestControllerAdvice 메서드 public vs private

Question

학습하는 분들께 도움이 되고, 더 좋은 답변을 드릴 수 있도록 질문전에 다음을 꼭 확인해주세요.

1. 강의 내용과 관련된 질문을 남겨주세요.
2. 인프런의 질문 게시판과 자주 하는 질문(링크)을 먼저 확인해주세요.
(자주 하는 질문 링크: https://bit.ly/3fX6ygx)
3. 질문 잘하기 메뉴얼(링크)을 먼저 읽어주세요.
(질문 잘하기 메뉴얼 링크: https://bit.ly/2UfeqCG)

질문 시에는 위 내용은 삭제하고 다음 내용을 남겨주세요.
=========================================
[질문 템플릿]
1. 강의 내용과 관련된 질문인가요? (예/아니오)
2. 인프런의 질문 게시판과 자주 하는 질문에 없는 내용인가요? (예/아니오)
3. 질문 잘하기 메뉴얼을 읽어보셨나요? (예/아니오)

[질문 내용]
ExConrollerAdvice 설명해주실때 메서드를 public 으로 선언하였는데 private 로 설정하여도 잘 동작하는데 public 일 필요가 있나요??

해당 부분을 public 으로 선언하면 유지보수하기 좋다는데 어떤 부분에서 그런건가요?

김영한 · Answer

안녕하세요. 황은경님 좋은 질문입니다. @ControllerAdvice 클래스의 메서드들(예: @ExceptionHandler , @InitBinder , @ModelAttribute 등이 붙은 메서드)은 실제로 private 으로 선언해도 Spring이 리플렉션(Reflection)을 통해 접근할 수 있기 때문에 동작합니다. 하지만 public 으로 선언하는 것이 권장되는 이유는 다음과 같습니다: 명확한 인터페이스 표현 : public 메서드는 이 메서드가 외부에서 호출될 수 있는 인터페이스임을 명확히 나타냅니다. @ControllerAdvice 는 본질적으로 프레임워크에 의해 호출되는 공개 API입니다. 상속과 확장성 : 다른 개발자가 해당 ControllerAdvice 클래스를 확장하거나 상속할 경우, public 메서드는 쉽게 재사용하거나 오버라이드할 수 있습니다. 일관된 코딩 스타일 : Spring Framework의 공식 예제와 문서에서는 일관되게 public 접근 제어자를 사용합니다. 프로젝트 전체에서 일관된 스타일을 유지하는 것이 가독성을 높입니다. Spring AOP와의 호환성 : Spring AOP는 기본적으로 public 메서드에만 적용됩니다. 만약 추후에 AOP를 활용한 부가 기능을 추가하려면 public 메서드여야 합니다. 테스트 용이성 : public 메서드는 단위 테스트에서 직접 호출하기 쉽습니다. Exception handler 등의 기능을 단위 테스트하기 위해서는 접근 가능해야 합니다. 실제로 private 으로 설정해도 동작한다는 점은 맞지만, 위의 이유들로 인해 유지보수 관점에서는 public 으로 선언하는 것이 더 바람직합니다. 감사합니다.

인프런 AI 인턴 · Answer

안녕하세요, 인프런 AI 인턴입니다. 황은경님. Spring에서 @RestControllerAdvice 나 @ControllerAdvice 에 정의된 메서드는 일반적으로 public으로 선언되어야 합니다. 이는 Spring 프레임워크가 이 메서드들을 애플리케이션 전반에 걸쳐 사용하도록 하기 위함인데요, 그 이유에 대해 자세히 설명해 드리겠습니다. @RestControllerAdvice 는 컨트롤러 전역에 걸쳐 예외 상황을 처리하기 위해 사용됩니다. 이 어노테이션을 사용한 클래스 내부에서 정의된 메서드는 스프링이 자동으로 찾고, HTTP 응답으로 전송할 데이터를 조작하기 위해 호출하게 됩니다. 프레임워크가 이러한 메서드들을 발견하고 사용할 수 있도록 하려면 메서드가 public하게 열려 있어야 합니다. 프레임워크 접근 가능성 : Spring 프레임워크가 이 메서드들을 찾고 호출할 수 있어야 하므로 public으로 선언해야 합니다. 메서드 접근 제한에 대한 규약 : private 메서드는 클래스 내부에서만 직접 호출 가능하므로, Spring이 호출하지 못하게 되어 바람직하지 않습니다. 캡슐화 및 공통 사용 : 예외 처리 메서드가 전역적으로 사용되도록 하기 위함입니다. 즉, 다양한 컨트롤러 클래스에서 동일한 예외 처리 로직을 재사용할 수 있습니다. 관련 질문과 답변을 통해 더 깊은 이해를 돕고자 아래 질문을 추천드립니다: - ControllerAdvice와 @ExceptionHandler의 차이 : ControllerAdvice를 통한 전역 예외 처리 로직에 대해 자세한 설명이 도움이 될 수 있습니다. 저는 질문자님의 이해를 돕고자 지식공유자님의 기존 답변을 참고하여 유사한 답변 링크를 추천해드리고 있습니다. 현재 베타 기능으로 답변이 만족스럽지 않을 수 있는 점 양해 부탁드립니다. 🙏 추가적으로 궁금한 점이 있으시면, 이어서 질문해 주세요. 곧 지식공유자께서 답변해 주실 것입니다.

인프런 커뮤니티 질문&답변

RestControllerAdvice 메서드 public vs private