How to add an active spring profile from an environment variable?

Question

Until now, I'm setting the following environment variable in my ~/.bash_profile :

export SPRING_PROFILES_ACTIVE=local

This set my active spring profile. But now, I want to add the local profile to other profiles defined in application.properties and not replace them.

In the Spring Boot documentation, there is a section about adding active profile, but I see nothing about adding active profile from an environment variable.

I've tried to set the SPRING_PROFILES_INCLUDE environment variable, but this has no effect.

How to do this?

P.S.: I'm using Spring Boot 1.4.2.

have you tried utilizing ConfigurableEnvironment docs.spring.io/spring-framework/docs/current/javadoc-api/org/… — SeaBiscuit
– SeaBiscuit, Commented Nov 16, 2016 at 16:57
No, I didn't, but I prefer to use a solution such as the Olszewski one. — Ortomala Lokni
– Ortomala Lokni, Commented Nov 16, 2016 at 19:07

OrangeDog · Accepted Answer · 2024-06-14 09:19:04Z

15

The next sentence in the documentation you linked to:

Sometimes it is useful to have profile-specific properties that add to the active profiles rather than replace them. The spring.profiles.include property can be used to unconditionally add active profiles.

So you can launch your application with a command-line parameter:

-Dspring.profiles.include=${SPRING_PROFILES_INCLUDE}

edited Jun 14, 2024 at 9:19

answered Nov 16, 2016 at 17:26

OrangeDog

39.3k18 gold badges141 silver badges227 bronze badges

Sign up to request clarification or add additional context in comments.

Comments

Daniel Olszewski · Accepted Answer · 2016-11-16 17:20:32Z

With default addition profile

You can introduce your own environment variable in the application.properties file, next to the defined profiles using an expression. For instance, if your current file looks like this:

spring.profiles.active=profile1,profile2

with a custom environment variable it will change into:

spring.profiles.active=profile1,profile2,${ADDITIONAL_APP_PROFILES:local}

where ADDITIONAL_APP_PROFILES is the name of the environment variable which you set instead of SPRING_PROFILES_ACTIVE.

The value local is used when the variable is not set on a current environment. In that case, the profile called local will be activated. If you don't set the default value and the environment variable is not present, the whole expression will be used as the name of an active profile.

Without default addition profile

If you like to avoid activating the default profile, you can remove the placeholder value and the comma before the variable expression:

spring.profiles.active=profile1,profile2${ADDITIONAL_APP_PROFILES}

but in that case the variable set on a current environment have to start with a comma:

export ADDITIONAL_APP_PROFILES=,local

radekpakula · Accepted Answer · 2019-03-28 09:40:03Z

This is an example of adding a programmatically additional active profile from system env or jvm arg.

@Configuration
public class ApplicationInitializer implements WebApplicationInitializer, ApplicationContextInitializer<ConfigurableWebApplicationContext> {

    @Override
    public void onStartup(ServletContext servletContext) throws ServletException {
        servletContext.setInitParameter("contextInitializerClasses", this.getClass().getCanonicalName());
    }

    @Override
    public void initialize(ConfigurableWebApplicationContext applicationContext) {
        ConfigurableEnvironment environment = applicationContext.getEnvironment();
        environment.addActiveProfile(System.getProperty("myProperty"));
        environment.addActiveProfile(System.getEnv("myProperty"));
    }
}

bvn13 · Accepted Answer · 2022-11-28 14:51:29Z

0

Here is not the Spring way, but also could be useful in some cases.

public static void main(String[] args) {
    System.setProperty("spring.profiles.active", "local");
    SpringApplication.run(MainApplication.class, args);
}

answered Nov 28, 2022 at 14:51

bvn13

17011 bronze badges

Comments

kuhajeyan · Accepted Answer · 2016-11-16 17:21:22Z

-2

To support bash environment, available values are SPRING_PROFILES_ACTIVE and SPRING_PROFILES_DEFAULT

not, SPRING_PROFILES_INCLUDE

you probably have to resort commandline way -Dspring.profiles.include or pro grammatically workout with ConfigurableEnvironment

http://docs.spring.io/spring/docs/current/javadoc-api/org/springframework/core/env/AbstractEnvironment.html#ACTIVE_PROFILES_PROPERTY_NAME

answered Nov 16, 2016 at 17:21

kuhajeyan

11.1k10 gold badges53 silver badges74 bronze badges

1 Comment

Peter Wippermann Over a year ago

Sorry, but I only understand half of your post. Could you please rephrase it?

Collectives™ on Stack Overflow

How to add an active spring profile from an environment variable?

5 Answers 5

Comments

Comments

Comments

Comments

1 Comment

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

5 Answers 5

Comments

Comments

Comments

Comments

1 Comment

Your Answer

Sign up or log in

Post as a guest

Related