Spring Boot

Ouvrir dans ChatGPT

Spring Boot est un choix populaire pour la création d'applications Java, offrant l'injection de dépendances, l'auto-configuration et un modèle de serveur intégré. Lorsque vous utilisez Spring Boot avec webforJ, vous pouvez injecter des services, des référentiels et d'autres beans gérés par Spring directement dans vos composants UI via l'injection de constructeur.

Lorsque vous utilisez Spring Boot avec webforJ, votre application s'exécute comme un JAR exécutable avec un serveur Tomcat intégré au lieu de déployer un fichier WAR sur un serveur d'application externe. Ce modèle d'emballage simplifie le déploiement et s'aligne avec les pratiques de déploiement cloud-native. Le modèle de composants de webforJ et le routage fonctionnent aux côtés du contexte d'application de Spring pour gérer les dépendances et la configuration.

Créer une application Spring Boot

Vous avez deux options pour créer une nouvelle application webforJ avec Spring Boot : en utilisant l'outil graphique startforJ ou la ligne de commande Maven.

Option 1 : Utiliser startforJ

Le moyen le plus simple de créer une nouvelle application webforJ est startforJ, qui génère un projet minimal de démarrage basé sur un archétype webforJ choisi. Ce projet de démarrage inclut toutes les dépendances requises, les fichiers de configuration et une mise en page préfabriquée, vous permettant de commencer à construire dessus immédiatement.

Lorsque vous créez une application avec startforJ, vous pouvez la personnaliser en fournissant les informations suivantes :

• Métadonnées de projet de base (Nom de l'application, ID de groupe, ID de l'artefact)
• Version de webforJ et version de Java
• Couleur et icône du thème
• Archétype
• Flavor - Sélectionnez webforJ Spring pour créer un projet Spring Boot

En utilisant ces informations, startforJ créera un projet de base à partir de l'archétype choisi, configuré pour Spring Boot. Vous pouvez choisir de télécharger votre projet sous forme de fichier ZIP ou de le publier directement sur GitHub.

Option 2 : Utiliser la ligne de commande

Si vous préférez utiliser la ligne de commande, générez un projet webforJ Spring Boot directement en utilisant les archétypes officiels de webforJ :

mvn -B archetype:generate \
  -DarchetypeGroupId=com.webforj \
  -DarchetypeArtifactId=webforj-archetype-hello-world \
  -DarchetypeVersion=LATEST \
  -DgroupId=org.example \
  -DartifactId=my-app \
  -Dversion=1.0-SNAPSHOT \
  -Dflavor=webforj-spring

Le paramètre flavor indique à l'archétype de générer un projet Spring Boot au lieu d'un projet webforJ standard.

Cela crée un projet Spring Boot complet avec :

• Configuration du POM parent de Spring Boot
• Dépendance de démarrage Spring Boot de webforJ
• Classe principale de l'application avec @SpringBootApplication et @Routify
• Vues d'exemple
• Fichiers de configuration pour Spring et webforJ

Ajouter Spring Boot à des projets existants

Si vous avez une application webforJ existante, vous pouvez ajouter Spring Boot en modifiant la configuration de votre projet. Ce processus implique la mise à jour de votre configuration Maven, l'ajout de dépendances Spring, et la conversion de votre classe principale de l'application.

Pour les projets existants uniquement

Sauter cette section si vous créez un nouveau projet à partir de zéro.

Étape 1 : Mettre à jour la configuration Maven

Apportez les modifications suivantes à votre fichier POM :

1. Changez l'emballage de WAR en JAR :

   pom.xml

   <packaging>jar</packaging>

2. Définissez Spring Boot comme POM parent :

   pom.xml

   <parent>
       <groupId>org.springframework.boot</groupId>
       <artifactId>spring-boot-starter-parent</artifactId>
       <version>3.5.3</version>
       <relativePath/>
   </parent>

3. Supprimez toute configuration spécifique à WAR, telle que :

   • maven-war-plugin
   • Références au répertoire webapp
   • Configuration liée à web.xml

Si vous avez déjà un POM parent, vous devrez importer le Bill of Materials (BOM) de Spring Boot à la place :

pom.xml

<dependencyManagement>
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-dependencies</artifactId>
            <version>3.5.3</version>
            <type>pom</type>
            <scope>import</scope>
        </dependency>
    </dependencies>
</dependencyManagement>

Étape 2 : Ajouter des dépendances Spring

Ajoutez le démarrage Spring Boot de webforJ à vos dépendances. Gardez votre dépendance webforJ existante :

pom.xml

<dependencies>
    <!-- Votre dépendance webforJ existante -->
    <dependency>
        <groupId>com.webforj</groupId>
        <artifactId>webforj</artifactId>
        <version>${webforj.version}</version>
    </dependency>
    
    <!-- Ajouter le démarrage Spring Boot -->
    <dependency>
        <groupId>com.webforj</groupId>
        <artifactId>webforj-spring-boot-starter</artifactId>
        <version>${webforj.version}</version>
    </dependency>

    <!-- Ajouter devtools -->
    <dependency>
      <groupId>com.webforj</groupId>
      <artifactId>webforj-spring-devtools</artifactId>
      <optional>true</optional>
    </dependency>

    <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-devtools</artifactId>
      <optional>true</optional>
    </dependency>
</dependencies>

Outils de développement webforJ pour un rafraîchissement automatique du navigateur

La dépendance webforj-spring-devtools étend Spring DevTools avec un rafraîchissement automatique du navigateur. Lorsque vous enregistrez des modifications dans votre IDE, le navigateur se recharge automatiquement sans intervention manuelle. Voir le guide Spring DevTools pour les détails de configuration.

Étape 3 : Mettre à jour les plugins de construction

Remplacez le plugin Jetty par le plugin Maven de Spring Boot. Supprimez toute configuration Jetty existante et ajoutez :

pom.xml

<build>
    <plugins>
      <plugin>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-maven-plugin</artifactId>
        <configuration>
          <excludeDevtools>true</excludeDevtools>
        </configuration>
      </plugin>
    </plugins>
</build>

Étape 4 : Convertir votre classe d'application

Transformez votre classe principale App en une application Spring Boot en ajoutant les annotations Spring nécessaires et une méthode main :

Application.java

package com.example;

import com.webforj.App;
import com.webforj.annotation.Routify;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
@Routify(packages = "com.example.views")
public class Application extends App {
    
    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }
    
    // Conservez votre méthode run() existante si vous en avez une
    @Override
    public void run() throws WebforjException {
      // Votre code d'initialisation existant 
    }
}

L'annotation @SpringBootApplication active l'auto-configuration et le scan des composants de Spring. L'annotation @Routify reste la même, continuant à scanner vos packages de vue pour les routes.

Étape 5 : Ajouter la configuration Spring

Créez application.properties dans src/main/resources :

application.properties

# Nom de la classe entièrement qualifiée du point d'entrée de l'application
webforj.entry = org.example.Application

# Nom de l'application
spring.application.name=Hello World Spring

# Configuration du serveur
server.port=8080
server.shutdown=immediate

# Configuration des outils de développement webforJ
spring.devtools.livereload.enabled=false
webforj.devtools.livereload.enabled=true
webforj.devtools.livereload.static-resources-enabled=true

Exécuter l'application Spring Boot

Une fois configurée, exécutez votre application en utilisant :

mvn spring-boot:run

L'application démarre avec un serveur Tomcat intégré sur le port 8080 par défaut. Vos vues et routes webforJ existantes fonctionnent exactement comme auparavant, mais maintenant vous pouvez injecter des beans Spring et utiliser les fonctionnalités de Spring.

Configuration

Utilisez le fichier application.properties dans src/main/resources pour configurer votre application. Consultez Configuration des propriétés pour des informations sur les propriétés de configuration de webforJ.

Les paramètres application.properties de webforJ suivants sont spécifiques à Spring :

Propriété	Type	Description	Par défaut
webforj.servletMapping	Chaîne	Modèle de mappage d'URL pour le servlet webforJ.	/*
webforj.excludeUrls	Liste	Modèles d'URL qui ne doivent pas être gérés par webforJ lorsqu'ils sont mappés à la racine. Lorsque webforJ est mappé au contexte racine (/*), ces modèles d'URL seront exclus de la gestion par webforJ et pourront être gérés par des contrôleurs Spring MVC à la place. Cela permet aux points de terminaison REST et autres mappages Spring MVC de coexister avec les routes webforJ.	[]

Différences de configuration

Lorsque vous passez à Spring Boot, plusieurs aspects de configuration changent :

Aspect	Standard webforJ	Spring Boot webforJ
Emballage	Fichier WAR	JAR exécutable
Serveur	Externe (Jetty, Tomcat)	Tomcat intégré
Commande d'exécution	mvn jetty:run	mvn spring-boot:run
Configuration principale	webforj.conf uniquement	application.properties + webforj.conf
Profils	webforj-dev.conf, webforj-prod.conf	Profils Spring avec application-{profile}.properties
Configuration du port	Dans la configuration du plugin	server.port dans les propriétés