[ Jackson ] Jackson mock 테스트 역직렬화 오류

기본적인 코드를 테스트 하면서 JSON을 파싱하는 JackSon 라이브러리를 너무 모르고 사용을 하였다.

그래서 간단한 테스트 코드를 작성을 해도 오류가 발생했다. 일단 발생한 오류를 설명하고 Jackson이 어떻게 파싱을 하고 그 이후에 어떤 행동을 하는지 알아보겠다.

 

@PostMapping
@ResponseStatus(HttpStatus.CREATED)
public UserData create(@RequestBody UserData userData){
    User user = userService.registerUser(userData);

    return UserData.builder()
            .email(user.getEmail())
            .build();
}

@Getter
@Builder
@AllArgsConstructor
public class UserData {
    private Long id;
    private String email;
    private String name;
}

@Test
@DisplayName("register")
public void registerUserWithValidAttributes() throws Exception{
    //given
    given(userService.registerUser(any(UserData.class))).will(invocation -> {
        UserData userData = invocation.getArgument(0);
        User user = User.builder()
                .email(userData.getEmail())
                .build();
        return user;
    });

    //when
    //{"email":"test@exampel.com", "password":"1234",...}
    mockMvc.perform(post("/users")
            .contentType(APPLICATION_JSON)
            .content("{\"email\": \"test@example.com\", \"name\":\"tester\"," +
                    "\"password\": \"test\"}"))
            .andExpect(status().isCreated())
            .andExpect(content().string(
                    containsString("\"email\":\"test@example.com\"")
            ));

    //Then
    verify(userService).registerUser(any(UserData.class));
}

위에 코드는 간단하게 생성 테스트를 확인하는 테스트 코드이다.

UserData를 매개변수로 받아 UserData 타입으로 반환을 해주는 코드이다.

테스트 코드에 대해서 설명하면 content로 JSON을 넘겨서 Jackson을 통하여 직렬화를 하고 이후 andExcept의 content를 통하여 역직렬화를 하여 검증하는 코드이다.

내 생각으로는 문제가 없다고 생각을 하였으나 오류가 하나 발생하는데

org.springframework.web.util.NestedServletException: Request processing failed; 
nested exception is org.springframework.http.converter.HttpMessageConversionException: 
Type definition error: [simple type, class com.codesoom.assignment.dto.UserData];
nested exception is com.fasterxml.jackson.databind.exc.InvalidDefinitionException:
Cannot construct instance of `com.codesoom.assignment.dto.UserData` 
(no Creators, like default constructor, exist): cannot deserialize from Object value
(no delegate- or property-based Creator)
 at [Source: (PushbackInputStream); line: 1, column: 2]

이러한 오류가 발생을 하였다. 오류에 대해서 살펴보면 UserData를 역직렬화 하는 과정에서 생긴 문제이다.

 Cannot construct instance of `com.codesoom.assignment.dto.UserData` (no Creators, like default constructor, exist)

그 이유를 찾아보면 Jackson 라이브러리가 UserData 클래스의 기본 생성자를 호출하여 객체를 생성하려고 하지만 지금 클래스에는 기본 생성자가 없기 때문에 역직렬화가 실패한다는 의미이다. 

 

그래서 UserData에 기본 생성자를 추가하면 문제가 해결된다.

 

이제 Jackson에 대해서 알아보자

Jackson라이브러리는 JSON 데이터를 자바 객체로 변환하는 역직렬화 과정에 대해서 다음과 같이 실행된다.

1 .JSON 데이터를 가져옵니다.

2. JSON 데이터를 자바 객체로 변환하기 위해 Jackson 라이브러리가 제공하는 ObjectMapper를 사용합니다.

3. ObjectMapper는 JSON 데이터를 읽어들여 객체로 변환하는데, 이때 클래스의 정보를 참조하여 객체를 생성합니다.

4. 클래스에 매개변수가 없는 기본 생성자가 있는 경우, Jackson은 이 생성자를 호출하여 객체를 생성합니다.

5. 생성자가 없는 경우, Jackson은 다른 생성자를 사용하여 객체를 생성합니다. 이때 생성자의 매개변수와 JSON 데이터의 키가 일치하는지 확인하고, 일치하는 경우 해당 값을 매개변수에 전달하여 객체를 생성합니다.

6. 클래스에 매개변수가 없는 기본 생성자도 없고, 다른 생성자도 존재하지 않는 경우, Jackson은 객체를 생성할 수 없는 오류가 발생합니다.