[C#] indexer(インデクサー)とyield(リファレンス)

こんにちは。明月です。
今日はindexer(インデクサー)とyield(リファレンス)について勉強します。
indexerとyieldの場合は他の言語にはない文法です。なので少し理解が大変だと思われることもできるが以外に簡単だしよく理解して利用すればプログラム品質があがることにもできると思います。

indexer(インデクサー)

indexerはクラスを配列みたいに宣言するように使用するキーワードです。

class クラス名 { アクセス修飾子 データタイプ this[データタイプ パラメタ名] { get { } set { } } }

using System; using System.Collections.Generic; using System.Linq; using System.Text; using System.Threading.Tasks; namespace indexer { public enum TYPE { Type1, Type2, Type3 } public class IndexerEx { //インデクサー public String this[TYPE index] { //返却するところ get { //インデックス区分で返却値 switch (index) { case TYPE.Type1: return "TYPE1"; case TYPE.Type2: return "TYPE2"; case TYPE.Type3: return "TYPE3"; } return null; } //格納するところ set { Console.WriteLine(value); } } } class Program { static void Main(string[] args) { IndexerEx test = new IndexerEx(); //配列みたいに使います。 Console.WriteLine(test[TYPE.Type1]); Console.WriteLine(test[TYPE.Type2]); Console.WriteLine(test[TYPE.Type3]); Console.WriteLine("Press Any Key..."); Console.ReadLine(); } } }

上の例をみるとクラスを配列みたいに使っています。でも内部は本当の配列の構造になっていません。ただ、クラスを使用方法で配列みたいに宣言することで見やすくなることなので性能には影響がありません。

yield

yieldの場合はデザインパタンの「interator」パタンと関係があるキーワードです。
「interator」パタンは繰り返す的なデータ集団を一つずつに分離してデータを取り出しするパタンをいいます。普通のリストでデータを取り出す型は下記とおりです。

using System; using System.Collections.Generic; using System.Linq; using System.Text; using System.Threading.Tasks; namespace yieldEx { class ListTest { //メンバリスト private List<int> list = new List<int>(); //データ格納 public void setData(int data) { list.Add(data); } //内部メンバが外部に出る。 public List<int> getList() { return list; } //インデックスから取得(問題はインデックスを知らない場合？） public int getList(int index) { return list[index]; }<p></p> //インデックス計算のため、リストサイズ返却 public int getCount() { return list.Count; } } class Program { static void Main(string[] args) { ListTest test = new ListTest(); test.setData(10); test.setData(20); test.setData(30); //リストを外部から取得できる？OOPの特徴のカプセル化になれない List<int> list = test.getList(); //リストのインデックスをしらないのでエラー発生率が高い int data = test.getList(5); Console.WriteLine("Press Any Key..."); Console.ReadLine(); } } }

上の例をみると外部で「ListTest」クラスのメンバ変数「list」からデータを取得するようにはメンバ変数自体を返却するかインデックスを受け取って返却するかの一つです。
初めの方法でメンバ変数「list」を返却することですが、そうすればOOPの特性のカプセル化の意味がなくなります。実際に実装する形は２つ目ですが、インデックスを計算するようにリストの内部関数を連携して作成すべきです。(adapterパタン - リスト個数関数、リスト削除関数、リスト取得関数等)

using System; using System.Collections.Generic; using System.Linq; using System.Text; using System.Threading.Tasks; namespace yieldEx { class ListTest { //メンバリスト private List<int> list = new List<int>(); //データ格納 public void setData(int data) { list.Add(data); } //IEnumerableを返却してクラス内部オブジェクトと完全に分離 public IEnumerable<int> getList() { foreach(int item in list) { yield return item; } yield break; } } class Program { static void Main(string[] args) { ListTest test = new ListTest(); test.setData(10); test.setData(20); test.setData(30); //リスト値を返却 IEnumerable<int> list = test.getList(); IEnumerator<int> iter = list.GetEnumerator(); //次のデータがあるかどうか while (iter.MoveNext()) { //現在のポイントのデータ Console.WriteLine(iter.Current); } Console.WriteLine("Press Any Key..."); Console.ReadLine(); } } }

上の例を見るとリストを返却することではなく、IEnumerableタイプを返却します。それでクラス内のリストと外部クラスで呼び出したリストのオブジェクトを分離しています。

初めに説明したとおりにindexer,yieldは他の言語にはないキーワードです。(筆者が知ってる言語中では。)それで開発する間によく使うキーワードではないと思います。それでもよく認識して使えば可読性が上がると思うのでよく覚えていきましょう。