Как добавить WebView в Compose

Чтобы использовать WebView в Jetpack Compose, необходимо обернуть его в AndroidView. В этом руководстве объясняются распространенные варианты использования и способы их поддержки в Compose.

Как обернуть WebView в AndroidView

Чтобы использовать WebView в Compose, оберните его в 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)			
            }
        }
    )
}

Это работает для показа простого URL в приложении. Однако WebView имеет дело со сложными жизненными циклами состояний, которые отделены от жизненных циклов Android View и Compose. Интеграция Compose может привести к сложным сценариям WebView, которые приводят к трудноустранимым ошибкам. В разделах ниже описаны случаи, когда для поддержки этих функций может потребоваться специальная обработка.

Сохранение состояния WebView

Обработка изменений конфигурации и навигации в Compose – сложная задача, поскольку WebView – это устаревший View, привязанный к своему хосту Activity, и не рекомендуется, чтобы его экземпляр пережил жизненный цикл Activity.

Поэтому стандартный способ сохранить состояние WebView – разрешить уничтожение и повторное создание экземпляров WebView вместе с Activity. Вы можете вручную сохранить внутреннюю историю навигации и состояние прокрутки с помощью 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()
    )
}

Как настроить обратную навигацию

Если у WebView есть история навигации, системный жест "Назад" должен возвращать пользователя к предыдущему экрану в WebView, а не закрывать его.

Используйте Compose BackHandler API, чтобы перехватить системное событие возврата и вызвать функцию 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
                }
            )
        }
    }
}

Такая реализация обеспечивает навигацию, аналогичную браузерной.

Вложенная прокрутка

Вложенная прокрутка не поддерживается при использовании WebView в Compose. Если поместить WebView в прокручиваемый контейнер Compose, например LazyColumn, WebView может перехватывать все жесты прокрутки. Поскольку WebView использует собственный внутренний механизм отрисовки, вложенность в LazyColumn в настоящее время работает некорректно.

Чтобы отслеживать прогресс официальной поддержки вложенной прокрутки для WebView, ознакомьтесь с этой проблемой.

Макеты от края до края и вставки окон

При использовании макетов во весь экран контент WebView может отображаться под системными строками, например строкой состояния. Вы можете использовать модификатор windowInsetsPadding, чтобы поместить весь элемент WebView в безопасную область:

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

Подробнее о вставках окон в WebView…

Синхронизация темы приложения с контентом WebView

При переключении между светлой и темной темами контент WebView может обновляться автоматически без перезагрузки страницы, если все настроено правильно.

Если вы владелец контента веб-страницы, то, чтобы синхронизировать цвета с темой приложения, обработайте запрос медиа prefers-color-scheme. Это позволит адаптировать веб-страницу к выбранной теме.

Чтобы нативные элементы, такие как раскрывающиеся списки и всплывающие окна, определяли тему приложения и соответствовали ей, примените тему стиля DayNight к 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)
            }
        }
    )
}

Если у веб-страницы нет тёмной темы или вы не владеете веб-контентом, принудительно включить тёмную тему можно с помощью алгоритмического затемнения. Современные сайты, на которых уже есть тёмная тема, игнорируют этот алгоритм и используют собственные встроенные стили.

Как обрабатывать разрешения для сайтов в Compose

Когда веб-страница запрашивает доступ к оборудованию или данным (например, к камере, микрофону или местоположению), WebView активирует определенные обратные вызовы в своем WebChromeClient. Вы должны обработать эти обратные вызовы и убедиться, что предоставлены соответствующие динамические разрешения Android.

Как управлять разрешениями на доступ к камере и микрофону

Когда веб-страница запрашивает доступ к камере или микрофону (например, для WebRTC или записи видео), WebView вызывает WebChromeClient.onPermissionRequest.

Однако перед вызовом grant() необходимо запросить следующие динамические разрешения Android:

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

Сначала определите обработчик разрешений для WebView, который отслеживает PermissionRequest, запрашиваемые у 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
    }
}

Затем создайте composable-функцию, которая запоминает WebViewPermissionHandler. Используйте rememberLauncherForActivityResult, чтобы запросить разрешения:

@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 }
    }
}

Обработайте разрешение из обратного вызова onPermissionRequest. Это запустит запрос разрешений:

@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()
    )
}

Альтернатива встроенному компоненту WebView

Если вы не хотите встраивать WebView, в Android есть другие варианты показа веб-контента, например специальные вкладки Chrome. О том, как выбрать подходящий подход для ваших целей (например, для просмотра контента или аутентификации), читайте в статье Как использовать веб-контент в приложении для Android.

Дополнительные ресурсы