Kotlin 의 변수가 NotNull type 이지만 null 이 들어갈수 있다.

작성일 | In |

Kotlin 의 변수가 NotNull 타입이지만, Null 이 저장될 수 있는 케이스를 알아봅니다.

spring, jpa 를 사용할때 접할 수 있는 케이스를 알아 봅니다.

Goal

  • Kotlin 사용시 변수가 NotNull 타입이지만, null 로 저장될 수 있는 케이스를 정리해봅니다.
  • 왜 null 로 값이 할당될 수 있는지 알아 봅니다.

테스트 환경 버전

  • spring boot: 2.6.7
  • spring data jpa: 2.6.4

Kotlin 의 null 처리

1
2
val name: String? // nullable
val name: String // notNull
  • 코틀린을 사용하시는 분들은 기본적으로 코틀린은 Null 타입 구분을 ? 을 통해 언어적으로 분리하고 있는것을 알고 계실겁니다.
  • 하지만, String 와 같이 NotNull 인 경우에도 null 이 저장될 수 있습니다.

[예시1] Spring MVC

Collection<NotNull Type> 형태의 요청에서 null 이 삽입될 수 있습니다.

Dto 형태

1
2
3
data class TestDto(
    val list: List<Long>, // <== NotNull Type Long
)
  • TestDto 에서 들고 있는 list 는 List<Long> 으로, Long? 이 아닌 NotNull 타입 으로 선언 해주었습니다.

로직

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
@RequestMapping("api/v1/error")
@RestController
class ErrorTestController {

    @GetMapping("/list-empty-string")
    fun listEmptyStringNullTest(@RequestBody dto: TestDto) {
        dto.list.forEach {
            log.info("number: $it")
        }
    }

    companion object {
        val log = LoggerFactory.getLogger(this::class.java)
    }
}
  • dto 에서 list 를 받아서 출력하는 간단한 코드입니다.

일반적인 에러가 나는 요청

1
2
3
4
5
6
GET http://localhost:8080/api/v1/error/list-empty-string
Content-Type: application/json

{
  "list": [20,21,"yoonsung"] // Long 으로 받아야 하지만, "yoonsung" 으로 number 가 아닌형태로 요청
}
  • [20,21,”yoonsung”] 는 매핑 과정에서

JSON parse error: Cannot deserialize value of type long from String`

에러가나서, 애초에 로직을 타지 않는것을 확인할 수 있습니다.

문제가 되는 Request

1
2
3
4
5
6
7
8
9
10
11
12
POST http://localhost:8080/api/v1/post/test1
Content-Type: application/json

{
  "list": ["20","21",""]
}

// or

{
  "list": ["20","21",null]
}

image

image

  • 20, 21 까지 처리 하다가 "" or null 를 처리하는 시점에 가서야 "java.lang.NullPointerException" 이 발생하게 됩니다.
  • 즉 dto 에 매핑과정에서 오류가 발생하는것이 아닌, 실제 null 로 차있는 element 에 접근하는 시점에 가서야 NPE 가 발생 한다는것에 주의해야 합니다.

image

  • 디버그 모드로 보았을때, 3번째 element 인 Long 이 NotNull type 이지만 null 로 차있는것을 확인할 수 있습니다.

원인(추측)

reflection

  • 해당 이슈가 발생하는 원인은 , 단위로 데이터를 자른뒤 필드에 매핑하게 되는데요. 이때 spring boot 에서 기본적으로 사용하는 Jackson 은 기본적으로 reflection 을 통해 역직렬화를 하게 됩니다.

  • 이 과정에서 premitive 타입을 따로 구분하지 않는 코틀린의 경우, Long 인 필드에 null 이 채워지는 상황이 발생할 수 있게 되는것으로 예측하고 있습니다. (reflection 을 이용하면, final 한 변수도 변경할 수 있게 됩니다. 관련 내용)

  • 실제로 Kotlin NotNull Type 의 경우, java 로 디컴파일을 해보는 경우 @NotNull 어노테이션을 이용한 형태로 존재하는것을 확인할 수 있습니다. (디컴파일 하는방법)
1
class Goodall(val name: String)
  • 위와 같은 kotlin 코드도 디컴파일을 해보면

image

  • @NotNull 어노테이션에 의존적인 형태인것을 볼수 있습니다.
  • 즉, @NotNull 을 통한 null validition 이 되기전에 null 이 삽입된것으로 보입니다.

실제로 java reflection 을 사용하는 경우

NotNull 이지만, Null 이 차있게 됩니다.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
class ReflectionMember(
    val name: String
)

fun main() {
    javaReflection()
}

private fun javaReflection() {
    val clazzConstructor = ReflectionMember::class.java.getDeclaredConstructor(String::class.java)
    val member = clazzConstructor.newInstance("goodall")

    println(member.name)    // goodall

    val name = ReflectionMember::class.java.getDeclaredField("name")
    name.isAccessible = true
    name.set(member, null) // <== null 로 할당

    println(member.name)    // null
}

image

  • java reflection 을 사용하는 경우, val 이지만 값이 변경 되고, String 이지만 null 이 할당 되는것을 볼 수 있습니다.

Generic type arguments, varargs, and array elements nullability are not supported yet, but should be in an upcoming release. See this discussion for up-to-date information.

  • 실제로 spring docs 의 kotlin null-safety 를 언급한 내용에 따르면 list 형태의 경우에는 아직 null-safe 가 지원되지 않는다고 명시되어 있습니다.

2023-01-26 작성. 내부코드를 열어보고, kotlin + spring 에서의 동작 과정을 정리한뒤 수정 예정

List 형태가 아닌 단일값인 경우

1
2
3
4
5
6
7
8
data class TestDto(
    val age: Int,
)

// Request
{
  "age": null,
}

image

  • Number 형태(Int, Long)가 "" or null 로 요청이 오는경우, 0 으로 자동매핑 해줍니다.

String 단일

  • string 을 받아야 하는데 명시적인 요청으로 null 이 오는 경우에는, 매핑단계에서 json 파싱에러가 발생합니다.
1
2
3
4
5
6
7
8
data class TestDto(
    val name: String,
)

// Request
{
  "name": null,
}

“org.springframework.http.converter.HttpMessageNotReadableException: JSON parse error: Instantiation of [simple type, class com.example.mvc.controller.TestDto] value failed for JSON property name due to missing (therefore NULL) value for creator parameter name which is a non-nullable type;

List<String>

List<Long> 과 동일한 문제가 발생 합니다.

1
2
3
4
5
6
7
8
// Request
{
  "list": ["jys","goodall", null]
}

data class TestDto(
    val list: List<String>,
)

image

  • 3번째 element 가 null 인것을 확인할 수 있습니다.

[예시2] Spring Data JPA

DB 데이터

image

image

  • id, name 을 컬럼으로 가진 테이블이 있습니다.
  • 이때 name 은 nullable 하고, 실제로 데이터는 null 이 차있도록 해보겠습니다. {id:2, name: null}

Entity 구조

1
2
3
4
5
6
7
8
9
10
@Table(name = "members")
@Entity
class Member(
    @Column(name = "name")
    val name: String, // <=== not null

    @Column(name = "id")
    @Id @GeneratedValue(strategy = GenerationType.IDENTITY)
    val id: Long = 0L
)
  • JPA 에서 사용할 엔티티를 만듭니다.
  • 이때 name 은 notNull 인 String 형태로 만들어주었습니다.

조회

1
2
3
4
5
6
7
8
9
10
@Transactional
fun contextLoads() {
    memberRepository.findAll().forEach { member ->
        log.info("name: ${member.name}")
    }
}

companion object {
    val log = LoggerFactory.getLogger(this::class.java)
}

image

image

  • 엔티티를 조회하고, name 필드를 보면 사진과 같이 null 이 할당되어있는것을 볼 수 있습니다.
  • val String 이 notNull 타입이라고 생각했지만, 해당 필드에 접근했을때 null 이 나와서 NPE 가 발생할 수 있습니다.
  • 즉 DB 내의 데이터가 nullable 하고 실제로 null 데이터가 들어가있다면, kotlin 의 NotNull Field 에 null 이 들어갈 수 있게됩니다.
  • 실제 운영중인 DB의 스키마와, JPA 엔티티에서 사용하는 필드들간의 notNull 조건 유무가 같은지 확인하는것을 권장드립니다.

JPA 의 경우에도 reflection 을 통해서 데이터를 삽입하게 되는데, mvc 에서 발생한 이유와 원인이 같다고 추측중입니다.

Conclusion

  • Kotlin 에서 NotNull 이라고해서, 완벽하게 NotNull 이 보장되지는 않는다.
  • java 리플랙션이 사용되는 라이브러리, 프레임워크의 경우에는 NotNull Type 임에도 null 이 채워질 수 있음을 고려하고 있자.

Reference

  • https://docs.spring.io/spring-framework/docs/current/reference/html/languages.html#kotlin-null-safety
  • https://discuss.kotlinlang.org/t/null-safety-and-java-reflection/8525/17