Zawijanie WebView w Compose

Aby użyć WebView w Jetpack Compose, musisz opakować go w AndroidView. Z tego przewodnika dowiesz się, jakie są typowe przypadki użycia i jak je obsługiwać w Compose.

Zawijanie WebView za pomocą AndroidView

Aby użyć WebView w Compose, umieść go w AndroidView:

@Composable
fun SimpleWebView(
    initialUrl: String,
    modifier: Modifier = Modifier
) {
    AndroidView(
        modifier = modifier.fillMaxSize(),
        factory = { context ->
            WebView(context).apply {
                webViewClient = WebViewClient()
                settings.javaScriptEnabled = true
                loadUrl(initialUrl)			
            }
        }
    )
}

To rozwiązanie sprawdza się w przypadku wyświetlania prostego adresu URL w aplikacji. Jednak WebView obsługuje złożone cykle życia stanu, które są niezależne od cyklu życia widoku Androida i cyklu życia Compose. Integracja Compose może wprowadzić złożone scenariusze WebView, które powodują trudne do rozwiązania błędy. W kolejnych sekcjach opisujemy przypadki użycia, które mogą wymagać specjalnego traktowania, aby obsługiwać te funkcje.

Zachowywanie stanu WebView

Obsługa zmian konfiguracji i nawigacji w Compose jest trudna, ponieważ WebView to starsza wersja View powiązana z hostem Activity i nie zaleca się, aby jej instancja działała dłużej niż cykl życia Activity.

Dlatego standardowym sposobem na zachowanie stanu WebView jest umożliwienie niszczenia i ponownego tworzenia instancji WebView wraz z Activity. Możesz ręcznie zachować historię nawigacji wewnętrznej i stan przewijania za pomocą Bundle.

@Composable
fun PersistentWebView(url: String) {
    val webViewStateBundle = rememberSaveable { Bundle() }

    AndroidView(
        factory = { context ->
            WebView(context).apply {
                webViewClient = WebViewClient()
                settings.javaScriptEnabled = true

                // Restore the state and history
                if (webViewStateBundle.containsKey("WEBVIEW_STATE")) {
                    restoreState(webViewStateBundle.getBundle("WEBVIEW_STATE")!!)
                } else {
                    loadUrl(url)
                }
            }
        },
        onRelease = { releasedWebView ->
            // Save navigation history before the instance is destroyed
            val bundle = Bundle()
            releasedWebView.saveState(bundle)
            webViewStateBundle.putBundle("WEBVIEW_STATE", bundle)
        },
        modifier = Modifier.fillMaxSize()
    )
}

Obsługa przechodzenia wstecz

Jeśli WebView ma historię nawigacji, systemowy gest wstecz powinien powodować cofnięcie się w obrębie WebView, a nie zamknięcie ekranu.

Użyj interfejsu Compose BackHandler API, aby przechwycić zdarzenie systemowe cofnięcia i wywołać funkcję WebView goBack():

// ...
@Composable
fun BackNavigationDemoScreen(onBack: () -> Unit) {
    // Hold a reference to the WebView to check its history state
    var webViewReference by remember { mutableStateOf<WebView?>(null) }

    // Intercept the system back press if the WebView has history
    BackHandler(enabled = true) {
        val webView = webViewReference
        if (webView != null && webView.canGoBack()) {
            webView.goBack() // Go back in history
        } else {
            onBack() // Exit screen
        }
    }

    Scaffold(
        topBar = {
            TopAppBar(
                title = { Text("Back Navigation Demo") },
                navigationIcon = {
                    IconButton(onClick = onBack) {
                        Icon(Icons.AutoMirrored.Filled.ArrowBack, contentDescription = "Back")
                    }
                }
            )
        }
    ) { padding ->
        Column(modifier = Modifier.fillMaxSize().padding(padding)) {
            AndroidView(
                modifier = Modifier.fillMaxSize(),
                factory = { context ->
                    WebView(context).apply {
                        settings.javaScriptEnabled = true

                        // Keeps link navigations internal to the WebView instead of opening Chrome
                        webViewClient = WebViewClient() 

                        loadUrl("https://developer.android.com")
                        webViewReference = this
                    }
                },
                onRelease = {
                    webViewReference = null
                }
            )
        }
    }
}

Ta implementacja zapewnia zachowanie nawigacji w stylu przeglądarki.

Zagnieżdżone przewijanie

Zagnieżdżone przewijanie nie jest łatwo obsługiwane podczas korzystania z funkcji WebView w Compose. Jeśli umieścisz WebView w przewijanym kontenerze Compose, np. LazyColumn, WebView może wykorzystywać wszystkie gesty przewijania. WebView korzysta z własnego wewnętrznego mechanizmu renderowania, dlatego zagnieżdżanie go w LazyColumn nie działa obecnie prawidłowo.

Aby śledzić postępy w oficjalnej obsłudze zagnieżdżonego przewijania w WebView, zobacz ten problem.

Układy od krawędzi do krawędzi i wstawki okien

Podczas korzystania z układów od krawędzi do krawędzi treści WebView mogą pojawiać się pod paskami systemu, takimi jak pasek stanu. Możesz użyć modyfikatora windowInsetsPadding, aby przesunąć cały element WebView do bezpiecznego obszaru:

@Composable
fun EdgeToEdgeDemo(url: String) {
    AndroidView(
        modifier = Modifier
            .fillMaxSize()
            .windowInsetsPadding(WindowInsets.systemBars),
        factory = { context ->
            WebView(context).apply {
                loadUrl(url)
            }
        }
    )
}

Więcej informacji o wstawkach znajdziesz w artykule Wstawki okna w komponencie WebView.

Synchronizowanie motywu aplikacji z treścią WebView

Gdy aplikacja przełącza się między trybem jasnym i ciemnym, treść WebView może aktualizować się automatycznie bez ponownego ładowania strony, jeśli jest prawidłowo obsługiwana.

Jeśli jesteś właścicielem treści na stronie internetowej, aby zsynchronizować kolory z motywem aplikacji, obsłuż zapytanie o media prefers-color-scheme, aby upewnić się, że strona internetowa dostosowuje się do wybranego motywu.

Aby umożliwić elementom natywnym, takim jak menu i wyskakujące okienka, wykrywanie i dopasowywanie motywu aplikacji, zastosuj motyw stylu DayNight do Activity.

<resources>

    <!-- ...
    <!-- Use a DayNight theme in your manifest to handle both modes automatically -->
    <style name="Theme.Webviewdemo.DayNight" parent="Theme.AppCompat.DayNight.NoActionBar" />
</resources>

@Composable
fun ThemeSyncDemo(onBack: () -> Unit) {
    val context = LocalContext.current
    AndroidView(
        modifier = Modifier.fillMaxSize(),
        factory = { _ ->
            WebView(context).apply {
                settings.javaScriptEnabled = true
                webViewClient = WebViewClient()
                val html = """
                            <html>
                            <head>
                                // ...


                                    @media (prefers-color-scheme: dark) {
                                        body {
                                            background-color: #212121;
                                            color: #ffffff;
                                        }
                                        select {
                                            border-color: #BB86FC;
                                            background: #212121;
                                            color: #ffffff;
                                        }
                                    }
                                </style>
                            </head>
                            // ...
                            </html>
                        """.trimIndent()
                loadDataWithBaseURL(null, html, "text/html", "UTF-8", null)
            }
        }
    )
}

Jeśli strona internetowa nie ma ciemnego motywu lub nie jesteś właścicielem treści z internetu, algorytmiczne przyciemnianie może pomóc wymusić ciemny motyw. Nowoczesne witryny, które mają już tryb ciemny, ignorują ten algorytm i używają własnych wbudowanych stylów.

Obsługa uprawnień dotyczących sieci w Compose

Gdy strona internetowa prosi o dostęp do sprzętu lub danych (np. kamery, mikrofonu lub lokalizacji), WebView wywołuje określone wywołania zwrotne w WebChromeClient. Musisz obsłużyć te wywołania zwrotne i upewnić się, że przyznano odpowiednie uprawnienia w czasie działania aplikacji na Androidzie.

Zarządzanie uprawnieniami do korzystania z aparatu i dostęp do mikrofonu

Gdy strona internetowa prosi o dostęp do kamery lub mikrofonu (np. WebRTC lub nagrywanie filmu), WebView wywołuje WebChromeClient.onPermissionRequest.

Jednak przed wywołaniem grant() musisz poprosić o te uprawnienia w czasie działania aplikacji na Androidzie:

  • Manifest.permission.CAMERA
  • Manifest.permission.RECORD_AUDIO

Najpierw zdefiniuj moduł obsługi uprawnień dla WebView, który śledzi PermissionRequest żądane od WebView:

class WebViewPermissionHandler(
    private val launcher: ManagedActivityResultLauncher<Array<String>, Map<String, Boolean>>
) {
    var pendingRequest by mutableStateOf<PermissionRequest?>(null)
        private set

    fun handleRequest(request: PermissionRequest) {
        val isTrustedOrigin = request.origin.host == "www.trusted-domain.com" || request.origin.host == "app.local" // Always verify the origin before granting request


        if (!isTrustedOrigin) {
            Log.w("WebViewPermission", "Blocked and denied permission request from untrusted origin: ${request.origin.host}")
            request.deny()
            return
        }

        val androidPermissions = mutableListOf<String>()
        request.resources.forEach { resource ->
            when (resource) {
                PermissionRequest.RESOURCE_VIDEO_CAPTURE -> androidPermissions.add(Manifest.permission.CAMERA)
                PermissionRequest.RESOURCE_AUDIO_CAPTURE -> androidPermissions.add(Manifest.permission.RECORD_AUDIO)
            }
        }

        // Save the request and launch the Android system dialog
        pendingRequest = request
        launcher.launch(androidPermissions.toTypedArray())
    }

    fun onResult(results: Map<String, Boolean>) {
        val allGranted = results.values.all { it }
        Log.d("WebViewPermission", "Kotlin: All permissions granted? $allGranted")

        if (allGranted) {
            pendingRequest?.grant(arrayOf("/* list of permissions */"))
        } else {
            pendingRequest?.deny()
        }
        pendingRequest = null
    }
}

Następnie utwórz funkcję kompozycyjną, która zapamiętuje obiekt WebViewPermissionHandler. Użyj rememberLauncherForActivityResult, aby poprosić o uprawnienia:

@Composable
fun rememberWebViewPermissionHandler(): WebViewPermissionHandler {
    val handlerState = remember { mutableStateOf<WebViewPermissionHandler?>(null) }
    val launcher = rememberLauncherForActivityResult(
        ActivityResultContracts.RequestMultiplePermissions()
    ) { results ->
        handlerState.value?.onResult(results)
    }
    return remember {
        WebViewPermissionHandler(launcher).also { handlerState.value = it }
    }
}

Obsłuż uprawnienia z wywołania zwrotnego onPermissionRequest. Spowoduje to uruchomienie kreatora uprawnień:

@Composable
fun WebViewPermissionScreen() {
    val permissionHandler = rememberWebViewPermissionHandler()

    AndroidView(
        factory = { context ->
            WebView(context).apply {
                settings.javaScriptEnabled = true

                webChromeClient = object : WebChromeClient() {
                    override fun onPermissionRequest(request: PermissionRequest) {
                        // Simply delegate to the handler
                        permissionHandler.handleRequest(request)
                    }
                }

		   // load a web page that needs permissions
            }
        },
        modifier = Modifier.fillMaxSize()
    )
}

Alternatywa dla wbudowanego komponentu WebView

Jeśli nie chcesz osadzać WebView, Android udostępnia inne opcje wyświetlania treści z internetu, takie jak karty niestandardowe Chrome. Aby dowiedzieć się, jak wybrać odpowiednie podejście do konkretnych przypadków użycia (np. przeglądania lub uwierzytelniania), przeczytaj artykuł Korzystanie z treści z internetu w aplikacji na Androida.

Dodatkowe materiały