안정성 문제 해결

성능 문제를 일으키는 불안정한 클래스가 있는 경우 안정적으로 만들어야 합니다. 이 문서에서는 이를 위해 사용할 수 있는 몇 가지 기법을 간략히 설명합니다.

강력한 건너뛰기 사용 설정

먼저 강력한 건너뛰기 모드를 사용 설정해 보세요. 강력한 건너뛰기 모드를 사용하면 매개변수가 불안정한 컴포저블을 건너뛸 수 있으며 안정성으로 인해 발생하는 성능 문제를 해결하는 가장 쉬운 방법입니다.

자세한 내용은 강력한 건너뛰기를 참고하세요.

클래스를 변경할 수 없게 만들기

불안정한 클래스를 완전히 불변으로 만들 수도 있습니다.

  • 불변: 해당 유형의 인스턴스가 생성된 후에는 속성 값을 변경할 수 없으며 모든 메서드가 참조적으로 투명한 유형을 나타냅니다.
    • 클래스의 모든 속성이 var이 아닌 val이고 불변 유형인지 확인합니다.
    • String, Int, Float과 같은 기본 유형은 항상 변경할 수 없습니다.
    • 이것이 불가능한 경우 변경 가능한 속성에 Compose 상태를 사용해야 합니다.
  • 안정: 변경 가능한 유형을 나타냅니다. Compose 런타임은 유형의 공개 속성이나 메서드 동작이 이전 호출과 다른 결과를 생성하는지 여부와 시기를 알지 못합니다.

불변 컬렉션

Compose에서 클래스를 불안정하다고 간주하는 일반적인 이유는 컬렉션입니다. 안정성 문제 진단 페이지에 설명된 대로 Compose 컴파일러는 List, Map, Set과 같은 컬렉션이 실제로 변경 불가능한지 완전히 확신할 수 없으므로 불안정으로 표시합니다.

이 문제를 해결하려면 불변 컬렉션을 사용하면 됩니다. Compose 컴파일러에는 Kotlinx Immutable Collections 지원이 포함되어 있습니다. 이러한 컬렉션은 변경할 수 없으며 Compose 컴파일러는 이를 변경할 수 없는 것으로 취급합니다. 이 라이브러리는 아직 알파 단계이므로 API가 변경될 수 있습니다.

안정성 문제 진단 가이드의 불안정한 클래스를 다시 살펴보세요.

unstable class Snack {
  …
  unstable val tags: Set<String>
  …
}

불변 컬렉션을 사용하여 tags을 안정적으로 만들 수 있습니다. 클래스에서 tags의 유형을 ImmutableSet<String>로 변경합니다.

data class Snack{
    …
    val tags: ImmutableSet<String> = persistentSetOf()
    …
}

이렇게 하면 클래스의 모든 매개변수가 변경 불가능해지고 Compose 컴파일러가 클래스를 안정적인 것으로 표시합니다.

Stable 또는 Immutable 주석을 답니다.

안정성 문제를 해결하는 한 가지 방법은 불안정한 클래스에 @Stable 또는 @Immutable 주석을 추가하는 것입니다.

클래스에 주석을 다는 것은 컴파일러가 클래스에 관해 추론하는 내용을 재정의하는 것입니다. !! 연산자(Kotlin)와 유사합니다. 이러한 주석을 사용하는 방법에 매우 주의해야 합니다. 컴파일러 동작을 재정의하면 예상대로 컴포저블이 재구성되지 않는 등 예기치 않은 버그가 발생할 수 있습니다.

주석 없이 클래스를 안정화할 수 있다면 그런 방식으로 안정화를 달성해야 합니다.

다음 스니펫은 불변으로 주석이 지정된 데이터 클래스의 최소한의 예를 보여줍니다.

@Immutable
data class Snack(
…
)

@Immutable 또는 @Stable 주석을 사용하는지 여부에 관계없이 Compose 컴파일러는 Snack 클래스를 안정적으로 표시합니다.

컬렉션의 주석이 달린 클래스

List<Snack> 유형의 매개변수가 포함된 컴포저블을 고려해 보세요.

restartable scheme("[androidx.compose.ui.UiComposable]") fun HighlightedSnacks(
  …
  unstable snacks: List<Snack>
  …
)

Snack에 @Immutable 주석을 달더라도 Compose 컴파일러는 여전히 HighlightedSnacks의 snacks 매개변수를 불안정으로 표시합니다.

매개변수는 컬렉션 유형과 관련하여 클래스와 동일한 문제가 있습니다. 안정적인 유형의 컬렉션인 경우에도 Compose 컴파일러는 항상 List 유형의 매개변수를 불안정으로 표시합니다.

개별 매개변수를 안정적으로 표시할 수 없으며 항상 건너뛸 수 있도록 컴포저블에 주석을 달 수도 없습니다. 앞으로 나아갈 수 있는 방법은 여러 가지입니다.

불안정한 컬렉션 문제를 해결하는 방법은 여러 가지가 있습니다. 다음 하위 섹션에서는 이러한 다양한 접근 방식을 설명합니다.

구성 파일

코드베이스에서 안정성 계약을 준수하는 경우 안정성 구성 파일에 kotlin.collections.*를 추가하여 Kotlin 컬렉션을 안정적인 것으로 간주하도록 선택할 수 있습니다.

변경 불가능한 컬렉션

불변성의 컴파일 시간 안전을 위해 List 대신 kotlinx 불변 컬렉션을 사용할 수 있습니다.

@Composable
private fun HighlightedSnacks(
    …
    snacks: ImmutableList<Snack>,
    …
)

래퍼

변경 불가능한 컬렉션을 사용할 수 없는 경우 직접 만들 수 있습니다. 이렇게 하려면 주석이 추가된 안정적인 클래스로 List를 래핑하세요. 요구사항에 따라 일반 래퍼가 가장 적합할 수 있습니다.

@Immutable
data class SnackCollection(
   val snacks: List<Snack>
)

그런 다음 이를 컴포저블의 매개변수 유형으로 사용할 수 있습니다.

@Composable
private fun HighlightedSnacks(
    index: Int,
    snacks: SnackCollection,
    onSnackClick: (Long) -> Unit,
    modifier: Modifier = Modifier
)

해결 방법

이러한 접근 방식 중 하나를 취하면 Compose 컴파일러가 이제 HighlightedSnacks 컴포저블을 skippable 및 restartable로 표시합니다.

restartable skippable scheme("[androidx.compose.ui.UiComposable]") fun HighlightedSnacks(
  stable index: Int
  stable snacks: ImmutableList<Snack>
  stable onSnackClick: Function1<Long, Unit>
  stable modifier: Modifier? = @static Companion
)

이제 리컴포지션 중에 입력이 변경되지 않은 경우 Compose가 HighlightedSnacks를 건너뛸 수 있습니다.

안정성 구성 파일

Compose 컴파일러 1.5.5부터는 안정적인 것으로 간주할 클래스의 구성 파일을 컴파일 시간에 제공할 수 있습니다. 이를 통해 LocalDateTime와 같은 표준 라이브러리 클래스와 같이 제어할 수 없는 클래스를 안정적인 것으로 간주할 수 있습니다.

구성 파일은 행당 클래스가 하나인 일반 텍스트 파일입니다. 댓글, 단일 와일드 카드, 이중 와일드 카드가 지원됩니다.

구성 예:

// Consider LocalDateTime stable
java.time.LocalDateTime
// Consider my datalayer stable
com.datalayer.*
// Consider my datalayer and all submodules stable
com.datalayer.**
// Consider my generic type stable based off it's first type parameter only
com.example.GenericClass<*,_>

이 기능을 사용 설정하려면 구성 파일의 경로를 Compose 컴파일러 Gradle 플러그인 구성의 composeCompiler 옵션 블록에 전달하세요.

composeCompiler {
  stabilityConfigurationFile = rootProject.layout.projectDirectory.file("stability_config.conf")
}

Compose 컴파일러는 프로젝트의 각 모듈에서 별도로 실행되므로 필요한 경우 서로 다른 모듈에 서로 다른 구성을 제공할 수 있습니다. 또는 프로젝트의 루트 수준에 하나의 구성을 두고 각 모듈에 해당 경로를 전달합니다.

여러 모듈

또 다른 일반적인 문제는 다중 모듈 아키텍처와 관련이 있습니다. Compose 컴파일러는 참조하는 모든 비원시 유형이 명시적으로 안정적이라고 표시되거나 Compose 컴파일러로 빌드된 모듈에 있는 경우에만 클래스가 안정적인지 추론할 수 있습니다.

데이터 레이어가 UI 레이어와 별도의 모듈에 있는 경우(권장되는 접근 방식) 이 문제가 발생할 수 있습니다.

해결 방법

이 문제를 해결하려면 다음 방법 중 하나를 사용하세요.

  1. 컴파일러 구성 파일에 클래스를 추가합니다.
  2. 데이터 레이어 모듈에서 Compose 컴파일러를 사용 설정하거나 적절한 경우 @Stable 또는 @Immutable로 클래스에 태그를 지정합니다.
    • 여기에는 데이터 레이어에 Compose 종속 항목을 추가하는 작업이 포함됩니다. 하지만 Compose 런타임의 종속 항목일 뿐 Compose-UI의 종속 항목은 아닙니다.
  3. UI 모듈 내에서 데이터 레이어 클래스를 UI 관련 래퍼 클래스로 래핑합니다.

외부 라이브러리가 Compose 컴파일러를 사용하지 않는 경우에도 동일한 문제가 발생합니다.

모든 컴포저블이 스킵 가능해야 하는 것은 아닙니다.

안정성 문제를 해결할 때는 모든 컴포저블을 건너뛸 수 있도록 시도해서는 안 됩니다. 이렇게 하면 해결하는 문제보다 더 많은 문제를 야기하는 조기 최적화가 발생할 수 있습니다.

건너뛸 수 있는 것이 실제 이점이 없고 유지관리하기 어려운 코드로 이어질 수 있는 상황이 많이 있습니다. 예를 들면 다음과 같습니다.

  • 자주 다시 구성되지 않는 컴포저블
  • 자체적으로 건너뛸 수 있는 컴포저블만 호출하는 컴포저블
  • 비용이 많이 드는 equals 구현이 있는 매개변수가 많은 컴포저블 이 경우 매개변수가 변경되었는지 확인하는 비용이 저렴한 리컴포지션 비용보다 클 수 있습니다.

컴포저블을 건너뛸 수 있으면 작은 오버헤드가 추가되므로 그만한 가치가 없을 수 있습니다. 다시 시작할 수 있는 것이 가치보다 오버헤드가 더 크다고 판단되는 경우 컴포저블에 다시 시작할 수 없음을 주석으로 달 수도 있습니다.