如何在 Spring Boot 应用程序中使用 Spring 配置文件-java教程-PHP中文网

如何在 Spring Boot 应用程序中使用 Spring 配置文件

王林

发布： 2024-08-05 14:47:42

原创

1158 人浏览过

How to Use Spring Profiles in Your Spring Boot Application

Spring Profiles 提供了一种强大的方法来隔离应用程序配置的各个部分，并使其仅在某些环境中可用。此功能对于在不更改代码的情况下处理开发、测试和生产环境的不同配置特别有用。

什么是 Spring 配置文件？

Spring 配置文件允许您根据活动配置文件有条件地注册 Bean。这意味着您可以定义多个相同类型的 bean，并指定在给定环境中应激活哪个 bean。

设置弹簧配置文件

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 Boot 应用程序时使用 --spring.profiles.active 参数激活配置文件：

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
    }
}

登录后复制

在此示例中，仅当 dev 配置文件处于活动状态时才会创建 devDataSource bean，而当 prod 配置文件处于活动状态时才会创建 prodDataSource bean。

测试特定于配置文件的 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 {
}

登录后复制