Как считать компоненты из другой директории

Как считать компоненты из другой директории

Сканирование компонентов в Spring — это процесс автоматического обнаружения бинов (классов с аннотациями @Component, @Service, @Repository и т.д.) из указанных пакетов.

Базовое сканирование

// Spring автоматически сканирует пакет приложения
@SpringBootApplication
public class Application {
    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }
}

// @SpringBootApplication эквивалентен:
// @Configuration
// @EnableAutoConfiguration
// @ComponentScan(basePackages = "com.example")

Явное указание пакетов для сканирования

// Сканируем несколько пакетов
@ComponentScan(basePackages = {
    "com.example.services",
    "com.example.repositories",
    "com.example.controllers"
})
@Configuration
public class AppConfig {
}

// Или используя basePackageClasses для типобезопасности
@ComponentScan(basePackageClasses = {
    UserService.class,      // сканирует пакет com.example.services
    UserRepository.class    // сканирует пакет com.example.repositories
})
@Configuration
public class AppConfig {
}

Включение компонентов из внешней библиотеки

// Структура проекта:
// my-app/
//   ├── src/main/java/com/example/app/
//   │   └── Application.java
//   └── pom.xml
//
// external-lib.jar
//   └── com/example/external/
//       ├── ExternalService.class
//       └── ExternalComponent.class

// В Application.java — сканируем оба пакета
@SpringBootApplication
@ComponentScan(basePackages = {
    "com.example.app",
    "com.example.external"
})
public class Application {
    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }
}

Использование include и exclude фильтров

import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.FilterType;

@Configuration
@ComponentScan(
    basePackages = "com.example",
    includeFilters = {
        @ComponentScan.Filter(
            type = FilterType.ANNOTATION,
            classes = Component.class
        )
    },
    excludeFilters = {
        @ComponentScan.Filter(
            type = FilterType.ASSIGNABLE_TYPE,
            classes = TestComponent.class
        )
    }
)
public class AppConfig {
}

Регулярные выражения для фильтрации

@Configuration
@ComponentScan(
    basePackages = "com.example",
    includeFilters = @ComponentScan.Filter(
        type = FilterType.REGEX,
        pattern = ".*Service$"  // Только классы, заканчивающиеся на Service
    )
)
public class AppConfig {
}

Конфигурация через properties файл

# application.properties
spring.component-scan.base-packages=com.example.app,com.example.external

Явная регистрация бинов из другой директории

// Если компоненты не помечены аннотациями
public class ExternalService {
    public void doSomething() { }
}

// Регистрируем вручную
@Configuration
public class AppConfig {
    @Bean
    public ExternalService externalService() {
        return new ExternalService();
    }
}

Использование @Import для импорта конфигов

// external-lib содержит конфигурацию
public class ExternalLibConfig {
    @Bean
    public ExternalService externalService() {
        return new ExternalService();
    }
}

// В основном приложении импортируем эту конфигурацию
@SpringBootApplication
@Import(ExternalLibConfig.class)
public class Application {
    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }
}

Spring Boot AutoConfiguration для библиотек

// В external-lib создаём:
// src/main/resources/META-INF/spring.factories

// Содержимое spring.factories:
// org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
//   com.example.external.config.ExternalAutoConfig

@Configuration
@ConditionalOnMissingBean(ExternalService.class)
public class ExternalAutoConfig {
    @Bean
    public ExternalService externalService() {
        return new ExternalService();
    }
}

// В основном приложении просто добавляем зависимость
// Spring Boot автоматически включит конфигурацию

Условное сканирование

@Configuration
public class AppConfig {
    @Bean
    @ConditionalOnProperty(
        name = "app.enable-external",
        havingValue = "true"
    )
    public ExternalService externalService() {
        return new ExternalService();
    }
}

// application.properties
// app.enable-external=true

Профили для разных директорий

// Конфигурация для development
@Configuration
@Profile("dev")
@ComponentScan(basePackages = "com.example.dev")
public class DevConfig {
}

// Конфигурация для production
@Configuration
@Profile("prod")
@ComponentScan(basePackages = "com.example.prod")
public class ProdConfig {
}

// application.properties
// spring.profiles.active=dev

Пример с Maven модулями

<!-- parent pom.xml -->
<project>
    <modules>
        <module>app</module>
        <module>external-lib</module>
    </modules>
</project>

<!-- app/pom.xml -->
<dependency>
    <groupId>com.example</groupId>
    <artifactId>external-lib</artifactId>
    <version>1.0</version>
</dependency>

// В app/src/main/java/com/example/app/Application.java
@SpringBootApplication
@ComponentScan(basePackages = {
    "com.example.app",
    "com.example.external"
})
public class Application {
    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }
}

Отладка: что было отсканировано

@Component
public class ComponentScanDebugger {
    private final ApplicationContext context;
    
    public ComponentScanDebugger(ApplicationContext context) {
        this.context = context;
        logScannedBeans();
    }
    
    private void logScannedBeans() {
        String[] beans = context.getBeanDefinitionNames();
        System.out.println("Found " + beans.length + " beans:");
        for (String bean : beans) {
            System.out.println("  - " + bean);
        }
    }
}

Лучшие практики

1. Используй @SpringBootApplication — автоматически сканирует текущий пакет
2. Явно указывай basePackages — если нужны классы из других директорий
3. Используй @Import — для импорта готовых конфигураций
4. Профили — для разных конфигов в разных окружениях
5. AutoConfiguration — для переиспользуемых библиотек
6. Тестируй сканирование — убедись, что нужные бины зарегистрированы
7. Документируй — где и какие компоненты сканируются

Правильное сканирование компонентов — основа гибкой архитектуры Spring приложений.