[JAVA, Spring] NullPointerException 해결과정

특정 부분에서 수정 (PUT) 요청을 할 시 500 에러가 뜬다는 이슈가 있었다.
이슈를 재현하고 로그를 확인하니 WARN NullPointerException ~~ 이렇게 떠있었다.
 
1. 발생하는 부분을 try catch로 묶어서 NullPointerException 시 로그를 띄워주었다. 

 
로그 메시지는 아래와 같았다.

20231114 10:45:48.808 [http-nio-8090-exec-9] ERROR c.i.l.a.f.s.FileComponentUrlServiceImpl - NullPointerException caught:  
java.lang.NullPointerException: null
        at com.api.filecomponenturl.service.FileComponentUrlServiceImpl.updateUrl(FileComponentUrlServiceImpl.java:436)

NullPointerException이 발생했고,
updateUrl 메소드, FileComponentUrlServiceImpl.java:436라인이라고 알려주고 있다.
 
 
436라인의 코드는 다음과 같았다.

// json 형식 검사
if (!urlUpdateReq.getExtInfo().isEmpty() && !UrlUtil.checkValidJson(urlUpdateReq.getExtInfo())) {
	throw new ApiException("error.fileComponent.invalidExtInfoFormat", HttpStatus.BAD_REQUEST);
}

 
 
디버깅을 위해 해당 라인에서 참조되는 모든 객체가 null인지 아닌지 확인해야했다.
해당 라인에서 null이 될 수 있는 객체는 urlUpdateReq와 urlUpdateReq.getExtInfo() 이며, UrlUtil.checkValidJson 메소드 내부에서도 null 참조가 발생할 수 있어 검토해야했다.
 

1. urlUpdateReq의 null 체크: 먼저 urlUpdateReq 객체가 null인지 확인. 이 객체가 null이면, 메소드 내부에서 urlUpdateReq.getExtInfo()를 호출할 때 NullPointerException이 발생한다.
2. getExtInfo()의 리턴 값 체크: urlUpdateReq가 null이 아니라면, getExtInfo() 메소드의 반환 값이 null인지 확인. isEmpty() 메소드는 null에 대해 호출할 수 없으므로, 이 부분에서도 NullPointerException이 발생할 수 있다.
3. UrlUtil.checkValidJson 메소드 검사: 이 메소드 내부에서 null을 적절히 처리하고 있는지 확인. 입력 값으로 null이 들어갈 경우를 처리하는 로직이 있는지 검토해야 한다.

 
이를 확인하기 위해 다음과 같이 코드에 로그를 추가한다.

if (urlUpdateReq == null) {
    log.error("urlUpdateReq is null");
    throw new IllegalArgumentException("urlUpdateReq cannot be null");
}

String extInfo = urlUpdateReq.getExtInfo();
if (extInfo == null) {
    log.error("extInfo in urlUpdateReq is null");
    throw new IllegalArgumentException("extInfo cannot be null");
}

if (!extInfo.isEmpty() && !UrlUtil.checkValidJson(extInfo)) {
    log.error("Invalid JSON format in extInfo: " + extInfo);
    throw new ApiException("error.fileComponent.invalidExtInfoFormat", HttpStatus.BAD_REQUEST);
}

 
이렇게 코드를 수정하고 상황을 재현해보니

20231114 11:01:47.600 [http-nio-8090-exec-3] ERROR c.i.l.a.f.s.FileComponentUrlServiceImpl - extInfo in urlUpdateReq is null 
20231114 11:01:47.613 [http-nio-8090-exec-3] WARN o.s.w.s.m.m.a.ExceptionHandlerExceptionResolver - Resolved [java.lang.IllegalArgumentException: extInfo cannot be null]

extInfo in urlUpdateReq is null 조건문이 출력되었다. 
 
아래와 같이 해결할 수 있었다.

// json 형식 검사
String extInfo = urlUpdateReq.getExtInfo();
if (extInfo != null && !extInfo.isEmpty() && !UrlUtil.checkValidJson(extInfo)) {
	throw new ApiException("error.fileComponent.invalidExtInfoFormat", HttpStatus.BAD_REQUEST);
}

 
!= null 과 isEmpty()의 차이는 아래의 글에서 다루었다. 
 
 
https://yesolz.tistory.com/entry/JAVA-null%EA%B3%BC-isEmpty%EC%9D%98-%EC%B0%A8%EC%9D%B4

[JAVA] null과 isEmpty의 차이