Nilai pengembalian fungsi di PowerShell

Saya telah mengembangkan fungsi PowerShell yang melakukan sejumlah tindakan yang melibatkan penyediaan situs Tim SharePoint . Pada akhirnya, saya ingin fungsi untuk mengembalikan URL situs yang disediakan sebagai String sehingga pada akhir fungsi saya, saya memiliki kode berikut:

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

Kode yang memanggil fungsi ini terlihat seperti:

$returnURL = MyFunction -param 1 ...

Jadi saya mengharapkan String, namun tidak. Sebaliknya, ini adalah objek bertipe System.Management.Automation.PSMethod. Mengapa mengembalikan tipe itu dan bukan tipe String?

PowerShell benar-benar mengembalikan semantik - setidaknya jika dilihat dari perspektif pemrograman yang lebih tradisional. Ada dua ide utama untuk membungkus kepala Anda:

• Semua output ditangkap, dan dikembalikan
• Kata kunci kembali benar-benar hanya menunjukkan titik keluar yang logis

Dengan demikian, dua blok skrip berikut akan melakukan hal yang sama persis secara efektif:

$a = "Hello, World"
return $a

$a = "Hello, World"
$a
return

Variabel $ a dalam contoh kedua dibiarkan sebagai output pada pipeline dan, sebagaimana disebutkan, semua output dikembalikan. Bahkan, dalam contoh kedua Anda bisa menghilangkan pengembalian sepenuhnya dan Anda akan mendapatkan perilaku yang sama (pengembalian akan tersirat sebagai fungsi secara alami melengkapi dan keluar).

Tanpa lebih banyak definisi fungsi Anda, saya tidak bisa mengatakan mengapa Anda mendapatkan objek PSMethod. Dugaan saya adalah bahwa Anda mungkin memiliki sesuatu beberapa baris di atas yang tidak ditangkap dan ditempatkan pada pipa keluaran.

Perlu juga dicatat bahwa Anda mungkin tidak membutuhkan titik koma itu - kecuali jika Anda bersarang banyak ekspresi pada satu baris.

Anda dapat membaca lebih lanjut tentang semantik kembali di halaman about_Return di TechNet, atau dengan menjalankan help returnperintah dari PowerShell itu sendiri.

Bagian dari PowerShell ini mungkin merupakan aspek yang paling bodoh. Output luar yang dihasilkan selama suatu fungsi akan mencemari hasilnya. Terkadang tidak ada output, dan kemudian dalam beberapa kondisi ada beberapa output yang tidak terencana, selain nilai pengembalian yang Anda rencanakan.

Jadi, saya menghapus tugas dari panggilan fungsi asli, sehingga output berakhir di layar, dan kemudian melangkah sampai sesuatu yang saya tidak rencanakan untuk muncul di jendela debugger (menggunakan PowerShell ISE ).

Bahkan hal-hal seperti pemesanan variabel dalam lingkup luar menyebabkan output, seperti [boolean]$isEnabledyang akan memuntahkan False keluar kecuali Anda membuatnya [boolean]$isEnabled = $false.

Satu lagi yang bagus adalah $someCollection.Add("thing")yang mengeluarkan jumlah koleksi baru.

Dengan PowerShell 5 kami sekarang memiliki kemampuan untuk membuat kelas. Ubah fungsi Anda menjadi kelas, dan kembali hanya akan mengembalikan objek segera sebelum itu. Ini adalah contoh sederhana yang nyata.

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

Jika ini adalah fungsi, output yang diharapkan adalah

Hello World
808979

tetapi sebagai kelas satu-satunya hal yang dikembalikan adalah bilangan bulat 808979. Kelas semacam jaminan bahwa itu hanya akan mengembalikan tipe yang dinyatakan atau tidak berlaku.

Sebagai solusinya saya telah mengembalikan objek terakhir dalam array yang Anda dapatkan kembali dari fungsi ... Ini bukan solusi yang bagus, tetapi lebih baik daripada tidak sama sekali:

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

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

Secara keseluruhan, cara menulis yang sama secara garis lurus adalah:

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

Saya melewati objek Hashtable sederhana dengan anggota hasil tunggal untuk menghindari kegilaan kembali karena saya juga ingin menampilkan ke konsol. Bertindak melalui referensi dengan referensi.

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

Anda dapat melihat contoh penggunaan nyata di proyek GitHub saya unpackTunes .

Sulit untuk mengatakan tanpa melihat kode. Pastikan fungsi Anda tidak mengembalikan lebih dari satu objek dan Anda menangkap setiap hasil yang dibuat dari panggilan lain. Apa yang Anda dapatkan untuk:

@($returnURL).count

Pokoknya, dua saran:

Keluarkan objek ke string:

...
return [string]$rs

Atau cukup lampirkan dalam tanda kutip ganda, sama seperti di atas tetapi lebih pendek untuk mengetik:

...
return "$rs"

Deskripsi fungsi hasil Luke skenario ini tampaknya benar. Saya hanya ingin memahami akar permasalahan dan tim produk PowerShell akan melakukan sesuatu tentang perilaku tersebut. Tampaknya cukup umum dan telah menghabiskan banyak waktu debugging.

Untuk mengatasi masalah ini saya telah menggunakan variabel global daripada mengembalikan dan menggunakan nilai dari pemanggilan fungsi.

Inilah pertanyaan lain tentang penggunaan variabel global: Mengatur variabel PowerShell global dari fungsi di mana nama variabel global adalah variabel yang diteruskan ke fungsi

Berikut ini hanya mengembalikan 4 sebagai jawaban. Ketika Anda mengganti ekspresi tambah untuk string itu mengembalikan string pertama.

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

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

StartingEnd(StartingMain)

Ini juga bisa dilakukan untuk array. Contoh di bawah ini akan mengembalikan "Teks 2"

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

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

StartingEnd(StartingMain)

Perhatikan bahwa Anda harus memanggil fungsi di bawah fungsi itu sendiri. Kalau tidak, saat pertama kali dijalankan, ia akan mengembalikan kesalahan yang tidak tahu apa itu "StartingMain".

Jawaban yang ada sudah benar, tetapi kadang-kadang Anda tidak benar-benar mengembalikan sesuatu secara eksplisit dengan a Write-Outputatau a return, namun ada beberapa nilai misteri dalam hasil fungsi. Ini bisa menjadi output dari fungsi builtin likeNew-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

Semua kebisingan tambahan dari pembuatan direktori sedang dikumpulkan dan dipancarkan dalam output. Cara mudah untuk mengurangi ini adalah dengan menambahkan | Out-Nullke akhir New-Itempernyataan, atau Anda dapat menetapkan hasilnya ke variabel dan tidak menggunakan variabel itu. Akan terlihat seperti ini ...

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-Itemmungkin yang lebih terkenal dari ini, tetapi yang lain termasuk semua StringBuilder.Append*()metode, serta SqlDataAdapter.Fill()metode.