tokio-graceful-shutdown 项目教程-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00023/article/details/139387288

tokio-graceful-shutdown 项目教程

tokio-graceful-shutdown Provides utility functions to perform a graceful shutdown on tokio-rs based services 项目地址: https://gitcode.com/gh_mirrors/to/tokio-graceful-shutdown

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

tokio-graceful-shutdown/
├── examples/
│   ├── 01_normal_shutdown.rs
│   └── ...
├── src/
│   ├── lib.rs
│   └── ...
├── tests/
│   └── ...
├── .gitignore
├── Cargo.toml
├── LICENSE-APACHE
├── LICENSE-MIT
├── README.md
└── TODO.txt

目录结构介绍

examples/: 包含项目的示例代码，展示了如何使用 tokio-graceful-shutdown 库。
src/: 包含项目的源代码，其中 lib.rs 是库的主入口文件。
tests/: 包含项目的测试代码，用于确保库的正确性。
.gitignore: Git 忽略文件，指定哪些文件或目录不需要被版本控制。
Cargo.toml: Rust 项目的配置文件，定义了项目的依赖、元数据等。
LICENSE-APACHE: Apache 许可证文件。
LICENSE-MIT: MIT 许可证文件。
README.md: 项目的介绍文档，通常包含项目的概述、安装方法、使用示例等。
TODO.txt: 项目待办事项列表。

2. 项目的启动文件介绍

项目的启动文件通常是指 examples/ 目录下的示例代码。以下是 examples/01_normal_shutdown.rs 的简要介绍：

// examples/01_normal_shutdown.rs

async fn subsys1(subsys: SubsystemHandle) -> Result<()> {
    log::info("Subsystem1 started");
    subsys.on_shutdown_requested().await;
    log::info("Subsystem1 stopped");
    Ok(())
}

#[tokio::main]
async fn main() -> Result<()> {
    Toplevel::new(|s| async move {
        s.start(SubsystemBuilder::new("Subsys1", subsys1))
    })
    .catch_signals()
    .handle_shutdown_requests(Duration::from_millis(1000))
    .await
    .map_err(Into::into)
}

启动文件介绍

subsys1: 定义了一个异步子系统，该子系统在启动后等待关闭请求，然后停止自身。
main: 主函数，使用 Toplevel 对象启动子系统，并捕获 SIGINT/SIGTERM/Ctrl+C 信号以触发关闭请求。handle_shutdown_requests 方法确保在给定的超时时间内完成关闭，并返回错误值作为主函数的返回码。

3. 项目的配置文件介绍

项目的配置文件主要是 Cargo.toml，它定义了项目的依赖、元数据等。以下是 Cargo.toml 的简要介绍：

[package]
name = "tokio-graceful-shutdown"
version = "0.1.0"
authors = ["Your Name <your.email@example.com>"]
edition = "2018"

[dependencies]
tokio = { version = "1", features = ["full"] }
log = "0.4"

[dev-dependencies]
tokio = { version = "1", features = ["full"] }