跳转至

Rust API 服务 — 项目 CLAUDE.md

适用于使用 Axum、PostgreSQL 和 Docker 的 Rust API 服务的真实示例。 请将其复制到项目根目录，并根据你的服务进行自定义。

项目概览

技术栈： Rust 1.78+、Axum（Web 框架）、SQLx（异步数据库）、PostgreSQL、Tokio（异步运行时）、Docker

架构： 分层架构，按 handler → service → repository 分离。Axum 用于 HTTP，SQLx 用于编译时校验的 SQL，Tower 中间件用于横切关注点。

关键规则

Rust 约定

  • 库错误使用 thiserror，anyhow 仅用于二进制 crate 或测试
  • 生产代码中不要使用 .unwrap() 或 .expect() — 使用 ? 传播错误
  • 函数参数优先使用 &str 而不是 String；当发生所有权转移时返回 String
  • 使用 clippy 并配置 #![deny(clippy::all, clippy::pedantic)] — 修复所有警告
  • 为所有公共类型派生 Debug；仅在必要时派生 Clone、PartialEq
  • 没有 // SAFETY: 注释说明理由的 unsafe 块一律禁止

数据库

  • 所有查询都使用 SQLx 宏 query! 或 query_as! — 在编译时针对 schema 校验
  • 迁移文件放在 migrations/ 中，并使用 sqlx migrate — 永远不要直接修改数据库
  • 使用 sqlx::Pool<Postgres> 作为共享状态 — 永远不要为每个请求创建连接
  • 所有查询都使用参数化占位符（$1、$2） — 永远不要使用字符串格式化
// BAD: String interpolation (SQL injection risk)
let q = format!("SELECT * FROM users WHERE id = '{}'", id);

// GOOD: Parameterized query, compile-time checked
let user = sqlx::query_as!(User, "SELECT * FROM users WHERE id = $1", id)
    .fetch_optional(&pool)
    .await?;

错误处理

  • 为每个模块使用 thiserror 定义领域错误枚举
  • 通过 IntoResponse 将错误映射为 HTTP 响应 — 永远不要暴露内部细节
  • 使用 tracing 记录结构化日志 — 永远不要使用 println! 或 eprintln!
use thiserror::Error;

#[derive(Debug, Error)]
pub enum AppError {
    #[error("Resource not found")]
    NotFound,
    #[error("Validation failed: {0}")]
    Validation(String),
    #[error("Unauthorized")]
    Unauthorized,
    #[error(transparent)]
    Internal(#[from] anyhow::Error),
}

impl IntoResponse for AppError {
    fn into_response(self) -> Response {
        let (status, message) = match &self {
            Self::NotFound => (StatusCode::NOT_FOUND, self.to_string()),
            Self::Validation(msg) => (StatusCode::BAD_REQUEST, msg.clone()),
            Self::Unauthorized => (StatusCode::UNAUTHORIZED, self.to_string()),
            Self::Internal(err) => {
                tracing::error!(?err, "internal error");
                (StatusCode::INTERNAL_SERVER_ERROR, "Internal error".into())
            }
        };
        (status, Json(json!({ "error": message }))).into_response()
    }
}

测试

  • 单元测试放在每个源文件内的 #[cfg(test)] 模块中
  • 集成测试放在 tests/ 目录中，并使用真实的 PostgreSQL（Testcontainers 或 Docker）
  • 使用 #[sqlx::test] 进行数据库测试，支持自动迁移和回滚
  • 使用 mockall 或 wiremock 对外部服务进行 mock

代码风格

  • 最大行宽：100 个字符（由 rustfmt 强制）
  • 分组导入：std、外部 crate、crate/super — 用空行分隔
  • 模块：每个模块一个文件，mod.rs 仅用于重新导出
  • 类型：PascalCase，函数/变量：snake_case，常量：UPPER_SNAKE_CASE

文件结构

src/
  main.rs              # Entrypoint, server setup, graceful shutdown
  lib.rs               # Re-exports for integration tests
  config.rs            # Environment config with envy or figment
  router.rs            # Axum router with all routes
  middleware/
    auth.rs            # JWT extraction and validation
    logging.rs         # Request/response tracing
  handlers/
    mod.rs             # Route handlers (thin — delegate to services)
    users.rs
    orders.rs
  services/
    mod.rs             # Business logic
    users.rs
    orders.rs
  repositories/
    mod.rs             # Database access (SQLx queries)
    users.rs
    orders.rs
  domain/
    mod.rs             # Domain types, error enums
    user.rs
    order.rs
migrations/
  001_create_users.sql
  002_create_orders.sql
tests/
  common/mod.rs        # Shared test helpers, test server setup
  api_users.rs         # Integration tests for user endpoints
  api_orders.rs        # Integration tests for order endpoints

关键模式

Handler（精简）

async fn create_user(
    State(ctx): State<AppState>,
    Json(payload): Json<CreateUserRequest>,
) -> Result<(StatusCode, Json<UserResponse>), AppError> {
    let user = ctx.user_service.create(payload).await?;
    Ok((StatusCode::CREATED, Json(UserResponse::from(user))))
}

Service（业务逻辑）

impl UserService {
    pub async fn create(&self, req: CreateUserRequest) -> Result<User, AppError> {
        if self.repo.find_by_email(&req.email).await?.is_some() {
            return Err(AppError::Validation("Email already registered".into()));
        }

        let password_hash = hash_password(&req.password)?;
        let user = self.repo.insert(&req.email, &req.name, &password_hash).await?;

        Ok(user)
    }
}

Repository（数据访问）

impl UserRepository {
    pub async fn find_by_email(&self, email: &str) -> Result<Option<User>, sqlx::Error> {
        sqlx::query_as!(User, "SELECT * FROM users WHERE email = $1", email)
            .fetch_optional(&self.pool)
            .await
    }

    pub async fn insert(
        &self,
        email: &str,
        name: &str,
        password_hash: &str,
    ) -> Result<User, sqlx::Error> {
        sqlx::query_as!(
            User,
            r#"INSERT INTO users (email, name, password_hash)
               VALUES ($1, $2, $3) RETURNING *"#,
            email, name, password_hash,
        )
        .fetch_one(&self.pool)
        .await
    }
}

集成测试

#[tokio::test]
async fn test_create_user() {
    let app = spawn_test_app().await;

    let response = app
        .client
        .post(&format!("{}/api/v1/users", app.address))
        .json(&json!({
            "email": "alice@example.com",
            "name": "Alice",
            "password": "securepassword123"
        }))
        .send()
        .await
        .expect("Failed to send request");

    assert_eq!(response.status(), StatusCode::CREATED);
    let body: serde_json::Value = response.json().await.unwrap();
    assert_eq!(body["email"], "alice@example.com");
}

#[tokio::test]
async fn test_create_user_duplicate_email() {
    let app = spawn_test_app().await;
    // Create first user
    create_test_user(&app, "alice@example.com").await;
    // Attempt duplicate
    let response = create_user_request(&app, "alice@example.com").await;
    assert_eq!(response.status(), StatusCode::BAD_REQUEST);
}

环境变量

# Server
HOST=0.0.0.0
PORT=8080
RUST_LOG=info,tower_http=debug

# Database
DATABASE_URL=postgres://user:pass@localhost:5432/myapp

# Auth
JWT_SECRET=your-secret-key-min-32-chars
JWT_EXPIRY_HOURS=24

# Optional
CORS_ALLOWED_ORIGINS=http://localhost:3000

测试策略

# Run all tests
cargo test

# Run with output
cargo test -- --nocapture

# Run specific test module
cargo test api_users

# Check coverage (requires cargo-llvm-cov)
cargo llvm-cov --html
open target/llvm-cov/html/index.html

# Lint
cargo clippy -- -D warnings

# Format check
cargo fmt -- --check

ECC 工作流

# Planning
/plan "Add order fulfillment with Stripe payment"

# Development with TDD
/tdd                    # cargo test-based TDD workflow

# Review
/code-review            # Rust-specific code review
/security-scan          # Dependency audit + unsafe scan

# Verification
/verify                 # Build, clippy, test, security scan

Git 流程

  • feat: 新功能，fix: 缺陷修复，refactor: 代码重构
  • 功能分支从 main 创建，必须通过 PR
  • CI：cargo fmt --check、cargo clippy、cargo test、cargo audit
  • 部署：使用基于 scratch 或 distroless 的 Docker 多阶段构建

本页原文 Markdown：在 AtomGit 查看·内容源自开源项目 ev/ECC