Android Studioでアプリ開発!

Androidアプリ開発初心者の備忘録です。

プロジェクト内のアクティビティでグローバル変数を使う方法

アクティビティ間で共通の変数を扱いたい

アクティビティ間でデータの受け渡しを行う方法 - Android Studioでアプリ開発!では Intent.putExtra() や intent.getXxxExtra() を用いてアクティビティ間でデータを受け渡しする方法を説明しました。
今回はそれとは別に、アクティビティ間で共通の変数を使う方法を説明したいと思います。
Android Studioで最初のアクティビティに遷移する方法 - Android Studioでアプリ開発!で作ったプロジェクトを元に変更していきます。

完成イメージ

グローバル変数を利用して遷移した回数と遷移元の画面名称を Toast で表示しています。Android Studioで最初のアクティビティに遷移する方法 - Android Studioでアプリ開発!では最初の画面に戻ったときに遷移した回数はリセットされていましたが、今回は画面遷移を繰り返すたびに回数は +1 ずつされていきます。
f:id:jolene:20140726120003p:plain
f:id:jolene:20140726120019p:plain
f:id:jolene:20140726120025p:plain

共通変数を扱うクラスを作成する

新しく共通変数を扱うクラスとして Common クラスを作成しました。クラスの作成についてはAndroid Studioでクラスをプロジェクトに追加する - Android Studioでアプリ開発!を参照してください。
共通変数を扱うクラスは Application クラスを継承する必要があります。
プロジェクト内で使う共通変数と、それを初期化するメソッドを追加しています。

package com.example.transitiontest;

import android.app.Application;

/**
 * グローバル変数を扱うクラス
 * Created by XXXXX on 20XX/XX/XX.
 */
public class Common extends Application{
    // グローバルに扱う変数
    int transitionCount;        // 画面遷移した回数
    String fromActivityName;    // 遷移元の画面名称

    /**
     * 変数を初期化する
     */
    public void init(){
        transitionCount = 0;
        fromActivityName = "";
    }
}

AndroidManifest.xml を変更する

グローバル変数を扱うクラスは AndroidManifest.xml に追加する必要があります。application タグの name="Common" がその部分になります。

<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
    package="com.example.transitiontest" >

    <application
        android:allowBackup="true"
        android:icon="@drawable/ic_launcher"
        android:label="@string/app_name"
        android:theme="@style/AppTheme"
        android:name="Common" >

        <--中略-->

    </application>
</manifest>

プログラムを記述する

ActivityFirst は以下のように記述しました。onCreate() でグローバル変数を扱う Common クラスを getApplication() で取得しています。この画面は最初に呼び出されるのでグローバル変数を初期化します。onClick() ではグローバル変数の遷移元画面名称を設定しています。

public class ActivityFirst extends Activity {
    private Common common;      // グローバル変数を扱うクラス

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_first);

        // グローバル変数を扱うクラスを取得する
        common = (Common) getApplication();

        // グローバル変数を扱うクラスを初期化する
        common.init();

        // グローバル変数の[遷移した回数]を +1 する
        common.transitionCount++;

        // 遷移した回数を Toast で表示する
        String message = String.format("遷移した回数:%d\n遷移元の画面:%s", common.transitionCount, common.fromActivityName);
        Toast toast = Toast.makeText(this, message, Toast.LENGTH_LONG);
        toast.setGravity(Gravity.TOP, 0, 200);
        toast.show();
    }

    // 中略

    public void onClick(View view){
        switch (view.getId()){
            case R.id.btnToSecond:
                // Intent のインスタンスを取得する
                Intent intent = new Intent(this, ActivitySecond.class);

                // 遷移元の画面名称をグローバル変数に設定する
                common.fromActivityName = getTitle().toString();

                // 遷移先の画面を呼び出す
                startActivity(intent);
                break;
        }
    }
}

ActivitySecond と ActivityThird はほぼ同じです。getApplication() で Common クラスを取得し、グローバル変数にアクセスしています。
ActivitySecond のソース

public class ActivitySecond extends Activity {
    private Common common;      // グローバル変数を扱うクラス

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_second);

        // グローバル変数を扱うクラスを取得する
        common = (Common) getApplication();

        // グローバル変数の[遷移した回数]を +1 する
        common.transitionCount++;

        // 遷移した回数を Toast で表示する
        String message = String.format("遷移した回数:%d\n遷移元の画面:%s", common.transitionCount, common.fromActivityName);
        Toast toast = Toast.makeText(this, message, Toast.LENGTH_LONG);
        toast.setGravity(Gravity.TOP, 0, 200);
        toast.show();
    }

    // 中略

    public void onClick(View view){
        switch (view.getId()){
            case R.id.btnToThird:
                // Intent のインスタンスを取得する
                Intent intent = new Intent(this, ActivityThird.class);

                // 遷移元の画面名称をグローバル変数に設定する
                common.fromActivityName = getTitle().toString();

                // 遷移先の画面を呼び出す
                startActivity(intent);
                break;
        }
    }
}
ActivityThird のソース
public class ActivityThird extends Activity {
    private Common common;      // グローバル変数を扱うクラス

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_third);

        // グローバル変数を扱うクラスを取得する
        common = (Common) getApplication();

        // グローバル変数の[遷移した回数]を +1 する
        common.transitionCount++;

        // 遷移した回数を Toast で表示する
        String message = String.format("遷移した回数:%d\n遷移元の画面:%s", common.transitionCount, common.fromActivityName);
        Toast toast = Toast.makeText(this, message, Toast.LENGTH_LONG);
        toast.setGravity(Gravity.TOP, 0, 200);
        toast.show();
    }

    // 中略

    public void onClick(View view){
        switch (view.getId()){
            case R.id.btnToFirst:
                // Intent のインスタンスを取得する(最初の画面)
                Intent intent = new Intent(this, ActivityFirst.class);

                // ActivitySecond と ActivityThird を消す
                intent.addFlags(Intent.FLAG_ACTIVITY_CLEAR_TOP);

                // ActivityFirst を再利用する(onCreate() は呼ばれない)
                intent.addFlags(Intent.FLAG_ACTIVITY_SINGLE_TOP);

                // 遷移元の画面名称をグローバル変数に設定する
                common.fromActivityName = getTitle().toString();

                // 遷移先の画面を呼び出す
                startActivity(intent);
                break;
        }
    }
}

以上の実装で、冒頭の完成イメージのように動作します。

まとめ

プロジェクト内のアクティビティでグローバル変数を扱う方法を説明しました。グローバル変数を扱うには Application クラスを継承したクラスを作成する必要がありました。また、そのクラスは AndroidManifest.xml に追記する必要がありました。グローバル変数を扱うクラスをプログラムから利用するには、getApplication() メソッドを使う必要がありました。
アクティビティ間でデータをやりとりする場合、とても便利なので活用してみてください。

Android StudioではじめるAndroidプログラミング入門

Android StudioではじめるAndroidプログラミング入門

初歩からわかるAndroid最新プログラミング 増補改訂版

初歩からわかるAndroid最新プログラミング 増補改訂版