Rust Lib Project Calibur 使用教程

1. 项目的目录结构及介绍

calibur/
├── Cargo.toml
├── src/
│   ├── main.rs
│   ├── lib.rs
│   ├── config/
│   │   ├── mod.rs
│   │   ├── settings.rs
│   ├── utils/
│   │   ├── mod.rs
│   │   ├── helper.rs
│   ├── models/
│   │   ├── mod.rs
│   │   ├── user.rs
│   ├── routes/
│   │   ├── mod.rs
│   │   ├── index.rs
│   ├── tests/
│   │   ├── mod.rs
│   │   ├── integration_test.rs
├── .gitignore
├── README.md

目录结构介绍

• Cargo.toml: 项目的依赖管理文件，定义了项目的依赖库和版本。
• src/: 项目的主要代码目录。
  • main.rs: 项目的启动文件，程序的入口点。
  • lib.rs: 定义了项目的库模块。
  • config/: 配置文件相关的代码。
    • mod.rs: 配置模块的入口文件。
    • settings.rs: 具体的配置项定义。
  • utils/: 工具函数和辅助代码。
    • mod.rs: 工具模块的入口文件。
    • helper.rs: 具体的工具函数实现。
  • models/: 数据模型定义。
    • mod.rs: 模型模块的入口文件。
    • user.rs: 用户模型的定义。
  • routes/: 路由定义。
    • mod.rs: 路由模块的入口文件。
    • index.rs: 主页路由的定义。
  • tests/: 测试代码。
    • mod.rs: 测试模块的入口文件。
    • integration_test.rs: 集成测试代码。
• .gitignore: Git 忽略文件列表。
• README.md: 项目说明文档。

2. 项目的启动文件介绍

src/main.rs

main.rs 是项目的启动文件，程序的入口点。它负责初始化配置、加载路由、启动服务器等核心功能。

fn main() {
    // 初始化配置
    let config = Config::new();

    // 加载路由
    let app = App::new()
        .configure(routes::init);

    // 启动服务器
    HttpServer::new(|| app)
        .bind("127.0.0.1:8080")?
        .run()
        .await;
}

3. 项目的配置文件介绍

src/config/settings.rs

settings.rs 文件定义了项目的配置项，包括数据库连接、日志级别、端口号等。

pub struct Config {
    pub database_url: String,
    pub log_level: String,
    pub port: u16,
}

impl Config {
    pub fn new() -> Self {
        Self {
            database_url: env::var("DATABASE_URL").expect("DATABASE_URL must be set"),
            log_level: env::var("LOG_LEVEL").unwrap_or_else(|_| "info".to_string()),
            port: env::var("PORT").unwrap_or_else(|_| "8080".to_string()).parse().expect("PORT must be a number"),
        }
    }
}

Cargo.toml

Cargo.toml 文件定义了项目的依赖库和版本。

[package]
name = "calibur"
version = "0.1.0"
edition = "2018"

[dependencies]
actix-web = "3.3.2"
serde = { version = "1.0", features = ["derive"] }
dotenv = "0.15.0"

以上是 Rust Lib Project Calibur 的使用教程，涵盖了项目的目录结构、启动文件和配置文件的介绍。希望这些内容能帮助你更好地理解和使用该项目。