Логирование информации о проекте с использованием Log4j2

Введение

В этом проекте вы научитесь интегрировать фреймворк логирования Log4j2 в приложение Spring Boot. Вы настроите Log4j2 для записи информации о проекте как в консоль, так и в файлы журнала.

👀 Предварительный просмотр

🎯 Задачи

В этом проекте вы научитесь:

• Как изменить файл pom.xml для добавления необходимых зависимостей Log4j2
• Как настроить Log4j2 в файле application.properties
• Как создать логгер и записать информацию с использованием различных уровней логирования в файле DemoApplication.java
• Как упаковать и запустить приложение Spring Boot для просмотра записанной информации

🏆 Достижения

После завершения этого проекта вы сможете:

• Использовать фреймворк логирования Log4j2 в приложении Spring Boot
• Настроить Log4j2 для записи информации в консоль и файлы журнала
• Создать логгер и использовать различные уровни логирования для записи информации
• Упаковать и запустить приложение Spring Boot

Изменить файл pom.xml

В этом шаге вы научитесь изменять файл pom.xml для интеграции фреймворка логирования Log4j2 в проект Spring Boot.

1. Откройте файл pom.xml в проекте springbootlog4j2.

2. Добавьте зависимость spring-boot-starter-log4j2 в раздел <dependencies>:

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

3. Чтобы исключить стандартную зависимость Logback, добавьте следующий код в раздел <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>

Это обеспечит то, что в проекте будет использоваться только Log4j2 в качестве фреймворка логирования.

Настроить Log4j2 в файле application.properties

В этом шаге вы научитесь настраивать фреймворк логирования Log4j2 в файле application.properties.

1. Откройте файл application.properties в директории /src/main/resources/.

2. Добавьте следующую строку в файл:

logging.config=classpath:log4j2.xml

Эта строка сообщает приложению Spring Boot использовать файл конфигурации log4j2.xml, расположенный в classpath.

Изменить файл DemoApplication.java

В этом шаге вы научитесь создавать логгер и записывать информацию с использованием различных уровней логирования в файле DemoApplication.java.

1. Откройте файл DemoApplication.java в директории /src/main/java/org/labex/springbootlog4j2/.

2. Создайте объект логгера с использованием следующего кода:

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

3. В методе sayhello() добавьте следующие инструкции по логированию:

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. Обратите внимание, что нам нужно импортировать соответствующие классы:

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

Эти инструкции по логированию будут записывать информацию с использованием соответствующих уровней логирования.

Собрать и запустить приложение

В этом шаге вы научитесь упаковывать приложение Spring Boot и запускать его.

1. Откройте терминал и перейдите в директорию проекта springbootlog4j2.

2. Запустите следующую команду для упаковки приложения:

cd springbootlog4j2
mvn clean package

Это создаст JAR-файл в директории target.

3. Запустите приложение с использованием следующей команды:

mvn spring-boot:run

После запуска сервиса сначала нажмите на Web 8080 выше среды, вы сможете увидеть следующий эффект запуска, а затем вернитесь в консоль, чтобы просмотреть записанную информацию.

4. Чтобы просмотреть файлы журнала, перейдите в директорию logs в проекте. Вы должны увидеть файлы журнала, созданные конфигурацией Log4j2.

Поздравляем! Вы успешно интегрировали фреймворк логирования Log4j2 в проект Spring Boot и настроили его для записи информации в консоль и файлы журнала.

Резюме

Поздравляем! Вы завершили этот проект. Вы можете практиковаться в более многих лабораторных работах в LabEx, чтобы улучшить свои навыки.