NuGetForUnity插件开发指南：从入门到实践

倪燃喆Queenie

于 2025-06-10 09:19:41 发布

阅读量363

点赞数 3

CC 4.0 BY-SA版权

本文链接：https://blog.youkuaiyun.com/gitblog_00821/article/details/148552714

NuGetForUnity插件开发指南：从入门到实践

NuGetForUnity A NuGet Package Manager for Unity 项目地址: https://gitcode.com/gh_mirrors/nu/NuGetForUnity

前言

NuGetForUnity作为Unity项目中的NuGet包管理工具，其插件系统为开发者提供了强大的扩展能力。本文将深入解析如何开发NuGetForUnity插件，帮助开发者理解插件架构设计原理并掌握实际开发技巧。

插件开发基础准备

1. 项目创建规范

插件开发的第一步是建立正确的项目结构：

命名规范：插件项目名称应采用<PluginName>.NugetForUnityPlugin格式，这是插件加载器的识别规则
目标框架选择：
- 针对Unity 2021.3以下版本：创建.netstandard2.0类库
- 针对Unity 2021.3及以上版本：创建.netstandard2.1类库

2. 必要依赖配置

核心依赖：必须引用NuGetForUnity.PluginAPI包，该包包含插件开发所需的核心接口
Unity相关依赖：根据插件功能需求，可能需要引用Unity安装目录下的UnityEngine.dll和UnityEditor.dll

核心接口实现

INugetPlugin接口

这是所有插件的入口接口，开发者需要实现其Register方法。该方法接收INugetPluginRegistry参数，用于注册各类功能处理器。

关键注意事项：

public class MyNugetPlugin : INugetPlugin
{
    public void Register(INugetPluginRegistry registry)
    {
        // 在这里注册各种处理器
    }
}

运行时环境判断

通过IsRunningInUnity属性可以判断当前运行环境：

在Unity编辑器内运行时为true
在命令行环境下运行时为false

日志记录规范

应使用PluginService提供的日志方法而非Unity原生日志：

LogError：记录错误信息
LogErrorFormat：格式化错误日志
LogVerbose：详细日志

核心扩展点详解

1. 自定义包操作按钮

实现IPackageButtonsHandler接口可在包管理界面添加自定义按钮：

public class MyButtonHandler : IPackageButtonsHandler
{
    public void DrawButtons(INugetPackage package, INugetPackage? installedPackage, bool existsInUnity)
    {
        if (GUILayout.Button("自定义操作"))
        {
            // 按钮点击处理逻辑
        }
    }
}

注册时需注意环境判断：

if (registry.IsRunningInUnity)
{
    registry.RegisterPackageButtonDrawer(new MyButtonHandler());
}

2. 自定义包安装处理

通过IPackageInstallFileHandler可自定义文件安装逻辑：

public class MyInstallHandler : IPackageInstallFileHandler
{
    public bool HandleFileExtraction(INugetPackage package, ZipArchiveEntry entry, string extractDirectory)
    {
        if (entry.FullName.EndsWith(".myext"))
        {
            // 自定义处理逻辑
            return true; // 表示已处理，阻止默认安装
        }
        return false; // 继续默认安装
    }
}

3. 自定义包卸载处理

IPackageUninstallHandler接口提供两种卸载场景处理：

public class MyUninstallHandler : IPackageUninstallHandler
{
    public void HandleUninstall(INugetPackage package, PackageUninstallReason reason)
    {
        // 单个包卸载处理
    }

    public void HandleUninstalledAll()
    {
        // 全部包卸载处理
    }
}

卸载原因枚举说明：