Wählen Sie das richtige Visual-Studio-Erweiterbarkeitsmodell.

Visual Studio bietet zwei Erweiterbarkeitsmodelle: VisualStudio.Extensibility und das Visual Studio SDK (VSSDK). Verwenden Sie dieses Handbuch, um das richtige Modell für Ihr Szenario auszuwählen oder beide SDKs bei Bedarf in einer Hybriderweiterung zu kombinieren.

Recommendation

Beginnen Sie mit VisualStudio.Extensibility. Es ist die primäre Empfehlung für neue Erweiterungen, da sie moderne .NET unterstützt, eine Out-of-Process-Architektur für eine bessere Zuverlässigkeit verwendet und die einfachste Möglichkeit bietet, loszulegen. Wenn Sie später APIs benötigen, die noch nicht verfügbar sind, können Sie zu Prozessinterne (Hybrid-)Erweiterungen wechseln, wobei Sie VisualStudio.Extensibility weiterhin als Grundlage beibehalten.

Note

Betrachten Sie diese Modelle nicht als „neu vs. alt“. Sie sind beide gültige Ansätze für verschiedene Szenarien heute.

Important

Wenn Ihre Erweiterung modernes .NET (z. B. .NET 8 oder höher) verwenden muss, müssen Sie eine prozessexterne Erweiterung nutzen. In-Process-Erweiterungen (VSSDK) sind auf .NET Framework beschränkt. Wählen Sie VisualStudio.Extensibility und seine Out-of-Process-Architektur aus, um vollständigen Zugriff auf das moderne .NET Ökosystem zu erhalten.

Die Modelle auf einen Blick

VisualStudio.Extensibility (prozessextern) VSSDK
Laufzeit Moderne .NET .NET Framework
Hosting Getrennter Prozess Visual Studio-Prozess
API-Muster Asynchrone APIs und Konfiguration per Code COM, verwaltete Dienste, MEF und Befehlstabellen
Szenarioabdeckung Wachsende API-Oberfläche Breiterer Zugriff auf prozessinterne Funktionen
Installation Unterstützt die Installation ohne Visual Studio neu zu starten Erfordert einen Neustart von Visual Studio
Visual Studio-Versionen Visual Studio 2022 und höher Umfasst Unterstützung für Visual Studio 2019 und frühere Versionen

Hybriderweiterungen verwenden prozessintern VisualStudio.Extensibility-APIs neben dem VSSDK. Sie behalten die In-Process-Hosting- und .NET Framework-Anforderungen bei.

VisualStudio.Extensibility

VisualStudio.Extensibility ist das moderne Erweiterbarkeitsmodell, bei dem Erweiterungen außerhalb des Visual-Studio-Hauptprozesses ausgeführt werden. Diese Architekturverschiebung ermöglicht Folgendes:

  • Modern .NET – .NET 8+ als Ziel verwenden und das vollständige Ökosystem nutzen
  • Prozessisolation – reduziert das Risiko von Erweiterungsfehlern, die Visual Studio zum Absturz bringen
  • Installationen ohne Neustart – Benutzer können Erweiterungen installieren, ohne die IDE neu zu starten
  • Einfache, konsistente APIs – IntelliSense-gesteuerte Entwicklung mit asynchronen Mustern

Wenn Sie später APIs benötigen, die noch nicht außerhalb des Prozesses verfügbar sind, können Sie Ihre Erweiterung im Prozess ausführen und dabei weiterhin die VisualStudio.Extensibility-API-Oberfläche verwenden.

VSSDK

VSSDK ↗ (Visual Studio SDK) ist das Modell, auf dem die meisten Erweiterungen auf dem Visual Studio Marketplace ↗ basieren. Es ist das umfassendste und leistungsstärkste Modell, aber auch das komplexeste, was das Erlernen und die korrekte Anwendung betrifft. Erweiterungen werden im gleichen Prozess wie Visual Studio ausgeführt, was bedeutet, dass sie auf .NET Framework beschränkt sind und die IDE möglicherweise zum Absturz bringen oder zum Hängen bringen können.

Tip

Vollständige VSSDK-Dokumentation, einschließlich API-Referenzen, exemplarische Vorgehensweisen und Beispiele, finden Sie in der dokumentation zum Visual Studio SDK ↗.

Note

Das Community Toolkit ↗ ist eine optionale, von der Community gepflegte Hilfsbibliothek für VSSDK. Es ist kein separates Erweiterbarkeitsmodell und ändert die Laufzeit-, Hosting- oder Threadinganforderungen von VSSDK nicht.

Tip

Einen technischen Vergleich der beiden SDKs, einschließlich Codebeispielen, Threadinganalyse und architektonischer Kompromisse, finden Sie unter Detaillierter Vergleich der Erweiterungsmodelle.

Häufige Szenarien

Ich bin neu in der Visual-Studio-Erweiterungsentwicklung

Verwenden Sie VisualStudio.Extensibility. Es bietet die einfachste Onboarding-Erfahrung und produziert standardmäßig qualitativ hochwertige Erweiterungen.

Ich benötige APIs, die VisualStudio.Extensibility noch nicht unterstützt

Verwenden Sie den Hybridansatz – erstellen Sie eine VisualStudio.Extensibility-Erweiterung, die im Prozess ausgeführt wird und Ihnen Zugriff auf VSSDK-APIs zusammen mit der modernen API-Oberfläche bietet.

Ich muss Unterstützung für Visual Studio 2019 und ältere Versionen bieten.

Verwenden Sie VSSDK. VisualStudio.Extensibility unterstützt nur Visual Studio 2022 und höher.

Ich habe eine vorhandene Erweiterung, die ich migrieren möchte

Dies hängt von den Supportanforderungen für Ihre Version ab:

  • VS 2022+ nur: Schreiben Sie es in VisualStudio.Extensibility um, oder verwenden Sie den Hybridmodus , wenn Sie VSSDK-APIs benötigen, die noch keine Entsprechungen besitzen.
  • Unterstützung für mehrere Versionen: Gestalten Sie freigegebene Logik in eine gemeinsame Bibliothek um, erstellen Sie dann separate VSIX-Projekte für jedes Ziel (VSSDK für VS 2019, VisualStudio.Extensibility für VS 2022+). Eine ausführliche Schritt-für-Schritt-Anleitung finden Sie unter Migrieren von VSSDK.

Szenarien, für die VSSDK erforderlich ist

VisualStudio.Extensibility entwickelt sich aktiv weiter, einige Szenarien werden jedoch noch nicht prozessextern unterstützt. Verwenden Sie dazu den Hybridansatz oder das reine VSSDK:

Scenario VisualStudio.Extensibility VSSDK / Hybrid
Befehle, Menüs, Symbolleisten ✅ ✅
Toolfenster ✅ ✅
Editorränder, Taggers, CodeLens ✅ ✅
Language Server Protocol (LSP) ✅ ✅
Debuggervisualisierungen ✅ ✅
Einstellungen und Optionen ✅ ✅
Benutzerdefinierte Editoren (Designeroberflächen) ❌ ✅
IntelliSense-Anbieter ❌ ✅
Glühbirnenaktionen (Codefixes) ❌ ✅
Benutzerdefinierte Projektsysteme ❌ ✅
Erstellen der Systemintegration ❌ ✅
Benutzerdefinierte Debugger-Engines ❌ ✅
Anbieter der Quellcodeverwaltung ❌ ✅

Tip

Wenn Ihre Erweiterung ein oben mit ❌ gekennzeichnetes Szenario benötigt, erstellen Sie eine hybride Erweiterung mithilfe der Vorlage „VisualStudio.Extensibility Extension with VSSDK Compatibility“. Auf diese Weise können Sie VisualStudio.Extensibility für unterstützte Features verwenden, während Sie für den Rest im Prozess auf VSSDK-APIs zugreifen. Weitere Informationen finden Sie unter Prozessinterne Erweiterungen.

Nächste Schritte