C#でカスタム属性（Attribute）を作成する方法を徹底解説

カスタム属性とは、宣言的な情報を格納し、実行時にその情報を取得できるようにするための仕組みです。ここでは、C#でカスタム属性を宣言・作成する具体的な手順を解説します。

カスタム属性の宣言方法

カスタム属性を定義する際は、まずAttributeUsage属性を使って、その属性をどのプログラム要素に適用できるかを指定します。以下は宣言の基本形です。

[AttributeUsage (
AttributeTargets.Class |
AttributeTargets.Constructor |
AttributeTargets.Field |
AttributeTargets.Method |
AttributeTargets.Property,
AllowMultiple = true)]
public class DeBugInfo : System.Attribute

この例では、プログラムのデバッグ作業で得られた情報を格納するための「DeBugInfo」という名前のカスタム属性を作成します。

位置指定パラメーターと名前付きパラメーター

DeBugInfoクラスは、最初の3つの情報を保持するための3つのプライベートプロパティと、メッセージを保持するためのパブリックプロパティを持っています。

つまり、バグ番号・開発者名・レビュー日の3つはDeBugInfoクラスの位置指定パラメーターとして扱われ、メッセージは省略可能な名前付きパラメーターとして扱われます。

カスタム属性の実装例

すべての属性クラスには、必ず少なくとも1つのコンストラクターを定義する必要があります。以下のコードは、クラスおよびそのメンバーに割り当てられるカスタム属性の完全な実装例です。

//a custom attribute BugFix to be assigned to a class and its members
[AttributeUsage (
AttributeTargets.Class |
AttributeTargets.Constructor |
AttributeTargets.Field |
AttributeTargets.Method |
AttributeTargets.Property,
AllowMultiple = true)]

public class DeBugInfo : System.Attribute {
   private int bugNo;
   private string developer;
   private string lastReview;
   public string message;
   public DeBugInfo(int bg, string dev, string d) {
      this.bugNo = bg;
      this.developer = dev;
      this.lastReview = d;
   }
   public int BugNo {
      get {
         return bugNo;
      }
   }
   public string Developer {
      get {
         return developer;
      }
   }
   public string LastReview {
      get {
         return lastReview;
      }
   }
   public string Message {
      get {
         return message;
      }
      set {
         message = value;
      }
   }
}

コードのポイント

• System.Attributeの継承： カスタム属性クラスは、必ずSystem.Attributeクラスを継承します。
• AttributeTargetsの指定： この例では、クラス・コンストラクター・フィールド・メソッド・プロパティに対して属性を適用できるよう設定しています。
• AllowMultiple = true： 同じ要素に同じ属性を複数回適用できることを意味します。デバッグ情報のように複数の修正履歴を記録したい場合に有効です。

このようにして定義したカスタム属性は、クラスやメンバーに付与することでメタデータとして埋め込まれ、リフレクションを使って実行時に参照できます。