[java] JSR 305을 이용한 자바 코드 안정성 향상 방법

29 Nov 2023

java

자바 프로그래밍에서 코드 안정성은 매우 중요한 요소입니다. 안정성을 향상시키기 위해 여러 가지 방법이 있지만, 이번 글에서는 JSR 305를 이용한 방법에 대해 알아보겠습니다.

1. JSR 305이란?

JSR 305는 Java Specification Request 305의 약어로, 자바 코드 안정성을 개선하기 위한 명시적인 어노테이션을 제공합니다. 이 어노테이션을 사용하면 컴파일러가 코드를 분석하여 잠재적인 버그를 감지할 수 있게 됩니다.

2. JSR 305을 사용하는 방법

JSR 305은 다양한 어노테이션을 제공하며, 각각의 어노테이션은 특정한 상황에서의 안정성을 향상시키는 역할을 합니다. 이 중에서 가장 많이 사용되는 어노테이션은 다음과 같습니다.

2.1. @Nonnull

@Nonnull 어노테이션은 해당 메서드 또는 매개변수가 null이 아니어야 함을 명시합니다. 이 어노테이션을 사용하면 컴파일러가 null 체크를 수행하여 NullPointerException을 사전에 방지할 수 있습니다.

예시:

public void doSomething(@Nonnull String value) {
  // value를 사용하는 코드
}

2.2. @Nullable

@Nullable 어노테이션은 해당 메서드 또는 매개변수가 null일 수 있음을 명시합니다. 이 어노테이션을 사용하면 컴파일러가 null을 허용하는 코드를 경고할 수 있습니다.

예시:

public void processValue(@Nullable String value) {
  if (value != null) {
    // value를 사용하는 코드
  }
}

2.3. @CheckReturnValue

@CheckReturnValue 어노테이션은 해당 메서드의 반환값이 무시되는 것을 방지하기 위해 사용됩니다. 이 어노테이션이 붙은 메서드의 반환값을 사용하지 않으면 컴파일러가 경고를 발생시킵니다.

예시:

@CheckReturnValue
public int calculateSum(int a, int b) {
  return a + b;
}

public void processValues() {
  calculateSum(1, 2); // 반환값을 사용하지 않아 경고 발생
}

3. JSR 305 라이브러리 추가하기

JSR 305을 사용하기 위해서는 해당 라이브러리를 프로젝트에 추가해야 합니다. Maven을 사용한다면 다음과 같이 의존성을 추가하면 됩니다.

<dependency>
  <groupId>com.google.code.findbugs</groupId>
  <artifactId>jsr305</artifactId>
  <version>3.0.2</version>
</dependency>

Gradle을 사용한다면 다음과 같이 의존성을 추가하면 됩니다.

implementation 'com.google.code.findbugs:jsr305:3.0.2'

4. 결론

JSR 305을 이용하면 자바 코드의 안정성을 향상시킬 수 있습니다. @Nonnull, @Nullable, @CheckReturnValue 등의 어노테이션을 적절히 사용하여 컴파일러의 분석을 통해 잠재적인 문제를 사전에 방지할 수 있습니다. 프로젝트에 JSR 305 라이브러리를 추가하여 사용하는 것을 권장합니다.