Spring dans un contexte web

Serveurs de pages

Nous traiterons dans ce chapitre des serveurs de pages, principalement à travers l’utilisation du moteur de template Thymeleaf.

Configuration par annotation

Les serveurs web demandent généralement un fichier web.xml. Il est utilisé dans les applications déployées sur des serveurs de servlet, tels qu’Apache Tomcat, pour configurer divers aspects du comportement de l’application web.

La version avec annotation permet de ne pas avoir de fichier web.xml.

Pour la partie back :

@Configuration 
@ComponentScan({ "fr.eni.mvc.annot.service" }) 
public class SpringArriereConfig { 

Pour la partie web, dans le cas particulier de JSP :

@EnableWebMvc 
@Configuration 
@ComponentScan({ "fr.eni.mvc.annot.web" }) 
public class SpringWebConfig extends WebMvcConfigurerAdapter { 
   @Override 
   public void addResourceHandlers(ResourceHandlerRegistry 
                                   registry) { 
      registry.addResourceHandler("/resources/**") 
              .addResourceLocations("/resources/"); ...

Contrôleur

Une classe contrôleur dans le modèle MVC (modèle-vue-contrôleur) est marquée avec l’annotation @Controller. Son rôle principal est de gérer les requêtes HTTP entrantes et de renvoyer une réponse appropriée.

   @RequestMapping(value = "/home"...

Gestion des exceptions et des erreurs

Dans Spring MVC, la gestion des erreurs et des exceptions sont deux aspects liés, mais distincts du traitement des situations anormales ou inattendues qui peuvent survenir lors de l’exécution d’une application. Comprendre la différence entre ces deux concepts est crucial pour une bonne conception d’une application Spring MVC.

La gestion des exceptions dans Spring MVC est axée sur la capture et le traitement des exceptions Java spécifiques, tandis que la gestion des erreurs est centrée sur le traitement des erreurs au niveau HTTP.

Les deux mécanismes permettent de répondre de manière appropriée et cohérente aux situations d’erreur, améliorant ainsi la robustesse et la fiabilité de l’application.

@RestController

Le @RestController dans Spring MVC est une spécialisation du @Controller, apportant des fonctionnalités supplémentaires qui facilitent grandement le développement d’API REST. La principale différence entre @RestController et @Controller réside dans leur traitement des réponses des méthodes de contrôleur. Alors que @Controller est typiquement utilisé pour renvoyer des vues ou des pages HTML en utilisant des moteurs de rendu, @RestController est conçu pour créer des contrôleurs qui retournent directement des données, généralement au format JSON ou XML. Cela en fait une solution plus pratique et épurée, idéale pour le développement d’API REST dans nos applications Spring MVC, où l’accent est mis sur le renvoi de données plutôt que de vues.

Classes UriComponentsBuilder

La classe UriComponentsBuilder est une classe utile de Spring Framework utilisée pour construire et manipuler des URI de manière programmatique. Elle est particulièrement pratique pour créer des URI complexes de manière dynamique, par exemple lors de la construction de liens d’API REST.

UriComponentsBuilder permet de construire un URI en ajoutant différents composants tels que le schéma, l’hôte, le port, le chemin, les paramètres de requête, etc. Il gère également l’encodage correct des composants de l’URI et permet de manipuler facilement les URI existants.

Imaginons que nous développions une API REST où nous devons créer un lien vers une ressource spécifique après sa création. Par exemple, après avoir créé un nouvel utilisateur, nous souhaitons renvoyer un en-tête Location avec l’URI de cette nouvelle ressource utilisateur.

Voici comment nous pourrions faire :

@RestController 
public class UserController { 
 
  @PostMapping("/users") 
  public ResponseEntity<Object> createUser(@RequestBody 
         User user, UriComponentsBuilder uriBuilder) { 
    User createdUser = userService.createUser(user); 
    //...

Client REST

Dans Spring MVC, nous disposons de plusieurs clients REST adaptés pour consommer des services web RESTful, permettant d’envoyer des requêtes HTTP et de recevoir des réponses depuis des applications externes. Chaque client REST présente des avantages et des cas d’utilisation spécifiques. RestTemplate est une option simple et directe, bien adaptée pour les besoins standards. Cependant, pour les applications nécessitant des fonctionnalités asynchrones ou réactives, WebClient est souvent le meilleur choix, offrant plus de flexibilité et une meilleure gestion des flux de données. Pour les applications orientées cloud, Feign se révèle particulièrement utile, en facilitant la création de clients d’API web de manière déclarative. Par ailleurs, Apache HttpClient est idéal pour les situations nécessitant un contrôle très fin sur les requêtes HTTP, comme dans des cas d’utilisation plus complexes ou personnalisés.

import org.springframework.web.client.RestTemplate; ...

Spring Security

Spring Security est un framework de sécurité puissant et hautement personnalisable qui facilite l’ajout de fonctionnalités de sécurité robustes aux applications Java et Spring. Il offre des mécanismes pour gérer l’authentification, l’autorisation, la protection contre les attaques courantes, et bien plus encore. Voici les principaux aspects de Spring Security.

@Configuration 
@EnableWebSecurity 
public class WebSecurityConfig { 
 
  @Bean 
  public SecurityFilterChain securityFilterChain(HttpSecurity http) 
          throws Exception { 
  http 
    .authorizeHttpRequests((requests) -> requests 
    .requestMatchers("/", "/home").permitAll() 
    .anyRequest().authenticated() 
    ) 
    .formLogin((form) -> form 
    .loginPage("/login") 
    .permitAll() 
    ) 
    .logout((logout) -> logout.permitAll()); 
 
  return http.build(); 
  } 
 
  @Bean 
  public UserDetailsService userDetailsService() { 
  UserDetails user = 
    User.withDefaultPasswordEncoder() ...

Spring et HATEOAS

Spring HATEOAS est une extension de Spring qui simplifie la création d’API REST conformes à l’approche HATEOAS, un principe de conception des services web RESTful favorisant l’utilisation de liens hypertextes pour une navigation et une interaction dynamiques avec les ressources. En s’intégrant avec Spring MVC, Spring HATEOAS facilite l’incorporation automatique de liens hypertextes dans les réponses d’API, permettant ainsi une découverte intuitive des fonctionnalités disponibles sans que les clients aient besoin de connaître les URL ou points de terminaison à l’avance.

Cette intégration rend le développement d’API RESTful respectant HATEOAS plus simple et moins sujet à erreurs, grâce à l’usage des annotations et classes de Spring HATEOAS pour générer ces liens dynamiquement, améliorant ainsi l’expérience de développement au sein des applications Spring.

Utilisation de MapStruct

Dans les architectures logicielles multicouches, le recours au modèle DTO (Data Transfer Object) facilite le transfert de données entre différentes couches, mais soulève le défi de l’écriture manuelle de code de mappage, souvent volumineuse et répétitive. MapStruct, une bibliothèque Java, adresse ce problème en automatisant le mappage des données grâce à la génération de code basée sur des interfaces annotées, simplifiant ainsi le processus. Cette bibliothèque s’intègre harmonieusement avec le CDI de Spring et Lombok, permettant la création de mappers sous forme de beans Spring, ce qui optimise la conversion entre entités JPA et DTO correspondantes. Pour les développeurs cherchant à minimiser le code de mappage manuel tout en maintenant une architecture propre, MapStruct représente une solution efficace, avec une documentation complète disponible pour faciliter son intégration et son utilisation dans des projets Spring.

Pour créer une interface MapStruct qui automatise la conversion entre une entité JPA et un DTO correspondant, vous pouvez suivre cet exemple :

Définissez votre entité JPA :

   public class User { 
     private Long id; 
     private...

Approche API-First

La conception des backends pour les Web Services SOAP ou REST a évolué. Initialement, l’API était créée après le développement du service backend. Cette approche pouvait conduire à des API non optimales. Récemment, une méthode "API-First" a été adoptée, où l’API est définie avant le développement du service, favorisant ainsi une meilleure conception et intégration.

Pour les API REST, il n’y avait pas de norme standard jusqu’à l’émergence de Swagger, remplacé plus tard par OpenAPI. Ces standards facilitent la cohérence, la réutilisation et l’automatisation partielle du codage des API. L’approche API-First favorise également un découplage entre le producteur et le consommateur de l’API. Les normes actuelles pour REST incluent Swagger 2.0 et OpenAPI 3.0.

Spring Actuator

Spring Boot Actuator est un module qui permet d’obtenir des informations opérationnelles sur notre application.

Pour l’utiliser avec Spring Boot, il suffit d’ajouter la dépendance maven :

<dependency> 
   <groupId>org.springframework.boot</groupId> 
   <artifactId>spring-boot-starter-actuator</artifactId> 
</dependency> 

Le module fonctionne avec les applications Spring MVC et Spring Webflux et il utilise les endpoints HTTP et JMX pour exposer les informations.

Avec Spring Boot 2, seuls les endpoints /health et /info sont exposés pour limiter les problèmes de sécurité.

Endpoints disponibles :