HTML CSS JAVASCRIPT PYTHON PYTHON2 JAVA C C++ C# SQL Excel Linux AI BOOTSTRAP PHP 教程库 参考手册 技术文章 测验 练习 HOWTO FAQ
❮ 上一节 下一节 ❯

C# - 属性

属性是一种声明性标签，用于向运行时传递程序中各种元素(例如类、方法、结构体、枚举器、程序集等)行为的信息。您可以使用属性向程序添加声明性信息。声明性标签用方括号 ([ ]) 表示，该方括号位于其所针对的元素上方。

属性用于向程序添加元数据，例如编译器指令和其他信息，例如注释、描述、方法和类。 .Net 框架提供两种类型的属性:预定义属性和自定义属性。

指定属性

指定属性的语法如下:-

[attribute(positional_parameters, name_parameter = value, ...)]
element

属性的名称及其值在应用该属性的元素前的方括号内指定。位置参数指定必需信息，名称参数指定可选信息。

预定义属性

.Net 框架提供了三个预定义属性 -

  • AttributeUsage
  • Conditional
  • Obsoleated

AttributeUsage

预定义属性 AttributeUsage 描述了如何使用自定义属性类。它指定了可以应用该属性的项目类型。

指定此属性的语法如下 -

[AttributeUsage (
   validon,
   AllowMultiple = allowmultiple,
   Inherited = inherited
)]

其中，

  • 参数 validon 指定可放置该属性的语言元素。它是枚举器 AttributeTargets 值的组合。默认值为 AttributeTargets.All。

  • 参数 allowmultiple(可选)为此属性的 AllowMultiple 属性提供布尔值。如果为 true，则该属性为多用途。默认值为 false(单用途)。

  • 参数 inherited(可选)为此属性的 Inherited 属性提供布尔值。如果为 true，则该属性将被派生类继承。默认值为 false(不继承)。

例如，

[AttributeUsage(
   AttributeTargets.Class |
   AttributeTargets.Constructor |
   AttributeTargets.Field |
   AttributeTargets.Method |
   AttributeTargets.Property, 
   AllowMultiple = true)]

Conditional

此预定义属性标记一个条件方法，其执行取决于指定的预处理标识符。

它会根据指定的值(例如 Debug 或 Trace)对方法调用进行条件编译。例如，它在调试代码时显示变量的值。

指定此属性的语法如下:-

[Conditional(
    conditionalSymbol
)]

例如:

[Conditional("DEBUG")]

以下示例演示了此属性:-

#define DEBUG
using System;
using System.Diagnostics;

public class Myclass {
   [Conditional("DEBUG")]
   
   public static void Message(string msg) {
      Console.WriteLine(msg);
   }
}
class Test {
   static void function1() {
      Myclass.Message("In Function 1.");
      function2();
   }
   static void function2() {
      Myclass.Message("In Function 2.");
   }
   public static void Main() {
      Myclass.Message("In Main function.");
      function1();
      Console.ReadKey();
   }
}

当编译并执行上述代码时，它会产生以下结果 -

In Main function
In Function 1
In Function 2

已过时

此预定义属性标记不应使用的程序实体。它使您能够通知编译器丢弃特定的目标元素。例如，当类中使用新方法时，如果您仍想保留旧方法，则可以显示一条消息，提示应使用新方法而不是旧方法，并将其标记为已过时。

指定此属性的语法如下 -

[Obsolete (
   message
)]

[Obsolete (
   message,
   iserror
)]

其中，

  • 参数 message 是一个字符串，用于描述该项已过时的原因以及应使用什么来替代。

  • 参数 iserror 是一个布尔值。如果其值为 true，则编译器应将使用该项视为错误。默认值为 false(编译器会生成警告)。

以下程序演示了这一点 -

using System;

public class MyClass {
   [Obsolete("Don't use OldMethod, use NewMethod instead", true)]
   
   static void OldMethod() {
      Console.WriteLine("It is the old method");
   }
   static void NewMethod() {
      Console.WriteLine("It is the new method"); 
   }
   public static void Main() {
      OldMethod();
   }
}

当您尝试编译该程序时，编译器会给出一条错误消息，指出 -

 Don't use OldMethod, use NewMethod instead

创建自定义属性

.Net 框架允许创建自定义属性，这些属性可用于存储声明性信息，并可在运行时检索。根据设计标准和应用需求，此信息可以与任何目标元素关联。

创建和使用自定义属性包含四个步骤 -

  • 声明自定义属性
  • 构造自定义属性
  • 将自定义属性应用于目标程序元素
  • 通过反射访问属性

最后一步是编写一个简单的程序来读取元数据以查找各种符号。元数据是关于数据的数据或用于描述其他数据的信息。该程序应该使用反射在运行时访问属性。我们将在下一章讨论这一点。

声明自定义属性

新的自定义属性应该派生自 System.Attribute 类。例如:

//一个自定义属性 BugFix，赋值给一个类及其成员
[AttributeUsage(
   AttributeTargets.Class |
   AttributeTargets.Constructor |
   AttributeTargets.Field |
   AttributeTargets.Method |
   AttributeTargets.Property,
   AllowMultiple = true)]

public class DeBugInfo : System.Attribute

在上面的代码中，我们声明了一个名为 DeBugInfo 的自定义属性。

构造自定义属性

让我们构造一个名为 DeBugInfo 的自定义属性，它用于存储调试任何程序时获得的信息。它存储以下信息:

  • 错误的代码
  • 发现错误的开发人员姓名
  • 上次代码审查日期
  • 用于存储开发人员备注的字符串消息

DeBugInfo 类有三个私有属性用于存储前三个信息，以及一个公共属性用于存储消息。因此，错误编号、开发人员姓名和审核日期是 DeBugInfo 类的位置参数，而消息是可选参数或命名参数。

每个属性必须至少有一个构造函数。位置参数应通过构造函数传递。以下代码展示了 DeBugInfo 类 -

//一个自定义属性 BugFix，将被赋值给一个类及其成员
[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;
      }
   }
}

应用自定义属性

通过将属性放置在目标之前来应用该属性 -

[DeBugInfo(45, "Zara Ali", "12/8/2012", Message = "Return type mismatch")]
[DeBugInfo(49, "Nuha Ali", "10/10/2012", Message = "Unused variable")]
class Rectangle {
   //成员变量
   protected double length;
   protected double width;
   public Rectangle(double l, double w) {
      length = l;
      width = w;
   }
   [DeBugInfo(55, "Zara Ali", "19/10/2012", Message = "Return type mismatch")]
   
   public double GetArea() {
      return length * width;
   }
   [DeBugInfo(56, "Zara Ali", "19/10/2012")]
   
   public void Display() {
      Console.WriteLine("Length: {0}", length);
      Console.WriteLine("Width: {0}", width);
      Console.WriteLine("Area: {0}", GetArea());
   }
}

在下一章中，我们将使用反射类对象检索属性信息。

❮ 上一节 下一节 ❯