Logging in FirstSpirit

Die Ausgabe von Statusmeldungen hilft sowohl den Nutzern eines Moduls beim Nachvollziehen der Arbeitsweise als auch Entwicklern bei der Fehlersuche. FirstSpirit unterstützt für diesen Zweck mehrere Schnittstellen, um Log-Ausgaben zu produzieren.

Base-Logging

Das sogenannte Base-Logging befindet sich im Package de.espirit.common.base und wird primär über die darin enthaltene Klasse Logging gesteuert.

import de.espirit.common.base.Logging;

public class Demo {
    private static final Class<?> LOGGER = Demo.class;

    public Demo() {
        Logging.logInfo("Demo application started.", LOGGER);
    }
}

FirstSpirit selbst nutzt diesen Mechanisum zum Protokollieren von Statusmeldungen, das heißt auch die von Modulen erzeugten Ereignisse landen an derselben Stelle, z.B. das fs-server.log bei Server-Komponenten wie Services. Web-Komponenten, welche die Funktionalität des ContentCreators erweitern, können diesen Logging-Mechanismus ebenfalls verwenden.

SLF4J

Die meisten Java-Entwickler werden im Laufe der Zeit mit der Simple Logging Facade for Java (SLF4J) in Berührung kommen. Dabei handelt es sich um eine einheitliche API zum Erzeugen von Logging, die über eine Vielzahl von Adaptern mit vielen Logging-Frameworks (Log4j, Logback, ...) zusammenarbeiten kann.

Seit der Version 2023.12 wird FirstSpirit mit einem SLF4J-Adapter ausgeliefert, der Logging über SLF4J an das Base-Logging weiterreicht. Die Vorteile dieser API sind unter anderem

Nutzung einer bekannten, einheitlichen Schnittstelle
einfacherer Aufruf ohne Class-Objekte
automatischer Ersatz von Platzhaltern

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

public class Demo {

    private static final Logger LOGGER = LoggerFactory.getLogger(Demo.class);

    public Demo() {
        LOGGER.info("Demo application started.");
    }
}

Auch diese API kann von Web-Komponenten, die zum ContentCreator hinzugefügt werden, ohne weitere Konfiguration verwendet werden. Bei anderen Komponenten, etwa solchen, die in einem eigenen Web-Context installiert werden, ist jedoch das Einbinden eines eigenen SL4FJ-Adapters notwendig.

Druckversion | Seitenanfang