Makina Blog

Le blog Makina-corpus

Construire une application hybride mobile et desktop avec Cordova et Electron


Comment concevoir une application déployable sur n'importe quel support ?

On connait maintenant bien les applications mobiles hybrides, mais il est également possible de créer une application desktop grâce à Electron à partir de langages web.

Qu'est ce qu'Electron ?

Electron est un outil créé par les équipes de Github qui permet d'encapsuler une web app pour en faire un exécutable sur desktop ou une application installable via un exécutable (compatible Windows, Mac OS, Linux). Les éditeurs de texte Atom et Visual Studio Code sont par exemple fait à partir d'Electron.

Le principe est donc à peu près le même que pour Cordova, notre app tourne dans une webview basée sur Chromium.

Quelques différences techniques avec Cordova

  • Electron intègre de base BabelJS et permet très facilement de coder en ES2015
  • Les Web API sont en général mieux supportées, de nombreuses fonctionnalités peuvent donc être utilisées directement avec la Web API comme pour du web classique, sans passer par un quelconque plugin (exemple : Talk To Speech, Camera, Vibrate, etc.)
  • Pas besoin de compiler à chaque modification, un simple ctrl+R suffit à mettre à jour l'application

Construire une app modulaire

En construisant notre app sous forme de modules, il est ensuite très simple de réutiliser son code pour différents projets. Nous allons créer ici 3 dossiers : electron, cordova et modules.

Les dossiers cordova et electron contiennent tous les deux uniquement une base fraichement installée (cordova create cordova pour cordova et le quick start pour electron seront de bonnes bases). Tous nos développement (ou presque) se feront dans nos modules.

Le rendu HTML sera uniquement généré en JS pour éviter d'avoir à écrire ou à importer du HTML dans chacun des projets. J'utilise ici React pour simplifier la manipulation du DOM.

Comment gérer les besoins spécifiques (plugins Cordova, etc.) ?

Comme évoqué précédemment, nous avons parfois besoin d'implémenter des plugins à Cordova pour accéder à certaines fonctionnalités, tandis qu'Electron gère très bien la Web API.

Nous utiliserons donc des modules pour chacunes des fonctionnalités nécessitant un plugin.

NB : Il est aussi possible d'utiliser des modules pour concevoir un comportement différent selon le type de device.

Dans notre exemple, nous utilisons la fonctionnalité TextToSpeech (tts), qui fonctionne avec la Web API pour Electron, mais qui nécéssite un plugin pour Cordova. Nous avons donc 2 modules spécifiques (se terminant respectivement par .webapi ou .cordova) et un module principal (reader) qui sera le coeur de notre projet.

Comment utiliser nos modules ?

./modules/reader/reader.js (notre module principal)

Le coeur de notre application se trouve dans ./modules/reader. Nous lui passons en paramètres ce qui doit être spécifique à une plateforme. Elle prend ici en options un objet contenant :

  • container : l'élément HTML dans lequel nous voulons initialiser notre app
  • tts : notre fonction de TTS (car Cordova passe par un plugin et devra avoir une syntaxe légèrement différente)
  • text : Le texte que nous voulons lire

Comme vous l'aurez remarqué, la syntaxe utilisée est en ES2015, il faudra donc au préalable utiliser BabelJS et un module loader (Webpack, Browserify, …) pour l'utilisation dans Cordova.

See the Pen Reader module by Alexandra J (@lellex) on CodePen.


./modules/tts.webapi/tts.webapi.js (service spécifique pour electron ou web)

./modules/tts.webapi est notre fonction de TTS pour Electron (ou pour le web puisqu'il s'agit de la Web Speech API)

See the Pen TTS Web API by Alexandra J (@lellex) on CodePen.


./modules/tts.cordova/tts.cordova.js (service spécifique pour cordova)

Pour utiliser la synthèse vocale dans Cordova, nous allons avoir besoin de ce plugin car la Web API ne fonctionnera pas. Il faudra donc installer le plugin dans notre projet cordova et créer une fonction correspondante dans nos modules (la syntaxe à l'utilisation n'est pas tout à fait la même que le web).

See the Pen TTS Cordova by Alexandra J (@lellex) on CodePen.


./electron

Le chargement des modules peut se faire via npm, en pointant vers son adresse s'il est en ligne ou notre dossier local (pas besoin de .js si notre module a un fichier main référencé dans son package.json)

npm install ./../modules/reader

Une fois notre package installé, nous pouvons les utiliser avec un require ou import dans Electron. Il suffira ensuite d'initialiser notre fonction de lecture avec les bons paramètres (la fonction TTS ainsi que la phrase que nous voulons lire).

See the Pen Reader by Alexandra J (@lellex) on CodePen.


./cordova/www/index.js

Pour Cordova, nous installons les modules de la même manière, avec npm. Par contre il n'y a pas de module loader contrairement à Electron, nous devrons donc charger les fichiers dans index.html.

Notre fichier JS cordova fait appel à Reader de la même manière qu'Electron, avec des options différentes.

See the Pen Cordova by Alexandra J (@lellex) on CodePen.


Démo

Une version démo de l'exemple ci-dessus est disponible sur Github avec des explications plus détaillées. Chacun des modules a ici été mis sur un dépôt, ce qui nous permet d'utiliser directement npm pour les installer.

Les application desktop ne sont donc pas mortes ?

Electron apporte aux développeurs web la possibilité de compiler leurs applications en une version desktop de manière très simple. Néanmoins, les applications packagées tendent à être de moins en moins utilisées avec l'évolution des navigateurs et des usages du web.

Comme pour le développement mobile, on peut se poser la question du choix de la techno : progressive web app ou webview ? Dans tous les cas, si notre application métier est conçue comme un module réutilisable, il sera assez aisé de changer d'environnement.

Actualités en lien

Image
Capture d'une partie de carte montrant un réseau de voies sur un fond de carte sombre. Au centre, une popup affiche les information de l'un des tronçons du réseau.
28/02/2024

Géné­rer un fichier PMTiles avec Tippe­ca­noe

Exemple de géné­ra­tion et d’af­fi­chage d’un jeu de tuiles vecto­rielles en PMTiles à partir de données publiques.

Voir l'article
Image
Read The Docs
01/02/2024

Publier une documentation VitePress sur Read The Docs

À l'origine, le site de documentation Read The Docs n'acceptait que les documentations Sphinx ou MKDocs. Depuis peu, le site laisse les mains libres pour builder sa documentation avec l'outil de son choix. Voici un exemple avec VitePress.

Voir l'article
Image
Widget
04/04/2023

Créer une application en tant que composant web avec Stencil

Mise en place dans le cadre de Geotrek, cette solution permet de se passer d'une iFrame pour afficher une application dans n'importe quel site.

Voir l'article

Inscription à la newsletter

Nous vous avons convaincus