快速开始

安装 Rust

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

当前 Salvo 支持的最低 Rust 版本为 1.80. 运行 rustup update 确认您已经安装了符合要求的 Rust.

编写第一个 Salvo 程序

创建一个全新的项目:

cargo new hello --bin

添加依赖项到 Cargo.toml

[package]
name = "hello"
version = "0.1.0"
edition = "2021"
publish = false

[dependencies]
salvo = "0.72"
tokio = { version = "1", features = ["macros"] }
tracing = "0.1"
tracing-subscriber = "0.3"

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

use salvo::prelude::*;

#[handler]
async fn hello() -> &'static str {
    "Hello World"
}

#[tokio::main]
async fn main() {
    tracing_subscriber::fmt().init();

    let router = Router::new().get(hello);
    let acceptor = TcpListener::new("127.0.0.1:5800").bind().await;
    Server::new(acceptor).serve(router).await;
}

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

详细解读

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

原始形式:

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

您可以省略函数中某些用不着的参数, 比如这里面的 _req, _depot, _ctrl 都没有被使用, 可以直接不写:
```
#[handler]
async fn hello(res: &mut Response) {
    res.render("Hello world");
}
```
任何类型都可以作为函数的返回类型, 只要它实现了 Writer trait. 比如 &str 实现了 Writer, 当它被作为返回值时, 就打印纯文本:
```
#[handler]
async fn hello(res: &mut Response) -> &'static str {
    "Hello world"
}
```
更普遍的情况是, 我们需要在将 Result<T, E> 作为返回类型, 以便处理函数执行过程中的错误. 如果 T 和 E 都实现了 Writer, 那么 Result<T, E> 就可以作为返回值:
```
#[handler]
async fn hello(res: &mut Response) -> Result<&'static str, ()> {
    Ok("Hello world")
}
```

风骚的 HTTP3

据说 HTTP3 身轻如燕，多少程序员思而不得，这回，Salvo 就帮大家实现愿望，让大家轻松享受到 HTTP3 带来的美妙服务！

首先在 Cargo.toml 中启用 HTTP3 功能, 然后把 main.rs 改成这样：

use salvo::conn::rustls::{Keycert, RustlsConfig};
use salvo::prelude::*;

#[handler]
async fn hello() -> &'static str {
    "Hello World"
}

#[tokio::main]
async fn main() {
    tracing_subscriber::fmt().init();
    let cert = include_bytes!("../certs/cert.pem").to_vec();
    let key = include_bytes!("../certs/key.pem").to_vec();

    let router = Router::new().get(hello);
    let config = RustlsConfig::new(Keycert::new().cert(cert.as_slice()).key(key.as_slice()));
    let listener = TcpListener::new(("127.0.0.1", 5800)).rustls(config.clone());

    let acceptor = QuinnListener::new(config, ("127.0.0.1", 5800))
        .join(listener)
        .bind()
        .await;

    Server::new(acceptor).serve(router).await;
}

[package]
name = "example-hello-h3"
version = "0.1.0"
edition = "2021"
publish = false

[dependencies]
salvo = { workspace = true, features = ["quinn"] }
tokio = { version = "1", features = ["macros"] }
tracing = "0.1"
tracing-subscriber = "0.3"

快速开始

安装 Rust

编写第一个 Salvo 程序

详细解读

风骚的 HTTP3

更多示例