Rust源代码信息解析库srcinfo的使用指南

概述

srcinfo是一个用于解析Rust源代码并提取项目元数据和结构信息的库。它可以帮助开发者分析Rust项目的组织结构、模块依赖关系、函数签名等关键信息，非常适合用于构建代码分析工具、文档生成器或IDE插件。

主要功能

• 提取项目模块结构信息
• 分析函数、结构体、枚举等定义
• 获取类型签名和文档注释
• 解析依赖关系
• 提取元数据如特性(features)、编译目标等

安装方法

在Cargo.toml中添加依赖：

[dependencies]
srcinfo = "0.4"

基本使用方法

1. 解析单个Rust文件

use srcinfo::SourceInfo;

fn main() {
    let code = r#"
        /// 这是一个示例结构体
        #[derive(Debug)]
        pub struct Point {
            x: i32,
            y: i32,
        }
        
        impl Point {
            pub fn new(x: i32, y: i32) -> Self {
                Point { x, y }
            }
        }
    "#;

    let info = SourceInfo::from_str(code).unwrap();
    
    // 获取结构体信息
    for item in info.items() {
        if let Some(struct_info) = item.as_struct() {
            println!("找到结构体: {}", struct_info.name);
            println!("文档注释: {:?}", struct_info.docs);
            println!("字段数: {}", struct_info.fields.len());
        }
    }
}

2. 分析整个项目

use srcinfo::ProjectInfo;
use std::path::Path;

fn analyze_project() {
    let project_path = Path::new("./my_rust_project");
    let project_info = ProjectInfo::new(project_path).unwrap();
    
    println!("项目名称: {}", project_info.name());
    println!("版本: {}", project_info.version());
    println!("依赖项: {:?}", project_info.dependencies());
    
    // 遍历所有模块
    for module in project_info.modules() {
        println!("模块: {}", module.name());
        for item in module.items() {
            println!("  - 项目类型: {:?}", item.kind());
        }
    }
}

3. 提取函数信息

use srcinfo::SourceInfo;

fn extract_functions() {
    let code = r#"
        /// 计算两个数的和
        pub fn add(a: i32, b: i32) -> i32 {
            a + b
        }
        
        /// 计算阶乘
        fn factorial(n: u32) -> u32 {
            if n <= 1 { 1 } else { n * factorial(n - 1) }
        }
    "#;
    
    let info = SourceInfo::from_str(code).unwrap();
    
    for item in info.items() {
        if let Some(func) = item.as_function() {
            println!("函数名: {}", func.name);
            println!("可见性: {:?}", func.visibility);
            println!("参数: {:?}", func.params);
            println!("返回类型: {:?}", func.return_type);
            println!("文档: {:?}", func.docs);
        }
    }
}

高级用法

1. 自定义访问器遍历AST

use srcinfo::{SourceInfo, Visitor};

struct MyVisitor;

impl Visitor for MyVisitor {
    fn visit_function(&mut self, func: &srcinfo::Function) {
        println!("发现函数: {}", func.name);
    }
    
    fn visit_struct(&mut self, struc: &srcinfo::Struct) {
        println!("发现结构体: {}", struc.name);
    }
}

fn custom_visitor() {
    let code = "/* 一些Rust代码 */";
    let info = SourceInfo::from_str(code).unwrap();
    let mut visitor = MyVisitor;
    info.visit(&mut visitor);
}

2. 提取特性(features)信息

use srcinfo::ProjectInfo;

fn extract_features() {
    let project = ProjectInfo::new(Path::new(".")).unwrap();
    let features = project.features();
    
    println!("可用特性:");
    for (name, desc) in features.iter() {
        println!("- {}: {}", name, desc.as_deref().unwrap_or("无描述"));
    }
}

完整示例demo

下面是一个结合多个功能的完整示例，展示如何使用srcinfo分析一个Rust项目：

use srcinfo::{SourceInfo, ProjectInfo, Visitor};
use std::path::Path;

// 自定义访问器实现
struct ProjectAnalyzer;

impl Visitor for ProjectAnalyzer {
    fn visit_function(&mut self, func: &srcinfo::Function) {
        println!("[函数] {} (可见性: {:?})", func.name, func.visibility);
        println!("  参数: {:?}", func.params);
        println!("  返回类型: {:?}", func.return_type);
        if let Some(docs) = &func.docs {
            println!("  文档: {}", docs);
        }
    }
    
    fn visit_struct(&mut self, struc: &srcinfo::Struct) {
        println!("[结构体] {} (字段数: {})", struc.name, struc.fields.len());
        if let Some(docs) = &struc.docs {
            println!("  文档: {}", docs);
        }
    }
}

fn main() {
    // 示例1: 解析单个文件
    let code = r#"
        /// 用户信息结构体
        pub struct User {
            name: String,
            age: u8,
        }
        
        impl User {
            /// 创建新用户
            pub fn new(name: String, age: u8) -> Self {
                User { name, age }
            }
            
            /// 获取用户年龄
            pub fn get_age(&self) -> u8 {
                self.age
            }
        }
    "#;
    
    println!("=== 解析单个文件 ===");
    let source_info = SourceInfo::from_str(code).unwrap();
    let mut analyzer = ProjectAnalyzer;
    source_info.visit(&mut analyzer);
    
    // 示例2: 分析整个项目
    println!("\n=== 分析整个项目 ===");
    if let Ok(project_info) = ProjectInfo::new(Path::new(".")) {
        println!("项目名称: {}", project_info.name());
        println!("版本: {}", project_info.version());
        
        // 打印所有模块
        for module in project_info.modules() {
            println!("\n模块: {}", module.name());
            let mut mod_analyzer = ProjectAnalyzer;
            for item in module.items() {
                match item.kind() {
                    srcinfo::ItemKind::Function(_) => {
                        if let Some(func) = item.as_function() {
                            mod_analyzer.visit_function(func);
                        }
                    }
                    srcinfo::ItemKind::Struct(_) => {
                        if let Some(struc) = item.as_struct() {
                            mod_analyzer.visit_struct(struc);
                        }
                    }
                    _ => {}
                }
            }
        }
        
        // 打印特性信息
        println!("\n=== 项目特性 ===");
        let features = project_info.features();
        for (name, desc) in features.iter() {
            println!("- {}: {}", name, desc.as_deref().unwrap_or("无描述"));
        }
    } else {
        eprintln!("无法解析当前目录的项目");
    }
}

实际应用场景

1. 文档生成工具：自动提取代码中的文档注释生成API文档
2. 代码分析工具：统计项目中的函数数量、复杂度等指标
3. IDE插件：提供代码补全、跳转定义等功能
4. 依赖分析：可视化展示项目的模块依赖关系

注意事项

• srcinfo目前仍在活跃开发中，API可能会有变动
• 对于大型项目，解析可能需要一定时间
• 某些复杂的宏展开可能无法完全解析

通过srcinfo库，开发者可以轻松获取Rust项目的结构化信息，为构建各种开发工具提供了便利的基础设施。