【C#】拡張メソッドの使い方入門【Unity】

2019年5月22日2021年5月31日C#.NET, Unity, 開発

C#機能バージョン対応表作成しました。
こちらの記事も合わせてご覧ください。

【C#】Version Up 内容一覧【.NET】

【C#】【.NET】のバージョン毎に機能をまとめたページを作成しました。

https://honobono1212.com/page-237/

Contents

1. 拡張メソッドとは
2. 【まとめ】

拡張メソッドとは

【既存の型（クラス）に対して、元の型の変更や継承をすることなく、新たなメソッドを追加する仕組みです。】

ふ〜ん。そうなんだ。
で終わってしまわないように、実際に作成してみることに。

今回は、enumでやってみます。

サンプルコード１


public enum DayConstants
{
    Sun,
    Mon,
    Tue,
    Wed,
    Thu,
    Fri,
    Sat,
};

public enum DayConstants

{

Sun,

Mon,

Tue,

Wed,

Thu,

Fri,

Sat,

};

日曜日から土曜日までenumで定義しました。
次に拡張メソッドを定義します。

サンプルコード２


public static class DayConstantsExtension
{
    public static DayConstants GetNextDayConstants(this DayConstants dayConstant)
    {
        switch (dayConstant)
        {
            case DayConstants.Sat:
                return DayConstants.Sun;
            default:
                return ++dayConstant;
        }
    }
}

public static class DayConstantsExtension

{

public static DayConstants GetNextDayConstants(this DayConstants dayConstant)

{

switch (dayConstant)

{

case DayConstants.Sat:

return DayConstants.Sun;

default:

return ++dayConstant;

}

拡張メソッドを作成する場合は、第一引数に拡張したい型にthisをつけて定義します。
※第二引数以降を設定する場合はthisをつけません

今回のメソッドでは、enum型のまま次の曜日を返すように処理を作成しました。
・月曜日　なら　火曜日を返す
・土曜日　なら　日曜日を返す

土曜日以外はインクリメントした値を返し、土曜日の場合は日曜日を返すようにしています。

これで、拡張メソッドの作成は終了です。
次に、拡張メソッドを実際に作成してみます。

サンプルコード３


using System.Collections;
using System.Collections.Generic;
using UnityEngine;
using DG.Tweening;
using System;

public class DayConstantsExtensionTest : MonoBehaviour
{
    // Use this for initialization
    void Start()
    {
        Debug.Log("=== Debug.Log(dayConstant) ==========================================");
        foreach (DayConstants dayConstant in DayConstants.GetValues(typeof(DayConstants)))
        {
            Debug.Log(dayConstant);
        }

        Debug.Log("=== Debug.Log(dayConstant.GetNextDayConstants()) ===================");

        foreach (DayConstants dayConstant in DayConstants.GetValues(typeof(DayConstants)))
        {
            Debug.Log(dayConstant.GetNextDayConstants());
        }
    }

    // Update is called once per frame
    void Update()
    {

    }
}

using System.Collections;

using System.Collections.Generic;

using UnityEngine;

using DG.Tweening;

using System;

public class DayConstantsExtensionTest : MonoBehaviour

{

// Use this for initialization

void Start()

{

Debug.Log("=== Debug.Log(dayConstant) ==========================================");

foreach (DayConstants dayConstant in DayConstants.GetValues(typeof(DayConstants)))

{

Debug.Log(dayConstant);

}

Debug.Log("=== Debug.Log(dayConstant.GetNextDayConstants()) ===================");

foreach (DayConstants dayConstant in DayConstants.GetValues(typeof(DayConstants)))

{

Debug.Log(dayConstant.GetNextDayConstants());

}

// Update is called once per frame

void Update()

{

}

一つ目のforeachではenumの定義された順番にログを出力します。（今回の本題ではないので説明を省きます）

二つ目のforeach内の【dayConstant.GetNextDayConstants()】に注目です。
ここで拡張メソッドを呼び出しています。

このときに覚えるポイントは以下です。
①拡張メソッドを呼び出す時は、【拡張元の型】　＋　【 . (ピリオド)】で呼び出す。
②拡張メソッドで定義した第一引数には呼び出し元の型に設定されている値が渡される(今回は第一引数の　this DayConstants dayConstant に渡される)
③拡張メソッドで第二引数を定義している場合は、拡張メソッドを呼び出す際に引数を１つ渡す必要がある
　※　もしも第三引数まで定義されている場合は、拡張メソッドを呼び出す際に引数を２つ渡す必要がある

　 public static DayConstants GetNextDayConstants(this DayConstants dayConstant, int a, int b)
　上記の拡張メソッドを呼び出すときは

　dayConstant.GetNextDayConstants(100,200)
　のように呼び出してあげる必要あり

最後に実行結果です。