Udostępnij za pośrednictwem

Debugowanie rozszerzeń dla narzędzi SharePoint w Visual Studio

  • Artykuł

Można debugować rozszerzenia narzędzi programu SharePoint w wystąpieniu doświadczalnym lub regularnych wystąpieniach programu Visual Studio.Jeśli potrzebujesz rozwiązać problem zachowania rozszerzenia, można także modyfikować wartości rejestru, aby wyświetlić dodatkowe informacje o błędzie i skonfigurować sposób, w jaki Visual Studio wykonuje polecenia programu SharePoint.

Debugowanie rozszerzeń w doświadczalnym wystąpieniu programu Visual Studio

Aby zapewnić ochronę środowiska programowania Visual Studio przed przypadkowym uszkodzeniem przez niesprawdzonym rozszerzeniem program Visual Studio SDK zawiera alternatywne wystąpienie Visual Studio o nazwie Doświadczalne wystąpienie, której można zainstalować i przetestować rozszerzenia.Opracowujesz regularne rozszerzenia za pomocą regularnego wystąpienia programu Visual Studio, ale debugujesz i uruchamiasz je w wystąpieniach doświadczalnych.Aby uzyskać więcej informacji, zobacz Doświadczalne wystąpienia programu Visual Studio.

Jeśli używasz projektu VSIX do wdrożenia własnego rozszerzenia, a projekt VSIX jest projektem startowym w rozwiązaniu, Visual Studio automatycznie instaluje i uruchamia rozszerzenie w wystąpieniu eksperymentalnym podczas debugowania rozwiązania.Projekt startowy jest projektem, który rozpoczyna się podczas debugowania rozwiązania, które zawiera wiele projektów.Aby uzyskać więcej informacji dotyczących używania projektu VSIX do wdrażania rozszerzenia, zobacz Wdrażanie rozszerzeń dla narzędzi SharePoint w Visual Studio.Aby uzyskać więcej informacji na temat projektów startowych, zobacz Porady: ustawianie projektów startowych.

Aby uzyskać przykłady ilustrujące sposób debugowania różnego rodzaju rozszerzeń w doświadczalnym wystąpieniu programu Visual Studio, zobacz następujące instruktaże:

Debugowanie rozszerzeń w normalnym wystąpieniu programu Visual Studio

Jeśli chcesz debugować rozszerzenie projektu w regularnym wystąpieniu programu Visual Studio, należy najpierw zainstalować rozszerzenia w regularnym wystąpieniu.Następnie należy uruchomić debugera do drugiego procesu programu Visual Studio.Po zakończeniu można usunąć rozszerzenie tak, że już nie ładuje się na komputerze programisty.

Aby zainstalować rozszerzenie

  1. Zamknij wszystkie wystąpienia programu Visual Studio.

  2. W folderze danych wyjściowych kompilacji dla projektu rozszerzenia, otwórz plik .vsix, klikając go dwukrotnie lub otwierając menu skrótów, a następnie wybierając Otwórz:

  3. W oknie dialogowym Instalator rozszerzenia programu Visual Studio wybierz wydanie programu Visual Studio, do którego chcesz zainstalować rozszerzenie, a następnie wybierz przycisk Zainstaluj.

    Program Visual Studio instaluje pliki rozszerzenia do %UserProfile%\AppData\Local\Microsoft\VisualStudio\11.0\Extensions\author name\extension name\version.Ostatnie trzy foldery w tej ścieżce są wykonane z Author, Name, i Version elementy w pliku extension.vsixmanifest dla rozszerzenia.

  4. Po zainstalowaniu przez program Visual Studio rozszerzenia, wybierz przycisk Zamknij.

Aby debugować rozszerzenie

  1. Uruchom program Visual Studio z uprawnieniami administratora i Otwórz projekt rozszerzenia.Następujące kroki odnoszą się do tego wystąpienia programu Visual Studio jako pierwszej instancji,.

  2. Uruchomienie innego wystąpienia programu Visual Studio z uprawnieniami administratora.Następujące kroki odnoszą się do tego wystąpienia programu Visual Studio jako drugiej instancji,.

  3. Przełącz się do pierwszego wystąpienia programu Visual Studio.

  4. Na pasku menu wybierz Debugowanie, Dołącz do procesu.

  5. Z listy Dostępne procesy wybierz devenv.exe.Ten wpis, który odnosi się do drugiego wystąpienia programu Visual Studio; jest to wystąpienie, którym chcesz debugować swoje rozszerzenie projektu w.

  6. Wybierz przycisk Dołącz.

    Program Visual Studio uruchamia rozszerzenie projektu w trybie debugowania.

  7. Przełącz się do drugiego wystąpienia programu Visual Studio.

  8. Utwórz nowy projekt programu SharePoint, który ładuje Twoje rozszerzenie.Na przykład, w przypadku debugowania rozszerzeniem dla elementów projektu definicji listy, utwórz projekt Definicja listy.

  9. Wykonaj wszelkie wymagane kroki, aby przetestować kod rozszerzenia.

  10. Po zakończeniu debugowania rozszerzenia, zamknij drugie wystąpienie programu Visual Studio.

Aby usunąć rozszerzenie

  1. W Visual Studio, na pasku menu wybierz Narzędzia, Aktualizacje i rozszerzenia.

    Zostanie otwarte okno dialogowe Rozszerzenia i aktualizacje.

  2. Na liście rozszerzeń wybierz nazwę rozszerzenia, a następnie wybierz przycisk Odinstaluj.

  3. W oknie dialogowym, które się pojawi, wybierz przycisk Tak, aby potwierdzić, że chcesz odinstalować rozszerzenie.

  4. Wybierz przycisk Uruchom ponownie teraz, aby ukończyć dezinstalację.

Debugowanie poleceń programu SharePoint

Jeżeli chcesz debugować polecenie programu SharePoint, które jest częścią rozszerzenia narzędzi programu SharePoint, należy dołączyć program do usuwania błędów do procesu vssphost4.exe.Jest to proces hosta 64-bitowego, który wykonuje polecenia programu SharePoint.Aby uzyskać więcej informacji dotyczących poleceń programu SharePoint i vssphost4.exe, zobacz Wywoływanie modeli obiektów SharePoint.

Aby dołączyć debuger do procesu vssphost4.exe

  1. Rozpocznij debugowanie Twojego rozszerzenia w doświadczalnych wystąpieniach programu Visual Studio lub regularnych wystąpieniach programu Visual Studio, postępując zgodnie z instrukcjami.

  2. W przypadku programu Visual Studio, w którym uruchomiono program do usuwania błędów, na pasku menu wybierz Debuguj, Dołącz do procesu.

  3. Z listy Dostępne procesy wybierz vssphost.exe.

    [!UWAGA]

    Jeśli procesu vssphost.exe nie ma na liście, należy uruchomić proces vssphost4.exe w wystąpieniu programu Visual Studio, w którym są uruchomione rozszerzenia.Zazwyczaj można to zrobić, wykonując akcję wywołującą Visual Studio, aby połączyć się z witryną programu SharePoint na komputerze deweloperskim.Na przykład, program Visual Studio uruchamia vssphost4.exe, po rozwinięciu węzła połączenia witryny (węzła, który zawiera adres URL witryny) pod węzłem Połączenia SharePoint w oknie Eksplorator serwera lub podczas dodawania niektórych elementów projektu programu SharePoint, takich jak Wystąpienie listy lub Odbiorca zdarzenia do projektu programu SharePoint.

  4. Wybierz przycisk Dołącz.

  5. W wystąpieniu programu Visual Studio, który jest debugowany należy wykonać kroki, które są wymagane do wykonania polecenia.

Modyfikowanie wartości rejestru do pomocy w debugowaniu rozszerzeń narzędzi programu SharePoint.

Podczas debugowania rozszerzenia narzędzi programu SharePoint w programie Visual Studio, można modyfikować wartości w rejestrze, aby pomóc w rozwiązaniu rozszerzenia.Istnieją wartości w kluczu HKEY_CURRENT_USER\Software\Microsoft\VisualStudio\11.0\SharePointTools.Te wartości nie istnieją domyślnie.

Aby ułatwić rozwiązywanie wszelkich rozszerzeń narzędzi programu SharePoint, można utworzyć i ustawić wartość EnableDiagnostics.W poniższej tabeli opisano tę wartość.

Wartość

Opis

EnableDiagnostics

REG_DWORD, określająca, czy komunikaty diagnostyczne są wyświetlane w oknie Wyjście.

Aby wyświetlić komunikatu diagnostyczne, wartość tę należy ustawić na wartość 1.Aby zatrzymać wyświetlanie komunikatów, ustaw tę wartość na 0 lub usuń tę wartość.

Aby pisać wiadomości do okna Danych wyjściowych z rozszerzenia narzędzi w programie SharePoint, należy użyć usługi projektu programu SharePoint.Aby uzyskać więcej informacji, zobacz Korzystanie z usługi projektu SharePoint.

Jeśli rozszerzenie zawiera polecenia programu SharePoint, można utworzyć i ustawić dodatkowe wartości, aby ułatwić rozwiązywanie problemów związanych z poleceniami.W poniższej tabeli opisano te wartości.

Wartość

Opis

AttachDebuggerToHostProcess

REG_DWORD, który określa, czy wyświetlać okno dialogowe, które pozwala na dołączanie debugera do vssphost4.exe jak tylko zacznie.Jest to przydatne, jeśli polecenie, które chcesz debugować jest wykonywana przez vssphost.exe, natychmiast po jego uruchomieniu, a nie ma wystarczająco dużo czasu na ręczne dołączenie debugera przed wykonaniem polecenia.Aby wyświetlić okno dialogowe, wywołania vssphost4.exe Debugger.Break metoda podczas uruchamiania.

Aby włączyć to zachowanie, należy ustawić tę wartość na 1.Aby wyłączyć to zachowanie, ustaw tę wartość na 0 lub usunąć tę wartość.

Jeśli ta wartość jest ustawiona na 1, można również zwiększyć wartość HostProcessStartupTimeout, aby przyznać sobie wystarczającą ilość czasu, aby uruchomić program do usuwania błędów, zanim Visual Studio może się spodziewać, że obiekt vssphost4.exe zasygnalizuje pomyślne uruchomienie.

ChannelOperationTimeout

REG_DWORD, który określa czas, w sekundach, na ciągu których Visual Studio czeka na wykonanie polecenia programu SharePoint.Jeśli polecenie nie jest wykonywane w czasie, SharePointConnectionException jest generowany.

Wartość domyślna to 120 sekund.

HostProcessStartupTimeout

REG_DWORD, który określa czas, w sekundach, w ciągu których Visual Studio czeka na sygnalizowanie vssphost4.exe, że został uruchomiony pomyślnie.Jeśli proces vssphost4.exe nie sygnalizuje pomyślnego uruchomienie w czasie, SharePointConnectionException jest generowany.

Wartość domyślna to 60 sekund.

MaxReceivedMessageSize

REG_DWORD, który określa maksymalny dopuszczalny rozmiar, w bajtach, wiadomościach WCF, które są przekazywane między Visual Studio i vssphost4.exe.

Wartością domyślną jest 1 048 576 bajtów (1 MB).

MaxStringContentLength

REG_DWORD, który określa maksymalny dopuszczalny rozmiar, w bajtach, ciągach, które są przekazywane między Visual Studio i vssphost4.exe.

Wartością domyślną jest 1 048 576 bajtów (1 MB).

Zobacz też

Koncepcje

Wdrażanie rozszerzeń dla narzędzi SharePoint w Visual Studio

Inne zasoby

Rozszerzanie Narzędzi SharePoint w Visual Studio