.NET：Attribute 入门（内训教程）

背景

接触过的语言中，C#（.NET 平台的多数语言都支持）、Java 和 Python 都支持这个特性，本文重点介绍 C# 中的应用，这里简单的对 C#、java 和 Python 中的 Attribute 做个总结：

• C#：可以封装状态和行为，会作为元数据存储在程序集中，会关联某些语言结构，可以运行时读取。
• Java：只能封装状态（Java 中叫：Annotation），会作为元数据存储在程序集中，会关联某些语言结构，可以运行时读取（根据配置，某些 Annotation 只在存在编译时）。
• Python：只是语言糖，算是一种工厂（Python 中叫 Detector），比如：装饰一个对象，然后返回一个代理。

后面谈到 Attribute 都是指 C# 中的 Attribute。

认识 Attribute

Attribute 是一种类型，这种类型封装了一些元数据（状态）和行为，Attribute 可以应用在某些级别的语言结构上（程序集、类、方法、参数等等），Attribute 有如下用处：

1. 影响编译器：
   

       [CLSCompliant]
       class Program
       {
           static void Main(string[] args)
           {
           }
       }

   注意：除了编译器开发团队可以开发这种 Attribute，其他人是不可能开发的。

2. 影响运行时：
   

       [MTAThread]
       class Program
       {
           static void Main(string[] args)
           {
           }
       }

   注意：除了 CLR 开发团队可以开发这种 Attribute，其他人是不可能开发的，当然，如果 CLR 提供了一种机制，可以识别某个 Attribute 的子类的话，你也可以继承这个 Attribute 开发自己的子类了。

3. 影响框架和应用程序：
   

   using System;
   using System.Collections.Generic;
   using System.Linq;
   using System.Text;
   using System.Threading.Tasks;
   using System.Web.Mvc;
   
   using Common.Logging;
   using Happy.ExceptionHanding;
   using Happy.Web.Mvc.Newtonsoft;
   
   namespace Happy.Web.Mvc.ExceptionHanding
   {
       /// <summary>
       /// 处理应用程序未捕获的异常。
       /// </summary>
       [AttributeUsage(AttributeTargets.Class, AllowMultiple = false, Inherited = true)]
       public class WriteExceptionResultAttribute : FilterAttribute, IExceptionFilter
       {
           /// <inheritdoc />
           public void OnException(ExceptionContext filterContext)
           {
               var exception = filterContext.Exception;
               if (!FriendlyExceptionRegistry.IsFriendly(exception.GetType()))
               {
                   LogManager.GetCurrentClassLogger().Error(exception);
               }
               filterContext.Result = CreateErrorResult(exception);
               filterContext.ExceptionHandled = true;
           }
   
           private static ActionResult CreateErrorResult(Exception exception)
           {
               var information = ExceptionInformationProviderRegistry.CreateInformation(exception);
   
               return new NewtonsoftJsonResult
               {
                   Data = information
               };
           }
       }
   }

   注意：之所以可以开发这个 Attribute，是因为 ASP.NET MVC 提供了这种机制，它的内部实现会在运行时反射这种（实现了某个基类）Attribute，然后根据 Attribute 的元数据执行某些逻辑，或者调用 Attribute 的行为。

开发自定义 Attribute

参考文章：http://www.cnblogs.com/hyddd/archive/2009/07/20/1526777.html。