Android StudioでURLからJSONを取得してKotlinでパースして表示させてみた

sample image

Android StudioでURLからJSONを取得してKotlinでパースして表示させてみた

Androidアプリの開発において、外部APIからデータを取得し、アプリ内で表示するのはよくある課題です。今回は、Kotlinを使ってURLからJSONデータを取得し、パースして表示する方法を紹介します。このプロジェクトでは、Retrofitを使って非同期通信を行い、リポジトリの情報を取得して表示します。

1. プロジェクトの準備

まず、Android Studioで新しいプロジェクトを作成します。次に、ネットワーク通信のための依存関係をbuild.gradleファイルに追加します。

build.gradleにRetrofitとGsonの依存関係を追加

Retrofitはネットワーク通信を簡単に行うライブラリで、GsonはJSONデータをパースするのに使います。


    // build.gradle(Module: app)
    implementation 'com.squareup.retrofit2:retrofit:2.9.0'
    implementation 'com.squareup.retrofit2:converter-gson:2.9.0'

2. RetrofitでJSONを取得する

Retrofitを使って外部APIからデータを取得するための設定を行います。ここでは、GitHub APIからリポジトリ情報を取得します。

Retrofitインターフェースを定義

RetrofitはAPIのエンドポイントをインターフェースとして定義し、非同期処理を行います。以下の例では、GitHubユーザーのリポジトリリストを取得します。


    import retrofit2.Retrofit
    import retrofit2.converter.gson.GsonConverterFactory
    import retrofit2.http.GET
    import retrofit2.http.Path

    // GitHub APIインターフェース
    interface GitHubService {
        @GET("users/{user}/repos")
        suspend fun listRepos(@Path("user") user: String): List<Repository>
    }

データクラスを作成

APIから取得するJSONデータを受け取るため、対応するデータクラスを作成します。GitHubのリポジトリ情報に対応するクラスは次のようになります。


    // リポジトリのデータクラス
    data class Repository(
        val id: Long,
        val name: String,
        val full_name: String
    )

3. Kotlinで非同期にAPIからデータを取得する

次に、非同期でデータを取得するための関数を作成します。ここでは、Coroutineを使って、バックグラウンドスレッドでネットワーク通信を行います。


    import kotlinx.coroutines.Dispatchers
    import kotlinx.coroutines.withContext

    // APIからリポジトリ情報を取得する関数
    suspend fun getRepos(user: String): List<Repository>? {
        return withContext(Dispatchers.IO) {
            try {
                // Retrofitインスタンスを作成
                val retrofit = Retrofit.Builder()
                    .baseUrl("https://api.github.com/")
                    .addConverterFactory(GsonConverterFactory.create())
                    .build()

                // GitHub APIサービスを作成
                val service = retrofit.create(GitHubService::class.java)

                // データを取得
                service.listRepos(user)
            } catch (e: Exception) {
                e.printStackTrace()
                null
            }
        }
    }

4. データをアプリで表示する

取得したリポジトリの情報を表示するために、ListViewを使います。非同期処理を行うため、lifecycleScopeを使ってデータ取得をバックグラウンドで行い、UIに反映します。

ListViewを使った簡単な表示

まず、レイアウトファイルにListViewを追加します。


    <ListView
        android:id="@+id/listView"
        android:layout_width="match_parent"
        android:layout_height="match_parent" />

次に、MainActivityでデータを取得し、リストに表示する処理を行います。


    import android.os.Bundle
    import android.widget.ArrayAdapter
    import androidx.appcompat.app.AppCompatActivity
    import androidx.lifecycle.lifecycleScope
    import kotlinx.coroutines.launch
    import android.widget.ListView

    class MainActivity : AppCompatActivity() {

        override fun onCreate(savedInstanceState: Bundle?) {
            super.onCreate(savedInstanceState)
            setContentView(R.layout.activity_main)

            // ListViewの参照を取得
            val listView = findViewById<ListView>(R.id.listView)

            // 非同期でリポジトリ情報を取得して表示
            lifecycleScope.launch {
                val repos = getRepos("octocat") // GitHubユーザー名
                repos?.let {
                    // リポジトリ名のリストを作成
                    val repoNames = it.map { repo -> repo.name }
                    // ArrayAdapterを使ってListViewにリポジトリ名を表示
                    val adapter = ArrayAdapter(this@MainActivity, android.R.layout.simple_list_item_1, repoNames)
                    listView.adapter = adapter
                }
            }
        }
    }

5. 最後に

以上で、Android StudioでURLからJSONデータを取得し、Kotlinでパースして表示させる方法を解説しました。ネットワーク通信の際には、セキュリティやエラーハンドリングも重要なので、適切に対策を講じてください。