世界, 你好!

安裝 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> 作為返回類型, 以便處理函數執行過程中的錯誤. 如果 TE 都實現了 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> 的命令運行.