[java] Java assert 키워드는 무엇을하며 언제 사용해야합니까?

어설 션은 코드에서 버그를 포착하는 개발 단계 도구입니다. 그것들은 쉽게 제거되도록 설계되었으므로 프로덕션 코드에는 존재하지 않습니다. 따라서 어설 션은 고객에게 제공하는 “솔루션”의 일부가 아닙니다. 그들은 가정이 올바른지 확인하기 위해 내부 검사입니다. 가장 일반적인 예는 null을 테스트하는 것입니다. 많은 방법이 다음과 같이 작성됩니다 :

void doSomething(Widget widget) {
  if (widget != null) {
    widget.someMethod(); // ...
    ... // do more stuff with this widget
  }
}

이와 같은 방법에서 위젯은 단순히 null이되지 않아야합니다. 따라서 null이면 코드에 추적해야 할 버그가 있습니다. 그러나 위의 코드는 이것을 알려주지 않습니다. 따라서 “안전한”코드를 작성하려는 의도적 인 노력으로 버그를 숨기고 있습니다. 다음과 같은 코드를 작성하는 것이 훨씬 좋습니다.

/**
 * @param Widget widget Should never be null
 */
void doSomething(Widget widget) {
  assert widget != null;
  widget.someMethod(); // ...
    ... // do more stuff with this widget
}

이런 식으로이 버그를 일찍 잡을 수 있습니다. 계약에서이 매개 변수가 널이 아니어야 함을 지정하는 것도 유용합니다. 개발 중에 코드를 테스트 할 때 어설 션을 설정해야합니다. (그리고 동료들에게 이것을하도록 설득하는 것도 종종 어렵 기 때문에 매우 성가시다.)

이제 일부 동료는이 코드에 반대하여 프로덕션에서 예외를 방지하기 위해 여전히 null 검사를 수행해야한다고 주장합니다. 이 경우 어설 션은 여전히 ​​유용합니다. 다음과 같이 작성할 수 있습니다.

void doSomething(Widget widget) {
  assert widget != null;
  if (widget != null) {
    widget.someMethod(); // ...
    ... // do more stuff with this widget
  }
}

이런 식으로 동료들은 프로덕션 코드에 대해 null 검사가 있다는 것을 기쁘게 생각하지만 개발 중에 위젯이 null 일 때 더 이상 버그를 숨기지 않습니다.

실제 예는 다음과 같습니다. 두 번의 임의의 값이 동일한 지 비교하는 방법을 작성했습니다. 두 값 중 하나가 null 일 수 있습니다.

/**
 * Compare two values using equals(), after checking for null.
 * @param thisValue (may be null)
 * @param otherValue (may be null)
 * @return True if they are both null or if equals() returns true
 */
public static boolean compare(final Object thisValue, final Object otherValue) {
  boolean result;
  if (thisValue == null) {
    result = otherValue == null;
  } else {
    result = thisValue.equals(otherValue);
  }
  return result;
}

이 코드 equals()는 thisValue가 null이 아닌 경우 메서드 작업을 위임합니다 . 그러나이 equals()방법 equals()이 null 매개 변수를 올바르게 처리 하여 계약을 올바르게 이행 한다고 가정합니다 .

동료가 내 코드에 반대하여 많은 클래스 equals()에 null을 테스트하지 않는 버그가있는 메소드가 있다고 알려주 므로이 검사를 체크해야합니다. 이것이 현명하거나 오류를 강제해야한다면 논쟁의 여지가 있습니다. 따라서 오류를 발견하고 수정할 수는 있지만 동료에게 연기하고 null 확인을했으며 주석으로 표시했습니다.

public static boolean compare(final Object thisValue, final Object otherValue) {
  boolean result;
  if (thisValue == null) {
    result = otherValue == null;
  } else {
    result = otherValue != null && thisValue.equals(otherValue); // questionable null check
  }
  return result;
}

여기서 추가 검사 는 계약에서 요구 한대로 메소드가 널을 검사하지 못하는 other != null경우에만 필요합니다 equals().

버그가있는 코드를 코드 기반으로 유지하는 데 대한 지혜에 대해 동료들과 결실없는 토론에 참여하기보다는 코드에 두 가지 주장 만 썼습니다. 이 어설 션은 개발 단계에서 클래스 중 하나가 equals()제대로 구현 되지 않으면 알려 줄 수 있습니다.

public static boolean compare(final Object thisValue, final Object otherValue) {
  boolean result;
  if (thisValue == null) {
    result = otherValue == null;
    assert otherValue == null || otherValue.equals(null) == false;
  } else {
    result = otherValue != null && thisValue.equals(otherValue);
    assert thisValue.equals(null) == false;
  }
  return result;
}

명심해야 할 중요한 사항은 다음과 같습니다.

1. 어설 션은 개발 단계 도구 일뿐입니다.

2. 주장의 요점은 코드뿐만 아니라 코드 기반에도 버그가 있는지 알려주는 것 입니다. (여기의 주장은 실제로 다른 클래스의 버그를 표시합니다.)

3. 동료가 수업이 제대로 작성되었다고 확신하더라도 여기에있는 주장이 여전히 유용 할 것입니다. null 테스트에 실패 할 수있는 새로운 클래스가 추가 될 예정이며이 메서드는 이러한 버그를 플래그로 지정할 수 있습니다.

4. 개발 중에는 작성한 코드가 어설 션을 사용하지 않더라도 항상 어설 션을 설정해야합니다. 내 IDE는 새로운 실행 파일에 대해 항상 기본적 으로이 작업을 수행하도록 설정되어 있습니다.

5. 어설 션은 프로덕션 환경에서 코드의 동작을 변경하지 않으므로 동료는 null 검사가 있고 equals()메소드가 버그가 있어도이 메소드가 제대로 실행된다는 것을 기쁘게 생각합니다 . equals()개발에서 버그가있는 방법을 잡을 수 있기 때문에 행복 합니다.

또한 실패 할 임시 어설 션을 넣어 어설 션 정책을 테스트해야하므로 로그 파일 또는 출력 스트림의 스택 추적을 통해 알림을받을 수 있습니다.

답변

switch (fruit) {
  case apple:
    // do something
    break;
  case pear:
    // do something
    break;
  case banana:
    // do something
    break;
}

switch (fruit) {
  case apple:
    // do something
    break;
  case pear:
    // do something
    break;
  case banana:
    // do something
    break;
  default:
    assert false : "Missing enum value: " + fruit;
}

public class Assert {
    public static void main(String[] args) {
        assert System.currentTimeMillis() == 0L;
    }
}

public class Assert {
    static final boolean $assertionsDisabled =
        !Assert.class.desiredAssertionStatus();
    public static void main(String[] args) {
        if (!$assertionsDisabled) {
            if (System.currentTimeMillis() != 0L) {
                throw new AssertionError();
            }
        }
    }
}

javac Assert.java
javap -c -constants -private -verbose Assert.class

static final boolean $assertionsDisabled;
  descriptor: Z
  flags: ACC_STATIC, ACC_FINAL, ACC_SYNTHETIC

 0: ldc           #6                  // class Assert
 2: invokevirtual #7                  // Method java/lang Class.desiredAssertionStatus:()Z
 5: ifne          12
 8: iconst_1
 9: goto          13
12: iconst_0
13: putstatic     #2                  // Field $assertionsDisabled:Z
16: return

 0: getstatic     #2                  // Field $assertionsDisabled:Z
 3: ifne          22
 6: invokestatic  #3                  // Method java/lang/System.currentTimeMillis:()J
 9: lconst_0
10: lcmp
11: ifeq          22
14: new           #4                  // class java/lang/AssertionError
17: dup
18: invokespecial #5                  // Method java/lang/AssertionError."<init>":()V
21: athrow
22: return