[C#] 剖析 AssemblyInfo.cs - 了解常用的特性 Attribute

剖析 AssemblyInfo.cs - 了解常用的特性 Attribute

【博主】反骨仔　　　　【原文】http://www.cnblogs.com/liqingwen/p/5944391.html

 

  

序

　　之前，我们通过《C# 知识回顾 - 特性 Attribute》已经了解如何创建和使用特性 Attribute，这次，让我们一起来看看每次使用 VS 创建项目时所自带的文件 AssemblyInfo.cs。

 

目录

• 全局特性
• 已过时的特性：Obsolete
• 条件特性：Conditional
• 调用方信息特性

 

AssemblyInfo.cs

随机挑选一个 AssemblyInfo.cs 文件，展开图中的代码，看箭头↓

using System.Reflection;
using System.Runtime.InteropServices;

// 有关程序集的常规信息通过下列特性集
// 控制。更改这些特性值可修改
// 与程序集关联的信息。
[assembly: AssemblyTitle("MusicStore")]
[assembly: AssemblyDescription("")]
[assembly: AssemblyConfiguration("")]
[assembly: AssemblyCompany("Microsoft")]
[assembly: AssemblyProduct("MusicStore")]
[assembly: AssemblyCopyright("Copyright © Microsoft 2016")]
[assembly: AssemblyTrademark("")]
[assembly: AssemblyCulture("")]

// 将 ComVisible 设置为 false 会使此程序集中的类型
// 对 COM 组件不可见。如果需要
// 从 COM 访问此程序集中的某个类型，请针对该类型将 ComVisible 特性设置为 true。
[assembly: ComVisible(false)]

// 如果此项目向 COM 公开，则下列 GUID 用于 typelib 的 ID
[assembly: Guid("a9ef3281-9049-4a52-a2f1-2061d442200e")]

// 程序集的版本信息由下列四个值组成:
//
//      主版本
//      次版本
//      内部版本号
//      修订版本
//
// 可以指定所有值，也可以使用“修订号”和“内部版本号”的默认值，
// 方法是按如下所示使用 "*":
[assembly: AssemblyVersion("1.0.0.0")]
[assembly: AssemblyFileVersion("1.0.0.0")]

 

一、全局特性

　　大多数特性适用于特定的语言元素（如类或方法），但是，有种特性它们适用于整个程序集或模块，称为全局特性。如：AssemblyVersionAttribute 特性可用于向程序集中嵌入版本信息。

 

　　全局特性在源代码中出现在任何顶级 using 指令以及任何类型、模块或命名空间声明之前。全局特性可显示在多个源文件，但是，在单一编译传递必须编译文件。在 C# 项目中，它们在 AssemblyInfo.cs 文件中。

　　程序集特性是提供有关程序集的信息的值。它们分成以下类别:

　　　　①程序集标识特性

　　　　②信息性特性

　　　　③程序集清单特性

　　　　④强名称特性

　　

　　1.程序集标识特性

　　三个特性 (使用强名称，如果适用) 确定程序集的标识：名称、版本和区域性。当在代码中引用时，这些特性构成程序集的完整名称需要。使用特性，可以将程序集的版本、区域性和名称值，由编译器，在 “程序集信息”对话框 的 Visual Studio IDE 设置，在创建程序集后，根据包含程序集清单的文件。AssemblyFlagsAttribute 特性指定程序集的多个副本是否可以共存。

 

图 - “程序集信息”对话框

图 - “程序集信息”对话框中的名词和 AssemblyInfo.cs 文件的对应关系

 

　　2.信息性特性

　　您可以使用信息性特性为程序集提供其他的公司或产品信息。

 

　　3.程序集清单特性

　　可以使用程序集清单特性提供程序集清单中的信息。其中包括标题、说明、默认别名和配置。

 

　　4.强名称特性（不深入）

　　一般存在 Visual Studio 的早期版本，若要使用强名称的程序集执行以下程序集级别特性:

　　　　①AssemblyKeyFileAttribute

　　　　②AssemblyKeyNameAttribute

　　　　③AssemblyDelaySignAttribute

　　虽然现在仍支持，但是，给程序集签名的首选方法是使用“签名页”。（这里不深入了解）

 

二、已过时的特性：Obsolete

 　　Obsolete 特性指示某个程序实体标记为建议不再使用的一个。 每次使用对实体标记为过时根据随后将生成警告或错误。

    /// <summary>
    /// 旧类
    /// </summary>
    [Obsolete("请使用 " + nameof(NewClass))]
    class OldClass
    {
        public void Method() { }
    }

    /// <summary>
    /// 新类
    /// </summary>
    class NewClass
    {
        [Obsolete("请使用 " + nameof(NewMethod), true)]
        public void OldMethod() { }

        public void NewMethod() { }
    }

    class Program
    {
        static void Main(string[] args)
        {
            var oldClass = new OldClass();　　//警告

            var newClass = new NewClass();
            newClass.OldMethod();　　//报错
        }
    }

　　在此示例中应用 Obsolete 特性类 OldClass 和方法 NewClass.OldMethod。此构造函数的第一个参数为警告或错误的信息，由于特性构造函数的第二个参数被应用于 NewClass.OldMethod 设置为 true，此方法将导致编译器错误，而使用 OldClass 只将生成警告的类。

 

三、条件特性：Conditional

　　Conditional 特性执行方法依赖于预处理标识符。Conditional 属性是 ConditionalAttribute 的别名，可应用于方法或属性类。

　　在此示例中，Conditional 应用于方法以启用或禁用程序特定诊断信息示:

    class Debug
    {
        [Conditional("DEBUG")]
        public static void Output(string msg)
        {
            Console.WriteLine(msg);
        }
    }

    class Program
    {
        static void Main(string[] args)
        {
            Debug.Output("This is Debug!");
            Console.WriteLine("Done!");

            Console.Read();
        }
    }

　　Conditional 特性通常用于在 DEBUG 标识符启用跟踪，并记录的功能的调试版本，但不在发布版本中。

　　

　　将之前的代码简单改动下，使用 #if…#endif 包扎，结果和上图是一样的。

    class Debug
    {
        public static void Output(string msg)
        {
            Console.WriteLine(msg);
        }
    }

    class Program
    {
        static void Main(string[] args)
        {
            #if DEBUG
            Debug.Output("This is Debug!");
            #endif

            Console.WriteLine("Done!");

            Console.Read();
        }
    }

　　使用 Conditional 更加整洁，当然也可以将平常不太到用到或者容易出错的方法在 #if…#endif 内部块标明。

 

四、调用方信息特性

　　使用调用方信息属性，可以获取关于调用方的信息传递给方法。可以获取源代码、行号在源代码和调用方的成员名称的文件路径。

　　若要获取成员调用方信息，请使用适用于可选参数的属性。每个可选参数指定默认值。

 

    internal class Program
    {
        private static void Main(string[] args)
        {
            CallerMethod();
            Console.Read();
        }

        public static void CallerMethod()
        {
            TraceMessage("我是调用者");
        }

        public static void TraceMessage(string msg,
            [CallerMemberName] string name = "",
            [CallerFilePath] string filePath = "",
            [CallerLineNumber] int lineNumer = 0)
        {
            Trace.WriteLine($"{nameof(msg)}: {msg}");
            Trace.WriteLine($"{nameof(name)}: {name}");
            Trace.WriteLine($"{nameof(filePath)}: {filePath}");
            Trace.WriteLine($"{nameof(lineNumer)}: {lineNumer}");
        }
    }

　　每次调用 CallerMethod 方法时，调用方信息将替换为可选参数的变量。

 

　　1.备注

　　你必须为每个可选参数指定显式默认值。不能将调用方信息特性应用于未指定为可选的参数。

　　调用方信息特性不会使参数成为可选参数。相反，它们会在忽略此参数时影响传入的默认值。

　　在编译时，调用方信息值将作为文本传入中间语言 (IL)。与异常的 StackTrace 特性的结果不同，这些结果不受模糊处理的影响。

　　你可显式提供可选参数来控制调用方信息或隐藏调用方信息。

 

传送门

　　《C# 知识回顾 - 特性 Attribute》

　　《C# 知识回顾 - 序列化》

　　《C# 知识回顾 - 表达式树 Expression Trees》

 

 

---

【参考】微软官方文档