C# コンパイラエラー CS0071 の原因と対策を解説
CS0071はC#のコンパイラーエラーです。
インターフェイスで定義されたイベントを明示的に実装する際、通常自動生成されるaddおよびremoveアクセサーの代わりに、明示的なアクセサー構文で記述する必要があります。
適切なアクセサーを実装することで、このエラーを回避できます。
CS0071エラーの原因
エラー発生の背景
C#では、インターフェイス内で宣言されたイベントを明示的に実装する際、コンパイラは自動でadd
およびremove
アクセサーを生成することはできません。
そのため、明示的な実装の場合は、これらのアクセサーを自分で記述する必要があります。
記述しない場合、コンパイラはエラーCS0071を発生させます。
以下のサンプルコードは、エラーが発生する例を示しています。
// CS0071ErrorExample.cs
public delegate void MyEvent(object sender);
interface ITest
{
event MyEvent Clicked;
}
class Test : ITest
{
// 明示的なイベント実装でアクセサーを定義しない場合にエラーが発生
event MyEvent ITest.Clicked; // ここでCS0071エラーが発生
public static void Main()
{
// 基本的なMain関数のみ記述
}
}
// コンパイル時にエラー:
// error CS0071: An explicit interface implementation of 'ITest.Clicked' must be accompanied by an accessor declaration
イベントインターフェイス実装時の注意点
明示的なインターフェイスのイベント実装では、アクセサーの記述が必須です。
アクセサー内では、内部で使用する変数や委譲(delegate)の登録・解除の処理を記述する必要があります。
たとえば、イベントハンドラーを保持するプライベートフィールドを定義し、add
アクセサーでそのフィールドに登録し、remove
アクセサーで解除する実装を行います。
このようにすることで、イベントの発生元と処理先を柔軟に制御できます。
自動生成されたアクセサーとの違い
通常のイベント宣言では、コンパイラが自動的にadd
とremove
アクセサーを生成しますが、インターフェイスの明示的な実装の場合は自動生成は行われません。
自動生成されたアクセサーは簡潔な構文で実装できますが、明示的な実装では内部処理を明確に定義する必要があるため、手動で登録・解除の手順を記述する必要があります。
明示的なイベントアクセサーの実装方法
addアクセサーの記述方法
基本構文と実装例
add
アクセサーは、イベントハンドラーを登録する処理を記述する部分です。
以下のサンプルコードでは、add
アクセサー内でプライベート変数clicked
に対してイベントハンドラーを追加する実装例を示しています。
using System;
public delegate void MyEvent(object sender);
interface ITest
{
event MyEvent Clicked;
}
class Test : ITest
{
// プライベート変数としてイベントハンドラーの保持先を用意
private MyEvent clicked;
// 明示的なイベント実装時にアクセサーを定義
event MyEvent ITest.Clicked
{
add
{
// addアクセサーでイベントハンドラーを追加
clicked += value;
}
remove
{
// removeアクセサーはここで定義する必要があります
clicked -= value;
}
}
// イベントを発火するメソッドの例
public void OnClicked()
{
// イベントがnullでない場合に呼び出し
clicked?.Invoke(this);
}
public static void Main()
{
Test test = new Test();
ITest iTest = test;
// イベントハンドラーを登録。イベントが発火されるとメッセージが表示される
iTest.Clicked += (sender) =>
{
Console.WriteLine("イベントが発生しました。");
};
// イベント発火の呼び出し
test.OnClicked();
}
}
イベントが発生しました。
removeアクセサーの記述方法
基本構文と実装例
remove
アクセサーは、登録したイベントハンドラーを解除する処理を記述する部分です。
上記のサンプルコード内でもremove
アクセサーで処理を行っています。
解除処理は、add
アクセサーと対になっており、正しく管理することで不要なイベント呼び出しを防ぐことができます。
以下の例は、削除処理に焦点を当てた実装例です。
using System;
public delegate void MyEvent(object sender);
interface ITest
{
event MyEvent Clicked;
}
class Test : ITest
{
private MyEvent clicked;
event MyEvent ITest.Clicked
{
add
{
clicked += value;
}
remove
{
// removeアクセサーでイベントハンドラーを解除
clicked -= value;
}
}
// イベントを発火するメソッドの例
public void OnClicked()
{
clicked?.Invoke(this);
}
public static void Main()
{
Test test = new Test();
ITest iTest = test;
// サンプルハンドラーの定義
MyEvent handler = (sender) =>
{
Console.WriteLine("イベントハンドラーが呼ばれました。");
};
// イベントハンドラーを登録
iTest.Clicked += handler;
// イベント発火
test.OnClicked();
// イベントハンドラーを解除し、再度イベント発火しても呼ばれないことを確認
iTest.Clicked -= handler;
test.OnClicked();
}
}
イベントハンドラーが呼ばれました。
// 解除後は出力なし
エラー回避のための実装例
誤った実装例と問題点
次に示すサンプルは、明示的なインターフェイス実装時にアクセサーを定義せずに直接イベントを宣言した場合の誤った実装例です。
この実装では、イベントを登録・解除するための処理が不足しているため、コンパイラエラーCS0071が発生します。
using System;
public delegate void MyEvent(object sender);
interface ITest
{
event MyEvent Clicked;
}
class Test : ITest
{
// 誤った実装例:アクセサーが定義されていないためエラーになる
event MyEvent ITest.Clicked;
public static void Main()
{
// この状態では基本的な呼び出しができない
}
}
// コンパイルエラー:
// error CS0071: An explicit interface implementation of 'ITest.Clicked' must be accompanied by an accessor declaration
正しい実装例の具体的手順
正しい実装例では、必ずadd
とremove
の両方のアクセサーを記述します。
以下のサンプルコードは、イベントハンドラーの登録と解除の処理を正しく実装した例です。
まず、プライベート変数にイベントハンドラーを保持し、add
アクセサーで追加、remove
アクセサーで削除する処理を行います。
using System;
public delegate void MyEvent(object sender);
interface ITest
{
event MyEvent Clicked;
}
class Test : ITest
{
// イベントハンドラーの格納用プライベート変数
private MyEvent clicked;
// 明示的な実装でアクセサーを定義し、登録と解除の処理を記述
event MyEvent ITest.Clicked
{
add
{
// イベントハンドラーを追加
clicked += value;
}
remove
{
// イベントハンドラーを削除
clicked -= value;
}
}
// イベント発火のメソッド
public void OnClicked()
{
clicked?.Invoke(this);
}
public static void Main()
{
Test test = new Test();
ITest iTest = test;
// イベントハンドラーの定義と登録
iTest.Clicked += (sender) =>
{
Console.WriteLine("正しくイベントが処理されました。");
};
// イベントを発火して動作を確認
test.OnClicked();
}
}
正しくイベントが処理されました。
実装後の確認手順
検証すべきポイント
実装後は、以下のポイントの検証が必要です。
add
アクセサーとremove
アクセサーの動作確認- イベントハンドラーが正しく登録・解除されること
- イベント発火時に意図した処理が実行されること
具体的には、イベントに複数のハンドラーを登録し、解除後に発火した際に不要な処理が呼ばれていないか確認することが求められます。
デバッグ時は、プライベート変数に登録されたイベントハンドラーの内容が期待通りかどうかもチェックするとよいでしょう。
デバッグ時の留意点
デバッグ時には、以下の点に注意してください。
- イベントの追加と削除が正しく行われているか、ブレークポイントを使用して追跡する
null
チェックが適切に行われているか、特にイベント発火前のclicked
変数の状態を確認する- 複数のイベントハンドラーが登録された場合、すべてのハンドラーが正しく呼び出されているか確認すること
これらの手順を踏むことで、明示的なイベント実装においてCS0071エラーを回避し、正しいイベント処理の実装が可能となります。
まとめ
この記事では、C#におけるCS0071エラーの原因とその対策について理解できます。
インターフェイスのイベントを明示的に実装する際、addおよびremoveアクセサーを正しく記述しなければエラーが発生することを説明し、誤った実装例とその問題点も解説しています。
加えて、正しい実装手順やサンプルコードを通して、イベントハンドラーの登録・解除、発火処理、検証ポイントとデバッグポイントを明確に理解できる内容となっています。