Xamarin.Forms: Tutorial zu lokalen Datenbanken

Für dieses Tutorial benötigen Sie das neueste Release von Visual Studio 2019 und die Workload Mobile-Entwicklung mit .NET. Außerdem müssen Sie über einen gekoppelten Mac verfügen, um die Tutorial-App unter iOS zu kompilieren. Informationen zur Installation der Xamarin-Plattform finden Sie unter Installieren von Xamarin. Informationen zum Verbinden von Visual Studio 2019 mit einem Mac-Buildhost finden Sie unter Durchführen einer Kopplung mit einem Mac für die Xamarin.iOS-Entwicklung.

1. Starten Sie Visual Studio, und erstellen Sie eine neue leere Xamarin.Forms-App mit dem Namen LocalDatabaseTutorial.

   Wichtig

   Für die C#- und XAML-Codeausschnitte in diesem Tutorial ist es erforderlich, dass die Projektmappe LocalDatabaseTutorial genannt wird. Die Verwendung eines anderen Namens führt zu Buildfehlern, wenn Sie Code aus diesem Tutorial in die Projektmappe kopieren.

   Weitere Informationen zur .NET Standard-Bibliothek, die erstellt wird, finden Sie unter Struktur einer Xamarin.Forms-Anwendung im Artikel Xamarin.Forms: Ausführliche Erläuterungen zum Schnellstart.

2. Klicken Sie im Projektmappen-Explorer mit der rechten Maustaste auf das Projekt LocalDatabaseTutorial und anschließend auf Manage NuGet Packages... (NuGet-Pakete verwalten...).

   

3. Klicken Sie im NuGet-Paket-Manager auf die Registerkarte Durchsuchen, suchen Sie nach dem NuGet-Paket sqlite-net-pcl, wählen Sie es aus, und klicken Sie auf die Schaltfläche Installieren, um es dem Projekt hinzuzufügen:

   

   Hinweis

   Es gibt eine Reihe von NuGet-Paketen mit ähnlichen Namen. Das richtige Paket verfügt über die folgenden Attribute:

   • Ersteller: SQLite-net
   • NuGet-Link: sqlite-net-pcl

   Trotz des Paketnamens kann dieses NuGet-Paket in .NET Standard-Projekten verwendet werden.

   Mit diesem Paket können Datenbankvorgänge in der Anwendung verwendet werden.

   Wichtig

   SQLite.NET ist eine Drittanbieterbibliothek, die vom praeclarum/sqlite-net-Repository unterstützt wird.

4. Erstellen Sie die Projektmappe, um sich zu vergewissern, dass keine Fehler vorliegen.

Für dieses Tutorial benötigen Sie Visual Studio für Mac (neuestes Release) mit Plattformunterstützung für iOS und Android. Zudem ist Xcode (neuestes Release) erforderlich. Weitere Informationen zur Installation der Xamarin-Plattform finden Sie unter Installieren von Xamarin.

1. Starten Sie Visual Studio für Mac, und erstellen Sie eine neue leere Xamarin.Forms-App mit dem Namen LocalDatabaseTutorial.

   Wichtig

   Für die C#- und XAML-Codeausschnitte in diesem Tutorial ist es erforderlich, dass die Projektmappe LocalDatabaseTutorial genannt wird. Die Verwendung eines anderen Namens führt zu Buildfehlern, wenn Sie Code aus diesem Tutorial in die Projektmappe kopieren.

   Weitere Informationen zur .NET Standard-Bibliothek, die erstellt wird, finden Sie unter Struktur einer Xamarin.Forms-Anwendung im Artikel Xamarin.Forms: Ausführliche Erläuterungen zum Schnellstart.

2. Klicken Sie im Lösungspad mit der rechten Maustaste auf das Projekt LocalDatabaseTutorial und anschließend auf Manage NuGet Packages (NuGet-Pakete verwalten):

   

3. Suchen Sie im Fenster Manage NuGet Packages (NuGet-Pakete verwalten) nach dem NuGet-Paket sqlite-net-pcl, wählen Sie es aus, und klicken Sie auf Paket hinzufügen, um es dem Projekt hinzuzufügen:

   

   Hinweis

   Es gibt eine Reihe von NuGet-Paketen mit ähnlichen Namen. Das richtige Paket verfügt über die folgenden Attribute:

   • ID: sqlite-net-pcl
   • Autor: SQLite-net
   • NuGet-Link: sqlite-net-pcl

   Trotz des Paketnamens kann dieses NuGet-Paket in .NET Standard-Projekten verwendet werden.

   Mit diesem Paket können Datenbankvorgänge in der Anwendung verwendet werden.

4. Erstellen Sie die Projektmappe, um sich zu vergewissern, dass keine Fehler vorliegen.

1. Fügen Sie im Projektmappen-Explorer dem Projekt LocalDatabaseTutorial eine neue Klasse mit dem Namen Person hinzu. Entfernen Sie anschließend in Person.cs den gesamten Vorlagencode, und ersetzen Sie ihn durch den folgenden:

   using SQLite;
   
   namespace LocalDatabaseTutorial
   {
       public class Person
       {
           [PrimaryKey, AutoIncrement]
           public int ID { get; set; }
           public string Name { get; set; }
           public int Age { get; set; }
       }
   }
   

   In diesem Codeausschnitt wird eine Person-Klasse definiert, die Daten zu allen Personen in der Anwendung speichert. Die ID-Eigenschaft wird mit den Attributen PrimaryKey und AutoIncrement markiert, um sicherzustellen, dass jede Person-Instanz in der Datenbank über eine eindeutige ID verfügt, die von SQLite.NET vergeben wird.

2. Fügen Sie im Projektmappen-Explorer dem Projekt LocalDatabaseTutorial eine neue Klasse mit dem Namen Database hinzu. Entfernen Sie anschließend in Database.cs den gesamten Vorlagencode, und ersetzen Sie ihn durch den folgenden:

   using System.Collections.Generic;
   using System.Threading.Tasks;
   using SQLite;
   
   namespace LocalDatabaseTutorial
   {
       public class Database
       {
           readonly SQLiteAsyncConnection _database;
   
           public Database(string dbPath)
           {
               _database = new SQLiteAsyncConnection(dbPath);
               _database.CreateTableAsync<Person>().Wait();
           }
   
           public Task<List<Person>> GetPeopleAsync()
           {
               return _database.Table<Person>().ToListAsync();
           }
   
           public Task<int> SavePersonAsync(Person person)
           {
               return _database.InsertAsync(person);
           }
       }
   }
   

   Diese Klasse enthält Code, mit dem die Datenbank erstellt wird und Daten aus ihr gelesen bzw. in sie geschrieben werden. Im Code werden asynchrone SQLite.NET-APIs verwendet, mit denen Datenbankvorgänge in Hintergrundthreads verschoben werden. Außerdem akzeptiert der Database-Konstruktor den Pfad der Datenbankdatei als Argument. Dieser Pfad wird in der nächsten Übung von der App-Klasse bereitgestellt.

3. Erweitern Sie App.xaml im Projektmappen-Explorer im Projekt LocalDatabaseTutorial, und doppelklicken Sie dann auf die Datei App.xaml.cs, um sie zu öffnen. Entfernen Sie anschließend in App.xaml.cs den gesamten Vorlagencode, und ersetzen Sie ihn durch den folgenden:

   using System;
   using System.IO;
   using Xamarin.Forms;
   
   namespace LocalDatabaseTutorial
   {
       public partial class App : Application
       {
           static Database database;
   
           public static Database Database
           {
               get
               {
                   if (database == null)
                   {
                       database = new Database(Path.Combine(Environment.GetFolderPath(Environment.SpecialFolder.LocalApplicationData), "people.db3"));
                   }
                   return database;
               }
           }
   
           public App()
           {
               InitializeComponent();
   
               MainPage = new MainPage();
           }
   
           protected override void OnStart()
           {
               // Handle when your app starts
           }
   
           protected override void OnSleep()
           {
               // Handle when your app sleeps
           }
   
           protected override void OnResume()
           {
               // Handle when your app resumes
           }
       }
   }
   

   In diesem Codeausschnitt wird eine Database-Eigenschaft definiert, mit der eine neue Database-Instanz als Singleton erstellt wird. Als Argumente für den Konstruktor der Database-Klasse werden ein lokaler Dateipfad und ein Dateiname als Speicherort der Datenbank übergeben.

   Wichtig

   Durch das Bereitstellen der Datenbank als Singleton kann eine einzelne Datenbankverbindung erstellt werden, die während der Ausführung der App offen bleibt, sodass der Aufwand für das Öffnen und Schließen der Datenbank beim Ausführen des Datenbankvorgangs vermieden wird.

4. Erstellen Sie die Projektmappe, um sich zu vergewissern, dass keine Fehler vorliegen.

1. Fügen Sie im Lösungspad dem Projekt LocalDatabaseTutorial eine neue Klasse mit dem Namen Person hinzu. Entfernen Sie anschließend in Person.cs den gesamten Vorlagencode, und ersetzen Sie ihn durch den folgenden:

   using SQLite;
   
   namespace LocalDatabaseTutorial
   {
       public class Person
       {
           [PrimaryKey, AutoIncrement]
           public int ID { get; set; }
           public string Name { get; set; }
           public int Age { get; set; }
       }
   }
   

   In diesem Codeausschnitt wird eine Person-Klasse definiert, die Daten zu allen Personen in der Anwendung speichert. Die ID-Eigenschaft wird mit den Attributen PrimaryKey und AutoIncrement markiert, um sicherzustellen, dass jede Person-Instanz in der Datenbank über eine eindeutige ID verfügt, die von SQLite.NET vergeben wird.

2. Fügen Sie im Lösungspad dem Projekt LocalDatabaseTutorial eine neue Klasse mit dem Namen Database hinzu. Entfernen Sie anschließend in Database.cs den gesamten Vorlagencode, und ersetzen Sie ihn durch den folgenden:

   using System.Collections.Generic;
   using System.Threading.Tasks;
   using SQLite;
   
   namespace LocalDatabaseTutorial
   {
       public class Database
       {
           readonly SQLiteAsyncConnection _database;
   
           public Database(string dbPath)
           {
               _database = new SQLiteAsyncConnection(dbPath);
               _database.CreateTableAsync<Person>().Wait();
           }
   
           public Task<List<Person>> GetPeopleAsync()
           {
               return _database.Table<Person>().ToListAsync();
           }
   
           public Task<int> SavePersonAsync(Person person)
           {
               return _database.InsertAsync(person);
           }
       }
   }
   

   Diese Klasse enthält Code, mit dem die Datenbank erstellt wird und Daten aus ihr gelesen bzw. in sie geschrieben werden. Im Code werden asynchrone SQLite.NET-APIs verwendet, mit denen Datenbankvorgänge in Hintergrundthreads verschoben werden. Außerdem akzeptiert der Database-Konstruktor den Pfad der Datenbankdatei als Argument. Dieser Pfad wird in der nächsten Übung von der App-Klasse bereitgestellt.

3. Erweitern Sie App.xaml im Lösungspad im Projekt LocalDatabaseTutorial, und doppelklicken Sie dann auf die Datei App.xaml.cs, um sie zu öffnen. Entfernen Sie anschließend in App.xaml.cs den gesamten Vorlagencode, und ersetzen Sie ihn durch den folgenden:

   using System;
   using System.IO;
   using Xamarin.Forms;
   
   namespace LocalDatabaseTutorial
   {
       public partial class App : Application
       {
           static Database database;
   
           public static Database Database
           {
               get
               {
                   if (database == null)
                   {
                       database = new Database(Path.Combine(Environment.GetFolderPath(Environment.SpecialFolder.LocalApplicationData), "people.db3"));
                   }
                   return database;
               }
           }
   
           public App()
           {
               InitializeComponent();
   
               MainPage = new MainPage();
           }
   
           protected override void OnStart()
           {
               // Handle when your app starts
           }
   
           protected override void OnSleep()
           {
               // Handle when your app sleeps
           }
   
           protected override void OnResume()
           {
               // Handle when your app resumes
           }
       }
   }
   

   In diesem Codeausschnitt wird eine Database-Eigenschaft definiert, mit der eine neue Database-Instanz als Singleton erstellt wird. Als Argumente für den Konstruktor der Database-Klasse werden ein lokaler Dateipfad und ein Dateiname als Speicherort der Datenbank übergeben.

   Wichtig

   Durch das Bereitstellen der Datenbank als Singleton kann eine einzelne Datenbankverbindung erstellt werden, die während der Ausführung der App offen bleibt, sodass der Aufwand für das Öffnen und Schließen der Datenbank beim Ausführen des Datenbankvorgangs vermieden wird.

4. Erstellen Sie die Projektmappe, um sich zu vergewissern, dass keine Fehler vorliegen.

1. Doppelklicken Sie im Projektmappen-Explorer im Projekt LocalDatabaseTutorial auf die Datei MainPage.xaml, um sie zu öffnen. Entfernen Sie dann in MainPage.xaml den gesamten Vorlagencode, und ersetzen Sie ihn durch den folgenden:

   <?xml version="1.0" encoding="utf-8"?>
   <ContentPage xmlns="http://xamarin.com/schemas/2014/forms"
                xmlns:x="http://schemas.microsoft.com/winfx/2009/xaml"
                x:Class="LocalDatabaseTutorial.MainPage">
       <StackLayout Margin="20,35,20,20">
           <Entry x:Name="nameEntry"
                  Placeholder="Enter name" />
           <Entry x:Name="ageEntry"
                  Placeholder="Enter age" />
           <Button Text="Add to Database"
                   Clicked="OnButtonClicked" />
           <CollectionView x:Name="collectionView">
               <CollectionView.ItemTemplate>
                   <DataTemplate>
                       <StackLayout>
                           <Label Text="{Binding Name}"
                                  FontSize="Medium" />
                           <Label Text="{Binding Age}"
                                  TextColor="Silver"
                                  FontSize="Small" />
                       </StackLayout>
                   </DataTemplate>
               </CollectionView.ItemTemplate>
           </CollectionView>
       </StackLayout>
   </ContentPage>
   

   Dieser Code definiert deklarativ die Benutzeroberfläche für die Seite, die aus zwei Entry-Instanzen, einem Button-Objekt und einer CollectionView-Klasse in einer StackLayout-Klasse besteht. Jede Entry-Klasse hat ihre Placeholder-Eigenschaft festgelegt, die den Platzhaltertext angibt, die vor der Benutzereingabe angezeigt wird. Das Button-Objekt legt sein Clicked-Ereignis auf einen Ereignishandler namens OnButtonClicked fest, der im nächsten Schritt erstellt wird. Die CollectionView-Klasse legt ihre ItemTemplate-Eigenschaft auf eine DataTemplate-Klasse fest, die eine StackLayout-Klasse und zwei Label-Objekte verwendet, um die Darstellung der einzelnen Zeilen in der CollectionView-Klasse zu definieren. Die Label-Objekte binden ihre Text-Eigenschaften an die Name- und Age-Eigenschaften des jeweiligen Person-Objekts.

   Außerdem haben die Entry-Instanzen und die CollectionView-Klasse Namen, die mit dem x:Name-Attribut angegeben werden. Dadurch kann die CodeBehind-Datei mithilfe des zugewiesenen Namens auf das Objekt zugreifen.

2. Erweitern Sie MainPage.xaml im Projektmappen-Explorer im Projekt LocalDatabaseTutorial, und doppelklicken Sie dann auf die Datei MainPage.xaml.cs, um sie zu öffnen. Fügen Sie dann in der Datei MainPage.xaml.cs der Klasse die OnAppearing-Außerkraftsetzung und den OnButtonClicked-Ereignishandler hinzu:

   protected override async void OnAppearing()
   {
       base.OnAppearing();
       collectionView.ItemsSource = await App.Database.GetPeopleAsync();
   }
   
   async void OnButtonClicked(object sender, EventArgs e)
   {
       if (!string.IsNullOrWhiteSpace(nameEntry.Text) && !string.IsNullOrWhiteSpace(ageEntry.Text))
       {
           await App.Database.SavePersonAsync(new Person
           {
               Name = nameEntry.Text,
               Age = int.Parse(ageEntry.Text)
           });
   
           nameEntry.Text = ageEntry.Text = string.Empty;
           collectionView.ItemsSource = await App.Database.GetPeopleAsync();
       }
   }
   

   Die OnAppearing-Methode befüllt die CollectionView-Klasse mit sämtlichen Daten, die in der Datenbank gespeichert sind. Die OnButtonClicked-Methode, die ausgeführt wird, wenn auf das Button-Objekt getippt wird, speichert die eingegebenen Daten in der Datenbank, bevor beide Entry-Instanzen gelöscht werden, und aktualisiert die Daten in der CollectionView-Klasse.

   Hinweis

   Die Außerkraftsetzung der OnAppearing-Methode wird ausgeführt, nachdem die ContentPage-Klasse angelegt wurde, aber noch bevor sie angezeigt wird. Daher eignet sich diese Position gut, um den Inhalt von Xamarin.Forms-Ansichten festzulegen.

3. Klicken Sie in der Symbolleiste von Visual Studio auf die Schaltfläche zum Starten (die dreieckige Schaltfläche, die einer Wiedergabetaste ähnelt), um die Anwendung im ausgewählten iOS-Remotesimulator oder Android-Emulator zu starten:

   Geben Sie mehrere Datenelemente ein, und tippen Sie für jedes Datenelement auf das Button-Objekt. Dadurch werden die Daten in der Datenbank gespeichert, und die CollectionView-Klasse wieder mit allen Daten der Datenbank befüllt:

   

   Beenden Sie die Anwendung in Visual Studio.

   Weitere Informationen zu lokalen Datenbanken in Xamarin.Forms finden Sie unter Lokale Xamarin.Forms-Datenbanken (Leitfaden)

1. Doppelklicken Sie im Lösungspad im Projekt LocalDatabaseTutorial auf die Datei MainPage.xaml, um sie zu öffnen. Entfernen Sie dann in MainPage.xaml den gesamten Vorlagencode, und ersetzen Sie ihn durch den folgenden:

   <?xml version="1.0" encoding="utf-8"?>
   <ContentPage xmlns="http://xamarin.com/schemas/2014/forms"
                xmlns:x="http://schemas.microsoft.com/winfx/2009/xaml"
                x:Class="LocalDatabaseTutorial.MainPage">
       <StackLayout Margin="20,35,20,20">
           <Entry x:Name="nameEntry"
                  Placeholder="Enter name" />
           <Entry x:Name="ageEntry"
                  Placeholder="Enter age" />
           <Button Text="Add to Database"
                   Clicked="OnButtonClicked" />
           <CollectionView x:Name="collectionView">
               <CollectionView.ItemTemplate>
                   <DataTemplate>
                       <StackLayout>
                           <Label Text="{Binding Name}"
                                  FontSize="Medium" />
                           <Label Text="{Binding Age}"
                                  TextColor="Silver"
                                  FontSize="Small" />
                       </StackLayout>
                   </DataTemplate>
               </CollectionView.ItemTemplate>
           </CollectionView>
       </StackLayout>
   </ContentPage>
   

   Dieser Code definiert deklarativ die Benutzeroberfläche für die Seite, die aus zwei Entry-Instanzen, einem Button-Objekt und einer CollectionView-Klasse in einer StackLayout-Klasse besteht. Jede Entry-Klasse hat ihre Placeholder-Eigenschaft festgelegt, die den Platzhaltertext angibt, die vor der Benutzereingabe angezeigt wird. Das Button-Objekt legt sein Clicked-Ereignis auf einen Ereignishandler namens OnButtonClicked fest, der im nächsten Schritt erstellt wird. Die CollectionView-Klasse legt ihre ItemTemplate-Eigenschaft auf eine DataTemplate-Klasse fest, die eine StackLayout-Klasse und zwei Label-Objekte verwendet, um die Darstellung der einzelnen Zeilen in der CollectionView-Klasse zu definieren. Die Label-Objekte binden ihre Text-Eigenschaften an die Name- und Age-Eigenschaften des jeweiligen Person-Objekts.

   Außerdem haben die Entry-Instanzen und die ListView-Klasse Namen, die mit dem x:Name-Attribut angegeben werden. Dadurch kann die CodeBehind-Datei mithilfe des zugewiesenen Namens auf das Objekt zugreifen.

2. Erweitern Sie MainPage.xaml im Lösungspad im Projekt LocalDatabaseTutorial, und doppelklicken Sie dann auf die Datei MainPage.xaml.cs, um sie zu öffnen. Fügen Sie dann in der Datei MainPage.xaml.cs der Klasse die OnAppearing-Außerkraftsetzung und den OnButtonClicked-Ereignishandler hinzu:

   protected override async void OnAppearing()
   {
       base.OnAppearing();
       collectionView.ItemsSource = await App.Database.GetPeopleAsync();
   }
   
   async void OnButtonClicked(object sender, EventArgs e)
   {
       if (!string.IsNullOrWhiteSpace(nameEntry.Text) && !string.IsNullOrWhiteSpace(ageEntry.Text))
       {
           await App.Database.SavePersonAsync(new Person
           {
               Name = nameEntry.Text,
               Age = int.Parse(ageEntry.Text)
           });
   
           nameEntry.Text = ageEntry.Text = string.Empty;
           collectionView.ItemsSource = await App.Database.GetPeopleAsync();
       }
   }
   

   Die OnAppearing-Methode befüllt die CollectionView-Klasse mit sämtlichen Daten, die in der Datenbank gespeichert sind. Die OnButtonClicked-Methode, die ausgeführt wird, wenn auf das Button-Objekt getippt wird, speichert die eingegebenen Daten in der Datenbank, bevor beide Entry-Instanzen gelöscht werden, und aktualisiert die Daten in der CollectionView-Klasse.

   Hinweis

   Die Außerkraftsetzung der OnAppearing-Methode wird ausgeführt, nachdem die ContentPage-Klasse angelegt wurde, aber noch bevor sie angezeigt wird. Daher eignet sich diese Position gut, um den Inhalt von Xamarin.Forms-Ansichten festzulegen.

3. Klicken Sie in der Symbolleiste von Visual Studio für Mac auf die Schaltfläche zum Starten (die dreieckige Schaltfläche, die einer Wiedergabetaste ähnelt), um die Anwendung im ausgewählten iOS-Simulator oder Android-Emulator zu starten:

   Geben Sie mehrere Datenelemente ein, und tippen Sie für jedes Datenelement auf das Button-Objekt. Dadurch werden die Daten in der Datenbank gespeichert, und die CollectionView-Klasse wieder mit allen Daten der Datenbank befüllt:

   

   Beenden Sie die Anwendung in Visual Studio für Mac.

   Weitere Informationen zu lokalen Datenbanken in Xamarin.Forms finden Sie unter Lokale Xamarin.Forms-Datenbanken (Leitfaden)