2 个版本

0.2.1	2023年2月3日
0.2.0	2023年2月3日

#20 in #swim

MIT 许可证

7KB

Swim ⚡🏊

一个包含电池的 Rust 网络框架的见解方法。

想法是取 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()
    }

    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 来定义一个中间件。它负责处理请求并返回响应。您可以实现您想要处理的特定 HTTP 方法。

#[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。这个项目完全是关于新想法和改善开发者体验。

app cargo-swim