Java / Spring: comment générer complètement une API CRUD REST à l'aide de Speedment

Dans cet article, vous apprendrez à utiliser Speedment pour créer une API CRUD REST complète pour une base de données.



Il devient de plus en plus évident chaque année que Spring Framework est l'un des frameworks de développement Web Java les plus utilisés.

À l'approche de la prochaine décennie, le module le plus populaire de Spring, Spring Boot, vient de recevoir une mise à jour majeure. Les nouvelles versions de Spring Boot "2.2.0" et 2020 sont presque parfaitement adaptées les unes aux autres. Par conséquent, l'équipe de développement de Speedment a comblé cette lacune en mettant à jour le plugin Spring Boot.

Si c'est la première fois que vous entendez parler de Speedment, vous l'apprécierez car nous montrons comment le plugin Spring Boot Speedment permet aux développeurs de créer sans effort des applications de base de données Spring à l'aide de Speedment, ORM avec une puissante interface de requête basée sur l'API Stream.

À propos de Speedment

Speedment peut être décrit comme l'ORM que la communauté Java mérite - une boîte à outils pour ceux qui aiment le développement rapide et les applications encore plus rapides.

En utilisant l'API Java Stream comme principal moyen de communication avec la base de données sélectionnée, Speedment permet aux développeurs ayant une expérience Java de se sentir chez eux. En plus de l'API facile à utiliser, Speedment fournit aux développeurs un outil graphique qui génère un modèle de domaine pour eux en quelques secondes.

Si vous êtes intéressé par Speedment dans son ensemble, cliquez sur le lien suivant pour une documentation détaillée avec des exemples . Le reste de cet article se concentrera sur le plugin Spring Boot.

Spring Boot: Démarrage le plus rapide

Le plugin Speedment Spring Boot existe depuis un certain temps, mais Speedment 3.2.2 a introduit la fonction principale - la possibilité de générer l'intégralité de l'API CRUD REST directement à partir de votre modèle de base de données.

Selon que vous partez de zéro ou que vous avez déjà un projet, les étapes seront différentes, mais assurez-vous que le processus d'intégration sera simple quel que soit l'état de votre projet.

Si vous souhaitez intégrer Spring Boot dans un projet Speedment existant, vous devez ajouter les 2 éléments suivants à votre pom.xml :

<plugin> <groupId>com.speedment.enterprise</groupId> <artifactId>speedment-enterprise-maven-plugin</artifactId> <version>${speedment.version}</version> <configuration> <components> component>com.speedment.enterprise.plugins.spring.SpringGeneratorBundle</component> </components> <appName>${project.artifactId}</appName> <packageName>${project.groupId}</packageName> </configuration> ... // Database connector dependency </plugin> <dependencies> ... <dependency> <groupId>javax.annotation</groupId> <artifactId>javax.annotation-api</artifactId> <version>1.3.1</version> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> <version>2.2.1.RELEASE</version> </dependency> <dependency> <groupId>com.speedment.enterprise.plugins</groupId> <artifactId>spring-runtime</artifactId> <version>${speedment.version}</version> </dependency> ... </dependencies> 

Après avoir ajouté ces éléments lors de la prochaine régénération de votre modèle de domaine, une configuration spécifique à Spring doit être générée. La configuration générée contrôle les propriétés de connexion à la base de données et d'enregistrement de bac pour les différents gestionnaires générés par Speedment.

Si vous démarrez le projet à partir de zéro, accédez à l' initialiseur de projet , où un projet prêt à l'emploi pour Spring Boot sera créé pour vous. La façon dont vous allez configurer le projet dépend de vous, mais pour inclure le plugin Spring Boot dans le projet généré, assurez-vous que la case à côté de Spring est cochée dans la section plugins. Lorsque la configuration du projet vous convient, cliquez sur le bouton Télécharger et vous recevrez une archive de projet prête à l'emploi.

CRUD simplifié

Une fois le plugin installé, certaines options spécifiques de Spring Boot seront disponibles dans l'outil Speedment que vous pouvez utiliser pour configurer votre API REST. Vous pouvez exécuter l'outil Speedment en exécutant la commande suivante:

 mvn speedment:tool 

Si c'est la première fois que vous utilisez Speedment, vous souhaiterez peut-être vous familiariser avec le flux de travail en suivant le bref didacticiel Hello Speedment .

Par défaut, l'outil Speedment ne génère pas d'API REST. Pour générer une API CRUD REST pour une table spécifique, sélectionnez la table dans l'arborescence et cochez la case « Generate @RestController » ainsi que l'option « REST Enable Create / Update / Delete ». Lorsque vous cliquez sur Générer , un ensemble de mappages REST sera créé - des URL qui implémentent des opérations CRUD pour une table spécifique.



C'est tout! Le codage manuel n'est pas requis. Exécutez simplement le projet Spring généré en exécutant la commande:

 mvn spring-boot:run 

Création d'entités à l'aide de REST

Pour créer une nouvelle entité à l'aide de l'API REST que vous avez créée, vous devez exécuter une demande POST sur le chemin spécifié dans l'outil. Par défaut, le nom de ce chemin correspond au nom de votre table, avec le préfixe du nom de votre schéma. Si vous décochez la case « REST Endpoint », vous pouvez spécifier un nom de chemin arbitraire. Le corps de la demande doit contenir des paires clé-valeur dans l'objet JSON, où les valeurs " REST Field Name " de l'outil Speedment sont des clés.

Par exemple, si nous avons une table nommée personne avec les colonnes id , nom et âge , nous enverrons la requête suivante pour créer une nouvelle personne entité:

 POST localhost:8080/db/person { "id": 1, "name": "Jane", "age": 25 } 

ou

 curl -d '{"id": 1,"name": "Jane","age": 25}' -H "Content-Type:application/json" -X POST localhost:8080/db/person 

Si la valeur de la colonne id est générée automatiquement (ou utilise une séquence), vous pouvez l'exclure du corps POST. Si vous souhaitez exclure de force une colonne spécifique du corps POST, cliquez sur la colonne correspondante dans l'arborescence des outils et décochez la case « Inclure dans la création de corps » et recréez votre modèle de domaine. D'un autre côté, si vous voulez vous assurer qu'une colonne spécifique existe dans le corps POST lors de l'exécution de la demande, cochez «Requis dans Créer un corps» et recréez votre modèle de domaine.

Récupération d'entités à l'aide de REST

Pour obtenir notre entité nouvellement créée, nous devons exécuter une demande GET de la même manière que celle utilisée pour créer l'entité:

 GET localhost:8080/db/person 

ou

 curl localhost:8080/db/person/1 

Une demande terminée renverra un tableau JSON de toutes les entités existantes. Dans notre cas, il retournerait un tableau uniquement avec notre seule entité:

 [ { "id": 1, "name": "Jane", "age": 25 } ] 

Les concepts avancés tels que les filtres et les trieurs sont détaillés dans la documentation officielle de Speedment.

Mise à jour des entités existantes à l'aide de REST

La mise à jour d'une entité existante à l'aide de l'API REST est similaire à la création d'une entité. Au lieu d'une demande POST, nous exécutons une demande PATCH et le chemin est développé avec un identifiant d'entité. L'identifiant de notre entité dépend de la colonne de clé primaire de cette table. Puisque notre colonne PK (clé primaire) est de type numérique, notre identifiant d'entité sera un entier.

Pour mettre à jour l'entité que nous avons créée dans notre exemple précédent, nous exécuterons la requête suivante:

 PATCH localhost:8080/db/person/1 { "name": "Mike", "age": 43 } 

ou

 curl -d '{"name": "Jane","age": 25}' -H "Content-Type:application/json" -X PATCH localhost:8080/db/person/1 

Par défaut, toutes les colonnes sont incluses dans le corps PATCH (à l'exception de la colonne de clé primaire), mais elles ne sont pas obligatoires. Si vous souhaitez exclure de force une colonne spécifique du corps de la demande, cliquez sur la colonne correspondante dans l'arborescence des outils et décochez la case « Inclure dans le corps de la mise à jour » et recréez votre modèle de domaine. D'un autre côté, si vous voulez vous assurer qu'une colonne existe dans le corps de la demande, cochez « Requis dans le corps de mise à jour » et mettez à jour votre modèle de domaine.

Suppression d'entités à l'aide de REST

La suppression d'une entité à l'aide de l'API REST est assez simple - nous exécutons une demande DELETE de la même manière que celle utilisée pour mettre à jour les entités.

Pour supprimer l'entité que nous avons créée et mise à jour dans les exemples précédents, nous exécuterions la requête suivante:

 DELETE localhost:8080/db/person/1 

ou

 curl -X DELETE localhost:8080/db/person/1 

Résumé

Le lancement de nouveaux projets peut parfois être gênant. En tant que développeurs, nous voulons éviter autant que possible ces inconvénients et plonger directement dans le codage. Avec le nouveau plugin Speed ​​Boot Spring Boot, les développeurs peuvent accélérer le lancement de nouveaux projets en générant automatiquement toutes les configurations nécessaires et les contrôleurs REST directement à partir de la base de données.

Nous espérons que vous avez apprécié ce petit guide des nouvelles fonctionnalités CRUD fournies par le plugin Speedment Spring Boot. Si vous êtes intéressé par une explication plus détaillée des nouvelles fonctions, rendez-vous dans la documentation officielle , où vous trouverez des explications détaillées et des exemples de nouvelles fonctions CRUD.

Lecture complémentaire

Création d'une API REST Partie 4: Gestion des demandes POST, PUT et DELETE

Création d'une application MVC CRUD RESTful Spring Boot de base: Prise en main de Java Spring