Xamarin.Forms App Lifecycle のチュートリアル

[アーティクル]
Developer (初級)
完了まで 8 分

このチュートリアルを試行する前に、以下を正常に完了しておく必要があります。

初めての Xamarin.Forms アプリのビルドに関するクイックスタート。
StackLayout のチュートリアル。
Entry のチュートリアル。

このチュートリアルでは、以下の内容を学習します。

開始中、休止中、または再開中のアプリケーションに応答する。
ライフサイクルの状態変化をまたいでデータを保持する。

ライフサイクルの状態変化をまたいでデータを保存する方法を示す簡単なアプリケーションを作成するには、Visual Studio 2019 または Visual Studio for Mac を使用します。次のスクリーンショットは、最終的なアプリケーションです。

ライフサイクルの状態変化に応答する

残り 7 分

Visual Studio
Visual Studio for Mac

このチュートリアルを完了するには、 .NET によるモバイル開発ワークロードがインストールされた、Visual Studio 2019 (最新リリース) が必要です。さらに、iOS でチュートリアルアプリケーションを構築するには、ペアリング済みの Mac が必要になります。 Xamarin プラットフォームのインストールについては、「Xamarin のインストール」を参照してください。 Mac ビルドホストへの Visual Studio 2019 の接続については、「Xamarin.iOS 開発のために Mac とペアリングする」を参照してください。

Visual Studio を起動し、AppLifecycleTutorial という名前の新しい空の Xamarin.Forms アプリを作成します。

重要

このチュートリアルの C# スニペットと XAML スニペットでは、AppLifecycleTutorial という名前のソリューションが必要です。別の名前を使用すると、コードをこのチュートリアルからソリューションにコピーするときに、ビルドエラーが発生します。

作成される .NET Standard ライブラリの詳細については、Xamarin.Forms クイックスタート Deep Dive の「Xamarin.Forms アプリケーションの構造」を参照してください。
ソリューションエクスプローラーの [AppLifecycleTutorial] プロジェクトで、[App.xaml] を展開し、[App.xaml.cs] をダブルクリックして開きます。次に、以下のように [App.xaml.cs] で、OnStart、OnSleep、および OnResume のオーバーライドを更新します。
```
protected override void OnStart()
{
    Console.WriteLine("OnStart");
}

protected override void OnSleep()
{
    Console.WriteLine("OnSleep");
}

protected override void OnResume()
{
    Console.WriteLine("OnResume");
}
```
このコードでは、各メソッドが呼び出されたタイミングを示す Console.WriteLine ステートメントで、アプリケーションのライフサイクルメソッドのオーバーライドを更新します。
- OnStart メソッドは、アプリケーションの起動時に呼び出されます。
- OnSleep メソッドは、アプリケーションがバックグラウンドに移行したときに呼び出されます。
- OnResume メソッドは、アプリケーションがバックグラウンドから再開したときに呼び出されます。
Note

アプリケーションの終了のメソッドはありません。通常の状況では、アプリケーションの終了は OnSleep メソッドから発生します。
Visual Studio ツールバーで、 [開始] ボタン ([再生] ボタンに似た三角形のボタン) を押し、選択したリモート iOS シミュレーターまたは Android エミュレーター内でアプリケーションを起動します。アプリケーションが起動すると、OnStart メソッドが呼び出され、OnStart が Visual Studio の [出力] ウィンドウに出力されます。
```
[Mono] Found as 'java_interop_jnienv_get_object_array_element'.
OnStart
[OpenGLRenderer] HWUI GL Pipeline
```
(iOS または Android では [ホーム] ボタンをタップすることで) アプリケーションがバックグラウンド化されたときに、OnSleep メソッドが呼び出されます。
```
[EGL_emulation] eglMakeCurrent: 0x83ee2920: ver 3 0 (tinfo 0x8357eff0)
OnSleep
[Mono] Image addref System.Runtime.Serialization[0x83ee19c0] -> System.Runtime.Serialization.dll[0x83f57b00]: 2
```
その後、アプリケーションがバックグラウンドから再開した (iOS ではアプリケーションアイコンをタップし、Android では [概要] ボタンをタップして AppLifecycleTutorial アプリケーションを選択した) ときに、OnResume メソッドが呼び出されます。
```
Thread finished: <Thread Pool> #5
OnResume
[EGL_emulation] eglMakeCurrent: 0x83ee2920: ver 3 0 (tinfo 0x8357eff0)
```
Note

これらのコードブロックは、Android でアプリケーションを実行した場合の出力例を示しています。

Visual Studio で、アプリケーションを停止します。

Xamarin.Forms アプリのライフサイクルの詳細については、「Xamarin.Forms アプリのライフサイクル」を参照してください。

このチュートリアルを完了するには、iOS と Android のプラットフォームのサポートがインストールされた Visual Studio for Mac (最新リリース) が必要です。さらに、Xcode (最新リリース) も必要になります。 Xamarin プラットフォームのインストールについて詳しくは、「Xamarin のインストール」を参照してください。

Visual Studio for Mac を起動し、AppLifecycleTutorial という名前の新しい空の Xamarin.Forms アプリを作成します。

重要

このチュートリアルの C# スニペットと XAML スニペットでは、AppLifecycleTutorial という名前のソリューションが必要です。別の名前を使用すると、コードをこのチュートリアルからソリューションにコピーするときに、ビルドエラーが発生します。

作成される .NET Standard ライブラリの詳細については、Xamarin.Forms クイックスタート Deep Dive の「Xamarin.Forms アプリケーションの構造」を参照してください。
Solution Pad の [AppLifecycleTutorial] プロジェクトで、[App.xaml] を展開し、[App.xaml.cs] をダブルクリックして開きます。次に、以下のように [App.xaml.cs] で、OnStart、OnSleep、および OnResume のオーバーライドを更新します。
```
protected override void OnStart()
{
    Console.WriteLine("OnStart");
}

protected override void OnSleep()
{
    Console.WriteLine("OnSleep");
}

protected override void OnResume()
{
    Console.WriteLine("OnResume");
}
```
このコードでは、各メソッドが呼び出されたタイミングを示す Console.WriteLine ステートメントで、アプリケーションのライフサイクルメソッドのオーバーライドを更新します。
- OnStart メソッドは、アプリケーションの起動時に呼び出されます。
- OnSleep メソッドは、アプリケーションがバックグラウンドに移行したときに呼び出されます。
- OnResume メソッドは、アプリケーションがバックグラウンドから再開したときに呼び出されます。
Note

アプリケーションの終了のメソッドはありません。通常の状況では、アプリケーションの終了は OnSleep メソッドから発生します。
Visual Studio for Mac ツールバーで、 [開始] ボタン ([再生] ボタンに似た三角形のボタン) を押し、選択した iOS シミュレーターまたは Android エミュレーター内でアプリケーションを起動します。アプリケーションが起動すると、OnStart メソッドが呼び出され、OnStart が Visual Studio for Mac の [アプリケーション出力] ウィンドウに出力されます。
```
2019-02-11 12:05:23.164761+0000 AppLifecycleTutorial.iOS[4089:361037] SecTaskLoadEntitlements failed error=22 cs_flags=200, pid=4089
2019-02-11 12:05:23.165297+0000 AppLifecycleTutorial.iOS[4089:361037] SecTaskCopyDebugDescription: AppLifecycleTuto[4089]/0#-1 LF=0
2019-02-11 12:05:23.685430+0000 AppLifecycleTutorial.iOS[4089:361037] OnStart
```
(iOS または Android では [ホーム] ボタンをタップすることで) アプリケーションがバックグラウンド化されたときに、OnSleep メソッドが呼び出されます。
```
2019-02-11 12:06:12.394301+0000 AppLifecycleTutorial.iOS[4089:361037] OnSleep
Thread started: <Thread Pool> #3
Thread started: <Thread Pool> #4
Thread started: <Thread Pool> #5
Thread started: <Thread Pool> #6
2019-02-11 12:06:13.056968+0000 AppLifecycleTutorial.iOS[4089:361037] SecTaskLoadEntitlements failed error=22 cs_flags=200, pid=4089
2019-02-11 12:06:13.057264+0000 AppLifecycleTutorial.iOS[4089:361037] SecTaskCopyDebugDescription: AppLifecycleTuto[4089]/0#-1 LF=0
```
その後、アプリケーションがバックグラウンドから再開した (iOS ではアプリケーションアイコンをタップし、Android では [概要] ボタンをタップして AppLifecycleTutorial アプリケーションを選択した) ときに、OnResume メソッドが呼び出されます。
```
2019-02-11 12:07:10.321905+0000 AppLifecycleTutorial.iOS[4130:365695] SecTaskLoadEntitlements failed error=22 cs_flags=200, pid=4130
2019-02-11 12:07:10.322557+0000 AppLifecycleTutorial.iOS[4130:365695] SecTaskCopyDebugDescription: AppLifecycleTuto[4130]/0#-1 LF=0
2019-02-11 12:07:17.110938+0000 AppLifecycleTutorial.iOS[4130:365695] OnResume
```
Note

これらのコードブロックは、iOS でアプリケーションを実行した場合の出力例を示しています。

Visual Studio for Mac で、アプリケーションを停止します。

Xamarin.Forms アプリのライフサイクルの詳細については、「Xamarin.Forms アプリのライフサイクル」を参照してください。

ライフサイクルの状態変化をまたいでデータを保持する

残り 4 分

Application サブクラスには、ライフサイクルの状態の変化を通してデータを格納するために使用できる静的 Properties ディクショナリがあります。このディクショナリでは、string キーが使用され、object 値が格納されます。このディクショナリはデバイスに自動的に保存され、アプリケーションの再起動時にデータが再作成されます。

重要

Properties ディクショナリでは、ストレージ用のプリミティブ型のみをシリアル化できます。

この演習では、バックグラウンド処理時に Entry のテキストを保持し、アプリケーションの再起動時にテキストを Entry に復元するようにアプリケーションを変更します。

Visual Studio
Visual Studio for Mac

ソリューションエクスプローラーの [AppLifecycleTutorial] プロジェクトで、 [App.xaml] を展開し、 [App.xaml.cs] をダブルクリックして開きます。次に、App.xaml.cs のテンプレートコードをすべて削除し、次のコードに置き換えます。
```
using System;
using Xamarin.Forms;

namespace AppLifecycleTutorial
{
    public partial class App : Application
    {
        const string displayText = "displayText";

        public string DisplayText { get; set; }

        public App()
        {
            InitializeComponent();

            MainPage = new MainPage();
        }

        protected override void OnStart()
        {
            Console.WriteLine("OnStart");

            if (Properties.ContainsKey(displayText))
            {
                DisplayText = (string)Properties[displayText];
            }
        }

        protected override void OnSleep()
        {
            Console.WriteLine("OnSleep");
            Properties[displayText] = DisplayText;
        }

        protected override void OnResume()
        {
            Console.WriteLine("OnResume");
        }
    }
}
```
このコードは DisplayText プロパティと displayText 定数を定義します。アプリケーションがバックグラウンド化されるか終了すると、OnSleep メソッドのオーバーライドは displayText のキーに対して DisplayText プロパティ値を Properties ディクショナリに追加します。その後、Properties ディクショナリに displayText キーが含まれていれば、アプリケーションの起動時にそのキーの値が DisplayText プロパティに復元されます。

重要

予期しないエラーを防ぐために、必ず Properties ディクショナリでキーが存在することを確認してからアクセスしてください。

OnResume メソッドのオーバーロードで Properties ディクショナリからデータを復元する必要はありません。これは、アプリケーションがバックグラウンド化されても、アプリケーションとその状態はまだメモリに保持されているためです。
ソリューションエクスプローラーの AppLifecycleTutorial プロジェクトで、 [MainPage.xaml] をダブルクリックして開きます。次に、 [MainPage.xaml] のテンプレートコードをすべて削除し、次のコードに置き換えます。
```
<?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="AppLifecycleTutorial.MainPage">
    <StackLayout Margin="20,35,20,20">
        <Entry x:Name="entry"
               Placeholder="Enter text here"
               Completed="OnEntryCompleted" />
    </StackLayout>
</ContentPage>
```
このコードでは、StackLayout の中の Entry から構成されるページのユーザーインターフェイスを宣言によって定義します。 Entry.Placeholder プロパティは、Entry が最初に表示されたときに表示されるプレースホルダーテキストを指定し、OnEntryCompleted という名前のイベントハンドラーが Completed イベントに登録されます。また、Entry には x:Name 属性で指定された名前があります。これにより、分離コードファイルは、割り当てられた名前を使用して Entry オブジェクトにアクセスできます。
ソリューションエクスプローラーの AppLifecycleTutorial プロジェクトで [MainPage.xaml] を展開し、 [MainPage.xaml.cs] をダブルクリックして開きます。次に、MainPage.xaml.cs で、OnAppearing メソッドのオーバーライドと OnEntryCompleted イベントハンドラーをクラスに追加します。
```
protected override void OnAppearing()
{
    base.OnAppearing();

    entry.Text = (Application.Current as App).DisplayText;
}

void OnEntryCompleted(object sender, EventArgs e)
{
    (Application.Current as App).DisplayText = entry.Text;
}
```
OnAppearing メソッドは App.DisplayText プロパティの値を取得し、それを Entry の Text プロパティ値として設定します。

Note

OnAppearing メソッドのオーバーライドは、ContentPage がレイアウトされた後、それが表示される直前に実行されます。したがって、これは Xamarin.Forms ビューのコンテンツを設定するのに適した場所です。

テキストが Entry で終了したら、Return キーで OnEntryCompleted メソッドを実行します。Entry テキストが App.DisplayText プロパティに格納されます。
Visual Studio ツールバーで、 [開始] ボタン ([再生] ボタンに似た三角形のボタン) を押し、選択したリモート iOS シミュレーターまたは Android エミュレーター内でアプリケーションを起動します。

Entry にテキストを入力してReturn キーを押します。次に、[ホーム] ボタンをタップして OnSleep メソッドを呼び出してアプリケーションをバックグラウンドにします。

Visual Studio で、アプリケーションを停止してからもう一度起動すると、以前に Entry に入力されたテキストが復元されます。

Visual Studio で、アプリケーションを停止します。

Properties ディクショナリへのデータの永続化の詳細については、「Xamarin.Forms の App クラス」ガイドの「Properties ディクショナリ」を参照してください。

Solution Pad の [AppLifecycleTutorial] プロジェクトで、[App.xaml] を展開し、[App.xaml.cs] をダブルクリックして開きます。次に、App.xaml.cs のテンプレートコードをすべて削除し、次のコードに置き換えます。
```
using System;
using Xamarin.Forms;

namespace AppLifecycleTutorial
{
    public partial class App : Application
    {
        const string displayText = "displayText";

        public string DisplayText { get; set; }

        public App()
        {
            InitializeComponent();

            MainPage = new MainPage();
        }

        protected override void OnStart()
        {
            Console.WriteLine("OnStart");

            if (Properties.ContainsKey(displayText))
            {
                DisplayText = (string)Properties[displayText];
            }
        }

        protected override void OnSleep()
        {
            Console.WriteLine("OnSleep");
            Properties[displayText] = DisplayText;
        }

        protected override void OnResume()
        {
            Console.WriteLine("OnResume");
        }
    }
}
```
このコードは DisplayText プロパティと displayText 定数を定義します。アプリケーションがバックグラウンド化されるか終了すると、OnSleep メソッドのオーバーライドは displayText のキーに対して DisplayText プロパティ値を Properties ディクショナリに追加します。その後、Properties ディクショナリに displayText キーが含まれていれば、アプリケーションの起動時にそのキーの値が DisplayText プロパティに復元されます。

重要

予期しないエラーを防ぐために、必ず Properties ディクショナリでキーが存在することを確認してからアクセスしてください。

OnResume メソッドのオーバーロードで Properties ディクショナリからデータを復元する必要はありません。これは、アプリケーションがバックグラウンド化されても、アプリケーションとその状態はまだメモリに保持されているためです。
Solution Pad の AppLifecycleTutorial プロジェクトで、[MainPage.xaml] をダブルクリックして開きます。次に、 [MainPage.xaml] のテンプレートコードをすべて削除し、次のコードに置き換えます。
```
<?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="AppLifecycleTutorial.MainPage">
    <StackLayout Margin="20,35,20,20">
        <Entry x:Name="entry"
               Placeholder="Enter text here"
               Completed="OnEntryCompleted" />
    </StackLayout>
</ContentPage>
```
このコードでは、StackLayout の中の Entry から構成されるページのユーザーインターフェイスを宣言によって定義します。 Entry.Placeholder プロパティは、Entry が最初に表示されたときに表示されるプレースホルダーテキストを指定し、OnEntryCompleted という名前のイベントハンドラーが Completed イベントに登録されます。また、Entry には x:Name 属性で指定された名前があります。これにより、分離コードファイルは、割り当てられた名前を使用して Entry オブジェクトにアクセスできます。
Solution Pad の [AppLifecycleTutorial] プロジェクトで、[MainPage.xaml] を展開し、[MainPage.xaml.cs] をダブルクリックして開きます。次に、MainPage.xaml.cs で、OnAppearing メソッドのオーバーライドと OnEntryCompleted イベントハンドラーをクラスに追加します。
```
protected override void OnAppearing()
{
    base.OnAppearing();

    entry.Text = (Application.Current as App).DisplayText;
}

void OnEntryCompleted(object sender, EventArgs e)
{
    (Application.Current as App).DisplayText = entry.Text;
}
```
OnAppearing メソッドは App.DisplayText プロパティの値を取得し、それを Entry の Text プロパティ値として設定します。

Note

OnAppearing メソッドのオーバーライドは、ContentPage がレイアウトされた後、それが表示される直前に実行されます。したがって、これは Xamarin.Forms ビューのコンテンツを設定するのに適した場所です。

テキストが Entry で終了したら、Return キーで OnEntryCompleted メソッドを実行します。Entry テキストが App.DisplayText プロパティに格納されます。
Visual Studio for Mac ツールバーで、 [開始] ボタン ([再生] ボタンに似た三角形のボタン) を押し、選択した iOS シミュレーターまたは Android エミュレーター内でアプリケーションを起動します。

Entry にテキストを入力してReturn キーを押します。次に、[ホーム] ボタンをタップして OnSleep メソッドを呼び出してアプリケーションをバックグラウンドにします。

Visual Studio for Mac で、アプリケーションを停止してからもう一度起動すると、以前に Entry に入力されたテキストが復元されます。

Visual Studio for Mac で、アプリケーションを停止します。

Properties ディクショナリへのデータの永続化の詳細については、「Xamarin.Forms の App クラス」ガイドの「Properties ディクショナリ」を参照してください。

次の方法で共有

Xamarin.Forms App Lifecycle のチュートリアル

ライフサイクルの状態変化に応答する

ライフサイクルの状態変化をまたいでデータを保持する

おめでとうございます。

次の手順

次の方法で共有

Xamarin.Forms App Lifecycle のチュートリアル

ライフサイクルの状態変化に応答する

ライフサイクルの状態変化をまたいでデータを保持する

おめでとうございます。

次の手順

関連リンク