Xamarin FormsでAndroidのプリファレンスにデータを登録してみた。

こんにちは。コタツです。

今回は、Androidで開発している人なら必ず使っている機能「プリファレンス」へXamarin Formsから登録をしてみました。

Xamarin Forms 側

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

namespace Sample
{
    /// <summary>
    /// ローカルデータを操作するインターフェース
    /// </summary>
    public interface ILocalData
    {
        /// <summary>
        /// ローカルにデータを保存します。
        /// </summary>
        /// <param name="sKey">キー</param>
        /// <param name="sValue">バリュー</param>
        void SaveData(string sKey, string sValue);

        /// <summary>
        /// ローカルデータを取得します。
        /// </summary>
        /// <param name="sKey">キー</param>
        /// <returns>バリュー</returns>
        string LoadData(string sKey);
    }
}

using System;

using System.Collections.Generic;

using System.Linq;

using System.Text;

using System.Threading.Tasks;

namespace Sample

{

/// <summary>

/// ローカルデータを操作するインターフェース

/// </summary>

public interface ILocalData

{

/// <summary>

/// ローカルにデータを保存します。

/// </summary>

/// <param name="sKey">キー</param>

/// <param name="sValue">バリュー</param>

void SaveData(string sKey, string sValue);

/// <summary>

/// ローカルデータを取得します。

/// </summary>

/// <param name="sKey">キー</param>

/// <returns>バリュー</returns>

string LoadData(string sKey);

}

Xamarin Formsの「DependencyService」の機能を使用して実装します。「DependencyService」とはiOS／Androidの各プラットフォーム固有の機能を実装する方法ですが、「DependencyService」の説明に関してはここでは省かせていただきます。

Xamarin Forms側でインターフェースを定義します。「SaveData()」メソッドでキー、バリューを引数にしてプリファレンスに保存します。「LoadData()」メソッドで引数のキーでプリファレンスに保存しているデータを取得します。

Android 側

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;

using Android.App;
using Android.Content;
using Android.OS;
using Android.Runtime;
using Android.Views;
using Android.Widget;

namespace Sample
{
    /// <summary>
    /// Androidの共通情報を管理するクラスです。
    /// </summary>
    public class CCommonModel_Droid
    {
        #region プロパティ

        /// <summary>
        /// メインアクティビティ
        /// </summary>
        public Activity MainAct { set; get; }

        /// <summary>
        /// 共通情報
        /// </summary>
        public static CCommonModel_Droid Instance;

       #endregion

        #region コンストラクタ

        /// <summary>
        /// コンストラクタ
        /// </summary>
        public CCommonModel_Droid()
        {
        }

        #endregion

        #region メソッド

        /// <summary>
        /// 初期処理をします。
        /// </summary>
        public static void Init()
        {
            Instance = new CCommonModel_Droid();
        }

        #endregion
    }
}

using System;

using System.Collections.Generic;

using System.Linq;

using System.Text;

using Android.App;

using Android.Content;

using Android.OS;

using Android.Runtime;

using Android.Views;

using Android.Widget;

namespace Sample

{

/// <summary>

/// Androidの共通情報を管理するクラスです。

/// </summary>

public class CCommonModel_Droid

{

#region プロパティ

/// <summary>

/// メインアクティビティ

/// </summary>

public Activity MainAct { set; get; }

/// <summary>

/// 共通情報

/// </summary>

public static CCommonModel_Droid Instance;

#endregion

#region コンストラクタ

/// <summary>

/// コンストラクタ

/// </summary>

public CCommonModel_Droid()

{

}

#endregion

#region メソッド

/// <summary>

/// 初期処理をします。

/// </summary>

public static void Init()

{

Instance = new CCommonModel_Droid();

}

#endregion

}

Android側でAdMobインターステイシャル広告を操作するクラス「CCommonModel_Droid.cs」を作成します。このクラスはメモリ上に保管します。

CCommonModel_Droid.Init();
CCommonModel_Droid.GetInstance().MainAct = this;

1 2	CCommonModel_Droid.Init(); CCommonModel_Droid.GetInstance().MainAct = this;

AndroidのMainActivityに上記のソースを追加してください。

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;

using Android.App;
using Android.Content;
using Android.OS;
using Android.Runtime;
using Android.Views;
using Android.Widget;

using Xamarin.Forms;
using Sample;

[assembly: Dependency(typeof(CLocalDataCtrl_Droid))]
namespace Sample
{
    public class CLocalDataCtrl_Droid : ILocalData
    {
        #region メソッド

        /// <summary>
        /// ローカルにデータを保存します。
        /// </summary>
        /// <param name="sKey">キー</param>
        /// <param name="sValue">バリュー</param>
        public void SaveData(string sKey, string sValue)
        {
            var sp = CCommonModel_Droid.GetInstance().MainAct.GetPreferences(FileCreationMode.Private);
            var edit = sp.Edit();
            edit.PutString(sKey, sValue);
            edit.Commit();
        }

        /// <summary>
        /// ローカルデータを取得します。
        /// </summary>
        /// <param name="sKey">キー</param>
        /// <returns>バリュー</returns>
        public string LoadData(string sKey)
        {
            var sp = CCommonModel_Droid.GetInstance().MainAct.GetPreferences(FileCreationMode.Private);
            var str = sp.GetString(sKey, null);
            return str;
        }

        #endregion
    }
}

using System;

using System.Collections.Generic;

using System.Linq;

using System.Text;

using Android.App;

using Android.Content;

using Android.OS;

using Android.Runtime;

using Android.Views;

using Android.Widget;

using Xamarin.Forms;

using Sample;

[assembly: Dependency(typeof(CLocalDataCtrl_Droid))]

namespace Sample

{

public class CLocalDataCtrl_Droid : ILocalData

{

#region メソッド

/// <summary>

/// ローカルにデータを保存します。

/// </summary>

/// <param name="sKey">キー</param>

/// <param name="sValue">バリュー</param>

public void SaveData(string sKey, string sValue)

{

var sp = CCommonModel_Droid.GetInstance().MainAct.GetPreferences(FileCreationMode.Private);

var edit = sp.Edit();

edit.PutString(sKey, sValue);

edit.Commit();

}

/// <summary>

/// ローカルデータを取得します。

/// </summary>

/// <param name="sKey">キー</param>

/// <returns>バリュー</returns>

public string LoadData(string sKey)

{

var sp = CCommonModel_Droid.GetInstance().MainAct.GetPreferences(FileCreationMode.Private);

var str = sp.GetString(sKey, null);

return str;

}

#endregion

}

「CLocalDataCtrl_Droid.cs」は「DependencyService」での呼び出し側となります。メモリ上の「CCommonModel_Droid」クラスを呼び出して実装しています。

プリファレンスへの保存方法

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

using Xamarin.Forms;
namespace Sample
{
    /// <summary>
    /// ローカルデータを操作するクラスです。
    /// </summary>
    public class CLocalDataCtrl
    {
        #region コンストラクタ

        /// <summary>
        /// コンストラクタ
        /// </summary>
        public CLocalDataCtrl()
        {
        }

        #endregion

        #region メソッド

        /// <summary>
        /// ローカルにデータを保存します。
        /// </summary>
        /// <param name="sKey">キー</param>
        /// <param name="sValue">バリュー</param>
        public void SaveData(string sKey, string sValue)
        {
            var depemdemcy = DependencyService.Get<ILocalData>();
            depemdemcy.SaveData(sKey, sValue);
        }

        /// <summary>
        /// ローカルデータを取得します。
        /// </summary>
        /// <param name="sKey">キー</param>
        /// <returns>バリュー</returns>
        public string LoadData(string sKey)
        {
            var depemdemcy = DependencyService.Get<ILocalData>();
            return depemdemcy.LoadData(sKey);
        }

        #endregion
    }
}

using System;

using System.Collections.Generic;

using System.Linq;

using System.Text;

using System.Threading.Tasks;

using Xamarin.Forms;

namespace Sample

{

/// <summary>

/// ローカルデータを操作するクラスです。

/// </summary>

public class CLocalDataCtrl

{

#region コンストラクタ

/// <summary>

/// コンストラクタ

/// </summary>

public CLocalDataCtrl()

{

}

#endregion

#region メソッド

/// <summary>

/// ローカルにデータを保存します。

/// </summary>

/// <param name="sKey">キー</param>

/// <param name="sValue">バリュー</param>

public void SaveData(string sKey, string sValue)

{

var depemdemcy = DependencyService.Get<ILocalData>();

depemdemcy.SaveData(sKey, sValue);

}

/// <summary>

/// ローカルデータを取得します。

/// </summary>

/// <param name="sKey">キー</param>

/// <returns>バリュー</returns>

public string LoadData(string sKey)

{

var depemdemcy = DependencyService.Get<ILocalData>();

return depemdemcy.LoadData(sKey);

}

#endregion

}

Xamarin Form側で実装します。「SaveData」メソッドでキーとバリューを指定してプリファレンスに保存します。プリファレンスからデータを取得したいときは「LoclaData」メソッドにキーを指定すれば取得することができます。

まとめ

今回はAndroidの開発ではよく利用するプリファレンスへの保存について紹介しました。iOSでの経験が乏しいためiOSではどのように実装していくのかは今後の課題にしています。実装でき次第紹介したいと思います。

Xamarin Forms 側

Android 側

プリファレンスへの保存方法

まとめ

コメントをどうぞ