AI 助理
备案控制台
开发者社区 开发与运维 文章 正文

C#自定义属性与反射综合应用

2013-09-05 1093
版权
版权声明：
本文内容由阿里云实名注册用户自发贡献，版权归原作者所有，阿里云开发者社区不拥有其著作权，亦不承担相应法律责任。具体规则请查看《 阿里云开发者社区用户服务协议》和 《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容，填写 侵权投诉表单进行举报，一经查实，本社区将立刻删除涉嫌侵权内容。
简介： 一、属性的基本概念 1、什么是属性？为什么要使用属性？     属性提供功能强大的方法以将声明信息与 C# 代码（类型、方法、属性等）相关联。特别在数据库设计中，一个数据库中的各个字段的性质不一样，有的是primary key,有的是key,有的则是普通的字段，通过属性的该表的类中进行字段标识，使用时通过反射出这些属性就可以知道这个字段的信息。

一、属性的基本概念

1、什么是属性？为什么要使用属性？

    属性提供功能强大的方法以将声明信息与 C# 代码（类型、方法、属性等）相关联。特别在数据库设计中，一个数据库中的各个字段的性质不一样，有的是primary key,有的是key,有的则是普通的字段，通过属性的该表的类中进行字段标识，使用时通过反射出这些属性就可以知道这个字段的信息。

2、属性的两种表现形式

    一种是在公共语言运行时 (CLR) 中定义的属性。
    另一种是可以创建的用于向代码中添加附加信息的自定义属性。此信息可在以后以编程方式检索。

3、属性的使用场合

    属性可以放置在几乎所有的声明中（但特定的属性可能限制在其上有效的声明类型）。

4、属性的使用语法

    在语法上，属性的指定方法为：将括在方括号中的属性名置于其适用的实体声明之前。

二、属性的案例说明

    本案例主要实现自定义属性类DescriptionAttribute，在类CNBAStar及其成员中应用该属性，并在main（）中通过反射的方式将这些属性获取。
案例代码：

点击(此处)折叠或打开

  1. using System;
  2. using System.Collections.Generic;
  3. using System.Linq;
  4. using System.Text;
  5. using System.Reflection;

  7. namespace CustomAttibute2
  8. {
  9.     class Program
  10.     {
  11.         [Description("I'm class CNBAStar ",ExtraInfo="private")]
  12.         class CNBAStar
  13.         {
  14.             private string mName = "Michael Jordan";

  16.             #region Properties field
  17.             [Description("I'm CNBAStar's attribute Name")]
  18.             public string Name
  19.             {
  20.                 get { return mName; }
  21.                 set { Name = mName; }
  22.             }
  23.             #endregion

  25.             #region Methods field
  26.             [Description("I'm CNBAStar's mothed ShowTime()",ExtraInfo="public")]
  27.             public string ShowTime()
  28.             { return mName + " is most famous basketball player of the world!"; }

  30.             [method: Description("I'm CNBAStar's mothed ShowTime2()")]
  31.             public string ShowTime2()
  32.             { return "Kobe Brynt is so so."; }

  34.             [return: Description("Just mark the return value of showTime3() ")]
  35.             public string ShowTime3()
  36.             { return "Lebron James is so so."; }
  37.             #endregion
  38.         }

  40.         static void Main(string[] args)
  41.         {
  42.             /* 反射出CNBAStar class中携带信息的方法 */
  43.             Object[] attrs = typeof(CNBAStar).GetCustomAttributes(true);
  44.             foreach (Object obj in attrs)
  45.             {
  46.                 if (obj is DescriptionAttribute)
  47.                 {
  48.                     Console.WriteLine((obj as DescriptionAttribute).MData);
  49.                     Console.WriteLine("===================================================");
  50.                 }
  51.             }

  53.             /* 反射出CNBAStar class中相关属性、方法所携带信息的方法：
  54.              * 先获取class.members,再取type.GetCustomAttributes() */
  55.             MemberInfo[] members = typeof(CNBAStar).GetMembers();
  56.             foreach (MemberInfo member in members)
  57.             { ParseAttributes(member); }

  59.             Console.ReadKey();
  60.         }


  63.         /** *************************************************************************************************
  64.          * DESC : 将class的members所携带的信息一 一进行反射
  65.          * ARGC :
  66.          * @type: member's all infomation.
  67.          * RET:
  68.          *---------------------------------------------------------------------------------------------------
  69.         ****************************************************************************************************/
  70.         static void ParseAttributes(MemberInfo type)
  71.         {
  72.             object[] attributes = type.GetCustomAttributes(true);
  73.             Console.WriteLine("{0} {1}'s attributes:", type.MemberType.ToString(), type.Name);

  75.             if (attributes.Length != 0)
  76.             {
  77.                 foreach (object attribute in attributes)
  78.                 {
  79.                     Console.WriteLine(" Attribute =[{0}]", attribute.ToString());
  80.                     DescriptionAttribute da = attribute as DescriptionAttribute;
  81.                     if (da != null)
  82.                     {
  83.                         Console.WriteLine(".Description = {0}",da.MData);
  84.                         if (da.ExtraInfo != "")
  85.                             Console.WriteLine(".ExtraInfo = {0}", da.ExtraInfo);
  86.                         else
  87.                             Console.WriteLine(".ExtraInfo=\"\"");
  88.                     }
  89.                     Console.WriteLine();
  90.                 }
  91.             }
  92.             else
  93.                 Console.WriteLine(" {0} has no attributes\n", type.Name);
  94.         }


  97.         [AttributeUsage(AttributeTargets.All)]
  98.         public class DescriptionAttribute : Attribute
  99.         {
  100.             private string mData;
  101.             private string mExtraInfo;
  102.             private string mThirdInfo;

  104.             public DescriptionAttribute(string data)
  105.             {
  106.                 mData = data;
  107.                 mExtraInfo = "";
  108.                 mThirdInfo = "";
  109.             }

  111.             public string MData
  112.             {
  113.                 get { return mData; }
  114.             }

  116.             /* Extra infomation */
  117.             public string ExtraInfo
  118.             {
  119.                 get { return mExtraInfo; }
  120.                 set { mExtraInfo = value; ; }
  121.             }

  123.             public string ThirdInfo
  124.             {
  125.                 get { return mThirdInfo; }
  126.                 set { mThirdInfo = value; ; }
  127.             }
  128.         }

  130.     }
  131. }


image

图2-1

    上图是使用程序中使用了[Description]属性的类、方法、Property被反射出的属性信息。

三、定位参数与命令参数

    自定义属性类中构造函数的参数称之为定位参数（即本例的data）,任何公共读写字段或属性都是命令参数。两类参数的区别：

1、定位参数是构造函数带的参数，必须填写，下面是典型的报错：

  1. [Description]
  2. private string mName = "Michael Jordan";

错误    1    “CustomAttibute2.Program.DescriptionAttribute”不包含采用“0”参数的构造函数    

2、命令参数能选择性填写，并且顺序不要求。
    本例中的下面两种写法都是正确的

顺序一：

  1. [Description("I'm CNBAStar's mothed ShowTime()",ExtraInfo="public",ThirdInfo=="3#")]
  2. public string ShowTime()

顺序二：

  1. [Description("I'm CNBAStar's mothed ShowTime()",ThirdInfo=="3#",ExtraInfo="public")]
  2. public string ShowTime()

四、消除属性目标的歧义性

  1. [Description("I'm CNBAStar's mothed ShowTime()",ExtraInfo="public")]
  2. public string ShowTime()
  3. { return mName + " is most famous basketball player of the world!"; }

    上面代码中，虽然.NET内部将这个Description习惯归于ShowTime()方法，但表面上看这样的写法仍然让人容易误解：这个属性到底是属性方法ShowTime()还是属性它的返回值？

    为了解决这种歧义，在属性中添加了method和return参数作为区分，如下：

    属性标识方法ShowTime2()

  1. [method: Description("I'm CNBAStar's mothed ShowTime2()")]
  2. public string ShowTime2()
  3. { return "Kobe Brynt is so so."; }

    属性标识返回值

  1. [return: Description("Just mark the return value of showTime3() ")]
  2. public string ShowTime3()
  3. { return "Lebron James is so so."; }



参考文献：

1、http://edn.embarcadero.com/article/30250

Using Custom Attributes in C# - By David Clegg

2、http://msdn.microsoft.com/zh-cn/library/b3787ac0(v=vs.90).aspx 

消除属性目标的歧义性

3、http://database.ctocio.com.cn/4/9344004.shtml

SQLServer:如何使用C#自定义属性

4、http://www.csharpwin.com/csharpspace/11732r3341.shtml

如何在C#中自定义属性

文章标签：
C#
.NET
数据库
开发框架
关键词：
C#反射
C#属性
C#自定义应用
C#自定义
C#反射应用
长空翱翔
目录
相关文章
代码掌控者
|
17天前
|
程序员 C# 数据库
C# 比较对象新思路，利用反射技术打造更灵活的比较工具
中途接手的项目，碰到需要在更新对象信息时比较并记录差异的需求，最变态的还有附加要求，怎么办？有没有既能满足需求又能对项目影响最小的方法呢？分享这个我封装的方法，一个利用反射技术打造的更灵活的比较工具
代码掌控者
30 5
蓝易云
|
23天前
|
存储 安全 编译器
学懂C#编程：属性（Property）的概念定义及使用详解
通过深入理解和使用C#的属性，可以编写更清晰、简洁和高效的代码，为开发高质量的应用程序奠定基础。
蓝易云
81 12
长梦
|
2月前
|
存储 安全 物联网
C# 在物联网 (IoT) 应用中的应用
本文介绍了C#在物联网（IoT）应用中的应用，涵盖基础概念、优势、常见问题及其解决方法。重点讨论了网络通信、数据处理和安全问题，并提供了相应的代码示例，旨在帮助开发者更好地利用C#进行IoT开发。
长梦
102 3
蓝易云
|
2月前
|
编译器 C#
c# - 运算符＜＜不能应用于long和long类型的操作数
在C#中，左移运算符的第二个操作数必须是 `int`类型，因此需要将 `long`类型的位移计数显式转换为 `int`类型。这种转换需要注意数据丢失和负值处理的问题。通过本文的详细说明和示例代码，相信可以帮助你在实际开发中正确使用左移运算符。
蓝易云
43 3
蓝易云
|
2月前
|
编译器 C#
c# - 运算符＜＜不能应用于long和long类型的操作数
在C#中，左移运算符的第二个操作数必须是 `int`类型，因此需要将 `long`类型的位移计数显式转换为 `int`类型。这种转换需要注意数据丢失和负值处理的问题。通过本文的详细说明和示例代码，相信可以帮助你在实际开发中正确使用左移运算符。
蓝易云
73 1
蓝易云
|
2月前
|
编译器 C#
c# - 运算符＜＜不能应用于long和long类型的操作数
在C#中，左移运算符的第二个操作数必须是 `int`类型，因此需要将 `long`类型的位移计数显式转换为 `int`类型。这种转换需要注意数据丢失和负值处理的问题。通过本文的详细说明和示例代码，相信可以帮助你在实际开发中正确使用左移运算符。
蓝易云
26 0
长梦
|
3月前
|
消息中间件 网络协议 安全
C# 一分钟浅谈：WebSocket 协议应用
【10月更文挑战第6天】在过去的一年中，我参与了一个基于 WebSocket 的实时通信系统项目，该项目不仅提升了工作效率，还改善了用户体验。本文将分享在 C# 中应用 WebSocket 协议的经验和心得，包括基础概念、C# 实现示例、常见问题及解决方案等内容，希望能为广大开发者提供参考。
长梦
199 0
何雨晨
|
3月前
|
Web App开发 网络协议 API
基于C#编写一个远程桌面应用
基于C#编写一个远程桌面应用
何雨晨
95 0
长梦
|
2月前
|
C# 开发者
C# 一分钟浅谈：Code Contracts 与契约编程
【10月更文挑战第26天】本文介绍了 C# 中的 Code Contracts，这是一个强大的工具，用于通过契约编程增强代码的健壮性和可维护性。文章从基本概念入手，详细讲解了前置条件、后置条件和对象不变量的使用方法，并通过具体代码示例进行了说明。同时，文章还探讨了常见的问题和易错点，如忘记启用静态检查、过度依赖契约和性能影响，并提供了相应的解决建议。希望读者能通过本文更好地理解和应用 Code Contracts。
长梦
44 3
长梦
|
2月前
|
设计模式 C# 图形学
Unity 游戏引擎 C# 编程：一分钟浅谈
本文介绍了在 Unity 游戏开发中使用 C# 的基础知识和常见问题。从 `MonoBehavior` 类的基础用法，到变量和属性的管理，再到空引用异常、资源管理和性能优化等常见问题的解决方法。文章还探讨了单例模式、事件系统和数据持久化等高级话题，旨在帮助开发者避免常见错误，提升游戏开发效率。
长梦
79 4