Roslyn 簡單實現程式碼智慧提示補全功能

lindexi發表於2024-08-18
ROS

相信有很多夥伴熱衷於編寫 IDE 應用，在 dotnet 系下，透過 Roslyn 友好的 API 和強大的能力，實現一個程式碼智慧提示是非常簡單的事情。本文將和大家簡單介紹一下如何使用 Roslyn 實現簡單的程式碼智慧提示補全功能

現在的 dotnet C# 核心構建工具鏈是非常完善的且開放的，基於 dotnet 完善的構建核心能力，咱可以非常方便的在此基礎之上構建咱的編譯器相關的應用

由於如何製作一個 IDE 應用是一個龐大的話題，本文僅僅只是和大家介紹如何使用 Roslyn 實現簡單的程式碼智慧提示補全功能。本文實現的示例程式碼是全控制檯的演示，沒有涉及任何介面邏輯，大家可以在本文末尾找到本文使用的程式碼的下載方法

本文屬於 Roslyn系列部落格，前置知識還請大家自行從 部落格導航 瞭解

先介紹一下本文預期實現的功能：當輸入 Cons 程式碼時，預期輸入 "Cons" 能夠得到 Console 等單詞的補全。當然了，在閱讀完成本文之後，相信大家也可以非常方便的換成自己的其他程式碼片段獲取其補全資訊

透過 Roslyn 實現智慧補全的核心是透過 Microsoft.CodeAnalysis.Completion.CompletionService 的 GetCompletionsAsync 方法獲取補全列表

本文提供的方法比 Roslyn如何實現簡單的程式碼提示 - JackWang-CUMT - 部落格園 部落格使用的方法更加具有程式碼通用性，可以實現近似於 VisualStudio 裡的智慧提升功能，甚至如果大家考慮自己編寫一點排序演算法，還可以做到近似於 ReSharper 的功能

以下是從從零開始編寫程式碼，先建立一個控制檯專案，我這裡建立的是 .NET 9 的控制檯專案。編輯 csproj 專案檔案為以下程式碼用於安裝必備的 NuGet 庫

<Project Sdk="Microsoft.NET.Sdk">

  <PropertyGroup>
    <OutputType>Exe</OutputType>
    <TargetFramework>net9.0</TargetFramework>
    <ImplicitUsings>enable</ImplicitUsings>
    <Nullable>enable</Nullable>
  </PropertyGroup>

  <ItemGroup>
    <PackageReference Include="Microsoft.CodeAnalysis.CSharp.Scripting" Version="4.9.2" />
    <PackageReference Include="Microsoft.CodeAnalysis.CSharp.Features" Version="4.9.2" />
    <PackageReference Include="Microsoft.CodeAnalysis.Workspaces.MSBuild" Version="4.9.2" />
  </ItemGroup>
</Project>

為了方後續程式碼的編寫方便，開啟 Program.cs 檔案，先新增一些名稱空間引用

using System.Diagnostics;

using Microsoft.CodeAnalysis;
using Microsoft.CodeAnalysis.Completion;
using Microsoft.CodeAnalysis.CSharp;
using Microsoft.CodeAnalysis.Host.Mef;
using Microsoft.CodeAnalysis.Text;

完成引用之後，接下來就是開始建立虛擬的解決方案 Solution 和專案了。建立虛擬的解決方案不是要大家真的去新建一個 sln 檔案，只需使用如下程式碼即可完成建立

var adhocWorkspace = new AdhocWorkspace(MefHostServices.DefaultHost);
Solution solution = adhocWorkspace.CurrentSolution;

當然了，此時的 Solution 裡面一個專案都沒有，需要咱開始建立一個虛擬的專案才能加入到 Solution 裡

建立專案時，重要的一點是加入引用程式集，引用程式集是非常重要的步驟。如果缺少這一步驟，將會導致找不到依賴，進而導致後續的智慧提示等邏輯失敗

本文這裡只是新增必備的引用程式集，程式碼如下

// 加上引用程式集，防止找不到引用
var referenceAssemblyPaths = new[]
{
    typeof(object).Assembly.Location,
    typeof(Console).Assembly.Location,
};

大家可以根據自己的實際需求選擇所新增的引用程式集。關於引用程式集等屬於 dotnet 基礎知識，還請自行參閱 dotnet 基礎知識

完成引用程式集收集之後，接下來就是透過 CSharpCompilationOptions 建立專案，程式碼如下

var csharpCompilationOptions = new CSharpCompilationOptions
(
    OutputKind.DynamicallyLinkedLibrary, // 輸出型別 dll 型別
    usings: new[] { "System" }, // 引用的名稱空間
    allowUnsafe: true, // 允許不安全程式碼
    sourceReferenceResolver: new SourceFileResolver
    (
        searchPaths: new[] { Environment.CurrentDirectory },
        baseDirectory: Environment.CurrentDirectory
    )
);

var project = ProjectInfo.Create(ProjectId.CreateNewId(), VersionStamp.Create(),
    name: "Lindexi",
    assemblyName: "Lindexi",
    language: csharpCompilationOptions.Language,
    metadataReferences: referenceAssemblyPaths.Select(t => MetadataReference.CreateFromFile(t)));

再將專案新增到 Solution 裡。由於 Roslyn 信奉的是不可變，呼叫了 AddProject 之後將會返回新的 Solution 物件，原有的 Solution 不被改變，因此需要重新賦值，程式碼如下

solution = solution.AddProject(project);

新建的專案裡面還沒有程式碼，咱繼續建立程式碼文件，程式碼如下

var documentInfo = DocumentInfo.Create(DocumentId.CreateNewId(project.Id), name: "LindexiCode", sourceCodeKind: SourceCodeKind.Script);

將文件直接新增到解決方案裡面，用於獲取從 DocumentInfo 獲取到 Microsoft.CodeAnalysis.Document 物件

solution = solution.AddDocument(documentInfo);

依然是不可變思想的寫法，呼叫 AddDocument 之後會返回新的 Solution 物件，需要重新賦值

加入到 Solution 之後，即可透過 GetDocument 獲取到 Document 物件用於後續分析

Document document = solution.GetDocument(documentInfo.Id)!;

接下來咱嘗試模擬輸入的程式碼，預期輸入 "Cons" 能夠得到 Console 補全

var text = "Cons";

將此模擬的程式碼放入到文件裡面，程式碼如下

Document textDocument = document.WithText(SourceText.From(text));

現在基於此文件，在分析器看來的程式碼大概如下

using System;

Cons

以上程式碼的 using System; 是在建立專案的 CSharpCompilationOptions 新增的預設引用

透過文件關聯關係獲取到程式碼補全服務，獲取方法如下

CompletionService completionService = CompletionService.GetService(document)!;
Debug.Assert(completionService != null);

現在此文件已經可以被 Roslyn 進行分析了，嘗試獲取補全列表，程式碼如下

CompletionList completionList = await completionService.GetCompletionsAsync(textDocument, caretPosition: text.Length);

以上就是本文的核心程式碼邏輯。接下來就是需要對補全列表進行排序，補全列表的內容如果太多且沒有排序的話，那開發者看著補全列表也不開森，以下是我使用簡單的排序方法進行排序，然後在控制檯輸出的程式碼

foreach (var completionItem in completionList.ItemsList
             .OrderBy(item => item.DisplayText.StartsWith(text) ? 0 : 1)
             .ThenByDescending(item => item.Rules.MatchPriority)
             .ThenBy(item => item.SortText))
{

    Console.WriteLine($"""
                       DisplayText:{completionItem.DisplayText}
                       SortText:{completionItem.SortText}
                       FilterText:{completionItem.FilterText}
                       MatchPriority:{completionItem.Rules.MatchPriority}
                       
                       """);
}

我先排序的是包含輸入的程式碼字元的，於是 Consistency 和 Console 就可以排在前面，接著再使用通用的 MatchPriority 和 SortText 加入到排序裡面

大概的輸出內容如下

DisplayText:Consistency
SortText:~Consistency  System.Runtime.ConstrainedExecution
FilterText:Consistency
MatchPriority:0

DisplayText:Console
SortText:~Console  System
FilterText:Console
MatchPriority:0

DisplayText:Console
SortText:~Console Internal
FilterText:Console
MatchPriority:0

...

透過 CompletionItem 可以獲取到補全的內容的很多資訊，包括這個提示是關鍵詞還是型別還是程式碼片等等

我感覺 ReSharper 的智慧提示比 VisualStudio 更好用的部分，不在於智慧提示的內容，而在於智慧提示的內容的排序上，經常我可以發現 ReSharper 將我需要的東西排在前面甚至第一個，然而 VisualStudio 經常將我不需要的內容放在前面。如果大家想要實現一個 IDE 應用，我感覺需要智慧提示和補全倒是問題不大，比較期望花精力的是在於智慧提示的內容的排序

以上就是本文演示的使用 CompletionService 提供的智慧補全功能，透過此功能可以輔助大家更加方便實現智慧程式碼補全和智慧提示功能

至於如何使用此能力去製作一個屬於自己的 IDE 那就需要大家自行編寫了

本文程式碼放在 github 和 gitee 上，可以使用如下命令列拉取程式碼。我整個程式碼倉庫比較龐大，使用以下命令列可以進行部分拉取，拉取速度比較快

先建立一個空資料夾，接著使用命令列 cd 命令進入此空資料夾，在命令列裡面輸入以下程式碼，即可獲取到本文的程式碼

git init
git remote add origin https://gitee.com/lindexi/lindexi_gd.git
git pull origin c5eebfd01f7b4c567c2719161b7513e2e7b6df06

以上使用的是國內的 gitee 的源，如果 gitee 不能訪問，請替換為 github 的源。請在命令列繼續輸入以下程式碼，將 gitee 源換成 github 源進行拉取程式碼。如果依然拉取不到程式碼，可以發郵件向我要程式碼

git remote remove origin
git remote add origin https://github.com/lindexi/lindexi_gd.git
git pull origin c5eebfd01f7b4c567c2719161b7513e2e7b6df06

獲取程式碼之後，進入 Workbench/WhinerfejuwhawHallkeferbai 資料夾，即可獲取到原始碼

更多 Roslyn 相關部落格，請參閱 部落格導航

相關文章