使用Api分析器与Windows兼容包来编写智能的跨平台.NETCore应用

本文翻译自Scott Hanselman博客&＃xff1a;

https://www.hanselman.com/blog/WritingSmarterCrossplatformNETCoreAppsWithTheAPIAnalyzerAndWindowsCompatibilityPack.aspx

正文&＃xff1a;

这是最近这几周你应该知道的一对.Net Core界的优秀工具。我们在编写或者移植跨平台代码时&＃xff0c;它们非常有帮助。

.NET API 分析器

首先是API 分析器。如你所知&＃xff0c;有时候我们会遇到过时的API&＃xff0c;或者一个方法你可以在Windows下使用&＃xff0c;但是在Linux下却不能工作。API分析器是一个Roslyn&＃xff08;Roslyn是C#/.NET编译器的名称&＃xff09;分析器&＃xff0c;它可以很容易地添加到你的项目&＃xff0c;通过一个NuGet包。你所要做的就是添加这个包&＃xff0c;之后你将立即得到警告&＃xff0c;或者波浪线表示API有问题。

看看这个简单地例子。我将生成一个简单地控制台应用&＃xff0c;它已经添加了API分析器。注意这个版本号是目前的&＃xff0c;以后会改变。

C:\supercrossplatapp> dotnet new console
C:\supercrossplatapp> dotnet add package Microsoft.DotNet.Analyzers.Compatibility --version 0.1.2-alpha

 然后我将使用一个只能在Windows下使用的API。但是我依旧希望在任何平台下都可以运行。

static void Main(string[] args)

{

    Console.WriteLine("Hello World!");

    if (RuntimeInformation.IsOSPlatform(OSPlatform.Windows))

    {

        var w &＃61; Console.WindowWidth;

        Console.WriteLine($"Console Width is {w}");

    }

}

之后我使用“dotnet build”命令&＃xff08;或者运行命令&＃xff0c;运行也包含build动作&＃xff09;然后我得到了一个漂亮的警告&＃xff0c;这个API不能工作在所有平台下。

C:\supercrossplatapp> dotnet build

Program.cs(14,33): warning PC001: Console.WindowWidth isn&＃39;t supported on Linux, MacOSX [C:\Users\scott\Desktop\supercr

ossplatapp\supercrossplatapp.csproj]

  supercrossplatapp -> C:\supercrossplatapp\bin\Debug\netcoreapp2.0\supercrossplatapp.dll

Build succeeded.

.NET团队的Olia做了一个很好的YouTube视频&＃xff0c;她的视频展示了API分析器是如何工作的。API分析器的代码已经上传到Github。如果你发现了bug请在上面提issue&＃xff01;

.NET CORE的windows兼容包

第二个&＃xff0c;.NET Core的Windows兼容包是一个很好的补充技术。当.NET Core 2.0开发完成并推出后&＃xff0c;它包含3.2万个很好地兼容现有.NET Framework代码的API。实际上&＃xff0c;它们确实兼容地非常好&＃xff0c;我之前可以很容易地将一个15年前的.NET程序移植到.NET Core2.0上&＃xff0c;这个过程中都没有碰到什么麻烦。

从.NET Standard1.6的1.3万个api到.NET Standard2.0的3.2万个API&＃xff0c;他们增加了一倍多的可用API

.NET Standard非常的酷炫&＃xff0c;因为它支持如下平台&＃xff1a;

• .NET Framework 4.6.1

• .NET Core 2.0

• Mono 5.4

• Xamarin.iOS 10.14

• Xamarin.Mac 3.8

• Xamarin.Android 7.5

当你迁移代码到.NET Core时会有大量的Windows平台特有的依赖&＃xff0c;你可能会遇到有些API在.NET Standard找不到的情况。这时&＃xff0c;这个新的NuGet包Microsoft.Windows.Compatibility&＃xff08;预览&＃xff09;&＃xff0c;它可以提供原先只在.NET Framework可用的API。

在这个兼容包里面的API会包含两种类型。一种是这个API原先就是Windows的一部分&＃xff0c;但是也可以跨平台工作。另外一种是只能在windows下工作&＃xff0c;因为他们是操作系统特有的。例如&＃xff0c;API访问WIndows注册表这是Windows下独有的。但是System.DirectoryServices或者System.Drawing他们却可以在任何平台都工作的很好。Windows兼容包在.NET Core现在可用Api的基础上新增呢20000多个API。可以参阅Immol录制的视频。

问题在于&＃xff0c;如果这些不可用API是你使用.NET Core的拦路虎&＃xff0c;那么现在你可以借助兼容包&＃xff0c;耶&＃xff01;但是你要知道你为什么需要迁移到.NET Core。.NET Core与完整版.NET Framework都可以在Windows上工作。如果你的程序目前工作的很好&＃xff0c;并且不需要.NET Core的新特性&＃xff0c;那么就不需要移植到.NET Core。这是规则列表&＃xff1a;

使用.NET Core的情况&＃xff1a;

• 你有跨平台需求

• 你的目标是微服务

• 你使用Dorcker容器

• 你有高性能与可拓展需求

• 你需要同步.NET版本

使用.NET Core的情况&＃xff1a;

• 你的程序当前使用.NET Framework&＃xff08;推荐采用拓展来替代迁移&＃xff09;

• 你的程序使用第三方.NET库或者NuGet包&＃xff0c;它们的.NET Core版本还不可用

• 你所使用的.NET技术在.NET Core上还没有支持

• 你的程序所使用的操作系统平台目前.NET Core还不支持