Salvo框架中404错误日志记录问题解析

问题背景

在使用Salvo框架开发Web应用时，开发者发现框架默认不会记录404错误的访问日志。这个问题在社区中被提出并讨论，最终得到了解决。

问题复现

当开发者使用Salvo框架构建一个简单的Web服务时，通常会配置基础的日志记录功能。例如以下典型代码：

use salvo::prelude::*;

#[handler]
async fn hello() -> &'static str {
    "Hello World"
}

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

    let router = Router::new().hoop(Logger::new()).get(hello);
    let acceptor = TcpListener::new("127.0.0.1:5800").bind().await;
    Server::new(acceptor).serve(router).await;
}

这段代码配置了一个简单的路由和日志中间件，但当访问不存在的路径时，虽然会返回404响应，但日志系统却不会记录这些请求。

问题原因

Salvo框架的日志中间件默认只记录成功匹配路由的请求。对于未匹配任何路由的请求（即404响应），日志中间件不会自动记录。这是框架设计上的一个特性，而非缺陷。

解决方案

要记录404请求，开发者需要显式地添加一个专门处理404情况的中间件。具体实现方式是在路由配置中添加一个catch_all处理器：

use salvo::prelude::*;

#[handler]
async fn hello() -> &'static str {
    "Hello World"
}

#[handler]
async fn handle_404(res: &mut Response) {
    res.status_code(StatusCode::NOT_FOUND);
}

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

    let router = Router::new()
        .hoop(Logger::new())
        .get(hello)
        .push(Router::with_path("<**path>").handle(handle_404));
    
    let acceptor = TcpListener::new("127.0.0.1:5800").bind().await;
    Server::new(acceptor).serve(router).await;
}

技术原理

在Salvo框架中，路由匹配是按照定义顺序进行的。当添加一个通配路径<**path>的路由处理器后，所有未匹配前面路由的请求都会落到这个处理器上。由于这个处理器位于日志中间件之后，因此这些请求也会被日志系统记录。

最佳实践

1. 明确记录所有请求：建议开发者始终配置404处理器，以便完整记录所有访问日志
2. 自定义404处理：可以在404处理器中添加更多业务逻辑，如返回自定义错误页面
3. 日志级别控制：可以通过配置日志中间件参数来控制404日志的记录级别

总结

Salvo框架的这种设计给了开发者更大的灵活性，允许开发者根据需要决定是否记录404请求。理解这一机制有助于开发者更好地构建符合业务需求的Web应用日志系统。通过合理配置路由和中间件，可以实现完整的访问日志记录功能。