Realworld Axum SQLx 项目教程
1. 项目的目录结构及介绍
realworld-axum-sqlx/
├── Cargo.toml
├── src/
│ ├── main.rs
│ ├── models/
│ ├── routes/
│ ├── state/
│ └── utils/
├── migrations/
├── .env
└── README.md
- Cargo.toml: 项目的依赖和元数据配置文件。
- src/: 包含项目的源代码。
- main.rs: 项目的入口文件。
- models/: 包含数据访问逻辑。
- routes/: 包含路由处理逻辑。
- state/: 包含应用状态管理。
- utils/: 包含工具函数和辅助逻辑。
- migrations/: 包含数据库迁移脚本。
- .env: 项目的配置文件。
- README.md: 项目说明文档。
2. 项目的启动文件介绍
项目的启动文件是 src/main.rs
。这个文件负责初始化应用状态、配置路由和启动服务器。以下是 main.rs
的基本结构:
mod models;
mod routes;
mod state;
mod utils;
use axum::{
routing::{get, post},
Router,
};
use sqlx::postgres::PgPoolOptions;
use std::net::SocketAddr;
#[tokio::main]
async fn main() {
// 初始化数据库连接池
let pool = PgPoolOptions::new()
.max_connections(5)
.connect("postgres://user:password@localhost/database").await.unwrap();
// 初始化应用状态
let app_state = state::AppState {
db: pool,
};
// 配置路由
let app = Router::new()
.route("/", get(routes::home::handler))
.route("/articles", post(routes::articles::create_article))
.with_state(app_state);
// 启动服务器
let addr = SocketAddr::from(([127, 0, 0, 1], 3000));
axum::Server::bind(&addr)
.serve(app.into_make_service())
.await
.unwrap();
}
3. 项目的配置文件介绍
项目的配置文件是 .env
。这个文件用于存储环境变量,如数据库连接字符串、端口号等。以下是一个示例 .env
文件的内容:
DATABASE_URL=postgres://user:password@localhost/database
PORT=3000
在 main.rs
中,可以通过 dotenv
库来加载这些环境变量:
use dotenv::dotenv;
use std::env;
#[tokio::main]
async fn main() {
dotenv().ok();
let database_url = env::var("DATABASE_URL").expect("DATABASE_URL must be set");
let port = env::var("PORT").expect("PORT must be set").parse::<u16>().expect("PORT must be a number");
// 初始化数据库连接池
let pool = PgPoolOptions::new()
.max_connections(5)
.connect(&database_url).await.unwrap();
// 初始化应用状态
let app_state = state::AppState {
db: pool,
};
// 配置路由
let app = Router::new()
.route("/", get(routes::home::handler))
.route("/articles", post(routes::articles::create_article))
.with_state(app_state);
// 启动服务器
let addr = SocketAddr::from(([127, 0, 0, 1], port));
axum::Server::bind(&addr)
.serve(app.into_make_service())
.await
.unwrap();
}
通过这种方式,可以方便地管理项目的配置,并在不同的环境中使用不同的配置。