使用 MSBuild 專案 SDK

  • 發行項

MSBuild 15.0 引進了 「project SDK」 的概念，可簡化使用需要匯入屬性和目標的軟體發展工具組。

<Project Sdk="Microsoft.NET.Sdk">
    <PropertyGroup>
        <TargetFramework>net46</TargetFramework>
    </PropertyGroup>
</Project>

在評估專案期間，MSBuild 會在專案檔的頂端和底部新增隱含匯入：

<Project>
    <!-- Implicit top import -->
    <Import Project="Sdk.props" Sdk="Microsoft.NET.Sdk" />

    <PropertyGroup>
        <TargetFramework>net46</TargetFramework>
    </PropertyGroup>

    <!-- Implicit bottom import -->
    <Import Project="Sdk.targets" Sdk="Microsoft.NET.Sdk" />
</Project>

參考專案 SDK

參考專案 SDK 的方式有三種：

在 Sdk 專案上使用 <Project/> 屬性

<Project Sdk="My.Custom.Sdk">
    ...
</Project>

隱含匯入會新增至專案的頂端和底部，如先前所述。

若要指定特定版本的 SDK，請將它附加至 Sdk 屬性：

<Project Sdk="My.Custom.Sdk/1.2.3">
    ...
</Project>

使用最上層 <Sdk/> 元素

<Project>
    <Sdk Name="My.Custom.Sdk" Version="1.2.3" />
    ...
</Project>

隱含匯入會新增至專案的頂端和底部，如先前所述。

不需要屬性 Version 。

<Import/>在專案中的任何位置使用 專案

<Project>
    <PropertyGroup>
        <MyProperty>Value</MyProperty>
    </PropertyGroup>
    <Import Project="Sdk.props" Sdk="My.Custom.Sdk" />
    ...
    <Import Project="Sdk.targets" Sdk="My.Custom.Sdk" />
</Project>

在您的專案中明確包含匯入可讓您完全控制順序。

當使用 <Import/> 元素時，您也可以指定選擇性的 Version 屬性。 例如，您可以指定 <Import Project="Sdk.props" Sdk="My.Custom.Sdk" Version="1.2.3" />。

警告

如果您要將專案變更為使用 <Import/> 專案，請確定您同時新增 .props 和 .targets 匯入，而且您會從 <Project/> 元素和 <Sdk/> 元素中移除 SDK。 若無法這麼做，將會導致匯入和 MSB4011 警告加倍。

解析專案 SDK 的方式

評估匯入時，MSBuild 會根據您指定的名稱和版本，動態解析專案 SDK 的路徑。 MSBuild 也有已註冊的 SDK 解析程式清單，這是在您的電腦上尋找專案 SDK 的外掛程式。 這些外掛程式包括：

  • 以 NuGet 為基礎的解析程式，可查詢 NuGet 套件的設定套件摘要，以尋找符合您所指定 SDK 的識別碼和版本。

    只有在您指定選擇性版本時，此解析程式才會作用中。 它可以用於任何自訂專案 SDK。

  • .NET SDK 解析程式，可解析隨 .NET SDK一起安裝的 MSBuild SDK。

    此解析程式會尋找屬於產品一部分的專案 SDK，例如 Microsoft.NET.Sdk 和 Microsoft.NET.Sdk.Web 。

  • 預設的解析程式，可解析使用 MSBuild 安裝的 SDK。

NuGet 型 SDK 解析程式支援在 global.json 檔案中指定版本，可讓您在一個地方控制專案 SDK 版本，而不是在每個個別專案中：

{
    "msbuild-sdks": {
        "My.Custom.Sdk": "5.0.0",
        "My.Other.Sdk": "1.0.0-beta"
    }
}

在建置期間每個專案 SDK 都只能使用一個版本。 如果您參考兩個不同版本的相同專案 SDK，MSBuild 會發出警告。 如果global.json檔案中指定了版本，建議您不要在專案中指定版本。

另請參閱