PowerShell'de işlev dönüş değeri

SharePoint Team sitelerinin sağlanmasını içeren bir dizi eylem gerçekleştiren bir PowerShell işlevi geliştirdim . Sonuçta, fonksiyonumun sonunda aşağıdaki kod var böylece fonksiyonun sağlanan sitenin URL'sini bir String olarak döndürmek istiyorum:

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

Bu işlevi çağıran kod şöyle görünür:

$returnURL = MyFunction -param 1 ...

Bu yüzden bir String bekliyorum, ancak değil. Bunun yerine, System.Management.Automation.PSMethod türünde bir nesnedir. Neden bir String türü yerine bu türü döndürüyor?

PowerShell, en azından daha geleneksel bir programlama perspektifinden bakıldığında gerçekten tuhaf dönüş semantiğine sahiptir. Kafanı sarmak için iki ana fikir var:

• Tüm çıktılar yakalanır ve döndürülür
• Dönüş anahtar kelimesi gerçekten mantıklı bir çıkış noktasını gösterir

Bu nedenle, aşağıdaki iki komut dosyası bloğu aynı şeyi etkili bir şekilde yapacaktır:

$a = "Hello, World"
return $a

$a = "Hello, World"
$a
return

İkinci örnekteki $ a değişkeni, boru hattında çıktı olarak bırakılır ve belirtildiği gibi, tüm çıktı döndürülür. Aslında, ikinci örnekte, dönüşü tamamen atlayabilirsiniz ve aynı davranışı elde edersiniz (işlev, doğal olarak tamamlandığında ve çıktıkça dönüş ima edilir).

Daha fazla işlev tanımınız olmadan neden bir PSMethod nesnesi elde ettiğinizi söyleyemem. Tahminimce, muhtemelen yakalanmayan ve çıkış hattına yerleştirilen birkaç satırlık bir şey var.

Tek bir satıra birden fazla ifade yerleştirmediğiniz sürece, muhtemelen bu noktalı virgüllere ihtiyacınız olmadığını da belirtmek gerekir.

Dönüş semantiği hakkında TechNet'teki about_Return sayfasında veya help returnkomutu PowerShell'in kendisinden çağırarak daha fazla bilgi edinebilirsiniz .

PowerShell'in bu kısmı muhtemelen en aptal yönüdür. Bir işlev sırasında üretilen herhangi bir yabancı çıktı sonucu kirletir. Bazen herhangi bir çıktı olmaz ve daha sonra bazı koşullar altında planlanan dönüş değerinize ek olarak planlanmamış başka bir çıktı da olur.

Bu nedenle, atamayı orijinal işlev çağrısından kaldırırım, böylece çıktı ekranda sona erer ve sonra hata ayıklayıcı penceresinde ( PowerShell ISE kullanarak ) açmayı planladığım bir şey çıkıncaya kadar adım adım ilerlerim .

Değişkenleri dış kapsamlarda ayırmak gibi şeyler bile çıktıya neden olur, [boolean]$isEnabledki bunu yapmazsanız rahatsız edici bir şekilde yanlış çıkarır [boolean]$isEnabled = $false.

Bir başka iyi $someCollection.Add("thing")olan, yeni koleksiyon sayısını tükürüyor.

PowerShell 5 ile artık sınıflar oluşturabiliyoruz. İşlevinizi bir sınıfa dönüştürün ve dönüş yalnızca nesnenin hemen önündeki nesneyi döndürecektir. İşte gerçekten basit bir örnek.

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

Bu bir işlev olsaydı, beklenen çıktı

Hello World
808979

ancak bir sınıf olarak döndürülen tek şey 808979 tamsayısıdır.

Çözüm olarak dizideki son nesneyi işleve geri döndürüyorum ... Harika bir çözüm değil, ama hiç yoktan iyidir:

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

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

Sonuçta, aynı şeyi yazmanın daha tek satırlık bir yolu olabilir:

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

Konsola çıkış yapmak istediğim için dönüş çılgınlığını önlemek için tek bir sonuç üyesi ile basit bir Hashtable nesnesinin etrafından geçiyorum. Referans yoluyla paso yoluyla hareket eder.

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

Gerçek örnek kullanımını GitHub projem unpackTunes'da görebilirsiniz .

Koda bakmadan söylemek zor. İşlevinizin birden fazla nesne döndürmediğinden ve diğer aramalardan alınan sonuçları yakaladığınızdan emin olun. Ne için alırsınız:

@($returnURL).count

Her neyse, iki öneri:

Nesneyi dizeye yayınlayın:

...
return [string]$rs

Ya da sadece yukarıdakiyle aynı, ancak yazmak için daha kısa olan çift tırnak içine alın:

...
return "$rs"

Luke'un bu senaryolarda fonksiyon sonuçlarıyla ilgili açıklaması doğru görünüyor. Sadece temel nedeni anlamak istiyorum ve PowerShell ürün ekibi davranış hakkında bir şeyler yapar. Oldukça yaygın görünüyor ve hata ayıklama zamanı bana çok pahalıya mal oldu.

Bu soruna geçici bir çözüm bulmak için, işlev çağrısındaki değeri döndürmek ve kullanmak yerine genel değişkenler kullanıyorum.

Genel değişkenlerin kullanımına ilişkin başka bir soru: Genel değişken adının işleve geçirilen bir değişken olduğu bir işlevden genel bir PowerShell değişkeni ayarlama

Aşağıdaki cevap olarak 4'ü döndürür. Dizeler için deyim ekleme ifadesini değiştirdiğinizde, ilk dizeyi döndürür.

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

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

StartingEnd(StartingMain)

Bu, bir dizi için de yapılabilir. Aşağıdaki örnekte "Metin 2" döndürülecektir

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

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

StartingEnd(StartingMain)

İşlevin altındaki işlevi çağırmanız gerektiğini unutmayın. Aksi takdirde, ilk çalıştırıldığında "StartingMain" in ne olduğunu bilmediği bir hata döndürür.

Mevcut cevaplar doğrudur, ancak bazen aslında a Write-Outputveya a ile açıkça bir şey döndürmüyorsunuz return, ancak işlev sonuçlarında bazı gizemli değerler vardır. Bu gibi yerleşik bir fonksiyonun çıktısı olabilirNew-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

Dizin oluşturma işleminin tüm bu ekstra gürültüsü çıktıda toplanıyor ve yayılıyor. Bunu hafifletmenin kolay yolu | Out-Null, New-Itemifadenin sonuna eklemektir veya sonucu bir değişkene atayabilir ve yalnızca bu değişkeni kullanamazsınız. Şöyle görünecektir ...

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-ItemMuhtemelen bunlardan daha meşhurdur, ancak diğerleri tüm StringBuilder.Append*()yöntemleri ve SqlDataAdapter.Fill()yöntemi içerir.