แปลง JSON เป็น struct ของ Rust!

ป้อน JSON เพื่อสร้างโค้ด struct ของ Rust รวมถึงออบเจ็กต์ที่ซ้อนกัน! รองรับ serde Serialize, Deserialize, #[serde(rename)]
JSON
ผลลัพธ์
 

แปลง JSON เป็น struct ของ Rust!

แปลงตัวอย่าง JSON เป็น struct ของ Rust ที่พร้อมใช้กับ serde ทุก struct derive Debug, Clone, Serialize, Deserialize ชื่อฟิลด์เป็นไปตามธรรมเนียม snake_case ของ Rust และถ้าต่างจากคีย์เดิมจะผูกกลับไปด้วย #[serde(rename)]

เป็นจุดเริ่มต้นเมื่ออยากได้ response ของ reqwest ที่มีไทป์ ต้องการไทป์ request สำหรับ extractor Json<T> ของ axum หรือ actix-web หรือกำลังเขียน CLI ที่พาร์ส JSON ของ log หรือ event

วิธีใช้

  1. วาง JSON อาร์เรย์ที่มีหลายรายการช่วยให้ตรวจพบฟิลด์ที่ไม่บังคับได้
  2. ใส่ชื่อ struct ระดับบนสุดใน ชื่อไทป์ (เช่น AccessLog)
  3. วางผลลัพธ์ลงไฟล์ .rs แล้วเพิ่ม serde (เปิด feature derive) และ serde_json ใน Cargo.toml
  4. ใช้งานผ่าน serde_json::from_str::<AccessLog>(&body)? หรือ resp.json::<AccessLog>().await?

ตัวอย่าง

อินพุต (JSON)
{
  "timestamp": 1714550400,
  "level": "warn",
  "type": "http_request",
  "status": 503,
  "latency_ms": 1250.7,
  "headers": [{ "name": "user-agent", "value": "curl/8.4" }],
  "trace_id": null
}
เอาต์พุต (Rust · serde)
use serde::{Deserialize, Serialize};

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct AccessLog {
    pub timestamp: i64,
    pub level: String,
    #[serde(rename = "type")]
    pub type_: String,
    pub status: i64,
    pub latency_ms: f64,
    pub headers: Vec<Header>,
    pub trace_id: serde_json::Value,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct Header {
    pub name: String,
    pub value: String,
}

type เป็นคำสงวนของ Rust ฟิลด์จึงเป็น type_ พร้อม #[serde(rename = "type")] จำนวนเต็มเป็น i64 ไม่ว่าจะขนาดเท่าไร และ latency_ms เป็น f64 ส่วน trace_id มีแต่ null จึงไม่รู้ไทป์และยังเป็น serde_json::Value ให้เปลี่ยนเป็นไทป์จริง เช่น Option<String>

ฟีเจอร์ที่รองรับ

  • #[derive(Debug, Clone, Serialize, Deserialize)] และฟิลด์ pub ในทุก struct
  • ใส่ #[serde(rename = "originalKey")] รายฟิลด์เมื่อคีย์ต่างจากชื่อฟิลด์แบบ snake_case
  • ฟิลด์ที่ขาดไปในบางรายการ: Option<T> พร้อม #[serde(default, skip_serializing_if = "Option::is_none")]
  • ฟิลด์ที่มีเสมอแต่บางครั้งเป็น null: Option<T> ธรรมดาโดยไม่มี attribute
  • ไทป์: i64 สำหรับจำนวนเต็ม, f64 สำหรับทศนิยม, bool, String, Vec<T> และ serde_json::Value สำหรับไทป์ที่ปนกัน
  • คีย์ที่เป็นคำสงวนอย่าง type, match หรือ ref ได้ขีดล่างต่อท้าย (type_)
  • อาร์เรย์ระดับบนสุดได้ pub type Root = Vec<RootItem>;

กรณีการใช้งาน

response ของ reqwest ที่มีไทป์

เปลี่ยนการเข้าถึง serde_json::Value อย่าง ["status"].as_i64() เป็น resp.json::<AccessLog>() เพื่อให้ฟิลด์ที่สะกดผิดพังตั้งแต่ตอนคอมไพล์

request body ใน axum หรือ actix-web

สร้าง struct จาก JSON ที่ไคลเอนต์ส่งมา แล้วรับเป็น Json(payload): Json<CreateOrder> request ที่ขาดฟิลด์หรือไทป์ผิดจะถูกเฟรมเวิร์กปฏิเสธก่อนถึงโค้ด handler

CLI วิเคราะห์ log แบบ JSON Lines

สร้าง struct จาก log หนึ่งบรรทัด แล้ว deserialize ทีละบรรทัดจาก BufReader::lines() ก็ได้เครื่องมือสรุปผลรายฟิลด์ในไม่กี่บรรทัด

ข้อควรระวังและข้อจำกัด

  • จำนวนเต็มเป็น i64 เสมอแม้ค่าจะเล็ก ถ้ารู้ช่วงค่าก็ลดขนาดเอง เช่น status code เป็น u16 หรือตัวนับเป็น u32
  • timestamp และสตริงวันที่ยังเป็น i64 หรือ String การเปลี่ยนเป็นไทป์ของ chrono หรือ time ต้องเปิด feature serde ของ crate นั้น
  • ผลลัพธ์ที่ใช้ serde_json::Value เขียน path เต็ม จึงไม่ต้อง use เพิ่ม แต่ยังต้องมี dependency serde_json
  • การเปลี่ยนชื่อทำรายฟิลด์ ไม่ใช่ #[serde(rename_all = "camelCase")] ระดับ struct ถ้าคีย์ใช้ธรรมเนียมเดียวกันทั้งหมด จะรวบเองก็ได้
  • ไม่สร้าง tagged enum ฟิลด์ที่มีชุดค่าตายตัวอย่าง "level": "warn" เหมาะจะเปลี่ยนเป็น enum ภายหลัง

คำถามที่พบบ่อย

ทำไมฟิลด์ที่ไม่บังคับถึงมี #[serde(default)] ด้วย?

serde เติม None ให้ Option ที่ไม่มีค่าอยู่แล้ว แต่การระบุ default ชัดเจนทำให้ยังรับคีย์ที่ขาดได้ถ้าภายหลังเปลี่ยนไทป์เป็นอย่าง Vec<T> ส่วน skip_serializing_if จะตัดฟิลด์ที่เป็น None ออกเมื่อเขียน JSON กลับ รูปร่างเดิมจึงคงอยู่

ฟิลด์ที่เป็น null ได้กับฟิลด์ที่อาจไม่มี ต่างกันอย่างไรในผลลัพธ์?

ทั้งสองเป็น Option<T> แต่เฉพาะฟิลด์ที่คีย์อาจไม่มีเท่านั้นที่ได้ attribute default และ skip_serializing_if ฟิลด์ที่มีเสมอแต่บางครั้งเป็น null จะถูกเขียนกลับเป็น null

ทำไมไม่ยืมด้วยฟิลด์ &str และ lifetime 'de?

ฟิลด์แบบ zero-copy (&'a str) อยู่นานกว่าบัฟเฟอร์อินพุตไม่ได้ ซึ่งไม่สะดวกกับการจัดการ response ทั่วไป ค่าเริ่มต้นจึงเป็น String แบบ owned ถ้าเรื่องประสิทธิภาพสำคัญ ให้เปลี่ยนฟิลด์ที่ใช้บ่อยเป็น Cow<'a, str>

เพิ่ม derive Default หรือ PartialEq ได้ไหม?

ผลลัพธ์ derive แค่ Debug, Clone, Serialize และ Deserialize เพิ่มเข้าไปในรายการ derive เองได้เมื่อทุกไทป์ของฟิลด์รองรับ (serde_json::Value implement PartialEq)