Проблема конфігурації Spring Boot: відсутність ConfigurationPropertiesBindingPostProcessor

3 Березня 2024 в 01:55 40

У світі розробки програмного забезпечення не рідко зустрічаються складні технічні проблеми, які вимагають великої уваги та розуміння. Однією з таких проблем є невдале застосування анотації @ConfigurationProperties у Spring Boot проектах через відсутність ConfigurationPropertiesBindingPostProcessor. Розглянемо цей випадок докладніше.

У процесі розробки веб-додатків на базі Spring Boot дуже часто виникає потреба у налагодженні конфігурації. Завдяки механізму автоконфігурації, Spring Boot дозволяє з легкістю виконувати це завдання, забезпечуючи вбудовані засоби для роботи з конфігураційними файлами. Однак іноді можуть виникнути проблеми, пов’язані з некоректним застосуванням або налаштуванням.

Одним із зручних і потужних інструментів для роботи з конфігурацією є анотація @ConfigurationProperties. Ця анотація дозволяє зв’язати значення з файлу конфігурації з властивостями у Java-об’єкті. Такий підхід спрощує роботу з конфігурацією, роблячи код більш структурованим та зрозумілим.

Однак, коли виникає проблема, пов’язана з використанням анотації @ConfigurationProperties, може знадобитися глибоке розуміння того, як працює Spring Boot і що відбувається під капотом. Однією з таких проблем є відсутність ConfigurationPropertiesBindingPostProcessor, яка може призвести до того, що конфігураційні дані не будуть зчитані правильно.

Спробуємо розібратися в цьому питанні на конкретному прикладі. Припустимо, що ми розробляємо проект Spring Boot з використанням Maven multi-module. Одним із модулів є common-db, де ми розміщуємо конфігурацію бази даних та створюємо клас DataBaseProperties для роботи з нею.

@Configuration
@ConfigurationProperties("spring.datasource")
@Getter
@Setter
@ToString
@FieldDefaults(level = AccessLevel.PRIVATE)
@Slf4j
public class DataBaseProperties implements InitializingBean {
    String driverClassName = "com.mysql.cj.jdbc.Driver";
    Integer initialSize;
    Integer maxActive;
    Integer minIdle;
    Integer maxWait;
    Boolean showSql = false;
    String basePackage = "com.example.**.mapper";
    String[] mapperLocations;
    Boolean cacheEnabled = true;
    @Override
    public void afterPropertiesSet() {
        log.info("configuration properties: {}", this);
    }
}

@Configuration

@ConfigurationProperties("spring.datasource")

@Getter

@Setter

@ToString

@FieldDefaults(level = AccessLevel.PRIVATE)

@Slf4j

public class DataBaseProperties implements InitializingBean {

String driverClassName = "com.mysql.cj.jdbc.Driver";

Integer initialSize;

Integer maxActive;

Integer minIdle;

Integer maxWait;

Boolean showSql = false;

String basePackage = "com.example.**.mapper";

String[] mapperLocations;

Boolean cacheEnabled = true;

@Override

public void afterPropertiesSet() {

log.info("configuration properties: {}", this);

}

Далі, ми використовуємо файл spring.factories для автоматичного впровадження цього класу як біна:

# Auto Configure
org.springframework.boot.autoconfigure.EnableAutoConfiguration=com.example.common.db.config.properties.DataBaseProperties

1 2	# Auto Configure org.springframework.boot.autoconfigure.EnableAutoConfiguration=com.example.common.db.config.properties.DataBaseProperties

Після цього ми імпортуємо модуль common-db у головний проект. Однак, при спробі використати DataBaseProperties, ми стикаємося з проблемою: він не може отримати конфігураційні дані.

Спроби змінити префікс конфігурації, використати @EnableConfigurationProperties або навіть додати додаткові залежності Maven не приводять до успіху. Відладка показує, що під час ініціалізації DataBaseProperties відсутній ConfigurationPropertiesBindingPostProcessor, що ускладнює отримання конфігураційних даних.

Проблема полягає в тому, що DataBaseProperties використовує AnnotationConfigServletWebServerApplicationContext, а не AnnotationConfigApplicationContext, як більшість інших класів, які успішно отримують конфігураційні дані. Це призводить до того, що ConfigurationPropertiesBindingPostProcessor не включається в контекст додатка.

Для вирішення цієї проблеми можна використати деякі підходи. Одним із них є переконфігурування контексту додатка таким чином, щоб використовувався AnnotationConfigApplicationContext замість AnnotationConfigServletWebServerApplicationContext. Це можна зробити шляхом налаштування конфігурації Spring або зміною способу, яким модуль common-db імпортується у головний проект.

Також можна спробувати вручну додати ConfigurationPropertiesBindingPostProcessor до контексту додатка. Хоча цей підхід може бути менш елегантним, він може бути ефективним у вирішенні проблеми.

У будь-якому випадку, розуміння причин виникнення проблеми та вивчення можливих шляхів її вирішення є важливим етапом для кожного розробника. Незважаючи на те, що проблеми можуть бути складними та заплутаними, глибоке розуміння технологій та вміння ефективно діагностувати та вирішувати їх допомагає підтримувати проекти на правильному шляху.