Rust宏代码生成库schematic_macros的使用：自动化Schema构建与过程宏开发

安装

在项目目录中运行以下Cargo命令：

cargo add schematic_macros

或者在Cargo.toml中添加以下行：

schematic_macros = "0.18.11"

示例

以下是一个使用schematic_macros进行自动化Schema构建与过程宏开发的完整示例：

use schematic_macros::*;

// 定义一个Schema结构体
#[derive(Schema)]
struct UserSchema {
    #[schema(required)]
    id: u64,
    
    #[schema(min_length = 3, max_length = 20)]
    username: String,
    
    #[schema(format = "email")]
    email: String,
    
    #[schema(default = false)]
    is_admin: bool,
    
    #[schema(nested)]
    profile: ProfileSchema,
}

// 嵌套的Schema结构体
#[derive(Schema)]
struct ProfileSchema {
    #[schema(min_length = 0, max_length = 500)]
    bio: Option<String>,
    
    #[schema(min = 13, max = 120)]
    age: Option<u8>,
}

// 使用过程宏生成验证器
#[derive(Validator)]
#[validator(schema = "UserSchema")]
struct UserValidator;

fn main() {
    let user_data = json!({
        "id": 123,
        "username": "john_doe",
        "email": "john@example.com",
        "profile": {
            "bio": "Rust developer",
            "age": 30
        }
    });

    match UserValidator::validate(&user_data) {
        Ok(user) => {
            println!("Valid user: {:?}", user);
        }
        Err(errors) => {
            println!("Validation errors: {:?}", errors);
        }
    }
}

完整示例代码

use serde_json::json;
use schematic_macros::{Schema, Validator};

// 用户数据结构定义
#[derive(Debug, Schema)]
pub struct User {
    #[schema(required, min = 1)] // ID必须存在且大于0
    pub id: u64,
    
    #[schema(required, min_length = 3, max_length = 20)] // 用户名必填，长度3-20
    pub username: String,
    
    #[schema(format = "email")] // 必须符合email格式
    pub email: String,
    
    #[schema(default = false)] // 默认值为false
    pub is_active: bool,
    
    #[schema(default = "user")] // 默认角色为"user"
    pub role: String,
    
    #[schema(nested)] // 嵌套验证地址信息
    pub address: Address,
}

// 地址数据结构定义
#[derive(Debug, Schema)]
pub struct Address {
    #[schema(required)] // 街道必填
    pub street: String,
    
    #[schema(required)] // 城市必填
    pub city: String,
    
    #[schema(min_length = 5, max_length = 10)] // 邮编长度5-10
    pub postal_code: Option<String>,
}

// 生成用户验证器
#[derive(Validator)]
#[validator(schema = "User")]
pub struct UserValidator;

fn main() {
    // 测试数据1 - 有效数据
    let valid_data = json!({
        "id": 1,
        "username": "rustfan",
        "email": "rust@example.com",
        "address": {
            "street": "123 Main St",
            "city": "Techville",
            "postal_code": "12345"
        }
    });

    // 测试数据2 - 无效数据(缺少必填字段)
    let invalid_data = json!({
        "id": 0, // 无效ID
        "username": "rt", // 用户名太短
        "email": "not-an-email",
        "address": {
            "city": "Techville" // 缺少street字段
        }
    });

    println!("--- 验证有效数据 ---");
    match UserValidator::validate(&valid_data) {
        Ok(user) => println!("验证成功: {:#?}", user),
        Err(e) => println!("验证错误: {:#?}", e),
    }

    println!("\n--- 验证无效数据 ---");
    match UserValidator::validate(&invalid_data) {
        Ok(user) => println!("验证成功: {:#?}", user),
        Err(e) => println!("验证错误: {:#?}", e),
    }
}

功能说明

1. Schema定义：通过#[derive(Schema)]宏定义数据结构及其验证规则

2. 字段验证：支持多种验证规则如：

   • required：必填字段
   • min_length/max_length：字符串长度限制
   • format：格式验证（如email）
   • default：默认值
   • nested：嵌套结构验证
   • min/max：数值范围验证

3. 自动验证器生成：通过#[derive(Validator)]宏自动生成验证逻辑

4. 错误处理：验证失败时返回详细的错误信息

使用场景

• API请求/响应数据验证
• 配置文件验证
• 数据库模型验证
• 表单数据验证

优势

1. 声明式验证：通过属性宏定义验证规则，代码简洁
2. 类型安全：充分利用Rust的类型系统
3. 可扩展：支持自定义验证规则
4. 嵌套验证：支持复杂数据结构的验证
5. 良好错误信息：验证失败时提供详细的错误信息

许可证

MIT许可证