Spring @RequestBody 필드 바인딩이 되지 않는 이슈 (feat. Lombok, Jackson의 네이밍 차이)

개요

Spring에서 클라이언트의 요청을 JSON 형식으로 받고, @RequestBody를 사용하여 JSON body의 데이터를 Java Object의 필드와 역직렬화(Deserialize)를 통해 각 데이터가 정상적으로 바인딩이 이루어지게 됩니다. 

하지만, 필드의 특정 네이밍 + Lombok의 @Getter를 사용할 때 바인딩이 정상적으로 되지 않는 이슈가 존재하는데요, 이와 관련하여 간략히 살펴보겠습니다.

 

 

### Send POST request with json body
POST http://localhost:8080/api/v1/test
Content-Type: application/json

{
  "pId": "pId",
  "poId":  "poId"
}

 

예를 들어, 위와 같은 서버 코드가 존재하고 클라이언트에서 위 JSON 형식으로 body 데이터를 전송하면,

서버의 TestBody Object에 pId, poId가 정상적으로 바인딩이 됩니다.

 

하지만, 위의 경우 pId는 null이 되고, poId만 정상적으로 바인딩이 되는데요 이와 관련해서 왜 pId는 바인딩이 되지 않는지 살펴보겠습니다.

 

 

@RequestBody의 동작과정 관련해서는 RequestResponseBodyMethodProcessor 클래스의 resolveArgument() 메서드를 통해 JSON 데이터와 Java Object 간 바인딩이 되는데요, 이번 포스팅에서는 자세한 설명은 생략하겠습니다.

(궁금하시다면 아래와 비슷하게 브레이크 포인트를 걸고, 따라 들어가보시면 될 것 같습니다. 😅)

 

 

 

분석

순서대로는 아니지만, 대략적으로 위 클래스들에 대해 브레이크 포인트를 걸어놓고 들어가다 보면,

POJOPropertiesCollector 클래스에서 Object의 field를 찾아 설정하는 부분이 있는데 여기서 문제가 발생합니다.

 

@RequestBody의 JSON <-> Object 역직렬화는 대략적으로 아래와 같은 흐름으로 들어가게 됩니다.

AbstractJackson2HttpMessageConveter > ObjectMapper > Deserializer... > BeanDeserializerFactory > ... > POJOPropertiesCollector > DefaultAccessorNamingStrategy > ...

 

그럼 앞의 클래스는 일부 생략하고, POJOPropertiesCollector 클래스부터 간략히 살펴보겠습니다.

 

 

POJOPropertiesCollector

collectAll()

 

POJOPropertiesCollector#collectAll()

collectAll() 메서드에 주석도 많고, 이것저것 메서드들도 많은데요

위에서 Java Object 의 데이터를 설정하는 메서드가 _addFields(props), _addMethods(props) 등입니다.

 

위에서 _addFields(props) 메서드를 거치면서 pId, poId 필드가 설정이 되었지만,

이상하게도 _addMethods(props) 메서드를 거치면 "pid"라는 알 수 없는 필드가 하나 더 추가가 됩니다.

(poId 필드와 다르게 pId, pid는 getter, setter도 null인 것을 볼 수 있습니다.)

 

그럼 _addMethods(props)에 문제가 있는 것 같으니, 내부 코드를 조금 더 보겠습니다.

 

 

_addMethods(Map<String, POJOPropertyBuilder> props)

현재 메서드가 getter이면 _addGetterMethod()를 호출하고, setter이면 _addSetterMethod()를 호출합니다.

 

 

실제 문제가 발생하는 필드 "pId"에 대해 Lombok이 생성하는 Getter 메서드의 네이밍은 getPId()이고,
이어서 _addGetterMethod()를 호출합니다.

 

 

_addGetterMethod(Map<String, POJOPropertyBuilder> props, AnnotatedMethod m, AnnotationIntrospector ai)

_addGetterMethod()에서 메서드의 네이밍을 가져오는데요,

현재 로직에서는 _accessorNaming.findNameForRegularGetter(m, m.getName())를 호출합니다.

 

 

DefaultAccessorNamingStrategy

AccessorNamingStrategy >&nbsp;DefaultAccessorNamingStrategy

findNameForRegularGetter(AnnotatedMethod am, String name)

DefaultAccessorNamingStrategy#findNameForRegularGetter

위의 findNameForRegularGetter() 메서드에서는 마지막 return에서 legacyManglePropertyName() 메서드를 호출합니다.

 

 

legacyManglePropertyName(final String basename, final int offset)

위 159라인부터 시작되는 코드가 Object의 필드명을 생성하는 부분입니다.

 

필드명은 pId이지만, 169라인의 append() 메서드를 보면 소문자로 변경한 문자를 넣기 때문에 I가 아닌 i를 저장하여 필드명을 만들어내고, 이로인해 호출부인 POJOPropertiesCollector#_addGetterMthod()에서는 pid를 바인딩하여 저장하게 됩니다.

POJOPropertiesCollector#_addGetterMthod()

 

 

size = 3 (pId, poId, pid)

size = 2 (poId, pid)

의도하지 않은 pid가 추가로 프로퍼티에 저장이 되고, 이후 _removeUnwantedProperties(props) 메서드에서는 특정 조건(visible)에 따라 pId를 필드에서 제거하여 의도하지 않은 "pid" 라는 네이밍을 가진 필드가 저장되어서 기존의 "pId" 네이밍을 가진 필드는 null 처리가 되는 것으로 보입니다.

 

 

그럼 왜 위와 같은 문제가 발생할까요?

결론부터 말씀드리면 Lombok에서 생성하는 getter/setter 메서드의 네이밍과, Jackson에서 인식하는 getter/setter 메서드의 네이밍이 다르기 때문에 발생하는 문제입니다.

 

일반적인 경우에는 문제가 발생하지 않지만, "pId"의 경우 getter의 네이밍이 getPId()가 되어야 할 것 같지만(실제 Lombok의 네이밍), IntelliJ에서는 getpId()로 만들어 주고, Jackson에서도 getpId()의 경우에만 인식하기 때문에 문제가 발생합니다.

 

일반적으로 발생하는 케이스는 아니고, 위의 경우 처럼 getter/setter의 네이밍이 연속된 2개의 대문자가 될 때 발생하는 것 같습니다.

(aBc, pId, cId ...)

 

 

실제 테스트 해보기

위 테스트를 보시면 아시겠지만, Lombok과 IntelliJ가 만들어내는 getter의 네이밍은 서로 다릅니다.

 

 

JavaBeans의 컨벤션

https://download.oracle.com/otndocs/jcp/7224-javabeans-1.01-fr-spec-oth-JSpec/

위 이미지는 Oracle에 존재하는 JavaBeans 규약에서 8.8 Capitalization of inferred names. 중 일부 문장입니다.

 

마지막 문장에서 "가장 처음 두 문자가 연속으로 대문자라면, 그대로 둔다"라고 나와있는데요, 이러한 이유 때문에

pId의 경우 JavaBeans 규약을 따르면 IntelliJ가 만들어내는 getpId()가 맞는 네이밍이라고 볼 수 있습니다.

(저는 getPId()라고 생각했었는데, 이와 관련하여 stackoverflow 에도 여러 의견들이 존재합니다.)

 

그렇기 때문에 위와 같은 필드의 네이밍에 대해서 Lombok을 사용하면 JavaBeans와는 다르기 때문에 문제가 발생하는데요,

일반적인 상황은 아니지만 많은 Java 개발자들이 Lombok을 사용하는 것으로 미루어보면, 동일한 이슈를 겪었던 사람이 존재했을 것 같은데요, 찾아보니 역시 존재했습니다.

 

https://github.com/FasterXML/jackson-databind/issues/3538

field name changed when deserializing bean · Issue #3538 · FasterXML/jackson-databind

위 이슈에서 마지막 코멘트를 보니, (제가 이해한 게 맞다면) 이러한 경우, 사용자가 비표준적인(JavaBeans의 네이밍 규약을 따르지 않는)

필드명과 getter/setter가 연결(바인딩?) 되도록 어노테이션을 사용해야 하고, 이를 통해 Jackson이 프로퍼티 명을 인식할 수 있도록 사용해야 한다는 것을 95%정도 확신한다고 말을 하는 것 같네요.

 

위 cowtowncoder가 남긴 내용을 잘못 이해하여 관련 이슈를 등록해놓긴 했는데, 해당 이슈가 반영되어 수정이 되는것은 쉽지 않아 보이네요.. ㅎㅎ

https://github.com/FasterXML/jackson-databind/issues/4421

Problem with property name on deserialization wrt non-standard property names · Issue #4421 · FasterXML/jackson-databind

 

 

 

해결법

내용은 굉장히 길지만, 사실 해결법은 굉장히 간단합니다.

 

1. @JsonProperty 어노테이션 사용 (JacksonAnnotationIntrospector 클래스에서 사용)

 

 

2. Lombok 어노테이션 대신, IDE가 만들어주는 getter/setter 사용

 

 

3. 필드의 네이밍을 변경(pId -> poId) 하면 정상적으로 바인딩이 잘 됩니다.