8 releases

0.0.9 Sep 4, 2024
0.0.8 Aug 25, 2024

#885 in Configuration

Download history 102/week @ 2024-08-10 351/week @ 2024-08-17 246/week @ 2024-08-24 212/week @ 2024-08-31 25/week @ 2024-09-07 15/week @ 2024-09-14 1/week @ 2024-09-21 103/week @ 2024-09-28 6/week @ 2024-10-05 3/week @ 2024-10-12

564 downloads per month
Used in spring-actuator

MIT license

30KB
675 lines

crates.io Documentation

Introduction

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

All plugins need to implement the Plugin feature.

How to write your own plugin

Add dependencies

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

struct MyPlugin;

#[async_trait]
impl Plugin for MyPlugin {
    async fn build(&self, app: &mut AppBuilder) {
        // Call app.get_config::<Config>(self) method to get configuration items
        match app.get_config::<Config>(self) {
            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),
        }
    }
}

/// Configuration item prefix
impl Configurable for MyPlugin {
    fn config_prefix(&self) -> &str {
        "my-plugin"
    }
}

/// Plugin configuration
#[derive(Debug, Deserialize)]
struct Config {
    a: u32,
    b: bool,
}

You can use the derive macro to implement the Configurable trait:

/// Use the `config_prefix` attr macro to define the prefix configured in the toml file
#[derive(Configurable)]
#[config_prefix = "my-plugin"]
struct MyPlugin;

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

Dependencies

~9–18MB
~219K SLoC