KotlinでAPI通信をする方法!Retrofitの基本的な使い方を初心者向けに解説
生徒
「Androidアプリでインターネットからデータを取得したいんですが、どうやってやるんですか?」
先生
「それなら、Retrofit(レトロフィット)というライブラリを使うのが一般的ですよ。KotlinでAPI通信するのにとても便利なんです。」
生徒
「API通信ってなんですか?アプリが勝手にネットを使えるんですか?」
先生
「簡単に言うと、他のサービスからデータをもらったり、データを送ったりする仕組みのことです。では、Retrofitの基本的な使い方を見ていきましょう。」
1. Retrofitとは?KotlinでのAPI通信を助ける便利なツール
Retrofitは、AndroidアプリでAPI通信(インターネット経由のデータのやり取り)を行うための人気ライブラリです。
KotlinでWeb APIと通信するときに、Retrofitを使うと複雑なネットワーク処理を簡単に書けるようになります。URLを指定して、データを取得したり、送信したりできます。
2. APIとは何か?初心者でもわかるように解説
APIとは「アプリケーション・プログラミング・インターフェース」の略で、アプリ同士の会話のルールのようなものです。
たとえば、天気アプリがインターネットから天気情報を取得するのも、APIを使ってデータをもらっているからです。人間がブラウザで見るページとは別に、アプリ専用のデータ通信ルートがあるイメージです。
3. Retrofitを使う準備:build.gradleに追加する
まず、Retrofitを使うには、プロジェクトのbuild.gradleファイルに次のような依存関係を追加します。
implementation 'com.squareup.retrofit2:retrofit:2.9.0'
implementation 'com.squareup.retrofit2:converter-gson:2.9.0'
converter-gsonは、JSONというデータ形式をKotlinのオブジェクトに変換するための設定です。JSONは、API通信でよく使われるデータのかたちです。
4. Retrofitでデータモデルを定義する
APIから受け取るデータに合わせて、Kotlinのクラス(データモデル)を作成します。たとえば、以下のようなJSONデータがあるとします。
{
"id": 1,
"title": "記事のタイトル"
}
このデータに対応するクラスは、こうなります。
data class Article(
val id: Int,
val title: String
)
5. Retrofitのインターフェースを作ろう
次に、Retrofitに「どのAPIにアクセスするか」を教えるインターフェースを作ります。
interface ApiService {
@GET("articles")
fun getArticles(): Call<List<Article>>
}
@GETは、HTTPのGETリクエストを意味します。articlesはURLの一部です。
6. Retrofitインスタンスを作成する
次に、Retrofitのインスタンスを作ってAPIを使えるようにします。
val retrofit = Retrofit.Builder()
.baseUrl("https://example.com/api/")
.addConverterFactory(GsonConverterFactory.create())
.build()
val api = retrofit.create(ApiService::class.java)
baseUrlには、APIの基本URLを指定します。最後のスラッシュ(/)を忘れずに!
7. 実際にAPI通信してデータを取得する
RetrofitでAPI通信を行い、結果を受け取る方法は次の通りです。
api.getArticles().enqueue(object : Callback<List<Article>> {
override fun onResponse(call: Call<List<Article>>, response: Response<List<Article>>) {
if (response.isSuccessful) {
val articles = response.body()
articles?.forEach {
Log.d("API_RESULT", it.title)
}
}
}
override fun onFailure(call: Call<List<Article>>, t: Throwable) {
Log.e("API_ERROR", t.message ?: "エラー")
}
})
onResponseで成功時の処理、onFailureで失敗時の処理を記述します。
8. API通信の基本の流れをまとめると?
KotlinとRetrofitを使ったAPI通信の基本の流れは以下の通りです。
- Retrofitのライブラリを追加する
- データモデル(data class)を作る
- APIインターフェースを定義する
- Retrofitインスタンスを作成する
- APIを呼び出してデータを取得する
このように段階を踏めば、初心者でもAPI通信のしくみが理解できるはずです。
9. 初心者がつまずきやすいポイントとアドバイス
Retrofitでよくあるつまずきポイントは次のようなものです。
- baseUrlに末尾の
/を忘れると通信に失敗する - インターネットの権限を
AndroidManifest.xmlに書き忘れる - 非同期処理なので、データ取得のタイミングに注意
ネット通信を使うには、必ず次のように許可を与えてください。
<uses-permission android:name="android.permission.INTERNET" />