Crate spring

source
Expand description

For the complete documentation of spring, please click this address: https://spring-rs.github.io

crates.io Documentation

§Introduction

spring is the core module of this project, which includes: configuration management, plugin management, and component management.

  • All plugins need to implement the Plugin trait.
  • All configurations need to implement the Configurable trait.
  • All components need to implement the Clone trait.

Note: To avoid deep copying of large struct in Component, it is recommended to use the newtype pattern to reference them via Arc<T>.

§How to write your own plugin

Add dependencies

spring = { version = "<version>" }           # This crate contains the definition of plugin traits
serde = { workspace = true, features = ["derive"] } # Used to parse plugin configuration items
use serde::Deserialize;
use spring::async_trait;
use spring::config::{Configurable, ConfigRegistry};
use spring::{app::AppBuilder, plugin::Plugin};

struct MyPlugin;

#[async_trait]
impl Plugin for MyPlugin {
    async fn build(&self, app: &mut AppBuilder) {
        // Call app.get_config::<Config>() method to get configuration items
        match app.get_config::<Config>() {
            Ok(config) => {
                println!("{:#?}", config);
                assert_eq!(config.a, 1);
                assert_eq!(config.b, true);

                // Get the configuration items to build the corresponding components

            }
            Err(e) => println!("{:?}", e),
        }
    }
}

/// Plugin configuration
#[derive(Debug, Configurable, Deserialize)]
#[config_prefix = "my-plugin"]
struct Config {
    a: u32,
    b: bool,
}

For the complete code, refer to plugin-example, or refer to other built-in plugin codes.

§Compile-time dependency inject

spring-rs provides a special Component - Service, which supports injecting dependent components at compile time.

Like the following example, UserService only needs to derive the Service feature. In order to distinguish the injected dependencies, you need to specify whether the dependency is a Component or a Config through the attribute macros #[component] and #[config].

use spring_sqlx::ConnectPool;
use spring::config::Configurable;
use spring::plugin::service::Service;
use serde::Deserialize;

#[derive(Clone, Configurable, Deserialize)]
#[config_prefix = "user"]
struct UserConfig {
    username: String,
    project: String,
}

#[derive(Clone, Service)]
struct UserService {
    #[component]
    db: ConnectPool,
    #[config]
    config: UserConfig,
}

For the complete code, see dependency-inject-example.

Re-exports§

Modules§

Macros§

Attribute Macros§