SuncodeSoftware.SuperSDK.App 2.2.0

SuperSDK.App 使用指南

SuperSDK.App 提供开箱即用的应用框架，集成 ReactiveUI、Logger、SqlDebug。

快速开始

1️⃣ 引入命名空间（使用 SApp 别名）

using SApp = SuperSDK.App.SuperApp;

2️⃣ 在 App.axaml.cs 中初始化和清理

using Avalonia;
using Avalonia.Controls.ApplicationLifetimes;
using Avalonia.Markup.Xaml;
using SApp = SuperSDK.App.SuperApp;

public partial class App : Application
{
    public override void Initialize()
    {
        AvaloniaXamlLoader.Load(this);
        
        // 初始化 SuperSDK.App
        SApp.Initialize(config =>
        {
            // 注册内置的 Logger 和 SQL Debug 窗口
            config.UseBuiltInLogger(showOnStartup: false);
            config.UseSqlDebug(showOnStartup: false);
            
            // 注册项目特有的数据库实体
            config.RegisterEntity<YourEntity>();
            
            // 初始化完成后的回调（可选）
            config.OnInitialized = () =>
            {
                SApp.LogInfo("应用初始化完成");
            };
        });
    }

    public override void OnFrameworkInitializationCompleted()
    {
        if (ApplicationLifetime is IClassicDesktopStyleApplicationLifetime desktop)
        {
            desktop.MainWindow = new MainWindow();
            
            // 🔥 程序退出时清理资源
            desktop.ShutdownRequested += (s, e) =>
            {
                SApp.Cleanup();
            };
        }

        base.OnFrameworkInitializationCompleted();
    }
}

就这么简单！ 只需要在 App.axaml.cs 中添加初始化和清理代码，无需在其他文件中做任何修改。

常用 API

Logger 操作

// 切换 Logger 窗口显示/隐藏
SApp.ToggleLogger();

// 记录日志
SApp.LogDebug("调试信息");
SApp.LogInfo("普通信息");
SApp.LogWarning("警告信息");
SApp.LogError("错误信息");

SQL Debug 操作

// 切换 SQL Debug 窗口显示/隐藏
SApp.ToggleSqlDebug();

完整示例

using Avalonia;
using Avalonia.Controls.ApplicationLifetimes;
using Avalonia.Markup.Xaml;
using SApp = SuperSDK.App.SuperApp;
using YourApp.Models;

namespace YourApp;

public partial class App : Application
{
    public override void Initialize()
    {
        AvaloniaXamlLoader.Load(this);
        
        SApp.Initialize(config =>
        {
            config.UseBuiltInLogger(showOnStartup: false);
            config.UseSqlDebug(showOnStartup: false);
            config.RegisterEntity<DeviceInfo>();
            
            config.OnInitialized = () =>
            {
                SApp.LogInfo("应用初始化完成");
            };
        });
    }

    public override void OnFrameworkInitializationCompleted()
    {
        if (ApplicationLifetime is IClassicDesktopStyleApplicationLifetime desktop)
        {
            desktop.MainWindow = new MainWindow();
            
            // 程序退出时清理资源
            desktop.ShutdownRequested += (s, e) =>
            {
                SApp.Cleanup();
            };
        }

        base.OnFrameworkInitializationCompleted();
    }
}

核心功能

✅ 自动集成

• ReactiveUI 配置
• Semi.Avalonia 主题加载

✅ 内置组件

• Logger 窗口（GzLoggerView）
• SQL Debug 窗口（GzSqlDebugView）

✅ 数据库管理

• 自动注册实体类型
• 自动初始化 DbContext
• 支持自定义实体注册

注意事项

1. 所有代码都在 App.axaml.cs 中完成：

   • SApp.Initialize() - 在 Initialize() 方法中调用
   • SApp.Cleanup() - 在 OnFrameworkInitializationCompleted() 的 ShutdownRequested 事件中调用
   • 无需在 MainWindow 或其他地方添加任何代码

2. GzLogConfig 自动注册：

   • 使用 UseBuiltInLogger() 时，GzLogConfig 实体会自动注册
   • 无需手动调用 RegisterEntity<GzLogConfig>()

3. 别名推荐：

   • 使用 using SApp = SuperSDK.App.SuperApp; 简化代码
   • 提高可读性和编码效率

更新日志

v1.1.1

• ✅ 初始版本发布
• ✅ 支持内置 Logger 和 SqlDebug
• ✅ 自动加载 Semi.Avalonia 主题