SpringBoot - @Profile注解详解

最新推荐文章于 2025-09-17 20:18:58 发布

原创最新推荐文章于 2025-09-17 20:18:58 发布 · 591 阅读

0 ·

CC 4.0 BY-SA版权

文章标签：

#spring boot

SpringBoot 专栏收录该内容

108 篇文章

订阅专栏

本文介绍了如何利用Spring的@Profile注解在-dev，-prod，-local等不同环境中动态激活或切换组件。@Profile注解允许我们指定组件在特定环境下注册到Spring容器。使用包括：与@Component等注解配合，指定生效环境，标注在类或方法上，并通过spring.profiles.active配置激活。文章详细阐述了激活注解的多种方式，以及项目中常见的环境配置文件应用场景。

写在前面

在实际的项目中，会有-dev，-prod，-local等不同的运行环境，有时需要能够根据当前的运行/部署环境动态激活或者切换相关的组件场景，针对该场景我们可以借助 Spring 提供的 @Profile 注解来实现。

注解说明

@Profile注解用于指定某些组件在特定的运行环境下才会被注册到SPRING容器中，若不使用该注解，则在任何环境下都能注册这个组件到SPRING容器中。

如何使用

A. 与@Component、@Configuration、@Bean注解配合使用；
B. @Profile中需要指定一个字符串，这个字符串表明生效的环境，一般和application-XXX.yml对应；
C. @Profile可以标注在类、方法或者是注解上；
D. 需要与spring.profiles.active=dev的激活配置配合使用。

激活注解

一般在实际项目中有4个配置文件，分别在不同的场景下使用：

applcation.yml       # 公共配置, 一般存放不会因为运行环境不同而改变的信息
application-dev.yml  # 开发环境配置
application-test.yml # 测试环境配置
application-prod.yml # 生产环境配置

在 applcation.yml 文件中可以通过以下配置来激活profile：
spring:
  profiles:
    active: prod

或者
System.setProperty("spring.profiles.active", "prod");

或者
java -jar spring-boot-test-0.0.1-SNAPSHOT.jar --spring.profiles.active=prod；