[Java] ObjectMapper (FasterXML/jackson)

Published: by Creative Commons Licence

참고 문서

jackson은 1.x 버전과 2.x 버전의 패키지가 다르다.

  • 1.x: org.codehaus.jackson
  • 2.x: com.fasterxml.jackson

Map/Collections - JSON간 변환

writeValueAsString()

writeValueAsString( value )
  • value: String 타입으로 변환할 대상

readValue()

readValue( arg, type )
  • arg: 지정된 타입으로 변환할 대상
  • type: 대상을 어떤 타입으로 변환할것인지 클래스를 명시한다. Class, TypeReference 타입이 올 수 있다.
mapper.readValue(arg, ArrayList.class);
mapper.readValue(arg, new ArrayList<HashMap<String, String>>().getClass());
mapper.readValue(arg, new TypeReference<ArrayList<HashMap<String, String>>>() {});

map

맵 타입이 JSON 형식의 String 타입으로 변환된다. 자바스크립트에 JSON을 넘겨줄 때 유용하다.

import com.fasterxml.jackson.databind.ObjectMapper;

public class Test2 {
    public static void main(String[] args) throws Exception {

        ObjectMapper mapper = new ObjectMapper();

        HashMap<String, String> map = new HashMap<String, String>();
        map.put("name", "steave");
        map.put("age", "32");
        map.put("job", "baker");

        System.out.println(map);
        System.out.println(mapper.writeValueAsString(map));
    }
}

// {age=32, name=steave, job=baker}
// {"age":"32","name":"steave","job":"baker"}

위와 반대로 JSON을 맵 타입으로 변환하려면 다음처럼 작성한다:

import com.fasterxml.jackson.core.type.TypeReference;
import com.fasterxml.jackson.databind.ObjectMapper;

public class Test2 {
    public static void main(String[] args) throws Exception {

        ObjectMapper mapper = new ObjectMapper();
        HashMap<String, String> map = new HashMap<String, String>();

        String jsn = "{\"age\":\"32\",\"name\":\"steave\",\"job\":\"baker\"}";

        map = mapper.readValue(jsn,
                new TypeReference<HashMap<String, String>>() {});

        System.out.println(map);
    }
}

// {name=steave, age=32, job=baker}

Collections<Map>

다음은 view에 전달할 model이 List<map<?, ?>> 타입일 때 이를 JSON으로 변환하는 방법이다. 사용방법은 크게 다르지 않고 writeValueAsString(), readValue() 메서드를 사용하되 타입 명시만 달리한다.

import com.fasterxml.jackson.core.type.TypeReference;
import com.fasterxml.jackson.databind.ObjectMapper;

public class Test2 {
    public static void main(String[] args) throws Exception {

        ObjectMapper mapper = new ObjectMapper();

        // map -> json
        ArrayList<HashMap<String, String>> list
                = new ArrayList<HashMap<String,String>>();

        HashMap<String, String> map = new HashMap<String, String>();
        map.put("name", "steave");
        map.put("age", "32");
        map.put("job", "baker");
        list.add(map);

        map = new HashMap<String, String>();
        map.put("name", "matt");
        map.put("age", "25");
        map.put("job", "soldier");
        list.add(map);

        System.out.println(mapper.writeValueAsString(list));

        // json -> map
        String jsn = "[{\"age\":\"32\",\"name\":\"steave\",\"job\":\"baker\"},"
                + "{\"age\":\"25\",\"name\":\"matt\",\"job\":\"soldier\"}]";
        list = mapper.readValue(jsn,
                new TypeReference<ArrayList<HashMap<String, String>>>() {});

        System.out.println(list);
    }
}

// [{"age":"32","name":"steave","job":"baker"},{"age":"25","name":"matt","job":"soldier"}]
// [{name=steave, age=32, job=baker}, {name=matt, age=25, job=soldier}]

어노테이션

TODO

@JsonInclude

보통 아래처럼 null이 아닌 필드만 변환하도록 씀:

@JsonInclude(JsonInclude.Include.NON_NULL)
public class JsonResponse {
    // ... 생략

문자열에서 java.time 패키지로 타입 변환하기

테스트 환경 정보

  • Java 17

"2021-03-91" 같은 문자열을 java.time 패키지의 LocalDate, LocalDateTime 같은 날짜 타입의 값으로 변환하려고 하면 이런 예외가 발생한다:

com.fasterxml.jackson.databind.exc.InvalidDefinitionException: Java 8 date/time type java.time.LocalDate not supported by default: add Module "com.fasterxml.jackson.datatype:jackson-datatype-jsr310" to enable handling

에러 메시지가 알려주는 것처럼 모듈을 추가하면 해결된다.

해결 방법

<!-- https://mvnrepository.com/artifact/com.fasterxml.jackson.datatype/jackson-datatype-jsr310 -->
<dependency>
    <groupId>com.fasterxml.jackson.datatype</groupId>
    <artifactId>jackson-datatype-jsr310</artifactId>
    <version>2.14.2</version>
</dependency>

@Getter
@Setter
public class ParseMe {
    private LocalDate birthDate;
}

ObjectMapper mapper = new ObjectMapper();
mapper.registerModule(new JavaTimeModule());

String str = "{\"birthDate\":\"2018-01-01\"}";
ParseMe parseMe = mapper.readValue(str, ParseMe.class);