Roslyn 簡單實現代碼智能提示補全功能

相信有很多伙伴熱衷於編寫 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 相關博客，請參閱 博客導航

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

如圖片看不見，請在瀏覽器開啟不安全http內容相容