|
26 | 26 |
|
27 | 27 | **基础方法**: |
28 | 28 |
|
29 | | -通过右击底层库属性,点击调试,设置为可执行文件,路径修改为主项目的启动程序。就可以在底层库点击调试运行主项目调试,同时支持打断点和进行二进制兼容的更改 |
| 29 | +在底层库项目的 `Properties/launchSettings.json` 文件中配置调试启动参数。可以通过 Visual Studio 右击底层库项目属性,点击调试,打开调试启动配置文件 UI 界面,选择启动方式为可执行文件,路径修改为主项目的启动程序。工具将自动读取 `launchSettings.json` 中首个 `commandName` 为 `Executable` 的配置项,从中获取 `executablePath` 作为主项目的可执行文件路径。配置完成之后就可以在底层库点击调试运行主项目调试,同时支持打断点和进行二进制兼容的更改。 |
30 | 30 |
|
31 | | -请注意,将使用首个可执行文件调试配置作为输出配置 |
| 31 | +`launchSettings.json` 中可执行文件配置的路径支持相对路径,相对于当前底层库项目的输出文件夹。工具会从 `executablePath` 找到主项目的可执行文件,并将底层库的输出文件拷贝到该可执行文件所在的文件夹。 |
32 | 32 |
|
33 | 33 | **高级方法**: |
34 | 34 |
|
35 | | -编辑底层库项目的 csproj 文件,添加下面代码 |
| 35 | +编辑底层库项目的 csproj 文件,添加 `MainProjectExecutablePath` 属性直接指定主项目的可执行文件路径。此方法将覆盖基础方法的 `launchSettings.json` 配置: |
36 | 36 |
|
37 | 37 | ```xml |
38 | 38 | <PropertyGroup> |
39 | | - <MainProjectExecutablePathCommandArgs>主项目的输出可执行文件</MainProjectExecutablePathCommandArgs> |
| 39 | + <MainProjectExecutablePath>主项目的输出可执行文件</MainProjectExecutablePath> |
40 | 40 | </PropertyGroup> |
41 | 41 | ``` |
42 | 42 |
|
43 | 43 | 请注意如果路径包含空格,记得加上引号,如下面例子 |
44 | 44 |
|
45 | 45 | ```xml |
46 | 46 | <PropertyGroup> |
47 | | - <MainProjectExecutablePathCommandArgs>"C:\dotnet campus\Foo\bin\release\net5.0\Foo.exe"</MainProjectExecutablePathCommandArgs> |
| 47 | + <MainProjectExecutablePath>"C:\dotnet campus\Foo\bin\release\net9.0\Foo.exe"</MainProjectExecutablePath> |
48 | 48 | </PropertyGroup> |
49 | 49 | ``` |
50 | 50 |
|
51 | | -以上主项目的输出文件夹支持相对路径,相对于当前底层库项目 csproj 的相对路径 |
| 51 | +以上 `MainProjectExecutablePath` 支持相对路径,相对于当前底层库项目 csproj 的相对路径 |
| 52 | + |
| 53 | +### 多框架兼容性检查 |
| 54 | + |
| 55 | +当底层库项目使用多框架(`<TargetFrameworks>`)时,工具会自动检查当前编译的目标框架与主项目可执行文件的框架是否兼容。兼容规则如下: |
| 56 | + |
| 57 | +- 主项目为 .NET Core / .NET 5+ 系列 → 仅拷贝 .NET Core / .NET 5+ 系列的输出 |
| 58 | +- 主项目为 .NET Framework 系列 → 仅拷贝 .NET Framework 系列的输出 |
| 59 | +- 跨系列框架(如 .NET Core 库拷贝到 .NET Framework 主项目)将自动跳过,不做拷贝 |
| 60 | + |
| 61 | +工具通过检测主项目可执行文件所在目录是否存在 `.runtimeconfig.json` / `.deps.json` 文件判断其框架类型。对于 .NET Framework 系列,工具还会进一步读取 `.exe.config` 文件中的 `supportedRuntime` 信息。 |
52 | 62 |
|
53 | 63 | ## 推荐使用方法 |
54 | 64 |
|
|
60 | 70 |
|
61 | 71 | ## 原理 |
62 | 72 |
|
63 | | -在软件运行的时候依然可以移动 dll 或 exe 的路径,而此工具将底层库项目的输出 dll 和 pdb 文件拷贝到主项目的文件夹或 MainProjectPath 设置的文件夹,将原本的 dll 和 pdb 重命名,然后通过调试的可执行文件方式启动主项目 |
| 73 | +在软件运行的时候依然可以移动 dll 或 exe 的路径,而此工具将底层库项目的输出 dll 和 pdb 文件拷贝到主项目可执行文件所在的文件夹(通过 `MainProjectExecutablePath` 或 `launchSettings.json` 获取),将原本的 dll 和 pdb 重命名为 `.bak` 文件,然后通过调试的可执行文件方式启动主项目 |
64 | 74 |
|
65 | 75 | 此时的主项目将会加载新的 dll 文件,同时因为存在 pdb 文件也能进去代码调试 |
66 | 76 |
|
|
74 | 84 |
|
75 | 85 | ## 细节 |
76 | 86 |
|
77 | | -默认仅有在 Debug 下开启此功能,如需在 Release 也开启,请通过设置 EnableUsingMSBuildCopyOutputFileToFastDebug 属性为 true 开启 |
| 87 | +### 启用控制 |
| 88 | + |
| 89 | +默认仅有在 Debug 下开启此功能,如需在 Release 也开启,请通过设置 `EnableUsingMSBuildCopyOutputFileToFastDebug` 属性为 `true` 开启: |
78 | 90 |
|
79 | 91 | ```xml |
80 | 92 | <PropertyGroup> |
81 | 93 | <EnableUsingMSBuildCopyOutputFileToFastDebug>true</EnableUsingMSBuildCopyOutputFileToFastDebug> |
82 | 94 | </PropertyGroup> |
83 | 95 | ``` |
84 | 96 |
|
85 | | -此项设置之后将会在 Debug 和 Release 下都开启复制 |
| 97 | +此项设置之后将会在 Debug 和 Release 下都开启复制。 |
| 98 | + |
| 99 | +### 复制文件 |
| 100 | + |
| 101 | +工具默认将当前项目的输出 dll 和 pdb 文件(`$(AssemblyName).dll` 和 `$(AssemblyName).pdb`)拷贝到主项目可执行文件所在的文件夹。如需复制更多文件,可在项目文件中自行扩展 `OutputFileToCopy` 项组。 |
| 102 | + |
| 103 | +### 文件占用处理 |
| 104 | + |
| 105 | +目标文件夹如果已存在同名 dll 或 pdb 文件,工具会先将其重命名为 `{原文件名}{序号}.{扩展名}.bak`,再拷贝新文件。被重命名的 bak 文件会被记录到清理列表文件(位于 `$(IntermediateOutputPath)CleanUsingMSBuildCopyOutputFileToFastDebugFile.txt`),在执行 MSBuild Clean 目标时统一清理。 |
86 | 106 |
|
87 | 107 | ## 感谢 |
88 | 108 |
|
|
0 commit comments