使用Springprofile实现开发、测试和生产环境的配

发表于

介绍

软件开发过程一般涉及“开发 -> 测试 -> 部署上线”多个阶段，每个阶段的环境的配置参数会有不同，如数据源，文件路径等。为避免每次切换环境时都要进行参数配置等繁琐的操作，可以通过spring的profile功能来进行配置参数的切换。

以我用到的项目的实际情况为例，首先可以在resources文件夹下分别为每个环境建立单独的文件夹（也可以额外建立一个common文件夹，用于存放公共的参数配置文件），每个文件夹下面存放对应的环境所需的配置文件，就像这样子：

使用Spring.profile实现开发、测试和生产环境的配置和切换

配置和使用

在resources文件夹下建立

applicationContext-profile.xml文件，用来定义不同的profile：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
xml复制代码<?xml version="1.0" encoding="UTF-8"?>
<beans> <!--省略了一些头部属性-->
 <description>spring profile配置</description>

 <!-- 开发环境配置文件 -->
 <beans profile="development">
 <context:property-placeholder
 location="classpath*:common/*.properties, classpath*:development/*.properties" />
 </beans>

 <!-- 测试环境配置文件 -->
 <beans profile="test">
 <context:property-placeholder
 location="classpath*:common/*.properties, classpath*:test/*.properties" />
 </beans>
 
 <!-- 生产环境配置文件 -->
 <beans profile="production">
 <context:property-placeholder
 location="classpath*:common/*.properties, classpath*:production/*.properties" />
 </beans>
</beans>

这样就实现了通过profile标记不同的环境，接下来就可以通过设置spring.profiles.default和spring.profiles.active这两个属性来激活和使用对应的配置文件。default为默认，如果没有通过active来指定，那么就默认使用default定义的环境。

这两个属性可以通过多种方法来设置：

  • 在web.xml中作为web应用的上下文参数context-param；
  • 在web.xml中作为DispatcherServlet的初始化参数；
  • 作为JNDI条目；
  • 作为环境变量；
  • 作为JVM的系统属性；
  • 在集成测试类上，使用@ActiveProfiles注解配置。

前两者都可以在web.xml文件中设置：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
xml复制代码<?xml version="1.0" encoding="UTF-8"?>
<web-app version="3.0"><!--省略了一些头部属性-->
 <display-name>Archetype Created Web Application</display-name>

 <context-param>
 <param-name>contextConfigLocation</param-name>
 <param-value>
 classpath*:/applicationContext*.xml
 </param-value>
 </context-param>

 <!-- 在上下文context-param中设置profile.default的默认值 -->
 <context-param>
 <param-name>spring.profiles.default</param-name>
 <param-value>development</param-value>
 </context-param>

 <!-- 在上下文context-param中设置profile.active的默认值 -->
 <!-- 设置active后default失效，web启动时会加载对应的环境信息 -->
 <context-param>
 <param-name>spring.profiles.active</param-name>
 <param-value>development</param-value>
 </context-param>

 <servlet>
 <servlet-name>appServlet</servlet-name>
 <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
 <!-- 在DispatcherServlet参数中设置profile的默认值，active同理 -->
 <init-param>
 <param-name>spring.profiles.default</param-name>
 <param-value>development</param-value>
 </init-param>
 <load-on-startup>1</load-on-startup>
 </servlet>

 <servlet-mapping>
 <servlet-name>appServlet</servlet-name>
 <url-pattern>/</url-pattern>
 </servlet-mapping>

</web-app>

激活指定的环境，也可以通过JVM参数来设置，可以在tomcat的启动脚本中加入以下JVM参数来激活：

使用Spring.profile实现开发、测试和生产环境的配置和切换

1
ini复制代码-Dspring.profiles.active="production"

在程序中，也可以通过 @Profile(“…”) 对某些资源进行注解，这样只有当选择对应的环境时，才会产生对应的bean，如：

1
2
3
4
5
6
7
8
9
10
less复制代码@Bean
@Profile("production") 
 public DataSource jndiDataSource(){
 JndiObjectFactoryBean jofb=new JndiObjectFactoryBean();
 jofb.setJndiName("jndi/iDS");
 jofb.setResourceRef(true);
 jofb.setProxyInterface(xxx.class);
 return (DataSource) jofb.getObject();
 }
}

本文转载自: 掘金

开发者博客 – 和开发相关的 这里全都有

0%