C# 操作PowerShell模块文件 C#如何创建和解析.psd1和.psm1文件

1次阅读

powershell模块文件.psd1必须用powershell运行时解析,不可用c#直接读取;正确方式是引用microsoft.powershell.sdk,调用import-powershelldatafile并取baseobject获取hashtable,且需绝对路径、及时dispose。

C# 操作PowerShell模块文件 C#如何创建和解析.psd1和.psm1文件

PowerShell模块文件不是C#原生格式,别试图用File.ReadAllText直接解析.psd1

PSD1是PowerShell的哈希表序列化格式,本质是PowerShell代码(尽管看起来像json),C#没有内置解析器。直接读取再正则或JsonConvert.DeserializeObject会失败——ConvertFrom-StringData不适用,ConvertFrom-Json也报错,因为PSD1支持嵌套哈希、脚本块、类型标注(如[datetime]::Now)等非JSON语法。

正确路径只有一条:调用PowerShell运行时解析。别绕开它,也别写“轻量级PSD1解析器”,那只会漏掉@{Key='Value'; Nested=@{A=1}}Root = @{ PSModuleVersion = '1.2.3' }这类合法结构。

  • 必须引用 System.Management.Automation NuGet 包(v7+ 推荐用 Microsoft.PowerShell.SDK
  • 初始化 runspace 前先调用 [Powershell].Assembly.GetTypes() 触发自动加载,否则首次 PowerShell.Create() 可能卡住
  • PSD1 文件路径需用绝对路径传入,相对路径在 runspace 中默认以 PowerShell 工作目录为准,和 C# 当前目录无关

用PowerShell.Create().AddScript()安全加载.psd1并提取哈希表

不能用 Import-ModuleInvoke-Expression 加载 PSD1——它不是模块,是配置数据。正确做法是用 Import-PowerShellDataFile(v5.1+)或手动 Invoke-Expression + ConvertFrom-StringData 回退(不推荐)。v5.1 后应强制走 Import-PowerShellDataFile

Powershell ps = PowerShell.Create(); ps.AddScript("Import-PowerShellDataFile -Path 'C:modMyModule.psd1'"); var result = ps.Invoke(); if (ps.HadErrors) {     throw new InvalidOperationException(string.Join("; ", ps.Streams.Error.Select(e => e.Exception.Message))); } Hashtable data = result[0].BaseObject as Hashtable; // 注意是 BaseObject,不是 ToString()
  • Import-PowerShellDataFile 会做安全检查,拒绝含命令、函数定义的 PSD1;若遇到被拒文件,说明它其实不是纯数据文件,而是伪装成 PSD1 的脚本
  • 返回对象PSObject,必须取 .BaseObject 才能得到原始 Hashtable,否则得到的是带属性包装的代理对象
  • PowerShell runspace 是有状态的,每次用完建议调用 ps.Dispose(),尤其在循环中反复加载多个 PSD1 时,否则内存泄漏明显

.psm1 是 PowerShell 脚本,C#只能执行不能“解析AST”

PSM1 不是可反编译的二进制,也不是 C# 能静态分析的源码。它本质是 .ps1 脚本,只是约定扩展名和加载方式不同。你无法用 C# 提取其中的函数签名、参数列表或注释帮助(.SYNOPSIS)。想“解析”,只有两条路:执行后反射导出,或调用 PowerShell 的 Get-CommandGet-Help

  • 加载 PSM1 必须用 Import-Module -Name 'C:path oModule.psm1' -Force,不能用 Invoke-Expression,否则函数不会注册进 session
  • 加载后执行 Get-Command -Module 'ModuleName' 获取导出函数列表,模块名默认取文件名(不含扩展名),但可通过 ModuleToProcess 在 PSD1 中覆盖
  • 若 PSM1 依赖其他模块,C# 中必须先确保那些模块已导入,PowerShell 不会自动解析 #requires 并下载——那是 Install-Module 的事,C# 不管

跨版本兼容性陷阱:PowerShell Core(pwsh)和 windows PowerShell(powershell.exe)行为不同

Import-PowerShellDataFile 在 PowerShell 5.1 和 7+ 都存在,但 7+ 默认禁用 Invoke-Expression 类型的回退路径,且对 Unicode bom、注释位置更严格。Windows PowerShell 允许 PSD1 末尾多一个逗号,pwsh 会直接报错 Unexpected Token ',' in expression or statement

  • 生成 PSD1 时,务必用 Export-PowerShellDataFile(v5.1+)或手动拼接哈希表后调用 Out-File -Encoding UTF8NoBOM,避免记事本保存引入 BOM
  • C# 中判断当前环境:检查 Environment.GetEnvironmentVariable("PSModulePath") 是否含 powershell/7 路径,或运行 $PSVersionTable.PSVersion.Major 获取主版本号
  • 不要假设 PSModulePath 一定包含你的模块目录——C# 进程启动时 PowerShell 运行时可能还没初始化模块路径,需显式追加:$env:PSModulePath = 'C:mymodules;' + $env:PSModulePath

真正麻烦的从来不是怎么读,而是 PSD1 里那个看似无害的 @{ ScriptsToProcess = @('init.ps1') } ——它会让 Import-PowerShellDataFile 静默失败,除非你提前把 init.ps1 放到正确路径下。这种依赖链,C# 没法替你 resolve。

text=ZqhQzanResources