リクエスト中のパニックをキャッチ

Catch Panicは、プログラムがリクエストを処理する過程で発生するクラッシュをキャッチするために使用されます。具体的なAPIについてはドキュメントを参照してください

注意: CatchPanicを使用するには、Cargo.tomlcatch-panic featureを有効にする必要があります:

salvo= { version = "xxx", features = ["catch-panic"] }

ミドルウェアの紹介

CatchPanicは、ハンドラー内で発生するパニックをキャッチするためのミドルウェアです。リクエスト処理中にパニックが発生した場合、サーバー全体をクラッシュさせる代わりに、これらのパニックをキャッチし、500 Internal Server Errorをレスポンスに書き込みます。

重要: このミドルウェアは、他のミドルウェアやハンドラー内のパニックを確実にキャッチできるように、最初のミドルウェアとして使用する必要があります。

基本的な使い方

use salvo_core::prelude::*;
use salvo_extra::catch_panic::CatchPanic;

#[handler]
async fn hello() {
    panic!("panic error!");
}

#[tokio::main]
async fn main() {
    let router = Router::new().hoop(CatchPanic::new()).get(hello);
    let acceptor = TcpListener::new("0.0.0.0:8698").bind().await;
    Server::new(acceptor).serve(router).await;
}

他のフレームワークとの比較 概念を素早く理解

Axum

AxumにおけるTowercatch_panicミドルウェアに相当:

use axum::{
    Router,
    routing::get,
    http::StatusCode,
};
use tower::ServiceBuilder;
use tower_http::catch_panic::CatchPanicLayer;

async fn panic_handler() -> &'static str {
    panic!("panic error!");
}

#[tokio::main]
async fn main() {
    let app = Router::new()
        .route("/", get(panic_handler))
        .layer(
            ServiceBuilder::new()
                .layer(CatchPanicLayer::new())
        );
    
    axum::Server::bind(&"0.0.0.0:3000".parse().unwrap())
        .serve(app.into_make_service())
        .await
        .unwrap();
}

Gin (Go)

Go言語のGinフレームワークでは、Recoveryミドルウェアに類似:

package main

import (
    "github.com/gin-gonic/gin"
)

func main() {
    r := gin.Default() // デフォルトでRecoveryミドルウェアを含む
    
    r.GET("/", func(c *gin.Context) {
        panic("panic error!")
    })
    
    r.Run(":8080")
}

サンプルコード

main.rs
Cargo.toml
use salvo::prelude::*;

// Handler that deliberately panics to demonstrate panic catching
#[handler]
async fn hello() {
    panic!("panic error!");
}

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

    // Set up router with CatchPanic middleware to handle panics gracefully
    // This prevents the server from crashing when a panic occurs in a handler
    let router = Router::new().hoop(CatchPanic::new()).get(hello);

    // Bind server to port 8698 and start serving
    let acceptor = TcpListener::new("0.0.0.0:8698").bind().await;
    Server::new(acceptor).serve(router).await;
}