참고
ObjectMapper
NOTE
ObjectMapper는 Jackson 라이브러리에서 찾아 볼 수 있으며, JSON - Java 객체간의 변환(직렬화, 역직렬화)를 해주는 라이브러리 클래스입니다.
ObjectMapper - 직렬화
NOTE
ObjectMapper는 리플렉션을 활용해서 객체로부터 Json 형태의 문자열을 만들어내는데, 이것을 직렬화라고 합니다. 해당 부분은 주로 @ResponseBody나 @RestController, ResponseEntity등을 사용하는데 처리됩니다.
String에서는 기본적으로 jackson 모듈의 ObjectMapper라는 클래스가 직렬화를 처리합니다. 그 과정에서 ObjectMapper의 writeValueAsString이라는 메소드가 사용됩니다.
public class Person {
private String name;
private int age;
// 기본 생성자 필요 for JSON 역직렬화
public Person() {}
public Person(String name, int age) {
this.name = name;
this.age = age;
}
// getter 메소드 ..
}
Java
복사
직렬화 객체
@Component
@RequiredArgsConstructor
public class ObjectMapperService {
private final ObjectMapper objectMapper;
// 직렬화
public String personToJson() throws Exception {
Person person = new Person("John Doe", 30);
return objectMapper.writeValueAsString(person);
// {"name":"John Doe","age":30}
}
}
Java
복사
직렬화 코드
•
ObjectMapper의 기본 설정으로는 public 필드 또는 public 형태의 getter만 접근이 가능합니다. 그러므로 직렬화를 위해 기본적으로 getter를 만드는 것이 좋습니다.
위에서 말한 getter의 접근으로 생성한다는 점이 때로는 의도치 않은 메시지를 만들어 내기도 합니다.
public class Person {
private String name;
private int age;
// 기본 생성자 필요 for JSON 역직렬화
public Person() {}
public Person(String name, int age) {
this.name = name;
this.age = age;
}
// 이상한 getter 추가
public String getNameWithAge(){
return name + "(" + age + ")";
}
}
Java
복사
@Component
@RequiredArgsConstructor
public class ObjectMapperService {
private final ObjectMapper objectMapper;
// 직렬화
public String personToJson() throws Exception {
Person person = new Person("John Doe", 30);
return objectMapper.writeValueAsString(person);
// {"name":"John Doe","age":30,"nameWithAge":"John Doe(30)"}
}
}
Java
복사
직렬화 코드
ObjectMapper - 역직렬화
NOTE
ObjectMapper는 리플렉션을 사용해 Json 문자열에서 객체를 생성하는데, 이를 역직렬화라고 합니다. 이 과정은 주로 @RequestBody로 json 문자열을 받을 때 사용됩니다.
역직렬화는 기본적으로 다음과 같은 과정을 거칩니다.
1.
기본 생성자를 사용해 객체를 생성합니다.
2.
필드 값을 찾아 바인딩합니다.
먼저, 객체를 생성하는데 기본 생성자가 없으면 에러가 발생합니다. 기본 생성자로 객체를 생성한 후에는 필드 값을 찾아야 하는데, 기본적으로 Public 필드 또는 public 형태의 getter를 이용해 찾을 수 있습니다.
@Test
void jsonToPersonTest() throws Exception {
String personJson = "{\"name\":\"John Doe\",\"age\":30}"; // json 문자열
Person result = objectMapperService.jsonToPerson(personJson);
System.out.println("result = " + result); // 객체값 출력!
}
Java
복사
ObjectMapper에서 LocalDateTime 사용하기
NOTE
LocalDateTime은 자바8에서 도입이 되었고, Jackson 라이브러리는 이전 버전과의 호환성을 위해 해당 타입에 대한 지원을 기본적으로 하지 않습니다. 따라서 이를 위해 JavaTimeMoudle을 ObjectMapeer에 등록해줘야 합니다.
objectMapper = new ObjectMapper();
objectMapper.registerModule(new JavaTimeModule()); // 추가
Java
복사
ObjectMapper를 위한 DTO 클래스 작성법
NOTE
ObjetMapper를 위한 DTO 클래스 작성법은 위에서 말한대로 기본 생성자와, 올바른 getter()함수를 제공하면 되지만, 이외에도 추가적인 어노테이션 옵션이 있습니다.
@Getter
@Builder
@NoArgsConstructor
@AllArgsConstructor
@ToString
public class Person {
private String name;
private int age;
// json 필드 이름과 다른경우 매칭시켜준다.
@JsonProperty("email_address")
private String email;
// json 직렬화/역직렬화에서 제외된다.
@JsonIgnore
private String password;
// 날짜형식을 지정해줍니다.
@JsonFormat(shape = JsonFormat.Shape.STRING, pattern = "yyyy-mm-dd")
private LocalDate birthDate;
}
Java
복사
@Test
void jsonTest3() throws Exception {
// Person 객체 생성
Person person = new Person("John Doe", 30, "johndoe@example.com", "supersecret", LocalDate.of(1990, 1, 1));
String jsonString = objectMapper.writeValueAsString(person);
System.out.println("jsonString = " + jsonString); // email -> email_address로 변환, password 무시
// {"name":"John Doe","age":30,"birthDate":"1990-01-01","email_address":"johndoe@example.com"}
String jsonInput = "{\"name\":\"Jane Doe\",\"age\":25,\"email_address\":\"janedoe@example.com\",\"birthDate\":\"1995-05-30\"}";
Person personFromJson = objectMapper.readValue(jsonInput, Person.class);
System.out.println("personFromJson = " + personFromJson);
// Person(name=Jane Doe, age=25, email=janedoe@example.com, password=null, birthDate=1995-05-30)
}
Java
복사