イントロダクション(Kotlin)
クイックスタート
Contents |
クイックスタートについて
このページでは、mobile backendをKotlinアプリを連携させる手順を紹介します
アプリの新規作成
- ニフクラ mobile backendにログインします
- 管理画面が表示されたら、「アプリの新規作成」を行います
- すでに別のアプリを作成済みの場合は、ヘッダーの「+新しいアプリ」をクリックします
- 「アプリ名」を入力し「新規作成」をクリックすると、APIキー(アプリケーションキーとクライアントキー)が発行されます
- APIキーは後ほどAndroidアプリで使います
- AndroidStudioでプロジェクトを作成します
- 既存のプロジェクトを利用する場合はこの作業は不要です
SDKのダウンロード
- Githubリリースページの Assets 内の NCMB.x.x.x.zip ボタンからダウンロードしてください
- 最新版をダウンロードしてください。
- zipファイルの中身に、NCMB.jarがあります。
SDKのインストール
- このSDKでは、以下のライブラリを使用しています。
- Gson
- Android Studioでプロジェクトを開き、以下の手順でSDKをインストールしてください
- Project Viewに切り替えてから、app/libsフォルダにNCMB.jarをコピーします
- app/build.gradleファイルに以下を追加します
dependencies {
implementation 'com.squareup.okhttp3:okhttp:4.8.1'
implementation 'com.google.code.gson:gson:2.3.1'
api files('libs/NCMB.jar')
//同期処理を使用する場合はこちらを追加していただく必要があります
implementation 'org.jetbrains.kotlinx:kotlinx-coroutines-core:1.3.9'
}
参考:SDKのアップデートについて
- 最新のSDKをダウンロードし、上で追加した
NCMB.jar
を置き換えることでSDKのアップデートが可能です
AndroidManifest.xmlの編集
- <application>タグの直前に以下のpermissionを追加します
<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
SDKの読み込み
- MainActivity.ktの冒頭に次のコードを追記して、インストールしたSDKを読み込みます
import com.nifcloud.mbaas.core.NCMB
APIキーの設定とSDKの初期化
- ニフクラ mobile backendのアプリケーションキーとクライアントキーを利用して、 NCMBクラスのinitializeメソッドでAndroid SDKの初期化を行います
- アプリ起動時に表示するアクティビティのonCreateメソッドに下記の内容を追記します
NCMB.initialize(this.applicationContext, "YOUR_APPLICATION_KEY", "YOUR_CLIENT_KEY")
- 上の「
APP_KEY
」と「CLIENT_KEY
」は、mBaaSの管理画面で「アプリの新規作成」を行ったときに発行されたAPIキーに置き換えます- アプリ作成時のAPIキー発行画面を閉じてしまった場合は、「アプリ設定」>「基本」で確認できます。
- 「コピー」ボタンを使用してコピーしてください。
- これで連携作業は完了です!
- サンプルコードを書いて実際にmBaaSを使ってみましょう
サンプルコードの実装
- 最初に、ファイルの先頭に利用するライブラリを追記します
import com.nifcloud.mbaas.core.NCMB
import com.nifcloud.mbaas.core.NCMBException
import com.nifcloud.mbaas.core.NCMBObject
import com.nifcloud.mbaas.core.NCMBCallback
※注意:利用する機能に合わせて使用するライブラリのimportが必要です
import com.nifcloud.mbaas.core.NCMB //全機能必須
import com.nifcloud.mbaas.core.NCMBCallback //非同期処理を行う場合
import com.nifcloud.mbaas.core.NCMBException //例外処理を行う場合
import com.nifcloud.mbaas.core.NCMBObject //データストアを利用する場合
import java.io.File //ファイルストアを利用する場合
import com.nifcloud.mbaas.core.NCMBFile //ファイルストアを利用する場合
import com.nifcloud.mbaas.core.NCMBUser //会員管理を利用する場合
import com.nifcloud.mbaas.core.NCMBGeoPoint //位置情報を利用する場合
import com.nifcloud.mbaas.core.NCMBQuery //検索機能を利用する場合
MainActivity.kt
のonCreate
メソッド内に書いた処理は、アプリの起動時に実行されます- APIキーの設定とSDK初期化コードの下にサンプルコードを書くと、すぐに動作確認が可能です
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
// APIキーの設定とSDK初期化
NCMB.initialize(this.applicationContext, "YOUR_APPLICATION_KEY", "YOUR_CLIENT_KEY")
// ↓ ここにサンプルコードを実装 ↓
setContentView(R.layout.activity_main)
}
サンプルコード(データストア)
- 次のコードはmBaaSのデータストアに保存先の「TestClass」というクラスを作成し、「message」というフィールドへ「Hello, NCMB!」というメッセージ(文字列)を保存するものです。
// クラスのNCMBObjectを作成
val obj = NCMBObject("TestClass")
// オブジェクトの値を設定
obj.put("message", "Hello, NCMB!")
obj.saveInBackground(NCMBCallback { e, ncmbObj ->
if (e != null) {
//保存に失敗した場合の処理
print("保存に失敗しました : " + e.message)
} else {
//保存に成功した場合の処理
val result = ncmbObj as NCMBObject
print("保存に成功しました ObjectID :" + result.getObjectId())
}
})
アプリを実行してmBaaSの管理画面を確認する
- アプリを実機またはシミュレーターで実行します
- アプリが起動されたら、mBaaSの管理画面で「データストア」から、データが保存されていることを確認できます
Kotlinアプリのチュートリアルについて
- 他にもさまざまなチュートリアルをご用意しています
ぜひご活用ください!
お探しの内容が見つからなかった場合はユーザーコミュニティ
もご活用ください。(回答保証はいたしかねます)
なお、 Expertプラン以上のお客様はテクニカルサポートにてご質問を承らせて頂きます。
推奨画面サイズ1024×768px以上