Які найкращі практики використання SmtpClient, SendAsync та Dispose під .NET 4.0

Я трохи здивований, як керувати SmtpClient тепер, коли він є одноразовим, особливо якщо я телефоную за допомогою SendAsync. Імовірно, я не повинен закликати розпоряджатися, поки SendAsync не завершиться. Але чи повинен я коли-небудь це називати (наприклад, використовуючи "використання"). Сценарій - це послуга WCF, яка періодично надсилає електронні листи, коли здійснюються дзвінки. Більшість обчислень проходить швидко, але надсилання електронної пошти може зайняти секунду або близько того, тому Async буде кращим.

Чи потрібно створювати новий SmtpClient кожного разу, коли я надсилаю пошту? Чи варто створити його для всього WCF? Довідка!

Оновлення Якщо це має значення, кожен електронний лист завжди налаштовується для користувача. WCF розміщується на Azure, а Gmail використовується як електронна пошта.

Примітка: .NET 4.5 SmtpClient реалізує async awaitableметод SendMailAsync. Для нижчих версій використовуйте, SendAsyncяк описано нижче.

Ви завжди повинні розпоряджатися IDisposableекземплярами якомога раніше. У випадку з асинхронними дзвінками це повернення дзвінка після надсилання повідомлення.

var message = new MailMessage("from", "to", "subject", "body"))
var client = new SmtpClient("host");
client.SendCompleted += (s, e) => {
                           client.Dispose();
                           message.Dispose();
                        };
client.SendAsync(message, null);

Це трохи дратує те, SendAsyncщо не приймає зворотний дзвінок.

Оригінальне запитання було задано .NET 4, але якщо він допомагає, як .NET 4.5 SmtpClient реалізує метод очікування async SendMailAsync.

Як результат, надсилати електронну пошту асинхронно таким чином:

public async Task SendEmail(string toEmailAddress, string emailSubject, string emailMessage)
{
    using (var message = new MailMessage())
    {
        message.To.Add(toEmailAddress);

        message.Subject = emailSubject;
        message.Body = emailMessage;

        using (var smtpClient = new SmtpClient())
        {
            await smtpClient.SendMailAsync(message);
        }
    }
}

Краще уникати використання методу SendAsync.

Взагалі об’єкти, що не використовуються, повинні бути утилізовані якнайшвидше; реалізація IDisposable на об'єкті призначена для повідомлення про те, що у відповідного класу є дорогі ресурси, які слід детерміновано звільнити. Однак якщо створення цих ресурсів коштує дорого і вам потрібно сконструювати багато цих об'єктів, можливо, краще (з розумом виконання) зберігати один екземпляр у пам’яті та використовувати його повторно. Є лише один спосіб дізнатися, чи це має значення: профілі!

Re: розпорядження та Async: usingочевидно, ви не можете використовувати . Замість цього ви зазвичай розпоряджаєтесь об'єктом у події SendCompleted:

var smtpClient = new SmtpClient();
smtpClient.SendCompleted += (s, e) => smtpClient.Dispose();
smtpClient.SendAsync(...);

Гаразд, старе питання, яке я знаю. Але я натрапив на це сам, коли мені потрібно було реалізувати щось подібне. Я просто хотів поділитися деяким кодом.

Я повторюю декілька SmtpClients, щоб надіслати кілька повідомлень асинхронно. Моє рішення схоже на TheCodeKing, але я розміщую натомість об'єкт зворотного виклику. Я також передаю MailMessage як userToken, щоб отримати його у події SendCompleted, щоб я також міг зателефонувати розпоряджатися цим. Подобається це:

foreach (Customer customer in Customers)
{
    SmtpClient smtpClient = new SmtpClient(); //SmtpClient configuration out of this scope
    MailMessage message = new MailMessage(); //MailMessage configuration out of this scope

    smtpClient.SendCompleted += (s, e) =>
    {
        SmtpClient callbackClient = s as SmtpClient;
        MailMessage callbackMailMessage = e.UserState as MailMessage;
        callbackClient.Dispose();
        callbackMailMessage.Dispose();
    };

    smtpClient.SendAsync(message, message);
}

Ви можете зрозуміти, чому особливо важливо утилізувати SmtpClient наступним коментарем:

public class SmtpClient : IDisposable
   // Summary:
    //     Sends a QUIT message to the SMTP server, gracefully ends the TCP connection,
    //     and releases all resources used by the current instance of the System.Net.Mail.SmtpClient
    //     class.
    public void Dispose();

У моєму сценарії надсилання декількох листів за допомогою Gmail без розпорядження клієнта я отримував:

Повідомлення: Служба недоступна, закриваючи канал передачі. Відповідь сервера була: 4.7.0 Тимчасова системна проблема. Повторіть спробу пізніше (WS). oo3sm17830090pdb.64 - gsmtp