.NET 6 中 System.Drawing.Common 的改变

09/11/2021 23:37:36 | China Standard Time

由于 libgdiplus 曾经由社区维护，存在许多问题，在 Unix 上效果不是很好。所以从 .NET 6 开始，System.Drawing.Common 将仪在 Windows 上提供支持，但你仍可以通过配置运行时开关在 Unix 上使用这个库。这篇文章将会介绍如何在 Unix 中使用 System.Drawing.Common 并探讨还有哪些更好的替代方案。

如果你升级到了 .NET 6 并且在 Unix 平台使用 `System.Drawing.Common` 那么你将会收到平台兼容性分析仪的警告 `PlatformNotSupportedException` `libgdiplus`, 提示 `System.Drawing.Common` 仅在 Windows 平台可用。

微软的计划如下：
https://github.com/terrajobst/designs/blob/c739fa7c709a1dfd9a7937da025d2a12623272ad/accepted/2021/system-drawing-win-only/system-drawing-win-only.md

## 原文

The proposal is to do the following for .NET 6:

1. **Mark the assembly as only being supported on Windows.** That will cause the platform compatibility analyzer to warn when consumed from a project that isn’t targeting net6.0-windows (or marked as Windows-specific).

1. Throw `PlatformNotSupportedException` when trying to load `libgdiplus` pointing to an aka.ms link with the reasons behind it and recommending stable, well-maintained open-source library alternatives

1. Add an AppContext switch customers can set in their apps or at runtime to re-enable `System.Drawing.Common` via `libgdiplus` on non-Windows platforms.

1. Add targets to the package that when it is restored using a non-windows RID, it warns that we no longer support it on non-windows and point to the aka.ms link with more info.

The challenge is that `System.Drawing.Common` is used by 1st party consumers such as ML.NET, which uses it for image manipulation and even exposes an API that returns a Bitmap. At the same time, `System.Devices.Iot` is in the process of moving to use ImageSharp and so far they had a great migration experience. We need to engage with 1st party customers to see what impact this proposal will have on them.

***Note:** This only affect `System.Drawing.Common` and would leave `System.Drawing.Primitives` as-is. That assembly on contains primitive types that don’t depend on GDI+, such `Rectangle`, `Point`, and `Size`.*

## 在 Unix 平台中启用 System.Drawing.Common

文档中提到了你可以通过 AppContext 配置运行时设置，以便在非 Windows 平台重新启用 System.Drawing.Common，不过并没有提到详细细节。

还好 issues 中可以找到一些有价值的内容，目前有三种解决方案。

## 通过 AppContext 进行配置。

详情：https://github.com/dotnet/designs/pull/234#issuecomment-882043097

你可以在项目中添加以下代码来配置运行时

```csharp
AppContext.SetSwitch("System.Drawing.EnableUnixSupport", true);
```

## 修改配置文件

详情：https://github.com/dotnet/designs/pull/234#issuecomment-882043557

> 以下三种方式，都可以实现相同的效果，你可以根据自己的需求选择合适的方案。

#### 创建 runtimeconfig.json

构建项目时，将在输出目录中生成 [appname].runtimeconfig.json 文件。 如果项目文件所在的文件夹中存在 runtimeconfig.template.json 文件，它包含的任何配置选项都将插入到 [appname].runtimeconfig.json 文件中。 如果自行构建应用，请将所有配置选项放在 runtimeconfig.template.json 文件中。 如果只是运行应用，请将其直接插入 [appname].runtimeconfig.template.json 文件中。

- 在 runtimeconfig.json 文件的 configProperties 部分指定运行时配置选项。

```json
"configProperties": {
	"config-property-name1": "config-value1",
	"config-property-name2": "config-value2"
}
```

- [appname].runtimeconfig.template.json 示例

```json
{
	"runtimeOptions": {
		"tfm": "netcoreapp3.1",
		"framework": {
			"name": "Microsoft.NETCore.App",
			"version": "3.1.0"
		},
		"configProperties": {
			"System.GC.Concurrent": false,
			"System.Threading.ThreadPool.MinThreads": 4,
			"System.Threading.ThreadPool.MaxThreads": 25
		}
	}
}
```

- runtimeconfig.template.json 示例

```json
{
	"configProperties": {
		"System.GC.Concurrent": false,
		"System.Threading.ThreadPool.MinThreads": "4",
		"System.Threading.ThreadPool.MaxThreads": "25"
	}
}
```

#### 修改 MSBuild 属性

可使用 SDK 样式 .NET Core 项目的 .csproj 或 .vbproj 文件中的 MSBuild 属性设置某些运行时配置选项。** MSBuild 属性优先于在 runtimeconfig.template.json 文件中设置的选项。**

```xml
<Project Sdk="Microsoft.NET.Sdk">
	<PropertyGroup>
		<OutputType>Exe</OutputType>
		<TargetFramework>netcoreapp3.1</TargetFramework>
	</PropertyGroup>
	<PropertyGroup>
		<ConcurrentGarbageCollection>false</ConcurrentGarbageCollection>
		<ThreadPoolMinThreads>4</ThreadPoolMinThreads>
		<ThreadPoolMaxThreads>25</ThreadPoolMaxThreads>
	</PropertyGroup>
</Project>
```

#### 配置环境变量

环境变量可用于提供一些运行时配置信息。 **如果使用环境变量配置运行时选项，会将设置应用于所有 .NET Core 应用。**

```txt
# Windows
set DOTNET_GCRetainVM=1

# Powershell
$env:DOTNET_GCRetainVM="1"

# Unix
export DOTNET_GCRetainVM=1
```

## 取消编译警告

你可以通过修改代码或 MSBuild 属性 来忽略平台兼容性分析仪的警告。

- 修改代码

```csharp
#pragma warning disable CA1416 // Validate platform compatibility
...Your code
#pragma warning restore CA1416 // Validate platform compatibility
```

- 修改 MSBuild 属性

你可以在 csproj 中添加 `<NoWarn>` 元素来忽略特定警告。

详情：https://docs.microsoft.com/zh-cn/visualstudio/ide/how-to-suppress-compiler-warnings

![](https://corehome.oss-accelerate.aliyuncs.com/blogs/9734091f-91ed-4339-a706-8eb6f06fceb5.jpg)

## System.Drawing.Common 的替代方案

[![ReadMe Card](https://github-readme-stats.vercel.app/api/pin/?username=SixLabors&repo=ImageSharp)](https://github.com/SixLabors/ImageSharp)

[![ReadMe Card](https://github-readme-stats.vercel.app/api/pin/?username=mono&repo=SkiaSharp)](https://github.com/mono/SkiaSharp)