การใช้คำต่อท้าย "Async" ในชื่อเมธอดนั้นขึ้นอยู่กับว่าใช้ตัวแก้ไข "async" หรือไม่

หลักการสำหรับการต่อท้ายชื่อเมธอดด้วย "Async" คืออะไร?

คำต่อท้าย "Async" ควรต่อท้ายเฉพาะเมธอดที่ประกาศด้วยasyncตัวปรับแต่งหรือไม่

public async Task<bool> ConnectAsync()

หรือเพียงพอที่วิธีการคืนค่าTask<T>หรือTask?

public Task<bool> ConnectAsync()

ฉันคิดว่าความจริงคลุมเครือแม้จากเอกสารของ Microsoft:

ใน Visual Studio 2012 และ. NET Framework 4.5 วิธีการใด ๆ ที่ประกอบด้วยasyncคีย์เวิร์ด ( Asyncใน Visual Basic) ถือเป็นวิธีการแบบอะซิงโครนัสและคอมไพเลอร์ C # และ Visual Basic จะทำการแปลงที่จำเป็นเพื่อใช้วิธีการแบบอะซิงโครนัสโดยใช้ TAP วิธีการอะซิงโครนัสควรส่งคืนวัตถุTaskหรือTask<TResult>วัตถุ

http://msdn.microsoft.com/en-us/library/hh873177(v=vs.110).aspx

ไม่ถูกต้องอยู่แล้ว วิธีการใด ๆ ที่มีasyncเป็นแบบอะซิงโครนัสจากนั้นจึงบอกว่าควรส่งคืน a TaskหรือTask<T>- ซึ่งไม่ถูกต้องสำหรับวิธีการที่ด้านบนของ call stack, Button_Click เป็นต้นหรือasync void.

แน่นอนคุณต้องพิจารณาว่าอะไรคือจุดสำคัญของการประชุมใหญ่?

คุณสามารถพูดได้ว่าหลักการAsyncต่อท้ายคือการสื่อสารกับผู้ใช้ API ว่าวิธีนี้รออยู่ สำหรับวิธีการที่จะ awaitable ก็ต้องกลับTaskสำหรับเป็นโมฆะหรือTask<T>หาวิธีการที่คุ้มค่ากลับมาซึ่งหมายความว่าเพียงหลังสามารถ suffixed Asyncกับ

หรือคุณอาจพูดได้ว่าหลักการAsyncต่อท้ายคือการสื่อสารว่าเมธอดสามารถคืนค่าได้ทันทีโดยปล่อยเธรดปัจจุบันเพื่อทำงานอื่นและอาจทำให้เกิดการแข่งขัน

คำพูดของ Microsoft doc นี้กล่าวว่า:

ตามแบบแผนคุณต้องต่อท้าย "Async" ต่อท้ายชื่อของวิธีการที่มีตัวปรับเปลี่ยน Async หรือ async

http://msdn.microsoft.com/en-us/library/hh191443.aspx#BKMK_NamingConvention

ซึ่งไม่ได้พูดถึงว่าวิธีการแบบอะซิงโครนัสของคุณกลับมานั้นTaskต้องการAsyncคำต่อท้ายซึ่งฉันคิดว่าเราทุกคนเห็นด้วย

ดังนั้นคำตอบสำหรับคำถามนี้อาจเป็นได้ทั้งสองอย่าง ในทั้งสองกรณีที่คุณจำเป็นต้องผนวกAsyncกับวิธีการที่มีasyncคำหลักและผลตอบแทนที่หรือTaskTask<T>

ฉันจะขอให้ Stephen Toub ชี้แจงสถานการณ์

อัปเดต

ดังนั้นฉันจึงทำ และนี่คือสิ่งที่คนดีของเราเขียน:

หากเมธอดสาธารณะคือการส่งคืนงานและเป็นแบบอะซิงโครนัส (ตรงข้ามกับวิธีการที่ทราบว่าจะดำเนินการพร้อมกันเพื่อให้เสร็จสมบูรณ์เสมอ แต่ยังคงส่งคืนงานด้วยเหตุผลบางประการ) ก็ควรมีคำต่อท้าย“ Async” นั่นคือแนวทาง เป้าหมายหลักในการตั้งชื่อนี้คือการทำให้ผู้บริโภคเห็นได้ชัดถึงฟังก์ชันการทำงานที่ว่าวิธีการที่เรียกใช้อาจจะไม่ทำงานทั้งหมดพร้อมกัน แน่นอนว่ายังช่วยในกรณีที่มีการเปิดเผยฟังก์ชันการทำงานด้วยวิธีการซิงโครนัสและอะซิงโครนัสเช่นนั้นคุณต้องมีความแตกต่างของชื่อเพื่อแยกความแตกต่าง วิธีการบรรลุการใช้งานแบบอะซิงโครนัสนั้นไม่มีความสำคัญต่อการตั้งชื่อ: ไม่ว่าจะใช้ async / await เพื่อรวบรวมความช่วยเหลือของคอมไพเลอร์หรือว่าประเภทและวิธีการจาก System.Threading งานถูกใช้โดยตรง (e. ก. TaskCompletionSource) ไม่สำคัญนักเนื่องจากจะไม่ส่งผลกระทบต่อลายเซ็นของวิธีการเท่าที่ผู้บริโภคใช้วิธีนี้เกี่ยวข้อง

แน่นอนว่ามีข้อยกเว้นเสมอสำหรับแนวทางปฏิบัติ สิ่งที่น่าสังเกตมากที่สุดในกรณีของการตั้งชื่อคือกรณีที่ raison d'etre ทั้งประเภทให้ฟังก์ชันการทำงานที่เน้น async ซึ่งในกรณีนี้การมี Async ในทุกวิธีจะเป็นการใช้งานมากเกินไปเช่นวิธีการใน Task ที่สร้าง Tasks อื่น ๆ .

สำหรับวิธีการแบบอะซิงโครนัสที่คืนค่าเป็นโมฆะไม่พึงปรารถนาที่จะมีวิธีการดังกล่าวในพื้นที่สาธารณะเนื่องจากผู้เรียกไม่มีวิธีที่ดีในการรู้ว่างานอะซิงโครนัสเสร็จสิ้นเมื่อใด หากคุณต้องเปิดเผยวิธีการอะซิงโครนัสที่คืนค่าเป็นโมฆะต่อสาธารณะคุณน่าจะต้องการมีชื่อที่บ่งบอกว่างานอะซิงโครนัสกำลังเริ่มต้นขึ้นและคุณสามารถใช้คำต่อท้าย“ Async” ที่นี่ได้หากเหมาะสม เมื่อพิจารณาถึงความยากของกรณีนี้ฉันขอยืนยันว่ามันเป็นการตัดสินใจแบบเคสต่อกรณี

ฉันหวังว่าจะช่วยได้สตีฟ

คำแนะนำสั้น ๆ จากประโยคเปิดของ Stephen นั้นชัดเจนเพียงพอ ไม่รวมasync voidเนื่องจากเป็นเรื่องผิดปกติที่ต้องการสร้าง API สาธารณะด้วยการออกแบบดังกล่าวเนื่องจากวิธีที่ถูกต้องในการใช้โมฆะอะซิงโครนัสคือการส่งคืนTaskอินสแตนซ์ธรรมดาและปล่อยให้คอมไพเลอร์ใช้เวทมนตร์ อย่างไรก็ตามหากคุณต้องการขอแนะนำให้public async voidต่อท้าย Asyncวิธีการด้านบนของสแต็กasync voidอื่น ๆ เช่นตัวจัดการเหตุการณ์มักจะไม่เป็นสาธารณะและไม่สำคัญ / มีคุณสมบัติ

สำหรับผมมันบอกว่าถ้าฉันพบตัวเองสงสัยเกี่ยวกับ suffixing Asyncบนasync voidผมอาจจะเปิดเป็นเพื่อให้สายที่สามารถรอมันแล้วผนวกasync TaskAsync

ฉันสร้างบริการ API จำนวนมากและแอปพลิเคชันอื่น ๆ ที่เรียกระบบอื่น ๆ ซึ่งโค้ดส่วนใหญ่ของฉันทำงานแบบอะซิงโครนัส

กฎทั่วไปของฉันที่ฉันติดตามคือ:

หากมีทั้งวิธีที่ไม่ใช่ async และ async ที่ส่งคืนสิ่งเดียวกันฉันต่อท้าย async ด้วย Async มิฉะนั้นจะไม่

ตัวอย่าง:

วิธีเดียวเท่านั้น:

public async Task<User> GetUser() { [...] }

วิธีเดียวกันกับสองลายเซ็น:

public User GetUser() { [...] }

public async Task<User> GetUserAsync() { [...] }

สิ่งนี้สมเหตุสมผลเนื่องจากเป็นข้อมูลเดียวกันกับที่ส่งคืน แต่สิ่งเดียวที่แตกต่างคือวิธีการส่งคืนข้อมูลไม่ใช่ข้อมูลเอง

ฉันยังคิดว่ารูปแบบการตั้งชื่อนี้มีอยู่เนื่องจากความจำเป็นในการแนะนำวิธีการ async และยังคงรักษาความเข้ากันได้แบบย้อนหลัง

ฉันยืนยันว่ารหัสใหม่ไม่ควรใช้คำต่อท้าย Async เป็นที่ชัดเจนพอ ๆ กับประเภทการส่งคืนของ String หรือ Int ตามที่กล่าวไว้ก่อนหน้านี้ในเธรดนี้

หลักการสำหรับการต่อท้ายชื่อเมธอดด้วย "Async" คืออะไร

แบบงานตามแบบ Asynchronous (TAP)สั่งการว่าวิธีการควรกลับTask<T>(หรือTask) และได้รับการตั้งชื่อที่มีAsyncต่อท้าย; asyncนี้จะแยกจากการใช้งานของ ทั้งสองTask<bool> Connect()และจะคอมไพล์และรันได้ดี แต่คุณจะไม่ปฏิบัติตามหลักการตั้งชื่อ TAPasyncTask<bool> Connect()

วิธีนี้ควรมีasyncตัวปรับแต่งหรือไม่หรือเพียงพอที่จะส่งคืนงาน

หากเนื้อหาของวิธีการ (โดยไม่คำนึงถึงประเภทการส่งคืนหรือชื่อ) รวมอยู่awaitด้วยคุณต้องใช้async; และคอมไพเลอร์จะแจ้งให้คุณทราบว่า "ตัวดำเนินการ 'await' สามารถใช้ได้ภายในเมธอด async เท่านั้น ... " กลับมาTask<T>หรือTaskไม่ "พอ" asyncที่จะหลีกเลี่ยงการใช้ ดูasync (อ้างอิง C #)สำหรับรายละเอียด

ลายเซ็นใดต่อไปนี้ถูกต้อง:

ทั้งสองและปฏิบัติตามอนุสัญญา TAP อย่างถูกต้อง คุณสามารถเสมอใช้คำหลัก แต่คุณจะได้รับการเตือนคอมไพเลอร์ "วิธีการ async นี้ขาด 'รอคอย' ผู้ประกอบการและจะทำงานพร้อมกัน ... ." ถ้าร่างกายไม่ได้ใช้asyncTask<bool> ConnectAsync()Task<bool> ConnectAsync()asyncawait

หรือเพียงพอที่จะส่งคืนงาน?

ที่. asyncคำหลักไม่ได้เป็นปัญหาจริงที่นี่ หากคุณใช้อะซิงโครไนซ์โดยไม่ใช้asyncคีย์เวิร์ดเมธอดยังคงเป็น "Async" ตามความหมายทั่วไป

เนื่องจากTaskและTask<T>เป็นประเภทที่รอคอยได้ทั้งสองประเภทจึงแสดงถึงการดำเนินการแบบอะซิงโครนัสบางอย่าง หรืออย่างน้อยก็ควรเป็นตัวแทน

คุณควรเพิ่มคำต่อท้ายAsyncลงในเมธอดซึ่งในบางกรณี (ไม่จำเป็นต้องเป็นทั้งหมด) จะไม่ส่งคืนค่า แต่จะส่งกลับ wrapper รอบการดำเนินการที่กำลังดำเนินอยู่ กระดาษห่อนั้นมักจะเป็น a Taskแต่ใน Windows RT สามารถเป็นIAsyncInfoได้ ปฏิบัติตามความรู้สึกของคุณและจำไว้ว่าหากผู้ใช้รหัสของคุณเห็นAsyncฟังก์ชันนั้นเขาหรือเธอจะรู้ว่าการเรียกใช้วิธีนั้นแยกออกจากผลลัพธ์ของวิธีการนั้นและพวกเขาจำเป็นต้องดำเนินการตามนั้น

โปรดทราบว่ามีวิธีการเช่นTask.DelayและTask.WhenAllที่ส่งคืนTaskแต่ยังไม่มีAsyncคำต่อท้าย

นอกจากนี้โปรดทราบว่ามีasync voidวิธีการที่แสดงถึงไฟและลืมวิธีการอะซิงโครนัสและคุณควรตระหนักดีกว่าว่าวิธีนี้ถูกสร้างขึ้นในลักษณะดังกล่าว

ฉันจะโต้แย้งว่าควรใช้ Async-ต่อท้ายหากส่งคืนงานไม่ว่าจะประกาศเมธอดด้วยasyncตัวปรับแต่งหรือไม่ก็ตาม

เหตุผลเบื้องหลังคือการประกาศชื่อในอินเทอร์เฟซ อินเทอร์เฟซประกาศประเภทการส่งคืนซึ่งเป็นไฟล์Task. จากนั้นมีการใช้งานอินเทอร์เฟซนั้นสองแบบการใช้งานหนึ่งใช้งานโดยใช้asyncตัวปรับแต่งส่วนอีกตัวไม่ใช้

public interface IFoo
{
    Task FooAsync();
}

public class FooA : IFoo
{
    public Task FooAsync() { /* ... */ }
}

public class FooB : IFoo
{
    public async Task FooAsync() { /* ... */ }
}

ในการเขียนโปรแกรมแบบอะซิงโครนัสกับ async และ await (C #) Microsoft เสนอคำแนะนำต่อไปนี้:

อนุสัญญาการตั้งชื่อ

ตามแบบทั่วไปคุณจะเพิ่ม "Async" ต่อท้ายชื่อของวิธีการที่มี ตัวปรับเปลี่ยนasync

คุณสามารถเพิกเฉยต่อการประชุมที่เหตุการณ์คลาสฐานหรือสัญญาอินเทอร์เฟซแนะนำชื่ออื่น ตัวอย่างเช่นคุณไม่ควรเปลี่ยนชื่อตัวจัดการเหตุการณ์ทั่วไปเช่นButton1_Click.

ฉันพบว่าคำแนะนำนี้ไม่สมบูรณ์และไม่น่าพอใจ หมายความว่าในกรณีที่ไม่มีasyncตัวปรับเปลี่ยนควรตั้งชื่อเมธอดนี้ConnectแทนConnectAsync?

public Task<bool> ConnectAsync()
{
    return ConnectAsyncInternal();
}

ฉันไม่คิดอย่างนั้น ตามที่ระบุไว้ในคำตอบที่กระชับโดย@Servyและคำตอบที่ละเอียดยิ่งขึ้นโดย@Luke Puplettฉันเชื่อว่าเหมาะสมและคาดว่าควรตั้งชื่อเมธอดนี้อย่างแน่นอนConnectAsync(เพราะส่งคืนค่าที่รอคอยได้) ในการสนับสนุนเพิ่มเติมเกี่ยวกับสิ่งนี้@John Skeetในคำตอบสำหรับคำถามอื่นนี้จะต่อท้ายAsyncชื่อวิธีการโดยไม่คำนึงถึงการมีตัวasyncปรับเปลี่ยน

สุดท้ายสำหรับคำถามอื่นให้พิจารณาความคิดเห็นนี้โดย@Damien_The_Unbeliever :

async/awaitเป็นรายละเอียดการใช้งานวิธีการของคุณ ไม่ใช่เรื่องสำคัญว่าจะมีการประกาศวิธีการของคุณasync Task Method()หรือไม่Task Method()ก็ตามตราบเท่าที่ผู้โทรของคุณกังวล (อันที่จริงคุณมีอิสระที่จะเปลี่ยนแปลงระหว่างสองสิ่งนี้ในเวลาต่อมาโดยไม่ถือว่าเป็นการเปลี่ยนแปลงที่แตกหัก)

จากนั้นฉันสรุปได้ว่าเป็นลักษณะอะซิงโครนัสของวิธีการที่กำหนดว่าควรตั้งชื่ออย่างไร ผู้ใช้วิธีนี้จะไม่ทราบด้วยซ้ำว่าasyncมีการใช้ตัวปรับแต่งในการนำไปใช้งาน (โดยไม่มีซอร์สโค้ด C # หรือ CIL)