Axum-Htmx 项目使用教程

Axum-Htmx 项目使用教程

axum-htmxA set of htmx extractors, responders, and request guards for axum.项目地址:https://gitcode.com/gh_mirrors/ax/axum-htmx

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

Axum-Htmx 项目的目录结构如下：

axum-htmx/
├── Cargo.toml
├── LICENSE-APACHE
├── LICENSE-MIT
├── README.md
├── src/
│   ├── lib.rs
│   ├── main.rs
│   ├── responders.rs
│   └── ...
└── ...

目录结构介绍

• Cargo.toml: 项目的依赖和元数据配置文件。
• LICENSE-APACHE 和 LICENSE-MIT: 项目的许可证文件。
• README.md: 项目的基本介绍和使用说明。
• src/: 包含项目的源代码文件。
  • lib.rs: 库文件，定义了一些共享的功能和模块。
  • main.rs: 主程序文件，项目的入口点。
  • responders.rs: 定义了一些响应处理逻辑。

2. 项目的启动文件介绍

项目的启动文件是 src/main.rs，它包含了项目的入口点和主要的启动逻辑。以下是 main.rs 的基本结构：

use axum::{
    routing::get,
    Router,
};
use axum_htmx::{HxBoosted, HxResponseTrigger};

async fn get_index(HxBoosted(boosted): HxBoosted) -> impl IntoResponse {
    if boosted {
        // 发送扩展自 _partial html 的模板
    } else {
        // 发送扩展自 _base html 的模板
    }
}

async fn index() -> (HxResponseTrigger<'static>, &'static str) {
    (
        HxResponseTrigger::normal(["my-event", "second-event"]),
        "Hello world",
    )
}

#[tokio::main]
async fn main() {
    let app = Router::new()
        .route("/", get(get_index))
        .route("/index", get(index));

    axum::Server::bind(&"0.0.0.0:3000".parse().unwrap())
        .serve(app.into_make_service())
        .await
        .unwrap();
}

启动文件介绍

• get_index 函数：处理 / 路由的请求，根据 HxBoosted 的值返回不同的模板。
• index 函数：处理 /index 路由的请求，触发指定的事件并返回字符串。
• main 函数：定义了路由和启动服务器的逻辑。

3. 项目的配置文件介绍

项目的配置文件是 Cargo.toml，它包含了项目的依赖和元数据配置。以下是 Cargo.toml 的基本结构：

[package]
name = "axum-htmx"
version = "0.1.0"
edition = "2021"

[dependencies]
axum = "0.5"
axum-htmx = "0.1"
tokio = { version = "1", features = ["full"] }

[dev-dependencies]
...

[build-dependencies]
...

配置文件介绍

• [package] 部分：定义了项目的名称、版本和使用的 Rust 版本。
• [dependencies] 部分：列出了项目依赖的库和版本。
• [dev-dependencies] 部分：列出了开发时依赖的库和版本。
• [build-dependencies] 部分：列出了构建时依赖的库和版本。

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

axum-htmxA set of htmx extractors, responders, and request guards for axum.项目地址:https://gitcode.com/gh_mirrors/ax/axum-htmx