Spring Boot 配合Maven切换Profile

引言

在我们的项目开发工作中，是有多种运行环境的。例如我们公司就分为：开发环境（DEV），测试环境（SIT and UAT），生产环境（PROD）。我们已经知道Spring Boot可以针对与每一个环境单独指定一个配置文件，那么如何让Spring Boot项目在不同运行环境中方便、快捷并且准确的加载对应的配置文件呢？

实现

项目中的配置文件目录：

在Spring Boot中，Spring Boot可以通过在application配置文件中配置属性值：

spring:
  profiles:
    active: dev //指定使用dev环境profile

那么，问题来了，我们是否可以做的更自动化一些呢？答案当然可以，否则我也不会写这篇文章了。我们可以利用Maven配合Spring Boot来自动化加载指定配置文件，从而避免频繁修改配置文件。

首先在Maven中也有profile,我们可以在pom中定义profile
pom

<profiles>
        <profile>
            <id>dev</id>
            <properties>
            	<!-- profileActive:自定义名称，叫什么并无关紧要，自己保证一致即可。-->
                <profileActive>dev</profileActive>
            </properties>
            <activation>
                <activeByDefault>true</activeByDefault>
            </activation>
        </profile>

        <profile>
            <id>sit</id>
            <properties>
                <profileActive>sit</profileActive>
            </properties>
            <activation>
                <activeByDefault>false</activeByDefault>
            </activation>
        </profile>

        <profile>
            <id>uat</id>
            <properties>
                <profileActive>uat</profileActive>
            </properties>
            <activation>
                <activeByDefault>false</activeByDefault>
            </activation>
        </profile>
       <profile>
            <id>prod</id>
            <properties>
                <profileActive>prod</profileActive>
            </properties>
            <activation>
                <activeByDefault>false</activeByDefault>
            </activation>
        </profile>

重点来了,在pom文件中指定配置文件所在目录，指定我们要加载的配置文件，占位符是用来动态填充上面定义的名称。

true 设置为true是值发布对应的profile，否则会发布多个。
pom

   <resources>
            <resource>
                <directory>src/main/resources</directory>
                <includes>
                    <include>application-${profileActive}.yml</include>
                    <include>application.yml</include>
                </includes>
                <filtering>true</filtering>
            </resource>
        </resources>

接下来我们就可以配置spring.profiles.active的属性值了：

spring:
  profiles:
    active: @profileActive@

@profileActive@ 即取得pom中的profileActive值。

自定义spring boot分隔符

我们在浏览其他人的代码或者博文是，又发现不是@符号，那是因为他们自定义了分隔符。
查看spring-boot-starter-parent会发现

<properties>
<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
	<java.version>1.8</java.version>
	//默认配置文件中分隔符号为@
	<resource.delimiter>@</resource.delimiter>
	<maven.compiler.source>${java.version}</maven.compiler.source>
	<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
	<maven.compiler.target>${java.version}</maven.compiler.target>
</properties>

那么我们要如何设定成我们自己的呢？很简单，只需要在pom文件中plugins标签下加入以下代码：

			<plugin>
				<groupId>org.apache.maven.plugins</groupId>
				<artifactId>maven-resources-plugin</artifactId>
				<configuration>
					<delimiters>
						// 指定自定义分隔符号
						<delimiter>#</delimiter>
					</delimiters>
					// 不使用默认分隔符
					<useDefaultDelimiters>false</useDefaultDelimiters>
				</configuration>
			</plugin>