내가 만든 non-null 변수에서 NullPointerException이 발생할 리가 없어!

카카오스타일 전시 UX팀이 Kotlin에서 non-null로 선언한 변수에 null이 들어와 NPE가 난 사례를 파고든 글이다. 지그재그 특가의 알림 유도 UI가 일부 사용자에게 노출되지 않아 추적해보니 non-null 필드에서 예외가 나고 있었다. 원인이 Kotlin 버전, JSON 라이브러리, 타입 정의 세 갈래로 갈린다.

핵심 포인트

Kotlin에는 null과 non-null 구분이 있지만 기반인 JVM에는 없어 언어의 제약과 무관하게 내부 값이 null일 수 있다.
Gson은 JSON에 필드가 없어도 조용히 null을 넣어 객체를 만들고 그 값을 쓰는 시점에 NPE가 난다.
1.4.20에서는 when 안에서 이 값을 쓸 때 예외가 났고 1.5로 올리자 재현되지 않았다.
같은 상황에서 if는 통과하는데 when은 예외가 나 when이 if의 문법 설탕만은 아니라는 것이 드러났다.
Jackson과 kotlinx는 파싱 단계에서 필수 필드 누락을 예외로 잡아준다.
근본 원인은 GraphQL 스키마에서 nullable인 필드를 Kotlin 클래스에서 non-null로 선언한 것이었다.

상세 정리

증상: 알림 동의 상태 값이 특정 값일 때 알림 유도 UI를 띄우게 돼 있었는데 동의하지 않은 일부 사용자에게 UI가 안 떴다.
진단: 해당 값을 반환하는 함수에서 NPE가 발생하고 있었다.
재현 코드: user 객체는 있지만 그 안에 필드가 없는 JSON을 Gson으로 파싱하고 when으로 분기하는 최소 코드로 재현했다.
재현 결과: 출력해보면 non-null로 선언한 필드에 null이 들어간 객체가 그대로 만들어지고, when 분기에서 String의 hashCode 호출로 NPE가 난다.
오해 정정: user 자체가 null이어서 나는 게 아니다. 실제 환경에서 user가 null이면 로그를 남기게 해봤지만 아무것도 찍히지 않았다.
원인 1 Kotlin 버전: 오래전에 만들어진 서비스라 1.4.20을 쓰고 있었고 1.5로 올리자 문제가 사라졌다.
when과 if의 차이: 같은 상황에서 when을 if로 바꾸면 예외가 나지 않아 구버전 when 동작에 특이한 부분이 있다고 짐작했다.
enum 실험: 필드 타입을 enum으로 바꾸면 최신 2.0.0에서도 if는 통과하고 when에서 ordinal 호출로 NPE가 난다.
원인 2 JSON 라이브러리: Kotlin의 null 구분은 JVM에는 없으므로 파싱 결과에 null이 섞일 수 있다. TypeScript도 같은 이유로 파싱 후 타입 검증을 권한다.
Jackson의 동작: kotlinModule을 등록하면 non-nullable 파라미터에 값이 없다는 예외를 파싱 단계에서 던진다.
kotlinx의 동작: 필수 필드 누락을 MissingFieldException으로 잡는다.
kotlinx의 추가 차이: 필드를 nullable로 선언했을 때 Gson과 Jackson은 문제가 없었지만 kotlinx는 JSON에 그 키가 명시적으로 null로 들어 있어야만 정상 파싱했다.
원인 3 타입 정의: GraphQL 스키마에서는 nullable인 필드였는데 Kotlin 클래스에서 non-null로 선언돼 있었다. GraphQL에 익숙하지 않던 시기의 실수로 본다.
재발 방지: 최근에 쓴 GraphQL 처리 코드는 스키마에서 자동 생성한 클래스 정의를 쓰고 있어 같은 문제가 없다.