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

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

KotlinでNCMBを使う:ファイルストアへテキストファイルをアップロード/ダウンロードする

f:id:mbaasdevrel:20181207095244p: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 を開いて設定を追加します。 android.permission.INTERNET はインターネット接続を用いる設定です。

<?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 クラスと、ファイルストアで用いる NCMBFile クラスを読み込んでいます。

import com.nifcloud.mbaas.core.NCMB
import com.nifcloud.mbaas.core.NCMBFile

そして 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")

ファイルをアップロードする

今回はユーザが入力した文字列をテキストファイルとしてアップロードします。注意点はテキストをtoByteArrayを使って配列にすることです。

var data = findViewById<TextView>(R.id.txtMemo).text.toString().toByteArray()
var acl = NCMBAcl()
acl.publicReadAccess = true
acl.publicWriteAccess = true
val file = NCMBFile("Memo.txt", data, acl)
file.saveInBackground { e ->
    if (e != null) {
        Log.d("Error", "${e.localizedMessage}")
    } else {
        Log.d("Success", "File saved.")
    }
}

このような処理によって、ファイルアップロード処理が実現できます。

ファイルをダウンロードする

逆にダウンロードする際にはファイル名を指定して fetchInBackground を実行します。その際もバイト配列が返ってきますので、文字コードを指定した上でtoStringを行って元の文字列を得ます。

val file = NCMBFile("Memo.txt")
file.fetchInBackground { data, e ->
    if (e != null) {
        Log.d("Error", "${e.localizedMessage}")
    } else {
        Log.d("Done", data.toString(Charset.defaultCharset()))
    }
}

まとめ

テキストファイルのアップロードはCSVやHTMLファイルなどでよく使います。ファイルストアを活用する際にコードを参考にしてください。

中津川 篤司

中津川 篤司

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