插件基础知识

ClassIsland 社区About 3 min

插件基础知识

这里是在 ClassIsland 开发基础的基础上，开发插件时还需要注意的事项。

程序集隔离

默认情况下，不同的插件会被加载到不同的程序集加载上下文（AssemblyLoadContext）中。因此，不同插件间可以引入相同依赖库的不同版本，而不会产生冲突。

Warning

由于这个特性，当两个插件间包含具有相同名称的类型定义时，它们不是同一类型。当且仅当它们来自同一个 Assembly 实例时，它们的类型相同。详细请见此文章。

资源引用

在插件中引用插件程序集内的资源时，需要使用绝对路径，否则会将路径解析至 ClassIsland 本体的程序集。例如：

pack://application:,,,/程序集名称;;;component/资源路径
pack://application:,,,/ExamplePlugin;;;component/Assets/Image.png

依赖注入

在 ClassIsland 开发基础所描述的基础上，插件需要在入口点的 Initialize 方法内完成相关注册操作。例如：

// ...
namespace ClassIsland.ExamplePlugin;

[PluginEntrance]
public class Plugin : PluginBase
{
    public override void Initialize(HostBuilderContext context, IServiceCollection services)
    {
        services.AddSettingsPage<HelloSettingsPage>();
        services.AddSingleton<MyService>();
    }
    // ...
}

访问 Application 对象

ClassIsland 的应用程序类（App）基于封装后的 System.Windows.Application 类 ClassIsland.Core.AppBase。AppBase 类在源 Application 的基础上，向插件暴露了一些生命周期事件和控制生命周期状态的方法。

您可以通过 ClassIsland.Core.AppBase 的 Current 属性获取当前 Application 实例。

下面的示例代码获取了应用程序对象，并订阅了 AppStarted 事件，以在应用启动完成时在终端输出“App started!”。

var app = AppBase.Current;

app.AppStarted += (o, args) => Console.WriteLine("App started!");

您可以通过 AppBase.Stop 和 AppBase.Restart 方法停止或重启应用。下面的代码演示了如何重启 ClassIsland。

var app = AppBase.Current;

app.Restart();

保存插件配置

ClassIsland 为每个插件创建了单独的配置目录，您可以将插件的各种配置文件和数据库等信息保存到插件的配置目录下。您可以通过访问插件入口类的PluginConfigFolder属性来获取插件配置目录的绝对路径。

您可以使用ClassIsland.Shared.Helpers.ConfigureFileHelper类中封装的方法便捷地读取和保存 JSON 格式的配置文件。例如：

using System.IO;
using ClassIsland.Core.Abstractions;
using ClassIsland.Core.Attributes;
using ClassIsland.Core.Extensions.Registry;
using ClassIsland.Shared.Helpers;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Hosting;
using PluginWithSettingsPage.Models;
using PluginWithSettingsPage.Views.SettingsPages;

namespace PluginWithSettingsPage;

[PluginEntrance]
public class Plugin : PluginBase
{
    public Settings Settings { get; set; } = new();

    public override void Initialize(HostBuilderContext context, IServiceCollection services)
    {
        Settings = ConfigureFileHelper.LoadConfig<Settings>(Path.Combine(PluginConfigFolder, "Settings.json"));  // 加载配置文件
        Settings.PropertyChanged += (sender, args) =>
        {
            ConfigureFileHelper.SaveConfig<Settings>(Path.Combine(PluginConfigFolder, "Settings.json"), Settings);  // 保存配置文件
        };
    }

    public override void OnShutdown()
    {
    }
}

上面的的示例代码在插件入口类的初始化方法中获取了插件配置目录，然后读取插件配置，并订阅了配置对象的PropertyChanged属性，以在配置属性更改时保存配置文件。

Warning