纸上得来终觉浅,绝知此事要躬行。

 

【译】在 Linux 上不安装 Mono 构建 .NET Framework 类库

在这篇文章中,我展示了如何在 Linux 上构建针对 .NET Framework 版本的.NET项目,而不使用 Mono。通用使用微软新发布的 Mocrosoft.NETFramework.ReferenceAssemblies NuGet 包,您将不需要安装除 .NET Core SDK 之外的任何其他软件包!总的来说,在 Linux 系统上构建 .NET Framework 类库时,只需要在你的项目文件中添加下面的节点即可:

<PackageReference Include="Microsoft.NETFramework.ReferenceAssemblies" PrivateAssets="All" Version="1.0.0-preview.2" />

 

背景:在 Linux 上构建 full-framework 类库

如果您正在构建 .NET Standard NuGet 软件包,并且希望为用户提供最佳体验(并避免一些依赖性),那么您将需要查看有关跨平台定位的建议。那里有很多可以做和不可以做的建议,但我倾向于将其归结为:如果您的目标是任何版本的 .NET Standard,那么您至少需要以下目标框架:

<TargetFrameworks>netstandard2.0;net461;net472</TargetFrameworks>

如果您的目标是.NET Standard 1.x,那么将其添加到构建目标中时,重要的是包含两个 .NET Framework 目标以避免 .NET Standard 2.0 垫片出现问题。

这就引出了一些问题 - 完整的 .NET 框架目标理论上只能在 Windows 上构建。在上一篇文章中,我展示了如何通过安装 Mono 并使用它提供的程序集来解决这个问题。在那篇文章中,我也展示了在 Linux 上运行 .NET Framework 测试套件。到目前为止,这对我来说非常有效,但它有几个缺点:

  • 它需要你安装 Mono
  • 它需要添加一个有点hacky .props文件
  • 它没有得到官方的支持,所以如果它不起作用,你就得自己想办法

.props 文件将 FrameworkPathOverride MSBuild 变量设置为 Mono 引用程序集,这是我们能够构建的方式。但正如 Jon Skeet在评论中指出的那样,Mono 实际上并不是必需的。我们只需要一种方法来轻松获取要编译的引用程序集。那就是微软提供的 Microsoft.NETFramework.ReferenceAssemblies 包。

通过 NuGet 使用程序集 Microsoft.NETFramework.ReferenceAssemblies

在我看到 Muhammad Rehan Saeed 的这条推文之前,我完全没有注意到 Microsoft.NETFramework.ReferenceAssemblies NuGet 包。这是一条非常棒的信息,构建 full .NET Framework 类库只需要在 Linux 上安装 .NET Core SDK !

我们来举个例子吧。

您可以使用  dotnet new classlib  创建一个 .NET Core 类库,它将提供一个如下所示的 .csproj 文件:

<Project Sdk="Microsoft.NET.Sdk">

  <PropertyGroup>
    <TargetFrameworks>netstandard2.0</TargetFrameworks>
  </PropertyGroup>

</Project>

 修改 .csproj 项目文件,添加更多的构建目标:

<Project Sdk="Microsoft.NET.Sdk">

  <PropertyGroup>
    <TargetFrameworks>netstandard2.0;net461;net472</TargetFrameworks>
  </PropertyGroup>

</Project>

 如果此时尝试在 Linux 上使用  dotnet build ,您将看到类似以下内容的错误:

/usr/share/dotnet/sdk/2.1.700/Microsoft.Common.CurrentVersion.targets(1175,5): 
error MSB3644: The reference assemblies for framework ".NETFramework,Version=v4.6.1" 
were not found. To resolve this, install the SDK or Targeting Pack for this framework 
version or retarget your application to a version of the framework for which you have 
the SDK or Targeting Pack installed. Note that assemblies will be resolved from the 
Global Assembly Cache (GAC) and will be used in place of reference assemblies. 
Therefore your assembly may not be correctly targeted for the framework you intend.

 终于到了见证奇迹的时刻。添加 Microsoft.NETFramework.ReferenceAssemblies NuGet 包到你的项目文件:

<Project Sdk="Microsoft.NET.Sdk">

  <PropertyGroup>
    <TargetFrameworks>netstandard2.0;net461;net472</TargetFrameworks>
  </PropertyGroup>

  <!-- Add this reference-->
  <ItemGroup>
    <PackageReference Include="Microsoft.NETFramework.ReferenceAssemblies" PrivateAssets="All" Version="1.0.0-preview.2" />
  </ItemGroup>

</Project>

 再次执行  dotnet build ,竟然构建成功了。

Build succeeded.
    0 Warning(s)
    0 Error(s)

使用 PrivateAssets 特性可防止 Microsoft.NETFramework.ReferenceAssemblies 包“泄漏”到依赖项目或已发布的 NuGet 包中;它只是一个构建时依赖。

只需将软件包添加到项目中就可以获得比安装 Mono 更好的体验。最重要的是,这将是从现在开始 .NET Core 支持的方法。并且在 .NET Core 3.0 SDK 中它将变得更好,必要时 .NET Core SDK 将自动引用此包,所以,理论上根本不需要我们手工编辑项目文件添加配置节点去构建 .NET Framework 项目!

它是如何工作的:a meta-package, a .targets, and lots of dlls

如果你对包的工作方式感兴趣,我建议你阅读相关的问题,但我会在这里提供一个高级的大纲。

我们将从 Microsoft.NETFramework.ReferenceAssemblies NuGet 包本身开始。这个包是一个不包含代码的元包,但是对于每个受支持的 .NET Framework 版本都依赖于不同的 NuGet 包:

例如:以 .NET Framework 4.6.1 为目标时将依赖 Microsoft.NETFramework.ReferenceAssemblies.net461。此方法可以确保您只会下载到与目标框架一致的 NuGet 包。

如果你打开一个特定 Framework 的 NuGet 包,你会在 build 文件夹中发现两件事:

  • 一个 .targets 文件
  • 一个 .NETFramework 文件夹,其中包含引用的全部程序集(> 100MB)

.targets 文件与我上一篇文章中的 .props 文件的用途类似 - 它告诉 MSBuild 在哪里可以找到框架库。以下示例来自.NET 4.6.1包: 

<Project>
  <PropertyGroup Condition=" ('$(TargetFrameworkIdentifier)' == '.NETFramework') And ('$(TargetFrameworkVersion)' == 'v4.6.1') ">
    <TargetFrameworkRootPath>$(MSBuildThisFileDirectory)</TargetFrameworkRootPath>

    <!-- FrameworkPathOverride is typically not set to the correct value, and the common targets include mscorlib from FrameworkPathOverride.
         So disable FrameworkPathOverride, set NoStdLib to true, and explicitly reference mscorlib here. -->
    <EnableFrameworkPathOverride>false</EnableFrameworkPathOverride>
    <NoStdLib>true</NoStdLib>
  </PropertyGroup>

  <ItemGroup Condition=" ('$(TargetFrameworkIdentifier)' == '.NETFramework') And ('$(TargetFrameworkVersion)' == 'v4.6.1') ">
    <Reference Include="mscorlib" Pack="false" />
  </ItemGroup>

</Project>

 这会将 TargetFrameworkRootPath 参数设置为包含 .targets 文件的文件夹。MSBuild 遍历 NuGet 包的文件夹结构(.NETFramework \ v4.6.1),找到dll,并找到引用程序集: 

我已经使用.NET Core 2.1 SDK 和 2.2 SDK 测试了这些软件包,并且它的工作时间都非常出色。试试看!

Reference

 

原文链接:https://andrewlock.net/using-reference-assemblies-to-build-net-framework-libararies-on-linux-without-mono/ 

posted on 2019-07-31 15:26  JRoger  阅读(2075)  评论(3编辑  收藏  举报

导航