Aide-mémoire Spring Boot

Aide-mémoire Spring Boot

Annotations

Annotation	Description	Example
@SpringBootApplication	Marks a class as a Spring Boot application. Enables auto-configuration and component scanning.	@SpringBootApplication
@RestController	Indicates that a class provides RESTful endpoints. It combines @Controller and @ResponseBody annotations.	@RestController
@RequestMapping	Maps HTTP requests to handler methods of RESTful controllers.	@RequestMapping("/api")
@Autowired	Injects dependencies into a Spring bean. It can be used for constructor, setter, or field injection.	@Autowired private MyService myService;
@Component	Indicates that a class is a Spring-managed component. It is automatically detected during component scanning.	@Component
@Repository	Marks a class as a Spring Data repository. It handles data access and persistence logic.	@Repository
@Service	Marks a class as a service component in the business layer. It is used to separate business logic from presentation logic.	@Service
@Configuration	Indicates that a class provides bean definitions. It is used along with @bean to define beans in Java-based configuration.	@Configuration
@Value	Injects values from properties files or environment variables into Spring beans.	@Value("${my.property}") private String property;

Flux de contrôle

1. Initialisation : Spring Boot démarre en chargeant les propriétés de l'application et en configurant automatiquement les beans.
2. Analyse des composants : Spring analyse les composants tels que les contrôleurs, les services et les référentiels.
3. Création de bean : Spring crée des beans et résout les dépendances à l'aide de l'injection de dépendances.
4. Gestion des demandes : les requêtes HTTP entrantes sont mappées aux méthodes du contrôleur en fonction des mappages de requêtes.
5. Exécution : les méthodes du contrôleur gèrent les requêtes, interagissent avec les services et renvoient des réponses.
6. Rendu des réponses : Spring convertit les valeurs de retour de la méthode en réponses HTTP appropriées (par exemple, JSON).

Structure de dossier recommandée

src
├── principal
│ ├── java
│ │ └── com
│ │ └── exemple
│ │ ├── contrôleur
│ │ │ └── MonContrôleur.java
│ │ ├── service
│ │ │ └── MonService.java
│ │ └── Application.java
│ └── ressources
│ ├── application.properties
│ └── modèles
│ └── index.html
└── tester
└── java
└──com
└── exemple
└── contrôleur
└── MonControllerTest.java

Gestion des erreurs dans l'aide-mémoire Spring Boot

La gestion des erreurs est un aspect essentiel de la création d'applications robustes. Spring Boot fournit plusieurs mécanismes pour gérer les erreurs et les exceptions avec élégance, garantissant ainsi une expérience utilisateur fluide.

Types d'erreurs

• Erreurs client : erreurs causées par des demandes client non valides, telles que 400 Bad Request ou 404 Not Found.
• Erreurs de serveur : erreurs se produisant côté serveur, telles que 500 erreur de serveur interne.
• Erreurs de validation : erreurs dues à des entrées non valides ou à des échecs de validation des données.

Mécanismes de gestion des erreurs

1. Conseils du contrôleur

• @ControllerAdvice : une annotation utilisée pour définir les gestionnaires d'exceptions globaux dans Spring MVC.
• @ExceptionHandler : une annotation utilisée pour gérer des exceptions spécifiques dans un avis de contrôleur.
• Exemple :

@ControllerAdvice
public class GlobalExceptionHandler {

    @ExceptionHandler(MyException.class)
    public ResponseEntity<ErrorResponse> handleMyException(MyException ex) {
        ErrorResponse response = new ErrorResponse("My error message");
        return new ResponseEntity<>(response, HttpStatus.BAD_REQUEST);
    }

    @ExceptionHandler(Exception.class)
    public ResponseEntity<ErrorResponse> handleException(Exception ex) {
        ErrorResponse response = new ErrorResponse("Internal server error");
        return new ResponseEntity<>(response, HttpStatus.INTERNAL_SERVER_ERROR);
    }
}

ResponseEntityExceptionHandler

• ResponseEntityExceptionHandler : une classe de base pour gérer les exceptions Spring MVC courantes.
• Overrides : remplacez les méthodes telles que handleMethodArgumentNotValid, handleHttpMessageNotReadable, etc.
• Exemple :

@ControllerAdvice
public class CustomExceptionHandler extends ResponseEntityExceptionHandler {

@Override
protected ResponseEntity<Object> handleMethodArgumentNotValid(
        MethodArgumentNotValidException ex, HttpHeaders headers, HttpStatus status, WebRequest request) {
    ErrorResponse response = new ErrorResponse("Validation failed");
    return new ResponseEntity<>(response, HttpStatus.BAD_REQUEST);
}

// Other overrides for handling specific exceptions

3. Attributs d'erreur

• ErrorAttributes : Interface utilisée pour personnaliser le contenu et le format des réponses d'erreur.
• DefaultErrorAttributes : implémentation par défaut fournie par Spring Boot.

@Component
public class CustomErrorAttributes extends DefaultErrorAttributes {
@Override
public Map<String, Object> getErrorAttributes(WebRequest webRequest, boolean includeStackTrace) {
    Map<String, Object> errorAttributes = super.getErrorAttributes(webRequest, includeStackTrace);
    errorAttributes.put("customAttribute", "Custom value");
    return errorAttributes;
}

}

Utilisation des fichiers de propriétés

• application.properties : stockez les propriétés à l'échelle de l'application telles que le port du serveur, l'URL de la base de données, etc.
• Fichiers de propriétés personnalisées : définissez des fichiers de propriétés personnalisées pour différents environnements (par exemple, application-dev.properties).
• Accès aux propriétés : accédez aux propriétés à l'aide de l'annotation @Value ou de l'API d'environnement de Spring.

Projet de construction

• Maven : Exécutez mvn clean install pour construire le projet et générer un JAR exécutable.
• Gradle : Exécutez ./gradlew build pour construire le projet et générer un JAR exécutable.

Sujets supplémentaires

• Spring Boot Starters : utilisez des démarreurs pour ajouter des dépendances et une configuration automatique à votre projet.
• Journalisation : configurez la journalisation à l'aide de Logback, Log4j ou Java Util Logging.
• Gestion des erreurs : implémentez la gestion globale des exceptions avec @ControllerAdvice.
• Tests : rédigez des tests unitaires et des tests d'intégration à l'aide de JUnit, Mockito et SpringBootTest.

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!