ObjectMapper 란 ?

📌 ObjectMapper 란?

• Jackson 라이브러리의 ObjectMapper란, Java 객체를 JSON으로 또는 반대로 JSON을 java 객체로 역직렬화하는 도구이다.
• Spring boot에서도 기본적으로 사용되며 REST API 개발 시 JSON 데이터를 직렬화한거나 역직렬화 하는 데 많이 활용됩니다.

📌 직렬화와 역직렬화

1. 직렬화

• 정의 : 객체를 바이트 스트림(파일, JSON, XML 등)으로 변환하는 과정으로 데이터를 저장하거나 전송할 때 사용된다.
  ex. java 객체 -> JSON

• 용도 :

  • 영구 저장 : 객체를 파일이나 데이터베이스에 저장하여 나중에 복원할 수 있다.
  • 네트워크 전송 : 객체를 네트워크를 통해 다른 시스템으로 전송할 수 있다
  • 캐시 : 객체를 캐시에 저장하여 빠르게 접근할 수 있다.

2. 역직렬화

• 정의 : 바이트 스트림(파일, JSON, XML 등)을 -> 객체로 변환하는 과정으로 네트워크 통신, 파일 저장된 데이터를 다시 사용 가능한 객체로 복원할 때 사용된다.

• 용도 :

  	- 데이터 복원 : 파일이나 데이터베이스에 저장된 객체를 다시 메모리로 불러올 수 있다.

  • 네트워크 데이터 수신 : 네트워크를 통해 받은 데이터를 객체로 변환할 수 있다.

-JSON과 바이트 스트림
JSON 자체는 바이트 스트림이 아니지만, JSON 데이터를 저장하거나 전송할 때는 바이트 스트림 형태로 처리된다.

📌 직렬화 (Serialization) - Java Object to JSON

public class Student {
	
    private Long id;
	private String name;
    
    public Student() {}

    public Burger(Long id, String name) {
        this.id = id;
        this.name = name;
    }
   
   // Getter 및 Setter 메서드


public class Main {
    public static void main(String[] args) {
        try {
            ObjectMapper objectMapper = new ObjectMapper();

            Student student = new Student(1L, 김일반);

            // student 객체를 JSON 문자열로 변환
            String prettyJson = objectMapper.writeWithDefaultPrettyPrinter()
            									.writeValueAsString(student);

            // JSON 문자열 출력
            System.out.println(jsonString);

        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

출력 : 

{
	"id":1,
	"name":"김일반"
}

• objectMapper 의 writeValueAsString() 메서드로 변환하고자 하는 객체 -> JSON 형태로 쉽게 변환할 수 있다.

---

📌 역직렬화 (Deserialization) - JSON to Java Object

public class Student {
	
    private Long id;
	private String name;
    
    public Student() {}

    public Burger(Long id, String name) {
        this.id = id;
        this.name = name;
    }
    
   // Getter 및 Setter 메서드
   
   
    @Override
    public String toString() {
        return "Student{" +
                "id='" + id +"L"+ '\'' +
                ", name='" + name + '\'' +
                "}';
    }


public class Main {
    public static void main(String[] args) {
        try {
            // JSON 문자열
            String jsonString = "{\"id\": 1,\"name\":\"김일반\"}";

            // ObjectMapper 인스턴스 생성
            ObjectMapper objectMapper = new ObjectMapper();

            // JSON 문자열을 Studednt 객체로 변환
            Student student = objectMapper.readValue(jsonString, Student.class);

            // 변환된 객체 출력 @Override 메서드 사용
            System.out.println(student);

        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

출력 :  Student{id='1L', name='김일반'}

• objectMapper 의 readValue() 메서드로 변환하고자 하는 JSON -> Java 객체로 쉽게 변환할 수 있다.

📌Custom Serialization or Deserialization

• 직렬화를 임의로 커스텀할 수 있다.
• 보통 이런 경우는 특정 필드의 변환 방식을 변경
• 민감한 정보를 ***** 로 변환
• 필드명을 변경하는 경우 유연하게 변경이 가능하다.

1. Custom serializer - Object -> JSON

package com.example.study2.basic3.student;

import java.io.IOException;

import com.fasterxml.jackson.core.JsonGenerator;
import com.fasterxml.jackson.databind.SerializerProvider;
import com.fasterxml.jackson.databind.ser.std.StdSerializer;

public class CustomStudentSerializer extends StdSerializer<Student> {

	public CustomStudentSerializer() {
		this(null);
	}

	public CustomStudentSerializer(Class<Student> t) {
		super(t);
	}

	@Override
	public void serialize(Student student, JsonGenerator jsonGenerator, SerializerProvider serializerProvider) throws
		IOException {
		jsonGenerator.writeStartObject();
        jsonGenerator.writeNumberField("age", student.getId());
		jsonGenerator.writeStringField("teacher", student.getName());
		jsonGenerator.writeEndObject();
	}
}

package com.example.study2.basic3;

import com.example.study2.basic3.student.CustomStudentSerializer;
import com.example.study2.basic3.student.Student;
import com.fasterxml.jackson.core.Version;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.module.SimpleModule;

public class CustomObToJSON {
	public static void main(String[] args) {

		try {
			ObjectMapper mapper = new ObjectMapper();
            
			SimpleModule module = new SimpleModule("CustomStudentSerializer",
				new Version(1, 0, 0, null, null, null));
                
			module.addSerializer(Student.class, new CustomStudentSerializer());
            
			mapper.registerModule(module);
            
			Student student = new Student(46L, "선생님");

			String studentJson = mapper.writeValueAsString(student);
			System.out.println(studentJson);
		} catch (Exception e) {
			e.printStackTrace();
		}
	}
}

출력 : {
		  "age " : 46,
  		  "teacher " : "선생님"
       }

• 커스텀 직렬화를 이용하면 기존의 Student의 필드명을 name -> teacher로 변환 가능하다
• 예를 들면 JSON value와 java 객체의 필드명이 서로 다른 경우 커스텀 직렬화를 이용한다.

2. custom Deserializer - JSON -> Object

package com.example.study2.basic3.student;

import java.io.IOException;

import com.fasterxml.jackson.core.JacksonException;
import com.fasterxml.jackson.core.JsonParser;
import com.fasterxml.jackson.core.ObjectCodec;
import com.fasterxml.jackson.databind.DeserializationContext;
import com.fasterxml.jackson.databind.JsonNode;
import com.fasterxml.jackson.databind.deser.std.StdDeserializer;

public class CustomStudentDeserializer extends StdDeserializer<Student> {

	public CustomStudentDeserializer() {
		this(null);
	}

	public CustomStudentDeserializer(Class<?> vc) {
		super(vc);
	}

	@Override
	public Student deserialize(JsonParser jsonParser, DeserializationContext deserializationContext) throws
		IOException,
		JacksonException {
		Student student = new Student();
		ObjectCodec codec = jsonParser.getCodec();
		JsonNode node = codec.readTree(jsonParser);

		try {
			String name = node.get("name").asText();
			Long id = node.get("id").asLong();
			student.updateName(id, name);
			return student;
		} catch (Exception e) {
			e.printStackTrace();
		}
		throw new RuntimeException();
	}

}

package com.example.study2.basic3.student;

import com.fasterxml.jackson.core.Version;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.module.SimpleModule;

public class CustomJsonTpOb {
	public static void main(String[] args) {

		try {
			String json = "{\"id\" : 44555, \"name\" : \"김일반\"}";
			
            ObjectMapper mapper = new ObjectMapper();
			
            SimpleModule module = new SimpleModule("CustomStudentDeserializer",
				new Version(1, 0, 0, null, null, null));
			
            module.addDeserializer(Student.class, new CustomStudentDeserializer());
			
            mapper.registerModule(module);
			
            Student student = mapper.readValue(json, Student.class);
			
            System.out.println(student);
		} catch (Exception e) {
			e.printStackTrace();
		}
	}
}

출력 :  Student{id='44555L', name='김일반'}

• 커스텀 역직렬화를 통해서 특정 조건만 만족하는 데이터 일부만 역직렬화가 가능하다.

---

참고문서