AssemblyMetadataAttribute可用于在.NET程序集中嵌入自定义键值对元数据，通过AssemblyInfo.cs或.csproj文件声明，运行时利用反射读取，适用于存储构建信息、环境标识等非标准属性，区别于AssemblyVersion等预定义属性，其优势在于灵活扩展程序集的自我描述能力。
这里的
$(BuildDateTime)
和
$(ComputerName)
可以是MSBuild属性，这样就能在构建时动态注入信息了，这对我来说简直是追踪部署版本时的神器。
AssemblyMetadataAttribute与AssemblyVersion等标准属性有何不同？
说白了，
AssemblyMetadataAttribute
和
AssemblyVersion
、
AssemblyCompany
这种标准属性，它们的目的和设计哲学有着根本区别。
AssemblyVersion
、
AssemblyCompany
、
AssemblyProduct
这些，它们是.NET框架预定义好的，有着明确的语义和用途。比如
AssemblyVersion
直接影响程序集的版本兼容性策略，
AssemblyCompany
就是为了标识软件的开发公司。这些属性通常会被各种工具（比如安装程序、依赖解析器）识别和利用，它们是程序集“身份证”上的标准字段。它们有固定的结构和期望的值类型。
而
AssemblyMetadataAttribute
则完全是“自由发挥”的区域。它不预设任何语义，仅仅提供一个键值对的容器。你可以往里面塞任何你觉得有用的信息，比如一个Git提交哈希值、一个特定的构建服务器名称、某个内部配置标识，甚至是程序集是否启用了某个实验性功能等等。它就像程序集的一个“备忘录”或者“便签纸”，你可以写上任何你想写的东西，只要你能在运行时通过反射读出来就行。我个人觉得，当你的信息不适合任何一个标准属性时，
AssemblyMetadataAttribute
就是最优雅的归宿。试图把一个Git哈希硬塞到
AssemblyDescription
里，那才叫真的别扭。
如何在运行时读取AssemblyMetadataAttribute添加的元数据？
既然元数据已经嵌入到程序集里了，那么在运行时要读取它，就得用到反射（Reflection）了。这就像拿着放大镜去检查程序集的内部结构。
基本步骤是：
获取当前正在执行的程序集或你想要检查的特定程序集对象。调用程序集对象的
GetCustomAttributes()
方法，其中
T
就是
AssemblyMetadataAttribute
。遍历返回的属性集合，访问每个属性的
Key
和
Value
属性来获取数据。
下面是一个简单的C#代码示例，展示了如何读取这些元数据：
using System;using System.Linq;using System.Reflection; // 别忘了引用这个命名空间public class AssemblyMetadataReader{ public static void ReadMyAssemblyMetadata() { // 获取当前正在执行的程序集 Assembly currentAssembly = Assembly.GetExecutingAssembly(); Console.WriteLine($"正在检查程序集: {currentAssembly.FullName}"); // 获取所有 AssemblyMetadataAttribute 实例 var metadataAttributes = currentAssembly.GetCustomAttributes(); if (!metadataAttributes.Any()) { Console.WriteLine("当前程序集没有找到任何 AssemblyMetadataAttribute 元数据。"); return; } Console.WriteLine("n发现以下自定义程序集元数据："); foreach (var attr in metadataAttributes) { Console.WriteLine($" 键 (Key): {attr.Key}"); Console.WriteLine($" 值 (Value): {attr.Value}"); Console.WriteLine("--------------------"); } // 如果你知道某个特定的键，也可以直接查询 var buildDateAttr = metadataAttributes.FirstOrDefault(a => a.Key == "BuildDate"); if (buildDateAttr != null) { Console.WriteLine($"n特定元数据 'BuildDate': {buildDateAttr.Value}"); } } // 假设你有一个主方法来调用它 public static void Main(string[] args) { ReadMyAssemblyMetadata(); Console.ReadKey(); // 暂停控制台，方便查看输出 }}
这段代码非常直接，它会列出所有你通过
AssemblyMetadataAttribute
添加的键值对。实际应用中，你可能需要根据特定的键来查找对应的值，比如前面示例中的
BuildDate
。
AssemblyMetadataAttribute在实际项目中有什么应用场景？
AssemblyMetadataAttribute
在实际项目中有着不少非常实用的场景，它能解决一些看似细小却在关键时刻能救命的问题。
一个最常见的，也是我个人用得最多的场景，就是嵌入构建信息。想象一下，你的应用程序部署到生产环境后，出了个Bug，客服反馈说“某个功能不对劲”。这时候，如果你的程序集里包含了诸如：
Git提交哈希 (Git Commit Hash)：
[assembly: AssemblyMetadata("GitCommit", "abcdef123456")]
构建时间 (Build Timestamp)：
[assembly: AssemblyMetadata("BuildTime", "2023-10-27T10:30:00Z")]
构建服务器名称 (Build Server Name)：
[assembly: AssemblyMetadata("BuildServer", "Jenkins-Prod-01")]
分支名称 (Branch Name)：
[assembly: AssemblyMetadata("GitBranch", "feature/bugfix-123")]
目标环境 (Target Environment)：
[assembly: AssemblyMetadata("TargetEnv", "Production")]
那么，当你在日志中看到某个异常或者用户报告问题时，你就能立刻通过程序集自带的这些元数据，精确地追溯到是哪个Git提交、在哪个服务器上、什么时候构建出来的这个版本。这对于快速定位问题、复现Bug，以及确保部署的正确性来说，简直是无价之宝。我曾经就靠着这个，在没有版本号信息的情况下，成功定位到一个线上Bug对应的代码版本。
其次，它也可以用于内部配置或功能标记。虽然运行时配置通常通过配置文件或环境变量来管理，但有时一些编译时就确定的、不常变动的“配置”或者“功能开关”也可以放在这里。比如，一个库可能根据不同的客户需求编译出不同的版本，每个版本包含或不包含某些功能。你可以在程序集中标记：
[assembly: AssemblyMetadata("FeatureSet", "EnterpriseEdition")]
或者
[assembly: AssemblyMetadata("IsTrialVersion", "False")]
。这样，在应用程序启动时，就可以读取这些标记来调整行为，而无需额外的配置文件。这对于一些需要硬编码但又想灵活切换的特性来说，提供了便利。
再有，工具或部署流程的辅助信息。比如，一个复杂的微服务系统，你可能需要标记某个服务属于哪个部署组，或者它应该被哪个特定的部署工具处理。
[assembly: AssemblyMetadata("DeploymentGroup", "CoreServices")]
这样的元数据就能帮助自动化部署脚本识别和处理不同的程序集。
总的来说，
AssemblyMetadataAttribute
提供了一个简洁、标准化的方式来将任何你认为重要的、与程序集本身相关的自定义信息打包进去。它避免了额外的配置文件，也比在文件名里塞信息要优雅得多，而且能够被程序以编程方式读取。它的价值在于提供了一种“内省”的能力，让程序集能够“自我描述”一些非标准但又关键的属性。
以上就是.NET的AssemblyMetadataAttribute类如何添加元数据？的详细内容，更多请关注创想鸟其它相关文章！
版权声明：本文内容由互联网用户自发贡献，该文观点仅代表作者本人。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。
如发现本站有涉嫌抄袭侵权/违法违规的内容， 请发送邮件至 chuangxiangniao@163.com 举报，一经查实，本站将立刻删除。
发布者：程序猿，转转请注明出处：https://www.chuangxiangniao.com/p/1439539.html
赞 (0)
打赏
微信扫一扫
支付宝扫一扫
微信扫一扫
支付宝扫一扫
