[Unity 3D] 为编辑器插件引入基于 Git Tag 的版本管理功能

FeastSC · 发表于 2022-11-30 08:02

在本文，笔者将带领大家学习一下，如何为自己写的插件引入版本管理功能。

前言：

受 HybridCLR walon 大侠邀约，为其 HybridCLR 安装器接入版本选择功能，想着名利双收(够吹好一阵了)还能逼迫自己走出舒适区学点新知识（git相关），于是便接下了这个橄榄枝。
需求：

实现基于 tag 的版本选择功能：

实现上面的功能得进行一些与 git 操作相关的知识储备：

闲话少叙，接下来笔者以代码的形式汇总一下上面提到的疑难点吧~
实现：

1. 使用 BashUtil.cs 实现 git-bash 的调用

该组件用于调用 git-bash 程序完成对 git 仓库的所有操作。
using System.Diagnostics;using System.IO;using System.Linq;using UnityEditor;namespace HybridCLR.Editor.Installer{ public static class BashUtil {// 执行指定的程序并以 exitcode 返回执行结果 public static int RunCommand(string workingDir, string program, string[] args, bool log = true) { using (Process p = new Process()) { p.StartInfo.WorkingDirectory = workingDir; p.StartInfo.FileName = program; p.StartInfo.UseShellExecute = false; p.StartInfo.CreateNoWindow = true; string argsStr = string.Join(" ", args.Select(arg => "\"" + arg + "\"")); p.StartInfo.Arguments = argsStr; if (log) { UnityEngine.Debug.Log($"[BashUtil] run => {program} {argsStr}"); } p.Start(); p.WaitForExit(); return p.ExitCode; } }// 执行指定的程序并将（ exitcode + 标准输出 +错误输出）放到 c# 元组（tuple）作为返回值告知执行结果 public static (int ExitCode, string StdOut, string StdErr) RunCommand2(string workingDir, string program, string[] args, bool log = true) { using (Process p = new Process()) { p.StartInfo.WorkingDirectory = workingDir; p.StartInfo.FileName = program; p.StartInfo.UseShellExecute = false; p.StartInfo.CreateNoWindow = true; p.StartInfo.RedirectStandardOutput = true; p.StartInfo.RedirectStandardError = true; string argsStr = string.Join(" ", args.Select(arg => "\"" + arg + "\"")); p.StartInfo.Arguments = argsStr; if (log) { UnityEngine.Debug.Log($"[BashUtil] run => {program} {argsStr}"); } p.Start(); p.WaitForExit(); string stdOut = p.StandardOutput.ReadToEnd(); string stdErr = p.StandardError.ReadToEnd(); return (p.ExitCode, stdOut, stdErr); } }// 查询是否有安装 git-bash 执行程序 public static bool ExistProgram(string prog) {#if UNITY_EDITOR_WIN return RunCommand(".", "where", new string[] { prog }) == 0;#elif UNITY_EDITOR_OSX || UNITY_EDITOR_LINUX return RunCommand(".", "which", new string[] {prog}) == 0;#endif } }}2. 撰写 VersionResolver.cs

该脚本实现对 git 仓库的初始化及 tag 解析、仓库检出等功能，下面摘抄部分核心功能：

仓库初始化 + 最简化获取所有 tags 信息

public int InitRepository() { string repo_url = GetRepositoryUrl(); var dirInfo = new DirectoryInfo(path); if (!dirInfo.Exists || !IsGitRepository(path)) { dirInfo.Create(); //init git BashUtil.RunCommand(path, "git", new string[] { "init" }, false); // add remote origin BashUtil.RunCommand(path, "git", new string[] { "remote", "add", "origin", repo_url }, false); } //Fast fetch repo to get refs var value = BashUtil.RunCommand2(path, "git", new string[] { "fetch", "--depth=1", "-fq", "--prune", "origin", "refs/tags/*:refs/tags/*", "+refs/heads/*:refs/remotes/origin/*" }, false); if (value.ExitCode != 0) { Debug.LogError($"{nameof(VersionResolver)} - {repository} - {value.StdErr}"); } return value.ExitCode; }

获取本地检出的 tag 信息
hybridclr tag 格式为：v1.0.0-rc 、il2cpp_plus tag 格式为：v2021-1.0.0-rc

// 获取仓库所有 tag 信息（先执行 Fetch 以确保 tags 为远程最新） public string GetRepositoryLocalVersion() { var ret = BashUtil.RunCommand2(path, "git", new string[] { "tag", "--points-at", "HEAD" }, false); if (ret.ExitCode == 0) { var tags = ret.StdOut.Split(new char[] { '\n' }, StringSplitOptions.RemoveEmptyEntries); if (tags.Length > 1) { Debug.LogError($"{nameof(VersionResolver)}: {repository} has multiple tags: {string.Join(" , ", tags)}"); } if (tags.Length == 0) { Debug.LogWarning($"{nameof(VersionResolver)}: {repository} HEAD has no tag"); return NONEINFO; } return tags[0]; } return ERRORGITINFO; }

获取降序排列后的远程 tag 信息

public string[] GetRepositoryRemoteVersion() { var ret = BashUtil.RunCommand2(path, "git", new string[] { "tag" }, false); var tags = ret.StdOut.Split(new char[] { '\n' }, StringSplitOptions.RemoveEmptyEntries); // 使用 semver 的版本排序 Array.Sort(tags, (a, b) => SemverCompare(a, b)); return tags; } // v2021-1.10.1-rc-dhe // 将 tag 解析为 semver 格式的版本信息 public Version ResolveVersionFromTag(string tag) { var pattern = string.IsNullOrEmpty(branch) ? @"v(\d+)\.(\d+)\.(\d+)" : @"-(\d+)\.(\d+)\.(\d+)"; var match = Regex.Match(tag, pattern); if (match.Success) { var major = int.Parse(match.Groups[1].Value); var minor = int.Parse(match.Groups[2].Value); var patch = int.Parse(match.Groups[3].Value); return new Version(major, minor, patch); } else { throw new Exception($"tag = {tag} 格式不正确，约定 tag 格式为：v1.0.0-rc 或者 v2020-1.0.0-rc "); } }// 对版本进行降序排列 private int SemverCompare(string a, string b) { Version va = ResolveVersionFromTag(a); Version vb = ResolveVersionFromTag(b); return vb.CompareTo(va); }

获取git仓库的 remote url

/// <summary> /// 获取仓库中记录的 origin remote url 信息 /// </summary> private string GetRepositoryOriginUrl() { var result = BashUtil.RunCommand2(path, "git", new string[] { "remote", "get-url", "origin" }, false); return result.StdOut.Trim(); }

拉取远程仓库所有 tags 信息

public async Task FetchRepositoryDataAsync() { hasInit = false; ReloadRepositoryIfNeeded(); // 如果 remote url 被修改则删除并重建 git仓库 await Task.Run(InitRepository); // 初始化仓库，在此步中拉取远程所有 tag 信息 current = selected = GetRepositoryLocalVersion(); // 获取本地 tag 信息 tags = GetRepositoryRemoteVersion(); //获取排序后的所有 tag 信息 if (!string.IsNullOrEmpty(branch))//过滤前缀，前缀约定为 Unity 版本 { tags = tags.Where(v => v.StartsWith($"v{branch}")).ToArray(); } index = Array.IndexOf(tags, selected); // 当仓库未checkout任何tag时，赋初始值为本地最新版tag，如果没有tag，则赋值为 NONEINFO // 每次 checkout tag 时，都会更新 selected 为第一个。 if (index != 0) { index = 0; if (tags.Length == 0) { var defaultOne = current != "" && current != ERRORGITINFO ? current : NONEINFO; tags = new string[] { defaultOne }; } selected = tags[0]; } hasInit = true; Loom.Post(() => window?.Repaint()); // 使用 Loom 投递窗口重绘请求 }3. 撰写 Loom.cs

该脚本实现了非主线程对主线程类型的访问，主要用户在非主线程中通知窗口完成重绘。
（git 仓库的操作涉及到网络请求故而引入的基于 Task 的异步操作）
using System;using System.Collections.Concurrent;using System.Threading;using UnityEditor;using UnityEngine;namespace HybridCLR.Editor{ /// <summary> /// 线程间通信，仅供 Editor 使用 /// </summary> public static class Loom { static SynchronizationContext context; static readonly ConcurrentQueue<Action> tasks = new ConcurrentQueue<Action>(); //5. 确保编辑器下推送的事件也能被执行 [InitializeOnLoadMethod] static void EditorForceUpdate() { context = SynchronizationContext.Current; EditorApplication.update -= ForceEditorPlayerLoopUpdate; EditorApplication.update += ForceEditorPlayerLoopUpdate; void ForceEditorPlayerLoopUpdate() { if (EditorApplication.isCompiling || EditorApplication.isUpdating) { // Not in Edit mode, don't interfere return; } Update(); } } // 将需要在主线程中执行的委托传递进来 public static void Post(Action task) { if (SynchronizationContext.Current == context) { task?.Invoke(); } else { tasks.Enqueue(task); } } static void Update() { while (tasks.TryDequeue(out var task)) { try { task?.Invoke(); } catch (Exception e) { Debug.Log($"{nameof(Loom)}: 封送的任务执行过程中发现异常，请确认: {e}"); } } } }}4. UX 的工作流实现以及 IMGUI 的绘制

反正就是不停打磨，发现痛点，自提需求，完善细节。进而实现用户可以按常规软件的使用惯性平滑过渡以便接受这个版本选择功能，保证按用户可以按直觉交互。
代码略，更多实现细节可见：InstallerWindow.cs
写到最后

扩展阅读：

		自动登录	找回密码
密码			立即注册

[Unity 3D] 为编辑器插件引入基于 Git Tag 的版本管理功能

本帖子中包含更多资源