Состояние Affix - общие данные в запросе

Промежуточное ПО Affix State используется для добавления общих данных в Depot. Для использования функции Affix State необходимо включить функцию affix-state в Cargo.toml.

Разбор функциональности

Affix State предоставляет простой способ обмена данными в процессе обработки запроса. Он позволяет вам:

  • Вводить глобальные настройки или общие данные на этапе конфигурации маршрута
  • Получать доступ к этим данным через Depot в любом обработчике
  • Поддерживать любой клонируемый тип в качестве данных состояния

Сравнение с другими фреймворками для быстрого понимания концепции

ФреймворкЯзыкСпособ управления состоянием
Salvo (Affix State)RustХранение и доступ через Depot, поддержка различных типов
AxumRustХранение состояния через Extension, аналогично, но с другим способом использования
Actix-webRustИспользование App Data и Web::Data для общего состояния
GinGoИспользование context.Set и context.Get для доступа к данным
EchoGoИспользование context.Set и context.Get для управления общим состоянием
SpringJavaИспользование ApplicationContext или аннотации @Bean для управления зависимостями
QuarkusJavaИспользование CDI и механизма внедрения зависимостей
Express.jsJavaScriptИспользование app.locals или req.app.locals для хранения глобального состояния
Nest.jsJavaScriptИспользование системы внедрения зависимостей для управления общими сервисами
Koa.jsJavaScriptИспользование ctx.state для хранения состояния на уровне запроса

Типичные сценарии использования

  • Общий пул подключений к базе данных
  • Общий конфигурация приложения
  • Общий экземпляр кэша
  • Общий API-клиент
  • Глобальные счетчики или отслеживание состояния

Преимущество Affix State заключается в его простоте и гибкости, что позволяет легко обмениваться данными любого типа между различными маршрутами и обработчиками без большого количества шаблонного кода. Пример кода

main.rs
Cargo.toml
affix-state/src/main.rs
use std::sync::Arc;
use std::sync::Mutex;

use salvo::prelude::*;

// Configuration structure with username and password
#[allow(dead_code)]
#[derive(Default, Clone, Debug)]
struct Config {
    username: String,
    password: String,
}

// State structure to hold a list of fail messages
#[derive(Default, Debug)]
struct State {
    fails: Mutex<Vec<String>>,
}

#[handler]
async fn hello(depot: &mut Depot) -> String {
    // Obtain the Config instance from the depot
    let config = depot.obtain::<Config>().unwrap();
    // Get custom data from the depot
    let custom_data = depot.get::<&str>("custom_data").unwrap();
    // Obtain the shared State instance from the depot
    let state = depot.obtain::<Arc<State>>().unwrap();
    // Lock the fails vector and add a new fail message
    let mut fails_ref = state.fails.lock().unwrap();
    fails_ref.push("fail message".into());
    // Format and return the response string
    format!("Hello World\nConfig: {config:#?}\nFails: {fails_ref:#?}\nCustom Data: {custom_data}")
}

#[tokio::main]
async fn main() {
    // Initialize the tracing subscriber for logging
    tracing_subscriber::fmt().init();

    // Create a Config instance with default username and password
    let config = Config {
        username: "root".to_string(),
        password: "pwd".to_string(),
    };

    // Set up the router with state injection and custom data
    let router = Router::new()
        // Use hoop to inject middleware and data into the request context
        .hoop(
            affix_state::inject(config)
                // Inject a shared State instance into the request context
                .inject(Arc::new(State {
                    fails: Mutex::new(Vec::new()),
                }))
                // Insert custom data into the request context
                .insert("custom_data", "I love this world!"),
        )
        // Register the hello handler for the root path
        .get(hello)
        // Add an additional route for the path "/hello" with the same handler
        .push(Router::with_path("hello").get(hello));

    // Bind the server to port 5800 and start serving
    let acceptor = TcpListener::new("0.0.0.0:5800").bind().await;
    Server::new(acceptor).serve(router).await;
}