Journalisation des informations du projet avec Log4j2

Introduction

Dans ce projet, vous allez apprendre à intégrer le framework de journalisation Log4j2 dans une application Spring Boot. Vous allez configurer Log4j2 pour enregistrer les informations du projet dans la console et dans les fichiers de journal.

👀 Aperçu

🎯 Tâches

Dans ce projet, vous allez apprendre :

• Comment modifier le fichier pom.xml pour ajouter les dépendances Log4j2 nécessaires
• Comment configurer Log4j2 dans le fichier application.properties
• Comment créer un logger et enregistrer des informations en utilisant différents niveaux de journalisation dans le fichier DemoApplication.java
• Comment emballer et exécuter l'application Spring Boot pour voir les informations enregistrées

🏆 Réalisations

Après avoir terminé ce projet, vous serez capable de :

• Utiliser le framework de journalisation Log4j2 dans une application Spring Boot
• Configurer Log4j2 pour enregistrer des informations dans la console et dans les fichiers de journal
• Créer un logger et utiliser différents niveaux de journalisation pour enregistrer des informations
• Emballer et exécuter une application Spring Boot

Modifier le fichier pom.xml

Dans cette étape, vous allez apprendre à modifier le fichier pom.xml pour intégrer le framework de journalisation Log4j2 dans le projet Spring Boot.

1. Ouvrez le fichier pom.xml dans le projet springbootlog4j2.

2. Ajoutez la dépendance spring-boot-starter-log4j2 à la section <dependencies> :

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

3. Pour exclure la dépendance Logback par défaut, ajoutez le code suivant à la section <dependencies> :

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter</artifactId>
    <exclusions>
        <exclusion>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-logging</artifactId>
        </exclusion>
    </exclusions>
</dependency>

Cela garantira que seul Log4j2 est utilisé comme framework de journalisation dans le projet.

Configurer Log4j2 dans le fichier application.properties

Dans cette étape, vous allez apprendre à configurer le framework de journalisation Log4j2 dans le fichier application.properties.

1. Ouvrez le fichier application.properties dans le répertoire /src/main/resources/.

2. Ajoutez la ligne suivante au fichier :

logging.config=classpath:log4j2.xml

Cette ligne indique à l'application Spring Boot d'utiliser le fichier de configuration log4j2.xml situé dans le classpath.

Modifier le fichier DemoApplication.java

Dans cette étape, vous allez apprendre à créer un logger et à enregistrer les informations en utilisant différents niveaux de journalisation dans le fichier DemoApplication.java.

1. Ouvrez le fichier DemoApplication.java dans le répertoire /src/main/java/org/labex/springbootlog4j2/.

2. Créez un objet logger à l'aide du code suivant :

private static final Logger logger = LoggerFactory.getLogger(DemoApplication.class);

3. Dans la méthode sayhello(), ajoutez les instructions de journalisation suivantes :

logger.error("This is an error message");
logger.warn("This is a warning message");
logger.info("This is an info message");
logger.debug("This is a debug message");

4. Notez que nous devons importer les classes pertinentes :

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

Ces instructions de journalisation enregistreront les informations en utilisant les niveaux de journalisation correspondants.

Emballer et exécuter l'application

Dans cette étape, vous allez apprendre à emballer l'application Spring Boot et à l'exécuter.

1. Ouvrez un terminal et accédez au répertoire du projet springbootlog4j2.

2. Exécutez la commande suivante pour emballer l'application :

cd springbootlog4j2
mvn clean package

Cela générera un fichier JAR dans le répertoire target.

3. Exécutez l'application à l'aide de la commande suivante :

mvn spring-boot:run

Après le démarrage du service, cliquez d'abord sur Web 8080 au-dessus de l'environnement, vous pouvez voir l'effet d'exécution suivant, puis revenez à la console pour voir les informations enregistrées.

4. Pour voir les fichiers de journal, accédez au répertoire logs dans le projet. Vous devriez voir les fichiers de journal créés par la configuration Log4j2.

Félicitations! Vous avez réussi à intégrer le framework de journalisation Log4j2 dans le projet Spring Boot et à le configurer pour enregistrer les informations dans la console et les fichiers de journal.

Résumé

Félicitations! Vous avez terminé ce projet. Vous pouvez pratiquer plus de laboratoires dans LabEx pour améliorer vos compétences.