世界, 你好!

安装 Rust

如果呢还没有安装 Rust, 你可以使用官方提供的 rustup 安装 Rust. 官方教程 中有包含如何安装的介绍.

当前 Salvo 支持的最小 Rust 为 1.56. 运行 rustup update 确认您已经安装了最新的 Rust.

编写第一个 Salvo 程序

创建一个全新的项目:

cargo new hello_salvo --bin

添加依赖项到 Cargo.toml

[dependencies]
salvo = "0.24"
tokio = { version = "1", features = ["macros"] }

在 main.rs 中创建一个简单的函数句柄, 命名为hello_world, 这个函数只是简单地打印文本 "Hello world".

use salvo::prelude::*;

#[fn_handler]
async fn hello_world() -> &'static str {
    "Hello world"
}
#[tokio::main]
async fn main() {
    let router = Router::new().get(hello_world);
    Server::new(TcpListener::bind("127.0.0.1:7878")).serve(router).await.unwrap();
}

恭喜你, 你的一个 Salvo 程序已经完成. 只需要在命令行下运行 cargo run, 然后在浏览器里打开 http://127.0.0.1:7878 即可.

详细解读

这里的 hello_world 是一个 Handler, 用于处理用户请求. #[fn_handler] 可以让一个函数方便实现 Handler trait. 并且, 它允许我们用不同的方式简写函数的参数.

  • 原始形式:

    #[fn_handler]
async fn hello_world(_req: &mut Request, _depot: &mut Depot, res: &mut Response, _ctrl: &mut FlowCtrl) {
    res.render("Hello world");
}

  • 您可以省略调函数中参数中你用不着的, 比如这里面的 ``_req, _depot, _ctrl``` 都用不着, 可以直接不写.

    #[fn_handler]
async fn hello_world(res: &mut Response) {
    res.render("Hello world");
}

  • 任何类型都可以作为函数的返回类型, 只要它实现了 Writer trait. 比如 &str 实现了 Writer, 当它被作为返回值时, 就打印纯文本:

    #[fn_handler]
async fn hello_world(res: &mut Response) -> &'static str {// just return &str
    "Hello world"
}

  • 更普遍的情况是, 我们需要在将 Result<T, E> 作为返回类型, 以便处理函数执行过程中的错误. 如果 T 和 E 都实现了 Writer, 那么 Result<T, E> 就可以作为返回值:

    #[fn_handler]
async fn hello_world(res: &mut Response) -> Result<&'static str, ()> {// return Result
    Ok("Hello world")
}

更多示例

建议直接克隆 Salvo 仓库, 然后运行 examples 目录下的示例. 比如下面的命令可以运行 hello_world 的例子:

git clone https://github.com/salvo-rs/salvo
cd salvo
cargo run --bin example-hello_world

examples 目录下有很多的例子. 都可以通过类似 cargo run --bin example-<name> 的命令运行.

← Handler
Request →