Thruster

在我们的网站上查看示例和教程开始使用！

快速直观的Rust网络框架

没有时间阅读文档？请查看

• 为什么你应该使用Thruster
• 为什么你不应该使用Thruster（绝对要读这个）

✅ 稳定运行 ✅ 运行速度快 ✅ 不使用unsafe

文档

功能

• 考虑到异步/等待构建
• 与Hyper兼容
• SSL就绪
• 可测试
• 静态文件服务
• socketio
• gRPC，以及更多实验性的 非tonic基于的gRPC
• 依赖注入

动机

Thruster是一个旨在使开发者在项目和团队之间保持高效和一致的Web框架。其目标是

• 性能好
• 简单
• 直观

Thruster还

• 不使用 unsafe
• 在稳定Rust中运行

快

Thruster可以用不同的服务器后端运行，并代表它们之上的一层良好封装。这意味着它可以跟上Hyper、Actix甚至ThrusterServer（一个自制的http引擎）等类似框架的最新和最好的变化。

直观

基于Koa和Express等框架，Thruster旨在成为开发者的乐趣。

示例

运行示例 cargo run --example <example-name>。例如，cargo run --example hello_world 并打开 https://127.0.0.1:4321/

基于中间件

使新的 async await 代码工作为核心部分是为中间件函数指定 #[middleware_fn] 属性（这标记了中间件，使其与 Thruster 构建在上的稳定 futures 版本兼容），然后在实际路由中的 m! 宏。

使用 async await 的简单示例是

use std::boxed::Box;
use std::future::Future;
use std::pin::Pin;
use std::time::Instant;

use thruster::{App, BasicContext as Ctx, Request};
use thruster::{m, middleware_fn, MiddlewareNext, MiddlewareResult, Server, ThrusterServer};

#[middleware_fn]
async fn profile(context: Ctx, next: MiddlewareNext<Ctx>) -> MiddlewareResult<Ctx> {
    let start_time = Instant::now();

    context = next(context).await;

    let elapsed_time = start_time.elapsed();
    println!(
        "[{}μs] {} -- {}",
        elapsed_time.as_micros(),
        context.request.method(),
        context.request.path()
    );

    Ok(context)
}

#[middleware_fn]
async fn plaintext(mut context: Ctx, _next: MiddlewareNext<Ctx>) -> MiddlewareResult<Ctx> {
    let val = "Hello, World!";
    context.body(val);
    Ok(context)
}

#[middleware_fn]
async fn four_oh_four(mut context: Ctx, _next: MiddlewareNext<Ctx>) -> MiddlewareResult<Ctx> {
    context.status(404);
    context.body("Whoops! That route doesn't exist!");
    Ok(context)
}

#[tokio::main]
fn main() {
    println!("Starting server...");

    let mut app = App::<Request, Ctx, ()>::new_basic();

    app.get("/plaintext", m![profile, plaintext]);
    app.set404(m![four_oh_four]);

    let server = Server::new(app);
    server.build("0.0.0.0", 4321).await;
}

错误处理

这是一个很好的例子

use thruster::errors::ThrusterError as Error;
use thruster::proc::{m, middleware_fn};
use thruster::{map_try, App, BasicContext as Ctx, Request};
use thruster::{MiddlewareNext, MiddlewareResult, MiddlewareReturnValue, Server, ThrusterServer};

#[middleware_fn]
async fn plaintext(mut context: Ctx, _next: MiddlewareNext<Ctx>) -> MiddlewareResult<Ctx> {
    let val = "Hello, World!";
    context.body(val);
    Ok(context)
}

#[middleware_fn]
async fn error(mut context: Ctx, _next: MiddlewareNext<Ctx>) -> MiddlewareResult<Ctx> {
    let res = "Hello, world".parse::<u32>()
        .map_err(|_| {
            let mut context = Ctx::default();
            
            context.status(400);

            ThrusterError {
                context,
                message: "Custom error message".to_string(),
                cause: None,
            }
        }?;

    context.body(&format!("{}", non_existent_param));

    Ok(context)
}

#[tokio::main]
fn main() {
    println!("Starting server...");

    let app = App::<Request, Ctx, ()>::new_basic()
        .get("/plaintext", m![plaintext])
        .get("/error", m![error]);

    let server = Server::new(app);
    server.build("0.0.0.0", 4321).await;
}

测试

Thruster 提供了一个简单的测试套件来测试您的端点，只需像下面一样包含 testing 模块

let mut app = App::<Request, Ctx, ()>::new_basic();

...

app.get("/plaintext", m![plaintext]);

...

let result = testing::get(app, "/plaintext");

assert!(result.body == "Hello, World!");

创建自己的中间件模块

创建中间件非常简单！只需创建一个函数并在模块级别导出它。下面，您将看到一个允许对请求进行剖析的中间件

#[middleware_fn]
async fn profiling<C: 'static + Context + Send>(
    mut context: C,
    next: MiddlewareNext<C>,
) -> MiddlewareResult<C> {
    let start_time = Instant::now();

    context = next(context).await?;

    let elapsed_time = start_time.elapsed();
    info!("[{}μs] {}", elapsed_time.as_micros(), context.route());

    Ok(context)
}

您可能会发现您希望允许在上下文中存储更具体的数据，例如，也许您希望能够将查询参数填充到 hashmap 中以供其他中间件稍后使用。为了做到这一点，您可以创建一个额外的 trait，中间件必须遵守。查看提供的 query_params 中间件 以获取示例。

其他或自定义后端

Thruster 能够在某种服务器之上仅提供路由层，例如，在上面的 Hyper 片段中。只要服务器实现 ThrusterServer，这就可以广泛应用于任何后端。

use async_trait::async_trait;

#[async_trait]
pub trait ThrusterServer {
    type Context: Context + Send;
    type Response: Send;
    type Request: RequestWithParams + Send;

    fn new(App<Self::Request, Self::Context>) -> Self;
    async fn build(self, host: &str, port: u16);
}

需要的是

• 创建服务器的一种简单方法。
• 一个将服务器构建成可以加载到异步运行时的未来的函数。

在 build 函数中，服务器实现应

• 启动某种类型的连接监听器
• 调用 let matched = app.resolve_from_method_and_path(<some method>, <some path>);（这是提供实际路由。）
• 调用 app.resolve(<incoming request>, matched)（这是运行链式中间件。）

为什么你应该使用Thruster

• 可以随意更改后端。开箱即用，Thruster 现在可以在以下后端中使用：actix-web、hyper 或 自定义后端
• Thruster 支持从框架级别进行 测试
• @trezm 在没有人为其创建 PR 或打开问题时会感到孤独。
• Thruster 在更简洁的中间件概念方面更简洁——例如路由守卫。以下是在 actix 中限制 IP 的示例

fn ip_guard(head: &RequestHead) -> bool {
    // Check for the cloudflare IP header
    let ip = if let Some(val) = head.headers().get(CF_IP_HEADER) {
        val.to_str().unwrap_or("").to_owned()
    } else if let Some(val) = head.peer_addr {
        val.to_string()
    } else {
        return false;
    };

    "1.2.3.4".contains(&ip)
}

#[actix_web::post("/ping")]
async fn ping() -> Result<HttpResponse, UserPersonalError> {
    Ok(HttpResponse::Ok().body("pong"))
}

...
        web::scope("/*")
            // This is confusing, but we catch all routes that _aren't_
            // ip guarded and return an error.
            .guard(guard::Not(ip_guard))
            .route("/*", web::to(HttpResponse::Forbidden)),
    )
    .service(ping);
...

这是 Thruster

#[middleware_fn]
async fn ip_guard(mut context: Ctx, next: MiddlewareNext<Ctx>) -> MiddlewareResult<Ctx> {
    if "1.2.3.4".contains(&context.headers().get("Auth-Token").unwrap_or("")) {
        context = next(context).await?;

        Ok(context)
    } else {
        Err(Error::unauthorized_error(context))
    }

}

#[middleware_fn]
async fn ping(mut context: Ctx, _next: MiddlewareNext<Ctx>) -> MiddlewareResult<Ctx> {
    context.body("pong");
    Ok(context)
}

...
    app.get("/ping", m![ip_guard, plaintext]);
...

更直接一点是挺不错的！

为什么你不应该使用 Thruster

• 维护者很少（基本上只有一个人。）
• 还有其他项目经过了更多的实战考验。Thruster正在生产中使用，但并不在你知道或重要的地方。
• 它还没有被聪明绝顶的人优化。@trezm 尽力而为，但总是被他的狗（们）分散注意力。
• 严肃地说，这个框架可能 是很棒的，但肯定没有像其他框架那样被仔细检查。你的帮助可以大大提高其安全性和健壮性，但我们可能还没有达到那里。

如果你已经读到这儿，感谢你的阅读！随时欢迎联系。