Какой самый элегантный способ написать метод «Try» в C # 7?

Я пишу тип реализации Queue, в котором есть TryDequeueметод, который использует шаблон, аналогичный различным TryParseметодам .NET , где я возвращаю логическое значение, если действие выполнено успешно, и использую outпараметр для возврата фактического значения в очереди.

public bool TryDequeue(out Message message) => _innerQueue.TryDequeue(out message);

Теперь я люблю избегать outпараметров, когда могу. C # 7 выдает нам переменные делкарации, чтобы упростить работу с ними, но я все же считаю параметры скорее необходимым злом, чем полезным инструментом.

Поведение, которое я хочу от этого метода, следующее:

• Если есть предмет для удаления из очереди, верните его.
• Если нет элементов для удаления из очереди (очередь пуста), предоставьте вызывающей стороне достаточно информации, чтобы действовать соответствующим образом.
• Не просто возвращайте нулевой элемент, если ничего не осталось.
• Не выбрасывайте исключение, если пытаетесь удалить из пустой очереди.

Прямо сейчас вызывающая сторона этого метода почти всегда использует шаблон, подобный следующему (используя синтаксис переменной C # 7 out):

if (myMessageQueue.TryDequeue(out Message dequeued))
    MyMessagingClass.SendMessage(dequeued)
else
    Console.WriteLine("No messages!"); // do other stuff

Что не самое худшее, все сказали. Но я не могу помочь, но чувствую, что могут быть более хорошие способы сделать это (я полностью готов признать, что не может быть). Я ненавижу, как вызывающий должен разбить свой поток на условные, когда все, что он хочет, это получить значение, если оно существует.

Какие существуют другие паттерны, способствующие такому же «пробному» поведению?

Для контекста этот метод потенциально может быть вызван в проектах VB, так что бонусные баллы за то, что хорошо работает в обоих. Этот факт должен иметь очень небольшой вес, хотя.

Используйте тип Option, то есть объект типа, который имеет две версии, обычно называемые «Some» (при наличии значения) или «None» (при отсутствии значения) ... Или иногда они называются справедливо и ничего. Затем в этих типах есть функции, которые позволяют получить доступ к значению, если оно присутствует, проверить наличие, и, что наиболее важно, метод, который позволяет применить функцию, которая возвращает дополнительный параметр к значению, если оно присутствует (обычно в C # это должно быть названным FlatMap, хотя в других языках это часто называют Bind вместо ... Имя является критическим в C #, потому что наличие метода s этого имени и типа позволяет вам использовать ваши объекты Option в операторах LINQ).

Дополнительные функции могут включать в себя такие методы, как IfPresent и IfNotPresent для вызова действий в соответствующих условиях и OrElse (который заменяет значение по умолчанию, когда значение отсутствует, но в противном случае это не операция), и так далее.

Ваш пример может выглядеть примерно так:

myMessageQueue.TryDeque()
    .IfPresent( dequeued => MyMessagingClass.SendMessage(dequeued))
    .IfNotPresent (() =>  Console.WriteLine("No messages!")

Это образец монады Option (или Maybe), и он чрезвычайно полезен. Существуют реализации (например, https://github.com/nlkl/Optional/blob/master/README.md ), но это не так сложно сделать самостоятельно.

(Возможно, вы захотите расширить этот шаблон, чтобы вы возвращали описание причины ошибки, а не ничего, когда метод завершается ошибкой ... Это вполне достижимо и часто называется монадой Either; как следует из названия, вы можете использовать ту же FlatMap шаблон, чтобы облегчить работу в этом случае тоже)

Данные ответы хороши, и я бы пошел с одним из них. Считайте, что этот ответ просто заполняет несколько углов альтернативными идеями:

• Сделайте подклассы Messageвызываемых SomeMessageи NoMessage. Dequeueтеперь может вернуться, NoMessageесли нет сообщения, и SomeMessageесли есть сообщение. Если вызываемый абонент хочет определить, в каком случае он находится, он может легко сделать это путем проверки типа. Если они этого не делают, просто делают NoMessageничего не делать, когда вызывается какой-либо из его методов, и они получают то, что просили.

• То же, что и выше, но сделать Messageнеявно конвертируемым bool(или реализовать operator true / operator false). Теперь вы можете сказать, if (message)чтобы оно было правдой, если сообщение хорошее, и ложным, если оно плохое. (Это почти наверняка плохая идея, но я включил ее для полноты!)

• C # 7 имеет кортежи. Верните (bool, Message)кортеж.

• Сделайте Messageтип структуры и верните Message?.

В C # 7 вы можете использовать сопоставление с образцом, чтобы добиться того же более элегантным способом:

if (myMessageQueue.TryDequeue() is Message dequeued) 
{
     MyMessagingClass.SendMessage(dequeued)
} 
else 
{
    Console.WriteLine("No messages!"); // do other stuff
}

В этом конкретном случае, однако, я бы, вероятно, использовал события вместо того, чтобы повторно опрашивать очередь.

Нет ничего плохого в методе Try ... (с параметром out) для сценария, в котором сбой (без значения) так же распространен, как и успех.

Но если вы настаиваете на том, чтобы делать что-то по-другому, вы можете захотеть вернуть пустое сообщение и либо просто отправить его (больше не ваша проблема), либо отложить утверждение if, пока вы действительно не узнаете, есть ли у вас сообщение с контентом или нет.

Обратите внимание, что кто-то должен пройти тест в любом случае. Я бы сказал, что тест должен быть сделан, когда и где этот вопрос актуален. Это в момент оформления.