특수 배포 처리

아티클
06/19/2023

배포는 프로젝트에 대한 선택적 작업입니다. 예를 들어 웹 프로젝트는 프로젝트가 웹 서버를 업데이트할 수 있도록 배포를 지원합니다. 마찬가지로 스마트 디바이스 프로젝트는 빌드된 애플리케이션을 대상 디바이스에 복사하는 배포를 지원합니다. 프로젝트 하위 형식은 IVsDeployableProjectCfg 인터페이스를 구현하여 특수한 배포 동작을 제공할 수 있습니다. 이 인터페이스는 배포 작업의 전체 집합을 정의합니다.

AdviseDeployStatusCallback
Commit
QueryStartDeploy
QueryStatusDeploy
Rollback
StartDeploy
StopDeploy
UnadviseDeployStatusCallback

실제 배포 작업은 별도의 스레드에서 수행되어야 Microsoft Visual Studio가 사용자 상호 작용에 더욱 잘 반응할 수 있습니다. IVsDeployableProjectCfg에서 제공하는 메서드는 Microsoft Visual Studio에서 비동기적으로 호출되고 백그라운드에서 작동하므로 환경에서 언제든지 배포 작업의 상태를 쿼리하거나 필요한 경우 작업을 중지할 수 있습니다. IVsDeployableProjectCfg 인터페이스 배포 작업은 사용자가 배포 명령을 선택할 때 환경에서 호출됩니다.

배포 작업이 시작 또는 종료되었음을 환경에 알리려면 프로젝트 하위 형식이 OnStartDeploy 및 OnEndDeploy 메서드를 호출해야 합니다.

하위 형식 프로젝트에서 특수 배포를 처리하려면

배포 상태 이벤트 알림을 받도록 환경을 등록하려면 AdviseDeployStatusCallback 메서드를 구현합니다.

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;
}

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

배포 상태 이벤트 알림을 받도록 환경의 등록을 취소하려면 UnadviseDeployStatusCallback 메서드를 구현합니다.

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

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

애플리케이션과 관련된 커밋 작업을 수행하려면 Commit 메서드를 구현합니다. 이 메서드는 주로 데이터베이스 배포에 사용됩니다.

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

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

롤백 작업을 수행하려면 Rollback 메서드를 구현합니다. 이 메서드가 호출되면 배포 프로젝트는 변경 내용을 롤백하고 프로젝트 상태를 복원하는 데 적절한 작업을 수행해야 합니다. 이 메서드는 주로 데이터베이스 배포에 사용됩니다.
- C#
- VB
```
public int Rollback(uint dwReserved)
{
    //Implement Rollback operation here.
    return VSConstants.S_OK;
}
```
```
Public Function Commit(ByVal dwReserved As UInteger) As Integer
    'Implement commit operation here.
    Return VSConstants.S_OK
End Function
```

프로젝트가 배포 작업을 시작할 수 있는지 여부를 확인하려면 QueryStartDeploy 메서드를 구현합니다.

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;
}

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

배포 작업이 완료되었는지 여부를 확인하려면 QueryStatusDeploy 메서드를 구현합니다.

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

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

별도의 스레드에서 배포 작업을 시작하려면 StartDeploy 메서드를 구현합니다. 애플리케이션 배포와 관련된 코드를 Deploy 메서드 내부에 배치합니다.

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;
}

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

배포 작업을 중지하려면 StopDeploy 메서드를 구현합니다. 이 메서드는 배포 프로세스 중에 사용자가 취소 단추를 누를 때 호출됩니다.

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;
}

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

참고 항목

이 항목에 제공된 모든 코드 예제는 VSSDK 샘플에서 더 큰 예제의 일부입니다.

프로젝트 하위 형식

다음을 통해 공유

특수 배포 처리

하위 형식 프로젝트에서 특수 배포를 처리하려면

추가 리소스

다음을 통해 공유

특수 배포 처리

하위 형식 프로젝트에서 특수 배포를 처리하려면

관련 콘텐츠

추가 리소스