Journalisation dans les applications Kotlin : meilleures pratiques pour débutants

Journalisation dans les applications Kotlin : meilleures pratiques pour débutants

La journalisation ne consiste pas simplement à écrire des messages dans un fichier. C'est un système qui aide le développeur à comprendre ce qui se passe dans l'application en temps réel, à trouver rapidement les erreurs et à analyser le comportement des utilisateurs. Dans cet article, nous allons voir comment organiser correctement la journalisation dans les applications Kotlin, quelles bibliothèques utiliser et quelles erreurs éviter.

Pourquoi la journalisation est-elle nécessaire ?

La journalisation répond à plusieurs objectifs clés :

\n
• Débogage : permet de voir la séquence des appels et les valeurs des variables sans utiliser de débogueur.
\n
• Surveillance : aide à suivre l'état de l'application en environnement de production.
\n
• Audit : enregistre les actions des utilisateurs et les événements système.
\n
• Performance : les logs permettent d'identifier les goulots d'étranglement et les ralentissements.
\n

Bibliothèques populaires pour la journalisation en Kotlin

Dans l'écosystème Kotlin et JVM, il existe plusieurs solutions éprouvées. Voici les principales :

\n
• SLF4J (Simple Logging Facade for Java) — une façade qui n'implémente pas elle-même la journalisation, mais fournit une API unifiée pour différentes implémentations (Logback, Log4j2, etc.).
\n
• Logback — l'implémentation la plus populaire de SLF4J. Rapide, flexible, avec prise en charge des fichiers rotatifs.
\n
• Log4j 2 — une bibliothèque puissante avec prise en charge de la journalisation asynchrone et du filtrage.
\n
• Kotlin Logging — une enveloppe pratique pour SLF4J, utilisant des fonctions inline pour minimiser les frais généraux.
\n

Configuration de Logback dans un projet Kotlin

Voyons la configuration étape par étape de Logback, la solution la plus populaire pour les applications Kotlin/JVM.

Étape 1. Ajout des dépendances

Dans le fichier build.gradle.kts, ajoutez :

dependencies {\n    implementation("ch.qos.logback:logback-classic:1.4.14")\n    implementation("io.github.microutils:kotlin-logging-jvm:3.0.5")\n}

Étape 2. Création du fichier de configuration

Créez le fichier src/main/resources/logback.xml :

<configuration>\n    <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">\n        <encoder>\n            <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>\n        </encoder>\n    </appender>\n\n    <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">\n        <file>logs/app.log</file>\n        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">\n            <fileNamePattern>logs/app.%d{yyyy-MM-dd}.log</fileNamePattern>\n            <maxHistory>30</maxHistory>\n        </rollingPolicy>\n        <encoder>\n            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>\n        </encoder>\n    </appender>\n\n    <root level="INFO">\n        <appender-ref ref="CONSOLE"/>\n        <appender-ref ref="FILE"/>\n    </root>\n</configuration>

Cette configuration affiche les logs dans la console et dans un fichier avec une rotation quotidienne (les logs sont conservés pendant 30 jours).

Étape 3. Utilisation dans le code

Utilisons la bibliothèque kotlin-logging :

import mu.KotlinLogging\n\nprivate val logger = KotlinLogging.logger {}\n\nfun main() {\n    logger.info("Application démarrée")\n    logger.debug { "Valeur de la variable x = $x" }\n    try {\n        // du code\n    } catch (e: Exception) {\n        logger.error(e) { "Erreur lors de l'exécution de l'opération" }\n    }\n}

Niveaux de journalisation : quand utiliser quoi

Le bon choix du niveau est la base de logs lisibles. Dans Logback, les niveaux suivants sont disponibles