Gibt es eine Standard-Java-Ausnahmeklasse, die bedeutet, dass das Objekt nicht gefunden wurde?

Betrachten Sie eine Funktion der folgenden allgemeinen Form:

Foo findFoo(Collection<Foo> foos, otherarguments)
throws ObjectNotFoundException {
    for(Foo foo : foos){
        if(/* foo meets some condition*/){
            return foo;
        }
    }
    throw new ObjectNotFoundException();
}

Ein konkreter Fall wäre zum Beispiel:

User findUserByName(Collection<User> users, String name)
throws ObjectNotFoundException {
    for(User user : users){
        if(user.getName().equals(name)){
            return user;
        }
    }
    throw new ObjectNotFoundException();
}

Diese Funktionen lösen eine Ausnahme aus, wenn das Objekt nicht gefunden wird. Ich kann zu diesem Zweck eine benutzerdefinierte Ausnahmeklasse erstellen (in den Beispielen ObjectNotFoundException), würde jedoch lieber eine vorhandene Klasse verwenden. In der Standard-Java-Bibliothek konnte ich jedoch keine Ausnahmeklasse mit dieser Bedeutung finden. Wissen Sie, ob es eine Standardausnahme gibt, die hier verwendet werden kann?

Wissen Sie, ob es eine Standardausnahme gibt, die hier verwendet werden kann?

Es gibt einige Ausnahmen, die verwendet werden könnten (z. B. NoSuchElementExceptionoder IllegalArgumentException), aber die Antwort hängt wirklich von der Semantik ab, die Sie vermitteln möchten:

• NoSuchElementException Wird normalerweise verwendet, wenn Sie eine Sequenz oder Aufzählung durchlaufen, wobei Sie hier eine Suche haben.

• IllegalArgumentException Dies deutet darauf hin, dass das Argument fehlerhaft ist. In diesem Fall kann es jedoch sein, dass die Annahmen des Aufrufers falsch sind oder spezifisch für die Anwendungslogik sind.

• Mit einer benutzerdefinierten Ausnahme können Sie (in den Javadocs) genau angeben, was die Ausnahme bedeutet. Sie können auch deklarieren, dass es überprüft werden soll ... falls dies angemessen ist.

(Aber seien Sie nicht versucht zu benutzen UnknownUserException. Das wäre schrecklich falsch; lesen Sie den Javadoc!)

Es lohnt sich auch, eine Rückgabe in Betracht zu ziehen null, insbesondere wenn ein Suchfehler wahrscheinlich ein ziemlich häufiges (nicht außergewöhnliches) Ereignis in Ihrer Anwendung ist. Der Nachteil der Rückgabe nullist jedoch, dass der Anrufer nach nullunerwarteten NullPointerExceptions suchen oder diese riskieren muss . In der Tat würde ich argumentieren, dass Überbeanspruchung nullschlimmer ist als Überbeanspruchung von Ausnahmen. Ersteres kann zu unzuverlässigen Anwendungen führen, während letzteres "nur" die Leistung beeinträchtigt.

Für Java 8 und höher Optionalwäre die Rückgabe von a eine sauberere Wahl als die Rückgabe von a null.

In diesen Dingen ist es wichtig, über die Dogmen hinauszuschauen und sich anhand der tatsächlichen Kontextbedingungen zu entscheiden.

Ausnahmen werden erstellt, um außergewöhnliches Verhalten zu kennzeichnen. Meiner Meinung nach ist eine nicht gefundene Objektsituation keine Ausnahme. Ich würde Ihre Methode so umschreiben, dass sie null zurückgibt, wenn der Benutzer nicht gefunden wird.

User findUserByName(Collection<User> users, String name) {
   for(User user : users){
       if(user.getName().equals(name)){
           return user;
      }
    }
  return null; 
}

Dies ist das Standardverhalten vieler Java-Sammlungen. Beispielsweise gibt http://docs.oracle.com/javase/7/docs/api/java/util/Map.html#get(java.lang.Object) null zurück, wenn sich kein Eintrag mit dem angegebenen Schlüssel in der befindet Karte.

Sie sollten vermeiden, sich auf Ausnahmen in Ihrer Programmlogik zu verlassen.

IllegalArgumentException wird hier manchmal verwendet, aber die Verwendung Ihrer eigenen Ausnahme ist vollkommen in Ordnung.

Nebenbei würde ich empfehlen, eine Karte mit String nameals Schlüssel und Userals Wert zu verwenden. Ein Iterieren über die Sammlung wäre dann unnötig und würde verhindern, dass zwei Benutzer mit demselben Namen in der Sammlung sind. Wenn Sie keine Karte verwenden möchten, verteidigen Sie sich zumindest NullPointerExceptionwie folgt:

User findUserByName(Collection<User> users, String name) throws ObjectNotFoundException
{
  if (name == null)
  {
    throw new IllegalArgumentException("name parameter must not be null");
  }
  if (users == null)
  {
    throw new IllegalArgumentException("Collection of users must not be null");
  }
  for(User user : users)
  {
    if(name.equals(user.getName()))
    {
      return user;
    }
  }
  throw new ObjectNotFoundException("Unable to locate user with name: " + name);
}

Mit Java 8 würde ich empfehlen, für diesen Anwendungsfall eine Option zu verwenden.

Optional<User> findUserByName(Collection<User> users, String name){
    Optional<User> value = users
        .stream()
        .filter(a -> a.equals(name))
        .findFirst();
}

Dies macht dem Anrufer auch sehr deutlich, dass das Optionale leer sein kann, wenn der Wert nicht gefunden wird. Wenn Sie wirklich eine Ausnahme auslösen möchten, können Sie sie orElseThrowsin Optional verwenden, um sie zu erreichen.

Dies hängt vom dokumentierten Schnittstellenvertrag Ihrer Methode ab:

Wenn in der Dokumentation Ihrer Methode angegeben ist, dass das nameArgument dem Namen eines vorhandenen Benutzers entsprechen muss , ist es angebracht, zu werfen, IllegalArgumentExceptionwenn der Name nicht gefunden wird, da dies bedeutet, dass der Aufrufer die Anforderungen der Methode verletzt hat, indem er einen Namen übergeben hat, der nicht entspricht Ein Benutzer.

Wenn Ihre Methode nicht sagt, dass der Name einem vorhandenen Benutzer entsprechen muss, ist die Übergabe eines unbekannten Namens kein Fehler und Sie sollten überhaupt keine Ausnahme auslösen. Eine Rückgabe nullwäre in dieser Situation angebracht.

Beachten Sie, dass Ihre findUserByNameMethode die Methode im Grunde neu erfindet, die zurückgegeben Map.getwird, nullwenn der angegebene Schlüssel nicht gefunden wird.