Лучше использовать assert или IllegalArgumentException для обязательных параметров метода?

В Java, что более рекомендуется и почему? Оба типа будут генерировать исключения, поэтому обработка их одинакова. assertнемного короче, но я не уверен, насколько это важно.

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

против

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

BEWARE!

Утверждения удаляются во время выполнения, если вы явно не укажете «включить утверждения» при компиляции кода. Утверждения Java не должны использоваться в производственном коде и должны быть ограничены частными методами (см. « Исключение против утверждения» ), поскольку ожидается, что частные методы будут известны и будут использоваться только разработчиками. Также assertвыдает AssertionError, которая Errorне распространяется Exceptionи которая обычно указывает на то, что у вас есть очень ненормальная ошибка (например, «OutOfMemoryError», с которой трудно восстановиться, не так ли?), Которую вы не должны лечить.

Удалите флаг «включить утверждения» и проверьте с помощью отладчика, и вы увидите, что вы не будете вмешиваться в вызов вызова IllegalArgumentException ... так как этот код не был скомпилирован (опять же, когда удаляется «ea»)

Лучше использовать вторую конструкцию для открытых / защищенных методов, и если вы хотите что-то, что делается в одной строке кода, есть по крайней мере один из известных мне способов. Я лично использую класс Spring Framework , в Assertкотором есть несколько методов для проверки аргументов и которые выдают «IllegalArgumentException» при сбое. В основном, что вы делаете:

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

... Который на самом деле будет выполнять тот же код, который вы написали во втором примере. Есть несколько других полезных методов, таких как hasText, hasLengthтам.

Я не люблю писать больше кода, чем необходимо, поэтому я счастлив, когда сокращаю количество написанных строк на 2 (2 строки> 1 строка) :-)

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

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

Например, утверждение

assert myConnection.isConnected();

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

С другой стороны, чек

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

означает, что «вызов моей библиотеки без установления соединения является ошибкой программирования».

Если вы пишете функцию, которая не допускает nullв качестве допустимого значения параметра, вы должны добавить @Nonnullаннотацию к сигнатуре и использовать ее, Objects.requireNonNullчтобы проверить, является ли аргумент аргументом, nullи бросить a, NullPointerExceptionесли он есть. @NonnullАннотации для документации и будут предоставлять полезные предупреждения во время компиляции в некоторых случаях. Это не мешает nullбыть переданным во время выполнения.

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

    // do stuff...
}

Обновление:@Nonnull аннотации не является частью стандартной библиотеки Java. Вместо этого существует множество конкурирующих стандартов от сторонних библиотек (см. Какую аннотацию @NotNull Java следует использовать? ). Это не значит, что это плохая идея, просто это не стандартно.

Я всегда предпочитаю бросать IllegalArgumentException поверх утверждений.

Утверждения используются в основном в JUnit или других инструментах тестирования для проверки / подтверждения результатов тестирования. Поэтому другим разработчикам может показаться, что ваш метод является тестовым.

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

IMO второй немного лучше, потому что он приносит больше информации и может быть расширен (например, путем расширения класса исключений), чтобы быть еще более информативным, также он не использует отрицательное сравнение, которое легче понять.

Я не часто использую aserts, но общий подход с Lombock @NonNull: https://projectlombok.org/features/NonNull

Реализация Lombok: импорт lombok.NonNull;

public class NonNullExample extends Something {
  private String name;

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

Версия 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 - действительно неплохая библиотека, которую я использую везде