• Português

      • Cache

      Middleware que fornece funcionalidade de cache.

      O middleware Cache pode armazenar em cache o StatusCode, Headers e Body de uma Response. Para conteúdos já armazenados em cache, o middleware Cache enviará diretamente o conteúdo em cache da memória para o cliente ao processar solicitações subsequentes.

      Nota: Este plugin não armazena em cache objetos Response cujo Body seja ResBody::Stream. Se aplicado a tal Response, o Cache não processará essas solicitações e nenhum erro ocorrerá.

      Principais Funcionalidades

      • CacheIssuer fornece uma abstração para gerar chaves de cache. RequestIssuer é uma de suas implementações, permitindo definir quais partes da URL da solicitação e do Method da solicitação devem ser usadas para gerar a chave de cache. Você também pode definir sua própria lógica de geração de chaves de cache. A chave de cache não precisa necessariamente ser uma string; qualquer tipo que satisfaça as restrições Hash + Eq + Send + Sync + 'static pode ser usado como chave.

      • CacheStore fornece operações para armazenar e recuperar dados. MokaStore é uma implementação de cache baseada em memória integrada, baseada em moka. Você também pode definir sua própria implementação.

      • Cache é uma estrutura que implementa Handler. Ela também contém um campo interno skipper, que pode ser usado para especificar solicitações que devem ignorar o cache. Por padrão, usa MethodSkipper para ignorar todas as solicitações, exceto aquelas com Method::GET.

        Exemplo de código de implementação interna:

        impl<S, I> Cache<S, I> {
  pub fn new(store: S, issuer: I) -> Self {
      let skipper = MethodSkipper::new().skip_all().skip_get(false);
      Cache {
          store,
          issuer,
          skipper: Box::new(skipper),
      }
  }
}

      Migração Rápida de Outros Frameworks

      Se você já usou mecanismos de cache em outros frameworks, os seguintes mapeamentos conceituais ajudarão você a se adaptar mais rapidamente à implementação de cache do Salvo:

      Guia de Migração do Framework Rust

      • Migrando do Actix-web: Plugins como actix-web-cache no Actix-web normalmente precisam ser introduzidos separadamente, enquanto o cache no Salvo faz parte da biblioteca principal.

        // Exemplo de cache no Actix-web
use actix_web_cache::Cache;
App::new().wrap(Cache::new().ttl(30))

// Implementação correspondente no Salvo
use salvo::prelude::*;
Router::new().hoop(Cache::new(MokaStore::new(100), RequestIssuer::new()))

      Guia de Migração para Frameworks em Outras Linguagens

      • Migrando do Go/Gin: O Gin usa um padrão de middleware, que o Salvo também adota de maneira semelhante:

        // Exemplo de cache no Gin
store := persist.NewMemoryStore(time.Second * 60)
router.Use(cache.CachePage(store, time.Second * 30))
        // Implementação correspondente no Salvo
let store = MokaStore::new(100).with_ttl(Duration::from_secs(30));
router.hoop(Cache::new(store, RequestIssuer::new()))

      • Migrando do Spring Boot: O cache declarativo do Spring Boot precisa ser convertido para a configuração explícita de middleware do Salvo:

        // Spring Boot
@Cacheable(value = "books", key = "#isbn")
public Book findBook(ISBN isbn) { ... }
        // Implementação correspondente no Salvo - aplicando cache no nível da rota
let custom_issuer = YourCustomIssuer::new(); // Implemente a interface CacheIssuer
Router::with_path("books").hoop(Cache::new(MokaStore::new(100), custom_issuer))

      • Migrando do Express.js: O middleware de cache do Express.js é conceitualmente semelhante ao do Salvo, mas a sintaxe difere:

        // Express.js
const apicache = require('apicache');
app.use(apicache.middleware('5 minutes'));

// Implementação correspondente no Salvo
let store = MokaStore::new(100).with_ttl(Duration::from_secs(300));
router.hoop(Cache::new(store, RequestIssuer::new()))

      Ao migrar de outros frameworks, preste atenção a vários conceitos-chave do cache do Salvo:

      1. Geração de Chave de Cache - Controlada pela interface CacheIssuer.
      2. Armazenamento de Cache - Implementado pela interface CacheStore.
      3. Lógica de Ignorar Cache - Personalizada pelo mecanismo skipper.

      Por padrão, o Salvo armazena em cache apenas solicitações GET, o que está alinhado com o comportamento padrão da maioria dos frameworks.

      Código de Exemplo

      main.rs
      Cargo.toml
      use std::time::Duration;

use salvo::cache::{Cache, MokaStore, RequestIssuer};
use salvo::prelude::*;
use salvo::writing::Text;
use time::OffsetDateTime;

// Handler for serving the home page with HTML content
#[handler]
async fn home() -> Text<&'static str> {
    Text::Html(HOME_HTML)
}

// Handler for short-lived cached response (5 seconds)
#[handler]
async fn short() -> String {
    format!(
        "Hello World, my birth time is {}",
        OffsetDateTime::now_utc()
    )
}

// Handler for long-lived cached response (1 minute)
#[handler]
async fn long() -> String {
    format!(
        "Hello World, my birth time is {}",
        OffsetDateTime::now_utc()
    )
}

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

    // Create cache middleware for short-lived responses (5 seconds TTL)
    let short_cache = Cache::new(
        MokaStore::builder()
            .time_to_live(Duration::from_secs(5))
            .build(),
        RequestIssuer::default(),
    );

    // Create cache middleware for long-lived responses (60 seconds TTL)
    let long_cache = Cache::new(
        MokaStore::builder()
            .time_to_live(Duration::from_secs(60))
            .build(),
        RequestIssuer::default(),
    );

    // Set up router with three endpoints:
    // - / : Home page
    // - /short : Response cached for 5 seconds
    // - /long : Response cached for 1 minute
    let router = Router::new()
        .get(home)
        .push(Router::with_path("short").hoop(short_cache).get(short))
        .push(Router::with_path("long").hoop(long_cache).get(long));

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

// HTML template for the home page with links to cached endpoints
static HOME_HTML: &str = r#"
<!DOCTYPE html>
<html>
    <head>
        <title>Cache Example</title>
    </head>
    <body>
        <h2>Cache Example</h2>
        <p>
            This examples shows how to use cache middleware.
        </p>
        <p>
            <a href="/short" target="_blank">Cache 5 seconds</a>
        </p>
        <p>
            <a href="/long" target="_blank">Cache 1 minute</a>
        </p>
    </body>
</html>
"#;