跳转到内容

ApplicationHelper

ApplicationHelper 是一个静态帮助类,为应用程序提供了丰富的信息和控制功能,包括应用程序信息获取、系统环境信息检测、硬件信息获取、运行时监控、应用程序控制、环境变量管理等,旨在简化应用程序信息获取和系统环境检测的开发工作。

  • 📱 应用程序信息获取(名称、版本、路径等)
  • 🖥️ 系统环境信息检测(操作系统、架构、区域设置等)
  • 💾 硬件信息获取(处理器、磁盘、网络接口等)
  • 📊 运行时监控(进程信息、GC 信息、性能监控等)
  • 🔧 应用程序控制(重启、退出、权限检测等)
  • 🌍 环境变量管理
public static partial class ApplicationHelper

获取当前应用程序的名称。

public static string GetApplicationName()

返回值: 应用程序名称,如果无法获取则返回 “Unknown”。

获取当前应用程序的完整名称(包含版本信息)。

public static string GetApplicationFullName()

返回值: 应用程序完整名称,格式为 “名称 版本号”。

获取当前应用程序的版本。

public static Version GetApplicationVersion()

返回值: 应用程序版本,如果无法获取则返回 0.0.0.0。

获取当前应用程序的版本字符串。

public static string GetApplicationVersionString(int fieldCount = 3)
参数名类型描述
fieldCountint版本字段数量(1-4),默认为 3

获取当前应用程序的启动路径(基目录)。

public static string GetApplicationPath()

获取当前应用程序的可执行文件路径。

public static string GetExecutablePath()

注意: 在单文件发布模式下,此方法可能返回空字符串。

获取当前应用程序的配置文件路径。

public static string GetConfigurationPath()

获取应用程序域信息。

public static AppDomainInfo GetAppDomainInfo()

返回值: AppDomainInfo 对象,包含 FriendlyName、BaseDirectory、RelativeSearchPath、ShadowCopyFiles、IsFullyTrusted 属性。

获取当前进程 ID。

public static int GetProcessId()

获取当前进程名称。

public static string GetProcessName()

获取应用程序启动时间。

public static DateTime GetStartTime()

获取应用程序运行时长。

public static TimeSpan GetUptime()

获取操作系统信息。

public static OperatingSystemInfo GetOperatingSystemInfo()

返回值: OperatingSystemInfo 对象,包含 Platform、Version、ServicePack、Is64Bit、MachineName、UserName、UserDomainName 属性。

获取操作系统描述字符串。

public static string GetOSDescription()

获取当前系统架构。

public static string GetSystemArchitecture()

返回值: 系统架构(x64 或 x86)。

获取当前运行时架构。

public static string GetRuntimeArchitecture()

获取运行时框架描述。

public static string GetFrameworkDescription()

检查操作系统是否为 Windows。

public static bool IsWindows()

检查操作系统是否为 Linux。

public static bool IsLinux()

检查操作系统是否为 macOS。

public static bool IsMacOS()

获取当前操作系统平台。

public static string GetCurrentPlatform()

返回值: 操作系统平台名称(Windows、Linux、macOS 或 Unknown)。

获取系统区域信息。

public static CultureInfo GetSystemCulture()

获取系统 UI 区域信息。

public static CultureInfo GetSystemUICulture()

获取系统时区信息。

public static TimeZoneInfo GetSystemTimeZone()

获取系统时区名称。

public static string GetSystemTimeZoneName()

获取计算机名称。

public static string GetMachineName()

获取当前用户名。

public static string GetUserName()

获取用户域名。

public static string GetUserDomainName()

获取系统目录路径。

public static string GetSystemDirectory()

获取系统启动以来的毫秒数。

public static long GetTickCount()

返回值: 系统启动以来的毫秒数。

示例:

var tickCount = ApplicationHelper.GetTickCount();
Console.WriteLine($"系统运行时间: {tickCount / 1000 / 60} 分钟");

获取处理器信息。

public static ProcessorInfo GetProcessorInfo()

返回值: ProcessorInfo 对象,包含 ProcessorCount、ProcessorArchitecture、OSArchitecture 属性。

示例:

var cpuInfo = ApplicationHelper.GetProcessorInfo();
Console.WriteLine($"处理器数量: {cpuInfo.ProcessorCount}");
Console.WriteLine($"架构: {cpuInfo.ProcessorArchitecture}");

获取处理器核心数。

public static int GetProcessorCount()

获取可用内存(字节)。

public static long GetAvailableMemory()

注意: 此方法返回的是 GCMemoryInfo 中可用的内存大小,可能与实际系统可用内存不同。

获取磁盘驱动器信息列表。

public static List<DiskDriveInfo> GetDiskDriveInfo()

获取指定磁盘驱动器信息。

public static DiskDriveInfo? GetDiskDriveInfo(string driveName)

参数:

  • driveName: 驱动器名称(如 “C:”)

返回值: 指定驱动器的信息,如果不存在则返回 null。

获取网络接口信息列表。

public static List<NetworkInterfaceInfo> GetNetworkInterfaceInfo()

检查是否有网络连接。

public static bool HasNetworkConnection()

返回值: 如果有网络连接返回 true;否则返回 false。

示例:

if (ApplicationHelper.HasNetworkConnection())
{
Console.WriteLine("网络已连接");
}
else
{
Console.WriteLine("网络未连接");
}

获取运行时信息。

public static RuntimeInfo GetRuntimeInfo()

返回值: RuntimeInfo 对象,包含 WorkingSet、PeakWorkingSet、VirtualMemorySize、ThreadCount、HandleCount 等属性。

获取 GC 信息。

public static GCInfo GetGCInfo()

返回值: GCInfo 对象,包含 CollectionCountGen0、CollectionCountGen1、CollectionCountGen2、TotalMemory、MaxGeneration 属性。

获取当前内存使用量(字节)。

public static long GetMemoryUsage()

示例:

var memUsage = ApplicationHelper.GetMemoryUsage();
Console.WriteLine($"内存使用: {memUsage / 1024 / 1024} MB");

获取峰值内存使用量(字节)。

public static long GetPeakMemoryUsage()

获取线程数。

public static int GetThreadCount()

获取句柄数。

public static int GetHandleCount()

强制执行垃圾回收。

public static void ForceGarbageCollection(int generation = -1, bool blocking = false, bool compacting = false)

参数:

  • generation: 回收代数(0-2),-1 表示最大代数
  • blocking: 是否阻塞直到回收完成
  • compacting: 是否执行内存压缩

示例:

// 执行完整垃圾回收并压缩内存
ApplicationHelper.ForceGarbageCollection(blocking: true, compacting: true);

异步监控应用程序性能。

public static async Task MonitorPerformanceAsync(
TimeSpan duration,
TimeSpan interval,
Action<ResourceUsageSnapshot> callback,
CancellationToken cancellationToken = default)

参数:

  • duration: 监控持续时间
  • interval: 采样间隔
  • callback: 每次采样的回调
  • cancellationToken: 取消令牌

示例:

await ApplicationHelper.MonitorPerformanceAsync(
TimeSpan.FromSeconds(30),
TimeSpan.FromSeconds(1),
snapshot => Console.WriteLine($"CPU: {snapshot.CpuUsage}%, Memory: {snapshot.MemoryUsage}"));

获取应用程序资源使用情况快照。

public static ResourceUsageSnapshot GetResourceUsageSnapshot()

返回值: ResourceUsageSnapshot 对象,包含 Timestamp、CpuUsage、MemoryUsage、ThreadCount、HandleCount 属性。

示例:

var snapshot = ApplicationHelper.GetResourceUsageSnapshot();
Console.WriteLine($"CPU: {snapshot.CpuUsage:F1}%");
Console.WriteLine($"内存: {snapshot.MemoryUsage / 1024 / 1024} MB");

重启应用程序。

public static void Restart(string[]? args = null)

参数:

  • args: 启动参数,可选

注意: 此方法会终止当前进程并启动新进程。

退出应用程序。

public static void Exit(int exitCode = 0)

检查当前进程是否以管理员权限运行(仅 Windows)。

public static bool IsRunningAsAdministrator()

返回值: 如果以管理员权限运行返回 true;否则返回 false。

注意: 在非 Windows 系统上,此方法始终返回 false。

示例:

if (!ApplicationHelper.IsRunningAsAdministrator())
{
Console.WriteLine("请以管理员权限运行此程序");
}

以管理员权限重新启动应用程序(仅 Windows)。

public static bool RestartAsAdministrator()

返回值: 是否成功启动新进程。如果已经以管理员权限运行,则不执行任何操作并返回 false。

设置应用程序为单实例运行。

public static bool SetSingleInstance(string applicationName)
public static bool SetSingleInstance(string applicationName, out Mutex? mutex)

参数:

  • applicationName: 应用程序唯一标识名称
  • mutex: 创建的 Mutex 对象(需要保持引用防止被 GC 回收)

返回值: 如果是第一个实例返回 true;否则返回 false。

示例:

if (!ApplicationHelper.SetSingleInstance("MyUniqueAppName", out var mutex))
{
Console.WriteLine("应用程序已在运行");
return;
}
// 保持 mutex 引用直到程序退出
GC.KeepAlive(mutex);

设置进程优先级。

public static bool SetProcessPriority(ProcessPriorityClass priority)

参数:

  • priority: 进程优先级

返回值: 是否设置成功

示例:

ApplicationHelper.SetProcessPriority(ProcessPriorityClass.High);

启用高性能模式(提高进程优先级并禁止系统睡眠)。

public static bool EnableHighPerformanceMode()

返回值: 是否成功启用

注意: 此方法仅影响当前进程,不会永久修改系统设置。


获取应用程序启动参数。

public static string[] GetStartupArguments()

返回值: 启动参数数组

示例:

var args = ApplicationHelper.GetStartupArguments();
foreach (var arg in args)
{
Console.WriteLine($"参数: {arg}");
}

获取环境变量值。

public static string? GetEnvironmentVariable(string variableName, EnvironmentVariableTarget target = EnvironmentVariableTarget.Process)

参数:

  • variableName: 环境变量名称
  • target: 环境变量目标,默认为 Process

设置环境变量值。

public static void SetEnvironmentVariable(string variableName, string? value, EnvironmentVariableTarget target = EnvironmentVariableTarget.Process)

获取所有环境变量。

public static Dictionary<string, string> GetEnvironmentVariables(EnvironmentVariableTarget target = EnvironmentVariableTarget.Process)

检查环境变量是否存在。

public static bool HasEnvironmentVariable(string variableName, EnvironmentVariableTarget target = EnvironmentVariableTarget.Process)

示例:

if (ApplicationHelper.HasEnvironmentVariable("MY_VAR"))
{
Console.WriteLine("MY_VAR 已设置");
}

获取特殊文件夹路径。

public static string GetSpecialFolderPath(Environment.SpecialFolder folder)

参数:

  • folder: 特殊文件夹枚举

返回值: 文件夹路径

示例:

var desktop = ApplicationHelper.GetSpecialFolderPath(Environment.SpecialFolder.Desktop);
Console.WriteLine($"桌面: {desktop}");

获取应用程序数据目录(如果不存在会自动创建)。

public static string GetApplicationDataDirectory()

返回值: 应用程序数据目录路径

示例:

var appDataDir = ApplicationHelper.GetApplicationDataDirectory();
Console.WriteLine($"应用数据目录: {appDataDir}");

获取本地应用程序数据目录(如果不存在会自动创建)。

public static string GetLocalApplicationDataDirectory()

获取临时目录路径。

public static string GetTempDirectory()

创建临时文件并返回路径。

public static string CreateTempFile()

返回值: 临时文件路径

获取日志目录(如果不存在会自动创建)。

public static string GetLogDirectory()

返回值: 日志目录路径


using Chet.Utils.Helpers;
// 获取应用程序名称
var appName = ApplicationHelper.GetApplicationName();
Console.WriteLine($"应用程序名称: {appName}");
// 获取应用程序版本
var version = ApplicationHelper.GetApplicationVersion();
Console.WriteLine($"应用程序版本: {version}");
// 获取应用程序路径
var path = ApplicationHelper.GetApplicationPath();
Console.WriteLine($"应用程序路径: {path}");
// 获取运行时长
var uptime = ApplicationHelper.GetUptime();
Console.WriteLine($"已运行: {uptime.TotalHours:F2} 小时");
// 获取操作系统信息
var osInfo = ApplicationHelper.GetOperatingSystemInfo();
Console.WriteLine($"操作系统: {osInfo.Platform}");
Console.WriteLine($"版本: {osInfo.Version}");
Console.WriteLine($"64位: {osInfo.Is64Bit}");
// 检测操作系统平台
if (ApplicationHelper.IsWindows())
{
Console.WriteLine("当前运行在 Windows 系统");
}
else if (ApplicationHelper.IsLinux())
{
Console.WriteLine("当前运行在 Linux 系统");
}
// 获取时区信息
var timeZone = ApplicationHelper.GetSystemTimeZone();
Console.WriteLine($"时区: {timeZone.DisplayName}");
// 获取处理器核心数
var processorCount = ApplicationHelper.GetProcessorCount();
Console.WriteLine($"处理器核心数: {processorCount}");
// 获取内存信息
var totalMemory = ApplicationHelper.GetTotalMemory();
var availableMemory = ApplicationHelper.GetAvailableMemory();
Console.WriteLine($"总内存: {totalMemory / 1024 / 1024} MB");
Console.WriteLine($"可用内存: {availableMemory / 1024 / 1024} MB");
// 获取磁盘信息
var disks = ApplicationHelper.GetDiskDriveInfo();
foreach (var disk in disks)
{
Console.WriteLine($"磁盘 {disk.Name}: {disk.TotalSize / 1024 / 1024 / 1024} GB");
}
// 获取进程内存使用
var workingSet = ApplicationHelper.GetWorkingSet();
Console.WriteLine($"工作集内存: {workingSet / 1024 / 1024} MB");
// 获取线程数
var threadCount = ApplicationHelper.GetThreadCount();
Console.WriteLine($"线程数: {threadCount}");
// 获取 GC 内存
var gcMemory = ApplicationHelper.GetGCTotalMemory();
Console.WriteLine($"GC 总内存: {gcMemory / 1024 / 1024} MB");
// 检查是否以管理员权限运行
if (ApplicationHelper.IsAdministrator())
{
Console.WriteLine("当前以管理员权限运行");
}
else
{
Console.WriteLine("当前以普通用户权限运行");
}
// 确保单实例运行
if (!ApplicationHelper.EnsureSingleInstance("MyUniqueAppName"))
{
Console.WriteLine("应用程序已在运行,退出...");
ApplicationHelper.Exit(1);
}

属性名类型描述
FriendlyNamestring应用程序域友好名称
BaseDirectorystring基目录
RelativeSearchPathstring相对搜索路径
ShadowCopyFilesbool是否启用卷影复制
IsFullyTrustedbool是否完全受信任
属性名类型描述
Platformstring操作系统平台
Versionstring版本号
ServicePackstring服务包
Is64Bitbool是否为 64 位
MachineNamestring计算机名
UserNamestring用户名
UserDomainNamestring用户域名
属性名类型描述
Namestring驱动器名称
TotalSizelong总大小(字节)
AvailableFreeSpacelong可用空间(字节)
DriveFormatstring文件系统格式
DriveTypestring驱动器类型
属性名类型描述
Namestring接口名称
Descriptionstring描述
Statusstring状态
Speedlong速度(bps)
MacAddressstringMAC 地址

  1. 部分方法在不同操作系统上可能返回不同的结果。
  2. 获取硬件信息可能需要相应的权限。
  3. 单实例检测使用 Mutex 实现,确保 mutexName 全局唯一。
  4. 在单文件发布模式下,GetExecutablePath 可能返回空字符串。

  • .NET Framework 4.6.1 及以上版本
  • .NET Core 2.0 及以上版本
  • .NET 5.0 及以上版本
  • .NET Standard 2.1 及以上版本