วิธีนำ Custom Serializer ไปใช้กับ @JsonSerialize ใน Java

คำอธิบายประกอบ @JsonSerialize ใช้ประกาศ custom serializer ระหว่างการ serialize ฟิลด์ เราสามารถนำ custom serializer ไปใช้โดยการ extends คลาส StdSerializer และ override เมธอด serialize() ของ StdSerializer

Syntax

@Target(value={ANNOTATION_TYPE, METHOD, FIELD, TYPE, PARAMETER})
@Retention(value=RUNTIME)
public @interface JsonSerialize

ตัวอย่างการใช้งาน

import java.io.*;
import com.fasterxml.jackson.core.*;
import com.fasterxml.jackson.databind.*;
import com.fasterxml.jackson.databind.annotation.*;
import com.fasterxml.jackson.databind.ser.std.*;

public class JsonSerializeAnnotationTest {
    public static void main(String[] args) throws JsonProcessingException, IOException {
        Employee emp = new Employee(115, "Adithya", new String[] {"Java", "Python", "Scala"});
        ObjectMapper mapper = new ObjectMapper();
        String jsonString = mapper.writerWithDefaultPrettyPrinter().writeValueAsString(emp);
        System.out.println(jsonString);
    }
}

// CustomSerializer class
class CustomSerializer extends StdSerializer<Employee> {
    public CustomSerializer(Class<Employee> t) {
        super(t);
    }
    
    public CustomSerializer() {
        this(Employee.class);
    }
    
    @Override
    public void serialize(Employee emp, JsonGenerator jgen, SerializerProvider sp) throws IOException {
        StringBuilder sb = new StringBuilder();
        jgen.writeStartObject();
        jgen.writeNumberField("id", emp.getId());
        jgen.writeStringField("name", emp.getName());
        
        for (String s : emp.getLanguages()) {
            sb.append(s).append(";");
        }
        jgen.writeStringField("languages", sb.toString());
        jgen.writeEndObject();
    }
}

// Employee class
@JsonSerialize(using = CustomSerializer.class)
class Employee {
    private int id;
    private String name;
    private String[] languages;
    
    public Employee(int id, String name, String[] languages) {
        this.id = id;
        this.name = name;
        this.languages = languages;
    }
    
    public int getId() { return this.id; }
    public String getName() { return this.name; }
    public String[] getLanguages() { return this.languages; }
    
    @Override
    public String toString() {
        StringBuilder sb = new StringBuilder("ID: ").append(this.id)
            .append("\nName: ").append(this.name)
            .append("\nLanguages:");
        for (String s : this.languages) {
            sb.append(" ").append(s);
        }
        return sb.toString();
    }
}

ผลลัพธ์ (Output)

{
  "id" : 115,
  "name" : "Adithya",
  "languages" : "Java;Python;Scala;"
}

คำอธิบาย

CustomSerializer ใช้ JsonGenerator สร้าง JSON output เอง โดยรวม array ของ languages เป็น string เดียวคั่นด้วย semicolon แทนที่จะเป็น JSON array ตามปกติ

กรณีการใช้งาน (Use Cases)

• ต้องการรูปแบบ JSON output ที่แตกต่างจาก default (เช่น รวม array เป็น string)
• ต้องการเพิ่ม computed fields ที่ไม่มีใน object
• ต้องการ format วันที่/เวลา/ตัวเลข แบบกำหนดเอง
• ต้องการ serialize object graph แบบกำหนดเอง (ป้องกัน circular reference)
• ต้องการ conditional serialization ตามเงื่อนไข

สรุป

@JsonSerialize ร่วมกับ custom serializer ให้การควบคุม JSON output อย่างเต็มที่ เหมาะสำหรับกรณีที่ต้องการรูปแบบเฉพาะหรือจัดการโครงสร้างข้อมูลซับซ้อน