Xamarin StudioとGenymotionでAndroid開発 - Part4: Couchbase Liteアプリを使う

Couchbase Liteはモバイル端末向けの組み込みのJSONドキュメントデータベースです。エンジンはSQLiteです。Couchbase Mobileというモバイルソリューションでは、リモートのCouchbase ServerとJSONドキュメントを同期をすることができます。もちろん単体でSQLiteの代わりにJSONをローカルに保存する組み込みデータベースとしても使えます。Building your first Couchbase Lite .NET appのチュートリアルを写経していきます。

プロジェクトの作成

Xamarin Studioを起動してプロジェクトを作成します。

• ファイル > 新規 > ソリューション

新しいソリューションダイアログから、Android Applicationを選択します。

• C# > Android > Android Application
• ソリューション名: HelloCBL

NuGetからCouchbase Lite .NET library をパッケージに追加します。

• プロジェクト > Add Nuget Packages…
• 右上のボックスから”Couchbase Lite”を検索する
• 最新バージョンを選択し、1.0.0をAdd Packageする

Packege Consoleに警告がでていますが、パッケージのインストールは成功したようです。

>> Assembly references are being added from 'lib/MonoAndroid'
Added reference 'Couchbase.Lite' to project 'HelloCBL'.
Added file 'packages.config'.
Added file 'packages.config' to project 'HelloCBL'.
Successfully added 'Couchbase.Lite 1.0.0' to HelloCBL.

Couchbase.Lite Package contains PowerShell scripts which will not be run.

MainActivity.csに宣言を追加します。

using Couchbase.Lite;

マネージャーを作成

マネージャーを作成しますマネージャーのインスタンスを作成します。MainActivity.csのOnCreateに実装を追加していきます。

// Create a shared manager
var manager = Manager.SharedInstance;
Console.WriteLine("Manager created");

無料のSTARTプランを使っているのでアカウントにライセンスがついていません。ビルドに失敗してしまいます。

ダイアログに表示されているBegin a TrialをクリックしてXamarin.Androidの30日トライアルを開始します。

一度全てクリーンしてからビルドし直します。Genymotionのシュミレーターを起動してからDebug実行します。

アプリケーション出力にメッセージが出力されました。

Manager created

データベースを作成

次にデータベースを作成します。

// Create database
var dbName = "hello";
var database = manager.GetDatabase(dbName);
Console.WriteLine("Database created");

データベースの命名規則は以下です。

• Lowercase letters: a-z
• Numbers: 0-9
• Special characters: _$()+-/

Debug実行をすると、アプリケーション出力にメッセージが出力されます。

Database created

CRUD操作を実装

CRUD操作をOnCreateメソッドに実装します。

JSONドキュメントのCREATEをします。

using System.Collections.Generic;
...
// Create a document
var properties = new Dictionary <string,object> () {
	{"message","Hello Couchbase Lite"},
	{"created_at",DateTime.UtcNow.ToString("o")},
};

var document = database.CreateDocument ();
var revision = document.PutProperties (properties);
var docId = document.Id;
Console.WriteLine ("Document created with ID = {0}", docId);

Debug実行、アプリケーション出力にメッセージが出力されました。

Document created with ID = a6532552-c78b-4b31-b8e1-e127581493d6

JSONドキュメントのREADをします。

...
var retrievedDocument = database.GetDocument (docId);
Console.WriteLine ("Retrieved document: ");
foreach (var kvp in retrievedDocument.Properties) {
	Console.WriteLine ("{0} : {1}", kvp.Key, kvp.Value);
}

Debug実行、アプリケーション出力にメッセージが出力されました。

message : Hello Couchbase Lite
created_at : 1/14/2015 8:51:04 AM
_id : 8c702e41-d8bb-4861-b819-bf0547ee546c
_rev : 1-5ce83ca798342e9b21ef80ae825ef7fe

JSONドキュメントのUPDATEをします。

...
// Update a document
var updatedProperties = new Dictionary<string,object> (retrievedDocument.Properties);
updatedProperties ["message"] = "We're having a heat wave!";
updatedProperties ["temperature"] = 95.0;

var updatedRevision = retrievedDocument.PutProperties (updatedProperties);
System.Diagnostics.Debug.Assert(updatedRevision != null);

Console.WriteLine("Updated document: ");
foreach (var kvp in updatedRevision.Document.Properties){
	Console.WriteLine ("{0} : {1}", kvp.Key, kvp.Value);
}

Debug実行をすると、アプリケーション出力にメッセージが出力されます。

Updated document: 
message : We're having a heat wave!
created_at : 1/14/2015 9:03:40 AM
_id : 5e2e5087-78e6-44b1-85e7-8698f93614ec
_rev : 2-fb50e7e00bf17c6e02d353ebce929bb8
temperature : 95

JSONドキュメントのDELETEをします。

...
// Delete a document
retrievedDocument.Delete ();
Console.WriteLine("Deleted document, deletion status: {0}", retrievedDocument.Deleted);

Debug実行をすると、アプリケーション出力にメッセージが出力されます。

Deleted document, deletion status: True

MainActivity.cs

最後に完成したコードです。リポジトリはこちらにあります。

using System;

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

using Couchbase.Lite;

using System.Collections.Generic;

namespace HelloCBL
{
	[Activity (Label = "HelloCBL", MainLauncher = true, Icon = "@drawable/icon")]
	public class MainActivity : Activity
	{
		int count = 1;

		protected override void OnCreate (Bundle bundle)
		{
			base.OnCreate (bundle);

			// Set our view from the "main" layout resource
			SetContentView (Resource.Layout.Main);

			// Get our button from the layout resource,
			// and attach an event to it
			Button button = FindViewById<Button> (Resource.Id.myButton);
			
			button.Click += delegate {
				button.Text = string.Format ("{0} clicks!", count++);
			};

			// Create a shared manager
			var manager = Manager.SharedInstance;
			Console.WriteLine ("Manager created");

			// Create database
			var dbName = "hello";
			var database = manager.GetDatabase (dbName);
			Console.WriteLine ("Database created");

			// Create a document
			var properties = new Dictionary <string,object> () {
				{"message","Hello Couchbase Lite"},
				{"created_at",DateTime.UtcNow.ToString("o")},
			};

			var document = database.CreateDocument ();
			var revision = document.PutProperties (properties);
			var docId = document.Id;
			Console.WriteLine ("Document created with ID = {0}", docId);

			var retrievedDocument = database.GetDocument (docId);
			Console.WriteLine ("Retrieved document: ");

			foreach (var kvp in retrievedDocument.Properties) {
				Console.WriteLine ("{0} : {1}", kvp.Key, kvp.Value);
			}

			// Update a document
			var updatedProperties = new Dictionary<string,object> (retrievedDocument.Properties);
			updatedProperties ["message"] = "We're having a heat wave!";
			updatedProperties ["temperature"] = 95.0;

			var updatedRevision = retrievedDocument.PutProperties (updatedProperties);
			System.Diagnostics.Debug.Assert(updatedRevision != null);

			Console.WriteLine("Updated document: ");
			foreach (var kvp in updatedRevision.Document.Properties){
				Console.WriteLine ("{0} : {1}", kvp.Key, kvp.Value);
			}

			// Delete a document
			retrievedDocument.Delete ();
			Console.WriteLine("Deleted document, deletion status: {0}", retrievedDocument.Deleted);

		}
	}
}