Controller에서 의존성 주입 대상 필드 값이 NULL이 되는 문제와 해결방안, 이유

👋 배경

컨트롤러 매핑 메서드에서 의존성 주입된 필드에 접근하는데, 해당 필드가 null로 되어서 NullPointException이 뜨는 상황이 발생했다.

 

의존성 주입 대상 필드는 컴포넌트 스캔 범위에도 포함되어 있었으며, @Component 어노테이션을 통해 빈으로 등록해 놓은 상황이라 경험상으로 의존성 주입된 필드 값이 null인 것을 이해할 수 없었다.

 

해당 문제에 대해 여기저기 찾아보다가 원인을 찾고 해결하게 되었다.

🔎 원인

어이없게도 컨트롤러 매핑 메서드의 접근 지시자가 private인 것이 원인이었다.

 

    @PostMapping("/")
    @ResponseStatus(HttpStatus.OK)
    private ProductResponse.Register register(ProductDto productDto) {
    	...
    }

 

필자는 습관적으로 메서드를 정의할 때 private으로 지정하는데, 그러다가 해당 부분을 놓쳤던 것으로 보인다.

해당 부분은 컴파일 오류로 잡을 수 없기 때문에, 이 부분을 놓친다면 원인 파악을 위해 삽질을 하게 될 수도 있다.

👀 이유

그러다가 문득 '왜 private 메서드는 의존성 주입된 필드 값을 이용할 수 없는 걸까?' 의문이 들었고 관련 내용에 대해 알게 된 내용에 대해 공유하고자 한다.

 

기본적으로 스프링 컨트롤러의 매핑 메서드에 private 메서드를 사용하는 것은 스프링 프레임워크의 작동 방식과 원칙에 어긋난다.

 

매핑 메서드는 HTTP 요청을 처리하기 위해 스프링 MVC에 의해 호출되는 public 메서드이므로, 이러한 메서드는 스프링의 DispatcherServlet에 의해 동적으로 호출되며, 이를 위해 반드시 public 접근 제한자를 가져야 한다.

 

추가적으로 private 메서드를 매핑 메서드로 사용하려고 하면 다음과 같은 문제들이 발생한다고 한다.

1. 접근성 문제

private 메서드는 클래스 외부에서 접근할 수 없다. 스프링의 DispatcherServlet은 컨트롤러의 public 메서드만 호출할 수 있으므로, private 메서드는 매핑 메서드로 사용될 수 없다.

2. 스프링 빈 라이프사이클 위반

스프링은 빈(bean)의 라이프사이클을 관리하며, 컨트롤러 빈의 public 메서드에 대해 요청 매핑, 인터셉터 처리, AOP 프락시 등을 적용한다. private 메서드는 이러한 처리를 받을 수 없어, 스프링의 기능을 제대로 활용할 수 없다.

3. 프레임워크 규약 위반

스프링 MVC는 특정 규약을 따른다. 예를 들어, @RequestMapping이나 @GetMapping, @PostMapping 등의 애너테이션을 사용하여 HTTP 요청을 처리할 메서드를 지정한다. 이러한 애너테이션은 public 메서드에만 적용되어야 하며, private 메서드에 적용하는 것은 스프링 MVC의 설계 원칙에 반한다.

4. 리플렉션 제한

스프링은 내부적으로 리플렉션을 사용하여 컨트롤러의 메서드를 찾고 호출한다. private 메서드는 리플렉션을 통해서도 일반적으로 접근할 수 없으므로, 스프링이 해당 메서드를 매핑 메서드로 사용하는 것은 불가능하다.

📌 결론

스프링 컨트롤러에서는 매핑 메서드를 항상 public으로 선언해야 하며, private 메서드는 매핑 메서드로 사용되어서는 안 된다. 의존성 주입된 필드를 사용하려면, 해당 필드가 초기화되고 관리되는 public 메서드 내에서 사용해야 한다.

📚  REFERENCE

https://stackoverflow.com/questions/70143003/null-exception-service-in-a-spring-restcontroller-using-constructor-injection