リファクタリング　実装例３

情報の管理方法

入れ子クラスの作成と配列(List)の初期化

　２つ以上のデータを１つの情報内にまとめて管理したい場合、クラスや構造体を作成すると管理しやすくなります。
他のクラスでの利用がなければ、新しいスクリプト・ファイルを作成するのではなく、利用したいクラス内で入れ子クラスとして宣言しておく方が
利用箇所の特定、および隠蔽の双方においてメリットがあります。

　管理したい情報２つだけの情報で、片方の情報をラベル代わりに利用し、中身を１つだけ保持したいケースでは Dictionary が利用できます。

入れ子クラスの宣言

　入れ子クラスはクラスの継承が行えないという制約があります。
そのため new したタイミングでメンバ変数内に値を代入したい場合にはコンストラクタ・メソッドを用意しておきます。
コンストラクタは引数のオーバーロード機能が利用できますので、複数のコンストラクタを用意しておくことで、状況に応じて使い分けることが可能です。

    public class InfoData {
        public string message;
        public Color32 imageColor;

        /// <summary>
        /// コンストラクタ①。用途を限定した特殊なコンストラクタ
        /// </summary>
        public InfoData() {
            // オブジェクト初期化子を使う場合には、空っぽのコンストラクタが必要になります
        }

        /// <summary>
        /// コンストラクタ②。一般的なコンストラクタ
        /// 引数のオーバーロード機能を使い、コンストラクタを２つ用意します
        /// </summary>
        /// <param name="str"></param>
        /// <param name="color"></param>
        public InfoData(string str, Color32 color) {
            message = str;
            imageColor = color;
        }
    }

配列として管理する方法

メンバ変数の宣言時の初期化

        // 配列の場合(この変数自体はメンバ変数で用意しておきます)
        InfoData[] infoDatas;

        // メンバ変数の宣言時に初期化する場合(メソッド内でも書けます)
        // この処理にはコンストラクタ②を利用しています。
        InfoData[] infoDatas = new InfoData[dataCount] {
            new InfoData("Remove", new Color32(255, 31, 0, 150)), 
            new InfoData( "Put", new Color32(0, 246, 67, 150))
        };

通常の初期化

　メンバ変数の宣言時に初期化を行わない場合、メソッド内で初期化を行うことになります。
その場合の初期化の方法は２種類あります

　こちらの初期化の方法は、コンストラクタ②を利用した、通常の初期化の方法です。

  //まずサイズを設定します
  infoDatas = new InfoData[dataCount];

  // 値を代用します
  infoDatas[0] = new InfoData("Remove", new Color32(255, 31, 0, 150));
　infoDatas[1] = new InfoData("Put", new Color32(0, 246, 67, 150));

オブジェクト初期化子

　こちらの初期化の方法はオブジェクト初期化子を用いた方法です

　この方法は、コンストラクタを何も用意しないか、あるいは今回のようにコンストラクタを用意した場合には
引数のオーバーロード機能を利用し、①と②の２つのコンストラクタを用意します
そのうちの①のコンストラクタを利用しています

  //まずサイズを設定します
  infoDatas = new InfoData[dataCount];

  // 値を代用します
  infoDatas[0] = new InfoData { message = "Remove", imageColor = new Color32(255, 31, 0, 150) };
  infoDatas[1] = new InfoData { message = "Put", imageColor = new Color32(0, 246, 67, 150) };

List として管理する方法

　List の場合(この変数自体はメンバ変数で宣言して用意しておきます)

  List<InfoData> infoDataList;

  List<InfoData> infoDataList = new List<InfoData>();

  List<InfoData> infoDataList = new ();

通常の初期化

　List の場合、サイズの指定は不要なので、そのまま追加します。
Add メソッドを利用して初期化(追加)する方法の場合は、コンストラクタ②を使っています
丁寧に書く場合、変数に代入してから Add します。この場合、変数としてその後も利用できます。

        // ここから、メソッド内の処理になります(メンバ変数の宣言時に new しておいてもよいです)
        infoDataList = new List<InfoData>();

        InfoData infoData = new InfoData("Remove", new Color32(255, 31, 0, 150));
        infoDataList.Add(infoData);
            
        // 変数を利用する必要がない場合には、Add 内で直接インスタンスして追加します
        infoDataList.Add(new InfoData("Put", new Color32(0, 246, 67, 150)));

コレクション初期化子

　List では下記のような初期化の方法も出来ます。
この初期化の方法をコレクション初期化子といいます
この方法もコンストラクタ②を使っています

　なおこちらの処理は変数の宣言時にも利用できます

        infoDataList = new List<InfoData>
        {
           new InfoData("Remove", new Color32(255, 31, 0, 150)),
           new InfoData("Put", new Color32(0, 246, 67, 150))
        };

Dictionary として管理する方法

　今回は利用しませんが、同じくコレクションである Dictionary の使い方も書いておきます

        // Dictionary の場合(この変数自体はメンバ変数で用意しておきます)
        Dictionary<string, Color32> infoDataDic;

        // Add メソッドを利用する場合
        // このケースでは List と違い、コンストラクタは不要です
        infoDataDic = new Dictionary<string, Color32>();
        infoDataDic.Add("Remove", new Color32(255, 31, 0, 150));
        infoDataDic.Add("Put", new Color32(0, 246, 67, 150));

コレクション初期化子

        // コレクション初期化子を利用した初期化の場合
        // こちらもコンストラクタは不要です
        // List と同様に変数の宣言時にも利用できます
        infoDataDic = new Dictionary<string, Color32> {
            { "Remove", new Color32(255, 31, 0, 150) },
            { "Put", new Color32(0, 246, 67, 150) }
        };

実装例

　これらをすぐに使いこなせる必要はありませんが、覚えておいた方がよいです。
理由としては、ネットの記事などでは、実に色々な方法で処理が掲載されていますので、
読み手としては、いずれの方法も読み解ける必要があるためです。

　特にプログラムは、繰り返し使いたい処理はメソッドにまとめる、メソッドは引数を利用することで内部処理が自動分岐化できる、という部分が重要になります。

　そういった部分を意識し、着目して処理を書いていくように心がけることで、処理が読み解けるようになり、
色々な書き方を覚えてスキルアップしていくことができます。

　今回は、基礎である配列や enum の機能を利用し、それを組み合わせたり、キャストして利用することで応用しています。
そのため、色々な構文をイメージして作っていくためには、基礎部分もしっかりと理解しておくことが大切になってきます。
ここであれば、引数の可読性を上げるために、enum を用意し、それをキャスト機能を利用して int 型の情報に置き換えることで
配列の index として利用できるロジックを組み込んでいます。

＜enum を利用しない場合＞

　modeChange.UpdateShowInfos(0);

＜enum を利用する場合＞

　modeChange.UpdateShowInfos((int)PrepareType.Remove);

　メソッド内で処理が配列によって分岐されて適用されるケースの場合、どちらの処理の方が読みやすいか、わかりやすいかという部分です。

メソッドの定義

using System.Collections;
using System.Collections.Generic;
using UnityEngine;
using UnityEngine.UI;

public class ModeChange : MonoBehaviour {

    private GameManager gameManager;

    //ゲームモードボタン用のメンバ変数群
    [SerializeField]
    private Button btnModeChange;

    [SerializeField]
    private Text txtGameMode;

    [SerializeField]
    private Text txtModeChangeButton;

    [SerializeField]
    private GameObject selectUnitPanel;

    [SerializeField]
    AudioClip playBtnAudio;

    private AudioController audioCon;

    //ユニット設置/削除ボタン用のメンバ変数群
    [SerializeField]
    private Button btnPreparateModeChange;
    //public Button BtnPreparateModeChange { get => btnPreparateModeChange; }　　　//　メソッド化すれば外部から直接の指定は不要になります

    [SerializeField]
    private Text txtPreparateModeChangeButton;
    //public Text TxtPreparateModeChangeButton { get => txtPreparateModeChangeButton; }　　　//　メソッド化すれば外部から直接の指定は不要になります


    /// <summary>
    /// メソッドをボタンに設定
    /// </summary>
    /// <param name="gameManager"></param>
    public void SetupChangeModeButton(GameManager gameManager) {
        this.gameManager = gameManager;

        btnModeChange.onClick.AddListener(() => ChangeGameMode());
        btnPreparateModeChange.onClick.AddListener(() => PreparateChangeGameMode());
    }

    /// <summary>
    /// ゲームモードの切り替え
    /// </summary>
    /// <param name="gameManager"></param>
    public void ChangeGameMode() {
        if (gameManager.gameMode != GameManager.GameMode.Play) {
            gameManager.gameMode = GameManager.GameMode.Play;

            txtGameMode.text = "GAME MODE：プレイ";

            AudioSource.PlayClipAtPoint(playBtnAudio, Camera.main.transform.position, 0.7f);

            //モードチェンジボタンを非アクティブにする
            btnModeChange.gameObject.SetActive(false);

            //ユニット選択パネルを非アクティブにする
            selectUnitPanel.SetActive(false);

            //ユニット設置モードボタンを押せない状態にする
            btnPreparateModeChange.interactable = false;

            gameManager.stageGenerator.SwitchStageLayer();

            //BGMの切り替え
            audioCon.StopBgm(GameManager.stageLevel);
            audioCon.PlayBgm(audioCon.battleNumber);  // battleNumber の汎用性が低いように見えます。
                                                      // StageData にBGM用の曲番号を用意するか、stageLevel をそのまま利用できた方が作りやすいと思います
                                                      // 作りやすい、というのは、自分がステージを増やしていく際にも当てはまりますし、第三者が作る場合にも当てはまります
        }
    }

    /// <summary>
    /// ユニット設置/削除モードの切り替え
    /// </summary>
    public void PreparateChangeGameMode() {
        if (gameManager.gameMode != GameManager.GameMode.Preparate_Remove) {
            gameManager.gameMode = GameManager.GameMode.Preparate_Remove;

            // 処理をメソッド化しましょう　=>　public のメソッドにすることで、外部からこの2行分の処理を実行できるようになります
            // そうすると pulbic で用意しているメンバ変数を２つ削除できます(UIManager で1回しか利用していないもの) => 活用頻度が低く、メンバ変数として用意するのは勿体ない
            // このクラス内での処理の動きだけではなく、外部からの活用が想定される場合には、例え2行であっても、メソッド化した方が効率がよいです
            UpdateShowRemoveInfo();

            //txtPreparateModeChangeButton.text = "Remove";
            //btnPreparateModeChange.image.color = new Color32(255, 31, 0, 150);
        } else {
            gameManager.gameMode = GameManager.GameMode.Preparate;

            // 処理をメソッド化しましょう。理由は上記と同じです
            UpdateShowPreparateInfo();

            //txtPreparateModeChangeButton.text = "Put";
            //btnPreparateModeChange.image.color = new Color32(0, 246, 67, 150);
        }
    }

    public void SetupModechange(AudioController audioCon) {
        this.audioCon = audioCon;
    }

    public void UpdateShowRemoveInfo() {
        txtPreparateModeChangeButton.text = "Remove";
        btnPreparateModeChange.image.color = new Color32(255, 31, 0, 150);
    }

    //　UIManager 内で public の値を直接書き換えていますが、このように書き換えたい情報を public のメソッド化すれば
    //　現在ある public のメンバ変数２つを用意する必要がなくなります
    public void UpdateShowPreparateInfo() {
        txtPreparateModeChangeButton.text = "Put";
        btnPreparateModeChange.image.color = new Color32(0, 246, 67, 150);
    }

    
// 上記のように２つの変数を１組１セットで使いたいようなケースで、かつ利用範囲がこのクラスに限定されるのであれば
// このクラス内で入れ子のクラスを定義する(作る)とよいです。

    public class InfoData {
        public string message;
        public Color32 imageColor;

        /// <summary>
        /// コンストラクタ①。用途を限定した特殊なコンストラクタ
        /// </summary>
        public InfoData() {
            // オブジェクト初期化子を使う場合には、空っぽのコンストラクタが必要になります
        }

        /// <summary>
        /// コンストラクタ②。一般的なコンストラクタ
        /// 引数のオーバーロード機能を使い、コンストラクタを２つ用意します
        /// </summary>
        /// <param name="str"></param>
        /// <param name="color"></param>
        public InfoData(string str, Color32 color) {
            message = str;
            imageColor = color;
        }
    }

 
// このように定義して、それを配列か、List で初期化して中身を作ります。    

    private void SetInfoData(int dataCount = 2) {
		
		// このメソッドをゲーム開始の段階で実行します。デバッグするなら Start メソッドで実行します。

        // 配列の場合(この変数自体はメンバ変数で用意しておきます)
        InfoData[] infoDatas;

        // メンバ変数の宣言時に初期化する場合(メソッド内でも書けます)
        // この処理にはコンストラクタ②を利用しています。
        InfoData[] infoDatas = new InfoData[dataCount] {
            new InfoData("Remove", new Color32(255, 31, 0, 150)), 
            new InfoData( "Put", new Color32(0, 246, 67, 150))
        };

        // 上記の方法以外で初期化する場合、まずサイズを設定します。ここから、メソッド内の処理になります
        infoDatas = new InfoData[dataCount];

        // 初期化の方法は2種類あります。これはオブジェクト初期化子を用いた方法です
        // この方法は、コンストラクタを何も用意しないか、あるいは今回のようにコンストラクタを用意した場合には
        // 引数のオーバーロード機能を利用し、①と②の２つのコンストラクタを用意します
        // こちらは①のコンストラクタを利用しています
        infoDatas[0] = new InfoData { message = "Remove", imageColor = new Color32(255, 31, 0, 150) };

        // こちらの初期化の方法は、コンストラクタ②を利用した、通常の初期化の方法です
        infoDatas[1] = new InfoData("Put", new Color32(0, 246, 67, 150));

        // List の場合(この変数自体はメンバ変数で用意しておきます)
        List<InfoData> infoDataList;

        // ここから、メソッド内の処理になります(メンバ変数の宣言時に new しておいてもよいです)
        infoDataList = new List<InfoData>();

        // List の場合、サイズの指定は不要なので、そのまま追加します。
        // Add メソッドを利用して初期化(追加)する方法
        // この場合は、コンストラクタ②を使っています
        // 丁寧に書く場合、変数に代入してから Add します。この場合、変数としてその後も利用できます。
        InfoData infoData = new InfoData("Remove", new Color32(255, 31, 0, 150));
        infoDataList.Add(infoData);
            
        // 変数を利用する必要がない場合には、Add 内で直接インスタンスして追加します
        infoDataList.Add(new InfoData("Put", new Color32(0, 246, 67, 150)));


        // List では下記のような初期化の方法も出来ます。
        // この初期化の方法をコレクション初期化子といいます
        // この方法もコンストラクタ②を使っています
        // なおこちらの処理は変数の宣言時にも利用できます
        infoDataList = new List<InfoData>
        {
           new InfoData("Remove", new Color32(255, 31, 0, 150)),
           new InfoData("Put", new Color32(0, 246, 67, 150))
        };


        // 今回は利用しませんが、同じくコレクションである Dictionary の使い方も書いておきます
        // Dictionary の場合(この変数自体はメンバ変数で用意しておきます)
        Dictionary<string, Color32> infoDataDic;

        // Add メソッドを利用する場合
        // このケースでは List と違い、コンストラクタは不要です
        infoDataDic = new Dictionary<string, Color32>();
        infoDataDic.Add("Remove", new Color32(255, 31, 0, 150));
        infoDataDic.Add("Put", new Color32(0, 246, 67, 150));


        // コレクション初期化子を利用した初期化の場合
        // こちらもコンストラクタは不要です
        // List と同様に変数の宣言時にも利用できます
        infoDataDic = new Dictionary<string, Color32> {
            { "Remove", new Color32(255, 31, 0, 150) },
            { "Put", new Color32(0, 246, 67, 150) }
        };


        // 以上のいずれかの方法を利用して Text に使う文字列と Image に使う色を事前に用意しておくことが出来ます。
        // ただし、Dictionary は不向きなので、今回は利用するなら配列か List がよいです
        // Dictionary は何番目という index での指定が出来ません。"Remove" と書いて、Color を見つける、という形になるためです。

        // このように準備した場合、メソッドに引数を用意し index の番号を指定することで、１つのメソッドで２つの役割を代用することが出来るようになります

    }

    /// <summary>
    /// 引数の index により自動的に文字と色を変える
    /// 外部クラスから実行する場合には、modeChange.UpdateShowInfos(1) のように利用する
    /// 引数が分かりにくい場合には、enum を用意する
    /// </summary>
    /// <param name="index"></param>
    public void UpdateShowInfos(int index) {

        // index = 0 は、"Remove", new Color32(255, 31, 0, 150) が代用されている配列/List を指定します
        // index = 1 は、"Put", new Color32(0, 246, 67, 150) が代用されている配列/List を指定します

        // 配列の場合
        txtPreparateModeChangeButton.text = infoDatas[index].message;
        btnPreparateModeChange.image.color = infoDatas[index].imageColor;

        // List の場合
        txtPreparateModeChangeButton.text = infoDataList[index].message;
        btnPreparateModeChange.image.color = infoDataList[index].imageColor;


        // メソッドを２つ用意するのではなく、このような方法を用いることもできます

        // 特に２つ、３つの値の切り替えはよいですが、それ以上の複数の情報を切り替える場合には、その分だけ分岐やメソッドを個別に作らなければならなくなります。
        // 内容も、代入する値が違うだけで、処理はまったく同じメソッドがいくつも並ぶことになります。

        // そのような利用方法は、分岐を増やすたびにプログラム自体も追加しなければならないので、
        // 一度書いたら、あとは分岐が増えても自動的に処理をしてくれるようなメソッドを検討した方がよいです
    }
}


///　メソッドの引数がわかりにくい場合には enum を用意します


    public enum PrepareType {
        Remove,
        Put
    }


// enum には自動的に番号が採番され、0 から始まります。
// 上記であれば、Remove = 0、Put = 1 です。それを int 型にキャストして型を変えて使います


// その場合には、modeChange.UpdateShowInfos((int)PrepareType.Remove); という命令で実行でき、引数がわかりやすくなります。

メソッドの呼び出し命令

　実行命令は先ほども書いたように enum を用意した場合も含めて、2種類の方法が利用できます。

＜enum を利用しない場合＞

　modeChange.UpdateShowInfos(0);

＜enum を利用する場合＞

　modeChange.UpdateShowInfos((int)PrepareType.Remove);

考え方のポイント

　プログラムの難しい部分は、ルール化と定型(パターン)化が、異なっている部分です。

　例えば変数の宣言にはルールがあり、修飾子・データ型名・変数名という順番で記述するように定義されています。
ですが、変数名にはルールはありません。
基本的にはキャメル式という方式が用いられていて小文字スタートで記述していますが、
これはルールでないので、大文字で書く人もいますし、_ を利用したキャメル式も記述出来ます。
そして名前も明確なもの(固定名)がありません。エンジニアが、どういった意図で使うのかを考えて、任意に命名します。

　このように、ルール化はされていても、名前にはルールがなく、そしてそれもパターンがない(用途によって異なる)ため、
テンプレートのようなものが作りにくく、数学のように１つの決まった回答というものが用意されていません。

　そのため、ルールの部分は暗記して覚えていくことができますが、それ以外の部分は暗記出来ません。
この辺りのイメージをしっかりと持っておくと、学習の際に役立つと思います。

　プログラムにおいて、ルールとパターンとは違う、そしてパターンは無い等しい、という考え方です。

メソッドの作り変え方

　そのような目線で、先ほどの ModeChange クラスに新しく用意した UpdateShowInfos メソッドを見てみます。

public void UpdateShowInfos(int index) {

    // 配列の場合
    txtPreparateModeChangeButton.text = infoDatas[index].message;
    btnPreparateModeChange.image.color = infoDatas[index].imageColor;

    // List の場合
    txtPreparateModeChangeButton.text = infoDataList[index].message;
    btnPreparateModeChange.image.color = infoDataList[index].imageColor;
}

　実行命令は先ほども書いたように enum を用意した場合も含めて、2種類の方法が利用できます。

＜enum を利用しない場合＞

　modeChange.UpdateShowInfos(0);

＜enum を利用する場合＞

　modeChange.UpdateShowInfos((int)PrepareType.Remove);

　実行命令で指定している引数は、UpdateShowInfos メソッドの引数に int 型が定義されているので、その型に合わせています。
では、UpdateShowInfos メソッドの引数が、int 型ではなく、enum の PrepareType 型である場合には、どうなるでしょうか。

　まず、UpdateShowInfos メソッド自体を作り変えてみます。

public void UpdateShowInfos(PrepareType prepareType) {

    // 配列の場合
    txtPreparateModeChangeButton.text = infoDatas[(int)prepareType].message;
    btnPreparateModeChange.image.color = infoDatas[(int)prepareType].imageColor;

    // List の場合
    txtPreparateModeChangeButton.text = infoDataList[(int)prepareType].message;
    btnPreparateModeChange.image.color = infoDataList[(int)prepareType].imageColor;
}

　引数が PrepareType に変わることで、そのままの情報を配列や List の番号に指定できなくなります。
配列と List の [ ] の部分は index の指定の場所であり、ルールとして int 型の情報が必要になるので、
このメソッド内で enum の PrepareType 型をキャストして、int 型に置き換えてから、利用するように変化しています。

　そうなると、実行命令の方にも変化があります。

まず、enum での指定しかできなくなりますので、必然的に命令は1種類になります。

　modeChange.UpdateShowInfos(PrepareType.Remove);

　先ほどはこの実行命令のタイミングで、UpdateShowInfos メソッドの引数の型に合わせるためにキャストして渡していましたが、
今回は、PrepareType が引数の型になっているので、このタイミングではキャストしないで処理を書けます。

　このように、メソッド１つとっても、引数の型の指定の方法で、異なる処理のロジックを考えるようになります。

　どちらがよりよいのかは書き手と読み手に委ねられますが、個人的には、この書き方の方が実行命令が分かりやすくなると思います。
ただし、UpdateShowInfos メソッド内でキャストするので、配列の [ ] でキャストする処理が見慣れない場合には、処理が読めない可能性もあります。
一長一短です。

モアベターな処理をつくることを心がけることが大切ですが、読み手によっては読めない可能性も出てくるケースもあるため、
平坦な処理を書いておいた方が無難になることもあります。

　大切なことは、このように、メソッドの引数の作り方にも色々な方法があるので、１つの固定パターンで考えるのではなく
どういう処理を作っていけば読みやすいか、書きやすいか、という部分にフォーカスした方がよい、という部分と
プログラムは書き手によって異なる書き方が出来、それがプログラムの柔軟性になっているので、
読みやすく汎用性の高い処理を作るためには、自分も色々な処理の書き方を学び(ルールを覚え)、
その中でどれがよいのか柔軟に方法に考えていく(ルールに基づいた自由度の中で模索する)、という部分とになります。

　この辺りの説明も読むだけですと難しかったりしますので、ノートなどに書いて、自分なりにまとめてみると、段々と理解が深まります。

　以上になります。

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

印刷する

コメント（0）

リファクタリング　実装例３ - i-school 先頭へ

コメントをかく

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

i-school