Android项目使用Jetpack Compose @Preview时出现StackOverflowError

问题场景 #

在Android项目中使用Jetpack Compose的@Preview注解预览Composable函数时，每次都会抛出java.lang.StackOverflowError。

项目配置（build.gradle） #

plugins {
    id("com.android.application")
    id("org.jetbrains.kotlin.android")
}

android {
    namespace = "ir.gando"
    compileSdk = 34
    
    defaultConfig {
        applicationId = "ir.gando"
        minSdk = 24
        //noinspection EditedTargetSdkVersion
        targetSdk = 34
        versionCode = 1
        versionName = "1.0"
        
        testInstrumentationRunner = "androidx.test.runner.AndroidJUnitRunner"
        vectorDrawables {
            useSupportLibrary = true
        }
    }
    
    buildTypes {
        release {
            isMinifyEnabled = false
            proguardFiles(
                getDefaultProguardFile("proguard-android-optimize.txt"),
                "proguard-rules.pro"
            )
        }
    }
    compileOptions {
        sourceCompatibility = JavaVersion.VERSION_1_8
        targetCompatibility = JavaVersion.VERSION_1_8
    }
    kotlinOptions {
        jvmTarget = "1.8"
    }
    buildFeatures {
        compose = true
    }
    composeOptions {
        kotlinCompilerExtensionVersion = "1.4.3"
    }
    packaging {
        resources {
            excludes += "/META-INF/{AL2.0,LGPL2.1}"
        }
    }
}

dependencies {
    
    implementation("androidx.core:core-ktx:1.12.0")
    implementation("androidx.lifecycle:lifecycle-runtime-ktx:2.6.2")
    implementation("androidx.activity:activity-compose:1.8.1")
    implementation(platform("androidx.compose:compose-bom:2023.03.00"))
    implementation("androidx.compose.ui:ui")
    implementation("androidx.compose.ui:ui-graphics")
    implementation("androidx.compose.ui:ui-tooling-preview")
    implementation("androidx.compose.material3:material3")
    debugImplementation ("androidx.compose.ui:ui-tooling")
    implementation("androidx.navigation:navigation-compose:2.7.5")
    testImplementation("junit:junit:4.13.2")
    androidTestImplementation("androidx.test.ext:junit:1.1.5")
    androidTestImplementation("androidx.test.espresso:espresso-core:3.5.1")
    androidTestImplementation(platform("androidx.compose:compose-bom:2023.03.00"))
    androidTestImplementation("androidx.compose.ui:ui-test-junit4")
    debugImplementation("androidx.compose.ui:ui-tooling")
    debugImplementation("androidx.compose.ui:ui-test-manifest")
}

错误日志 #

java.lang.StackOverflowError
at androidx.compose.runtime.ParcelableSnapshotMutableState.<init>(ParcelableSnapshotMutableState.kt:27)
at androidx.compose.runtime.ActualAndroid_androidKt.createSnapshotMutableState(ActualAndroid.android.kt:93)
at androidx.compose.runtime.SnapshotStateKt__SnapshotStateKt.mutableStateOf(SnapshotState.kt:61)
at androidx.compose.runtime.SnapshotStateKt.mutableStateOf(Unknown Source)
at androidx.compose.material3.ColorScheme.<init>(ColorScheme.kt:131)
at androidx.compose.material3.ColorScheme.<init>(ColorScheme.kt)
at androidx.compose.material3.ColorSchemeKt.lightColorScheme-G1PFc-w(ColorScheme.kt:323)
at androidx.compose.material3.ColorSchemeKt.lightColorScheme-G1PFc-w$default(ColorScheme.kt:292)
at androidx.compose.material3.DynamicTonalPaletteKt.dynamicLightColorScheme(DynamicTonalPalette.kt:118)
at ir.gando.ui.theme.ThemeKt.GandoAndroidTheme(Theme.kt:50)
at ir.gando.ui.screen.MainScreenKt.MainScreenPreView(MainScreen.kt:25)
at ir.gando.ui.screen.ComposableSingletons$MainScreenKt$lambda-2$1.invoke(MainScreen.kt:26)
at ir.gando.ui.screen.ComposableSingletons$MainScreenKt$lambda-2$1.invoke(MainScreen.kt:25)
at androidx.compose.runtime.internal.ComposableLambdaImpl.invoke(ComposableLambda.jvm.kt:108)
at androidx.compose.runtime.internal.ComposableLambdaImpl.invoke(ComposableLambda.jvm.kt:35)
at androidx.compose.runtime.CompositionLocalKt.CompositionLocalProvider(CompositionLocal.kt:228)
at androidx.compose.material3.TextKt.ProvideTextStyle(Text.kt:261)
at androidx.compose.material3.MaterialThemeKt$MaterialTheme$1.invoke(MaterialTheme.kt:81)
at androidx.compose.material3.MaterialThemeKt$MaterialTheme$1.invoke(MaterialTheme.kt:80)
at androidx.compose.runtime.internal.ComposableLambdaImpl.invoke(ComposableLambda.jvm.kt:108)
at androidx.compose.runtime.internal.ComposableLambdaImpl.invoke(ComposableLambda.jvm.kt:35)
at androidx.compose.runtime.CompositionLocalKt.CompositionLocalProvider(CompositionLocal.kt:228)
at androidx.compose.material3.MaterialThemeKt.MaterialTheme(MaterialTheme.kt:73)
at ir.gando.ui.theme.ThemeKt.GandoAndroidTheme(Theme.kt:65)
at ir.gando.ui.screen.MainScreenKt.MainScreenPreView(MainScreen.kt:25)
...（重复递归调用链省略）

解决方法 #

从错误栈的递归调用链可以明确看出：GandoAndroidTheme和MainScreenPreView之间存在无限循环调用，导致栈溢出。

1. 修复Composable函数的调用逻辑 #

• 检查MainScreenPreView预览函数：确保它是用主题包裹要预览的内容，而不是被主题反向调用。正确写法示例：

@Preview
@Composable
fun MainScreenPreView() {
    // 用主题包裹需要预览的屏幕内容
    GandoAndroidTheme {
        MainScreen() // 这里是实际的屏幕Composable，不是预览函数
    }
}

• 检查Theme.kt中的GandoAndroidTheme：确保主题内部没有调用MainScreenPreView这个预览函数，主题应仅负责提供MaterialTheme的配置，不包含具体预览或屏幕内容。

2. 升级Compose依赖版本（可选） #

当前使用的Compose版本相对老旧（Compiler 1.4.3 + BOM 2023.03.00），升级到匹配的稳定版本可以避免一些潜在的框架级问题：

• 建议将composeOptions中的kotlinCompilerExtensionVersion升级到与Compose BOM对应的版本（例如BOM用2024.04.00，对应Compiler版本1.5.11）
• 所有Compose库版本通过BOM统一管理，避免版本不一致引发的问题。

内容的提问来源于stack exchange，提问作者MohammadBaqer