• English

      • Response Compression

      A middleware for compressing the content of Response.

      Supports three compression formats: br, gzip, and deflate. The priority and configuration of each compression method can be customized as needed.

      Data Compression in HTTP Protocol

      1. File format level: Specific file types use dedicated compression algorithms.
      2. HTTP protocol level: End-to-end resource compression transmission is achieved through content encoding.
      3. Connection level: Data compression is performed between nodes of an HTTP connection.

      For more information about HTTP compression, refer to the Mozilla Developer Network documentation.

      Example Code

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

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

    // Print current working directory for debugging
    println!("current_dir: {:?}", std::env::current_dir().unwrap());

    // Set up base directory for static files
    let current_dir = std::env::current_dir().unwrap();
    let base_dir = if !current_dir.to_str().unwrap().ends_with("compression") {
        current_dir
            .join("compression/static")
            .canonicalize()
            .unwrap()
    } else {
        current_dir.join("static").canonicalize().unwrap()
    };
    println!("Base Dir: {base_dir:?}");

    // Configure router with different compression settings for different paths
    let router = Router::new()
        // WebSocket chat with forced compression priority
        .push(
            Router::with_hoop(Compression::new().force_priority(true))
                .path("ws_chat")
                .get(StaticFile::new(base_dir.join("ws_chat.txt"))),
        )
        // SSE chat with Brotli compression
        .push(
            Router::with_hoop(Compression::new().enable_brotli(CompressionLevel::Fastest))
                .path("sse_chat")
                .get(StaticFile::new(base_dir.join("sse_chat.txt"))),
        )
        // Todos with Zstd compression
        .push(
            Router::with_hoop(Compression::new().enable_zstd(CompressionLevel::Fastest))
                .path("todos")
                .get(StaticFile::new(base_dir.join("todos.txt"))),
        )
        // All other paths with Gzip compression
        .push(
            Router::with_hoop(Compression::new().enable_gzip(CompressionLevel::Fastest))
                .path("{*path}")
                .get(StaticDir::new(base_dir)),
        );

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