Configuration des propriétés webforJ
Pour déployer et exécuter avec succès une application webforJ, quelques fichiers de configuration clés sont nécessaires : webforj.conf et web.xml. Chacun de ces fichiers contrôle différents aspects du comportement de l'application, allant des points d'entrée et des paramètres de débogage aux mappages de servlets.
Configuration de webforj.conf
Le fichier webforj.conf est un fichier de configuration central dans webforJ, spécifiant les paramètres de l'application tels que les points d'entrée, le mode débogage et l'interaction client-serveur. Le fichier est au format HOCON et doit se trouver dans le répertoire resources.
conseil
Si vous intégrez avec Spring, vous pouvez définir ces propriétés webforj.conf dans le fichier application.properties.
Exemple de fichier webforj.conf
# Ce fichier de configuration est au format HOCON :
# https://github.com/lightbend/config/blob/master/HOCON.md
webforj.entry = com.webforj.samples.Application
webforj.debug = true
webforj.reloadOnServerError = on
webforj.clientHeartbeatRate = 1s
Options de configuration
| Propriété | Type | Explication | Valeur par défaut |
|---|---|---|---|
webforj.assetsCacheControl | String | En-tête Cache-Control pour les ressources statiques. | null |
webforj.assetsDir | String | Le nom de route utilisé pour servir des fichiers statiques, tandis que le nom de dossier réel reste static. Cette configuration est utile si la route static par défaut entre en conflit avec une route définie dans votre application, vous permettant de changer le nom de route sans renommer le dossier lui-même. | null |
webforj.assetsExt | String | Extension de fichier par défaut pour les fichiers statiques. | null |
webforj.assetsIndex | String | Fichier par défaut servi pour les demandes de répertoire (ex., index.html). | null |
webforj.clientHeartbeatRate | String | L'intervalle auquel le client interroge le serveur pour voir s'il est toujours actif. Pour le développement, définissez cela sur un intervalle plus court, par exemple 8s, pour détecter rapidement la disponibilité du serveur. Définit à 50 secondes ou plus en production pour éviter des requêtes excessives. | 50s |
webforj.components | String | Lorsqu'il est spécifié, le chemin de base détermine où les composants DWC sont chargés. Par défaut, les composants sont chargés à partir du serveur hébergeant l'application. Cependant, définir un chemin de base personnalisé permet de charger des composants à partir d'un serveur alternatif ou d'un CDN. Par exemple, pour charger des composants depuis jsdelivr.com, définissez le chemin de base sur : https://cdn.jsdelivr.net/gh/webforj/dwc-dist@1.0.0-${webforj.version}. Il est important que les composants chargés soient compatibles avec la version du framework webforJ utilisée ; sinon, l'application peut ne pas fonctionner comme prévu. Ce paramètre est ignoré lorsqu'une installation BBj standard est utilisée sans le moteur. Pour une installation BBj standard, le paramètre peut être géré avec le !COMPONENTS STBL. | null |
webforj.debug | Boolean | Active le mode débogage. En mode débogage, webforJ affichera des informations supplémentaires dans la console et montrera toutes les exceptions dans le navigateur. Le mode débogage est désactivé par défaut. | null |
webforj.entry | String | Définit le point d'entrée de l'application en spécifiant le nom entièrement qualifié de la classe qui étend webforj.App. Si aucun point d'entrée n'est défini, webforJ analysera automatiquement le classpath pour les classes qui étendent webforj.App. Si plusieurs classes sont trouvées, une erreur se produira. Lorsqu'un paquet comprend plus d'un point d'entrée potentiel, le définir explicitement est nécessaire pour éviter l'ambiguïté, ou alternativement, l'annotation AppEntry peut être utilisée pour spécifier le point d'entrée lors de l'exécution. | null |
webforj.fileUpload.accept | List | Les types de fichiers autorisés pour les téléchargements de fichiers. Par défaut, tous les types de fichiers sont autorisés. Les formats pris en charge incluent des types MIME tels que image/*, application/pdf, text/plain, ou des extensions de fichiers comme *.txt. Lors d'une utilisation d'une installation BBj standard, ce paramètre est ignoré et géré via fileupload-accept.txt. | [] |
webforj.fileUpload.maxSize | Long | La taille maximale de fichier autorisée pour les téléchargements de fichiers, en octets. Par défaut, il n'y a pas de limite. Lors d'une utilisation d'une installation BBj standard, ce paramètre est ignoré et géré via fileupload-accept.txt. | null |
webforj.iconsDir | String | Point de terminaison URL pour le répertoire des icônes (par défaut, sert depuis resources/icons/). | icons/ |
webforj.license.cfg | String | Le répertoire pour la configuration de la licence. Par défaut, c'est le même que le répertoire de configuration de webforJ, mais cela peut être personnalisé si nécessaire. | "." |
webforj.license.startupTimeout | Integer | Délai d'attente de démarrage de la licence en secondes. | null |
webforj.locale | String | La locale pour l'application, déterminant la langue, les paramètres régionaux et les formats pour les dates, heures et nombres. | null |
webforj.quiet | Boolean | Désactive l'image de chargement lors du démarrage de l'application. | false |
webforj.reloadOnServerError | Boolean | Environnements de développement uniquement. Dans un environnement de développement, recharger automatiquement la page lors d'erreurs liées à la redéployment à chaud, mais pas d'autres types d'erreurs. Lors de l'utilisation du déploiement à chaud, si le client envoie une requête au serveur pendant qu'il redémarre, une erreur peut se produire pendant que le fichier WAR est échangé. Parce que le serveur sera probablement de nouveau en ligne sous peu, ce paramètre permet au client d'essayer de recharger automatiquement la page. | false |
webforj.servlets[n].name | String | Nom du servlet (utilise le nom de classe si non spécifié). | null |
webforj.servlets[n].className | String | Nom de classe entièrement qualifié du servlet. | null |
webforj.servlets[n].config.<key> | Map<String,String> | Paramètres d'initialisation du servlet. | null |
webforj.sessionTimeout | Integer | Durée du délai d'attente de session en secondes. | 60 |
webforj.stringTable | Map<String,String> | Une carte de paires clé-valeur utilisées pour stocker des chaînes pour une utilisation dans l'application. Utile pour stocker des messages ou des étiquettes de l'application. Plus d'informations sur StringTable peuvent être trouvées ici. | {} |
webforj.mime.extensions | Map<String,String> | Mappages de type MIME personnalisés pour des extensions de fichiers lors du service de fichiers statiques. Vous permet de remplacer les types MIME par défaut ou de définir des types MIME pour des extensions personnalisées. La clé de la carte est l'extension de fichier (sans le point), et la valeur est le type MIME. | {} |
Configuration de web.xml
Le fichier web.xml est un fichier de configuration essentiel pour les applications web Java, et dans webforJ, il définit des paramètres importants tels que la configuration des servlets, les modèles d'URL et les pages d'accueil. Ce fichier doit se trouver dans le répertoire WEB-INF de la structure de déploiement de votre projet.
| Paramètre | Explication | Valeur par défaut |
|---|---|---|
<display-name> | Définit le nom d'affichage pour l'application web, généralement dérivé du nom du projet. Ce nom apparaît dans les consoles de gestion des serveurs d'applications. | ${project.name} |
<servlet> et <servlet-mapping> | Définit le WebforjServlet, le servlet principal pour traiter les requêtes webforJ. Ce servlet est mappé à toutes les URL (/*), ce qui en fait le point d'entrée principal pour les requêtes web. | WebforjServlet |
<load-on-startup> | Spécifie que WebforjServlet doit être chargé lorsque l'application démarre. En le définissant sur 1, cela fait que le servlet se charge immédiatement, améliorant ainsi le traitement de la demande initiale. | 1 |