KotlinでNCMBを使う：リレーションの使い方

AndroidではJavaの他、Kotlinも公式言語としてサポートされています。KotlinはJVM上で動作する静的な型付け言語で、言語体系がSwiftに似ています。そのため、Swiftに慣れた開発者であればすぐに習得できるかと思います（似ているので逆に戸惑う部分もあるのですが）。

今回はAndroid Studio 3系を使い、KotlinでNCMBを利用する方法を解説します。今回はデータストアのオブジェクト同士を連携させる技術の一つ、リレーションの使い方を紹介します。

Android Studioでプロジェクトを作成する

Android Studio 3系からKotlinプラグインをインストールせずにKotlinプロジェクトを作成できるようになりました。まずは新しいプロジェクトを作成します。

新しいプロジェクトを作成する際にInclude Kotlin Supportをチェックします。これでKotlinベースのコードが生成されます。

他はデフォルトのままです。Phone and Tabletを対象にし、 APIはある程度新しいもの（今回は23）を選択します。

さらにベースは何もなし、Empty Activityを選択します。

Activity NameはMainActivity、Layout Nameはactivity_mainというのもデフォルトのままです。

NCMBを追加する

プロジェクトが作成されたらファイルツリーを右クリックして、Open Module Settingsを選択します。

開いたウィンドウで、上にあるプラスアイコンをクリックします。

そしてImport .JAR/.AAR Packageを選択します。

次のダイアログでNCMB.jarを選択します。NCMB.jarはこちらからダウンロードし、解凍します。

追加すると、左側のメニューでappの下にNCMBが追加されます。ついでDependenciesをクリックします。

下にあるプラスアイコンをクリックし、Module dependencyを選択します。

モジュールの選択でNCMBを選びます。

一覧にNCMBが追加されたら完了です。

セキュリティ設定を変更する

AndroidManifest.xml を開いて設定を追加します。これはインターネット接続を用いる設定です。

<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
    package="jp.moongift.ncmbupdatedatastore">
    <!-- 以下の uses-permission を追加 -->
    <uses-permission android:name="android.permission.INTERNET" />
    <application
      :
    />
</manifest>

これで準備完了です。

SDKをインポートする

まずNCMBを利用する画面のKotlinファイルを開きます。今回は MainActivity.kt を編集します。今回は基礎になる NCMB クラスと、データストアで用いる NCMBObject クラスを読み込んでいます。

import com.nifcloud.mbaas.core.NCMB
import com.nifcloud.mbaas.core.NCMBObject

そして override fun onCreate の内容を編集します。 APPLICATION_KEY 、CLIENT_KEY はそれぞれのキーに書き換えてください。

override fun onCreate(savedInstanceState: Bundle?) {
    super.onCreate(savedInstanceState)
    setContentView(R.layout.activity_main)
    // 初期化
    NCMB.initialize(applicationContext, "APPLICATION_KEY", "CLIENT_KEY")

今回はコルーチンを使い、async/awaitでデータを追加してみます。

var user = NCMBUser.getCurrentUser()
var obj1 = NCMBObject("Setting")
obj1.put("Key", "Setting Value1")
async(Dispatchers.Default) { obj1.save() }.await()
Log.d("[DEBUG]", "Saved 1.")
delay(3000)
var obj2 = NCMBObject("Setting")
obj2.put("Key", "Setting Value2")
async(Dispatchers.Default) { obj2.save() }.await()
Log.d("[DEBUG]", "Saved 2.")
delay(3000)
var obj3 = NCMBObject("Setting")
obj3.put("Key", "Setting Value3")
async(Dispatchers.Default) { obj3.save() }.await()

そして、これらのデータをリレーションで連結します。

var relation = NCMBRelation.addRelation(arrayListOf(obj1, obj2, obj3))

そのリレーションオブジェクトを連携するオブジェクトにセットします。

user.put("list", relation)
async(Dispatchers.Default) { user.save() }.await()

これでリレーションとしてのデータ保存が完了します。

データの取得

では次にデータの取得です。これは取得したいクラス（今回はSetting）のクエリを作成します。

var user = NCMBUser.getCurrentUser()
var query = NCMBQuery<NCMBObject>("Setting")

そして、whereRelatedToを使ってリレーションを設定しているオブジェクトを指定します。

query.whereRelatedTo(user, "list")

後は find オブジェクトでデータを取得するだけです。

try {
  var settings = async(Dispatchers.Default) { query.find() }.await()
  Log.d("[DEBUG]", settings[0].getString("Key"))
} catch (e: NCMBException) {
}

まとめ

リレーションを保存する処理はさほど問題ないかと思いますが、取得する際には注意が必要です。取得されるクラスのクエリを使いつつ、リレーションデータで絞り込むという形になりますのでご注意ください。

中津川 篤司

NCMBエヴァンジェリスト。プログラマ、エンジニアとしていくつかの企業で働き、28歳のときに独立。 2004年、まだ情報が少なかったオープンソースソフトの技術ブログ「MOONGIFT」を開設し、毎日情報を発信している。2013年に法人化、ビジネスとエンジニアを結ぶDXエージェンシー「DevRel」活動をスタート。