Créer des applications Web dans WebView

Utilisez WebView pour proposer une application Web ou une page Web dans une application cliente. La classe WebView est une extension de la classe View d'Android qui vous permet d'afficher des pages Web dans la mise en page de votre activité. Elle n'inclut pas les fonctionnalités d'un navigateur Web entièrement développé, telles que les commandes de navigation ou une barre d'adresse. Par défaut, WebView se contente d'afficher une page Web.

WebView peut vous aider à fournir des informations dans votre application que vous devrez peut-être mettre à jour, comme un contrat d'utilisateur final ou un guide de l'utilisateur. Dans votre application Android, vous pouvez créer un Activity contenant un WebView, puis l'utiliser pour afficher votre document hébergé en ligne.

WebView peut également être utile lorsque votre application fournit à l'utilisateur des données qui nécessitent une connexion Internet pour être récupérées, comme des e-mails. Dans ce cas, il peut être plus facile de créer un WebView dans votre application Android qui affiche une page Web contenant toutes les données utilisateur, plutôt que d'effectuer une requête réseau, puis d'analyser les données et de les afficher dans une mise en page Android. Vous pouvez plutôt concevoir une page Web adaptée aux appareils Android, puis implémenter un WebView dans votre application Android qui charge la page Web.

Ce document explique comment commencer à utiliser WebView, comment lier du code JavaScript de votre page Web à du code côté client dans votre application Android, comment gérer la navigation sur les pages et comment gérer les fenêtres lorsque vous utilisez WebView.

Utiliser WebView sur les versions antérieures d'Android

Pour utiliser en toute sécurité les fonctionnalités WebView plus récentes sur l'appareil sur lequel votre application s' exécute, ajoutez la bibliothèque AndroidX Webkit. Il s'agit d'une bibliothèque statique que vous pouvez ajouter à votre application pour utiliser des API android.webkit qui ne sont pas disponibles pour les versions antérieures de la plate-forme.

Ajoutez-la à votre fichier build.gradle comme suit :

Kotlin

dependencies {
    implementation("androidx.webkit:webkit:1.8.0")
}

Groovy

dependencies {
    implementation ("androidx.webkit:webkit:1.8.0")
}

Pour en savoir plus, consultez l'exemple WebView sur GitHub.

Ajouter un WebView à votre application

Pour ajouter un WebView à votre application, vous pouvez inclure l'élément <WebView> dans la mise en page de votre activité ou définir l'ensemble de la fenêtre Activity comme WebView dans onCreate().

Ajouter un WebView dans la mise en page de l'activité

Pour ajouter un WebView à votre application dans la mise en page, ajoutez le code suivant au fichier XML de mise en page de votre activité :

<WebView
    android:id="@+id/webview"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
/>

Pour charger une page Web dans le WebView, utilisez loadUrl(), comme illustré dans le exemple suivant :

Kotlin

val myWebView: WebView = findViewById(R.id.webview)
myWebView.loadUrl("http://www.example.com")

Java

WebView myWebView = (WebView) findViewById(R.id.webview);
myWebView.loadUrl("http://www.example.com");

Ajouter un WebView dans onCreate()

Pour ajouter un WebView à votre application dans la méthode onCreate() d'une activité, utilisez une logique semblable à la suivante :

Kotlin

val myWebView = WebView(activityContext)
setContentView(myWebView)

Java

WebView myWebView = new WebView(activityContext);
setContentView(myWebView);

Chargez ensuite la page :

Kotlin

myWebView.loadUrl("http://www.example.com")

Java

myWebView.loadUrl("https://www.example.com");

Ou chargez l'URL à partir d'une chaîne HTML :

Kotlin

// Create an unencoded HTML string, then convert the unencoded HTML string into
// bytes. Encode it with base64 and load the data.
val unencodedHtml =
     "<html><body>'%23' is the percent code for ‘#‘ </body></html>";
val encodedHtml = Base64.encodeToString(unencodedHtml.toByteArray(), Base64.NO_PADDING)
myWebView.loadData(encodedHtml, "text/html", "base64")

Java

// Create an unencoded HTML string, then convert the unencoded HTML string into
// bytes. Encode it with base64 and load the data.
String unencodedHtml =
     "<html><body>'%23' is the percent code for ‘#‘ </body></html>";
String encodedHtml = Base64.encodeToString(unencodedHtml.getBytes(),
        Base64.NO_PADDING);
myWebView.loadData(encodedHtml, "text/html", "base64");

Votre application doit avoir accès à Internet. Pour obtenir un accès à Internet, demandez l'autorisation INTERNET dans votre fichier manifeste, comme illustré dans l'exemple suivant :

<manifest ... >
    <uses-permission android:name="android.permission.INTERNET" />
    ...
</manifest>

Vous pouvez personnaliser votre WebView en procédant de l'une des manières suivantes :

  • Activer la prise en charge du plein écran à l'aide de WebChromeClient. Cette classe est également appelée lorsqu'un WebView a besoin d'une autorisation pour modifier l'interface utilisateur de l'application hôte, par exemple pour créer ou fermer des fenêtres ou envoyer des boîtes de dialogue JavaScript à l'utilisateur. Pour en savoir plus sur le débogage dans ce contexte, consultez Déboguer des applications Web.
  • Gérer les événements qui ont un impact sur le rendu du contenu, tels que les erreurs lors de l'envoi de formulaires ou de la navigation à l'aide de WebViewClient. Vous pouvez également utiliser cette sous-classe pour intercepter le chargement d'URL.
  • Activer JavaScript en modifiant WebSettings.
  • Utiliser JavaScript pour accéder aux objets du framework Android que vous avez injectés dans un WebView.

Utiliser JavaScript dans WebView

Si la page Web que vous souhaitez charger dans votre WebView utilise JavaScript, vous devez activer JavaScript pour votre WebView. Une fois JavaScript activé, vous pouvez créer des interfaces entre le code de votre application et votre code JavaScript.

Activer JavaScript

JavaScript est désactivé par défaut dans un WebView. Vous pouvez l'activer via le WebSettings associé à votre WebView. Récupérez WebSettings avec getSettings(), puis activez JavaScript avec setJavaScriptEnabled().

Consultez l'exemple suivant :

Kotlin

val myWebView: WebView = findViewById(R.id.webview)
myWebView.settings.javaScriptEnabled = true

Java

WebView myWebView = (WebView) findViewById(R.id.webview);
WebSettings webSettings = myWebView.getSettings();
webSettings.setJavaScriptEnabled(true);

WebSettings permet d'accéder à divers autres paramètres qui peuvent vous être utiles. Par exemple, si vous développez une application Web conçue spécifiquement pour le WebView de votre application Android, vous pouvez définir une chaîne d'agent utilisateur personnalisée avec setUserAgentString(), puis interroger l'agent utilisateur personnalisé dans votre page Web pour vérifier que le client qui demande votre page Web est votre application Android.

Lier du code JavaScript à du code Android

Lorsque vous développez une application Web conçue spécifiquement pour le WebView de votre application Android, vous pouvez créer des interfaces entre votre code JavaScript et votre code Android côté client. Par exemple, votre code JavaScript peut appeler une méthode dans votre code Android pour afficher un Dialog, au lieu d'utiliser la fonction alert() de JavaScript.

Pour lier une nouvelle interface entre votre code JavaScript et votre code Android, appelez addJavascriptInterface(), en lui transmettant une instance de classe à lier à votre code JavaScript et un nom d'interface que votre code JavaScript peut appeler pour accéder à la classe.

Pour en savoir plus sur la communication entre JavaScript et le code natif, y compris sur les API plus modernes et sécurisées, consultez Accéder aux API natives avec JSBridge.

Par exemple, vous pouvez inclure la classe suivante dans votre application Android :

Kotlin

/** Instantiate the interface and set the context.  */
class WebAppInterface(private val mContext: Context) {

    /** Show a toast from the web page.  */
    @JavascriptInterface
    fun showToast(toast: String) {
        Toast.makeText(mContext, toast, Toast.LENGTH_SHORT).show()
    }
}

Java

public class WebAppInterface {
    Context mContext;

    /** Instantiate the interface and set the context. */
    WebAppInterface(Context c) {
        mContext = c;
    }

    /** Show a toast from the web page. */
    @JavascriptInterface
    public void showToast(String toast) {
        Toast.makeText(mContext, toast, Toast.LENGTH_SHORT).show();
    }
}

Dans cet exemple, la WebAppInterface classe permet à la page Web de créer un Toast message, à l'aide de la showToast() méthode.

Vous pouvez lier cette classe au code JavaScript qui s'exécute dans votre WebView avec addJavascriptInterface(), comme illustré dans l'exemple suivant :

Kotlin

val webView: WebView = findViewById(R.id.webview)
webView.addJavascriptInterface(WebAppInterface(this), "Android")

Java

WebView webView = (WebView) findViewById(R.id.webview);
webView.addJavascriptInterface(new WebAppInterface(this), "Android");

Cela crée une interface appelée Android pour le code JavaScript qui s'exécute dans le WebView. À ce stade, votre application Web a accès à la classe WebAppInterface. Voici par exemple du code HTML et JavaScript qui crée un message toast à l'aide de la nouvelle interface lorsque l'utilisateur appuie sur un bouton :

<input type="button" value="Say hello" onClick="showAndroidToast('Hello Android!')" />

<script type="text/javascript">
    function showAndroidToast(toast) {
        Android.showToast(toast);
    }
</script>

Il n'est pas nécessaire d'initialiser l'interface Android à partir de JavaScript. Le WebView la met automatiquement à disposition de votre page Web. Ainsi, lorsqu'un utilisateur appuie sur le bouton, la fonction showAndroidToast() utilise l'interface Android pour appeler la méthode WebAppInterface.showToast().

Gérer la navigation sur les pages

Lorsque l'utilisateur appuie sur un lien à partir d'une page Web dans votre WebView, Android lance par défaut une application qui gère les URL. En règle générale, le navigateur Web par défaut s'ouvre et charge l'URL de destination. Toutefois, vous pouvez remplacer ce comportement pour votre WebView afin que les liens s'ouvrent dans votre WebView. Vous pouvez ensuite laisser l'utilisateur naviguer en avant et en arrière dans l'historique de sa page Web, qui est géré par votre WebView.

Pour ouvrir les liens sur lesquels l'utilisateur appuie, fournissez un WebViewClient pour votre WebView à l'aide de setWebViewClient(). Tous les liens sur lesquels l'utilisateur appuie se chargent dans votre WebView. Si vous souhaitez mieux contrôler l'emplacement de chargement d'un lien cliqué, créez votre propre WebViewClient qui remplace la shouldOverrideUrlLoading() méthode. L'exemple suivant suppose que MyWebViewClient est une classe interne de Activity.

Kotlin

private class MyWebViewClient : WebViewClient() {

    override fun shouldOverrideUrlLoading(view: WebView?, url: String?): Boolean {
        if (Uri.parse(url).host == "www.example.com") {
            // This is your website, so don't override. Let your WebView load
            // the page.
            return false
        }
        // Otherwise, the link isn't for a page on your site, so launch another
        // Activity that handles URLs.
        Intent(Intent.ACTION_VIEW, Uri.parse(url)).apply {
            startActivity(this)
        }
        return true
    }
}

Java

private class MyWebViewClient extends WebViewClient {
    @Override
    public boolean shouldOverrideUrlLoading(WebView view, WebResourceRequest request) {
        if ("www.example.com".equals(request.getUrl().getHost())) {
      // This is your website, so don't override. Let your WebView load the
      // page.
      return false;
    }
    // Otherwise, the link isn't for a page on your site, so launch another
    // Activity that handles URLs.
    Intent intent = new Intent(Intent.ACTION_VIEW, request.getUrl());
    startActivity(intent);
    return true;
  }
}

Créez ensuite une instance de ce nouveau WebViewClient pour le WebView :

Kotlin

val myWebView: WebView = findViewById(R.id.webview)
myWebView.webViewClient = MyWebViewClient()

Java

WebView myWebView = (WebView) findViewById(R.id.webview);
myWebView.setWebViewClient(new MyWebViewClient());

Désormais, lorsque l'utilisateur appuie sur un lien, le système appelle la méthode shouldOverrideUrlLoading(), qui vérifie si l'hôte de l'URL correspond à un domaine spécifique, comme défini dans l'exemple précédent. Si c'est le cas, la méthode renvoie la valeur "false" et ne remplace pas le chargement de l'URL. Elle permet au WebView de charger l'URL comme d'habitude. Si l'hôte de l'URL ne correspond pas, un Intent est créé pour lancer le par défaut Activity pour la gestion des URL, qui correspond au navigateur Web par défaut de l'utilisateur.

Gérer les URL personnalisées

WebView applique des restrictions lors de la demande de ressources et de la résolution de liens qui utilisent un schéma d'URL personnalisé. Par exemple, si vous implémentez des rappels tels que shouldOverrideUrlLoading() ou shouldInterceptRequest(), alors WebView ne les appelle que pour les URL valides.

Par exemple, WebView peut ne pas appeler votre méthode shouldOverrideUrlLoading() pour des liens comme celui-ci :

<a href="showProfile">Show Profile</a>

Les URL non valides, comme celle présentée dans l'exemple précédent, sont gérées de manière incohérente dans WebView. Nous vous recommandons donc d'utiliser une URL bien formée. Vous pouvez utiliser un schéma personnalisé ou une URL HTTPS pour un domaine que votre organisation contrôle.

Au lieu d'utiliser une simple chaîne dans un lien, comme dans l'exemple précédent, vous pouvez utiliser un schéma personnalisé tel que le suivant :

<a href="example-app:showProfile">Show Profile</a>

Vous pouvez ensuite gérer cette URL dans votre méthode shouldOverrideUrlLoading() comme suit :

Kotlin

// The URL scheme must be non-hierarchical, meaning no trailing slashes.
const val APP_SCHEME = "example-app:"

override fun shouldOverrideUrlLoading(view: WebView?, url: String?): Boolean {
    return if (url?.startsWith(APP_SCHEME) == true) {
        urlData = URLDecoder.decode(url.substring(APP_SCHEME.length), "UTF-8")
        respondToData(urlData)
        true
    } else {
        false
    }
}

Java

// The URL scheme must be non-hierarchical, meaning no trailing slashes.
private static final String APP_SCHEME = "example-app:";

@Override
public boolean shouldOverrideUrlLoading(WebView view, String url) {
    if (url.startsWith(APP_SCHEME)) {
        urlData = URLDecoder.decode(url.substring(APP_SCHEME.length()), "UTF-8");
        respondToData(urlData);
        return true;
    }
    return false;
}

L'API shouldOverrideUrlLoading() est principalement destinée à lancer des intents pour des URL spécifiques. Lorsque vous l'implémentez, veillez à renvoyer la valeur false pour les URL gérées par le WebView. Vous n'êtes toutefois pas limité au lancement d'intents. Vous pouvez remplacer le lancement d'intents par n'importe quel comportement personnalisé dans les exemples de code précédents.

Lorsque votre WebView remplace le chargement d'URL, il accumule automatiquement un historique des pages Web visitées. Vous pouvez naviguer en avant et en arrière dans l'historique avec goBack() et goForward().

Par exemple, le code suivant montre comment votre Activity peut utiliser le bouton "Retour" de l'appareil pour revenir en arrière :

Kotlin

override fun onKeyDown(keyCode: Int, event: KeyEvent?): Boolean {
    // Check whether the key event is the Back button and if there's history.
    if (keyCode == KeyEvent.KEYCODE_BACK && myWebView.canGoBack()) {
        myWebView.goBack()
        return true
    }
    // If it isn't the Back button or there isn't web page history, bubble up to
    // the default system behavior. Probably exit the activity.
    return super.onKeyDown(keyCode, event)
}

Java

@Override
public boolean onKeyDown(int keyCode, KeyEvent event) {
    // Check whether the key event is the Back button and if there's history.
    if ((keyCode == KeyEvent.KEYCODE_BACK) && myWebView.canGoBack()) {
        myWebView.goBack();
        return true;
    }
    // If it isn't the Back button or there's no web page history, bubble up to
    // the default system behavior. Probably exit the activity.
    return super.onKeyDown(keyCode, event);
}

Si votre application utilise AndroidX AppCompat 1.6.0 ou une version ultérieure, vous pouvez simplifier encore plus l'extrait précédent :

Kotlin

onBackPressedDispatcher.addCallback {
    // Check whether there's history.
    if (myWebView.canGoBack()) {
        myWebView.goBack()
    }
}

Java

onBackPressedDispatcher.addCallback {
    // Check whether there's history.
    if (myWebView.canGoBack()) {
        myWebView.goBack();
    }
}

La méthode canGoBack() renvoie la valeur "true" si l'utilisateur peut consulter l'historique des pages Web. De même, vous pouvez utiliser canGoForward() pour vérifier s'il existe un historique de navigation en avant. Si vous n'effectuez pas cette vérification, goBack() et goForward() ne font rien une fois que l'utilisateur a atteint la fin de l'historique.

Gérer les modifications de configuration de l'appareil

Lors de l'exécution, l'état de l'activité change lorsque la configuration d'un appareil change, par exemple lorsque les utilisateurs font pivoter l'appareil ou ferment un éditeur de méthode d'entrée (IME). Ces modifications entraînent la destruction de l'activité d'un objet WebView et la création d'une nouvelle activité, ce qui crée également un nouvel objet WebView qui charge l'URL de l'objet détruit. Pour modifier le comportement par défaut de votre activité, vous pouvez modifier la façon dont elle gère les modifications d'orientation dans votre fichier manifeste. Pour en savoir plus sur la gestion des modifications de configuration lors de l'exécution, consultez Gérer les modifications de configuration.

Gérer les fenêtres

Par défaut, les requêtes d'ouverture de nouvelles fenêtres sont ignorées. Cela s'applique qu'elles soient ouvertes par JavaScript ou par l'attribut cible d'un lien. Vous pouvez personnaliser votre WebChromeClient pour fournir votre propre comportement pour l'ouverture de plusieurs fenêtres.

Pour sécuriser davantage votre application, il est préférable d'empêcher l'ouverture de pop-ups et de nouvelles fenêtres. La méthode la plus sûre pour implémenter ce comportement consiste à transmettre "true" à setSupportMultipleWindows() sans remplacer la méthode onCreateWindow(), dont dépend setSupportMultipleWindows(). Cette logique empêche le chargement de toute page qui utilise target="_blank" dans ses liens.