Obsługa wyspecjalizowanego wdrożenia

Wdrożenie jest opcjonalną operacją dla projektów. Na przykład projekt internetowy obsługuje wdrożenie, aby umożliwić aktualizacji projektu serwera sieci Web. Podobnie projekt urządzenia inteligentnego obsługuje wdrożenie w celu skopiowania wbudowanej aplikacji na urządzenie docelowe. Podtypy projektu mogą dostarczać wyspecjalizowane zachowanie wdrożenia przez zaimplementowanie interfejsu IVsDeployableProjectCfg . Ten interfejs definiuje kompletny zestaw operacji wdrażania:

• AdviseDeployStatusCallback

• Commit

• QueryStartDeploy

• QueryStatusDeploy

• Rollback

• StartDeploy

• StopDeploy

• UnadviseDeployStatusCallback

  Rzeczywista operacja wdrażania powinna być wykonywana w osobnym wątku, aby program Visual Studio był jeszcze bardziej dynamiczny na interakcję użytkownika. Metody udostępniane przez IVsDeployableProjectCfg program są wywoływane asynchronicznie przez program Visual Studio i działają w tle, umożliwiając środowisku wykonywanie zapytań o stan operacji wdrażania w dowolnym momencie lub zatrzymywanie operacji, jeśli jest to konieczne. IVsDeployableProjectCfg Operacje wdrażania interfejsu są wywoływane przez środowisko, gdy użytkownik wybierze polecenie deploy.

  Aby powiadomić środowisko o rozpoczęciu lub zakończeniu operacji wdrażania, podtyp projektu musi wywołać OnStartDeploy metody i OnEndDeploy .

Aby obsłużyć wyspecjalizowane wdrożenie według projektu podrzędnego

• Zaimplementuj metodę rejestrowania AdviseDeployStatusCallback środowiska w celu odbierania powiadomień o zdarzeniach stanu wdrożenia.

  C#

  private Microsoft.VisualStudio.Shell.EventSinkCollection adviseSink = new Microsoft.VisualStudio.Shell.EventSinkCollection();
  public int AdviseDeployStatusCallback(IVsDeployStatusCallback pIVsDeployStatusCallback,
                                        out uint pdwCookie)
  {
      if (pIVsDeployStatusCallback == null)
          throw new ArgumentNullException("pIVsDeployStatusCallback");
  
      pdwCookie = adviseSink.Add(pIVsDeployStatusCallback);
      return VSConstants.S_OK;
  }
  
  

  VB

  Private adviseSink As Microsoft.VisualStudio.Shell.EventSinkCollection = New Microsoft.VisualStudio.Shell.EventSinkCollection()
  Public Function AdviseDeployStatusCallback(ByVal pIVsDeployStatusCallback As IVsDeployStatusCallback, _
                                             ByRef pdwCookie As UInteger) As Integer
  
      If pIVsDeployStatusCallback Is Nothing Then
          Throw New ArgumentNullException("pIVsDeployStatusCallback")
      End If
  
      pdwCookie = adviseSink.Add(pIVsDeployStatusCallback)
      Return VSConstants.S_OK
  
  End Function
  

• Zaimplementuj metodę UnadviseDeployStatusCallback , aby anulować rejestrację środowiska w celu otrzymywania powiadomień o zdarzeniach stanu wdrożenia.

  C#

  public int UnadviseDeployStatusCallback(uint dwCookie)
  {
      adviseSink.RemoveAt(dwCookie);
      return VSConstants.S_OK;
  }
  
  

  VB

  Public Function UnadviseDeployStatusCallback(ByVal dwCookie As UInteger) As Integer
      adviseSink.RemoveAt(dwCookie)
      Return VSConstants.S_OK
  End Function
  

• Zaimplementuj metodę Commit , aby wykonać operację zatwierdzania specyficzną dla aplikacji. Ta metoda jest używana głównie na potrzeby wdrażania bazy danych.

  C#

  public int Commit(uint dwReserved)
  {
       //Implement commit operation here.
       return VSConstants.S_OK;
  }
  
  

  VB

  Public Function Commit(ByVal dwReserved As UInteger) As Integer
      'Implement commit operation here.
      Return VSConstants.S_OK
  End Function
  

• Zaimplementuj metodę , Rollback aby wykonać operację wycofywania. Po wywołaniu tej metody projekt wdrożenia musi wykonać odpowiednie czynności, aby wycofać zmiany i przywrócić stan projektu. Ta metoda jest używana głównie na potrzeby wdrażania bazy danych.

  C#

  public int Rollback(uint dwReserved)
  {
      //Implement Rollback operation here.
      return VSConstants.S_OK;
  }
  
  

  VB

  Public Function Commit(ByVal dwReserved As UInteger) As Integer
      'Implement commit operation here.
      Return VSConstants.S_OK
  End Function
  

• Zaimplementuj metodę, QueryStartDeploy aby określić, czy projekt może rozpocząć operację wdrażania.

  C#

  public int QueryStartDeploy(uint dwOptions, int[] pfSupported, int[] pfReady)
  {
      if (pfSupported != null && pfSupported.Length >0)
          pfSupported[0] = 1;
      if (pfReady != null && pfReady.Length >0)
      {
          pfReady[0] = 0;
          if (deploymentThread != null && !deploymentThread.IsAlive)
              pfReady[0] = 1;
      }
      return VSConstants.S_OK;
  }
  
  

  VB

  Public Function QueryStartDeploy(ByVal dwOptions As UInteger, ByVal pfSupported As Integer(), ByVal pfReady As Integer()) As Integer
      If Not pfSupported Is Nothing AndAlso pfSupported.Length > 0 Then
          pfSupported(0) = 1
      End If
      If Not pfReady Is Nothing AndAlso pfReady.Length > 0 Then
          pfReady(0) = 0
          If Not deploymentThread Is Nothing AndAlso (Not deploymentThread.IsAlive) Then
              pfReady(0) = 1
          End If
      End If
      Return VSConstants.S_OK
  End Function
  

• Zaimplementuj metodę, QueryStatusDeploy aby określić, czy operacja wdrażania została ukończona pomyślnie.

  C#

  public int QueryStatusDeploy(out int pfDeployDone)
  {
      pfDeployDone = 1;
      if (deploymentThread != null && deploymentThread.IsAlive)
          pfDeployDone = 0;
      return VSConstants.S_OK;
  }
  
  

  VB

  Public Function QueryStatusDeploy(ByRef pfDeployDone As Integer) As Integer
      pfDeployDone = 1
      If Not deploymentThread Is Nothing AndAlso deploymentThread.IsAlive Then
          pfDeployDone = 0
      End If
      Return VSConstants.S_OK
  End Function
  

• Zaimplementuj metodę , StartDeploy aby rozpocząć operację wdrażania w osobnym wątku. Umieść kod specyficzny dla wdrożenia aplikacji wewnątrz Deploy metody .

  C#

  public int StartDeploy(IVsOutputWindowPane pIVsOutputWindowPane, uint dwOptions)
  {
      if (pIVsOutputWindowPane == null)
          throw new ArgumentNullException("pIVsOutputWindowPane");
  
      if (deploymentThread != null && deploymentThread.IsAlive)
          throw new NotSupportedException("Cannot start deployment operation when it is already started; Call QueryStartDeploy first");
  
      outputWindow = pIVsOutputWindowPane;
  
      // Notify that deployment is about to begin and see if any user wants to cancel.
      if (!NotifyStart())
          return VSConstants.E_ABORT;
  
      operationCanceled = false;
  
      // Create and start our thread
      deploymentThread = new Thread(new ThreadStart(this.Deploy));
      deploymentThread.Name = "Deployment Thread";
      deploymentThread.Start();
  
      return VSConstants.S_OK;
  }
  
  

  VB

  Public Function StartDeploy(ByVal pIVsOutputWindowPane As IVsOutputWindowPane, ByVal dwOptions As UInteger) As Integer
      If pIVsOutputWindowPane Is Nothing Then
          Throw New ArgumentNullException("pIVsOutputWindowPane")
      End If
  
      If Not deploymentThread Is Nothing AndAlso deploymentThread.IsAlive Then
          Throw New NotSupportedException("Cannot start deployment operation when it is already started; Call QueryStartDeploy first")
      End If
  
      outputWindow = pIVsOutputWindowPane
  
      ' Notify that deployment is about to begin and see if any user wants to cancel.
      If (Not NotifyStart()) Then
          Return VSConstants.E_ABORT
      End If
  
      operationCanceled = False
  
      ' Create and start our thread
      deploymentThread = New Thread(AddressOf Me.Deploy)
      deploymentThread.Name = "Deployment Thread"
      deploymentThread.Start()
  
      Return VSConstants.S_OK
  End Function
  

• Zaimplementuj metodę , StopDeploy aby zatrzymać operację wdrażania. Ta metoda jest wywoływana, gdy użytkownik naciska przycisk Anuluj podczas procesu wdrażania.

  C#

  public int StopDeploy(int fSync)
  {
      if (deploymentThread != null && deploymentThread.IsAlive)
          return VSConstants.S_OK;
  
      outputWindow.OutputStringThreadSafe("Canceling deployment");
      operationCanceled = true;
      if (fSync != 0)
      {
          // Synchronous request, wait for the thread to terminate.
          if (!deploymentThread.Join(10000))
          {
              Debug.Fail("Deployment thread did not terminate before the timeout, Aborting thread");
              deploymentThread.Abort();
          }
      }
  
      return VSConstants.S_OK;
  }
  
  

  VB

  Public Function StopDeploy(ByVal fSync As Integer) As Integer
      If Not deploymentThread Is Nothing AndAlso deploymentThread.IsAlive Then
          Return VSConstants.S_OK
      End If
  
      outputWindow.OutputStringThreadSafe("Canceling deployment")
      operationCanceled = True
      If fSync <> 0 Then
          ' Synchronous request, wait for the thread to terminate.
          If (Not deploymentThread.Join(10000)) Then
              Debug.Fail("Deployment thread did not terminate before the timeout, Aborting thread")
              deploymentThread.Abort()
          End If
      End If
  
      Return VSConstants.S_OK
  End Function
  

Uwaga

Wszystkie przykłady kodu podane w tym temacie są częścią większego przykładu w przykładach zestawu VSSDK.

Powiązana zawartość

• Podtypy projektu