Androidでsynchronized（同期）を使用したシングルトンダイアログの実装方法

シングルトンパターンとは

実装例に入る前に、まずシングルトンデザインパターンの基本をおさらいしておきましょう。シングルトンとは、クラスのインスタンス化を1つだけに制限するデザインパターンです。主な用途としては、同時実行（並行処理）の制御や、アプリケーション全体でデータストアへアクセスするための一元的なアクセスポイントの作成などが挙げられます。

また、synchronized（同期）とは、ある時点において1つのスレッドだけがアクセスできる状態にすることを意味します。

この記事では、Androidでsynchronizedを活用し、シングルトンクラス経由でダイアログを表示・制御する方法をステップごとに解説します。

手順1：新しいプロジェクトを作成する

Android Studioを開き、メニューから「File」→「New Project」を選択して、必要事項を入力し新しいプロジェクトを作成します。

手順2：activity_main.xml にコードを追加する

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

<?xml version = "1.0" encoding = "utf-8"?>
<LinearLayout xmlns:android = "https://schemas.android.com/apk/res/android"
   xmlns:tools = "https://schemas.android.com/tools"
   android:layout_width = "match_parent"
   android:layout_height = "match_parent"
   tools:context = ".MainActivity"
   android:orientation = "vertical">
   <Button
      android:id = "@+id/start"
      android:text = "start dialog in singleTone"
      android:layout_width = "wrap_content"
      android:layout_height = "wrap_content" />
   <Button
      android:id = "@+id/end"
      android:text = "end dialog singleTone"
      android:layout_width = "wrap_content"
      android:layout_height = "wrap_content" />
</LinearLayout>

上記のコードでは、2つのボタンを配置しています。「start dialog in singleTone」ボタンをタップするとプログレスダイアログが表示され、「end dialog singleTone」ボタンでそのダイアログを閉じる仕組みです。

手順3：MainActivity.java にコードを追加する

続いて、src/MainActivity.java に以下のコードを追加します。

package com.example.andy.myapplication;
import android.os.Bundle;
import android.support.v7.app.AppCompatActivity;
import android.view.View;
import android.widget.Button;
public class MainActivity extends AppCompatActivity {
   Button start;
   singleTonExample singletonexample;
   @Override
   protected void onCreate(Bundle savedInstanceState) {
      super.onCreate(savedInstanceState);
      setContentView(R.layout.activity_main);
      start = findViewById(R.id.start);
      singletonexample = singleTonExample.getInstance();
      findViewById(R.id.end).setOnClickListener(new View.OnClickListener() {
         @Override
         public void onClick(View v) {
            singletonexample.dismiss();
         }
      });
      start.setOnClickListener(new View.OnClickListener() {
         @Override
         public void onClick(View v) {
            singletonexample.show(MainActivity.this);
         }
      });
   }
}

このコードでは、singleTonExampleをシングルトンクラスとして利用しています。そこで次に、singleTonExample.javaというクラスを新規作成し、以下のコードを追加しましょう。

singleTonExample.java の作成

package com.example.andy.myapplication;
import android.app.Dialog;
import android.content.Context;
import android.view.Window;
public class singleTonExample {
   private Dialog dialog;
   private static final singleTonExample ourInstance = new singleTonExample();
   public static synchronized singleTonExample getInstance() {
      return ourInstance;
   }
   private singleTonExample() { }
   public void show(Context context) {
      if (dialog != null && dialog.isShowing()) {
         return;
      }
      dialog = new Dialog(context);
      dialog.requestWindowFeature(Window.FEATURE_NO_TITLE);
      dialog.setContentView(R.layout.layout_progress_dialog);
      dialog.setCancelable(true);
      dialog.show();
   }
   public void dismiss() {
      if (dialog != null && dialog.isShowing()) {
         dialog.dismiss();
      }
   }
}

ダイアログ用レイアウトファイルの作成

上記のコードでは、ダイアログにコンテンツビューを設定しています。そのため、resフォルダ内に layout_progress_dialog.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"
   android:gravity = "center">
   <ProgressBar
      android:layout_width = "wrap_content"
      android:layout_height = "wrap_content"
      android:id = "@+id/progress" />
</LinearLayout>

アプリを実行して動作を確認する

それでは、アプリケーションを実行してみましょう。ここでは、実機のAndroidスマートフォンをパソコンに接続しているものとします。Android Studioからアプリを起動するには、プロジェクト内のいずれかのアクティビティファイルを開き、ツールバーのRun（実行）アイコンをクリックします。接続したモバイルデバイスを選択すると、端末に以下のような初期画面が表示されます。

次に「start dialog in singleTone」ボタンをタップすると、シングルトンクラス経由でダイアログが表示されます。

まとめ

synchronizedを活用したシングルトンクラスにダイアログの表示・非表示処理を集約することで、アプリ内のどこから呼び出しても常に同一のダイアログインスタンスを扱うことができ、複数スレッドからの同時アクセスにも強いスレッドセーフな実装になります。ローディング表示など、アプリ全体で共通利用したいダイアログがある場合に非常に有効なパターンなので、ぜひ実際のプロジェクトでも活用してみてください。