Rust XML序列化与反序列化库yaserde_derive的使用

简介

yaserde_derive是一个Rust库，用于实现结构体与XML格式之间的序列化和反序列化。它通过过程宏提供了一种简单的方式来标注Rust结构体，使其能够与XML相互转换。

主要特性

• 支持结构体与XML的相互转换
• 提供自定义标签名、命名空间等配置选项
• 支持属性序列化
• 类型安全的数据转换

使用方法

1. 添加依赖

首先在Cargo.toml中添加依赖：

[dependencies]
yaserde = "0.8"
yaserde_derive = "0.8"

2. 基本使用示例

use yaserde_derive::{YaDeserialize, YaSerialize};

#[derive(YaSerialize, YaDeserialize, PartialEq, Debug)]
#[yaserde(rename = "book")]
pub struct Book {
    #[yaserde(attribute)]
    id: String,
    title: String,
    author: String,
    #[yaserde(rename = "pub_date")]
    publication_date: String,
}

fn main() {
    let book = Book {
        id: "1".to_string(),
        title: "Rust Programming".to_string(),
        author: "John Doe".to_string(),
        publication_date: "2023-01-01".to_string(),
    };

    // 序列化为XML
    let xml = yaserde::ser::to_string(&book).unwrap();
    println!("Serialized XML:\n{}", xml);

    // 反序列化回结构体
    let deserialized: Book = yaserde::de::from_str(&xml).unwrap();
    println!("Deserialized: {:?}", deserialized);
}

3. 输出示例

序列化后的XML可能如下：

<?xml version="1.0" encoding="utf-8"?>
<book id="1">
  <title>Rust Programming</title>
  <author>John Doe</author>
  <pub_date>2023-01-01</pub_date>
</book>

4. 高级配置选项

命名空间支持

#[derive(YaSerialize, YaDeserialize, PartialEq, Debug)]
#[yaserde(
    rename = "book",
    namespace = "ns: http://example.com/namespace"
)]
pub struct Book {
    #[yaserde(attribute, prefix = "ns")]
    id: String,
    // ...
}

嵌套结构

#[derive(YaSerialize, YaDeserialize, PartialEq, Debug)]
pub struct Library {
    #[yaserde(rename = "book")]
    books: Vec<Book>,
}

枚举支持

#[derive(YaSerialize, YaDeserialize, PartialEq, Debug)]
pub enum BookType {
    #[yaserde(rename = "paperback")]
    Paperback,
    #[yaserde(rename = "hardcover")]
    Hardcover,
    #[yaserde(rename = "ebook")]
    EBook,
}

完整示例demo

下面是一个结合了上述所有特性的完整示例：

use yaserde_derive::{YaDeserialize, YaSerialize};

// 定义书籍类型枚举
#[derive(YaSerialize, YaDeserialize, PartialEq, Debug)]
pub enum BookType {
    #[yaserde(rename = "paperback")]
    Paperback,
    #[yaserde(rename = "hardcover")]
    Hardcover,
    #[yaserde(rename = "ebook")]
    EBook,
}

// 定义书籍结构体，包含命名空间和属性
#[derive(YaSerialize, YaDeserialize, PartialEq, Debug)]
#[yaserde(
    rename = "book",
    namespace = "ns: http://example.com/namespace"
)]
pub struct Book {
    #[yaserde(attribute, prefix = "ns")]
    id: String,
    title: String,
    author: String,
    #[yaserde(rename = "pub_date")]
    publication_date: String,
    #[yaserde(rename = "type")]
    book_type: BookType,
}

// 定义图书馆结构体，包含嵌套的书籍集合
#[derive(YaSerialize, YaDeserialize, PartialEq, Debug)]
pub struct Library {
    #[yaserde(rename = "book")]
    books: Vec<Book>,
}

fn main() {
    // 创建图书馆数据
    let library = Library {
        books: vec![
            Book {
                id: "1".to_string(),
                title: "Rust Programming".to_string(),
                author: "John Doe".to_string(),
                publication_date: "2023-01-01".to_string(),
                book_type: BookType::Paperback,
            },
            Book {
                id: "2".to_string(),
                title: "Advanced Rust".to_string(),
                author: "Jane Smith".to_string(),
                publication_date: "2023-02-15".to_string(),
                book_type: BookType::Hardcover,
            },
        ],
    };

    // 序列化为XML
    let xml = yaserde::ser::to_string(&library).unwrap();
    println!("Serialized XML:\n{}", xml);

    // 反序列化回结构体
    let deserialized: Library = yaserde::de::from_str(&xml).unwrap();
    println!("Deserialized: {:?}", deserialized);
}

注意事项

1. 默认情况下，字段名会转换为小写作为XML标签名
2. 可以使用#[yaserde(rename = "...")]自定义标签名
3. 使用#[yaserde(attribute)]将字段序列化为XML属性而非子元素
4. 对于Option类型，值为None时默认不会序列化

yaserde_derive提供了一种高效且类型安全的方式来处理Rust结构体与XML之间的转换，特别适合需要与XML接口交互的应用场景。