Praca z projektami VSIX

Projekty VSIX to standardowy sposób pakowania rozszerzeń Visual Studio do dystrybucji. Niezależnie od tego, czy tworzysz rozszerzenie VisualStudio.Extensibility, czy rozszerzenie oparte na zestawie VSSDK, wynikiem jest plik .vsix, który użytkownicy instalują za pośrednictwem Menedżera rozszerzeń lub witryny Visual Studio Marketplace.

Tworzenie projektu VSIX

Szablony projektów VSIX są dostępne w oknie dialogowym Tworzenie nowego projektu . Wyszukaj ciąg "VSIX", aby je znaleźć:

• Rozszerzenie VisualStudio.Extensibility — w przypadku rozszerzeń poza procesem przy użyciu nowego modelu rozszerzalności.
• VSIX Project — w przypadku rozszerzeń opartych na zestawie VSSDK lub pakowania wielu składników rozszerzenia.
• Rozszerzenie VisualStudio.Extensibility ze zgodnością zestawu VSSDK — w przypadku rozszerzeń hybrydowych korzystających z obu modeli.
• Pusty projekt VSIX — pusty kontener VSIX do tworzenia pakietów istniejących składników.

Rozszerzenia pakietu w projekcie VSIX

Istniejące rozszerzenie lub składnik można spakować, opakowując je w projekt VSIX:

1. Utwórz projekt VSIX przy użyciu dowolnego z powyższych szablonów.
2. Plik source.extension.vsixmanifest otwiera się w Manifest Designer.
3. Na karcie Elementy zawartości wybierz pozycję Nowe, aby dodać składniki.
4. Na liście Typ wybierz typ zasobu do dodania (na przykład Microsoft.VisualStudio.MefComponent, Microsoft.VisualStudio.VsPackage).
5. Ustaw pozycję Źródło na projekt W bieżącym rozwiązaniu i wybierz projekt.

Format VSIX obsługuje pakowanie pakietów VSPackages, składników MEF, zestawów, szablonów projektów, szablonów elementów, kontrolek przybornika i niestandardowych typów rozszerzeń.

Dodawanie zależności do pakietu VSIX

Możesz skonfigurować plik VSIX tak, aby wymagał innych rozszerzeń jako zależności. Po zainstalowaniu rozszerzenia przez użytkownika instalator sprawdza, czy istnieją wszystkie wymagane zależności.

Aby dodać zależność:

1. Otwórz source.extension.vsixmanifest w widoku Projekt.
2. Przejdź do karty Zależności i wybierz pozycję Nowy.
3. Wybierz pozycję Zainstalowane rozszerzenie , aby wybrać zależność od już zainstalowanych rozszerzeń lub Plik w systemie plików , aby bezpośrednio odwołać się do innego pliku VSIX.

Wymaganie określonej wersji Visual Studio

Aby określić minimalny numer kompilacji Visual Studio, ustaw InstallationTarget zakres wersji:

<Installation>
  <InstallationTarget Id="Microsoft.VisualStudio.Community" Version="[17.0,)" />
</Installation>

Tworzenie pakietu rozszerzeń

Pakiet rozszerzeń to zestaw rozszerzeń, które można zainstalować razem. Pakiety rozszerzeń umożliwiają udostępnianie ulubionych rozszerzeń współpracownikom lub utworzenie pakietu z zestawu rozszerzeń dla scenariusza.

Aby utworzyć pakiet rozszerzeń:

1. Utwórz nowy projekt VSIX.
2. Kliknij prawym przyciskiem myszy projekt w Eksploratorze rozwiązań i wybierz polecenie Dodaj>nowy element.
3. Wybierz szablon Pakiet rozszerzeń . Spowoduje to dodanie pliku .vsext.
4. Edytuj plik .vsext, aby wyświetlić rozszerzenia do uwzględnienia:

{
  "id": "MyExtensionPack",
  "name": "My Extension Pack",
  "description": "A curated set of extensions for my team",
  "version": "1.0.0.0",
  "extensions": [
    {
      "vsixId": "41858b2d-ff0b-4a43-80b0-f1b2d6084935",
      "name": "AlignAssignments"
    },
    {
      "vsixId": "42374550-426a-400e-96f9-237682e8dea6",
      "name": "CopyAsHtml"
    }
  ]
}

5. Znajdź vsixId w witrynie Visual Studio Marketplace ↗ — otwórz stronę rozszerzenia i wybierz pozycję Kopiuj identyfikator.
6. Skompiluj i opublikuj projekt. Zobacz Publikowanie w Marketplace.

Omówienie architektury rozszerzeń

Zrozumienie, w jaki sposób Visual Studio ładuje Twoje rozszerzenie, pomaga podejmować lepsze decyzje dotyczące pakietowania i wdrażania.

VisualStudio.Extensibility (poza procesem)

Rozszerzenia działające poza procesem macierzystym są uruchamiane w oddzielnym procesie niż Visual Studio i komunikują się przez kanał JSON-RPC:

┌─────────────────────┐       JSON-RPC        ┌──────────────────────┐
│   Visual Studio     │◄─────────────────────►│  Extension Process   │
│   (DevEnv.exe)      │                        │  (.NET 8+)           │
│                     │                        │                      │
│  ┌───────────────┐  │                        │  ┌────────────────┐  │
│  │ Extension Host│  │                        │  │ Your Extension │  │
│  │ (manages      │  │                        │  │ Code           │  │
│  │  lifecycle)   │  │                        │  └────────────────┘  │
│  └───────────────┘  │                        └──────────────────────┘
└─────────────────────┘

Kluczowe cechy:

• Rozszerzenie działa na nowoczesnym środowisku .NET (8+)
• Awarie procesu rozszerzenia rzadziej powodują awarię programu Visual Studio
• Instalowanie/odinstalowywanie bez ponownego uruchamiania VS
• Instalacja dla użytkownika (bez uprawnień administratora)

VSSDK / hybryda (w procesie)

Rozszerzenia działające w procesie są ładowane bezpośrednio do procesu Visual Studio:

┌──────────────────────────────────────────┐
│   Visual Studio (DevEnv.exe)             │
│                                          │
│  ┌────────────────┐  ┌────────────────┐  │
│  │ VS Core        │  │ Your Extension │  │
│  │ Services       │◄─┤ (.NET Framework│  │
│  │                │  │  or hybrid)    │  │
│  └────────────────┘  └────────────────┘  │
└──────────────────────────────────────────┘

Kluczowe cechy:

• Pełny dostęp do wszystkich interfejsów API i usług VS
• Ograniczone do .NET Framework (chyba że jest hybrydowe)
• Błędy rozszerzeń mogą wpływać na stabilność programu Visual Studio
• Wymaga ponownego uruchomienia programu VS podczas instalacji/aktualizacji

Co znajduje się w pakiecie vsix

Plik .vsix jest archiwum ZIP ze standardową strukturą. Zawartość różni się w zależności od modelu rozszerzenia:

Treści powiązane

• Publikuj w Marketplace
• Podpisywanie pakietów VSIX