Повертаючи два значення, Tuple проти 'out' проти 'struct'

Розглянемо функцію, яка повертає два значення. Ми можемо написати:

// Using out:
string MyFunction(string input, out int count)

// Using Tuple class:
Tuple<string, int> MyFunction(string input)

// Using struct:
MyStruct MyFunction(string input)

Яка з них є найкращою практикою і чому?

У кожного з них є свої плюси і мінуси.

Вихідні параметри швидкі та дешеві, але вимагають, щоб ви передали змінну та покладалися на мутацію. Правильно використовувати параметр out із LINQ практично неможливо.

Кортежі чинять тиск на збір сміття і не самодокументуються. "Елемент1" не дуже описовий.

Спеціальні структури можуть бути повільними для копіювання, якщо вони великі, але вони самодокументуються та ефективні, якщо вони малі. Однак також важко визначити цілу купу спеціальних конструкцій для тривіального використання.

Я був би схильний до спеціального рішення структури за інших рівних умов. Ще краще, хоча це зробити функцію, яка повертає лише одне значення . Чому ви спочатку повертаєте два значення?

ОНОВЛЕННЯ: Зверніть увагу, що кортежі в C # 7, які надійшли через шість років після написання цієї статті, є типами цінностей і, отже, з меншою ймовірністю створюватимуть тиск на збір.

Додаючи до попередніх відповідей, C # 7 пропонує кортежі типу значення, на відміну від того, System.Tupleщо є посилальним типом, а також пропонує покращену семантику.

Ви все ще можете залишити їх без імені та використовувати .Item*синтаксис:

(string, string, int) getPerson()
{
    return ("John", "Doe", 42);
}

var person = getPerson();
person.Item1; //John
person.Item2; //Doe
person.Item3;   //42

Але що насправді є потужним у цій новій функції - це здатність називати кортежі. Тож ми могли б переписати вищенаведене так:

(string FirstName, string LastName, int Age) getPerson()
{
    return ("John", "Doe", 42);
}

var person = getPerson();
person.FirstName; //John
person.LastName; //Doe
person.Age;   //42

Також підтримується деструктуризація:

(string firstName, string lastName, int age) = getPerson()

Я думаю, що відповідь залежить від семантики того, що робить функція, та взаємозв'язку між двома значеннями.

Наприклад, TryParseметоди беруть outпараметр для прийняття проаналізованого значення та повертають a, boolщоб вказати, чи пройшов синтаксичний аналіз. Ці два значення насправді не належать разом, тому, семантично, це має більше сенсу, а намір коду легше читати, використовувати outпараметр.

Якщо, однак, ваша функція повертає координати X / Y якогось об’єкта на екрані, тоді ці два значення семантично належать разом, і було б краще використовувати a struct.

Я особисто уникаю використання а tupleдля будь-чого, що буде видно зовнішньому коду через незручний синтаксис для отримання членів.

Я піду на підхід до використання параметра Out, оскільки при другому підході вам потрібно буде створити і об’єкт класу Tuple, а потім додати до нього значення, що, на мою думку, є дорогою операцією порівняно з поверненням значення у параметрі out. Хоча, якщо ви хочете повернути кілька значень у класі Tuple (що фактично неможливо досягти, просто повернувши один параметр out), тоді я піду на другий підхід.

Ви не згадали ще один варіант, який має власний клас замість struct. Якщо дані мають семантику, пов’язану з ними, яка може працювати з функціями, або розмір екземпляра досить великий (> 16 байт, як правило), може бути кращим спеціальний клас. Використання "out" не рекомендується в загальнодоступному API через його прив'язку до покажчиків і вимагає розуміння того, як працюють посилальні типи.

https://msdn.microsoft.com/en-us/library/ms182131.aspx

Кортеж добре підходить для внутрішнього використання, але використання його в публічному API незручне. Отже, я голосую між struct та class для загальнодоступного API.

Не існує "найкращої практики". Це те, що вам комфортно і що найкраще працює у вашій ситуації. Поки ви погоджуєтесь із цим, жодна з опублікованих вами рішень не має проблем.