同步和異步 Rust 中的 RESTful API

2024-07-26碼農

在現代軟體開發中，RESTful API 已經成為構建分布式應用程式的標準方式。Rust 作為一種高效、安全且可靠的程式語言，為建立強大的 RESTful API 提供了理想的環境。本文將深入探討如何在 Rust 中使用同步和異步方式構建 RESTful API，並提供相應的範例程式碼。

同步 RESTful API

同步 API 在執行操作時會阻塞當前執行緒，直到操作完成。這對於簡單的 API 或處理單個請求的場景來說可能足夠了。以下是一個使用 hyper 庫建立同步 RESTful API 的簡單範例：

use hyper::{Body, Method, Request, Response, Server, StatusCode}; use hyper::service::{make_service_fn, service_fn}; #[tokio::main] asyncfnmain() { // 定義一個簡單的數據結構 #[derive(serde::Serialize, serde::Deserialize)] structUser { id: u32, name: String, } // 建立一個異步服務函式 let service = make_service_fn(|_| async { Ok::<_, hyper::Error>(service_fn(handle_request)) }); // 使用 `hyper` 構建一個 HTTP 伺服器 let addr = ([127, 0, 0, 1], 3000).into(); let server = Server::bind(&addr).serve(service); println!("伺服器正在監聽：http://127.0.0.1:3000"); // 執行伺服器 ifletErr(e) = server.await { eprintln!("伺服器啟動錯誤：{}", e); } } // 處理請求的函式 asyncfnhandle_request(req: Request<Body>) -> Result<Response<Body>, hyper::Error> { // 處理 GET 請求 if req.method() == Method::GET && req.uri().path() == "/users" { // 建立一個使用者數據 let user = User { id: 1, name: "John Doe".to_string() }; // 將使用者數據序列化為 JSON 格式 let json = serde_json::to_string(&user).unwrap(); // 返回成功的響應 Ok(Response::new(Body::from(json))) } else { // 返回 404 錯誤 Ok(Response::builder() .status(StatusCode::NOT_FOUND) .body(Body::empty()) .unwrap()) } }

在這個範例中，我們使用 hyper 庫建立了一個 HTTP 伺服器，並定義了一個 handle_request 函式來處理傳入的請求。該函式檢查請求的方法和路徑，並根據情況返回相應的響應。

異步 RESTful API

異步 API 在執行操作時不會阻塞當前執行緒，而是使用非阻塞 I/O 操作來提高效率。這對於處理大量並行請求的 API 非常重要。Rust 的異步編程模型基於 async / await 關鍵字和 tokio 等異步執行時。

以下是一個使用 tokio 和 hyper 庫建立異步 RESTful API 的範例：

use hyper::{Body, Method, Request, Response, Server}; use hyper::service::{make_service_fn, service_fn}; use tokio::sync::Mutex; #[tokio::main] asyncfnmain() { // 定義一個簡單的數據結構 #[derive(serde::Serialize, serde::Deserialize)] structUser { id: u32, name: String, } // 建立一個共享的使用者資訊儲存 let users = Mutex::new(vec![ User { id: 1, name: "John Doe".to_string() }, User { id: 2, name: "Jane Doe".to_string() }, ]); // 建立一個異步服務函式 let service = make_service_fn(move |_| { let users = users.clone(); asyncmove { Ok::<_, hyper::Error>(service_fn(move |req| { let users = users.clone(); handle_request(req, users) })) } }); // 使用 `hyper` 構建一個 HTTP 伺服器 let addr = ([127, 0, 0, 1], 3000).into(); let server = Server::bind(&addr).serve(service); println!("伺服器正在監聽：http://127.0.0.1:3000"); // 執行伺服器 ifletErr(e) = server.await { eprintln!("伺服器啟動錯誤：{}", e); } } // 處理請求的函式 asyncfnhandle_request( req: Request<Body>, users: Mutex<Vec<User>>, ) -> Result<Response<Body>, hyper::Error> { // 處理 GET 請求 if req.method() == Method::GET && req.uri().path() == "/users" { // 獲取使用者數據 let users = users.lock().await; let json = serde_json::to_string(&*users).unwrap(); // 返回成功的響應 Ok(Response::new(Body::from(json))) } else { // 返回 404 錯誤 Ok(Response::builder() .status(StatusCode::NOT_FOUND) .body(Body::empty()) .unwrap()) } }