デリゲートの実装例②

　デリゲートの実装方法について、活用事例を含めて紹介します。
ダイアログ(ポップアップ)内から外部クラスにある処理を制御する際に、デリゲートを利用した実装例です。

　今回の場合、引数付のデリゲートを利用し、ダイアログ内で情報を選択した前提で、その情報を外部クラス側に提供する処理を作成しています。

　前回の記事はこちらになります。

　　=>　デリゲートの実装例①

事前学習

　実装には UniRx を利用します。

　デリゲート、およびラムダ式による記述書式については、事前に理解しておく必要があります。
下記の教材を参考にしてください。

　　=>　デリゲート
　　=>　デリゲートとラムダ式の関係
　　=>　デリゲートとラムダ式の活用事例

設計

　ダイアログ(ポップアップ)を制御する際にデリゲートを利用した実装例です。
最初の教材で提示した図を再掲載します。

　具体的な実装内容としては、メソッドの引数にデリゲートを活用することで、
ダイアログ側では管理側との依存関係を持たず、管理側のメソッドを実行することが可能になります。

　今回の場合、引数付のデリゲートを利用し、ダイアログ内で情報を選択した前提で、その情報を外部クラス側に提供する処理を作成しています。

動画ファイルへのリンク

　デリゲートの活用方法は前回と同じです。
クラス同士の依存関係を持たない状態で、外部クラスのメソッドを実行できる状態を作り出します。

ダイアログの作成

　すでに作成済の場合には、この手順はスキップし、次のスクリプトの修正に入ってください。

　Canvas 内に生成するためのダイアログを作成し、プレハブにしておきます。
作成するダイアログは任意です。

　ここではサンプルとして、各ゲームオブジェクトの画像を紹介します。

ItemData クラスの作成

　ダイアログ内で取得できる情報として、ItemData クラスを作成しておきます。
次回の手順では、この情報をボタンに紐づけて扱うようにします。

<= クリックすると開きます

using UnityEngine;

[System.Serializable]
public class ItemData {

    public int id;

　　// TODO 他にもあれば追加。その際にはコンストラクタの引数を追加するか、新しいコンストラクタをオーバーロード機能を利用して追加する


    /// <summary>
    /// コンストラクタ
    /// </summary>
    /// <param name="no"></param>
    public ItemData(int no) {
        id = no;
    }
}

DialogBase クラスの修正

　
　DialogBaseクラスを修正します。

　UnityAction<ItemData> 型のフィールド onCloseActionItemData 変数は前回作成した onCloseAction 変数と同様に、外部クラスの処理を保持するために使用されます。
ここに処理を保持しておくことで、任意のタイミングで処理を実行できます。今回は ItemData 型の引数を定義しています。

　今回も直接的に外部クラスの参照を持たずに処理が実行できるため、依存関係がない(疎結合)状態が維持できています。

<= クリックすると開きます

using System;
using System.Collections;
using System.Collections.Generic;
using System.Linq;
using UnityEngine;
using UnityEngine.UI;
using UnityEngine.Events;
using DG.Tweening;
using UniRx;

public class DialogBase : MonoBehaviour, IDialogClose
{
    protected UnityAction onCloseAction;　　// 外部クラス(今回は DailogTest)の処理(メソッドの参照)を保持するデリゲート


////*　新しい変数を１つ追加　*////


    protected UnityAction<ItemData> onCloseActionItemData;


////*　ここまで　*////


    protected Canvas dialogCanvas;　　　　　// このダイアログを配置した Canvas の情報
    protected float fadeDuration = 1.0f;    // ダイアログを表示/非表示する際に時間
        
#pragma warning disable 0649
    [SerializeField] protected CanvasGroup canvasGroupDialog;
    [SerializeField] protected Button btnClose;
    [SerializeField] protected Ease fadeEase = Ease.InQuart;
#pragma warning restore 0649


    /// <summary>
    /// Dialog を使いまわす場合にはインスタンス後に最初に１回だけ実行する
    /// 引数で外部クラスの処理を受け取ることで依存関係を持たなくて済む
    /// </summary>
    /// <param name="closeAction"></param>
    public virtual void SetUp(UnityAction closeAction) {
        
        if(!transform.parent.TryGetComponent(out dialogCanvas))
        {
            Debug.Log("dialogCanvas 取得出来ません");
            return;
        }
        
        // UnityAction に外部クラスの処理(メソッドの参照)を保持しておく
        onCloseAction = closeAction;
        
        // ダイアログを閉じるボタンに処理を登録①
        //btnClose.onClick.AddListener(() => Hide());

        // ダイアログを閉じるボタンに処理を登録②
        btnClose.OnClickAsObservable()
            .ThrottleFirst(TimeSpan.FromSeconds(1.0f))
            .Subscribe(_ => Hide())
            .AddTo(this);
        
        // TODO 他にも１回だけ設定したいものを追加
        
    }


////*　新しいメソッドの追加　*////


    /// <summary>
    /// オーバーロード機能を利用
    /// Dialog を使いまわす場合にはインスタンス後に最初に１回だけ実行する
    /// 引数で外部クラスの処理を受け取ることで依存関係を持たなくて済む
    /// </summary>
    /// <param name="closeActionItem"></param>
    public virtual void SetUp(UnityAction<ItemData> closeActionItem) {
        
        if(!transform.parent.TryGetComponent(out dialogCanvas))
        {
            Debug.Log("dialogCanvas 取得出来ません");
            return;
        }
        
        // 外部クラスの処理を保持しておく
        onCloseActionItemData = closeActionItem;
        
        // ダイアログを閉じるボタンに処理を登録①
        //btnClose.onClick.AddListener(() => Hide());

        // ダイアログを閉じるボタンに処理を登録②
        btnClose.OnClickAsObservable()
            .ThrottleFirst(TimeSpan.FromSeconds(1.0f))
            .Subscribe(_ => Hide())
            .AddTo(this);
        
        // TODO 他にも１回だけ設定したいものを追加
        
    }


////*　ここまで　*////

        
    /// <summary>
    /// 外部クラスから実行
    /// ダイアログを表示
    /// </summary>
    public virtual void Show() {
        
        dialogCanvas.enabled = true;
        canvasGroupDialog.alpha = 0;
        
        // 表示準備や再設定がある場合
        OnEnterOpen();
        
        // ダイアログを表示するアニメ開始
        PlayOpenDialog();
    }

    /// <summary>
    /// ダイアログ内の表示準備や再設定がある場合に利用する
    /// </summary>
    protected virtual void OnEnterOpen() {
        
        // TODO 再設定の処理が必要な場合に処理を追加

    }

    /// <summary>
    /// ダイアログを表示するアニメ
    /// </summary>
    protected virtual void PlayOpenDialog() {
        canvasGroupDialog
            .DOFade(1.0f, fadeDuration)
            .SetEase(fadeEase)
            .SetLink(gameObject)
            .OnComplete(() => OnExitOpen());
    }

    /// <summary>
    /// ダイアログ表示後に実行しておく処理
    /// </summary>
    protected virtual void OnExitOpen() {
        // TODO 開いたときの挙動
        
    }

    /// <summary>
    /// ボタンから実行
    /// ダイアログを閉じる
    /// </summary>
    /// <returns></returns>
    public virtual bool Hide() {

        // 非表示にする前にやっておく処理
        OnEnterClose();
            
        // ダイアログを非表示にするアニメ開始
        PlayCloseDialog();
        
        return true;
    }

    /// <summary>
    /// 非表示にする前にやっておく処理
    /// </summary>
    protected virtual void OnEnterClose() {

        // 外部クラスで登録した外部の処理を実行

　　　　// ダイアログが閉じ始めたタイミングで、すぐに外部処理を実行したい場合
　　　　// OnExitClose() メソッドではなく、このタイミングで実行したいときに利用するので、ここではコメントアウト
        //onCloseAction?.Invoke();


////*　新しい処理の追加(OnExitClose() メソッドではなく、このタイミングで実行したいときに利用する)　*////


　　　　// ダイアログが閉じ始めたタイミングで、すぐに外部処理を実行したい場合
　　　　// OnExitClose() メソッドではなく、このタイミングで実行したいときに利用するので、ここではコメントアウト
        //onCloseActionItemData?.Invoke(new(1));
        

////*　ここまで　*////


    }
    
    /// <summary>
    /// ダイアログを非表示にするアニメ
    /// </summary>
    protected virtual void PlayCloseDialog() {
        canvasGroupDialog
            .DOFade(0, fadeDuration)
            .SetEase(fadeEase)
            .SetLink(gameObject)
            .OnComplete(() => OnExitClose());
    }

    /// <summary>
    /// ダイアログ非表示後に実行しておく処理
    /// </summary>
    protected virtual void OnExitClose() {

        dialogCanvas.enabled = false;
        
        // TODO 他にもあれば追加


////*　前回の処理の停止と、新しい処理の追加　*////

        
　　　　// ダイアログが閉じ終わってから外部処理を実行したい場合
        //onCloseAction?.Invoke();　　//　←　☆　コメントアウトする
　

　　　　// ItemData をインスタンスした上で引数で指定して、外部処理を実行
        onCloseActionItemData?.Invoke(new(1));　　//　←　数字を変えると、変えた数字が外部クラスに届きます。試してみましょう。


////*　ここまで　*////


    }
}

　新しく２つ目の SetUpメソッドを作成し、こちらは UnityAction<ItemData> 型の引数を受け取ります。
このメソッドも外部クラスから実行されますので、これにより、依存関係を持たずに外部クラスの処理をダイアログ内で実行できます。

　また、今回も OnEnterClose() メソッドと OnExitClose() メソッドにて、外部クラスの処理を実行する処理を書いています。
今回は引数を持っているメソッドを実行しているため、ダイアログ内で作成した情報を、外部クラスに提供することが可能になっています。

　　　　// ItemData をインスタンスした上で引数で指定して、外部処理を実行
        onCloseActionItemData?.Invoke(new(1));　　//　←　数字を変えると、変えた数字が外部クラスに届きます。試してみましょう。

　前回と同じように、外部クラスの処理がどういった処理なのかに合わせて、実行するタイミングを指定することで柔軟に対応が可能です。
これがデリゲートを活用した処理の大きなメリットになります。

DialogManager クラスの修正

　DialogManagerクラスを修正します。

　OpenDialog() メソッド内にあるダイアログを表示する処理の引数に
新しく作成する２つ目の CloseDialogAction メソッドを指定します。

　同名のメソッドは、引数の情報を変えることで２つ以上定義できます。
引数のオーバーロード機能です。調べておきましょう。

<= クリックすると開きます

using System.Collections;
using System.Collections.Generic;
using UniRx;
using UniRx.Triggers;
using UnityEngine;


public class DialogManager : MonoBehaviour
{
#pragma warning disable 0649
    [SerializeField] private DialogBase dialogPrefab;
    [SerializeField] private Transform dialogTran;
#pragma warning restore 0649
    
    private DialogBase dialogInstance;  // 生成済のダイアログを代入して保持しておく


    void Start() {
        this.UpdateAsObservable()
            .Where(_ => Input.GetKeyDown(KeyCode.A))
            .ThrottleFirst(System.TimeSpan.FromSeconds(1.0f))
            .Subscribe(_ => OpenDialog());
    }

    /// <summary>
    /// ダイアログ表示
    /// </summary>
    private void OpenDialog() {
        
        // ダイアログが生成されていない場合
        if (dialogInstance == null) {

            // 生成、初期設定
            dialogInstance = Instantiate(dialogPrefab, dialogTran, false);


////*　ここから処理を停止と追加　*////


　　　　　　// 引数として UnityAction 型のデリゲートを活用し、CloseDialogAction メソッドをダイアログ側に渡す
            //dialogInstance.SetUp(() => CloseDialogAction());　　//　←　コメントアウトします。



　　　　　　dialogInstance.SetUp(itemData => CloseDialogAction(itemData));  // 引数付のメソッドを指定します


////*　ここまで　*////


        }
        
        // ダイアログ表示   
        dialogInstance.Show();
    }

    /// <summary>
    /// ダイアログが非表示になったときに実行されるコールバック
    /// </summary>
    private void CloseDialogAction() {
        Debug.Log("ダイアログが非表示になりました");
    }


////*　ここから新しいメソッドを１つ追加　*////


    /// <summary>
    /// ダイアログが非表示になったときに実行されるコールバック
    /// オーバーロード機能を利用した、引数指定の異なる同名メソッド
    /// </summary>
    /// <param name="chooseItemData"></param>
    private void CloseDialogAction(ItemData chooseItemData) {
        Debug.Log($"Dialog 内で選択された情報が届きました : {chooseItemData.id}");
    }


////*　ここまで　*////


}

　OpenDialogメソッド内の処理を修正し、新しく作成した CloseDialogActionメソッドを指定します。
引数の情報を定義するため、ラムダ式を利用して処理を定義することで、ここでもデリゲート機能を利用しています。

　新しい CloseDialogActionメソッドも、ダイアログが非表示になったときに呼び出されるコールバック処理です。
今回はダイアログ内で設定された情報が引数を通じて届きますので、それをログとして表示しています。

　前回と同じで、この処理のポイントは、private メソッドである CloseDialogAction() メソッドが、
外部クラスであるダイアログ側から処理されて実行できる部分です。

　デリゲートを活用することで、クラス間の依存関係を保持せずに、外部クラスから処理を実行することが出来ます。
その上、外部クラスの情報を引数を通じて受け取るような形になっているので、ダイアログ内で設定された情報を、このクラス内で活用することが出来ます。

　この処理もテスト処理に該当しますので、同じような形で、外部クラスにメソッドを提供することでコールバック処理に出来ます。

解説

　ダイアログ側には DialogManager への依存関係がありません。
そのため、メンバ変数などを用意せずに済んでいます。

　代わりに UnityAction のデリゲートを用意し、ここに SetUp メソッドの引数として DialogManager クラスから渡ってきているメソッドの参照を保持します。

　このような設計にすることで、ダイアログ側は管理側である DialogManager クラスへの依存関係を持たずに、DialogManager 内にあるメソッドを実行する仕組みが構築できます。

　つまり、デリゲートの活用により、DialogBaseクラスとDialogManagerクラスは依存関係を持たずに連携できます。
具体的には、SetUpメソッドを通じて、DialogManagerクラスから外部の処理（CloseDialogActionメソッド）をDialogBaseクラスに渡すことができます。

　これにより、DialogBaseクラス内でダイアログの表示や非表示に関連する処理を実行しつつ、必要なタイミングでCloseDialogActionメソッドを外部クラスから実行できます。

　また、DialogManagerクラスはダイアログのテストと表示を管理する役割を果たし、DialogBaseクラスはダイアログの基本的な機能を提供する役割を果たしており、
これらのクラス間の協力がデリゲートを通じて実現されています。

まとめ

　引数付のデリゲートを使用することにより、外部クラスとのコミュニケーションを効果的に実現し、クラス間の疎結合性を保持しています。
今回はさらに、外部クラスの情報を引数を通じて別のクラスに提供する仕組みを実装できています。

　外部クラスの処理をデリゲートとして制御できるため、任意のタイミングで処理を実行できる部分もあり、実用性が高い設計になっており、
加えて、メソッドの引数を処理に組み込むことで、より多彩な処理が運用できる状態が出来ています。

　以上でこの教材は終了です。

　　=>　次は　デリゲートの実装例③　です。

このページを編集するこのページを元に新規ページを作成

印刷する

コメント（0）

デリゲートの実装例② - i-school 先頭へ

コメントをかく

名前	ユーザIDを使用しないで書き込む	ユーザーIDを使う	ログインする
画像コード	画像に記載されている文字を下のフォームに入力してください。
備考	「http://」を含む投稿は禁止されています。
本文
利用規約をご確認のうえご記入下さい

i-school