跳转至

Rust API Service — 项目 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，仅在二进制 crate 或测试中使用 anyhow
  • 生产代码中禁止使用 .unwrap() 或 .expect() —— 使用 ? 传播错误
  • 函数参数优先使用 &str 而非 String；需要转移所有权时返回 String
  • 结合 #![deny(clippy::all, clippy::pedantic)] 使用 clippy —— 修复所有警告
  • 所有公开类型均 derive Debug；仅在需要时 derive Clone、PartialEq
  • 除非有 // SAFETY: 注释证明其安全性，否则禁止使用 unsafe 块

数据库

  • 所有查询使用 SQLx 的 query! 或 query_as! 宏 —— 在编译时根据 schema 进行验证
  • 迁移使用 migrations/ 目录下的 sqlx migrate —— 不要直接修改数据库
  • 使用 sqlx::Pool<Postgres> 作为共享状态 —— 不要为每个请求创建连接
  • 所有查询使用参数化占位符（$1、$2）—— 禁止使用字符串格式化
// 나쁜 예: 문자열 보간 (SQL injection 위험)
let q = format!("SELECT * FROM users WHERE id = '{}'", id);

// 좋은 예: parameterized 쿼리, 컴파일 타임에 검증
let user = sqlx::query_as!(User, "SELECT * FROM users WHERE id = $1", id)
    .fetch_optional(&pool)
    .await?;

错误处理

  • 按模块定义使用 thiserror 的领域错误 enum
  • 通过 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)]
    Database(#[from] sqlx::Error),
    #[error(transparent)]
    Io(#[from] std::io::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::Database(err) => {
                tracing::error!(?err, "database error");
                (StatusCode::INTERNAL_SERVER_ERROR, "Internal error".into())
            }
            Self::Io(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 模拟外部服务

代码风格

  • 最大行长度：100 字符（由 rustfmt 强制执行）
  • import 分组：std、外部 crate、crate/super —— 用空行分隔
  • 模块：每个模块一个文件，mod.rs 仅用于 re-export
  • 类型：PascalCase，函数/变量：snake_case，常量：UPPER_SNAKE_CASE

文件结构

src/
  main.rs              # 진입점, 서버 설정, 우아한 종료
  lib.rs               # 통합 테스트를 위한 re-export
  config.rs            # envy 또는 figment을 사용한 환경 설정
  router.rs            # 모든 라우트가 포함된 Axum 라우터
  middleware/
    auth.rs            # JWT 추출 및 검증
    logging.rs         # 요청/응답 트레이싱
  handlers/
    mod.rs             # 라우트 핸들러 (얇게 — 서비스에 위임)
    users.rs
    orders.rs
  services/
    mod.rs             # 비즈니스 로직
    users.rs
    orders.rs
  repositories/
    mod.rs             # 데이터베이스 접근 (SQLx 쿼리)
    users.rs
    orders.rs
  domain/
    mod.rs             # 도메인 타입, 오류 enum
    user.rs
    order.rs
migrations/
  001_create_users.sql
  002_create_orders.sql
tests/
  common/mod.rs        # 공유 테스트 헬퍼, 테스트 서버 설정
  api_users.rs         # 사용자 엔드포인트 통합 테스트
  api_orders.rs        # 주문 엔드포인트 통합 테스트

主要模式

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_test_user(&app, "alice@example.com").await;
    // 중복 시도
    let response = create_user_request(&app, "alice@example.com").await;
    assert_eq!(response.status(), StatusCode::BAD_REQUEST);
}

环境变量

# 서버
HOST=0.0.0.0
PORT=8080
RUST_LOG=info,tower_http=debug

# 데이터베이스
DATABASE_URL=postgres://user:pass@localhost:5432/myapp

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

# 선택 사항
CORS_ALLOWED_ORIGINS=http://localhost:3000

测试策略

# 전체 테스트 실행
cargo test

# 출력과 함께 실행
cargo test -- --nocapture

# 특정 테스트 모듈 실행
cargo test api_users

# 커버리지 확인 (cargo-llvm-cov 필요)
cargo llvm-cov --html
open target/llvm-cov/html/index.html

# 린트
cargo clippy -- -D warnings

# 포맷 검사
cargo fmt -- --check

ECC 工作流

# 계획 수립
/plan "Add order fulfillment with Stripe payment"

# TDD로 개발
/tdd                    # cargo test 기반 TDD 워크플로우

# 리뷰
/code-review            # Rust 전용 코드 리뷰
/security-scan          # 의존성 감사 + unsafe 스캔

# 검증
/verify                 # 빌드, clippy, 테스트, 보안 스캔

Git 工作流

  • feat: 新功能，fix: Bug 修复，refactor: 代码重构
  • 从 main 创建 feature 分支，必须提交 PR
  • CI：cargo fmt --check、cargo clippy、cargo test、cargo audit
  • 部署：使用 scratch 或 distroless 基础镜像的 Docker 多阶段构建

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