dotnet 使用增量源代碼生成技術的 Telescope 庫導出程式集類型

本文將告訴大家在 dotnet 裡面使用免費完全開源的基於增量源代碼生成技術的 Telescope 庫，進行收集導出項目程式集裡面指定類型。可以實現性能極高的指定類型收集，方便多模塊對接入自己的業務框架

此 Telescope 庫是基於最友好的 MIT 協議開源的，免費開源可商用：https://github.com/dotnet-campus/SourceFusion

在日常開發過程中，也許會有這樣的需求：將項目程式集裡面的某種特征的類型們收集起來，用於實現自己的業務需求。比如說自己寫了某些工作器，這些工作器類型都是繼承 IWorker 介面的，此時業務上期望有某個邏輯可以將其收集導出，方便對接到自己業務上的框架

或者是自己寫了某些過程過濾器類型，這些過濾器類型都繼承 IFilter 介面，期望能夠從項目裡面導出收集，方便接入 IoC 容器或者是自動註入到過濾框架裡面

此時可選的實現方法是通過反射，找到程式集裡面滿足條件的類型，對齊進行處理。然而反射的性能是不高的，再加上需要掃描一次程式集，性能就更低了。同時掃描程式集可能導致在啟動過程中存在性能問題，比如掃描程式集導致更多依賴程式集被立刻載入，從而降低啟動性能

本文將和大家介紹的是我所在的 dotnet 職業技術學苑（dotnet campus）組織開源的 Telescope 庫。此 Telescope 庫原本就是一個預編譯庫，在源代碼生成技術 SourceGenerator 推出之前早已有此功能。有一個小道消息是 dotnet 的源代碼生成技術有部分可能也受到到此庫的啟發（我臉皮是不是有點厚）哈

在 dotnet 推出了 IIncrementalGenerator 增量 Source Generator 源代碼生成技術之後，我也對 Telescope 庫進行稍微的更改，推出了基於增量源代碼生成技術的版本，下麵來看看此庫的使用方法和功能

按照 dotnet 慣例，先安裝 NuGet 庫。可以右擊項目管理 NuGet 包安裝 dotnetCampus.Telescope.SourceGeneratorAnalyzers 庫，也可以編輯 csproj 項目文件添加以下代碼安裝

<PackageReference Include="dotnetCampus.Telescope.SourceGeneratorAnalyzers" Version="0.10.7-alpha17">
  <PrivateAssets>all</PrivateAssets>
  <IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
</PackageReference>

這裡需要提到的是 Telescope 的基於增量源代碼生成技術的版本是完全的開發者工具側的庫，完全是修改源代碼而不需要引入額外的庫。換句話說就是使用 Telescope 庫可以在發佈自己的項目的時候，可以不會有額外的 DLL 引入。這對於許多商用項目都是非常棒的，不會讓自己的輸出被污染，不會讓自己的安裝包裡面包含了其他組織製作的庫

當然了，需要再次提醒一下，這個 Telescope 是基於免費的 MIT 協議的，完全可以商用的，無任何糾紛問題，可以放心使用

完成了基礎庫的安裝之後，接下來就來編寫演示的代碼了。假定項目程式集裡面有如下的一些類型，比如名為 Base 的基礎類型，以及名為 FooAttribute 的特性。接下來的任務就是找到程式集裡面所有繼承 Base 基礎類型且標記了 FooAttribute 特性的類型

大家可以假想一下，在自己的項目裡面，那些需要反射掃描整個項目程式集才能實現的代碼，看看能否套用到這裡。如果可以的話，那推薦來試試這個 Telescope 庫，看能否給你的項目提升一些性能

class Base
{
}

class FooAttribute : Attribute
{
}

為了方便演示，這裡再創建兩個類型，用來繼承 Base 基礎類型且標記了 FooAttribute 特性

[FooAttribute]
class F1 : Base
{
}

[FooAttribute]
class F2 : Base
{
}

現在咱的任務是收集項目程式集定義的繼承 Base 基礎類型且標記了 FooAttribute 特性的類型，如以上的 F1 和 F2 類型

請看一下使用 Telescope 的收集方式的代碼

internal partial class Program
{
    static void Main(string[] args)
    {
        foreach (var (type, attribute, creator) in ExportFooEnumerable())
        {
        }
    }

    [dotnetCampus.Telescope.TelescopeExportAttribute()]
    private static partial IEnumerable<(Type type, FooAttribute attribute, Func<Base> creator)> ExportFooEnumerable();
}

可以看到用法非常簡單，只需要一個分部方法，在方法上標記了 TelescopeExportAttribute 特性即可，沒有其他多餘的侵入代碼

可以看到這裡的導出代碼是通過 partial 的方式實現源代碼生成對接的，只需要編寫一個 partial 類型，在這個 partial 類型裡面包含一個 partial 的方法，要求這個方法有滿足條件的導出返回值，再給方法標記特性，即可自動生成導出類型的代碼

如以上的代碼即可在 Main 裡面的遍歷找到了 F1 和 F2 兩個類型

更具體的用法要求是標記了 TelescopeExportAttribute 特性的方法的返回值有一定的要求。如要求使用的是 IEnumerable 等類型，且裡面使用 ValueTuple 方式。這個 ValueTuple 的形式大概固定，格式如下

(Type type, FooAttribute attribute, Func<Base> creator)

首個參數將會返回收集的類型的 Type 值，比如收集到 F1 那將會是 typeof(F1) 的類型。第二個參數表示要求類型繼續標記的特性，如此即可讓代碼可以有更好的控制。第三個參數是 Func<T> 這裡的 T 是表示要求收集的類型必須繼承的基類型，可以是類型或介面

導出類型的方法名沒有要求，方法的修飾也沒有要求，也就是可以是 private 也可以是 public 的等等，可以是靜態的也可以是非靜態的

通過以上的方式即可在增量源代碼生成裡面生成出自動收集類型的代碼，可以規避使用反射帶來的性能損耗，同時也能更好的支持 AOT 打包

除此之外還有許多高級的功能，比如說收集的類型不限於當前項目程式集，也能收集到當前項目的所有依賴項。如果想要收集到依賴程式集裡面的類型，可以在 TelescopeExportAttribute 裡面加上對 IncludeReferences 屬性的設置即可，如以下代碼

internal partial class Program
{
    [dotnetCampus.Telescope.TelescopeExportAttribute(IncludeReferences = true)]
    private static partial IEnumerable<(Type type, FooAttribute attribute, Func<Base> creator)> ExportFooEnumerable();
}

加上了 IncludeReferences 將會自動收集到滿足要求的所有類型，包括當前項目引用的程式集。但必須說明的是加上了 IncludeReferences 屬性設置為 true 將會在 Telescope 里收集引用的程式集類型，可能導致開發過程中的卡頓，但也只會影響開發，不會影響到程式運行

更多關於我博客請參閱 博客導航

博客園博客只做備份，博客發佈就不再更新，如果想看最新博客，請到 https://blog.lindexi.com/