Visual Studio 2019 - This extension uses deprecated APIs and is at risk of not functioning in a future VS update.
블로그를 위해 정의해 둔 비주얼 스튜디오 확장 도구가,
Visual Studio 확장(VSIX)을 이용해 사용자 매크로를 추가하는 방법
; https://www.sysnet.pe.kr/2/0/11186
2019 Preview 버전에 설치하니 다음과 같은 경고가 뜹니다.
This extension uses deprecated APIs and is at risk of not functioning in a future VS update.
문제는, "deprecated" 되었다는 API가 어떤 것인지 알려주지 않는다는 점입니다. ^^; 그래서 비교를 위해 새롭게 Visual Studio 2019에서 "Custom Command" 확장을 생성했더니, 결정적인 차이점으로 Package 객체가 AsyncPackage로 바뀌어 전체적인 동작이 비동기로 변경된 것입니다.
그래서 제 코드도 AsyncPackage를 사용하도록 변경했고 이후 설치를 하니 "deprecaged" 경고가 없어졌습니다.
아울러 AsyncPackage 적용을 위해 몇 가지 부가 작업이 함께 따르게 됩니다. 우선, csproj의 패키지 참조가 다음과 같이 바뀌고,
<ItemGroup>
<PackageReference Include="Microsoft.VisualStudio.SDK" Version="15.9.3" ExcludeAssets="runtime" />
<PackageReference Include="Microsoft.VSSDK.BuildTools" Version="16.0.298" />
</ItemGroup>
ProvideAutoLoad를 사용한 경우 PackageAutoLoadFlags도 함께 적용해야 합니다.
[ProvideAutoLoad(UIContextGuids80.EmptySolution, PackageAutoLoadFlags.BackgroundLoad)]
마지막으로 기존에 작성되었던 동기 호출 방식의 코드를 모두 비동기로 만들어야 하는데 이때 Visual Studio DOM을 호출하는 코드는 동기식으로 작성해야 하므로 다음과 같이 SwitchToMainThreadAsync 호출을 사전에 꼭 호출하는 코드를 넣어야 합니다.
private async Task DoSomeActionAsync(DTE2 dte, AsyncPackage package)
{
await ThreadHelper.JoinableTaskFactory.SwitchToMainThreadAsync(package.DisposalToken);
dte.ActiveDocument.Save(""); // Visual Studio UI Thread에서 이 코드가 실행되어야 하므로.
...[생략]...
}
이 정도의 변경을 거치고 나면 2019 Preview 버전에서도 잘 동작하게 됩니다.
참고로, AsyncPackage로 변경했는데 Visual Studio에서 로딩 시 다음과 같은 오류가 발생할 수 있습니다.
The 'MacroCommandPackage' package did not load correctly.
The problem may have been caused by a configuration change or by the installation of another extension. You can get more information by examining the file '%USERPROFILE%\AppData\Roaming\Microsoft\VisualStudio\16.0_d362fc82\ActivityLog.xml'.
Restarting Visual Studio could help resolve this issue.
로딩 시 실행되는 코드 중에 ThreadHelper.JoinableTaskFactory.SwitchToMainThreadAsync 코드를 적절한 위치에 넣어주지 않은 경우 예외가 발생한 문제였습니다. 코드를 꼼꼼히 확인해 주셔야 합니다. ^^
본문과는 상관없지만, 제가 가지고 있는 또 다른 VSIX 패키지를 마이그레이션 중에 "Microsoft.VisualStudio.TextTemplating.VSHost.11.0.dll"이 없어서 빌드를 못하는 문제가 있었습니다. 관련 버전을 담은 Visual Studio SDK를 삭제했던 것 같은데요. 검색해 보면, Visual Studio 2015 설치 파일에서 구할 수 있다고 하며 다음과 같이 명령행에서 실행하면 된다는 글이 있습니다.
vs_enterprise.exe /s /installSelectableItems VS_SDK_GROUPV1
음... 그런데 실제로 해보니 ^^; Visual Studio 2015를 설치만 하고 SDK는 설치하지 않았습니다. 그래서 다시 vs_enterprise.exe를 실행해 "Visual Studio Extensibility Tools Update 3" 항목을 직접 선택하여 설치할 수 있었습니다.
[이 글에 대해서 여러분들과 의견을 공유하고 싶습니다. 틀리거나 미흡한 부분 또는 의문 사항이 있으시면 언제든 댓글 남겨주십시오.]