[java] Java 코드에서 JSR 305 어노테이션을 사용하는 방법

29 Nov 2023

java

JSR 305는 자바 코드에서 코드 품질과 안정성을 향상시키기 위해 사용되는 어노테이션입니다. 이 어노테이션은 널 체크, 매개 변수 유효성 검사 등과 같은 일반적인 코드 리뷰 기능을 수행하며, 코드의 가독성과 유지 보수성을 향상시킵니다.

1. JSR 305 어노테이션 종류

JSR 305에서는 다양한 어노테이션을 제공합니다. 여기에서는 일부 일반적인 어노테이션에 대해 설명하겠습니다.

@Nonnull: 해당 매개 변수 또는 반환 값이 절대로 null이 될 수 없음을 표시합니다.
@Nullable: 해당 매개 변수 또는 반환 값이 null일 수 있다는 것을 표시합니다.
@CheckReturnValue: 해당 메서드의 반환 값을 무시하지 않도록 경고합니다.
@ReadOnly: 해당 매개 변수나 반환 값이 변경되지 않음을 표시합니다.

2. JSR 305 어노테이션 사용 방법

JSR 305 어노테이션을 사용하려면 다음 단계를 따르세요.

단계 1: 의존성 추가

먼저, 프로젝트에서 JSR 305 어노테이션을 사용하기 위해 다음 의존성을 추가해야 합니다.

dependencies {
    implementation 'com.google.code.findbugs:jsr305:3.0.2'
}

단계 2: 어노테이션 사용

Java 코드에서 JSR 305 어노테이션을 사용하려면 다음과 같이 어노테이션을 필드, 매개 변수 또는 반환 값에 적용합니다.

import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import javax.annotation.CheckReturnValue;
import javax.annotation.ReadOnly;

public class ExampleClass {
    
    public void exampleMethod(@Nonnull String parameter) {
        // 매개 변수가 null이 아님을 보장하는 코드
    }
    
    @Nullable
    public String exampleMethodWithNullable() {
        // null 값을 반환할 수 있는 메서드
        return null;
    }
    
    @CheckReturnValue
    public String exampleMethodWithReturnValue() {
        // 반환 값이 무시되지 않도록 경고
        return "example";
    }
    
    public void exampleImmutableMethod(@ReadOnly List<String> list) {
        // 매개 변수가 변경되지 않음을 표시
    }
}

위의 예시에서는 @Nonnull, @Nullable, @CheckReturnValue, @ReadOnly 어노테이션을 사용해 매개 변수, 반환 값, 메서드에 각각 적용했습니다.

3. JSR 305 어노테이션의 이점

JSR 305 어노테이션을 사용하면 다음과 같은 이점을 얻을 수 있습니다.

Null 체크: @Nonnull 어노테이션을 사용하여 null을 명시적으로 허용하지 않는 매개 변수를 식별하고, 경우에 따라 컴파일 시간에 경고를 표시합니다.
코드 리뷰: @CheckReturnValue 어노테이션을 사용하여 반환 값을 무시하지 않도록 경고를 표시하여 버그를 사전에 방지할 수 있습니다.
가독성 및 유지 보수성: @ReadOnly 어노테이션을 사용하여 변경되지 않는 매개 변수를 식별하여 코드의 의도를 명확히 전달하고 유지 보수성을 향상시킬 수 있습니다.

4. 결론

JSR 305 어노테이션은 자바 코드의 가독성과 유지 보수성을 향상시키는 데 도움이 되는 강력한 도구입니다. 의존성을 추가하고 어노테이션을 적용하여 코드 품질과 안정성을 향상시킬 수 있습니다.

더 자세한 내용은 JSR 305 스펙 문서를 참조하시기 바랍니다.