CHG: 確保 PowerShell Function 總是返回數組(即便對象是單一物件)

2024年5月15日星期三

這個問題是來自於 PowerShell 在經過函式的時候自動將單一一個的數組把數組拆掉變成一個物件的特性導致的。

要怎麼應付這個自動拆解有兩個方法

如果是在同一層級只要使用 @() 打包起來就好了，除了過函數會拆數組的特性之外還有一個是在任何時候總是會拆掉數組中的數組，就是不會讓你包兩層數組的意思，除非這兩層的Count都大於1，不然就會被拆掉只剩一層

利用這個特性就管他是不是數組，總之只要包起來就對了

$array = @((Get-Array))

不用寫判斷式也可以保證他是正確的，如果要寫判斷式的話會長這個樣子

$array = if ((Get-Array) -isnot [array]) { @((Get-Array)) }

函式返回就麻煩了一共套了兩層規則，一個是雙層數組拆解跟返回時拆解所以兩層都要解

對於返回值而言只能用逗號傳遞數組

function MyFunc() {
  return ,$array
}

這個第一次看應該覺得很問號，我給你講個猜想應該就可以馬上記住了。就把他當作加一個空物件組成 Count 大於二的數組 @($null, $array)，然後出去的時候那個空物件會被解掉。

雖然不確定實作是不是這樣做的，但總之就是對於函式返回值只有這樣才能解，你用第一種出去還是變成物件。

第二個問題是萬一你那個 $array 不是數組的話逗號的保護模被函式搓破了出去還是變成物件了，這個就把兩層保護組合起來就好了

function MyFunc() {
  return ,@((Get-Array))
}

這樣一來就可以不寫判斷式的保證返回值一定是個數組了

CHG