3 个不稳定版本

0.3.0	2024年1月26日
0.2.1	2023年2月3日
0.2.0	2023年2月3日

在 HTTP 服务器中排名 1050

每月下载量 44
在 swim 中使用

MIT 许可证

7KB

Swim ⚡🏊

一种有观点的“电池包含”方法，用于 Rust Web 框架。

理念是将 Rust 生态系统中的最佳部分结合起来，创建一个易于使用且提供良好开发体验的框架。

安装

将以下内容添加到您的 Cargo.toml 文件中。

[dependencies]
swim = "0.2"

功能

使用 hyper 和 tokio 以极快的速度运行
使用 routerify 强大的路由功能
使用 cargo-swim 的 CLI 工具（即将推出）
使用 SeaORM 支持数据库（计划中）
使用 Tera 进行模板化（计划中）
依赖注入（计划中）

构建项目

您通过定义一个实现了 Project 特质的 struct 来定义一个项目。它是框架中的最高层抽象。它负责定义项目的设置、应用程序和中间件。

use swim::prelude::*;

struct MyProject;

impl Project for MyProject {
    fn settings(&self) -> Settings {
        Settings::builder()
            .extend_ron(relative!("settings.ron"))
            .build()
            .unwrap()
    }

    fn apps(&self) -> Vec<Box<dyn App>> {
        vec! [
            MyApp.into()
        ]
    }

    fn middleware(&self) -> Vec<Box<dyn Middleware>> {
        vec! [
            MyMiddleware.into()
        ]
    }
}

构建应用程序

您通过定义一个实现了 App 特质的 struct 来定义一个应用程序。它负责定义应用程序的路由和视图。

use swim::prelude::*;

struct MyApp;

impl App for MyApp {
    fn mount(&self) -> &'static str {
        "/"
    }

    fn config(&self) -> AppConfig {
        AppConfig::with_name("MyApp")
    }

    fn models(&self) -> Vec<Box<dyn Model>> {
        vec! []
    }

    fn routes(&self) -> Vec<Route> {
        vec! [
            Route::new("/", IndexView),
            Route::new("/hello", HelloView),
            Route::new("/greeting/:name", GreetingView),
        ]
    }
}

构建视图

您通过定义一个实现了 View 特质的 struct 来定义一个视图。它负责处理请求并返回响应。您可以实现您想要处理的特定 HTTP 方法。

#[derive(Debug)]
pub struct HelloView;

#[async_trait::async_trait]
impl View for HelloView {
    async fn get(&self, request: Request<Body>) -> Result<Response<Body>> {
        Ok(Response::builder()
            .status(StatusCode::OK)
            .body(Body::from("Say hello to Swim! "))
            .unwrap())
    }

    async fn post(&self, request: Request<Body>) -> Result<Response<Body>> {
        Ok(Response::builder()
            .status(StatusCode::OK)
            .body(Body::from("It's a post request! "))
            .unwrap())
    }
}

定义中间件

您通过定义一个实现了 Middleware 特质的 struct 来定义一个中间件。您可能需要挂钩到 pre 和 post 方法，这些方法可以修改即将到来的请求并分别留下响应（或者您可以使用这些方法来监控流量）。

#[derive(Debug)]
pub struct Logger;

#[async_trait::async_trait]
impl Middleware for Logger {
    async fn pre(&self, request: Request<Body>) -> Result<Request<Body>> {
        println! ("New request: {:?}", request.uri());

        Ok(request)
    }

    async fn post(&self, response: Response<Body>) -> Result<Response<Body>> {
        println! ("Response: {:?}", response.status());

        Ok(response)
    }
}

运行项目

您可以使用优雅的 swim 宏来运行您的项目。

#[tokio::main(flavor = "multi_thread")]
async fn main() {
    swim! (MyProject, host = "localhost", port = 8000);
}

当前状态

设备已构建，但尚未包含电池。

贡献

如果您有任何想法或建议，请随时打开一个问题或 PR。这个项目完全是关于新想法和使开发体验变得更好。

swim-util