命令行与文本处理 / 系统课时

组织脚本文件

组织脚本文件

本课把一个可运行的 .ps1 脚本整理成参数区、初始化区、处理区和清理区,并使用 $PSScriptRoot 建立不受当前工作目录影响的路径。完成后,你可以直接套用这套结构编写更稳定、易维护的自动化脚本。

学习目标

  • 按职责划分脚本的四个主要区域
  • 正确使用 $PSScriptRoot 构造脚本相对路径
  • 通过 try、finally 保证清理逻辑执行

脚本结构为什么要固定

小脚本把变量、文件操作和输出混在一起通常也能运行,但功能增加后,很难判断参数在哪里定义、初始化是否完成、异常后是否清理。稳定的脚本结构应让读者从上到下看到“接收输入、准备环境、执行任务、收尾退出”的明确顺序。

参数区必须位于脚本前部,param() 之前只能出现注释、空行或属性。初始化区负责严格模式、错误策略、路径解析和依赖检查。处理区只实现核心业务,清理区则释放临时资源或恢复环境。

建立稳定的脚本根目录

$PSScriptRoot 表示当前脚本文件所在目录,而 Get-Location 表示调用者当前所在目录。脚本需要读取同目录配置、写入固定子目录或加载其他脚本时,应以 $PSScriptRoot 为起点,否则从其他目录调用时可能找不到文件。

下面的脚本读取输入文本,将副本写入脚本目录下的 output 子目录。初始化失败或处理失败时,$ErrorActionPreference = 'Stop' 会把可终止错误交给异常流程。

powershell
[CmdletBinding()]
param(
    [Parameter(Mandatory)]
    [string]$InputPath,

    [string]$OutputDirectory = (Join-Path $PSScriptRoot 'output')
)

# 初始化区:尽早启用严格检查并统一错误行为
Set-StrictMode -Version Latest
$ErrorActionPreference = 'Stop'

$inputFullPath = (Resolve-Path -LiteralPath $InputPath).Path

if (-not (Test-Path -LiteralPath $OutputDirectory)) {
    New-Item -ItemType Directory -Path $OutputDirectory -Force | Out-Null
}

try {
    # 处理区:只保留当前脚本真正要完成的业务
    $baseName = [System.IO.Path]::GetFileNameWithoutExtension($inputFullPath)
    $targetPath = Join-Path $OutputDirectory "$baseName.copy.txt"

    Get-Content -LiteralPath $inputFullPath |
        Set-Content -LiteralPath $targetPath -Encoding utf8

    Write-Output "已生成: $targetPath"
}
finally {
    # 清理区:即使处理区抛出异常也会执行
    Remove-Variable inputFullPath, baseName, targetPath -ErrorAction SilentlyContinue
}

将脚本保存为 Organize-File.ps1,再在脚本所在目录中执行:

powershell
@'
alpha
beta
'@ | Set-Content -LiteralPath .\sample.txt -Encoding utf8

.\Organize-File.ps1 -InputPath .\sample.txt
Get-Content -LiteralPath .\output\sample.copy.txt

预期输出:

text
已生成: <PATH>\output\sample.copy.txt
alpha
beta

<PATH> 会随脚本实际保存位置变化。即使先切换到其他目录再调用脚本,默认输出目录仍然以 Organize-File.ps1 所在目录为准。

初始化与清理的边界

初始化区只放核心处理开始前必须成功的操作,例如解析参数、检查文件和创建客户端。临时文件、网络连接、会话或环境变量一旦创建,就应考虑在 finally 中释放或恢复。

不要在清理区隐藏原始错误。清理命令通常应使用 -ErrorAction SilentlyContinue 或单独捕获异常,避免清理失败覆盖真正的业务故障。脚本没有需要释放的资源时,可以省略 finally,不必为形式强行添加空清理区。

组织较大脚本

当单个处理区持续增长时,先把独立逻辑提取为函数,再考虑拆成模块。主脚本应保留参数绑定、流程编排和最终输出,而不是堆积所有实现细节。这样既便于单独测试函数,也能让入口文件保持清晰。

路径变量建议统一在初始化区转换为绝对路径;写文件时使用 -LiteralPath,避免路径中的方括号被当作通配符。涉及覆盖、删除或批量移动时,应增加存在性检查、备份或 -WhatIf 支持,降低误操作风险。

按自己的节奏,确认真正理解。

目录与阅读设置

阅读设置

17

记录一个想法

组织脚本文件

0 / 10000 · 笔记保存到账号。未提交的修改会在关闭、离开或刷新后丢失。

登录哪都通