捕捉請求中的 Panic

Catch Panic 用於捕捉程式在處理請求過程中發生的崩潰。具體 API 請查閱文件.

注意: 使用 CatchPanic 需要在 Cargo.toml 中啟用 catch-panic 功能:

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

中介軟體介紹

CatchPanic 是一個用於捕捉處理程序中 panic 的中介軟體。當處理請求的過程中發生 panic 時,它會捕捉這些 panic 並將 500 Internal Server Error 寫入回應,而不是讓整個伺服器崩潰。

重要提示: 該中介軟體應作為第一個中介軟體使用,以確保能捕捉到其他中介軟體或處理程序中的 panic。

基本用法

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:5800").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
catch-panic/src/main.rs
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 5800 and start serving
    let acceptor = TcpListener::new("0.0.0.0:5800").bind().await;
    Server::new(acceptor).serve(router).await;
}