안정성 문제 해결

성능 문제를 일으키는 불안정한 클래스가 발생하면 클래스를 안정화해야 합니다. 이 문서에서는 이를 위해 사용할 수 있는 몇 가지 기법을 간략히 설명합니다.

클래스를 불변성으로 만들기

먼저 불안정한 클래스를 완전히 변경할 수 없게 만들어야 합니다.

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

변경할 수 없는 컬렉션

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

이 문제를 해결하려면 변경 불가능한 컬렉션을 사용하면 됩니다. Compose 컴파일러에는 Kotlinx 변경 불가능한 컬렉션 지원이 포함되어 있습니다. 이러한 컬렉션은 변경할 수 없도록 보장되며 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 Compiler 1.5.5부터 컴파일 시간에 안정적이라고 간주되는 클래스의 구성 파일을 제공할 수 있습니다. 이렇게 하면 LocalDateTime와 같은 표준 라이브러리 클래스와 같이 제어하지 않는 클래스를 안정적인 것으로 간주할 수 있습니다.

구성 파일은 행당 하나의 클래스가 있는 일반 텍스트 파일입니다. 주석, 단일 와일드 카드 및 이중 와일드 카드가 지원됩니다. 구성 예시는 다음과 같습니다.

// Consider LocalDateTime stable
java.time.LocalDateTime
// Consider kotlin collections stable
kotlin.collections.*
// 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 컴파일러 옵션에 전달하세요.

Groovy

kotlinOptions {
    freeCompilerArgs += [
            "-P",
            "plugin:androidx.compose.compiler.plugins.kotlin:stabilityConfigurationPath=" +
                    project.absolutePath + "/compose_compiler_config.conf"
    ]
}

Kotlin

kotlinOptions {
  freeCompilerArgs += listOf(
      "-P",
      "plugin:androidx.compose.compiler.plugins.kotlin:stabilityConfigurationPath=" +
      "${project.absolutePath}/compose_compiler_config.conf"
  )
}

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

다중 모듈

또 다른 일반적인 문제는 다중 모듈 아키텍처와 관련된 것입니다. Compose 컴파일러는 프리미티브가 아닌 모든 유형이 명시적으로 안정적인 것으로 표시된 경우 또는 마찬가지로 Compose 컴파일러로 빌드된 모듈에 있는 경우에만 클래스가 안정적인지 추론할 수 있습니다.

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

해결 방법

이 문제를 해결하려면 다음 접근 방식 중 하나를 사용하면 됩니다.

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

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

모든 컴포저블을 건너뛸 수 있는 것은 아닙니다.

안정성 문제를 해결할 때 모든 컴포저블을 건너뛸 수 있는 형식으로 만들려고 해서는 안 됩니다. 그렇게 하려고 하면 조기에 최적화되어 수정되는 것보다 더 많은 문제가 발생할 수 있습니다.

건너뛸 수 있다고 해서 실질적인 이점이 없고 코드를 관리하기 어려운 상황이 발생하는 경우가 많습니다. 예:

  • 자주 재구성되지 않거나 전혀 재구성되지 않는 컴포저블
  • 자체적으로 건너뛸 수 있는 컴포저블을 호출하는 컴포저블
  • 매개변수가 많고 같음 구현 비용이 높은 컴포저블 이 경우 매개변수가 변경되었는지 확인하는 비용이 저렴한 리컴포지션 비용을 능가할 수 있습니다.

건너뛸 수 있는 컴포저블의 경우 약간의 오버헤드가 추가되어 그다지 유용하지 않을 수도 있습니다. 다시 시작할 수 있는 것이 가치보다 많은 오버헤드라고 판단되는 경우 컴포저블에 다시 시작할 수 없도록 주석을 달 수도 있습니다.