Magicodes.IE编写多框架版本支持和执行单元测试

灰太狼 2023-06-28 15:28 28阅读 0赞

## 背景 ##

很多情况下，我们编写了一些工具库之后，往往在某些框架版本中会出现一些问题，比如本人最近写的一个导入导出的工具库Magicodes.IE（GitHub：[https://github.com/xin-lai/Magicodes.IE）][https_github.com_xin-lai_Magicodes.IE]就出现了以下问题：

![评论\_www.wityx.com][www.wityx.com]

虽然支持标准库2.0，但是通过编写单元测试，确实发现如此：

![测试结果\_www.wityx.com][www.wityx.com 1]

因此，单元测试确实需要针对各个框架版本进行测试，并且相关代码需要针对框架进行兼容修改。那么如何实现呢？接下来我们一步步实践。

## .NET框架版本说明 ##

### 最新目标框架版本 ###

下表定义了最常见的目标框架、如何引用这些框架，以及它们实现的 [.NET Standard][] 版本。 这些目标框架版本是最新的稳定版本。 预览版不会显示。 目标框架名字对象 (TFM) 是一个标准化令牌格式，用于指定 .NET 应用或库的目标框架。

<table> 
 <thead> 
  <tr> 
   <th align="center">目标 Framework</th> 
   <th align="center">最新 稳定版本</th> 
   <th align="center">目标框架名字对象 (TFM)</th> 
   <th align="center">已实现 .NET Standard 版本</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="center">.NET Standard</td> 
   <td align="center">2.1</td> 
   <td align="center">netstandard2.1</td> 
   <td align="center">不可用</td> 
  </tr> 
  <tr> 
   <td align="center">.NET Core</td> 
   <td align="center">3.0</td> 
   <td align="center">netcoreapp3.0</td> 
   <td align="center">2.1</td> 
  </tr> 
  <tr> 
   <td align="center">.NET Framework</td> 
   <td align="center">4.8</td> 
   <td align="center">net48</td> 
   <td align="center">2.0</td> 
  </tr> 
 </tbody> 
</table>

### 支持的目标框架版本 ###

目标框架通常由 TFM 引用。 下表显示 .NET Core SDK 和 NuGet 客户端支持的目标框架。 等效项显示在括号内。 例如，`win81` 对于 `netcore451` 来说等效于 TFM。

<table> 
 <thead> 
  <tr> 
   <th align="left">目标 Framework</th> 
   <th align="left">TFM</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="left">.NET Standard</td> 
   <td align="left">netstandard1.0 netstandard1.1 netstandard1.2 netstandard1.3 netstandard1.4 netstandard1.5 netstandard1.6 netstandard2.0 netstandard2.1</td> 
  </tr> 
  <tr> 
   <td align="left">.NET Core</td> 
   <td align="left">netcoreapp1.0 netcoreapp1.1 netcoreapp2.0 netcoreapp2.1 netcoreapp2.2 netcoreapp3.0</td> 
  </tr> 
  <tr> 
   <td align="left">.NET Framework</td> 
   <td align="left">net11 net20 net35 net40 net403 net45 net451 net452 net46 net461 net462 net47 net471 net472 net48</td> 
  </tr> 
  <tr> 
   <td align="left">Windows 应用商店</td> 
   <td align="left">netcore [netcore45] netcore45 [win] [win8] netcore451 [win81]</td> 
  </tr> 
  <tr> 
   <td align="left">.NET Micro Framework</td> 
   <td align="left">netmf</td> 
  </tr> 
  <tr> 
   <td align="left">Silverlight</td> 
   <td align="left">sl4 sl5</td> 
  </tr> 
  <tr> 
   <td align="left">Windows Phone</td> 
   <td align="left">wp [wp7] wp7 wp75 wp8 wp81 wpa81</td> 
  </tr> 
  <tr> 
   <td align="left">通用 Windows 平台</td> 
   <td align="left">uap [uap10.0] uap10.0 [win10] [netcore50]</td> 
  </tr> 
 </tbody> 
</table>

## 如何让工程支持多个框架？ ##

以单元测试工程为例：

<PropertyGroup>
        <TargetFrameworks>netcoreapp3.0;netcoreapp2.2;netcoreapp3.1;net461</TargetFrameworks>
        <IsPackable>false</IsPackable>
      </PropertyGroup>

如上述代码所示，我们可以通过“TargetFrameworks”元素来定义多个框架。那么如何在工程里面添加条件判断以进行编译呢？

除了工程里面，我们代码中如何针对不同的框架版本编写代码呢？

#if NET461
                return excelPackage.Workbook.Worksheets[typeof(T).GetDisplayName()] ??
                       excelPackage.Workbook.Worksheets[ExcelImporterSettings.SheetName] ??
                       excelPackage.Workbook.Worksheets[1];
    #else
                return excelPackage.Workbook.Worksheets[typeof(T).GetDisplayName()] ??
                       excelPackage.Workbook.Worksheets[ExcelImporterSettings.SheetName] ??
                       excelPackage.Workbook.Worksheets[0];
    #endif

这些“NET461”的符号都有哪些呢？如下所示：

### 完整的 .NET Core 目标框架的预处理器符号列表 ###

<table> 
 <thead> 
  <tr> 
   <th align="left">目标框架</th> 
   <th align="left">符号</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="left">.NET Framework</td> 
   <td align="left"><code>NETFRAMEWORK</code>,&nbsp;<code>NET20</code>,&nbsp;<code>NET35</code>,&nbsp;<code>NET40</code>,&nbsp;<code>NET45</code>,&nbsp;<code>NET451</code>,&nbsp;<code>NET452</code>,&nbsp;<code>NET46</code>,&nbsp;<code>NET461</code>,&nbsp;<code>NET462</code>,&nbsp;<code>NET47</code>,&nbsp;<code>NET471</code>,&nbsp;<code>NET472</code>,&nbsp;<code>NET48</code></td> 
  </tr> 
  <tr> 
   <td align="left">.NET Standard</td> 
   <td align="left"><code>NETSTANDARD</code>,&nbsp;<code>NETSTANDARD1_0</code>,&nbsp;<code>NETSTANDARD1_1</code>,&nbsp;<code>NETSTANDARD1_2</code>,&nbsp;<code>NETSTANDARD1_3</code>,&nbsp;<code>NETSTANDARD1_4</code>,&nbsp;<code>NETSTANDARD1_5</code>,&nbsp;<code>NETSTANDARD1_6</code>,&nbsp;<code>NETSTANDARD2_0</code>,&nbsp;<code>NETSTANDARD2_1</code></td> 
  </tr> 
  <tr> 
   <td align="left">.NET Core</td> 
   <td align="left"><code>NETCOREAPP</code>,&nbsp;<code>NETCOREAPP1_0</code>,&nbsp;<code>NETCOREAPP1_1</code>,&nbsp;<code>NETCOREAPP2_0</code>,&nbsp;<code>NETCOREAPP2_1</code>,&nbsp;<code>NETCOREAPP2_2</code>,&nbsp;<code>NETCOREAPP3_0</code>,&nbsp;<code>NETCOREAPP3_1</code></td> 
  </tr> 
 </tbody> 
</table>

## Magicodes.IE之多框架版本测试 ##

了解了这些知识，我们就可以编写多框架版本的实现和单元测试了。

### 单元测试添加多框架支持 ###

1.  修改TargetFramework为TargetFrameworks
    
    ![TargetFrameworks\_www.wityx.com][TargetFrameworks_www.wityx.com]
2.  设置分组
    
    根据目标框架分组：
    
    ![根据目标框架分组\_www.wityx.com][www.wityx.com 2]
3.  修复编译错误
4.  执行单元测试
    
    单元测试结果如下图所示：
    
    ![单元测试结果\_www.wityx.com][www.wityx.com 3]
    
    针对具体的单元测试，我们还可以指定目标框架进行运行和调试：
    
    ![指定目标框架进行运行和调试\_www.wityx.com][www.wityx.com 4]

## 总结和经验分享 ##

结合整改的过程，我们可以得出以下经验：

1.  单元测试编写时的异常消息判断尽量使用字符串包含判断，而不判断完整格式。

![异常消息不一致\_www.wityx.com][www.wityx.com 5]

如上面所示，左侧代码在net461、netcoreapp2.2都是无法通过的，格式化的参数模板不一致。

1.  特定框架、平台代码需添加符号判断
    
    如下面示例，默认情况下，.NET Core 不提供除代码页 28591 以外的其他任何代码页编码和 Unicode 编码，例如 UTF-8 和 UTF-16，所以我们可以使用以下代码进行添加，但是需要排除.NET Framework：
    
    ![特定平台代码\_www.wityx.com][www.wityx.com 6]
    
    除了特定代码之外，有时还有特定依赖的包：
    
    ![特定依赖\_www.wityx.com][www.wityx.com 7]
2.  慎用新语法糖
    
    比如以下代码：
    
    ![语法差异\_www.wityx.com][www.wityx.com 8]

精力有限，暂不适配过多框架版本，有兴趣的朋友可以参与进来。

[https_github.com_xin-lai_Magicodes.IE]: https://github.com/xin-lai/Magicodes.IE%EF%BC%89%E5%B0%B1%E5%87%BA%E7%8E%B0%E4%BA%86%E4%BB%A5%E4%B8%8B%E9%97%AE%E9%A2%98%EF%BC%9A
[www.wityx.com]: https://docs.xin-lai.com/assets/image-20191210111221404.png
[www.wityx.com 1]: https://docs.xin-lai.com/assets/70544-20191210101512551-48483647.png
[.NET Standard]: https://docs.microsoft.com/zh-cn/dotnet/standard/net-standard
[TargetFrameworks_www.wityx.com]: https://docs.xin-lai.com/assets/image-20191210161715383.png
[www.wityx.com 2]: https://docs.xin-lai.com/assets/image-20191210161814101.png
[www.wityx.com 3]: https://docs.xin-lai.com/assets/image-20191210145622155.png
[www.wityx.com 4]: https://docs.xin-lai.com/assets/image-20191210162009155.png
[www.wityx.com 5]: https://docs.xin-lai.com/assets/image-20191210160338723.png
[www.wityx.com 6]: https://docs.xin-lai.com/assets/image-20191210160806182.png
[www.wityx.com 7]: https://docs.xin-lai.com/assets/image-20191210161516655.png
[www.wityx.com 8]: https://docs.xin-lai.com/assets/image-20191210161352190.png