ScheduleTaskHelper.Plugins 1.0.7

ScheduleTaskHelper.Plugins

?? Overview

ScheduleTaskHelper.Plugins is a plugin-based architecture framework designed for .NET applications. It provides dynamic loading and management of external plugins, enabling developers to extend functionality without modifying the core application. This framework supports plugin initialization, service registration, task management, and graceful unloading, making it ideal for applications requiring high modularity and extensibility.

??? Key Features

• Dynamic Plugin Loading: Load and manage plugins dynamically at runtime.
• Task Scheduling: Support for scheduled and cron-based tasks.
• Dependency Injection: Seamless integration with .NET's DI container.
• Extensibility: Easily extend the application by adding new plugins.
• Task Metadata: Define and manage task metadata, including descriptions, parameters, and execution settings.
• Graceful Shutdown: Ensure proper resource cleanup when unloading plugins.

??? Architecture

Core Components

1. Plugin Interface (IPlugin)

Defines the contract for all plugins, including methods for initialization, service registration, task retrieval, and shutdown.

public interface IPlugin
{
    IPluginMetadata Metadata { get; }
    Task<bool> InitializeAsync(IServiceCollection services);
    void RegisterServices(IServiceCollection services);
    IEnumerable<PluginTaskInfo> GetAvailableTasks();
    Task ShutdownAsync();
}

2. Base Plugin (BasePlugin)

Provides a default implementation of the IPlugin interface, simplifying plugin development.

3. Plugin Metadata (IPluginMetadata)

Stores metadata about a plugin, such as its ID, name, version, author, and description.

4. Plugin Task Info (PluginTaskInfo)

Encapsulates information about tasks provided by a plugin, including task type, ID, description, and default parameters.

5. Plugin Configuration (PluginConfiguration)

Manages plugin and task configurations, including enabling/disabling plugins and defining task parameters.

6. Plugin Loader (PluginLoader)

Handles the discovery, loading, and management of plugins.

?? Configuration

Plugin Configuration File (pluginconfig.json)

Defines the enabled plugins and their task configurations.

{
  "EnabledPlugins": [
    "SamplePlugin"
  ],
  "TaskConfigurations": {
    "SampleTask": {
      "Enabled": true,
      "Group": "SampleTasks",
      "Priority": 1,
      "InitialDelay": "00:00:10",
      "Period": "00:05:00"
    },
    "SampleCronTask": {
      "Enabled": true,
      "Group": "SampleTasks",
      "CronExpression": "0 */5 * * * *",
      "ExecuteImmediately": true
    }
  }
}

Key Configuration Fields

• EnabledPlugins: List of plugin IDs to load.
• TaskConfigurations: Defines task-specific settings, such as schedule, priority, and parameters.

?? Getting Started

1. Create a Plugin

Implement the IPlugin interface or extend the BasePlugin class to create a new plugin.

public class SamplePlugin : BasePlugin
{
    public override IPluginMetadata Metadata => new PluginMetadata(
        id: "SamplePlugin",
        name: "Sample Plugin",
        version: "1.0.0",
        author: "Your Name",
        description: "A sample plugin demonstrating the plugin architecture."
    );

    public override IEnumerable<PluginTaskInfo> GetAvailableTasks()
    {
        yield return new PluginTaskInfo
        {
            TaskType = typeof(SampleTask),
            TaskId = "SampleTask",
            DisplayName = "Sample Task",
            Description = "A sample task provided by the Sample Plugin.",
            EnabledByDefault = true
        };
    }
}

2. Register Plugin Services

Override the RegisterServices method to register services required by the plugin.

public override void RegisterServices(IServiceCollection services)
{
    services.AddSingleton<ISampleService, SampleService>();
}

3. Load Plugins

Use the PluginLoader to discover and load plugins dynamically.

var pluginLoader = new PluginLoader();
await pluginLoader.LoadPluginsAsync();

?? API Documentation

Plugin Metadata (IPluginMetadata)

• Id: Unique identifier for the plugin.
• Name: Display name of the plugin.
• Version: Plugin version.
• Author: Plugin author.
• Description: Description of the plugin.

Plugin Task Info (PluginTaskInfo)

• TaskType: Type of the task (must implement IScheduledTask or ICronScheduledTask).
• TaskId: Unique identifier for the task.
• DisplayName: Display name of the task.
• Description: Description of the task.
• DefaultParameters: Default parameters for the task.
• EnabledByDefault: Indicates if the task is enabled by default.

?? License

This project is licensed under the MIT License. See the LICENSE file for details.