Aller au contenu principal

Assets Protocols

Ouvrir dans ChatGPT

webforJ prend en charge des protocoles d'actifs personnalisés qui permettent un accès structuré et efficace aux ressources. Ces protocoles abstraient les complexités de la récupération des ressources statiques et dynamiques, garantissant que les actifs sont récupérés et intégrés de manière transparente dans l'application.

Le protocole webserver​

Le protocole ws:// vous permet de récupérer des actifs hébergés dans le dossier statique d'une application webforJ. Tous les fichiers situés dans le classpath de l'application src/main/resources/static sont directement accessibles depuis le navigateur. Par exemple, si vous avez un fichier nommé css/app.css dans resources/static, il peut être accessible à : /static/css/app.css

Le protocole ws:// supprime la nécessité de coder en dur le préfixe static dans vos URL de ressources, protégeant contre les préfixes modifiés selon le contexte de déploiement. Si l'application web est déployée sous un contexte autre que la racine, tel que /moncontexte, l'URL pour css/app.css serait : /moncontexte/static/css/app.css

Configuration du préfixe statique

Vous pouvez contrôler le préfixe static à l'aide de l'option de configuration webforj webforj.assetsDir. Ce paramètre spécifie le nom de la route utilisée pour servir des fichiers statiques, tandis que le dossier physique reste nommé static. C'est particulièrement utile si la route statique par défaut entre en conflit avec une route de votre application, car cela vous permet de changer le nom de la route sans renommer le dossier.

Vous pouvez utiliser la classe utilitaire Assets pour résoudre une URL de serveur web donnée. Cela peut être utile si vous avez un composant personnalisé qui doit prendre en charge ce protocole.

String url = Assets.resolveWebServerUrl("ws://js/app.js");

Le protocole de contexte​

Le protocole de contexte se rapporte aux ressources dans le classpath de l'application à src/main/resources. Certaines méthodes API de ressources et annotations prennent en charge ce protocole pour lire le contenu d'un fichier situé dans le dossier des ressources et envoyer son contenu au navigateur. Par exemple, l'annotation InlineJavaScript permet de lire le contenu d'un fichier JavaScript du dossier des ressources et de l'inclure côté client.

Par exemple :

String content = Assets.contentOf(
  Assets.resolveContextUrl("context://data/customers.json")
);

Le protocole des icônes​

Le protocole icons:// propose une approche dynamique de la gestion des icônes, rendant l'efficacité et la flexibilité lors de la génération et de la diffusion des icônes dans des applications installables. Ce protocole vous permet de générer des icônes à la volée en fonction du nom de fichier demandé et des paramètres, éliminant ainsi le besoin d'icônes pré-générées dans de nombreux cas.

Img icon = new Img("icons://icon-192x192.png")

Icône de base​

Lorsqu'une icône est demandée en utilisant le protocole icons://, une image de base est dérivée dynamiquement du nom de fichier d'icône demandé. Cela garantit la cohérence dans le design des icônes et permet un retour automatique à une image par défaut si aucune icône de base n'est fournie.

  • Exemple 1 : Demande : /icons/icon-192x192.png → Icône de base : resources/icons/icon.png
  • Exemple 2 : Demande : /icons/icon-different-192x192.png → Icône de base : resources/icons/icon-different.png

Si une image de base n'existe pas pour l'icône demandée, le logo webforJ par défaut est utilisé comme solution de secours.

webforj.iconsDir

Par défaut, webforJ sert des icônes depuis le répertoire resources/icons/. Vous pouvez changer le nom du point de terminaison en définissant la propriété webforj.iconsDir dans le fichier de configuration de webforJ. Cela ne change que le point de terminaison URL utilisé pour accéder aux icônes, pas le nom réel du dossier. Le point de terminaison par défaut est icons/.

Remplacement des icônes​

Vous pouvez remplacer des tailles d'icônes spécifiques en plaçant des images pré-générées dans le répertoire resources/icons/. Cela offre un meilleur contrôle sur l'apparence des icônes lorsque certaines tailles ou styles doivent être personnalisés.

  • Exemple : Si resources/icons/icon-192x192.png existe, il sera servi directement au lieu d'être généré dynamiquement.

Personnalisation de l'apparence des icônes​

Le protocole icons:// prend en charge des paramètres supplémentaires qui vous permettent de personnaliser l'apparence des icônes générées dynamiquement. Cela inclut des options pour le rembourrage et la couleur d'arrière-plan.

  • Rembourrage : Le paramètre padding peut être utilisé pour contrôler le rembourrage autour de l'icône. Les valeurs acceptées vont de 0, signifiant pas de rembourrage, à 1, signifiant un rembourrage maximum.

    • Exemple : /icons/icon-192x192.png?padding=0.3

  • Couleur d'arrière-plan : Le paramètre background vous permet de définir la couleur d'arrière-plan de l'icône. Il prend en charge les valeurs suivantes :

    • transparent : Pas de couleur d'arrière-plan.
    • Codes de couleur hexadécimaux : Couleurs d'arrière-plan personnalisées (par exemple, FFFFFF pour blanc).
    • auto : Tente de détecter automatiquement la couleur d'arrière-plan de l'icône.

    Par exemple :

    • Exemple 1 : /icons/icon-192x192.png?background=000000
    • Exemple 2 : /icons/icon-192x192.png?background=auto