Roslyn 让 VisualStudio 急速调试底层库方法

在一个大项目里面调试底层库经常需要重新编译整个项目，本项目提供了在底层库编译完成之后将输出文件复制到主项目的输出文件夹，通过外部项目调试的方式提高调试效率

Build	NuGet

使用方法

安装

在需要调试的底层库项目安装 NuGet 库 dotnetCampus.UsingMSBuildCopyOutputFileToFastDebug

此库推荐仅在 Debug 下安装

  <ItemGroup Condition=" '$(Configuration)' == 'Debug'">
    <PackageReference Include="dotnetCampus.UsingMSBuildCopyOutputFileToFastDebug" Version="1.3.1" />
  </ItemGroup>

配置

配置有两个方法，高级方法将会覆盖基础方法

基础方法：

通过右击底层库属性，点击调试，设置为可执行文件，路径修改为主项目的启动程序。就可以在底层库点击调试运行主项目调试，同时支持打断点和进行二进制兼容的更改

请注意，将使用首个可执行文件调试配置作为输出配置

高级方法：

编辑底层库项目的 csproj 文件，添加下面代码

    <PropertyGroup>
        <MainProjectExecutablePathCommandArgs>主项目的输出可执行文件</MainProjectExecutablePathCommandArgs>
    </PropertyGroup>

请注意如果路径包含空格，记得加上引号，如下面例子

    <PropertyGroup>
        <MainProjectExecutablePathCommandArgs>"C:\dotnet campus\Foo\bin\release\net5.0\Foo.exe"</MainProjectExecutablePathCommandArgs>
    </PropertyGroup>

以上主项目的输出文件夹支持相对路径，相对于当前底层库项目 csproj 的相对路径

推荐使用方法

如果是小项目进行调试，推荐修改库的demo或添加单元测试进行测试

如果是需要调试具体状态，而不方便写demo等推荐使用此工具提升调试效率，可以将此工具在各个底层库安装

如果是需要做比较大的更改，如接口修改，推荐使用 dotnet-campus/DllReferencePathChanger: VS DLL引用替换插件 插件

原理

在软件运行的时候依然可以移动 dll 或 exe 的路径，而此工具将底层库项目的输出 dll 和 pdb 文件拷贝到主项目的文件夹或 MainProjectPath 设置的文件夹，将原本的 dll 和 pdb 重命名，然后通过调试的可执行文件方式启动主项目

此时的主项目将会加载新的 dll 文件，同时因为存在 pdb 文件也能进去代码调试

通过将原本dll重命名的方式可以解决主项目执行的文件占用问题

此调试方式要求对底层库的更改满足二进制兼容

关于二进制兼容请看 VisualStudio 通过外部调试方法快速调试库代码

原有的 dll 和 pdb 文件将被加入清理列表文件，将会在执行清理的时候进行清理

细节

默认仅有在 Debug 下开启此功能，如需在 Release 也开启，请通过设置 EnableUsingMSBuildCopyOutputFileToFastDebug 属性为 true 开启

    <PropertyGroup>
        <EnableUsingMSBuildCopyOutputFileToFastDebug>true</EnableUsingMSBuildCopyOutputFileToFastDebug>
    </PropertyGroup>

此项设置之后将会在 Debug 和 Release 下都开启复制

感谢

感谢 https://github.com/kkwpsv/lsjutil 提供 json 解析