Czy lepiej jest użyć assert lub IllegalArgumentException dla wymaganych parametrów metody?

W Javie, co jest bardziej zalecane i dlaczego? Oba typy będą zgłaszać wyjątki, więc ich obsługa jest taka sama. assertjest nieco krótszy, ale nie jestem pewien, ile to ma znaczenie.

public void doStuff(Object obj) {
    assert obj != null;
    ...
}

vs

public void doStuff(Object obj) {
    if (obj == null) {
        throw new IllegalArgumentException("object was null");
    }
    ...
}

STRZEC SIĘ!

Asercje są usuwane w czasie wykonywania, chyba że jawnie określisz opcję „włącz asercje” podczas kompilowania kodu. Asercji Java nie należy używać w kodzie produkcyjnym i należy ją ograniczyć do metod prywatnych (patrz Wyjątek vs. asercja ), ponieważ oczekuje się, że metody prywatne będą znane i używane tylko przez programistów. Również assertrzuci AssertionError która rozciąga się Errornie Exception, a które zazwyczaj oznacza, że masz bardzo nienormalne błąd (jak „OutOfMemoryError”, które jest trudne do odzyskania od, prawda?), Nie oczekuje się, aby móc leczyć.

Usuń flagę „włącz asercje” i sprawdź za pomocą debugera, a zobaczysz, że nie nadepniesz na wywołanie wyrzucenia IllegalArgumentException ... ponieważ ten kod nie został skompilowany (ponownie po usunięciu „ea”)

Lepiej jest użyć drugiej konstrukcji do metod publicznych / chronionych, a jeśli chcesz czegoś, co jest zrobione w jednym wierszu kodu, jest co najmniej jeden sposób, który znam. Ja osobiście korzystam z klasy Spring Framework , Assertktóra ma kilka metod sprawdzania argumentów i która generuje błąd „IllegalArgumentException” w przypadku niepowodzenia. Zasadniczo to, co robisz, to:

Assert.notNull(obj, "object was null");

... Który faktycznie wykona dokładnie ten sam kod, który napisałeś w drugim przykładzie. Istnieje kilka innych przydatnych metod, takich jak hasText, hasLengthtam.

Nie lubię pisać więcej kodu niż to konieczne, więc cieszę się, gdy zmniejszam liczbę zapisanych linii o 2 (2 linie> 1 linia) :-)

Musisz użyć wyjątku. Użycie asercji byłoby niewłaściwym użyciem tej funkcji.

Niezaznaczone wyjątki służą do wykrywania błędów programowych użytkowników biblioteki, podczas gdy twierdzenia mają na celu wykrywanie błędów we własnej logice. Są to osobne problemy, których nie należy mieszać.

Na przykład twierdzenie

assert myConnection.isConnected();

oznacza „Wiem, że każda ścieżka kodu prowadząca do tego stwierdzenia zapewnia, że myConnectionjest on połączony; jeśli powyższy kod nie uzyskał prawidłowego połączenia, powinien zgłosić wyjątek lub powrócić przed osiągnięciem tego punktu”.

Z drugiej strony czek

if (!myConnection.isConnected()) {
    throw new IllegalArgumentException("connection is not established");
}

oznacza, że ​​„Wywołanie mojej biblioteki bez nawiązania połączenia jest błędem programowania”.

Jeśli piszesz funkcję, która nie dopuszcza nulljako prawidłowej wartości parametru, należy dodać @Nonnulladnotację do podpisu i użyć, Objects.requireNonNullaby sprawdzić, czy argument jest, nulli wyrzucić, NullPointerExceptionjeśli tak jest. @NonnullAdnotacja jest dla dokumentacji i dostarczy pomocnych ostrzeżeń w czasie kompilacji w niektórych przypadkach. Nie zapobiega nullprzekazywaniu w czasie wykonywania.

void doStuff(@Nonnull Object obj) {
    Objects.requireNonNull(obj, "obj must not be null");

    // do stuff...
}

Aktualizacja:@Nonnull adnotacja nie jest częścią standardowej biblioteki języka Java. Zamiast tego istnieje wiele konkurujących standardów z bibliotek stron trzecich (patrz Której adnotacji @NotNull Java należy użyć? ). To nie znaczy, że używanie go jest kiepskim pomysłem, tylko że nie jest to standard.

Zawsze wolę rzucić IllegalArgumentException zamiast twierdzeń.

Asercje są używane głównie w JUnit lub innych narzędziach testujących do sprawdzania / potwierdzania wyników testów. Może to dawać fałszywe wrażenie innym programistom, że twoja metoda jest metodą testową.

Sensowne jest także zgłoszenie wyjątku IllegalArgumentException, gdy do metody przekazano niedozwolony lub niewłaściwy argument . Jest to bardziej zgodne z konwencją obsługi wyjątków stosowaną przez programistów Java.

IMO drugi jest nieco lepszy, ponieważ przynosi więcej informacji i może być dalej rozszerzany (np. Poprzez rozszerzenie klasy wyjątków), aby był jeszcze bardziej pouczający, a także nie używa porównania negatywnego, które jest łatwiejsze do zrozumienia.

Nie używam często asertów, ale wspólne podejście z Lombock @NonNull: https://projectlombok.org/features/NonNull

Implementacja Lombok: import lombok.NonNull;

public class NonNullExample extends Something {
  private String name;

  public NonNullExample(@NonNull Person person) {
    super("Hello");
    this.name = person.getName();
  }
}

Wersja Java:

 import lombok.NonNull;

public class NonNullExample extends Something {
  private String name;

  public NonNullExample(@NonNull Person person) {
    super("Hello");
    if (person == null) {
      throw new NullPointerException("person");
    }
    this.name = person.getName();
  }
}

Lombok to naprawdę niezła biblioteka, z której korzystam wszędzie