Разработка сигнатуры функции - возвращаемое значение или выходной параметр

Question

Привет, дорогие мои коллеги-эксперты,

Я разрабатываю одну функцию, которая должна обрабатывать файлы в папке.Функция должна сказать, сколько файлов она обработала, а также, если есть ошибка.Каков наилучший способ разработать такую ​​функцию?Я выбираю один из трех вариантов:

bool ProcessFiles(out int fileCount)
{
  // return true or false
}

int ProcessFiles()
{
  // return -1 when failed
}

int ProcessFiles(out bool success)
{
  // return count
}

Конечно, этот пример - скорее иллюстрация реальных проблем.Я просто хочу разработать хорошую стратегию.

Answer 1

Я бы пошел на:

int ProcessFiles() // returns count
{
   if(error)
   {
       throw new MyException();
   }
}

Answer 2

Почему бы не выдать исключение в случае сбоя процесса?

Answer 3

я бы пошел на

 bool ProcessFiles(out int fileCount)
{
  // return true or false
}

Answer 4

Как насчет чего-то более сложного?

class ProcessingResult
{
    public ProcessingResult(IEnumerable<Foo> processedFiles, IEnumerable<Foo> failures)
    {
        this.ProcessedFiles = processedFiles;
        this.Failures = failures ;
    }

    public IEnumerable<Foo> ProcessedFiles { get; private set; }
    public IEnumerable<Foo> Failures { get; private set; }
}

Тогда ваш метод становится:

ProcessingResult ProcessFiles(IEnumerable<Foo> files)
{
    List<Foo> failures = new List<Foo>();
    ProcessingResult result = new ProcessingResult(files, failures);

    foreach (var foo in files)
    {
        // voodoo

        if (error)
            failures.Add(foo);
    }

    return result;
}

Вы можете определить наличие ошибок, спросив result.Failures.Any().

Класс ProcessingResult можно легко расширить, чтобы он содержал больше деталей, таких как, в частности, проблема, связанная с каждым неисправным элементом, или несколько проблем на элемент, которые могут быть более полезными, чем простое «эта ошибка». 1011 *

Answer 5

Я бы также выбрал решение, выбрасывающее исключение.Иногда исключение не является опцией (например, API).Почему бы не создать класс?

public class RetrnClass
{
    public int AmountOfFiles { get; set; }
    public int ErrorCode { get; set; }
    public String ErrorMessage { get; set; }
    public Exception ExceptionObject { get; set; }
    public bool IsValid { get { return ExceptionObject == null; } }
    public static implicit operator bool(RetrnClass cls) { return cls.IsValid; }
}

Answer 6

Почему бы и нет:

int ProcessFiles()
{ 

   int num_of_files_processed = 0;

   if(error) 
   { 
       throw new MyException(num_of_files_processed, error_code); 

   return num_of_files_processed;
} 

Answer 7

Лично для однопоточного подхода я бы выбрал первый.

Тем не менее, я заявляю вам, что выполнение этой фоновой операции было бы предпочтительнее, и поэтому наличие BeginProcessFiles и либо EndProcessFiles, либо обратный вызов события было бы лучшим способом определения успеха операции и количества. файлы были обработаны.