Какой должен быть результат поиска если данных нет?

Question

[Actor]

Возьмем класическую схему, база и приложение.
В приложении есть класс для работы с базой, есть метод поиска по определнному полю, который должен возвращать данные в некой структуре

class SomeRecord
{
  public string prop1 {get;set;}
  public string prop1 {get;set;}
}

И есть метод котоырй ищет по полю:
...

public SomeRecord FindMe(string prop)
{
  var l = <linq query>
  return l.First<SomeRecord>(); 
}

Если LINQ запрос не выдаст результата (т.е. Count = 0) то return выпадет с ошибкой. Как правильно поступать в таких случаях?

Answer 1

[aush]

Правильно - возвращать коллекцию результатов поиска. Если результатов нет, то будет возвращаться пустая коллекция.

Если же у вас контракт такой, что "должен возвращаться только один результат", то FindMe должен выбрасывать исключение, т.к. он не смог выполнить контракт "вернуть один результат" (null - это не результат).

Null можно вовзвращать только если вы на самом деле хотите использоваться такой контракт: "возвращать один результат или null". Но подобный дизайн не приводит ни к чему хорошему и только увеличивает сложность.

Comments

[Actor]

1 абзац: Требуется получить один результат.
2 абзац: Если выбрасывать исключение то мы в принципе своем му просто переименуем исключение в свое. За этим классом нужно будет использовать try catch.

[aush]

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

Да, клиент этого кода должен оборачивать этот вызов в try/catch, если у он знает, как обрабатывать эту исключительную ситуацию - "результат должен быть, а его нет".

[aush]

Тем не менее - "1 абзац: Требуется получить один результат" означает, что скорее всего у вас есть более серьезная проблема с архитектурой вашего приложения.

[Actor]

В чем может быть проблема с архитектурой, вроде задача типичная - получать 1 запись. Самый простой пример это может быть пользователь... Последнее действие и т.д.

[aush]

Для задачи поиска получать 1 запись - нетипично. Если вам нужно получать ровно одну запись, то если результата поиска оказалось больше одного, то это ошибка и исключительная ситуация, которую тоже надо обрабатывать, а вы просто ее отбрасываете ("l.First()").

"Последнее действие и т.д." - тут вы нарушаете принцип Single responsibility (единственной обязанности), т.к. "последнее действие" - это бизнес-логика и она должна быть отделена от инфраструктуры (вытаскивание записей из базы). Т.е. ваш "поисковик" должен вернуть все записи, которые он нашел, а клиент (например, UI) уже решает, как ему поступать если результатов нет, результат один или результатов много.

[Actor]

Т.е. вы предлагаете вытаскивать милион записей к клиенту, и на нем выводить только для текущего пользователя его последнее действие?

[aush]

Клиенту кода поиска должно быть все равно, откуда тянутся данные. Если он будет знать, что данные тянутся из базы и нужно это оптимизировать, то это - нарушение инкапсуляции.

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

[Actor]

Это позволяет передать клиенту "коллекцию", которая не будет создавать никакой нагрузки, пока клиент не начнет ее перечислять. И если он возьмет оттуда только одну запись и на этом остановится, то остальные данные подтянуты из базы не будут.

Как это возможно? Можно пример?

[aush]

Если можете по-английски, по гуглите "linq deferred execution". На русском вот неплохая статья professorweb.ru/my/LINQ/linq_sql/level10/10_5.php

Answer 2

[GavriKos]

return null. Тем более раз вы класс используете.

Answer 3

[Alexander Sydorenko]

return l.FirstOrDefault<SomeRecord>();

и ожидать возможного null в результате. Либо обрабатывать ответ до возврата

public SomeRecord FindMe(string prop)
{
  var l = <linq query>
  SomeRecord result = l.FirstOrDefault<SomeRecord>(); 
  if(result == null) {
    result = new SomeRecord();
  }
  return result;
}

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

Answer 4

[Илья Глебов]

var result = l.SingleOrDefault();

1. Вот еще вариант для дальнейшей обработки: использовать что то типа Option из F# (или Nullable в C#)
Так, что б был сразу понятен контракт метода

public class SingleResult<T> where T : class { 
  private readonly T result;
  public readonly bool IsSuccess;

  private SingleResult(T result, bool isSuccess) {
    this.result = result;
     IsSuccess = isSuccess;
  }

  public T Result { 
    get {
       Contract.Requires<InvalidOperationException>(IsSuccess);
       return result;
     }
   }

   public static SingleResult<T> Success(T result) {
     Contract.Requires<ArgumentNullException>(result != null, "result");
     
     return new SingleResult<T>(result, true);
   }

   public static SingleResult<T> Nothing = new SingleResult<T>(null, false);
}

public SingleResult<SomeRecord> FindMe(string prop)         {
  var l = <linqquery >;
  
  var result = l.SingleOrDefault();
  if (result == null)
    return SingleResult<SomeRecord>.Nothing;
        
  return SingleResult<SomeRecord>.Success(result); 
}

2. Можно по типу TryParse

public bool TryFindSingle(string prop, out SomeRecord result) {...}

Answer 5

[Виталий Пухов]

Инкапсуляция вселенной!