在C#项目开发中,获取程序集版本号以及读取项目属性配置信息是常见需求,比如在做版本校验、日志记录或者关于页面展示时都会用到这些内容。程序集版本号通常在项目属性中配置,通过反射相关的类就可以获取到对应信息。

程序集版本号的基本概念
在C#项目中,程序集版本号分为四个部分,分别是主版本号、次版本号、生成号和修订号,格式为主版本.次版本.生成号.修订号。这些信息可以在项目的属性页面中进行配置,编译后会嵌入到生成的程序集文件中。
通过Assembly类获取程序集版本号
System.Reflection命名空间下的Assembly类提供了获取程序集相关信息的核心方法,我们可以通过它获取当前运行的程序集实例,再读取版本号属性。
获取当前程序集的版本号
以下是获取当前执行程序集版本号的示例代码:
using System;
using System.Reflection;
namespace AssemblyVersionDemo
{
class Program
{
static void Main(string[] args)
{
// 获取当前正在运行的程序集
Assembly currentAssembly = Assembly.GetExecutingAssembly();
// 获取程序集的版本信息
Version assemblyVersion = currentAssembly.GetName().Version;
// 输出版本号
Console.WriteLine("程序集版本号:" + assemblyVersion.ToString());
Console.ReadLine();
}
}
}
上述代码中,Assembly.GetExecutingAssembly()方法用于获取包含当前正在执行的代码的程序集,然后通过GetName().Version属性就可以拿到版本号对象,该对象包含了四个部分的版本信息,直接调用ToString()方法就能得到完整的版本号字符串。
获取指定程序集的版本号
如果需要获取其他程序集的版本号,可以通过加载指定路径的程序集来实现,示例代码如下:
using System;
using System.Reflection;
namespace AssemblyVersionDemo
{
class Program
{
static void Main(string[] args)
{
try
{
// 加载指定路径的程序集,这里替换为实际的程序集路径
Assembly targetAssembly = Assembly.LoadFrom(@"C:TestTestLibrary.dll");
Version targetVersion = targetAssembly.GetName().Version;
Console.WriteLine("目标程序集版本号:" + targetVersion.ToString());
}
catch (Exception ex)
{
Console.WriteLine("获取程序集失败:" + ex.Message);
}
Console.ReadLine();
}
}
}
使用Assembly.LoadFrom()方法可以加载指定路径的程序集文件,之后同样通过GetName().Version获取版本号。需要注意的是,如果程序集路径不存在或者程序集无效,会抛出异常,因此需要做好异常处理。
读取项目属性中的其他信息
除了版本号,项目属性中还配置了公司名称、产品名称、版权信息等内容,这些信息的读取方式和版本号类似,都是通过Assembly的自定义特性来获取。
常见的项目属性信息读取示例
以下是读取公司名称、产品名称、版权信息的代码示例:
using System;
using System.Reflection;
namespace AssemblyVersionDemo
{
class Program
{
static void Main(string[] args)
{
Assembly currentAssembly = Assembly.GetExecutingAssembly();
// 获取公司名称
AssemblyCompanyAttribute companyAttr = currentAssembly.GetCustomAttribute<AssemblyCompanyAttribute>();
string companyName = companyAttr != null ? companyAttr.Company : "未知";
// 获取产品名称
AssemblyProductAttribute productAttr = currentAssembly.GetCustomAttribute<AssemblyProductAttribute>();
string productName = productAttr != null ? productAttr.Product : "未知";
// 获取版权信息
AssemblyCopyrightAttribute copyrightAttr = currentAssembly.GetCustomAttribute<AssemblyCopyrightAttribute>();
string copyright = copyrightAttr != null ? copyrightAttr.Copyright : "未知";
Console.WriteLine("公司名称:" + companyName);
Console.WriteLine("产品名称:" + productName);
Console.WriteLine("版权信息:" + copyright);
Console.ReadLine();
}
}
}
这里用到了GetCustomAttribute<T>()方法,它可以获取程序集上指定的自定义特性,比如AssemblyCompanyAttribute对应公司名称特性,AssemblyProductAttribute对应产品名称特性,拿到特性实例后就可以读取对应的属性值。
不同版本号的区别
在C#项目中,除了程序集版本号,还有文件版本号和产品版本号,三者的区别如下:
| 版本号类型 | 对应特性 | 用途 |
|---|---|---|
| 程序集版本号 | AssemblyVersion | 用于.NET运行时的程序集绑定和加载,是程序集的唯一标识部分 |
| 文件版本号 | AssemblyFileVersion | 对应Windows文件属性中的文件版本,主要用于文件管理 |
| 产品版本号 | AssemblyInformationalVersion | 对应Windows文件属性中的产品版本,通常用于展示给用户的产品版本信息 |
如果需要获取文件版本号,可以使用AssemblyFileVersionAttribute特性,示例代码如下:
using System;
using System.Reflection;
namespace AssemblyVersionDemo
{
class Program
{
static void Main(string[] args)
{
Assembly currentAssembly = Assembly.GetExecutingAssembly();
AssemblyFileVersionAttribute fileVersionAttr = currentAssembly.GetCustomAttribute<AssemblyFileVersionAttribute>();
string fileVersion = fileVersionAttr != null ? fileVersionAttr.Version : "未知";
Console.WriteLine("文件版本号:" + fileVersion);
Console.ReadLine();
}
}
}
注意事项
- 程序集版本号修改后需要重新编译项目才能生效,运行时获取的是编译时嵌入的版本信息。
- 如果项目没有配置对应的特性,比如没有设置公司名称,那么
GetCustomAttribute方法会返回null,需要做非空判断避免空引用异常。 - 加载外部程序集时,要确保程序集和目标项目的.NET版本兼容,否则可能出现加载失败的情况。
获取程序集版本号和项目属性信息的方法都比较固定,核心是利用反射相关的类,开发者可以根据实际需求选择合适的特性进行读取,满足不同的业务场景。