Migration von Xamarin auf .NET MAUI

Bei der Entwicklung von Mobile Apps im Cross Platform-Ansatz gibt es verschiedene Möglichkeiten, Technologien und Frameworks, aus denen man wählen kann. Wer auf C# und die .NET-Plattform setzen möchte, hat sich vor einigen Jahren womöglich für das Xamarin Framework entschieden. 2011 zunächst als unabhängiges Unternehmen gegründet, wurde es 2016 von Microsoft gekauft und konsequent weiterentwickelt. Mit der .NET Multi-platform App UI (.NET MAUI) ist im Mai 2023 der geistige Nachfolger des Xamarin Frameworks erschienen. In diesem Artikel schauen wir uns an, welche Gründe für eine Migration sprechen, welche Schritte dafür notwendig sind und welches Potential darin steckt.

Zusätzlich kann plattform-spezifischer Code entweder durch Datei-basiertes Multi Targeting in verschiedenen Dateien (YourClass.Android.cs, YourClass.iOS.cs) abgelegt oder durch Conditional Compilation innerhalb einer Datei aufgerufen werden:

public class YourClass
{
    public void YourMethod()
    {
#if ANDROID
        // Code for Android
#elif IOS
        // Code for iOS
#endif       
    }
}

Zur Einbindung von Bildern und Grafiken war es bisher notwendig, für jede unterstützte Plattform eigene Assets zu hinterlegen, bei Rastergrafiken ggf. noch jeweils in unterschiedlichen Größen.

Das ist mit .NET MAUI nun nicht mehr notwendig. Ein Bild oder eine Grafik muss nur noch in einer Basisgröße im Projekt hinterlegt werden, z.B. als SVG-Datei. Den Rest übernimmt dann das Tooling: Beim Kompilieren werden die Grafiken für die verschiedenen Plattformen automatisch erzeugt.

Ob ein Projekt bereits auf das SDK Style-Format umgestellt wurde, ist an der Struktur der *.csproj-Datei einfach zu erkennen:

<?xml version="1.0" encoding="utf-8"?>
<Project ToolsVersion="15.0" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
    <!— (...) -->
</Project>

<Project Sdk="Microsoft.NET.Sdk">
    <!— (...) -->
</Project>

Es mag verlockend sein, bei der Umstellung auf .NET MAUI direkt das volle Potential des Frameworks ausschöpfen zu wollen. Es empfiehlt sich jedoch, den Fokus zunächst darauf zu legen, frühestmöglich wieder eine lauffähige Anwendung zu haben und nicht notwendige Anpassungen vorerst zu vertagen. Dazu zählen

Um die Migration zu .NET MAUI zu unterstützen, hat Microsoft den .NET Upgrade Assistant um die Unterstützung für .NET MAUI-Projekte erweitert. Abhängig davon wie komplex ein Projekt ist, kann man damit bereits Erfolg haben. Das Tool wird sowohl als Extension für Visual Studio als auch als Command Line Tool angeboten. Es bietet neben der „In Place“-Option auch die Möglichkeit, ein Projekt „side-by-side“ zu migrieren. Dabei bleiben die ursprünglichen Projektdateien während der Migration zunächst erhalten. Das erlaubt einem, den migrierten Stand jederzeit mit dem alten Stand zu vergleichen.

Auch wenn das Tool einen Teil der Migration übernimmt, sind im Anschluss höchstwahrscheinlich noch manuelle Nacharbeiten nötig.

Falls die Migration der App mit den .NET Upgrade Assistant nicht erfolgreich verläuft, gibt es die Möglichkeit der manuellen Migration.

Als erstes muss das Target-Framework der vorhandenen Projekte auf .NET 8 umgestellt werden. Das geht am einfachsten, indem Sie in Visual Studio für jedes Projekt zunächst eine neue .NET MAUI Class Library erstellen und die ursprünglichen Projektdateien in das neue Projekt kopieren:

HINWEIS:
Durch die Umstellung eines Projekts auf .NET 8 kann es notwendig sein, NuGet-Pakete ebenfalls auf eine Version zu aktualisieren, die mit .NET 8 kompatibel ist. Ist keine .NET 8-kompatible Version einer Bibliothek verfügbar, muss sie gegebenenfalls durch eine andere Bibliothek ersetzt werden.

Im nächsten Schritt müssen in allen Klassen die Xamarin.Forms.* Namespace-Definitionen durch die neuen Microsoft.Maui Namespaces ersetzt werden. Ein Einfaches „Suchen und Ersetzen“ wird hier jedoch nicht funktionieren, da in .NET MAUI auch Teile des Frameworks konsolidiert und in neue Namespaces umgezogen wurden. Eine genaue Übersicht über die neuen Namespaces gibt es hier.

Zusätzlich muss der Default-Namespace in Layout-Dateien (XAML) (vorher xmlns=“http://xamarin.com/schemas/2014/forms“) angepasst werden:

<ContentPage   xmlns="http://schemas.microsoft.com/dotnet/2021/maui"
                    (...) >
     <!-- (Page content) -->
</ContentPage>

Neben dem Umzug von Komponenten in andere Namespaces haben sich in .NET MAUI auch einige APIs geändert. Dazu zählen unter anderem:

Dementsprechend können weitere Angleichungen am Code notwendig sein. Eine gute Übersicht über potenziell notwendige Maßnahmen gibt es hier.

Eine gute Nachricht gibt es noch zu Xamarin Essentials: Die Bibliothek, die Xamarin.Forms um viele Basis- und Plattformfunktionalitäten erweitert, musste üblicherweise separat nachinstalliert werden. Das hat sich bei .NET MAUI nun geändert. Ihre Funktionen wurden direkt in das Framework integriert.

Zum Schluss sollte die App ausgiebig getestet werden. Auch wenn .NET MAUI im Vergleich zu Xamarin.Forms in vielerlei Hinsicht eine Verbesserung darstellt, ist das Framework nicht perfekt. Einen Überblick über bereits bekannte Herausforderungen finden Sie auf github.