Spring Profiles环境配置详解

文
章
目
录

• 一、@Profile注解
• 二、设置Profiles的多种方式
• （一）通过web.xml设置
• （二）借助WebApplicationInitializer
• （三）利用JVM参数
• （四）借助环境变量
• （五）通过Maven Profile
• （六）不同设置方式的优先级
• 三、Default Profile
• 四、Spring Boot Profile

Spring框架开发的项目，我们常常会面临不同环境下配置不同的情况，比如开发环境、测试环境和生产环境。Spring Profiles为我们解决了这个难题，让我们能轻松将Bean映射到不同的运行环境中。今天，咱们就来深入了解一下Spring Profiles。

一、@Profile注解

@Profile注解是Spring Profiles中非常重要的一个工具，它的作用是把Bean和特定的运行环境对应起来。打个比方，我们在开发项目时，开发环境和生产环境可能使用不同的数据源。在开发环境下，我们可能会使用一个专门用于测试的数据源，方便我们调试代码。这时，就可以利用@Profile注解来配置。

@Component
@Profile(\"dev\")
public class DevDatasourceConfig

上面这段代码表示，DevDatasourceConfig这个Bean只会在开发（dev）环境下被注入到Bean容器中。也就是说，只有当项目运行在开发环境时，这个Bean才会生效。

@Profile注解还支持“not”运算符。如果我们不想让某个Bean在特定环境下被注入，就可以使用这个运算符。比如，不想让某个Bean在开发环境下被注入，代码可以这样写：

@Component
@Profile(\"!dev\")
public class DevDatasourceConfig

这样一来，DevDatasourceConfig这个Bean就不会在开发环境下被注入了。

二、设置Profiles的多种方式

在实际开发中，我们有多种方法来设置当前使用的Profiles。下面就来详细介绍一下。

（一）通过web.xml设置

在Java Web应用里，我们可以在web.xml文件中通过context parameter来设置。具体代码如下：

<context-param>
  <param-name>spring.profiles.active</param-name>
  <param-value>dev</param-value>
</context-param>

这段代码的意思是，将当前的Profiles设置为开发环境（dev）。

（二）借助WebApplicationInitializer

WebApplicationInitializer是Spring提供的一个接口，它能让我们在基于Servlet API的Java Web应用启动时，用编程的方式配置ServletContext。通过实现这个接口，我们可以在应用启动时动态设置Servlet容器的参数，而不用依赖传统的web.xml文件。

@Configuration
public class MyWebApplicationInitializer 
  implements WebApplicationInitializer {

    @Override
    public void onStartup(ServletContext servletContext) throws ServletException {
 
        servletContext.setInitParameter(
          \"spring.profiles.active\", \"dev\");
    }
}

在上述代码中，当应用启动时，会将spring.profiles.active这个参数设置为“dev”，也就是设置为开发环境。

（三）利用JVM参数

在项目启动的时候，我们还可以通过JVM系统参数来设置Profiles。只需要在启动命令中添加-Dspring.profiles.active=dev这样的参数，就可以把项目设置为开发环境运行。

（四）借助环境变量

操作系统的环境变量也能用来设置Profiles。以Unix系统为例，在命令行中输入export spring_profiles_active=dev，就能把项目的运行环境设置为开发环境。

（五）通过Maven Profile

Spring Profile还能通过Maven Profile来设置。在pom.xml文件中，我们可以配置如下的profiles属性：

<profiles>
    <profile>
        <id>dev</id>
        <activation>
            <activeByDefault>true</activeByDefault>
        </activation>
        <properties>
            <spring.profiles.active>dev</spring.profiles.active>
        </properties>
    </profile>
    <profile>
        <id>prod</id>
        <properties>
            <spring.profiles.active>prod</spring.profiles.active>
        </properties>
    </profile>
</profiles>

这段配置定义了两个profile，分别是“dev”和“prod”。当我们激活某个Maven Profile时，对应的spring.profiles.active属性值会替换application.properties中的${spring.profiles.active}占位符。不过，我们还需要在pom.xml中添加下面这段配置：

<build>
    <resources>
        <resource>
            <directory>src/main/resources</directory>
            <filtering>true</filtering>
        </resource>
    </resources>
    ...
</build>

配置完成后，在Maven命令行中添加-P参数，就能切换不同的Profiles。比如，使用mvn clean package -Pprod命令，就可以将项目设置为生产环境进行打包。如果使用IDEA开发，还能通过IDEA内置的Maven插件界面来方便地切换Profile。

（六）不同设置方式的优先级

上面介绍的这5种设置Profile的方式，它们的生效优先级是不一样的。从高到低依次是：

1. web.xml设置Context parameter
2. WebApplicationInitializer
3. JVM系统参数
4. 环境变量
5. Maven profile

也就是说，高优先级的设置会覆盖低优先级的设置。在实际使用中，要根据项目的需求和场景选择合适的设置方式。

三、Default Profile

在Spring中，如果某个Bean没有指定Profile，那么它就属于default profile。我们也可以通过设置spring.profiles.default属性来修改默认的Profile。不过在实际开发中，要谨慎使用默认Profile，避免出现配置混乱的情况。

四、Spring Boot Profile

Spring Boot为基于Profile的配置文件提供了很好的支持。我们可以针对不同的环境，像开发、测试、生产等，创建独立的配置文件。这些配置文件的命名有特定的格式，即application-{profile}.properties。例如：

• application-dev.properties：专门用于开发环境的配置。
• application-prod.properties：用于生产环境的配置。

需要注意的是，application.yml是全局配置文件，在所有环境下都会默认加载。而特定环境配置文件中的配置会覆盖全局配置文件中的同名配置。在application.yml中，我们还可以设置当前激活的Profile：

spring:
  profiles:
    active: dev

上面这段代码就把当前激活的Profile设置为了开发环境（dev）。

通过这篇文章，相信大家对Spring Profiles有了更深入的了解。希望大家在实际开发中能够熟练运用Spring Profiles哦。