ニフクラ mobile backend(mBaaS)お役立ちブログ

スマホアプリ開発にニフクラ mobile backend(mBaaS)。アプリ開発に役立つ情報をおとどけ!

KotlinでNCMBを使う:データストアを検索する

f:id:mbaasdevrel:20181207113430p:plain

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

今回はAndroid Studio 3系を使い、KotlinでNCMBを利用する方法を解説します。今回はデータストアの検索方法です。

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

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

f:id:mbaasdevrel:20181207094347p:plain

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

f:id:mbaasdevrel:20181207094507p:plain

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

f:id:mbaasdevrel:20181207094525p:plainf:id:mbaasdevrel:20181207094525p:plain

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

f:id:mbaasdevrel:20181207094536p:plain

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

f:id:mbaasdevrel:20181207094555p:plain

NCMBを追加する

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

f:id:mbaasdevrel:20181207094605p:plain

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

f:id:mbaasdevrel:20181207094652p:plain

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

f:id:mbaasdevrel:20181207094710p:plain

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

f:id:mbaasdevrel:20181207094721p:plain

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

f:id:mbaasdevrel:20181207094843p:plain

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

f:id:mbaasdevrel:20181207094859p:plain

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

f:id:mbaasdevrel:20181207094908p:plain

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

f:id:mbaasdevrel:20181207094941p:plain

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

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_KEYCLIENT_KEY はそれぞれのキーに書き換えてください。

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

データを検索してリスト表示する

では今回はデータストアの検索を実行し、その結果をListViewに表示します。まずクエリ用クラスをインポートします。

import com.nifcloud.mbaas.core.NCMBQuery
import com.nifcloud.mbaas.core.NCMBObject

クエリオブジェクトを作成します。今回はTestClassを検索します。

val query = NCMBQuery<NCMBObject>("TestClass")

そして検索します。検索結果は非同期で得られます。

query.findInBackground { objects, e ->
  // 検索結果の処理
}

例えばListViewに文字を表示する際には以下のような実装になるでしょう。取得したデータは配列になっていますので、順番に処理をします。その際には文字列の場合は getString(key) メソッドで取得できます。

query.findInBackground { objects, e ->
    if (e != null) {
        // エラー
        Log.d("[Error]", e.toString())
    } else {
        // 取得
        var items = arrayListOf<String>()
        for (obj in objects) {
            items.add(obj.getString("message"))
        }
        val adapter = ArrayAdapter<String>(this, android.R.layout.simple_list_item_1, items)
        listView.adapter = adapter
    }
}

f:id:mbaasdevrel:20181207113430p:plain

まとめ

データストアを使うことで複数端末や複数ユーザでデータを共有するといった機能が簡単に実現できます。今回はACL(アクセスコントロール)を誰でも読めるデータとして設定していますが、ACLを使うことでセキュアで自由度高いデータとして管理できるようになります。

今回のコードはNCMBMania/kotlinQuery: Kotlinでデータストアの検索を行うデモですにアップロードしてあります。実装時の参考にしてください。

中津川 篤司

中津川 篤司

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