Java - Assertion(검증)
Java에서 프로그램 실행 중 오작동 하거나 비정상적으로 종료되는 경우에 대응하기 위해 다양한 방법을 사용할 수 있다.
assert문은try-catch에서throw exception과 비슷해 보이지만 사용하는 목적이 다르다.
assert문 형식
1
2
3
4
5
assert Expression1;
assert Expression1: Expression2;
// Ex
assert money >=0 : "money는 음수가 될 수 없다~";
Expression1- 조건 (거짓이면AssertionError발생)Expression2- 값,AssertionError인스턴스에 담길 메시지 (void메서드 X)
사실 동작만 보면 if문으로 조건을 걸고 throw exception하는 예외처리와 비슷해 보인다.
하지만 assert는 JVM 기본 설정에서는 실행 시 모두 제외된다. -ea(-enableassertions) 옵션을 사용해서 실행해야 assert이 동작한다. IDE에서는 Run Configurations에서 VM arguments에 추가해 실행한다.
C++에서는 디버그 모드에서만 컴파일되어 실행되고 릴리즈 모드에서는 컴파일러가
assert를 무시하고 제거한다.
assert의 목적
assert는 코드 실행 시 해당 조건이 참이라는 가정 하에 진행된다는 것을 명시하는 것이다. 코드 실행 중 발생하는 로직의 문제라기보단 개발 과정에서 이 조건을 상정하는 것이다.
assert 사용하기
Assertion을 사용하기 좋은 상황의 예시이다.
- 내부 불변성 (Internal Invariants)
- 제어 흐름 불변성 (Control-Flow Invariants)
- 사전 조건, 사후 조건, 클래스 불변성 (Preconditions, Postconditions, Class Invariants)
내부 불변성(Internal Invariants)
프로그램 과정 중 여기서 이 값을 가정한다는 것을 표현한다.
어떤 수를 3으로 나눈 뒤 나머지에 따라 다른 동작을 실행하는 예시를 들 수 있다.
1
2
3
4
5
6
7
if (i % 3 == 0) {
...
} else if (i % 3 == 1) {
...
} else {
// i % 3 == 2 인 상황
}
코드를 작성할 때 의도는 else에서 나머지가 2인 상황을 가정하는 것이다. 여기서 assert를 사용할 수 있다.
1
2
3
4
5
6
7
if (i % 3 == 0) {
...
} else if (i % 3 == 1) {
...
} else {
assert i % 3 == 2 : i;
}
위 코드가 실행되기 전 i가 음수였다면 AssertionError가 발생할 것이다. 디버깅하는 과정에서 AssertionError를 확인하고 i가 음수인 입력 상황을 미리 발견하고 수정할 수 있다.
가정을 검증하는 과정에서 예외 상황을 놓치지 않고 견고한 코드를 작성하는데 도움이 된다.
제어 흐름 불변성(Control-Flow Invariants)
프로그램 과정 중 도달할 수 없는 곳에 assert를 사용한다.
1
2
3
4
5
6
7
void method() {
...
if(...)
return;
assert false;
}
사실 이런 경우는 유의해서 사용하지 않는다면 대체로 컴파일 에러가 발생할 것이다.
프로그래머가 가정한 경우의 흐름을 벗어나는 경우에 assert를 사용하는 방식도 있다. 예시로 트럼프 카드의 문양에 따라 다른 동작을 한다고 해보자.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
switch(suit) {
case Suit.CLUBS:
...
break;
case Suit.DIAMONDS:
...
break;
case Suit.HEARTS:
...
break;
case Suit.SPADES:
...
break;
default:
assert false : suit;
}
트럼프 카드의 문양 4가지 이외의 경우에 도달하지 않게 하기 위해 assert를 사용할 수 있다. 이 과정에서 문양이 4종류인 것을 가정하는 것이라 내부 불변성과도 이어지는 내용이다.
사전 조건, 사후 조건, 클래스 불변성 (Preconditions, Postconditions, Class Invariants)
- 사전 조건 : 메서드 호출 시 참이여야 하는 상황
- 사후 조건 : 메서드 실행 후 침이여야 하는 상황
- 클래스 불변성 : 각 클래스의 인스턴스의 상태에 대해 참이여야 하는 상황
공간을 예약하는 메서드를 예시로 사전 조건, 사후 조건, 클래스 불변성의 예시를 들 수 있다.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
private Booking makeBooking(LocalDateTime startTime, LocalDateTime endTime) {
// 사전 조건: 시작 시간이 종료 시간보다 앞서야 한다.
assert startTime.isBefore(endTime) : "시작 시간이 종료 시간보다 뒤에 있습니다.";
Booking newBooking = new Booking(startTime, endTime);
bookings.add(newBooking);
// 클래스 불변성: bookings 리스트는 null이 아니어야 한다.
assert bookings != null : "bookings 리스트가 null입니다.";
// 사후 조건: 새로운 예약이 bookings 리스트에 추가되었는지 확인
assert bookings.contains(newBooking) : "예약이 정상적으로 추가되지 않았습니다.";
// 사후 조건: 예약 시간이 겹치지 않는지 확인
for (Booking booking : bookings) {
if (booking != newBooking && booking.overlaps(newBooking)) {
assert false : "새로운 예약과 기존 예약 시간이 겹칩니다.";
}
}
return newBooking;
}
assert 주의사항
public메서드의 인자에assert를 사용하지 말 것- 프로그램 동작에 필수인 작업을
assert에 넣지 말 것
큰 이유로는 두 경우 모두 assert가 비활성화 될 수 있기 때문이다.
public 메서드의 인자 검사는 항상 해당 조건을 보장해야 하기 때문에 기본적으로 실행되지 않는 assert는 이에 적합하지 않다.
같은 이유로 assert에 필수적인 작업을 하는 코드를 넣으면 실행되지 않을 수 있다. 예시로 assert names.remove(null); 같은 코드는 -ea 옵션을 실행 시 주지 않는 이상 동작하지 않는다. 따라서 remove()는 따로 실행하고 그 결과를 assert에서 확인하는 식으로 검증해야 한다.
assert 활용
assert 제거
Java에서 직접적으로 assert를 지울 수는 없지만 조건부 컴파일을 활용해서 지울 수 있다.
1
2
3
4
static final boolean asserts = ...; // false로 하면 assertions 제거
if (asserts)
assert ...;
asserts가 false면 컴파일 후 클래스 파일에서 assert가 제거되어 파일 크기가 줄어든다.
다만, 리소스가 매우 제약된 임베디드 또는 모바일 환경이나 클래스 로딩 시간이 중요한 경우가 아니라면 유의미한 성능 향상을 기대하긴 어렵다.
assert 요구
프로그래머가 원한다면 assert를 활성화하도록 요구할 수 있다. static 초기화 블럭에서 assert가 비활성화된 경우 exception을 발생시킬 수 있다.
1
2
3
4
5
6
static {
boolean assertsEnabled = false;
assert assertsEnabled = true; // 의도적인 side effect
if (!assertsEnabled)
throw new RuntimeException("Asserts must be enabled!!!");
}
assert가 활성화되었다면 assertsEnabled가 assert문에서 true로 변경되어 이후 조건문에 걸려 exception을 발생시킨다.