ฟังก์ชันส่งคืนค่าใน PowerShell

ฉันได้พัฒนาฟังก์ชัน PowerShell ที่ดำเนินการหลายอย่างที่เกี่ยวข้องกับการจัดเตรียมไซต์SharePoint Team ในที่สุดฉันต้องการฟังก์ชั่นเพื่อกลับ URL ของเว็บไซต์ที่จัดเตรียมเป็นสตริงดังนั้นในตอนท้ายของฟังก์ชั่นของฉันฉันมีรหัสต่อไปนี้:

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

รหัสที่เรียกใช้ฟังก์ชันนี้มีลักษณะดังนี้:

$returnURL = MyFunction -param 1 ...

ดังนั้นฉันคาดหวังสตริง แต่มันไม่ได้ แต่เป็นวัตถุประเภท System.Management.Automation.PSMethod แทน เหตุใดจึงส่งคืนชนิดนั้นแทนที่จะเป็นชนิดสตริง

PowerShell มีความหมายของการส่งคืนที่แปลกประหลาดอย่างน้อยเมื่อดูจากมุมมองการเขียนโปรแกรมแบบดั้งเดิมมากขึ้น มีสองแนวคิดหลักในการพันหัวของคุณ:

• เอาต์พุตทั้งหมดถูกดักจับและส่งคืน
• คำหลักที่ส่งคืนจริง ๆ เพียงระบุจุดทางออกตรรกะ

ดังนั้นบล็อกสคริปต์สองบล็อกต่อไปนี้จะทำสิ่งเดียวกันอย่างมีประสิทธิภาพ:

$a = "Hello, World"
return $a

$a = "Hello, World"
$a
return

ตัวแปร $ a ในตัวอย่างที่สองถูกปล่อยให้เป็นเอาต์พุตบนไพพ์ไลน์และดังที่กล่าวไว้เอาต์พุตทั้งหมดจะถูกส่งคืน ในความเป็นจริงในตัวอย่างที่สองคุณสามารถละเว้นการส่งคืนได้อย่างสมบูรณ์และคุณจะได้รับพฤติกรรมเดียวกัน

หากไม่มีนิยามฟังก์ชั่นของคุณมากขึ้นฉันไม่สามารถบอกได้ว่าทำไมคุณถึงได้รับวัตถุ PSMethod ฉันเดาว่าคุณอาจมีบางสิ่งบางอย่างที่ไม่ได้ถูกจับและวางลงบนท่อส่งออก

นอกจากนี้ยังเป็นที่น่าสังเกตว่าคุณอาจไม่ต้องการเครื่องหมายอัฒภาคเหล่านั้น - ยกเว้นว่าคุณกำลังซ้อนหลายนิพจน์ในบรรทัดเดียว

คุณสามารถอ่านเพิ่มเติมเกี่ยวกับ semantics ที่ส่งคืนได้ในหน้าabout_Returnบน TechNet หรือโดยเรียกใช้help returnคำสั่งจาก PowerShell

ส่วนหนึ่งของ PowerShell นี้อาจเป็นลักษณะที่โง่ที่สุด เอาต์พุตภายนอกใด ๆ ที่สร้างขึ้นระหว่างฟังก์ชั่นจะทำให้เกิดผลที่ไม่พึงประสงค์ บางครั้งไม่มีเอาต์พุตใด ๆ และภายใต้เงื่อนไขบางอย่างก็มีเอาต์พุตอื่นที่ไม่ได้วางแผนไว้นอกเหนือจากค่าส่งคืนที่คุณวางแผนไว้

ดังนั้นฉันจึงลบการมอบหมายจากการเรียกใช้ฟังก์ชั่นดั้งเดิมดังนั้นผลลัพธ์จะจบลงบนหน้าจอจากนั้นก้าวผ่านสิ่งที่ฉันไม่ได้วางแผนที่จะปรากฏขึ้นในหน้าต่างดีบักเกอร์ (ใช้PowerShell ISE )

แม้แต่สิ่งต่าง ๆ เช่นการจองตัวแปรในขอบเขตด้านนอกทำให้เกิดผลลัพธ์เช่น[boolean]$isEnabledที่จะแยกออกเป็นเท็จอย่างน่ารำคาญเว้นแต่คุณจะสร้างมัน[boolean]$isEnabled = $falseขึ้นมา

อีกสิ่งหนึ่งที่ดีคือ$someCollection.Add("thing")การแยกคอลเลกชันใหม่ออกมา

ด้วย PowerShell 5 ตอนนี้เรามีความสามารถในการสร้างคลาส เปลี่ยนฟังก์ชั่นของคุณลงในชั้นเรียนและผลตอบแทนจะเพียงกลับวัตถุทันทีก่อนหน้านั้น นี่คือตัวอย่างง่ายๆที่แท้จริง

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()วิธีการ