Làm thế nào nên chờ đợi một nhiệm vụ không đồng bộ và hiển thị một hình thức phương thức trong cùng một phương pháp được xử lý?

Question

Tôi có một ứng dụng biểu mẫu cửa sổ, trong đó tôi gửi email bằng SmtpClient. Các hoạt động không đồng bộ khác trong ứng dụng sử dụng async/await và tôi lý tưởng muốn nhất quán trong khi gửi thư.

Tôi hiển thị hộp thoại phương thức có nút hủy khi gửi thư và kết hợp SendMailAsync với biểu mẫu.ShowDialog là nơi mọi thứ trở nên phức tạp bởi vì việc chờ gửi sẽ chặn và ShowDialog sẽ như vậy. Cách tiếp cận hiện tại của tôi là như dưới đây, nhưng có vẻ lộn xộn, có cách tiếp cận tốt hơn cho điều này không?

private async Task SendTestEmail() 
{ 
    // Prepare message, client, and form with cancel button 
    using (Message message = ...) 
    { 
    SmtpClient client = ... 
    CancelSendForm form = ... 

    // Have the form button cancel async sends and 
    // the client completion close the form 
    form.CancelBtn.Click += (s, a) => 
    { 
     client.SendAsyncCancel(); 
    }; 
    client.SendCompleted += (o, e) => 
    { 
     form.Close(); 
    }; 

    // Try to send the mail 
    try 
    { 
     Task task = client.SendMailAsync(message); 
     form.ShowDialog(); 
     await task; // Probably redundant 

     MessageBox.Show("Test mail sent", "Success"); 
    } 
    catch (Exception ex) 
    { 
     string text = string.Format(
      "Error sending test mail:\n{0}", 
      ex.Message); 
     MessageBox.Show(text, "Error"); 
    } 
    } 

Answer 1

Tôi sẽ xem xét xử lý sự kiện Form.Shown và gửi email từ đó. Vì nó sẽ kích hoạt không đồng bộ, bạn không cần phải lo lắng về tính chất chặn "làm việc xung quanh" của ShowDialog và bạn có cách hơi sạch hơn để đồng bộ hóa việc đóng biểu mẫu và hiển thị thông báo thành công hoặc thất bại.

form.Shown += async (s, a) => 
{ 
    try 
    { 
     await client.SendMailAsync(message); 
     form.Close(); 
     MessageBox.Show("Test mail sent", "Success"); 
    } 
    catch(Exception ex) 
    { 
     form.Close(); 
     string text = string.Format(
      "Error sending test mail:\n{0}", 
      ex.Message); 
     MessageBox.Show(text, "Error"); 
    } 
}; 

form.ShowDialog(); 

Answer 2

Một điều đáng ngờ về SendTestEmail thực hiện hiện tại của bạn là nó trong thực tế đồng bộ, mặc dù nó trả về một Task. Vì vậy, nó chỉ trả về khi tác vụ đã hoàn thành, bởi vì ShowDialog là đồng bộ (một cách tự nhiên, vì hộp thoại là phương thức).

Điều này có thể gây nhầm lẫn. Ví dụ, đoạn mã sau sẽ không làm việc theo cách mong đợi:

var sw = new Stopwatch(); 
sw.Start(); 
var task = SendTestEmail(); 
while (!task.IsCompleted) 
{ 
    await WhenAny(Task.Delay(500), task); 
    StatusBar.Text = "Lapse, ms: " + sw.ElapsedMilliseconds; 
} 
await task; 

Nó có thể dễ dàng giải quyết bằng Task.Yield, mà sẽ cho phép tiếp tục không đồng bộ trên mới (lồng) modal vòng lặp thông điệp thoại:

public static class FormExt 
{ 
    public static async Task<DialogResult> ShowDialogAsync(
     Form @this, CancellationToken token = default(CancellationToken)) 
    { 
     await Task.Yield(); 
     using (token.Register(() => @this.Close(), useSynchronizationContext: true)) 
     { 
      return @this.ShowDialog(); 
     } 
    } 
} 

Sau đó, bạn có thể làm một cái gì đó như thế này (chưa được kiểm tra):

private async Task SendTestEmail(CancellationToken token) 
{ 
    // Prepare message, client, and form with cancel button 
    using (Message message = ...) 
    { 
     SmtpClient client = ... 
     CancelSendForm form = ... 

     // Try to send the mail 
     var ctsDialog = CancellationTokenSource.CreateLinkedTokenSource(token); 
     var ctsSend = CancellationTokenSource.CreateLinkedTokenSource(token); 
     var dialogTask = form.ShowDialogAsync(ctsDialog.Token); 
     var emailTask = client.SendMailExAsync(message, ctsSend.Token); 
     var whichTask = await Task.WhenAny(emailTask, dialogTask); 
     if (whichTask == emailTask) 
     { 
      ctsDialog.Cancel(); 
     } 
     else 
     { 
      ctsSend.Cancel(); 
     } 
     await Task.WhenAll(emailTask, dialogTask); 
    } 
} 

public static class SmtpClientEx 
{ 
    public static async Task SendMailExAsync(
     SmtpClient @this, MailMessage message, 
     CancellationToken token = default(CancellationToken)) 
    { 
     using (token.Register(() => 
      @this.SendAsyncCancel(), useSynchronizationContext: false)) 
     { 
      await @this.SendMailAsync(message); 
     } 
    } 
}