Einführung in das Visual Studio Extensibility SDK

Das neue Visual Studio Extensibility SDK basiert auf einer Brokerdiensteinfrastruktur, die in Visual Studio 2019 eingeführt wurde. Sie besteht in erster Linie aus:

  • Ein VisualStudioExtensibility ↗-Objekt, das als Einstiegspunkt für die Erweiterbarkeit-API fungiert. Dieses Objekt verfügt über Erweiterungsmethoden wie Views() oder Languages(), die Erweiterungspunkte der IDE bereitstellen.

  • Wrapper und Erweiterungsmethoden rund um vermittelte Dienste, die von der IServiceBroker ↗-Infrastruktur verfügbar gemacht werden, mit dem Ziel, Dienste einfach zu bedienen. In einigen Fällen sollten Erweiterungsmethoden die Vertragsschnittstelle direkt zurückgeben.

  • Basisklassen für Erweiterungsteile, Befehle und die Erweiterung selbst, die verwendet werden, um vermittelte Dienste von der Erweiterung zu Visual Studio-IDE verfügbar zu machen. Diese Dienste sind die primäre Methode, die Visual Studio für die Erweiterung aufruft.

  • Ein Codegeneratorframework zum Generieren einer .vsextension/extension.json Metadatendatei basierend auf Erweiterungsteilen und den zugehörigen Attributen. Diese Datei deklariert die Dienste, Erweiterungsteile und andere Dienste, die von der Erweiterung verfügbar gemacht werden.

NuGet-Pakete

Das neue Erweiterbarkeitsmodell für Visual Studio hängt von einer Reihe neuer NuGet-Pakete ab, um APIs, Buildtools, Codegenerierung und Analyzer bereitzustellen.

Microsoft.VisualStudio.Extensibility.Sdk

Link: Microsoft. VisualStudio.Extensibility.Sdk 17.xxxxx ↗

Dies ist das primäre Paket, das Abhängigkeiten zu allen erforderlichen Paketen enthält, die in den folgenden Abschnitten erwähnt werden. Wir empfehlen Erweiterungsentwicklern dringend, anstelle einzelner Verweise einen Verweis auf dieses Metapaket zu erhalten.

Microsoft.VisualStudio.Extensibility.Build

Link: Microsoft.VisualStudio.Extensibility.Build 17.xxxxx ↗

Dieses Paket enthält die Buildtools, Projektfunktionen-Codegeneratoren, die zum Erstellen der Erweiterung erforderlich sind, und damit es mit dem F5-Debuggen in der Visual Studio-IDE funktioniert.

Dependencies

Microsoft.VisualStudio.Extensibility

Dieses Paket enthält die SDK-APIs und Hilfsbibliotheken, um Erweiterungen mithilfe des Out-of-Process-Erweiterbarkeitsmodells zu entwickeln. Jede Erweiterung sollte einen Verweis auf dieses Paket als Ausgangspunkt enthalten.

Microsoft.VisualStudio.Extensibility.JsonGenerators.Sdk

Dieses Paket enthält die Codegeneratoren, die zum Generieren von Erweiterungsmetadaten während des Builds erforderlich sind. Ohne dieses Paket funktioniert eine kompilierte Erweiterung möglicherweise nicht ordnungsgemäß, da sie nicht die erforderlichen Metadatendateien enthält.

Optionale Pakete

In zukünftigen Vorschauen verfügen wir möglicherweise über NuGet-Pakete, die nicht als erforderliche Abhängigkeit vom Microsoft.VisualStudio.Extensibility.Sdk Paket enthalten sind, aber nach Bedarf hinzugefügt werden können, um APIs für bestimmte Featurebereiche wie Debugger, Quellcodeverwaltung bereitzustellen.