C# 15のExtension Indexersとは?拡張インデクサーの仕組み
C# 15では、新機能としてExtension Indexers(拡張インデクサー)が追加されました。
拡張インデクサーを利用すると、既存の型に対して、インデクサーによるアクセス方法を追加できます。
例えば、インデクサーを持たない型に対して、[] を使ったアクセス方法を定義できます。
従来の拡張メソッドでは、既存の型に独自の処理を追加できましたが、インデクサーによるアクセス方法を追加することはできませんでした。
この記事では、C# 15のExtension Indexersの仕組みや使い方、従来の拡張メソッドとの違いについて紹介します。
Extension Indexersとは?
Extension Indexers(拡張インデクサー)は、C# 15で追加された機能です。
extension ブロック内にインデクサーを定義することで、拡張対象の型にインデクサーが定義されているかのようにアクセスできます。
通常、インデクサーはクラスや構造体の内部に定義します。
例えば、次のようなクラスがあるとします。
public class NumberCollection
{
private readonly int[] numbers = [10, 20, 30];
public int this[int index] => numbers[index];
}
このクラスでは、インデクサーを定義しているため、次のようにアクセスできます。
var collection = new NumberCollection();
int value = collection[1];
一方、既存のライブラリなどにある型については、自分でその型の定義を変更できない場合があります。
C# 15のExtension Indexersを利用すると、元の型を変更せずに、拡張インデクサーを追加できます。
Extension Indexersの使い方
拡張インデクサーは、extension ブロックの中に this インデクサーを定義します。
Microsoft公式ドキュメントでは、IEnumerable<int> にインデクサーを追加する例が紹介されています。
using System.Collections.Generic;
using System.Linq;
public static class SequenceIndexer
{
extension(IEnumerable<int> sequence)
{
public int this[int index] => sequence.ElementAt(index);
}
}
この例では、IEnumerable<int> に対して拡張インデクサーを定義しています。
それぞれの記述には、次のような意味があります。
| 記述 | 説明 |
|---|---|
public static class | 拡張メンバーを定義する静的クラス |
extension(...) | 拡張対象の型とレシーバーを指定する |
IEnumerable<int> | 拡張対象となる型 |
sequence | 拡張対象のインスタンスを参照する名前 |
this[int index] | 追加するインデクサー |
ElementAt(index) | 指定した位置の要素を取得する処理 |
extension(IEnumerable<int> sequence) では、拡張対象となる型だけでなく、インスタンスを参照するための名前も指定しています。
インデクサーはインスタンスメンバーなので、拡張ブロックには名前付きのレシーバーパラメーターが必要です。
拡張インデクサーを呼び出す
定義した拡張インデクサーは、通常のインデクサーと同じように [] を使ってアクセスできます。
IEnumerable<int> numbers = Enumerable.Range(1, 10);
int third = numbers[2];
この例では、numbers[2] によって3番目の要素を取得しています。
Enumerable.Range(1, 10) は、1から10までの整数を生成するため、取得される値は 3 です。
通常の拡張メソッドのようにメソッド名を指定する必要はありません。
拡張インデクサーと拡張メソッドの違い
従来の拡張メソッドでは、既存の型に対して独自のメソッドを追加できます。
例えば、次のような拡張メソッドを定義できます。
public static class SequenceExtensions
{
public static int ElementAtIndex(
this IEnumerable<int> sequence,
int index)
{
return sequence.ElementAt(index);
}
}
利用するときは、次のようにメソッド名を指定します。
IEnumerable<int> numbers = Enumerable.Range(1, 10);
int third = numbers.ElementAtIndex(2);
一方、C# 15の拡張インデクサーでは、同じような処理を次のように記述できます。
int third = numbers[2];
主な違いは次のとおりです。
| 比較項目 | 拡張メソッド | 拡張インデクサー |
|---|---|---|
| 呼び出し方 | メソッド名と引数 | [] |
| 定義方法 | 拡張メソッドとして定義 | extension ブロック内に定義 |
| 主な用途 | 独自の処理を追加 | インデックス形式のアクセスを追加 |
| 対応バージョン | 従来のC#から利用可能 | C# 15以降 |
拡張インデクサーは、従来の拡張メソッドを置き換える機能ではありません。
インデックスを使ったアクセスが自然な処理に対して、新しい記述方法を提供する機能です。
getやsetにも対応している
拡張インデクサーは、値を取得する get だけでなく、値を設定する set にも対応しています。
また、式形式のアクセサーやref戻り値のアクセサーも利用できます。
通常のインデクサーと同じように、用途に合わせてアクセサーを定義できます。
例えば、次のような使い方が考えられます。
| アクセサー | 用途 |
|---|---|
| get | インデックスに対応する値を取得する |
| set | インデックスに対応する値を設定する |
| ref戻り値 | 参照を返し、呼び出し元から値を変更できるようにする |
Microsoftの公式チュートリアルでは、座標の相対的な移動量を保持する Path 型に対して、拡張インデクサーを追加する例が紹介されています。
この例では、path[index] で座標を取得したり、path[index] = target で座標を更新したりできます。
元の型にインデクサーがなくても、拡張インデクサー側で値の取得や更新処理を実装できる点が特徴です。
Extension Indexersを利用する際の注意点
拡張インデクサーを利用する際には、いくつか注意点があります。
C# 15に対応した環境が必要
Extension IndexersはC# 15で追加された機能です。
そのため、利用するにはC# 15に対応したコンパイラが必要です。
C# 15は.NET 11 SDKで利用でき、net11.0 を対象とするプロジェクトでは既定の言語バージョンになります。
通常の拡張インデクサーを利用するために、<LangVersion>preview</LangVersion> を指定する必要はありません。
配列や文字列には適用できない
拡張インデクサーは、すべての型のインデックスアクセスを拡張できるわけではありません。
C# 15の仕様では、配列や文字列に対する既存のインデックスアクセスには、拡張インデクサーを適用できません。
そのため、配列や文字列の標準的なインデクサーを置き換えたり、追加のインデクサーを提供したりする目的では利用できません。
元の型にインデクサーが追加されるわけではない
拡張インデクサーは、拡張対象の型そのものを変更する機能ではありません。
拡張メンバーとしてインデクサーを定義し、対象のインスタンスに対してインデックス形式のアクセスを提供します。
また、値の取得や更新がどのように行われるかは、拡張インデクサーの実装によって決まります。
例えば、内部でコレクションを走査する処理を実装した場合、通常の配列のように高速なランダムアクセスができるとは限りません。
拡張対象の型や利用範囲に注意する
拡張インデクサーは、定義した拡張メンバーが利用可能な範囲で使用できます。
拡張メンバーを定義した名前空間などが利用側から参照されている必要があります。
プロジェクト内で利用する場合は、拡張メンバーを定義したクラスや名前空間の構成にも注意が必要です。
まとめ
C# 15のExtension Indexersは、既存の型に対してインデクサーによるアクセス方法を追加できる機能です。
従来の拡張メソッドではメソッド名を指定して処理を呼び出していましたが、拡張インデクサーでは [] を使ったアクセスが可能になります。
今回の内容をまとめると、次のとおりです。
- Extension IndexersはC# 15で追加された機能
extensionブロック内にthis[...]を定義する- 既存の型に対してインデックス形式のアクセスを提供できる
get、set、ref戻り値のアクセサーに対応している- 配列や文字列の既存のインデックスアクセスには適用できない
- 元の型そのものが変更されるわけではない
既存の型に対して、インデックス形式でアクセスする処理を追加したい場合に、選択肢となる機能です。
