ngrok-rust 开源项目教程

ngrok-rust 开源项目教程

ngrok-rustEmbed ngrok secure ingress into your Rust apps with a single line of code.项目地址:https://gitcode.com/gh_mirrors/ng/ngrok-rust

1. 项目介绍

ngrok-rust 是一个开源的 Rust 库，旨在将 ngrok 的安全入口直接嵌入到 Rust 应用程序中。通过 ngrok-rust，开发者可以在不设置底层网络原语（如 IP、证书、负载均衡器和端口）的情况下，将 Rust 服务部署到互联网上。ngrok-rust 利用 ngrok 的全球入口网络来处理 TCP 和 HTTP 流量，并且与 tokio 的 AsyncRead 和 AsyncWrite 特性兼容，使得它可以轻松集成到使用 hyper 或 axum 等流行框架的应用程序中。

2. 项目快速启动

2.1 安装依赖

首先，确保你已经安装了 Rust 和 Cargo。然后，创建一个新的 Rust 项目并添加 ngrok-rust 依赖：

mkdir ngrok-rust-quickstart
cd ngrok-rust-quickstart
cargo init

在 Cargo.toml 文件中添加以下依赖：

[dependencies]
ngrok = "0.13.1"
axum = "0.6.1"
tokio = { version = "1", features = ["full"] }

2.2 编写代码

在 src/main.rs 文件中编写以下代码：

use axum::{routing::get, Router};
use ngrok::prelude::*;
use std::net::SocketAddr;

#[tokio::main]
async fn main() {
    // 创建一个 ngrok 会话
    let session = ngrok::Session::builder()
        .authtoken_from_env()
        .connect()
        .await
        .unwrap();

    // 创建一个 ngrok 隧道
    let tunnel = session.http_endpoint()
        .listen()
        .await
        .unwrap();

    println!("Ingress established at {:?}", tunnel.url());

    // 创建一个简单的 axum 服务
    let app = Router::new().route("/", get(|| async { "Hello, ngrok!" }));

    // 将 axum 服务绑定到 ngrok 隧道
    axum::Server::builder(tunnel)
        .serve(app.into_make_service())
        .await
        .unwrap();
}

2.3 运行项目

在项目根目录下运行以下命令来启动服务：

cargo run

运行成功后，你将看到类似以下的输出：

Ingress established at "https://xxxxxx.ngrok.io"

现在，你可以通过浏览器访问 https://xxxxxx.ngrok.io 来查看你的 Rust 服务。

3. 应用案例和最佳实践

3.1 本地开发与调试

在本地开发过程中，ngrok-rust 可以帮助你将本地服务暴露到互联网上，方便团队成员或外部用户进行测试和调试。

3.2 微服务架构

在微服务架构中，ngrok-rust 可以用于快速部署和测试新的服务，而无需复杂的网络配置。

3.3 临时服务暴露

当你需要临时将某个服务暴露到互联网上时，ngrok-rust 提供了一种简单且安全的方式来实现这一目标。

4. 典型生态项目

4.1 hyper

hyper 是一个高性能的 HTTP 库，ngrok-rust 与 hyper 兼容，使得开发者可以轻松地将 hyper 服务暴露到互联网上。

4.2 axum

axum 是一个基于 hyper 的 Web 框架，ngrok-rust 可以与 axum 无缝集成，提供便捷的 HTTP 服务暴露功能。

4.3 tokio

tokio 是一个异步运行时，ngrok-rust 利用 tokio 的 AsyncRead 和 AsyncWrite 特性，使得它可以与任何基于 tokio 的应用程序集成。

通过以上模块的介绍，你应该能够快速上手并使用 ngrok-rust 来部署和测试你的 Rust 服务。

ngrok-rustEmbed ngrok secure ingress into your Rust apps with a single line of code.项目地址:https://gitcode.com/gh_mirrors/ng/ngrok-rust