Android
 Computer >> コンピューター >  >> プログラミング >> Android

Androidローダーの使い方とは?連絡先一覧を表示する実装例をステップ解説

Androidローダー(Loader)とは

ローダーは、Android 3.0(APIレベル11)で導入された、バックグラウンドで非同期にデータを読み込むための仕組みです。UIスレッドをブロックすることなくコンテンツプロバイダやデータベースからデータを取得でき、画面回転などの設定変更時にも読み込み済みのデータを再利用できるのが大きな特徴です。

本記事では、ローダー(CursorLoader)を使って端末の連絡先一覧をListViewに表示する方法を、サンプルコード付きでステップごとに解説します。

ステップ1:新しいプロジェクトを作成する

Android Studioを起動し、メニューから「File」⇒「New Project」を選択します。必要な項目をすべて入力して、新しいプロジェクトを作成しましょう。

ステップ2:レイアウトファイルを編集する

res/layout/activity_main.xml に以下のコードを追加します。

<?xml version="1.0" encoding="utf-8"?>
<LinearLayout xmlns:android="https://schemas.android.com/apk/res/android"
    android:orientation="vertical"
    android:layout_width="match_parent"
    android:layout_height="match_parent">
    <ListView
        android:id="@+id/list"
        android:layout_width="match_parent"
        android:layout_height="wrap_content"
        android:layout_centerHorizontal="true"
        android:layout_centerVertical="true" />
</LinearLayout>

このレイアウトでは、連絡先の名前を一覧表示するためのListViewを画面いっぱいに配置しています。

ステップ3:MainActivity.javaを編集する

src/MainActivity.java に以下のコードを記述します。

import android.Manifest;
import android.content.CursorLoader;
import android.content.Loader;
import android.content.pm.PackageManager;
import android.database.Cursor;
import android.os.Bundle;
import android.provider.ContactsContract;
import android.support.v4.app.ActivityCompat;
import android.support.v4.app.FragmentActivity;
import android.support.v4.content.ContextCompat;
import android.support.v4.widget.SimpleCursorAdapter;
import android.widget.ListView;

public class MainActivity extends FragmentActivity implements android.app.LoaderManager.LoaderCallbacks<Cursor> {
    private static final int LOADER_CONTACTS = 100;
    private static final int PERMISSION_CONTACTS = 101;
    private static final String[] PROJECTION = {ContactsContract.Contacts._ID, ContactsContract.Contacts.DISPLAY_NAME};
    ListView lstContact;
    SimpleCursorAdapter adapter;
    String[] from = {ContactsContract.Contacts.DISPLAY_NAME};
    int[] to = {android.R.id.text1};

    @Override
    public void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        adapter = new SimpleCursorAdapter(this, android.R.layout.simple_list_item_1, null, from, to, 0);
        ListView listView = (ListView) findViewById(R.id.list);
        listView.setAdapter(adapter);
        if (ContextCompat.checkSelfPermission(this, Manifest.permission.READ_CONTACTS) != PackageManager.PERMISSION_GRANTED) {
            ActivityCompat.requestPermissions(this, new String[]{Manifest.permission.READ_CONTACTS}, PERMISSION_CONTACTS);
        } else {
            getLoaderManager().initLoader(LOADER_CONTACTS, null, this);
        }
    }

    @Override
    public Loader<Cursor> onCreateLoader(int id, Bundle bundle) {
        if (id == LOADER_CONTACTS) {
            return new CursorLoader(this, ContactsContract.Contacts.CONTENT_URI, PROJECTION, null, null, null);
        } else {
            return null;
        }
    }

    @Override
    public void onLoadFinished(android.content.Loader<Cursor> loader, Cursor data) {
        adapter.swapCursor(data);
        adapter.notifyDataSetChanged();
    }

    @Override
    public void onLoaderReset(android.content.Loader<Cursor> loader) {
        adapter.swapCursor(null);
    }
}

コードのポイント

  • 権限チェック:READ_CONTACTS権限が許可されていない場合は、requestPermissions()でユーザーに権限をリクエストします。
  • ローダーの初期化:権限がすでに許可されている場合は、getLoaderManager().initLoader()でローダーを初期化します。
  • onCreateLoader():ContactsContract.Contacts.CONTENT_URIを指定したCursorLoaderを返し、連絡先のIDと表示名を取得します。
  • onLoadFinished():データ読み込み完了時にswapCursor()でアダプターにカーソルを渡し、ListViewの表示を更新します。
  • onLoaderReset():ローダーがリセットされた際に、アダプターからカーソルを解放してリソースリークを防ぎます。

アプリを実行する

実際のAndroid端末をパソコンに接続した状態で、Android Studioからアプリを実行しましょう。プロジェクト内のアクティビティファイルを開き、ツールバーの「Run」アイコンをクリックします。接続した端末を選択すると、端末の画面に連絡先の一覧が表示されます。

Androidローダーの使い方とは?連絡先一覧を表示する実装例をステップ解説

注意:ローダーは非推奨(Deprecated)

なお、ローダーはAndroid 9.0(APIレベル28)以降で非推奨となっています。新規のアプリ開発では、ViewModelとLiveData、またはKotlin Coroutines(Flow)を用いた非同期処理が公式に推奨されています。ただし、既存プロジェクトの保守やレガシーコードの理解においては、ローダーの仕組みを把握しておくことが依然として役立ちます。

  1. 【Android】スナックバー(Snackbar)の使い方をステップごとに解説

    このチュートリアルでは、Androidアプリでスナックバー(Snackbar)を使用する方法を、サンプルコードとともに段階的に解説します。スナックバーは画面下部に短いメッセージを一時的に表示できるUIコンポーネントで、Toastとは異なり「再試行(RETRY)」などのアクションボタンを組み込めるのが大きな特徴です。 手順1:新規プロジェクトを作成する Android Studioを起動し、メニューから「File」→「New Project」を選択します。必要な項目をすべて入力して、新しいプロジェクトを作成しましょう。 手順2:レイアウトファイル(activity_main.xml)を編集する

  2. 【Android】NavigationViewの実装方法をステップごとに解説

    この記事では、AndroidアプリでNavigationView(ナビゲーションビュー)を使用してドロワーメニューを実装する方法を、ステップごとに詳しく解説します。ハンバーガーアイコンから開閉できるサイドメニューは、多くのアプリで採用されている定番のUIです。ステップ1:新しいプロジェクトを作成するAndroid Studioを開き、File → New Project を選択して、必要な情報を入力し新しいプロジェクトを作成します。テンプレートには「Navigation Drawer Activity」を選ぶと、後の作業がスムーズになります。ステップ2:activity_main.xml にコ