introduce-assertion

Introduce Assertion

GOAL

코드가 암묵적으로 가정하는 조건을 assertion으로 명시하여:

• 가정 위반 시 즉시 발견 (원인과 증상의 거리 단축)
• 주석보다 강력한 실행 가능한 문서
• 계약 기반 프로그래밍의 경량 버전

CONSTRAINTS

• 계열: Tidy — 후보 보고 후 승인 없이 적용 (../../references/refactoring-procedure.md §0·§3-A)
• 동작 변경 금지: assertion 추가만 수행 (기존 로직 변경 없음)
• 테스트 수정 금지: assertion 추가가 테스트를 실패시키면 되돌리기
• 명시적 git add: git add -A 금지, 변경된 파일만 명시

Assertion 도구 선택 (프로젝트 의존성 자동 감지)

프로젝트의 빌드 파일(build.gradle 또는 pom.xml)을 확인하여 자동 선택:

1. Spring 의존성 있음 → org.springframework.util.Assert
2. Apache Commons 있음 → org.apache.commons.lang3.Validate
3. 둘 다 없음 → java.util.Objects.requireNonNull + IllegalArgumentException

Java assert 키워드는 -ea 플래그가 필요하여 프로덕션에서 비활성화될 수 있으므로 사용하지 않음

적용 패턴

Before: 암묵적 가정 (Spring Assert)

public double calculateDiscount(double price, double rate) {
    // price는 양수, rate는 0~1 사이여야 함 (주석 또는 아무것도 없음)
    return price * rate;
}

After: assertion으로 가정 명시

import org.springframework.util.Assert;

public double calculateDiscount(double price, double rate) {
    Assert.isTrue(price > 0, "price must be positive: " + price);
    Assert.isTrue(rate >= 0 && rate <= 1, "rate must be between 0 and 1: " + rate);
    return price * rate;
}

추가 예시: Apache Commons Validate

import org.apache.commons.lang3.Validate;

public String formatName(Customer customer) {
    Validate.notNull(customer, "customer must not be null");
    Validate.notBlank(customer.getFirstName(), "firstName must not be blank");
    return customer.getFirstName() + " " + customer.getLastName();
}

추가 예시: 사후 조건 (결과 검증)

public int allocateSlots(int requested, int available) {
    int allocated = Math.min(requested, available);
    Assert.isTrue(allocated >= 0, "allocated slots must not be negative: " + allocated);
    Assert.isTrue(allocated <= available, "allocated exceeds available: " + allocated + " > " + available);
    return allocated;
}

적용 기준

적용 대상

• 메서드가 특정 조건을 가정하지만 명시하지 않은 경우
• 내부 메서드(private/package-private)의 전제 조건
• 계산 결과의 사후 조건 (결과값 범위 검증)
• 알고리즘의 불변식 (invariant)
• null이 아닌 것을 암묵적으로 가정하는 경우