今回のテーマ

以下の項目について復習する。

デリゲート
ラムダ式
System.Action
System.Func

導入

以下のプログラムについて、Array.Sort() で降順ソートを行っている。この Sort() の引数の意味、指定方法を理解できるようになることが目標である。

using System;

class Program
{
    static void Main()
    {
        // 配列に格納された整数を降順で並べ替える
        int[] arr = { 10, 409, 3, 64, 0, -2, 13 };
        Array.Sort(arr, (a, b) => b - a);
        Array.ForEach(arr, Console.WriteLine);
    }
}

インターネットを検索などして方法を見つけた際に、「ネットからコピペしたのでどういう意味なのかはわからない」という状態はよろしくない。ここでは、Visual Studio の機能を活用して、コードの意味を正しく理解する方法を学ぶ。

デリゲートとは

デリゲートとは「メソッドの型」である。int, string, Console などは「データ型」である。メソッドの型という発想により、メソッドを変数に代入したり、引数にメソッドをしていできるようになる。

デリゲート（メソッドの型）は以下が同じであれば同じ型であるとみなされる。

戻り値の型
引数の型
引数の数

ここがデータ型とは違うところである。データ型は「データ型が同じ」場合に同じ型であるとみなす。

Unity でデリゲートを使っているところ

Unity 内で「無意識に」デリゲートを使っているところがある。それはボタンのクリック時に実行するメソッドを指定する時である。ボタンをクリックした時に実行する処理としてメソッドを割り当てているが、これは実際はデリゲートを使ってメソッドを割り当てている。

デリゲートを理解していれば、スクリプトから「クリック時に実行される処理」を指定することもできる（リファレンス参照）。ただしその場合、割り当てられたメソッドは Inspector に表示されないことに注意すること。

Unity UI の EventTrigger コンポーネントはよりわかりやすい。以下のようなコンポーネントを使って EventTrigger のイベントに割り当ててみると、ShowMousePosition と Test1 メソッドは選べるのに、Test2, Test3 メソッドは選べない。

using UnityEngine;
using UnityEngine.EventSystems;

public class DelegateTest : MonoBehaviour
{
    // マウスのスクリーン座標を出力する。EventTrigger から呼ばれるためのメソッド。
    public void ShowMousePosition(BaseEventData bed)
    {
        PointerEventData pev = (PointerEventData)bed;
        print(pev.position);
    }

    public void Test1() { }
    public bool Test2() { return true; }
    public bool Test3(BaseEventData bed) { return true; }

}

Test2, Test3 が選べないのは、デリゲートが異なるためである。ShowMousePosition メソッドと Test3 メソッドは引数が同じだが、戻り値が異なるので異なるデリゲートと判別され、割り当て時に除外されてしまう。

内部的な仕様は明らかではないが、Button の OnClick() や EventTrigger に UI からメソッドを指定する時には、戻り値が void のデリゲートのみが指定できるのだろう。（リファレンスを見ると UnityAction を使っていると書いてあるので、おそらくそうなのでしょう）

Array.Sort() の引数には何を渡しているのか

導入のコードに戻る。まずは、Sort() メソッドの引数に何を渡しているのかを確認しなくてはならない。Visual Studio で "Sort" という文字列にマウスカーソルを合わせて待つと、以下のようにポップアップヘルプでメソッドの定義が表示される。17 個のオーバーロードのうちの一つを使っていることがわかる。

ここでマウスカーソルをポップアップ内に移動し、"Comparison" をクリックすると、以下のように Comparison の定義が表示される。

これで、この Sort() メソッドでは、第一引数にソートする対象の配列を、第二引数に「比較 (comparison)」を行うためのデリゲート（つまりメソッド）を渡していることがわかる。そして、そのデリゲート（つまりメソッドの型）は、

引数 (int, int)
戻り値 int

であることもわかる。

Array.Sort() の仕様を調べる

ここまでで、ある程度習熟した者であれば、Comparison にどのようなメソッドを渡すのかわかるだろう。IComparable.CompareTo() または IComparable<T>.CompareTo() と同じことをすればよいと想像がつくが、そうでない場合も問題ではない。リファレンスを見て何を渡すのかを確認すればよい。

Sort() の上にカーソルがある状態で F1 キーを押せば、リファレンスが表示される。オーバーロード一覧から、引数が (T[], Comparison<T>) であるものを見つけて内容を確認しましょう。

リファレンスを見ると、さらに Comparison<T> の説明へリンクされている。そこを読めば、Comparison には渡された 2つの引数 x, y の大小関係（前後関係）を戻り値として返すメソッドを渡す、ということがわかる。

これがわかれば、以下のように Array.Sort() を使った降順ソートを書くことができる。

// パターン A
using System;

class Program
{
    static void Main()
    {
        // 配列に格納された整数を降順で並べ替える
        int[] arr = { 10, 409, 3, 64, 0, -2, 13 };
        Comparison<int> comparison = Descending;   // デリゲートを使って変数にメソッドを割り当て、渡す
        Array.Sort(arr, comparison);
        Array.ForEach(arr, Console.WriteLine);
    }

    // x と y の降順の前後関係を定義する
    static int Descending(int x, int y)
    {
        if (x > y)
            return -1;  // 降順なので、x の方が大きければ x の方が前になる
        else if (x == y)
            return 0;
        else
            return 1;
    }
}

// パターン B
using System;

class Program
{
    static void Main()
    {
        // 配列に格納された整数を降順で並べ替える
        int[] arr = { 10, 409, 3, 64, 0, -2, 13 };

        // x と y の降順の前後関係を定義する
        int Descending(int x, int y)
        {
            return y - x;   // 降順なので、x の方が大きい時には負の値を返す
        }   // メソッド内にメソッドを定義することもできる。この場合スコープは Main メソッド内に限定される。

        Array.Sort(arr, Descending);    // わざわざ変数に入れずに直接メソッドを渡す
        Array.ForEach(arr, Console.WriteLine);
    }
}

匿名メソッドとラムダ式

前述のパターン A, B では Descending（降順）というメソッドを作って指定したが、汎用的でないメソッドをわざわざ定義するのは以下のような都合の悪い事態を招くことがある。

処理がコードの別の箇所に飛んだりして、コードの見通しが悪い
コードを記述する際に別の箇所に記述する必要があると、生産性が落ちる
他で使われる予定で作っていないのに、別のプログラマーによって予期せぬ箇所でメソッドが使われる
メソッドの元来の用途・考え方と合っていない

このような問題を解決する方法として、匿名メソッドが良く使われる。匿名 (anonymous) メソッドとは「名前を付けないメソッド」であり、コードに埋め込むことができる。無名 (nameless) メソッドと呼ばれる場合もある。

ラムダ式は、匿名メソッドを定義する時に使う書き方の一つである。C# では delegate 演算子を使って匿名メソッドを定義することもできるが、現在ではほとんど使われていない。

基本的な書き方は以下の通り。

(引数) =>
{
    // ここにメソッドを定義する
}

今回の降順ソートのコードに対しては、以下のように匿名メソッドを使って Comparison を定義することができる。

using System;

class Program
{
    static void Main()
    {
        // 配列に格納された整数を降順で並べ替える
        int[] arr = { 10, 409, 3, 64, 0, -2, 13 };
        // x と y の降順の前後関係を定義する匿名メソッドを定義し、変数に割り当てる
        Comparison<int> comparison = (int x, int y) =>
        {
            return y - x;
        };
        Array.Sort(arr, comparison);
        Array.ForEach(arr, Console.WriteLine);
    }
}

匿名メソッドを変数に割り当てずに引数に直接渡すと、以下のようになる。

using System;

class Program
{
    static void Main()
    {
        // 配列に格納された整数を降順で並べ替える
        int[] arr = { 10, 409, 3, 64, 0, -2, 13 };
        // x と y の降順の前後関係を定義する匿名メソッドを定義し、引数に渡す
        Array.Sort(arr, (int x, int y) =>
        {
            return y - x;
        });
        Array.ForEach(arr, Console.WriteLine);
    }
}

ラムダ式の省略

だいぶ近づいてきたが、まだ冒頭で示したコードにはなっていない。冒頭のコードにはない記述がある。

ラムダ式は、省略できる場合は省略して記述するのが一般的である。そのために、「ネットで探してコードを見つけた」時にそのコードの意味がわからないことも多々ある。今回の主張はそのようなことを減らしたいというものなのだが、そのためにはルールに基づいた省略の方法を知っておく必要がある。

まず、以下のような場合に省略できる。

引数の型は型推論できるため、省略できる、つまり書かなくてよい（var も書かない）
匿名メソッドが 1 行で済む場合は {} ; return が省略できる

この省略をした結果が以下になる。冒頭に示したコードと同じものになった。

using System;

class Program
{
    static void Main()
    {
        // 配列に格納された整数を降順で並べ替える
        int[] arr = { 10, 409, 3, 64, 0, -2, 13 };
        // x と y の降順の前後関係を定義する匿名メソッドを定義し、引数に渡す
        Array.Sort(arr, (x, y) => y - x);
        Array.ForEach(arr, Console.WriteLine);
    }
}

また、CompareTo() メソッドを使ったこんな書き方もできる。

using System;

class Program
{
    static void Main()
    {
        // 配列に格納された整数を降順で並べ替える
        int[] arr = { 10, 409, 3, 64, 0, -2, 13 };

        // x と y の降順の前後関係を定義する匿名メソッドを定義し、変数に割り当てる
        Array.Sort(arr, (x, y) => y.CompareTo(x));
        Array.ForEach(arr, Console.WriteLine);
    }
}

Unity でのラムダ式の用途

Unity でデリゲートやラムダ式を使う場面は、高度な事をやろうとすると多々ある。一般的なデータ処理や Linq ではもちろん使われる。ここでは、それ以外の用途で使われる例をいくつか挙げる。

Button, EventTrigger コンポーネントにプログラムから処理を割り当てる時
DOTween の OnComplete メソッドで非同期処理後のコールバック処理を指定する時
- 上のリンク先では OnComplete メソッド以外にもコールバックを指定するメソッドの一覧があります
ネットワークゲームで非同期通信完了後のコールバック処理を指定する時
- NCMB ではサーバーへの問い合わせ処理やユーザー管理処理など、非常に多くの場面で使われます

System.Action, System.Func

C# にジェネリックが導入されたことで、デリゲートを定義するのも非常に楽になった。例えば上記の Comparison<int> についても、ジェネリックが無ければ、int, uint, double, float, ... を比較するためにいちいちそれ専用のデリゲートを定義しなければならないが、ジェネリックのおかげで Comparison<T> だけであらゆる型の比較と大小・前後関係を定義することができるようになった。つまり汎用的に使えるようになった。

この汎用化をさらに進めたようなものが System.Action と System.Func である。

System.Action

System.Action とは、戻り値を返さないメソッドのデリゲートである。System.Action だけでは引数を持たないが、以下のように引数は 16 個まで指定できる。

System.Action - 引数なし、戻り値なし
System.Action<T> - 引数 T、戻り値なし
System.Action<T1, T2> - 引数 T1, T2、戻り値なし
System.Action<T1, T2, T3> - 引数 T1, T2, T3、戻り値なし ...
System.Action<T1, T2, ... T16> - 引数 T1, T2 ... T16、戻り値なし

冒頭のコードでは、Array.ForEach() メソッドで System.Action が使われている。これも以下のようにポップアップヘルプから見る事ができる。

Array.Sort を調べたのと同様に Array.ForEach のリファレンスを見ることで、第一引数で配列を指定し、その配列に含まれる各要素に対して実行される処理を第二引数に指定することがわかる。渡すメソッドは「int の値を引数にとり、戻り値のないメソッド」である。

やりたいことは「配列の各要素を出力する」ことなので、ここまでに学んだことを使うと、以下のように記述することになるでしょう。

using System;

class Program
{
    static void Main()
    {
        // 配列に格納された整数を降順で並べ替える
        int[] arr = { 10, 409, 3, 64, 0, -2, 13 };
        // x と y の降順の前後関係を定義する匿名メソッドを定義し、変数に割り当てる
        Array.Sort(arr, (x, y) => y.CompareTo(x));
        Array.ForEach(arr, (i) => Console.WriteLine(i));	// 「int の値を引数にとり、戻り値のないメソッド」を渡す
    }
}

なお、「ラムダ式の引数が一つしかない時は、左辺の () を省略できる」ので、以下のように書くこともできます。

using System;

class Program
{
    static void Main()
    {
        // 配列に格納された整数を降順で並べ替える
        int[] arr = { 10, 409, 3, 64, 0, -2, 13 };
        // x と y の降順の前後関係を定義する匿名メソッドを定義し、変数に割り当てる
        Array.Sort(arr, (x, y) => y.CompareTo(x));
        Array.ForEach(arr, i => Console.WriteLine(i));	// 「int の値を引数にとり、戻り値のないメソッド」を渡す
    }
}

しかし、Console.WriteLine() そのものが「int の値を引数にとり、戻り値のないメソッド」であるため、以下のようにそのまま指定することができる。

using System;

class Program
{
    static void Main()
    {
        // 配列に格納された整数を降順で並べ替える
        int[] arr = { 10, 409, 3, 64, 0, -2, 13 };
        // x と y の降順の前後関係を定義する匿名メソッドを定義し、変数に割り当てる
        Array.Sort(arr, (x, y) => y.CompareTo(x));
        Action<int> action = Console.WriteLine; // 「int の値を引数にとり、戻り値のないメソッド」を割り当てる
        Array.ForEach(arr, action);
    }
}

using System;

class Program
{
    static void Main()
    {
        // 配列に格納された整数を降順で並べ替える
        int[] arr = { 10, 409, 3, 64, 0, -2, 13 };
        // x と y の降順の前後関係を定義する匿名メソッドを定義し、変数に割り当てる
        Array.Sort(arr, (x, y) => y.CompareTo(x));
        Array.ForEach(arr, Console.WriteLine);  // 「int の値を引数にとり、戻り値のないメソッド」を直接渡す
    }
}

System.Func

System.Action は「戻り値のないメソッドのデリゲート」だが、一方 System.Func は「戻り値のあるメソッドのデリゲート」である。System.Action と同様、以下のように引数を 16 個までとることができる。

System.Func<TR> - 引数なし、戻り値 TR
System.Func<T, TR> - 引数 T、戻り値 TR
System.Func<T1, T2, TR> - 引数 T1, T2、戻り値 TR
System.Func<T1, T2, T3, TR> - 引数 T1, T2, T3、戻り値 TR ...
System.Func<T1, T2, ... T16, TR> - 引数 T1, T2 ... T16、戻り値 TR

覚えておかなければならないのは、T1, T2, ... TR のうち「一番右に指定された型パラメータが戻り値の型である」ことです。これを知らないと読むことができません。

System.Func を使う例としては Linq の OrderBy() メソッドがあります。降順ソートする場合は OrderByDescending() メソッドが使えます。これまでやってきたように Visual Studio のポップアップヘルプやリファレンス機能を使えば、まったく同様に使えます。

// パターン A
using System;
using System.Collections.Generic;
using System.Linq;

class Program
{
    static void Main()
    {
        // 配列に格納された整数を降順で並べ替える
        List<int> list = new List<int>(new int[] { 10, 409, 3, 64, 0, -2, 13 });
        // 降順ソートする
        Func<int, int> keySelector = (int i) => { return i; };
        list.OrderByDescending(keySelector).ToList().ForEach(Console.WriteLine);
    }
}

// パターン B
using System;
using System.Collections.Generic;
using System.Linq;

class Program
{
    static void Main()
    {
        // 配列に格納された整数を降順で並べ替える
        List<int> list = new List<int>(new int[] { 10, 409, 3, 64, 0, -2, 13 });
        // 降順ソートする
        foreach (var i in list.OrderByDescending(i => i))
            Console.WriteLine(i);
    }
}

最後に

今回のように Visual Studio のポップアップヘルプとリファレンスを使えば、どのようなデリゲートであろうとも使い方を知ることができます。System.Action や System.Func も汎用的に作られただけの「ただのデリゲート」です。

逆に、デリゲートの定義やそれを使うメソッドの使い方（つまりリファレンスに載っている内容）を知らなければ、コードだけを見ても何をしているのかわからないこともよくあります。従って、ネットで検索して意味を理解せずコードをコピペするのはよくありません。なぜなら「コードを見ただけでは何をしているかわからない」ことは「普通」だからです。プログラマーが意味を理解していないコードを使って動いているプログラムは危険であり、価値がありません。

先の例で DOTween や NCMB を挙げましたが、これらも次に挙げるように、当然リファレンスが用意されています。これがなければ、どういうコードを書けば期待通りに動くか（作った人以外）誰にもわからないからです。

リファレンスを読めるようになるのは難しいですが、便利な道具を使うことで飛躍的に楽になります。学んだことを活かして差をつけましょう。

4th term 1st week - dsuz/csharp GitHub Wiki

今回のテーマ

導入

デリゲートとは

Unity でデリゲートを使っているところ

Array.Sort() の引数には何を渡しているのか

Array.Sort() の仕様を調べる

匿名メソッドとラムダ式

ラムダ式の省略

Unity でのラムダ式の用途

System.Action, System.Func

System.Action

System.Func

最後に

⚠️ GitHub.com Fallback ⚠️

4th term 1st week - dsuz/csharp GitHub Wiki

今回のテーマ

導入

デリゲートとは

Unity でデリゲートを使っているところ

Array.Sort() の引数には何を渡しているのか

Array.Sort() の仕様を調べる

匿名メソッドとラムダ式

ラムダ式の省略

Unity でのラムダ式の用途

System.Action, System.Func

System.Action

System.Func

最後に

⚠️ **GitHub.com Fallback** ⚠️

⚠️ GitHub.com Fallback ⚠️