在Rust中使用Serde的詳細(xì)指南
在處理HTTP請(qǐng)求時(shí)，我們總是需要在一種數(shù)據(jù)結(jié)構(gòu)(可以是enum、struct等)和一種可以存儲(chǔ)或傳輸并稍后重建的格式(例如JSON)之間來(lái)回轉(zhuǎn)換。
Serde是一個(gè)庫(kù)(crate)，用于高效、通用地序列化和反序列化Rust數(shù)據(jù)結(jié)構(gòu)。在本文中，將詳細(xì)介紹如何使用Serde對(duì)數(shù)據(jù)結(jié)構(gòu)進(jìn)行序列化和反序列化操作。
讓我們從一個(gè)簡(jiǎn)單的結(jié)構(gòu)體Student開(kāi)始，它的定義如下所示，并進(jìn)行初始化。
use serde::{Serialize, Deserialize};
#[derive(Debug, Clone, Serialize, Deserialize)]
struct Student {
pub name: String,
pub student_id: String,
}
let student = Student{name:"tom".to_owned(), student_id:"J19990".to_owned()};約定
對(duì)于上面的示例，如果我們使用serde_json::to_string(&student)將其轉(zhuǎn)換為JSON字符串，那么輸出將如下所示。
{
"name": "tom",
"student_id": "J19990"
}看起來(lái)太棒了！然而，這依賴于發(fā)送HTTP請(qǐng)求的內(nèi)容，很有可能會(huì)與Rust中的數(shù)據(jù)結(jié)構(gòu)有不同的大小寫(xiě)約定。
基本上有兩種方法可以進(jìn)行約定：可以重命名字段；也可以對(duì)整個(gè)結(jié)構(gòu)應(yīng)用大小寫(xiě)約定。
例如，我們實(shí)際上希望使用studentId而不是student_id作為字段名。
方法1：使用#[serde(rename="")重命名單個(gè)字段。
struct Student {
pub name: String,
#[serde(rename="studentId")
pub student_id: String,
}方法2：使用#[serde(rename_all="camelCase")將大小寫(xiě)約定駝峰形式，應(yīng)用于整個(gè)結(jié)構(gòu)體。
#[serde(rename_all = "camelCase")]
struct Student {
pub name: String,
pub student_id: String,
}任何一種方法都會(huì)給出以下輸出：
{
"name": "tom",
"studentId": "J19990"
}除了camelCase之外，還可以應(yīng)用其他的約定。取值為“l(fā)owercase, UPPERCASE, PascalCase, camelCase, snake_case, SCREAMING_SNAKE_CASE, kebab-case, SCREAMING-KEBAB-CASE”。
Skip
Skip可用于不希望序列化或反序列化的字段。下面是一個(gè)簡(jiǎn)單的例子。讓我們給Student添加birth_year和age。
struct Student {
pub name: String,
pub student_id: String,
pub birth_year: u32,
pub age: u32,
}我們可能希望動(dòng)態(tài)更新年齡，因此需要對(duì)學(xué)生birth_year的引用。但是，當(dāng)我們發(fā)送請(qǐng)求時(shí)，應(yīng)該只顯示age字段，這可以使用#[serde(skip)]來(lái)解決。
struct Student {
pub name: String,
pub student_id: String,
#[serde(skip)]
pub birth_year: u32,
pub age: u32,
}通過(guò)這樣做，我們的JSON對(duì)象將變成：
{
"name": "tom",
"studentId": "J19990",
"age": 123
}Skip If
最常見(jiàn)的兩種使用方法是作用于Option字段和空的vector字段。
Option
假設(shè)我們有一個(gè)middle_name: Option<String>字段，如果我們想在學(xué)生沒(méi)有這個(gè)字段的情況下跳過(guò)這個(gè)字段，我們可以這樣做。
struct Student {
pub name: String,
pub student_id: String,
#[serde(skip_serializing_if="Option::is_none")]
pub middle_name: Option<String>
}這將為帶有或不帶有中間名的學(xué)生生成如下JSON：
// 沒(méi)有中間名
{
"name": "tom",
"studentId": "J19990",
}
// 有中間名
{
"name": "tom",
"studentId": "J19990",
"middleName": "middle"
}Vector
例如，我們?yōu)閟tudent結(jié)構(gòu)體提供了pets: Vec<String>字段。由于學(xué)生不必?fù)碛袑櫸?，它可以是一個(gè)空向量。
要跳過(guò)對(duì)空向量的序列化，可以向字段添加以下屬性。
#[serde(skip_serializing_if="Vec::is_empty")]
pub pets: Vec<String>,有屬性和沒(méi)有屬性之間的輸出差異如下所示。
// 沒(méi)有屬性
{
"name": "tom",
"studentId": "J19990",
"pets": []
}
// 有屬性
{
"name": "tom",
"studentId": "J19990"
}Flatten
讓我們創(chuàng)建一個(gè)名為SideInfo的新結(jié)構(gòu)體，并將Student結(jié)構(gòu)體更改為以下內(nèi)容。
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
struct Student {
pub name: String,
pub student_id: String,
#[serde(skip_serializing_if="Option::is_none")]
pub side_info: Option<SideInfo>
}
#[derive(Debug, Clone, Serialize, Deserialize, Default)]
#[serde(rename_all = "camelCase")]
struct SideInfo {
#[serde(skip_serializing_if="Option::is_none")]
pub pets: Option<Vec<String>>,
#[serde(skip_serializing_if="Option::is_none")]
pub address: Option<String>,
}讓我們創(chuàng)建一個(gè)新的Student
let student = Student{name:"dan".to_owned(), student_id: "1".to_owned(), side_info:Some(SideInfo{address:Some("47 street".to_owned()), ..Default::default()})};并輸出它的JSON字符串：
{
"name": "dan",
"studentId": "1",
"sideInfo": {
"address": "47 street"
}
}如你所見(jiàn)，地址字段嵌套在sideInfo中。我們可以通過(guò)將屬性flatten添加到Student結(jié)構(gòu)體中的sideInfo字段上，來(lái)消除嵌套。
#[serde(skip_serializing_if="Option::is_none", flatten)]
pub side_info: Option<SideInfo>就會(huì)變成：
{
"name": "dan",
"studentId": "1",
"address": "47 street"
}枚舉上的標(biāo)簽與非標(biāo)簽
假設(shè)我們有一個(gè)StudentList enum，如下所示：
enum StudentList {
Student1(Student),
Student2(Student)
}定義學(xué)生名單
let student1 = Student{name:"tom".to_owned(), student_id:"J19990".to_owned(), pets: vec![], middle_name:Some("middle".to_owned())};
let student2 = Student{name:"dan".to_owned(), student_id:"J19990".to_owned(), pets: vec![], middle_name:Some("middle".to_owned())};
let student_list = vec![StudentList::Student1(student1), StudentList::Student2(student2)];如果我們像現(xiàn)在一樣打印出JSON，它將如下所示，它是有標(biāo)簽的，是serde的默認(rèn)行為。
[
{
"Student1": {
"name": "tom",
"studentId": "J19990",
"pets": [],
"middleName": "middle"
}
},
{
"Student2": {
"name": "dan",
"studentId": "J19990",
"pets": [],
"middleName": "middle"
}
}
]如果你希望所有標(biāo)簽都具有相同的名稱，例如Student，該怎么辦呢？你可能認(rèn)為可以使用rename_all來(lái)實(shí)現(xiàn)這一點(diǎn)，但實(shí)際上并非如此，應(yīng)該手動(dòng)重命名枚舉中的每個(gè)變體。
#[derive(Debug, Clone, Serialize, Deserialize)]
enum StudentList {
#[serde(rename="Student")]
Student1(Student),
#[serde(rename="Student")]
Student2(Student)
}輸出如下：
[
{
"Student": {
"name": "tom",
"studentId": "J19990",
"pets": [],
"middleName": "middle"
}
},
{
"Student": {
"name": "dan",
"studentId": "J19990",
"pets": [],
"middleName": "middle"
}
}
]不加標(biāo)簽
如果我們只想要一個(gè)簡(jiǎn)單的學(xué)生數(shù)組，而不顯示枚舉變量名稱，該怎么辦？我們可以通過(guò)向枚舉中添加#[serde(untagged)]屬性來(lái)實(shí)現(xiàn)這一點(diǎn)。通過(guò)這樣做，我們的輸出將變成：
[
{
"name": "tom",
"studentId": "J19990",
"pets": [],
"middleName": "middle"
},
{
"name": "dan",
"studentId": "J19990",
"pets": [],
"middleName": "middle"
}
]內(nèi)部標(biāo)簽
枚舉的另一種表示形式是內(nèi)部標(biāo)簽，讓我們創(chuàng)建一個(gè)包含不同學(xué)生類型的新枚舉，我們將有班長(zhǎng)、副班長(zhǎng)和普通學(xué)生。
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(tag = "type", rename_all="camelCase")]
enum StudentType {
Regular(Student),
Leader(Student),
SubLeader(Student)
}指定serde(tag = "type")將允許我們?cè)趦?nèi)容中使用標(biāo)簽來(lái)識(shí)別我們正在處理的變體，如下所示：
[
{
"type": "leader",
"name": "tom",
"studentId": "J19990",
"pets": [],
"middleName": "middle"
},
{
"type": "regular",
"name": "dan",
"studentId": "J19990",
"pets": [],
"middleName": "middle"
}
]相鄰標(biāo)簽
表示標(biāo)簽和內(nèi)容作為同一對(duì)象中的兩個(gè)字段彼此相鄰。將枚舉的屬性修改如下：
#[serde(tag = "type", content = "student", rename_all="camelCase")]json數(shù)據(jù)變成：
[
{
"type": "leader",
"student": {
"name": "tom",
"studentId": "J19990",
"pets": [],
"middleName": "middle"
}
},
{
"type": "regular",
"student": {
"name": "dan",
"studentId": "J19990",
"pets": [],
"middleName": "middle"
}
}
]可以用Serde做很多很多事情。
