java: local variables referenced from a lambda expression must be final or effectively final

시나리오

1. 긴 정수 배열에 대해 특정 작업을 반복해야 한다.
2. 중간 중간 진행 상황을 알고자 한다. 이를 위한 메서드 runTasks()를 다음과 같이 작성했다고 하자.

private static void runTasks(int[] array, Consumer<Integer> onProgressUpdate) {
  int tasksDone = 0;
  for (int element : array) {
    // 오래 걸리는 작업
    task(element);
    
    // 10개 작업이 끝날 때 마다 진행도 업데이트
    if (++tasksDone % 10 == 0) {
      onProgressUpdate.accept(tasksDone);
    }
  }
  
  if (tasksDone % 10 != 0) {
    onProgressUpdate.accept(tasksDone);
  }
}

public static void trackProgress() {
  int currentProgress = 0;
  runTasks(
      new int[] {},
      (progress) -> {
        System.out.println("진행 상황: " + progress);
        currentProgress = progress;
      });
}

에러의 원인

람다에서 지역 변수의 변경이 제한되는 이유

1. 람다는 자신을 둘러싼 외부 범위의 변수에 접근할 수 있다. (람다 캡처링, lambda capturing)
2. 람다는 메서드 실행 종료 후에도 비동기적으로 실행될 수 있지만, 지역 변수는 메서드 실행이 종료되면 스택에서 사라진다.
   1. 예를 들어, runTasks()에 전달된 람다를 클래스 멤버 변수로 저장해 놓았다고 생각해보자.
   2. trackProgress() 메서드가 종료되는 시점에 currentProgress 변수는 스택에서 할당 해제된다.
   3. 반면, 전달된 onProgressUpdated 람다 객체는 여전히 살아있다.

해결 방법

배열로 감싸기

private static void trackProgress() {
    int[] currentProgress = {0}; // 배열로 감싸기
    runTasks(
        new int[] {},
        (progress) -> {
            System.out.println("진행 상황: " + progress);
            currentProgress[0] = progress; // 배열 요소 변경
        });
}

장점

• 간단하고 빠르게 적용 가능: 코드를 크게 수정하지 않고도 문제를 해결할 수 있다.
• 기존 코드의 수정 최소화: 람다 표현식 외부의 코드를 거의 변경하지 않아도 된다.

단점

• 코드 가독성 저하: 배열을 사용하는 의도를 명확히 파악하기 어려워 코드 가독성이 떨어질 수 있다. 다른 개발자가 코드를 이해하기 어려울 수 있다.
• 멀티 스레드 환경에서 동기화 문제 발생 가능: 멀티 스레드 환경에서는 여러 스레드가 동시에 currentProgress[0] 값을 변경하려고 할 때 문제가 발생할 수 있다.

멤버 필드로 만들기

private static int currentProgress = 0; // 멤버 필드로 선언

private static void trackProgress() {
    runTasks(
        new int[] {},
        (progress) -> {
            System.out.println("진행 상황: " + progress);
            currentProgress = progress; // 멤버 필드 변경
        });
}

장점

• 람다 표현식 내부에서 직접 접근 가능: 람다 표현식 내부에서 currentProgress 변수에 직접 접근하여 값을 변경할 수 있으므로, 코드가 더 간결해진다.
• 코드 가독성 향상: 배열을 사용하는 것보다 의도를 파악하기 쉽고, 코드 가독성이 높아진다.

단점

• 멀티 스레드 환경에서 동기화 문제 발생 가능: 멀티 스레드 환경에서는 여러 스레드가 동시에 currentProgress 값을 변경하려고 할 때 문제가 발생할 수 있다.
• 객체 지향 설계 원칙에 어긋날 수 있음: 멤버 필드를 사용하면 클래스의 상태가 외부에 노출될 수 있으며, 이는 객체 지향 설계 원칙에 어긋날 수 있다.

AtomicInteger 사용하기

private static void trackProgress() {
    AtomicInteger currentProgress = new AtomicInteger(0); // AtomicInteger 사용
    runTasks(
        new int[] {},
        (progress) -> {
            System.out.println("진행 상황: " + progress);
            currentProgress.set(progress); // AtomicInteger 값 변경
        });
}

장점

• 멀티 스레드 환경에서 안전하게 값 변경 가능: AtomicInteger는 멀티 스레드 환경에서 발생할 수 있는 경쟁 조건(race condition) 문제를 해결하여 안전하게 값을 변경할 수 있도록 보장한다.
• Atomic 클래스의 다양한 기능 활용 가능: AtomicInteger는 getAndIncrement, getAndUpdate 등 다양한 메서드를 제공하여 원자적인 연산을 수행할 수 있도록 지원한다.

단점

• Atomic 클래스 사용에 대한 이해 필요: AtomicInteger 클래스를 사용하려면 Atomic 클래스에 대한 기본적인 이해가 필요하다.
• 박싱/언박싱 오버헤드 발생 가능: AtomicInteger는 내부적으로 int 값을 객체로 감싸기 때문에, 박싱/언박싱 오버헤드가 발생할 수 있다. 하지만 대부분의 경우 성능에 큰 영향을 미치지 않는다.

마무리