【Java教程】Day23-06 Spring Boot开发：使用Profiles管理多环境配置

原创于 2025-01-10 00:16:56 发布 · 832 阅读

17 ·

CC 4.0 BY-SA版权

文章标签：

#java #spring boot #开发语言

Java教程专栏收录该内容

280 篇文章

订阅专栏

在开发和部署过程中，应用程序通常需要在不同的环境下运行，如开发环境、测试环境和生产环境。Spring Boot提供了Profiles功能，可以在同一个项目中根据不同的环境配置不同的属性和功能。这使得在不同的环境中能够使用不同的配置，而不需要修改代码。

今天，我们将深入了解如何使用Spring Boot的Profiles功能来管理多环境配置。

1. 什么是Profile？

Profile是Spring提供的一种机制，用于根据不同的环境加载不同的配置。常见的环境包括：

native：本地开发环境
test：测试环境
production：生产环境

你还可以根据项目的不同分支，定义如master和dev等不同的环境。

启动应用时指定Profile：

你可以在启动应用程序时通过命令行指定激活的Profile。例如，以下命令会激活test和master这两个环境：

bash-Dspring.profiles.active=test,master

2. 在Spring Boot中配置不同的Profile

Spring Boot允许在application.yml中为不同的Profile配置不同的属性。通过使用---分隔符，可以在同一个配置文件中配置多个Profile的设置。

配置示例：

yamlspring:  application:    name: ${APP_NAME:unnamed}  datasource:    url: jdbc:hsqldb:file:testdb    username: sa    password:     driver-class-name: org.hsqldb.jdbc.JDBCDriver    hikari:      auto-commit: false      connection-timeout: 3000      validation-timeout: 3000      max-lifetime: 60000      maximum-pool-size: 20      minimum-idle: 1pebble:  suffix:  cache: falseserver:  port: ${APP_PORT:8080}---spring:  config:    activate:      on-profile: testserver:  port: 8000---spring:  config:    activate:      on-profile: productionserver:  port: 80pebble:  cache: true

解析：

第一段配置是默认配置，如果没有指定Profile，应用将使用此配置。
第二段配置是在test环境下使用的配置，设置了server.port为8000。
第三段配置是在production环境下使用的配置，设置了server.port为80，并启用了Pebble的缓存。

默认Profile：

如果未指定任何Profile，Spring Boot将默认使用default环境。可以从Spring Boot的启动日志中看到：

bashINFO 13537 --- [           main] com.itranswarp.learnjava.Application : No active profile set, falling back to 1 default profile: "default"

激活特定Profile：

你可以在启动时通过以下命令来激活test环境：

bash$ java -Dspring.profiles.active=test -jar springboot-profiles-1.0-SNAPSHOT.jar

此时，你可以在启动日志中看到：

bashINFO 13510 --- [           main] com.itranswarp.learnjava.Application : The following 1 profile is active: "test"INFO 13510 --- [           main] o.s.b.w.embedded.tomcat.TomcatWebServer : Tomcat started on port(s): 8000 (http) with context path ''

日志显示，当前激活的Profile是test，Tomcat监听在8000端口。

3. 通过Profile实现环境特定的功能

假设你需要在不同环境下使用不同的存储服务。例如，在本地开发环境下使用文件存储，而在测试和生产环境下使用云存储。可以通过Profile来实现这种功能。

定义存储服务接口

javapublic interface StorageService {    // 根据URI打开InputStream    InputStream openInputStream(String uri) throws IOException;    // 根据扩展名和InputStream保存并返回URI    String store(String extName, InputStream input) throws IOException;}

本地存储服务实现（适用于`default`环境）

java@Component@Profile("default")public class LocalStorageService implements StorageService {    @Value("${storage.local:/var/static}")    String localStorageRootDir;    final Logger logger = LoggerFactory.getLogger(getClass());    private File localStorageRoot;    @PostConstruct    public void init() {        logger.info("Initializing local storage with root dir: {}", this.localStorageRootDir);        this.localStorageRoot = new File(this.localStorageRootDir);    }    @Override    public InputStream openInputStream(String uri) throws IOException {        File targetFile = new File(this.localStorageRoot, uri);        return new BufferedInputStream(new FileInputStream(targetFile));    }    @Override    public String store(String extName, InputStream input) throws IOException {        String fileName = UUID.randomUUID().toString() + "." + extName;        File targetFile = new File(this.localStorageRoot, fileName);        try (OutputStream output = new BufferedOutputStream(new FileOutputStream(targetFile))) {            input.transferTo(output);        }        return fileName;    }}

云存储服务实现（适用于非`default`环境）

java@Component@Profile("!default")public class CloudStorageService implements StorageService {    @Value("${storage.cloud.bucket:}")    String bucket;    @Value("${storage.cloud.access-key:}")    String accessKey;    @Value("${storage.cloud.access-secret:}")    String accessSecret;    final Logger logger = LoggerFactory.getLogger(getClass());    @PostConstruct    public void init() {        // TODO: Initialize cloud storage        logger.info("Initializing cloud storage...");    }    @Override    public InputStream openInputStream(String uri) throws IOException {        // TODO: Implement cloud storage access        throw new IOException("File not found: " + uri);    }    @Override    public String store(String extName, InputStream input) throws IOException {        // TODO: Implement cloud storage access        throw new IOException("Unable to access cloud storage.");    }}

说明：

LocalStorageService使用了@Profile("default")注解，表示当没有指定Profile或指定为default时，使用本地存储服务。
CloudStorageService使用了@Profile("!default")注解，表示非default环境时使用云存储服务。