Повернення значення функції в PowerShell

Я розробив функцію PowerShell, яка виконує ряд дій, пов’язаних із забезпеченням сайтів SharePoint Team. Зрештою, я хочу, щоб функція повертала URL-адресу наданого веб-сайту як String, тому наприкінці своєї функції я маю такий код:

$rs = $url.ToString();
return $rs;

Код, який викликає цю функцію, виглядає так:

$returnURL = MyFunction -param 1 ...

Тож я очікую струну, однак це не так. Натомість це об’єкт типу System.Management.Automation.PSMethod. Чому він повертає цей тип замість типу String?

PowerShell має насправді дурну семантику повернення - принаймні, якщо дивитися з традиційної перспективи програмування. Є дві основні ідеї, щоб обернути голову:

• Весь вихідний сигнал збирається та повертається
• Ключове слово повернення дійсно просто вказує на логічну точку виходу

Таким чином, наступні два блоки сценаріїв будуть ефективно робити те саме:

$a = "Hello, World"
return $a

$a = "Hello, World"
$a
return

Змінна $ a у другому прикладі залишається як вихід на конвеєр, і, як було сказано, весь вихід повертається. Насправді, у другому прикладі ви могли повністю опустити повернення, і ви отримали б таку саму поведінку (повернення мається на увазі, оскільки функція, природно, завершується і залишається).

Без більшого визначення вашої функції я не можу сказати, чому ви отримуєте об'єкт PSMethod. Я здогадуюсь, що у вас, мабуть, є щось на кілька ліній вгору, що не захоплюється і розміщується на вихідному конвеєрі.

Варто також зазначити, що вам, мабуть , не потрібні такі крапки з комою, якщо ви не вкладаєте кілька виразів у одному рядку.

Докладніше про семантику повернення можна прочитати на сторінці about_Return в TechNet або за допомогою виклику help returnкоманди від самого PowerShell.

Ця частина PowerShell - це, мабуть, найглупіший аспект. Будь-який сторонній вихід, отриманий під час функції, забруднює результат. Іноді немає жодного результату, а за певних умов, крім запланованого значення повернення, є ще якийсь позаплановий вихід.

Отже, я видаляю призначення з початкового виклику функції, тож результат закінчується на екрані, а потім переходжу до тих пір, поки щось не планувалося вискочити у вікні налагодження (використовуючи PowerShell ISE ).

Навіть такі речі, як резервування змінних у зовнішніх областях, спричиняють вихід, наприклад, [boolean]$isEnabledякий буде дратує виплюнути помилковий, якщо ви не зробите це [boolean]$isEnabled = $false.

Ще одним хорошим є те, $someCollection.Add("thing")що випльовує нову кількість колекцій.

Завдяки PowerShell 5 ми маємо можливість створювати класи. Змініть свою функцію на клас, а return поверне лише об’єкт безпосередньо перед ним. Ось справжній простий приклад.

class test_class {
    [int]return_what() {
        Write-Output "Hello, World!"
        return 808979
    }
}
$tc = New-Object -TypeName test_class
$tc.return_what()

Якби це функція, очікуваний результат був би

Hello World
808979

але як клас єдине повернене - це ціле число 808979. Клас є на зразок гарантії, що він поверне лише тип, оголошений або недійсний.

Як вирішення, я повертав останній об’єкт у масиві, який ви повертаєтесь із функції ... Це не чудове рішення, але краще, ніж нічого:

someFunction {
   $a = "hello"
   "Function is running"
   return $a
}

$b = someFunction
$b = $b[($b.count - 1)]  # Or
$b = $b[-1]              # Simpler

Загалом, більш однолінійним способом написання тієї ж речі може бути:

$b = (someFunction $someParameter $andAnotherOne)[-1]

Я обходжу простий об'єкт Hashtable з одним членом результату, щоб уникнути божевільності повернення, оскільки я також хочу вивести на консоль. Він діє через пропуск шляхом посилання.

function sample-loop($returnObj) {
  for($i = 0; $i -lt 10; $i++) {
    Write-Host "loop counter: $i"
    $returnObj.result++
  }
}

function main-sample() {
  $countObj = @{ result = 0 }
  sample-loop -returnObj $countObj
  Write-Host "_____________"
  Write-Host "Total = " ($countObj.result)
}

main-sample

Ви можете побачити реальний приклад використання в моєму проекті GitHub unpackTunes .

Важко сказати, не дивлячись на код. Переконайтеся, що ваша функція не повертає більше ніж один об'єкт, і ви отримуєте результати, отримані в результаті інших дзвінків. Що ви отримуєте:

@($returnURL).count

У будь-якому випадку, дві пропозиції:

Перекиньте об'єкт на рядок:

...
return [string]$rs

Або просто додайте їх у подвійні лапки, такі ж, як вище, але коротші для введення:

...
return "$rs"

Опис Лука результатів функції в цих сценаріях, здається, правильно. Я хочу лише зрозуміти першопричину, і команда продуктів PowerShell зробить щось стосовно поведінки. Це здається досить поширеним і коштувало мені занадто багато часу на налагодження.

Щоб обійти цю проблему, я використовував глобальні змінні, а не повернення та використання значення з виклику функції.

Ось ще одне питання щодо використання глобальних змінних: Встановлення глобальної змінної PowerShell з функції, де ім'я глобальної змінної є змінною, переданою функції

Далі просто повертає 4 як відповідь. При заміні виразів додавання для рядків він повертає перший рядок.

Function StartingMain {
  $a = 1 + 3
  $b = 2 + 5
  $c = 3 + 7
  Return $a
}

Function StartingEnd($b) {
  Write-Host $b
}

StartingEnd(StartingMain)

Це також можна зробити для масиву. Приклад нижче поверне "Текст 2"

Function StartingMain {
  $a = ,@("Text 1","Text 2","Text 3")
  Return $a
}

Function StartingEnd($b) {
  Write-Host $b[1]
}

StartingEnd(StartingMain)

Зауважте, що ви повинні викликати функцію нижче самої функції. Інакше при першому запуску він поверне помилку, що не знає, що таке "StartingMain".

Існуючі відповіді вірні, але іноді ви насправді не повертаєте щось явно з a Write-Outputабо a return, але в результатах функції є якесь загадкове значення. Це може бути результатом такої вбудованої функціїNew-Item

PS C:\temp> function ContrivedFolderMakerFunction {
>>    $folderName = [DateTime]::Now.ToFileTime()
>>    $folderPath = Join-Path -Path . -ChildPath $folderName
>>    New-Item -Path $folderPath -ItemType Directory
>>    return $true
>> }
PS C:\temp> $result = ContrivedFolderMakerFunction
PS C:\temp> $result


    Directory: C:\temp


Mode                LastWriteTime         Length Name
----                -------------         ------ ----
d-----         2/9/2020   4:32 PM                132257575335253136
True

Весь цей додатковий шум від створення каталогу збирається та випромінюється у висновку. Найпростіший спосіб пом'якшити це - додати | Out-Nullдо кінця New-Itemвисловлювання, або ви можете призначити результат змінній і просто не використовувати цю змінну. Це виглядатиме так ...

PS C:\temp> function ContrivedFolderMakerFunction {
>>    $folderName = [DateTime]::Now.ToFileTime()
>>    $folderPath = Join-Path -Path . -ChildPath $folderName
>>    New-Item -Path $folderPath -ItemType Directory | Out-Null
>>    # -or-
>>    $throwaway = New-Item -Path $folderPath -ItemType Directory 
>>    return $true
>> }
PS C:\temp> $result = ContrivedFolderMakerFunction
PS C:\temp> $result
True

New-ItemМабуть, більш відомий з них, але інші включають усі StringBuilder.Append*()методи, а також SqlDataAdapter.Fill()метод.