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

Что такое пружинные профили?

Профили Spring позволяют регистрировать bean-компоненты условно, в зависимости от активного профиля. Это означает, что вы можете определить несколько bean-компонентов одного и того же типа и указать, какой из них должен быть активным в данной среде.

Настройка профилей Spring

1. Создание файлов конфигурации

Spring Boot использует для конфигурации набор файлов application-{profile}.properties или application-{profile}.yml. Эти файлы содержат конфигурации, специфичные для профиля, и загружаются на основе активного профиля.

Конфигурация по умолчанию (application.yml)

spring:
  application:
    name: MySpringApp

server:
  port: 8080  # Default port

Конфигурация разработки (application-dev.yml)

spring:
  datasource:
    url: jdbc:h2:mem:devdb
    username: sa
    password: ""
    driver-class-name: org.h2.Driver
  jpa:
    hibernate:
      ddl-auto: update
    show-sql: true

server:
  port: 8081  # Development port

Производственная конфигурация (application-prod.yml)

spring:
  datasource:
    url: jdbc:mysql://prod-db-server:3306/proddb
    username: prod_user
    password: prod_password
    driver-class-name: com.mysql.cj.jdbc.Driver
  jpa:
    hibernate:
      ddl-auto: validate
    show-sql: false

server:
  port: 8082  # Production port

Активация пружинных профилей

2. Активация профилей через командную строку

Вы можете активировать профиль, используя параметр --spring.profiles.active при запуске приложения Spring Boot:

java -jar my-spring-app.jar --spring.profiles.active=dev

3. Активация профилей через свойства приложения.

Альтернативно вы можете указать активный профиль в файле application.yml:

spring:
  profiles:
    active: dev  # or prod

4. Активация профилей через переменные среды

Вы также можете установить активный профиль с помощью переменной среды:

export SPRING_PROFILES_ACTIVE=dev

Использование профилей в коде

Spring предоставляет аннотацию @Profile для условной регистрации bean-компонентов на основе активного профиля. Вот пример:

Примеры классов конфигурации

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

@Configuration
public class AppConfig {

    @Bean
    @Profile("dev")
    public DataSource devDataSource() {
        return new HikariDataSource();  // Development-specific DataSource
    }

    @Bean
    @Profile("prod")
    public DataSource prodDataSource() {
        return new HikariDataSource();  // Production-specific DataSource
    }
}

В этом примере bean-компонент devDataSource будет создан только тогда, когда активен профиль dev, а bean-компонент prodDataSource будет создан, когда активен профиль prod.

Тестирование Bean-компонентов, специфичных для профиля

При написании тестов вы можете указать, какие профили должны быть активными, с помощью аннотации @ActiveProfiles:

import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.ActiveProfiles;

@SpringBootTest
@ActiveProfiles("dev")
public class DevProfileTests {

    @Autowired
    private DataSource dataSource;

    @Test
    public void testDataSource() {
        // Test code using the development DataSource
    }
}

Специфические для профиля свойства

Иногда вам может потребоваться загрузить разные файлы свойств в зависимости от активного профиля. Для этого вы можете использовать аннотацию @PropertySource:

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

@Configuration
@PropertySource("classpath:application-${spring.profiles.active}.properties")
public class PropertyConfig {
}

Заключение

Профили Spring — это надежный и гибкий способ управления различными конфигурациями для различных сред. Разделяя свойства конфигурации и компоненты на основе профилей, вы можете гарантировать, что ваше приложение будет работать правильно в каждой среде, будь то разработка, тестирование или производство. Используя методы, описанные в этой статье, вы можете легко настраивать профили и управлять ими в приложении Spring Boot.