项目文件中的包参考 (PackageReference)

使用 PackageReference 节点的包引用可直接在项目文件中管理 NuGet 依赖项(无需单独的 packages.config 文件)。 使用所谓的 PackageReference 不会影响 NuGet 的其他方面;例如,仍按照常规 NuGet 配置中的说明应用 NuGet.Config 文件(包括包源)中的设置。

借助 PackageReference,还可使用 MSBuild 条件按目标框架或其他分组选择包引用。 它还允许对依赖项和内容流实行精细控制。 (有关更多详细信息,请参阅NuGet 打包和还原为 MSBuild 目标。)

项目类型支持

默认情况下,PackageReference 用于 .NET Core 项目、.NET Standard 项目,以及面向 Windows 10 Build 15063(创意者更新)及更高版本的 UWP 项目(C++ UWP 项目除外)。 .NET 框架项目支持 PackageReference,但当前默认为 packages.config。 若要使用 PackageReference,请将 packages.config 中的依赖项迁移到项目文件中,然后删除 packages.config。

面向完整 .NET Framework 的 ASP.NET 应用仅包括对 PackageReference 的有限支持。 不支持 C++ 和 JavaScript 项目类型。

添加 PackageReference

在项目文件中使用以下语法添加依赖项:

<ItemGroup>
    <!-- ... -->
    <PackageReference Include="Contoso.Utility.UsefulStuff" Version="3.6.0" />
    <!-- ... -->
</ItemGroup>

控制依赖项版本

用于指定包版本的约定与使用 packages.config 时的约定相同:

<ItemGroup>
    <!-- ... -->
    <PackageReference Include="Contoso.Utility.UsefulStuff" Version="3.6.0" />
    <!-- ... -->
</ItemGroup>

在上述示例中,3.6.0 指 >=3.6.0 的任何版本(首选项为最低版本),详见包版本控制

对没有 PackageReferences 的项目使用 PackageReference

高级:如果项目中没有安装包(项目文件中没有 PackageReference,也没有 packages.config 文件),但想要项目还原为 PackageReference 样式,则可以在项目文件中将项目属性 RestoreProjectStyle 设置为 PackageReference。

<PropertyGroup>
    <!--- ... -->
    <RestoreProjectStyle>PackageReference</RestoreProjectStyle>
    <!--- ... -->
</PropertyGroup>    

如果引用 PackageReference 样式的项目(现有 csproj 或 SDK 样式的项目),这可能很有用。 这可让其他项目以“可传递”的方式引用这些项目引用的包。

PackageReference 和源

在 PackageReference 项目中,在还原时解析可传递依赖项版本。 因此,在 PackageReference 项目中,所有源必须可用于所有还原。

可变版本

PackageReference 支持可变版本

<ItemGroup>
    <!-- ... -->
    <PackageReference Include="Contoso.Utility.UsefulStuff" Version="3.6.*" />
    <PackageReference Include="Contoso.Utility.UsefulStuff" Version="3.6.0-beta*" />
    <!-- ... -->
</ItemGroup>

控制依赖项资产

你可能只是将依赖项用作开发工具,而不希望将它向会使用包的项目公开。 在此情况下,可使用 PrivateAssets 元数据控制此行为。

<ItemGroup>
    <!-- ... -->

    <PackageReference Include="Contoso.Utility.UsefulStuff" Version="3.6.0">
        <PrivateAssets>all</PrivateAssets>
    </PackageReference>

    <!-- ... -->
</ItemGroup>

以下元数据标记控制依赖项资产:

标记 说明 默认值
IncludeAssets 将使用这些资产 all
ExcludeAssets 不会使用这些资产 none
PrivateAssets 将使用这些资产,但它们不会流入上级项目 contentfiles;analyzers;build

以下是这些标记的允许值,其中用分号分隔多个值(但 allnone 必须单独显示):

说明
编译 lib 文件夹的内容,控制项目能否对文件夹中的程序集进行编译
运行库 libruntimes 文件夹的内容,控制是否会复制这些程序集,以生成输出目录
contentFiles contentfiles 文件夹中的内容
build build 文件夹中的 .props.targets
buildMultitargeting (4.0) 文件夹中跨框架目标的.props``.targets``buildMultitargeting
buildTransitive (5.0+) 以可传递的方式流入任意使用项目的资产的 文件夹中的.props``.targets``buildTransitive。 请参阅功能页。
analyzers .NET 分析器
本机 native 文件夹中的内容
none 不使用以上任何内容。
all 以上都是(除 none 之外)

在以下示例中,项目将使用除包中的内容文件之外的所有项,并且除内容文件和分析器之外的所有项均会流入上级项目。

<ItemGroup>
    <!-- ... -->

    <PackageReference Include="Contoso.Utility.UsefulStuff" Version="3.6.0">
        <IncludeAssets>all</IncludeAssets>
        <ExcludeAssets>contentFiles</ExcludeAssets>
        <PrivateAssets>contentFiles;analyzers</PrivateAssets>
    </PackageReference>

    <!-- ... -->
</ItemGroup>

请注意,因为 PrivateAssets 未包括 build,所以目标和属性将流入上级项目。 例如,假设在生成名为 AppLogger 的 NuGet 包的项目中使用上述引用。 AppLogger 可以使用 Contoso.Utility.UsefulStuff 中的目标和属性,使用 AppLogger 的项目也可以。

备注

.nuspec 文件中将 developmentDependency 设置为 true 时,会将包标记为仅开发依赖项,从而防止包作为依赖项包含到其他包中。 利用 PackageReference (NuGet 4.8+) ,此标志还意味着将从编译中排除编译时资产。 有关详细信息,请参阅 PackageReference 的 DevelopmentDependency 支持

添加 PackageReference 条件

可使用条件控制是否包括包,在哪种条件可使用任何 MSBuild 变量或者目标或属性文件中定义的变量。 但目前仅支持 TargetFramework 变量。

例如,假设目标为 netstandard1.4net452,但具有的依赖项仅适用于 net452。 在此情况下,你不希望使用包的 netstandard1.4 项目添加该不必要的依赖项。 要防止此情况,请在 PackageReference 上指定条件,如下所示:

<ItemGroup>
    <!-- ... -->
    <PackageReference Include="Newtonsoft.Json" Version="9.0.1" Condition="'$(TargetFramework)' == 'net452'" />
    <!-- ... -->
</ItemGroup>

使用此项目生成的包会显示,仅对于 net452 目标,Newtonsoft.json 包含为依赖项:

对 VS2017 的 PackageReference 应用条件的结果

还可以在 ItemGroup 级别应用条件,并将其应用到所有子级 PackageReference 元素:

<ItemGroup Condition = "'$(TargetFramework)' == 'net452'">
    <!-- ... -->
    <PackageReference Include="Newtonsoft.Json" Version="9.0.1" />
    <PackageReference Include="Contoso.Utility.UsefulStuff" Version="3.6.0" />
    <!-- ... -->
</ItemGroup>

GeneratePathProperty

NuGet 5.0 或更高版本以及 Visual Studio 2019 16.0 或更高版本随附此功能 。

有时需要从 MSBuild 目标引用包中的文件。 在基于 packages.config 的项目中,包安装在项目文件所在的文件夹中。 但是,在 PackageReference 中,包是在 global-packages 文件夹中使用的,此文件可能会因计算机而异 。

为了消除这种差异,NuGet 引入了一个指向包使用位置的属性。

示例:

  <ItemGroup>
      <PackageReference Include="Some.Package" Version="1.0.0" GeneratePathProperty="true" />
  </ItemGroup>

  <Target Name="TakeAction" AfterTargets="Build">
    <Exec Command="$(PkgSome_Package)\something.exe" />
  </Target>

此外,NuGet 会对包含 tools 文件夹的包自动生成属性。

  <ItemGroup>
      <PackageReference Include="Package.With.Tools" Version="1.0.0" />
  </ItemGroup>

  <Target Name="TakeAction" AfterTargets="Build">
    <Exec Command="$(PkgPackage_With_Tools)\tools\tool.exe" />
  </Target>

MSBuild 属性和包标识不具有相同的限制,因此包标识需要改为一个 MSBuild 易记名称(以 Pkg 为前缀)。 若要验证生成的属性的确切名称,请查看生成的 nuget.g.props 文件。

PackageReference 别名

在某些极少数情况下,不同的包将包含相同命名空间中的类。 从 NuGet 5.7 和 Visual Studio 2019 Update 7 开始,等效于 ProjectReference,PackageReference 支持 Aliases。 默认情况下,不提供别名。 指定别名后,需要使用别名来引用来自带批注的包的所有程序集。

可以在 NuGet\Samples 处查看示例用法。

在项目文件中,按如下所示指定别名:

  <ItemGroup>
    <PackageReference Include="NuGet.Versioning" Version="5.8.0" Aliases="ExampleAlias" />
  </ItemGroup>

在代码中,按如下所示使用别名:

extern alias ExampleAlias;

namespace PackageReferenceAliasesExample
{
...
        {
            var version = ExampleAlias.NuGet.Versioning.NuGetVersion.Parse("5.0.0");
            Console.WriteLine($"Version : {version}");
        }
...
}

NuGet 警告和错误

NuGet 4.3 或更高版本以及 Visual Studio 2017 15.3 或更高版本随附此功能。

对于许多打包和还原方案,所有 NuGet 警告和错误都经过编码,且以 NU**** 开头。 所有 NuGet 警告和错误都列在参考文档中。

NuGet 遵循以下警告属性:

  • TreatWarningsAsErrors 将所有警告视为错误
  • WarningsAsErrors 将特定警告报告为错误
  • NoWarn 隐藏项目范围或包范围内的特定警告。

示例:

<PropertyGroup>
    <TreatWarningsAsErrors>true</TreatWarningsAsErrors>
</PropertyGroup>
...
<PropertyGroup>
    <WarningsAsErrors>$(WarningsAsErrors);NU1603;NU1605</WarningsAsErrors>
</PropertyGroup>
...
<PropertyGroup>
    <NoWarn>$(NoWarn);NU5124</NoWarn>
</PropertyGroup>
...
<ItemGroup>
    <PackageReference Include="Contoso.Package" Version="1.0.0" NoWarn="NU1605" />
</ItemGroup>

阻止 NuGet 警告

虽然推荐在打包和还原操作期间解决所有 NuGet 警告,但在某些情况下可以禁止显示警告。 若要禁止显示项目范围内的警告,请考虑执行以下操作:

<PropertyGroup>
    <PackageVersion>5.0.0</PackageVersion>
    <NoWarn>$(NoWarn);NU5104</NoWarn>
</PropertyGroup>
<ItemGroup>
    <PackageReference Include="Contoso.Package" Version="1.0.0-beta.1"/>
</ItemGroup>

有时,警告仅适用于图中的特定包。 通过对 PackageReference 项目添加 NoWarn,我们可以有更有选择性地禁止显示该警告。

<PropertyGroup>
    <PackageVersion>5.0.0</PackageVersion>
</PropertyGroup>
<ItemGroup>
    <PackageReference Include="Contoso.Package" Version="1.0.0-beta.1" NoWarn="NU1603" />
</ItemGroup>

在 Visual Studio 中禁止显示 NuGet 包警告

在 Visual Studio 中,还可以通过 IDE 禁止显示警告

锁定依赖项

NuGet 4.9 或更高版本以及 Visual Studio 2017 15.9 或更高版本随附此功能。

对 NuGet 还原的输入是项目文件中的一组包引用(顶级或直接依赖项),而输出则是所有包依赖项的完整闭包,其中包括可传递依赖项。 如果输入 PackageReference 列表尚未更改,则 NuGet 尝试始终生成相同的完整闭包。 但是,在某些情况下,它无法执行此操作。 例如:

  • 在使用 <PackageReference Include="My.Sample.Lib" Version="4.*"/> 等浮动版本时。 尽管在此处这样做的目的是浮动到每个包还原的最新版本,但是在某些情况下,用户需要在一个显式动作后,将图形锁定到某个最新版本并浮动到更高版本(如果有可用的更高版本)。

  • 匹配 PackageReference 版本要求的较新版本已发布。 例如

    • 第 1 天:如果指定了 <PackageReference Include="My.Sample.Lib" Version="4.0.0"/>,但在 NuGet 存储库上可用的版本为 4.1.0、4.2.0 和 4.3.0。 在这种情况下,NuGet 将解析为 4.1.0(最接近的最低版本)

    • 第 2 天:版本 4.0.0 发布。 NuGet 现在将查找完全匹配并开始解析到 4.0.0

  • 给定包版本将从存储库中删除。 尽管 nuget.org 不允许包删除,但并非所有包存储库都具有此约束。 这导致 NuGet 在无法解析到已删除的版本时查找最佳匹配项。

启用锁定文件

为了保留包依赖项的完整闭包,可以选择锁定文件功能,方法是通过设置项目的 MSBuild 属性 RestorePackagesWithLockFile

<PropertyGroup>
    <!--- ... -->
    <RestorePackagesWithLockFile>true</RestorePackagesWithLockFile>
    <!--- ... -->
</PropertyGroup>    

如果设置此属性,NuGet 还原将生成一个锁定文件 - 项目根目录中列出所有包依赖项的 packages.lock.json 文件。

备注

一旦项目在其根目录中具有 packages.lock.json 文件,则即使在未设置属性 RestorePackagesWithLockFile 时,锁定文件仍将始终与还原配合使用。 因此,选择加入此功能的另一个方法是在项目的根目录中创建一个虚拟空白 packages.lock.json 文件。

锁定文件的 restore 行为

如果项目存在锁定文件,则 NuGet 使用此锁定文件来运行 restore。 NuGet 将执行一次快速检查,以确定在包依赖项中是否存在项目文件(或相关项目的文件)中所提及的任何更改,如果没有任何更改,则它将仅还原锁定文件中提及的包。 不会对包依赖项进行重新评估。

如果 NuGet 检测到在定义的依赖项中存在一个或多个项目文件中提及的更改,它会重新评估包关系图,并将锁定文件更新为反映项目的新闭包。

对于 CI/CD 和其他方案(不想匆忙更改包依赖项),为此可以将 lockedmode 设置为 true

对于 dotnet.exe,请运行:

> dotnet.exe restore --locked-mode

对于 msbuild.exe,请运行:

> msbuild.exe -t:restore -p:RestoreLockedMode=true

此外,还可以在项目文件中设置此条件 MSBuild 属性:

<PropertyGroup>
    <!--- ... -->
    <RestoreLockedMode>true</RestoreLockedMode>
    <!--- ... -->
</PropertyGroup> 

如果锁定模式为 true,则还原将还原锁定文件中列出的完全匹配的包,或者,如果在锁定文件创建后为项目更新了定义的包依赖项,则还原将失败。

使锁定文件作为源存储库的一部分

若要生成应用程序,且可执行文件和相关项目位于依赖关系链的开头,请将锁定文件签入源代码存储库,以便 NuGet 能够在还原期间使用它。

但是,如果你的项目是不交付的库项目或其他项目依赖的常用代码项目,则不应 将锁定文件作为源代码的一部分签入。 保留锁定文件没有任何坏处,但在依赖于此常用代码项目的项目还原/生成期间,锁定文件中列出的常用代码项目的锁定的包依赖项可能无法使用。

例如

ProjectA
  |------> PackageX 2.0.0
  |------> ProjectB
             |------>PackageX 1.0.0

如果 ProjectAPackageX 版本 2.0.0 上具有依赖项并引用依赖于 PackageX 版本 1.0.0ProjectB,则 ProjectB 的锁定文件将列出 PackageX 版本 1.0.0 的依赖项。 但是,当生成 ProjectA 时,其锁定文件将包含 PackageX 锁定文件中列出的 版本 2.0.0(而不是)上的依赖项 1.0.0``ProjectB。 因此,常用代码项目的锁定文件对依赖于它的项目进行解析的包几乎没有控制。

锁定文件可扩展性

可以使用以下所述的锁定文件控制各种还原行为:

NuGet.exe 选项 dotnet 选项 MSBuild 等效选项 说明
-UseLockFile --use-lock-file RestorePackagesWithLockFile 选择使用锁定文件。
-LockedMode --locked-mode RestoreLockedMode 为还原启用锁定模式。 这对于要获取可重复生成的 CI/CD 方案非常有用。
-ForceEvaluate --force-evaluate RestoreForceEvaluate 对于在项目中定义了浮动版本的包,此选项也非常有用。 默认情况下,NuGet 还原不会在每次还原时自动更新包版本,除非使用此选项运行还原。
-LockFilePath --lock-file-path NuGetLockFilePath 为项目定义自定义锁定文件位置。 默认情况下,NuGet 支持根目录中的 packages.lock.json。 如果在同一目录中具有多个项目,则 NuGet 支持特定于项目的锁定文件 packages.<project_name>.lock.json

AssetTargetFallback

AssetTargetFallback 属性可用于为你的项目引用的项目以及你的项目所使用的 NuGet 包指定其他兼容的框架版本。

如果使用 PackageReference 指定包依赖项,但该包不包含与项目的目标框架兼容的资产,则可使用 AssetTargetFallback 属性。 使用 AssetTargetFallback 中指定的每个目标框架重新检查引用包的兼容性。 通过 AssetTargetFallback 引用 projectpackage 时,将引发 NU1701 警告。

有关 AssetTargetFallback 如何影响兼容性的示例,请参阅下表。

项目框架 AssetTargetFallback 包框架 结果
.NET Framework 4.7.2 .NET Standard 2.0 .NET Standard 2.0
.NET Core 应用 3.1 .NET Standard 2.0、.NET Framework 4.7.2 .NET Standard 2.0
.NET Core 应用 3.1 .NET Framework 4.7.2 不兼容,失败并引发 NU1202
.NET Core 应用 3.1 net472;net471 .NET Framework 4.7.2 .NET Framework 4.7.2,引发 NU1701

可以使用 ; 作为分隔符来指定多个框架。 若要添加回退框架,可以执行以下操作:

<AssetTargetFallback Condition=" '$(TargetFramework)'=='netcoreapp3.1' ">
    $(AssetTargetFallback);net472;net471
</AssetTargetFallback>

如果希望覆盖,而不是添加到现有 AssetTargetFallback 值,则可以退出 $(AssetTargetFallback)

备注

如果你使用的是基于 .NET SDK 的项目,系统会配置相应的 $(AssetTargetFallback) 值,而无需你手动设置这些值。

$(PackageTargetFallback) 是尝试解决这一难题的早期功能,但从根本上来说是无效的,因此不应使用该功能。 若要从 $(PackageTargetFallback) 迁移到 $(AssetTargetFallback),只需更改属性名称。