キャッチャー

Responseのステータスコードがエラーで、ページ内のBodyが空の場合、salvoはCatcherを使用してこのエラーを捕捉し、ユーザーフレンドリーなエラーページを表示しようとします。

Catcher::default()を使用すると、システムデフォルトのCatcherを取得でき、それをServiceに追加できます。

use salvo::catcher::Catcher;

Service::new(router).catcher(Catcher::default());

デフォルトのCatcherは、XMLJSONHTMLText形式でエラーページを送信することをサポートしています。

このデフォルトのCatcherhoopを追加することで、カスタムエラーハンドラをCatcherに追加できます。このエラーハンドラも依然としてHandlerです。

hoopを使用してCatcherに複数のカスタムエラーハンドラを追加できます。カスタムエラーハンドラはエラー処理後にFlowCtrl::skip_nextメソッドを呼び出して後続のエラーハンドラをスキップし、早期リターンすることが可能です。

main.rs
Cargo.toml
custom-error-page/src/main.rs
use salvo::catcher::Catcher;
use salvo::prelude::*;

// Handler that returns a simple "Hello World" response
#[handler]
async fn hello() -> &'static str {
    "Hello World"
}

// Handler that deliberately returns a 500 Internal Server Error
#[handler]
async fn error500(res: &mut Response) {
    res.status_code(StatusCode::INTERNAL_SERVER_ERROR);
}

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

    // Create and start server with custom error handling
    let acceptor = TcpListener::new("0.0.0.0:5800").bind().await;
    Server::new(acceptor).serve(create_service()).await;
}

// Create service with custom error handling
fn create_service() -> Service {
    // Set up router with two endpoints:
    // - / : Returns "Hello World"
    // - /500 : Triggers a 500 error
    let router = Router::new()
        .get(hello)
        .push(Router::with_path("500").get(error500));

    // Add custom error catcher for 404 Not Found errors
    Service::new(router).catcher(Catcher::default().hoop(handle404))
}

// Custom handler for 404 Not Found errors
#[handler]
async fn handle404(&self, _req: &Request, _depot: &Depot, res: &mut Response, ctrl: &mut FlowCtrl) {
    // Check if the error is a 404 Not Found
    if StatusCode::NOT_FOUND == res.status_code.unwrap_or(StatusCode::NOT_FOUND) {
        // Return custom error page
        res.render("Custom 404 Error Page");
        // Skip remaining error handlers
        ctrl.skip_rest();
    }
}