命令行与文本处理 / 系统课时
创建自定义对象
创建自定义对象
本课解决脚本中数据字段零散、输出结构不稳定的问题。完成后,你能用 PSCustomObject 把原始值组织成清晰的业务对象,并继续进行筛选、排序、导出和 JSON 序列化。
学习目标
- 使用
[pscustomobject]定义字段明确的对象 - 控制属性顺序、数据类型和计算字段
- 将对象送入管道并序列化为稳定的 JSON 结构
为什么使用 PSCustomObject
哈希表适合按键取值,但直接输出时更像配置容器;PSCustomObject 则拥有正式属性,可被 Select-Object、Where-Object、Sort-Object、Export-Csv 和 ConvertTo-Json 自然处理。
创建对象时应让每个属性承担明确职责,并尽早确定金额、日期、布尔值等数据类型。不要把所有值都保存成字符串,否则后续排序、求和和日期比较会得到错误结果。
构造并转换业务对象
下面把订单原始数据构造成自定义对象,再筛选已支付订单,生成适合接口传输的稳定结构。
$orders = @(
[pscustomobject][ordered]@{
OrderId = "A1001"
Customer = "Alice"
Amount = [decimal]128.50
CreatedAt = [datetimeoffset]"2026-08-04T09:30:00+08:00"
Status = "Paid"
}
[pscustomobject][ordered]@{
OrderId = "A1002"
Customer = "Bob"
Amount = [decimal]76.00
CreatedAt = [datetimeoffset]"2026-08-04T10:15:00+08:00"
Status = "Pending"
}
[pscustomobject][ordered]@{
OrderId = "A1003"
Customer = "Carol"
Amount = [decimal]42.30
CreatedAt = [datetimeoffset]"2026-08-04T11:00:00+08:00"
Status = "Paid"
}
)
# 输出对象只保留接口需要的字段,并在边界处完成格式转换。
$payload = @(
$orders |
Where-Object Status -eq "Paid" |
ForEach-Object {
[pscustomobject][ordered]@{
OrderId = $_.OrderId
Amount = [math]::Round($_.Amount, 2)
CreatedAt = $_.CreatedAt.ToString("yyyy-MM-dd HH:mm:ss zzz")
}
}
)
$payload | ConvertTo-Json -Depth 3预期输出
[
{
"OrderId": "A1001",
"Amount": 128.5,
"CreatedAt": "2026-08-04 09:30:00 +08:00"
},
{
"OrderId": "A1003",
"Amount": 42.3,
"CreatedAt": "2026-08-04 11:00:00 +08:00"
}
][ordered] 让属性按声明顺序显示和序列化,便于人工核对,但业务逻辑不应依赖属性顺序。对象中的 Amount 仍是数值,JSON 序列化时可能省略末尾零;只有 CreatedAt 在接口边界被转换为约定格式的字符串。
管道、导出与字段稳定性
自定义对象进入管道后,可以继续使用标准命令处理。导出 CSV 时,应先通过 Select-Object 明确字段;调用接口前,应通过 ConvertTo-Json 检查最终结构,并为嵌套对象设置足够的 -Depth。
不要在不同分支中随意增减属性。若同一批对象有的包含 ErrorMessage、有的没有,导出和消费端会变得难以预测。更稳妥的做法是统一声明该属性,正常记录使用 $null。
需要后续补充属性时可以使用 Add-Member,但批量创建对象时通常直接在 [pscustomobject]@{} 中一次性声明更清晰,也更容易代码审查。
常见错误
把 Format-Table 或 Format-List 的结果保存到变量,会得到格式化指令对象,而不是原始业务对象。格式化命令只应出现在终端展示的最后一步,导出、过滤和序列化必须在格式化之前完成。
另一个常见问题是复用同一个可变哈希表并不断修改后输出。应在每次循环中创建新的 PSCustomObject,避免多条结果意外引用相同状态。