[java] JSR 305 어노테이션의 다양한 사용 사례 및 팁

29 Nov 2023

java

소개

JSR 305 어노테이션은 Java 언어에서 코드 분석 도구나 정적 분석 도구를 통해 경고 및 오류를 검출하는 데 사용됩니다. 이러한 어노테이션은 주석으로 코드에 추가되며, 코드의 의도를 명확하게 전달하고 잠재적인 버그를 미리 예방하는 데 도움을 줍니다.

종류

JSR 305 어노테이션은 다양한 용도로 사용될 수 있으며, 주요 어노테이션 몇 가지를 살펴보겠습니다:

@Nonnull : 해당 매개변수 또는 반환 타입이 null이 될 수 없음을 나타냅니다.
@Nullable : 해당 매개변수 또는 반환 타입이 null이 될 수 있음을 나타냅니다.
@CheckForNull : 해당 매개변수 또는 반환 타입이 null이 될 수 있는지 검사하는 메서드를 호출한 결과를 검사합니다.
@CheckReturnValue : 해당 메서드의 반환 값을 사용하지 않을 경우 경고를 발생시킵니다.
@GuardedBy : 해당 필드 또는 메서드의 동기화를 담당하는 객체를 지정합니다.

사용 예시

@Nonnull / @Nullable

public void processString(@Nonnull String str) {
    // str은 null일 수 없음
    // 문자열 처리 로직
}

@Nullable
public String getData() {
    // 데이터 반환 로직
    return null; // null일 수도 있음
}

@CheckForNull

public void processUser(@CheckForNull User user) {
    // user가 null인 경우 처리 로직
    if (user != null) {
        // 유효한 사용자 처리 로직
    }
}

@CheckReturnValue

@CheckReturnValue
public Result calculateResult() {
    // 계산 로직
    return result;
}

public void useResult(Result result) {
    // 반환 값을 사용하지 않을 경우 경고 발생
    // 결과 처리 로직
}

@GuardedBy

public class ThreadSafeCounter {
    private final Object lock = new Object();

    @GuardedBy("lock")
    private int count = 0;

    public void increment() {
        synchronized (lock) {
            // 동기화된 코드 블록
            count++;
        }
    }
}

팁

JSR 305 어노테이션은 코드 문서화에도 도움이 됩니다. 메서드나 클래스에 어노테이션을 사용하여 null 여부나 사용되는 동기화 객체 등을 명시할 수 있습니다.
코드 분석 도구를 사용할 때 어노테이션에 대한 경고 값을 조정할 수 있습니다. 개발 환경에 따라 필요한 경고 수준을 선택하여 최적화된 결과를 얻을 수 있습니다.

결론

JSR 305 어노테이션은 Java 코드의 가독성과 안정성을 향상시키는 데 도움을 주는 강력한 도구입니다. 알맞게 사용하면 코드의 오류를 사전에 예방하고 다른 개발자가 코드를 이해하고 유지보수하는 데 도움이 될 수 있습니다.

소개

종류

사용 예시

@Nonnull / @Nullable

@CheckForNull

@CheckReturnValue

@GuardedBy

팁

결론

참고 자료