迈向专业级PowerShell脚本编写

### 迈向专业级PowerShell脚本编写 在PowerShell脚本编写的世界里，从新手到专业人士的转变并非一蹴而就。这不仅需要掌握基本的语法和命令，更要养成专业的编程习惯和思维方式。本文将为你介绍一系列专业级PowerShell脚本编写的最佳实践，帮助你提升脚本的质量和可维护性。 #### 1. 脚本思维转变 在脚本编写中，我们可以采用一些技巧来优化代码。例如，我们改用ForEach脚本结构，因为它运行速度稍快，且更易阅读。手动构建对象而非使用Select - Object，这样代码的可读性更强。同时，添加DomainController属性和ComputerName属性，其中ComputerName属性在管道中与 - ComputerName参数配合得更好。最重要的是，将代码封装在函数中，这样便于将输出通过管道传递给Export - CSV、ConvertTo - HTML等命令。 不过，当前的解决方案并不完美，它同时承担了从AD获取计算机账户和获取磁盘信息两项任务。在实际生产环境中，我们可以编写一个专门的工具来获取域计算机账户，然后修改函数使其仅处理磁盘信息。如果合理规划属性和参数，我们可以像这样使用假设的命令： ```powershell Get-CompanyServers | Get-DiskInfo Get-CompanyServers | Get-DiskInfo | Convertto-html -title "DiskInfo Report" ``` #### 2. 专业级脚本编写的准则 ##### 2.1 使用源代码控制 专业的PowerShell脚本编写者非常重视代码的长期维护性，而源代码控制在实现这一目标中起着关键作用。虽然有些人可能认为使用源代码控制就像报税一样麻烦，但现代工具已经大大简化了其使用过程。它可以无缝集成到Visual Studio Code（VS Code）等平台，操作起来就像保存文件并通过简单的按键提交更改一样容易。 使用源代码控制有诸多好处： - **团队协作**：在团队环境中，它可以跟踪谁进行了更改，防止意外覆盖，避免冲突。 - **版本历史**：可以回顾代码的先前版本，以便纠正错误或参考过去的实现方法。 - **备份和恢复**：源代码控制仓库通常是组织备份策略的一部分，确保代码库的安全。 - **代码共享**：方便与他人共享代码，同时控制贡献，这对基于社区的项目至关重要。 - **问题管理**：像Team Foundation Server（TFS）、Azure DevOps和GitHub等领先系统提供了跟踪和讨论问题以及发布更新的工具。 使用源代码控制能提升你在IT经理和同事眼中的专业形象。 ##### 2.2 代码清晰性 在控制台中，使用快捷方式可以节省时间，但在脚本中，可读性至关重要。应避免使用别名和缩写的参数名。例如，PowerShell发明者Jeffrey Snover在演示时可能会使用像`icm { ps } –com cl2`这样的命令，看起来很厉害但也很神秘，需要有人在旁边解释。在脚本中，应完整拼写命令和参数名，并利用Tab补全功能。这样不仅能提高脚本的可读性，还能减少拼写错误。 如果只是在控制台中为自己临时使用，使用快捷方式没问题。但脚本是要与他人共享并提交到源代码控制中的，需要更易于阅读。完整拼写每个命令名和参数名，并使用参数名而非依赖位置值。这样，几个月后，当你自己再看这个脚本时，会感谢当初自己的细心。而且，在PowerShell中，Tab补全功能可以轻松实现完整拼写，还能减少错误，可谓一举两得。 如果你使用VS Code，PowerShell扩展依赖的PowerShell Script Analyzer（PSScriptAnalyzer）工具会对使用别名的情况给出提示。所以，从一开始就正确编写代码很重要。 ##### 2.3 有效注释 注释对于代码的清晰性很重要，但不要过度注释。对于脚本中的复杂部分，应提供高层次的解释。内联注释不应只是重复显而易见的内容，而应使用详细的语句或内联注释来引导读者理解代码逻辑。 例如，下面的代码展示了如何使用注释来描述代码的意图： ```powershell # see if –NewUser was specified and modify arguments # We use StartPassword either way If ($PSBoundParameters.ContainsKey('NewUser')) { $args = @{'StartName'=$NewUser 'StartPassword'=$NewPassword} } Else { $args = @{'StartPassword'=$NewPassword} Write-Warning "Not setting a new user name" } ``` 这里的注释提供了对代码执行情况和原因的高层次描述。另外，使用详细语句（如`Write-Verbose`）代替一些内联注释也是可以的，例如： ```powershell Write-Verbose "Closing connection to $computer" $session | Remove-CimSession ``` `Remove - CimSession`命令本身已经很明确，所以不需要内联注释，但`Write - Verbose`语句有助于记录脚本的执行过程，对使用脚本的人和阅读脚本的人都有帮助。 ##### 2.4 代码格式化 代码的格式非常重要，混乱的代码是不可接受的。例如下面未格式化的代码就很难阅读： ```powershell function Set-TMServiceLogon { [CmdletBinding()] Param( [Parameter(Mandatory=$True,ValueFromPipelineByPropertyName=$True)] [string]ServiceName[Parameter(Mandatory=$True,ValueFromPipeline=$True, ValueFromPipelineByPropertyName=$True)][string[]]$ComputerName, [Parameter(ValueFromPipelineByPropertyName=$True)] [string]$NewPassword,[Parameter(ValueFromPipelineByPropertyName=$True)] [string]$NewUser, [string]$ErrorLogFilePath ) BEGIN{} PROCESS{ ForEach ($computer in $ComputerName) { Do { Write-Verbose "Connect to $computer on WS-MAN" $protocol = "Wsman" Try { $option = New-CimSessionOption -Protocol $protocol $session = New-CimSession -SessionOption $option – ComputerName $Computer -ErrorAction Stop If ($PSBoundParameters.ContainsKey('NewUser')) { $args = @{'StartName'=$NewUser 'StartPassword'=$NewPassword} } Else { $args = @{'StartPassword'=$NewPassword} Write-Warning "Not setting a new user name" } Write-Verbose "Setting $servicename on $computer" $params = @{'CimSession'=$session 'MethodName'='Change' 'Query ```