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

墨蓝 2022-06-03 07:36 196阅读 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打包时使用下面命令即可。 [view pl][] [c][view pl]

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打包时，修改这个变量即可。

具体实现：

![50443491][]![20160102095252819][]

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

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

pom.xml文件如下：

![50443491][]![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][]  
![50443491][]

application.properties文件：

![50443491][]![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，避免配置错误呢？可以参考如下代码。 [view plain][view pl] [copy][view pl]

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/

原文链接：[/images/20220603/1a8fa18b9faa4993a98e795bf5fd1dca.png][50443491]

[view pl]: /images/20220603/1a8fa18b9faa4993a98e795bf5fd1dca.png#
[50443491]: /images/20220603/1a8fa18b9faa4993a98e795bf5fd1dca.png
[20160102095252819]: /images/20220603/05a30c06577d459c9f61c1e5dc4dd9d4.png
[20160102100903768]: /images/20220603/ce44ed964d974db3bd207dd83ab3ca94.png
[20160102103943188]: /images/20220603/eebf9c3d3e0847c3b97625fb9456bcf7.png
[20160102113728719]: /images/20220603/5e1fd053102941fabb13367c751261b2.png
[20160102114157111]: /images/20220603/7b88873c89d843fbbe059ff19c6a6e71.png
[20160102120238514]: /images/20220603/3ac63b0288864e44acec5e048a5ee2fa.png
[Center]: /images/20220603/9508d59a65b54cd7bd884ea2dfaafb63.png
[Center 1]: /images/20220603/c103b5c4a2e14370a635fa31021ec5f8.png
[Center 2]: /images/20220603/9ad81d0299dc401b9bd0c04943488846.png
[Center 3]: /images/20220603/f9ff46faa4244a7b9acd8a47d2486ebd.png
[Center 4]: /images/20220603/b9b5683a188b4fd9b2ec751d830b3f69.png