警告文

本文

この記事は祝 .NET 6 GA！(中略) Advent Calendar 2021 8 日目の記事です。
まあこの書き出しを書いている時点で既に 11 日なんですけどね……

日本時間 2021/11/08 に .NET 6 と Visual Studio 2022 がリリースされましたが、一方で Xamarin の余命宣告がされました。
サポート期限は2 年後の 2023/11 まで 2024/5/1 まで^[1]、それまでにまだリリースもされていない後継フレームワークMAUI への移行を済ませる必要があります。
https://devblogs.microsoft.com/xamarin/whats-new-in-xamarin-and-visual-studio-2022/

MAUI は .NET 6 以降のみのサポートとなる^[2]ため、従来の Xamarin.Forms から MAUI へ移行する場合、実行環境とフレームワークを同時に更新することとなり、両者の破壊的変更に悩まされることが予想されます。
この記事では MAUI への移行に備え、フレームワークを Xamarin.Forms のまま実行環境のみを .NET 6 に移行する手順を紹介します。

.NET 6 に移行すると何が変わる？

実際に移行する前に、.NET 6 に移行することで何が変わるのか確認しましょう。

🟦 フレームワークは Xamarin.Forms のまま

.NET 6 に移行したからといって Xamarin.Forms 側で特に変わることはありません。
サポート期限も変わらず 2024/5/1 です。
ちなみに次の LTS バージョンである .NET 8 のリリース予定は 2023/11 です。

⚠️ 実行環境が Mono から .NET 6 に

これにより、従来のnetstandard2.1やプラットフォーム固有のライブラリに加え、netcoreappnet5.0net6.0 のライブラリを使用できます。
ただし冒頭に記述した通りxamariniosxamarinmacxamarintvos のライブラリは .NET 6 で使用できなくなってしまっています。
.NET 6 向けビルドが提供されていない Xamarin.Forms も使用できないため、iOS / Mac / tvOS 向けビルドが必要な場合は MAUI への移行も同時に行いましょう。
また互換性のあるはずのmonoandroid などのライブラリであってもnetcoreapp 向けのバイナリを参照してしまう場合があるため、ライブラリの扱いには注意が必要です。

https://github.com/xamarin/XamarinCommunityToolkit/issues/985

その他にも細かい破壊的変更が多数含まれているため注意が必要です。

筆者が特に注意が必要と考えている破壊的変更は以下の 2 つです。
アプリケーションコードで使用していない場合でもサードパーティ製ライブラリで利用している可能性もあるため気を付けましょう。

• DeflateStream、GZipStream、CryptoStream での部分的な読み取りとゼロバイトの読み取り
• System.Drawing.Common が Windows でしかサポートされない

https://docs.microsoft.com/ja-jp/dotnet/core/compatibility/breaking-changes

⚠️.csproj は SDK-style のみサポート

Visual Studio 2017 以降.csproj に SDK-style と呼ばれる新しい書き方が増え、これまで冗長で人の読めるものではなかった.csproj が整理されました。
この書き方は .NET Standard や .NET Core のプロジェクトではデフォルトで反映され、.NET Framework でも自分で書き換えれば利用できましたが、Xamarin の各プラットフォーム向けプロジェクトでは利用できませんでした。
.NET 6 へ移行する場合は SDK-style への移行が必須になります。
と言ってもほとんど自動で直してくれるので、手で直す箇所はほんの数行です。

https://ufcpp.net/blog/2017/5/newcsproj/

✅ 既定の C# バージョンが 8.0 から 10.0 に

従来の Xamarin.Forms でも手順を踏めば C# 10.0 の機能を利用できましたが、その手順が少々面倒であったり、ランタイム側の修正を伴うクラスの共変戻り値が利用できなかったりしていました。
.NET 6 ではデフォルトで C# 10.0 の機能が全て利用できます。
レコード型やnot パターン、ファイル スコープ名前空間など便利な機能がたくさん増えているので、積極的に使っていきましょう。

https://ufcpp.net/study/csharp/cheatsheet/ap_ver9/
https://ufcpp.net/study/csharp/cheatsheet/ap_ver10/

⚠️ Visual Studio 2019 でのビルドが不可能に

Visual Studio 2019 では .NET 6 アプリケーションのビルドはサポートされていないので、.NET 6 に移行すると当然ビルドができなくなってしまいます。
しかも厄介なことに 2019 でビルドしようとするとbinobj フォルダが壊れてしまうようで、壊れてしまったこれらのフォルダを削除しないと 2022 でもビルドが通らなくなります。
気を付けましょう。（1 敗）

Xamarin.Forms プロジェクトを .NET 6 へ移行する

違いがわかったところで .NET 6 への移行を始めましょう。

0. 前提条件

下記の手順は Visual Studio 2022 v17.4.1 及び .NET v6.0.202 で動作確認をしています。
Visual Studio for Mac での動作確認はしていないため、注意してください。
https://visualstudio.microsoft.com/

また実際に移行した際のソースコードはgithub.com/proudust/XamarinSandbox にあります。

1.dotnet workload コマンドで Android / iOS ワークロードをインストール

MAUI リリース前のバージョンの Visual Studio 2022 を使用する場合、.NET 6 の Android / iOS サポートを別途インストールする必要があります。
以下のコマンドでインストールできます。

dotnet workload install androiddotnet workload install ios

2..csproj を SDK-style に移行する

各プラットフォーム固有のプロジェクトの.csproj を SDK-style のような形式に移行して回ります。
.NET アップグレード アシスタントで移行してしまうのが早いです。
https://docs.microsoft.com/ja-jp/dotnet/core/porting/upgrade-assistant-overview

$ dotnet tool install -g upgrade-assistant$ rd /s /q XamarinSandbox\XamarinSandbox.Android\bin XamarinSandbox\XamarinSandbox.Android\obj$ upgrade-assistant upgrade XamarinSandbox\XamarinSandbox.Android\XamarinSandbox.Android.csproj$ rd /s /q XamarinSandbox\XamarinSandbox.iOS\bin XamarinSandbox\XamarinSandbox.iOS\obj$ upgrade-assistant upgrade XamarinSandbox\XamarinSandbox.iOS\XamarinSandbox.iOS.csproj

$ dotnet tool install -g upgrade-assistant$ rmdir -r XamarinSandbox/XamarinSandbox.Android/bin XamarinSandbox/XamarinSandbox.Android/obj$ upgrade-assistant upgrade XamarinSandbox/XamarinSandbox.Android/XamarinSandbox.Android.csproj$ rmdir -r XamarinSandbox/XamarinSandbox.iOS/bin XamarinSandbox/XamarinSandbox.iOS/obj$ upgrade-assistant upgrade XamarinSandbox/XamarinSandbox.iOS/XamarinSandbox.iOS.csproj

<ProjectSdk="Microsoft.NET.Sdk">

<ProjectDefaultTargets="Build"ToolsVersion="4.0"xmlns="http://schemas.microsoft.com/developer/msbuild/2003">

3..csproj を手作業で修正

下記のように変更します。

共有プロジェクト

• TargetFramework をnet6.0 に変更
• (Xamarin.Forms.Visual.Material を参照している場合のみ)XFDisableTargetFrameworkValidation をTrue で追加

<PropertyGroup>-<TargetFramework>netstandard2.0</TargetFramework>+<TargetFramework>net6.0</TargetFramework>+<XFDisableTargetFrameworkValidation>True</XFDisableTargetFrameworkValidation></PropertyGroup>

Android プロジェクト

• TargetFramework をnet6.0-android に変更
• PropertyGroup に<GenerateAssemblyInfo>false</GenerateAssemblyInfo> を追加
• RootNamespace をアップグレード前の値で追加
• (Xamarin.Forms.Visual.Material を参照している場合のみ)XFDisableTargetFrameworkValidation をTrue で追加

<PropertyGroup>-<TargetFramework>net6.0</TargetFramework>+<TargetFramework>net6.0-android</TargetFramework>+<GenerateAssemblyInfo>false</GenerateAssemblyInfo>+<RootNamespace>XamarinSandbox.Droid</RootNamespace>+<XFDisableTargetFrameworkValidation>True</XFDisableTargetFrameworkValidation></PropertyGroup>

iOS プロジェクト

• TargetFramework をnet6.0-ios に変更
• PropertyGroup に<GenerateAssemblyInfo>false</GenerateAssemblyInfo> を追加
• (Xamarin.Forms.Visual.Material を参照している場合のみ)XFDisableTargetFrameworkValidation をTrue で追加

<PropertyGroup>-<TargetFramework>net6.0</TargetFramework>+<TargetFramework>net6.0-ios</TargetFramework>+<GenerateAssemblyInfo>false</GenerateAssemblyInfo>+<XFDisableTargetFrameworkValidation>True</XFDisableTargetFrameworkValidation></PropertyGroup>

4. Visual Studio でソリューションを開き、構成マネージャを開く

ここまで行った後、Visual Studio 2022 でソリューションを開くと、「現在のソリューションには、正しくない構成マッピングが含まれています。（後略）」という表示が出ます。
指示に従い構成マネージャを開き、そのまま何も変更せずに閉じ、すべて保存します。
それだけでXamarinSandbox.sln が修正されるので、これで完了です。

Ex. 本当に .NET 6 になったのか確かめてみる

せっかくなので本当に .NET 6 が Android や iOS 上で動作しているのか確かめてみましょう。

従来の Xamarin では .NET の Linux 向け実装である Mono が使用されていました。
その Mono に含まれるMono.Runtime クラスのRuntime.GetDisplayName() クラスをリフレクションで取得し、実行することで確かめてみましょう。
下記のようなコードで取得することができます。^[4]

string monoVersion= Type.GetType("Mono.Runtime")?.GetMethods().FirstOrDefault(x=> x.Name=="GetDisplayName")?.Invoke(null,null)?.ToString();string dotnetVersion= Environment.Version.ToString();

移行前後で実行してみると以下のような情報が取得できます。

というわけで本物の .NET 6 が動いているようです。

Virtual cockadoodledoo