[Android] Jetpack - LiveData

LiveData를 프로젝트에 import하는 방법은 프로젝트에 컴포넌트 추가하기 참고

LiveData

• Observable Data Holder Class
• Lifecycle-aware
  • Activity, Fragment, Service 같은 앱 컴포넌트의 Lifecycle과 연관
  • 활성화(active) 상태(STARTED 또는 RESUMED)인 Observer에게만 업데이트를 알림
• LifecycleOwner의 Lifecycle이 DESTROYED 상태가 되면 Observer를 제거
  • leak에 대한 걱정없이 안전하게 LiveData를 observe 가능
  • Activity와 Fragment에서 특히 유용

LiveData 사용법에 대한 더 많은 정보는 Work with LiveData objects

LiveData 사용의 장점

1. UI와 데이터 상태 일치 보장

2. 메모리 릭 X

연결된 Lifecycle이 destroyed 상태가 되면 알아서 제거

3. 중지된 액티비티로 인한 크래시 X

비활성화 상태(예, 백스택에 있는 Activity)이면 어떤 LiveData 이벤트도 받지 않음

4. 직접 Lifecycle을 다룰 필요 X

5. 항상 최신의 데이터

Lifecycle이 비활성화 -> 활성화 상태로 돌아오면 가장 최신의 데이터를 받음 예) Activity가 백그라운드에 있다가 foreground로 돌아온 직후 최신의 데이터를 받음

6. 적절한 configuration changes 처리 가능

화면 회전과 같은 configuration change로 인해 Activity나 Fragment가 재생성된 경우, 가장 최신의 유효한 데이터를 즉시 받음

7. 자원 공유

LiveData를 확장하여 시스템 서비스를 감싸는 싱글톤으로 만들어서 앱에서 공유 가능 시스템 서비스와 LiveData를 한 번 연결해놓으면, 시스템 서비스가 필요한 Observer는 LiveData만 바라보면 됨 자세한 내용은 아래 LiveData 확장 파트 참고

LiveData 사용하기

1. 특정 타입의 데이터를 담는 LiveData 인스턴스 생성 (보통 ViewModel 안에서)
2. Observer 생성 및 onChanged() 메서드 정의 (보통 Activity/Fragment 같은 UI 컨트롤러 안에서)
3. observe() 메서드를 통해 Observer와 LiveData 연결 (보통 Activity/Fragment 같은 UI 컨트롤러 안에서)

observeForever(Observer)를 이용하여 LifecycleOwner 없이 Observer를 등록할 수 있습니다. 이 경우 Observer가 항상 활성화 상태로 인지되기 때문에 변화에 대한 알림을 항상 받게 됩니다. removeObserver(Observer) 메서드를 통해 Observer를 제거할 수 있습니다.

LiveData 생성

LiveData는 Collections 구현체를 포함한 모든 타입의 데이터를 담을 수 있습니다. 보통 LiveData는 아래 예제처럼 ViewModel 안에 저장되며, getter를 통해 접근됩니다. 초기에 LiveData 값은 설정되지 않습니다.

public class NameViewModel extends ViewModel {

// String 데이터를 갖는 LiveData
private MutableLiveData<String> currentName;

    public MutableLiveData<String> getCurrentName() {
        if (currentName == null) {
            currentName = new MutableLiveData<String>();
        }
        return currentName;
    }

// Rest of the ViewModel...
}

LiveData를 Activity/Fragment가 아닌 ViewModel에 저장하세요.

- Activity/Fragment 크기가 너무 커지는 것을 방지하기 위해,
    - 이제 UI 컨트롤러의 역할은 데이터를 표시하는 것이지 데이터를 가지고 있는 것이 아닙니다.
- Configuration change가 발생해도 LiveData는 유지되도록 특정 Activity/Fragment와 LiveData 인스턴스를 분리해야 합니다.

LiveData 구독하기

대부분의 경우, 앱 컴포넌트의 onCreate() 시점이 구독을 시작하기에 적절합니다.

• Activity/Fragment 의 onReume()에 정의했을 때의 불필요한 호출을 방지하기 위해
• Activity/Fragment가 활성화된 후 최대한 빨리 데이터를 표시하기 위해

구독 시작에 대한 예제 코드:

public class NameActivity extends AppCompatActivity {

    private NameViewModel model;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);

        // Other code to setup the activity...

        // Get the ViewModel.
        model = ViewModelProviders.of(this).get(NameViewModel.class);


        // Create the observer which updates the UI.
        final Observer<String> nameObserver = new Observer<String>() {
            @Override
            public void onChanged(@Nullable final String newName) {
                // Update the UI, in this case, a TextView.
                nameTextView.setText(newName);
            }
        };

        // Observe the LiveData, passing in this activity as the LifecycleOwner and the observer.
        model.getCurrentName().observe(this, nameObserver);
    }
}

nameObserver.observe()가 호출되면 mCurrentName의 가장 최신 값을 즉시 onChanged()로 전달받게 됩니다. LiveData에 값이 아직 설정되지 않았다면 onChanged()는 호출되지 않습니다.

LiveData 업데이트

LiveData는 저장된 값을 갱신하는 public 함수를 제공하지 않습니다. LiveData에 저장된 값을 변경할 필요가 있는 경우 setValue(T)/postValue(T)를 제공하는 MutableLiveData를 사용해야 합니다. 보통 MutableLiveData는 ViewModel 안에서만 사용하고, ViewModel은 Observer에 변경 불가능한 LiveData만 공개합니다.

LiveData 업데이트 예제:

button.setOnClickListener(new OnClickListener() {
    @Override
    public void onClick(View v) {
        String anotherName = "John Doe";
        model.getCurrentName().setValue(anotherName);
    }
});

메인 스레드에서 LiveData를 업데이트 하는 경우에는 반드시 setValue(T) 사용
만약 워커 스레드에서 코드가 실행된다면 postValue(T) 사용

Room과 함께 사용하기

Room 라이브러리는 LiveData를 반환하는 Observable 쿼리를 지원합니다. Room은 데이터베이스가 변경됐을 때 LiveData를 업데이트하는 데 필요한 모든 코드를 생성해줍니다. 생성된 코드는 필요한 경우 백그라운드에서 비동기적으로 쿼리를 실행합니다. 데이터베이스의 데이터와 UI를 항상 동기적으로 유지하기에 유용합니다. Room과 DAO에 대해서는 Room 가이드 에서 더 자세히 볼 수 있습니다.

Coroutine과 함께 사용하기

LiveData는 Kotlin coroutines도 지원합니다. 자세한 내용은 Android App Component와 Kotlin coroutine 사용하기 참고

LiveData 확장

public class StockLiveData extends LiveData<BigDecimal> {
    private StockManager stockManager;

    private SimplePriceListener listener = new SimplePriceListener() {
        @Override
        public void onPriceChanged(BigDecimal price) {
            setValue(price);
        }
    };

    public StockLiveData(String symbol) {
        stockManager = new StockManager(symbol);
    }

    @Override
    protected void onActive() {
        stockManager.requestPriceUpdates(listener);
    }

    @Override
    protected void onInactive() {
        stockManager.removeUpdates(listener);
    }
}

• onActive(): 활성화 Observer가 있을 때 호출. 주식 가격 변화에 대한 구독을 이 메서드에서 시작해야 합니다.
• onInactive(): 활성화 Observer가 하나도 없을 때 호출. Observer가 하나도 없으므로 StockManager와 연결을 유지할 필요가 없습니다.
• setValue(T) LiveData가 Lifecycle을 알고 있기 때문에 여러 Activity/Fragment/Service 간 공유가 가능합니다.

LiveData를 싱글톤으로 만든 예제:

public class StockLiveData extends LiveData<BigDecimal> {
    private static StockLiveData sInstance;
    private StockManager stockManager;

    private SimplePriceListener listener = new SimplePriceListener() {
        @Override
        public void onPriceChanged(BigDecimal price) {
            setValue(price);
        }
    };

    @MainThread
    public static StockLiveData get(String symbol) {
        if (sInstance == null) {
            sInstance = new StockLiveData(symbol);
        }
        return sInstance;
    }

    private StockLiveData(String symbol) {
        stockManager = new StockManager(symbol);
    }

    @Override
    protected void onActive() {
        stockManager.requestPriceUpdates(listener);
    }

    @Override
    protected void onInactive() {
        stockManager.removeUpdates(listener);
    }
}

아래 예제처럼 Fragment에서 사용:

public class MyFragment extends Fragment {
    @Override
    public void onActivityCreated(Bundle savedInstanceState) {
        StockLiveData.get(symbol).observe(this, price -> {
            // Update the UI.
        });
    }
}

LiveData 변형

• Observer에 전달하기 전에 값을 변경하고 싶은 경우
• 다른 값에 기반하여 다른 LiveData를 반환하고 싶은 경우

Lifecycle 패키지는 이런 경우를 위한 Transformations 클래스를 제공함

Transformations.map()

LiveData의 값에 함수를 적용시키고, 그 결과 값을 전달

LiveData<User> userLiveData = ...;
LiveData<String> userName = Transformations.map(userLiveData, user -> {
    user.name + " " + user.lastName
});

Transformations.switchMap()

map()과 유사하게 LiveData의 값에 함수를 적용시키고, 그 결과 값을 전달하지만, switchMap()의 리턴 타입은 LiveData

private LiveData<User> getUser(String id) {
  ...;
}

LiveData<String> userId = ...;
LiveData<User> user = Transformations.switchMap(userId, id -> getUser(id) );

Transformations는 반환된 LiveData를 구독하는 Observer가 없으면 변형을 적용하지 않습니다. Transformations는 lazy 연산이기 때문에, Lifecycle과 연관된 동작은 명시적인 호출이나 의존성의 필요없이 동작합니다.

ViewModel 객체 안에서 LiveData가 필요한 경우, Transformations는 더 좋은 방안이 될 수 있습니다. UI 컴포넌트가 주소와 그 주소에 해당하는 우편 번호를 받는다고 가정할 때, 잘 모르고 작성한 ViewModel 코드는 아래와 같을 수 있습니다:

class MyViewModel extends ViewModel {
    private final PostalCodeRepository repository;
    public MyViewModel(PostalCodeRepository repository) {
       this.repository = repository;
    }

    private LiveData<String> getPostalCode(String address) {
       // DON'T DO THIS
       return repository.getPostCode(address);
    }
}

이렇게 하면 UI 컴포넌트에서 getPostalCode()를 호출할 때마다 이전 LiveData의 구독을 해지하고, 새로운 LiveData를 구독해야 합니다. 게다가 UI 컴포넌트가 재생성됐을 때, 이전 호출의 결과를 사용하지 않고 repository.getPostCode()를 또 다시 호출하게 됩니다.

주소에 따라 우편 번호를 찾는 로직을 Transformations를 이용하여 아래처럼 구현할 수 있습니다:

class MyViewModel extends ViewModel {
    private final PostalCodeRepository repository;
    private final MutableLiveData<String> addressInput = new MutableLiveData();
    public final LiveData<String> postalCode =
            Transformations.switchMap(addressInput, (address) -> {
                return repository.getPostCode(address);
             });

  public MyViewModel(PostalCodeRepository repository) {
      this.repository = repository
  }

  private void setInput(String address) {
      addressInput.setValue(address);
  }
}

postalCode는 addressInput의 변형으로 정의됩니다. postalCode와 연결된 활성화 상태의 Observer가 있고, addressInput이 변경되면 postalCode의 값을 다시 계산합니다.

새로운 변형 생성하기

아주 다양한 변형 방법이 있지만, 디폴트로 제공되지는 않습니다. 원하는 변형을 구현하고 싶은 경우 MediatorLiveData를 사용하면 됩니다. 자세한 내용은 https://developer.android.com/reference/androidx/lifecycle/Transformations.html?hl=ko

여러 LiveData 합치기

MediatorLiveData는 LiveData의 서브클래스로, 여러 LiveData를 합칠 수 있게 해줍니다. MediatorLiveData는 LiveData들 중 하나라도 변경되면 Observer에 변경을 알립니다.

예, 로컬 데이터베이스 또는 네트워크가 변경될 때 UI가 변경된다면, 아래처럼 MediatorLiveData에 LiveData를 추가할 수 있습니다.

• 데이터베이스에 저장된 데이터에 대한 LiveData
• 네트워크로 접근하는 데이터에 대한 LiveData

더 자세한 예제는 App Architecture 가이드의 Addendum: exposing network status 파트 참고

추가 자료

Samples

• Sunflower, a demo app demonstrating best practices with Architecture Components
• Android Architecture Components Basic Sample

Codelabs

• Android Room with a View (Java) (Kotlin)

Blogs

• ViewModels and LiveData: Patterns + AntiPatterns
• LiveData beyond the ViewModel — Reactive patterns using Transformations and MediatorLiveData
• LiveData with SnackBar, Navigation and other events (the SingleLiveEvent case)

Videos

• Jetpack LiveData
• Fun with LiveData (Android Dev Summit ‘18)