Анотації @Configuration і @Bean для Java-based конфігурації

Сьогодні зосередимося на конфігурації Spring-додатків. Точніше — на тому, як Java-конфігурація з допомогою анотацій @Configuration і @Bean може замінити XML-файли і зробити життя простішим. Пристебайся, буде цікаво!

У "старі добрі" часи розробники Spring використовували для конфігурації XML-файли. Це було... чесно кажучи, далеко не найзручніше. Довгі XML-ки, повні тегів <bean> і прочих "роболірок", частіше викликали головний біль, ніж допомагали.

Java-based конфігурація — це як перехід від листів у пляшці відразу до електронної пошти. Вона дозволяє:

• Позбутися від XML: не треба стрибати між Java-кодом і XML, вся конфігурація тепер знаходиться там, де твій код.
• Зробити конфігурацію типізованою: користуєшся перевагами компіляції, і помилки стають очевидними ще до запуску.
• Забезпечити зручність і читабельність: колеги більше не дивитимуться на тебе здивовано, коли в проекті з'явиться черговий XML-файл.

Анотація @Configuration

Анотація @Configuration служить для вказівки Spring, що цей клас є конфігураційним. Це як сказати: "Гей, Spring, тримай інструкції, як налаштовувати наші бини, вони тут!"

Приклад використання

import org.springframework.context.annotation.Configuration;

@Configuration
public class AppConfig {

    // Тут буде наша магія bean-конфігурації
}

Досить просто, чи не так? Але що далі? Переходимо до анотації @Bean, де починається справжня магія.

Анотація @Bean

Анотація @Bean використовується для явного визначення бина в Spring-контексті. По суті, це метод, який повертає якийсь об'єкт (твій бин), а Spring піклується про керування його життєвим циклом.

Мінімальний приклад з @Bean

Давай створимо простий бин, що представляє наш основний сервіс:

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class AppConfig {

    @Bean
    public MyService myService() {
        return new MyService();
    }
}

class MyService {
    public void doSomething() {
        System.out.println("Працюємо з MyService!");
    }
}

Тепер, коли Spring підніме контекст (наприклад, через ApplicationContext), він автоматично створить екземпляр MyService і буде ним керувати.

Використання бінів у додатку

Окей, бин створено. Як його використовувати? Легко! У Spring він доступний для DI, наприклад:

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;

@Component
public class MyController {

    private final MyService myService;

    @Autowired
    public MyController(MyService myService) {
        this.myService = myService;
    }

    public void process() {
        myService.doSomething();
    }
}

Бін MyService автоматично вбудовується в контролер завдяки магії Spring. Круто, правда?

Відмінності між @Component і @Bean

Ключова відмінність у тому, де і як ти визначаєш свій бин:

• @Component: використовуй, якщо хочеш, щоб Spring автоматично знайшов твій клас і зареєстрував його як бин. Підходить для стандартних сценаріїв з невеликим рівнем кастомізації.

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

Приклад для @Bean

Припустимо, потрібно створити бин для конфігурації стороннього HTTP-клієнта:

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import okhttp3.OkHttpClient;

@Configuration
public class HttpClientConfig {

    @Bean
    public OkHttpClient httpClient() {
        return new OkHttpClient.Builder()
            .connectTimeout(30, TimeUnit.SECONDS)
            .readTimeout(30, TimeUnit.SECONDS)
            .build();
    }
}

Це не те, що можна автоматично відсканувати за допомогою @Component, тому використання @Bean тут більш доречне.

Зв'язування бінів: коли один бин залежить від іншого

Біни можуть залежати один від одного, і ти легко можеш це налаштувати за допомогою Java-based конфігурації. Уяви, що в нас є UserService, який залежить від UserRepository. Ось як це виглядатиме:

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class AppConfig {

    @Bean
    public UserRepository userRepository() {
        return new UserRepository();
    }

    @Bean
    public UserService userService(UserRepository userRepository) {
        return new UserService(userRepository);
    }
}

class UserRepository {
    // Ваш код репозиторію
}

class UserService {
    private final UserRepository userRepository;

    public UserService(UserRepository userRepository) {
        this.userRepository = userRepository;
    }

    public void processUsers() {
        System.out.println("Працюємо з користувачами!");
    }
}

Spring автоматично підставить екземпляр UserRepository в метод userService, саме завдяки IoC і DI. Зручно!

6. Переваги Java-based конфігурації перед XML

7. Коли використовувати @Bean?

Використовуй @Bean, коли:

• Тобі потрібно створювати об'єкти, які не є твоїми власними класами (наприклад, сторонні бібліотеки).
• Хочеш налаштувати бин з використанням складних параметрів.
• Потрібно явно контролювати створення бина.

Типові помилки з @Configuration і @Bean

Кожен з нас може помилятися (навіть найдосвідченіший розробник). Ось кілька розповсюджених помилок при роботі з Java-based конфігурацією:

• Забули анотацію @Configuration: якщо забути позначити клас як конфігураційний, Spring не дізнається про твої біни.
• Відсутність відповідності типів: переконайся, що повертаємий тип методу, позначеного @Bean, збігається з тим, що ти очікуєш інжектити.
• Циклічні залежності: якщо бин A залежить від бина B, а бин B залежить від бина A, це викличе помилку. Продумай архітектуру своїх бінів заздалегідь.

Цих помилок легко уникнути. Потрібні лише практика і увага до деталей!

Тепер ти знаєш, як використовувати анотації @Configuration і @Bean, щоб налаштовувати свої додатки в Spring. Кидай XML і насолоджуйся перевагами Java! Далі ми заглибимося в практичні аспекти створення конфігураційних класів і бінів.