Rust代码生成插件库rusteron-code-gen使用指南

介绍

rusteron-code-gen 是一个强大的 Rust 代码生成工具库，旨在通过自动化代码生成来提高开发效率。它特别适合以下场景：

• 减少重复性代码编写
• 自动生成样板代码
• 宏扩展和元编程
• 根据数据结构自动生成相关实现

安装

在 Cargo.toml 中添加依赖：

[dependencies]
rusteron-code-gen = "0.4"

基本使用方法

1. 生成结构体实现

use rusteron_code_gen::code_gen;

#[code_gen]
struct Person {
    name: String,  // 姓名
    age: u32,      // 年龄
    email: Option<String>,  // 可选邮箱
}

这将自动为 Person 结构体生成 new()、getter 和 setter 方法。

2. 自定义生成规则

use rusteron_code_gen::code_gen;

#[code_gen(
    derive(Debug, Clone, PartialEq),  // 自动派生常用trait
    impl_display,  // 实现Display trait
    builder  // 生成builder模式
)]
struct Book {
    title: String,   // 书名
    author: String,  // 作者
    isbn: String,   // ISBN号
    price: f64,     // 价格
}

这会为 Book 结构体：

• 自动派生 Debug, Clone 和 PartialEq trait
• 实现 Display trait
• 生成 builder 模式实现

3. 宏扩展

use rusteron_code_gen::expand_macro;

#[expand_macro]
macro_rules! vec_str {
    ($($element:expr),*) => {
        vec![$($element.to_string()),*]  // 将元素转换为字符串并收集到vec中
    };
}

这将扩展宏定义并提供更好的编译时检查和错误信息。

高级功能

1. 生成枚举实现

use rusteron_code_gen::code_gen;

#[code_gen(
    derive(Debug, Clone),  // 自动派生
    impl_from,  // 生成From实现
    impl_display  // 生成Display实现
)]
enum Status {
    Active,     // 活跃状态
    Inactive,   // 非活跃状态
    Suspended,  // 暂停状态
}

2. 生成 trait 实现

use rusteron_code_gen::code_gen;

trait Greet {
    fn greet(&self) -> String;  // 打招呼方法
}

#[code_gen(impl_trait = "Greet")]
struct User {
    name: String,  // 用户名
}

// 自动生成:
// impl Greet for User {
//     fn greet(&self) -> String {
//         format!("Hello, {}!", self.name)
//     }
// }

3. 自定义代码模板

use rusteron_code_gen::code_gen;

#[code_gen(
    template = r#"
        impl {{type_name}} {
            pub fn is_valid(&self) -> bool {
                !self.name.is_empty() && self.age > 0
            }
        }
    "#
)]
struct Member {
    name: String,  // 成员名
    age: u32,     // 年龄
}

配置选项

rusteron-code-gen 支持多种配置选项：

最佳实践

1. 保持生成的代码简单：生成的代码应该易于理解和维护
2. 文档注释：为生成的代码添加文档注释
3. 测试生成代码：像手写代码一样测试生成的代码
4. 版本控制：将生成的代码也纳入版本控制

示例项目结构

my_project/
├── Cargo.toml
├── src/
│   ├── main.rs
│   ├── models/
│   │   ├── mod.rs
│   │   ├── user.rs  # 使用rusteron-code-gen生成的代码
│   │   └── product.rs
│   └── macros/
│       └── custom.rs  # 使用宏扩展功能

完整示例demo

基本结构体生成示例

// main.rs
use rusteron_code_gen::code_gen;

#[code_gen]
pub struct Employee {
    id: u32,
    name: String,
    department: String,
    salary: f64,
}

fn main() {
    let emp = Employee::new(1, "Alice".to_string(), "Engineering".to_string(), 85000.0);
    println!("Employee: {} - {}", emp.get_id(), emp.get_name());
}

Builder模式生成示例

// models/product.rs
use rusteron_code_gen::code_gen;

#[code_gen(
    derive(Debug, Clone),
    builder,
    impl_display
)]
pub struct Product {
    id: u32,
    name: String,
    price: f64,
    in_stock: bool,
}

// 使用示例
fn create_product() {
    let product = Product::builder()
        .id(101)
        .name("Rust编程书".to_string())
        .price(59.99)
        .in_stock(true)
        .build();
    println!("{}", product);
}

枚举和trait实现示例

// models/status.rs
use rusteron_code_gen::code_gen;

#[code_gen(
    derive(Debug, Clone, PartialEq),
    impl_from,
    impl_display
)]
pub enum OrderStatus {
    Pending,
    Processing,
    Shipped,
    Delivered,
    Cancelled,
}

trait StatusCheck {
    fn is_completed(&self) -> bool;
}

#[code_gen(impl_trait = "StatusCheck")]
impl OrderStatus {
    // 自动生成:
    // impl StatusCheck for OrderStatus {
    //     fn is_completed(&self) -> bool {
    //         matches!(self, OrderStatus::Delivered | OrderStatus::Cancelled)
    //     }
    // }
}

宏扩展示例

// macros/custom.rs
use rusteron_code_gen::expand_macro;

#[expand_macro]
macro_rules! hash_map {
    ($($key:expr => $value:expr),*) => {
        {
            let mut map = std::collections::HashMap::new();
            $(map.insert($key, $value);)*
            map
        }
    };
}

// 使用示例
fn create_map() {
    let map = hash_map! {
        "name" => "Bob",
        "age" => "30",
        "city" => "Shanghai"
    };
    println!("{:?}", map);
}