C# - 属性

上一页
下一页

**属性**是声明性标签，用于向运行时传达有关各种元素（如类、方法、结构、枚举器、程序集等）在程序中的行为的信息。您可以使用属性向程序添加声明性信息。声明性标签由放置在它所用元素上方的方括号（[ ]）表示。

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

指定属性

指定属性的语法如下：

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

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

预定义属性

.Net Framework 提供三个预定义属性：

  • AttributeUsage
  • Conditional
  • Obsolete

AttributeUsage

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

指定此属性的语法如下：

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

其中，

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

  • 参数allowmultiple（可选）为此属性的AllowMultiple属性提供值，一个布尔值。如果为真，则属性是多用途的。默认为假（单一用途）。

  • 参数inherited（可选）为此属性的Inherited属性提供值，一个布尔值。如果为真，则派生类将继承该属性。默认值为假（未继承）。

例如，

[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

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

指定此属性的语法如下：

[Obsolete (
   message
)]

[Obsolete (
   message,
   iserror
)]

其中，

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

  • 参数iserror是一个布尔值。如果其值为真，则编译器应将项目的用法视为错误。默认值为假（编译器生成警告）。

以下程序演示了这一点：

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 Framework 允许创建自定义属性，这些属性可用于存储声明性信息，并在运行时检索。此信息可以与任何目标元素相关联，具体取决于设计标准和应用程序需求。

创建和使用自定义属性涉及四个步骤：

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

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

声明自定义属性

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

//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

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

构造自定义属性

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

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

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

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

//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;
      }
   }
}

应用自定义属性

通过将其放置在其目标之前立即应用属性：

[DeBugInfo(45, "Zara Ali", "12/8/2012", Message = "Return type mismatch")]
[DeBugInfo(49, "Nuha Ali", "10/10/2012", Message = "Unused variable")]
class Rectangle {
   //member variables
   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());
   }
}

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

打印页面
上一页
下一页
广告

© . All rights reserved.