Panics in Anfragen abfangen

Catch Panic dient dazu, Programmabstürze während der Anfrageverarbeitung abzufangen. Die spezifische API finden Sie in der Dokumentation.

Hinweis: Um CatchPanic zu verwenden, muss das Feature catch-panic in Cargo.toml aktiviert werden:

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

Middleware-Übersicht

CatchPanic ist eine Middleware, die Panics in Handler-Funktionen abfängt. Tritt während der Anfrageverarbeitung ein Panic auf, wird dieser abgefangen und stattdessen eine 500 Internal Server Error-Antwort gesendet, ohne dass der gesamte Server abstürzt.

Wichtig: Diese Middleware sollte als erste Middleware eingesetzt werden, um sicherzustellen, dass Panics in anderen Middlewares oder Handlern abgefangen werden.

Grundlegende Verwendung

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;
}

Vergleich mit anderen Frameworks - Konzepte schnell verstehen

Axum

Äquivalent zur catch_panic-Middleware von Tower in Axum:

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)

In Go mit dem Gin-Framework ähnlich der Recovery-Middleware:

package main

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

func main() {
    r := gin.Default() // Enthält standardmäßig die Recovery-Middleware
    
    r.GET("/", func(c *gin.Context) {
        panic("panic error!")
    })
    
    r.Run(":8080")
}

Beispielcode

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;
}