[Spring Boot 系列] 集成maven和Spring boot的profile功能

曾经终败给现在 2022-08-19 02:11 181阅读 0赞

由于项目的需要， 今天给spirng boot项目添加了profile功能。再网上搜索了一圈，也没有找到满意的参考资料，其实配置并不难，就是没有一个one stop(一站式)讲解的地方，所以有了写这篇博客的想法。由于本人水平有限，文中任何错误和纰漏欢迎大家反馈。希望本文可以给你带来帮助。

本文实现的目标：

1 使用了maven的profile功能

2 使用了Spring Boot的profile功能

3 集成了1和2的功能

4 在eclipse中运行mvn工程，使用开发环境的profile。

5 通过mvn在命令行中打包时，可以指定相应的profile。

什么是profile，解决什么问题呢？举个例子。一般在开发项目的时候要有多个环境，如开发环境、测试环境、生产环境，他们的配置文件一般不同。当我们要向各个环境发布程序时，需要人工处理这些配置文件，这显然麻烦且易错。有了profile，一切问题就简单了。只要在maven打包时使用下面命令即可。

mvn clean package -Dmaven.test.skip=true -P prod

解释一下， -P prod 就是告诉maven要使用名字为prod的profile来打包，即所有的配置文件都使用生产环境（prod是自己定义的，在这里自定义为生产环境）。

实现思路简述：

maven支持profile功能，当使用maven profile打包时，可以打包指定目录和指定文件，且可以修改文件中的变量。spring boot也支持profile功能，只要在application.properties文件中指定spring.profiles.active=xxx 即可，其中xxx是一个变量，当maven打包时，修改这个变量即可。

具体实现：

![Image 1][]![20160102095252819][]

A段，介绍coolpro工程的配置。

这个工程只需要修改pom.xml文件即可，需要定义具体maven的profile。定义完毕之后，当我们使用mvn clean package -P dev 时，maven就知道了profileActive=dev这个属性生效了。其中profileActive可以自己定义，就是一个maven的自定义属性。

pom.xml文件如下：

![Image 1][]![20160102100903768][]

B段，介绍coolpro-api工程的配置

这个工程是一个web工程，主要是想根据指定的profile配置相应的spring boot运行环境。如：如果profile是dev，配置web服务器的监听端口为8010；profile为test，则端口为8020；profile为prod，则端口为8030。

工程中有4个文件:

application.properties, 包含通用配置的文件。文件中有spring.profiles.active=@profileActive@的属性。spring boot的profile是通过spring.profiles.active属性来配置的，这里的profileActive和上面coolpro工程中配置的profileActive属性名要一致。这样，在运行mvn命令时，maven就会帮我们将@profileActive@替换成指定的profile。

application-dev.properties, 当mvn -P dev时， 需要打包这个文件。

application-test.properties, 当mvn -P test时， 需要打包这个文件。

application-prod.properties, 当mvn -P prod时， 需要打包这个文件。

pom.xml配置：

![20160102103943188][]  
![Image 1][]

application.properties文件：

![Image 1][]![20160102113728719][]

其他3个文件见截图：

![20160102114157111][]

C段，介绍coolpro-core工程的配置  
![20160102120238514][]

配置完成了。看效果。

1 在Eclipse环境中，直接运行项目。

![Center][]

2 使用maven命令，打包这个应用。

1）以开发环境打包：mvn clean package -Dmaven.test.skip=true -P dev -e

结果如下：

查看api工程：

![Center 1][]

查看core工程：

![Center 2][]

以此类推， 可以运行

mvn clean package -Dmaven.test.skip=true -P test -e

mvn clean package -Dmaven.test.skip=true -P prod -e

注意两点：

1 在属性文件中替换变量时，使用@符合。

![Center 3][]

最开始，使用$符号，就是不能替换，在网上搜索一下，原来是maven的maven-resources-plugin可以定义这个替换的符号。通过eclipse提供的Maven Pom editor编辑器打开pom.xml文件，在“Effective POM”选项卡中，可以看到定义的是@这个符号。

![Center 4][]

2 怎么在启动spring boot应用时，打印正在使用的profile，避免配置错误呢？可以参考如下代码。

public static void main(String[] args) {
    		ApplicationContext ctx = SpringApplication.run(RestApiApplication.class, args);
    		String[] activeProfiles = ctx.getEnvironment().getActiveProfiles();
    		for (String profile : activeProfiles) {
    			logger.warn("Spring Boot 使用profile为:{}" , profile);
    		}
    	}

参考：http://docs.spring.io/spring-boot/docs/current/reference/html/

http://www.tuicool.com/articles/NjqAF3

http://blog.csdn.net/jbgtwang/article/details/8642979

http://zilongsky-gmail-com.iteye.com/blog/2032001

http://www.huangyunkun.com/2015/01/01/run-code-after-spring-boot-started/

[Image 1]: 
[20160102095252819]: /images/20220731/c3845ae578c8449089597c39af55f372.png
[20160102100903768]: /images/20220731/1adfe76163cd42f897145ada3df89ecf.png
[20160102103943188]: /images/20220731/d3bd0ec1a96d40429495b765f8589bfa.png
[20160102113728719]: /images/20220731/dac6d0bb83b04584b7159aa5aaeffca4.png
[20160102114157111]: /images/20220731/40b5d1162da54f6b809b2d95e9bbe91d.png
[20160102120238514]: /images/20220731/81ab7819434e4eb6be1a953440ebd490.png
[Center]: /images/20220731/1e9d569df24940bb84c1cac6bfbf6c03.png
[Center 1]: /images/20220731/26622a2434184e66850fa0f77ab4efc1.png
[Center 2]: /images/20220731/ef4f3528de7a4e0c9be0157003ab87ae.png
[Center 3]: /images/20220731/acff2b2218f045238a59beeb0d922fff.png
[Center 4]: /images/20220731/8f66e78c2aa74c42a38dfeef8f7d2721.png