Spring MVC – How to set active profile

By mkyong | Updated: June 23, 2015

Viewed: 1,645 (+8 pv/w)

Tags: spring mvc spring profile

In this example, we will show you how to set active @Profile in a Spring MVC web application.

@Configuration
public class AppConfig {
 
	@Profile("dev")
	@Bean
	public CacheManager cacheManager() {
		//...
	}
 
	@Profile("live")
	@Bean
	public EhCacheManagerFactoryBean ehCacheCacheManager() {
		//...
	}
 
	@Profile("testdb")
	@Bean
	public DataSource dataSource() {
		//...
	}

}

To set active @Profile in Spring, define a value via spring.profiles.active system property.

1. web.xml

For normal web application, which contain web.xml file.

1.1 Set an active profile.

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

1.2 Set multiple active profile.

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

2. Servlet 3.0+ Container

For web application don’t have web.xml file, use one of the following methods:

2.1 Override onStartup

package com.mkyong.servlet3;

import javax.servlet.ServletContext;
import javax.servlet.ServletException;

public class MyWebInitializer extends
	AbstractAnnotationConfigDispatcherServletInitializer {

	//...

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

		//Set multiple active profile
		//servletContext.setInitParameter("spring.profiles.active", "dev, testdb");
	}
	
}

2.2 Depends which context (root or servlet) to load the @Profile beans.

package com.mkyong.servlet3;

import org.springframework.core.env.ConfigurableEnvironment;
import org.springframework.web.context.WebApplicationContext;
import org.springframework.web.servlet.support.AbstractAnnotationConfigDispatcherServletInitializer;

public class MyWebInitializer extends
	AbstractAnnotationConfigDispatcherServletInitializer {

	//If the @Profile beans are loaded via root context
	@Override
	protected WebApplicationContext createRootApplicationContext() {
		
		WebApplicationContext context = 
                     (WebApplicationContext)super.createRootApplicationContext();
	    	((ConfigurableEnvironment)context.getEnvironment()).setActiveProfiles("live");

		//Set multiple active profiles
		//((ConfigurableEnvironment)context.getEnvironment())
                //          .setActiveProfiles(new String[]{"live", "testdb"});

	    	return context;
	    
	}
	
	//If the @Profile beans are loaded via servlet context
	/*
	@Override
	protected WebApplicationContext createServletApplicationContext() {
		
		WebApplicationContext context = 
                     (WebApplicationContext)super.createServletApplicationContext();
	    	((ConfigurableEnvironment)context.getEnvironment()).setActiveProfiles("dev");
	    	return context;
	    
	}*/

}

References

1. Spring @Profile Examples