Настройка активного профиля для AbstractAnnotationConfigDispatcherServletInitializer, который можно использовать с @PropertySource?

Question

Я использую AbstractAnnotationConfigDispatcherServletInitializer для настройки своего веб-приложения. У меня также есть класс @Configuration, который я использую для создания нескольких бобов. В этом классе я использую аннотацию @PropertySource для загрузки файла свойств для различных параметров (например, сведения о соединении с базой данных).

В настоящее время я использую профили Maven с задачами Ant для создания правильных файлов свойств для среды выполнения. То есть, я получаю Maven для перемещения «prod.properties» или «dev.properties» в «application.properties» (который использует класс) во время сборки. Что бы я хотел сделать, это использовать Spring-профили, чтобы устранить это. Я хотел был бы быть в состоянии сделать следующее:

@PropertySource(value = "classpath:/application-${spring.profiles.active}.properties") 

Я также хочу установить профиль без использования каких-либо XML. Поэтому мне нужно будет настроить профиль на основе наличия системного свойства. Например,

String currentEnvironment = systemProperties.getProperty("current.environment"); 
if (currentEnvironment == null) { 
    ((ConfigurableEnvironment)context.getEnvironment()).setActiveProfiles("production"); 
} else { 
    ((ConfigurableEnvironment)context.getEnvironment()).setActiveProfiles(currentEnvironment); 
} 

Я не уверен, где бы я мог это сделать. Согласно an answer связанному с этим вопросу, это можно сделать в переопределении метода createRootApplicationContext в моем классе инициализатора. Но этот ответ также зависит от загружаемых классов конфигурации перед настройкой профиля.

Является ли это тем, что я хочу сделать возможным? Если да, то как?

Answer 1

Переопределение createRootApplicationContext или createServletApplicationContext не работало для меня. Я получал различные ошибки, такие как незаконные исключения состояния и «$ {spring.profiles.active}», которые не могут быть разрешимы. Рытье через дерево наследования для AbstractAnnotationConfigDispatcherServletInitializer я придумал следующее решение:

public class ApplicationInitializer 
    extends AbstractAnnotationConfigDispatcherServletInitializer 
{ 
    @Override 
    public void onStartup(ServletContext context) throws ServletException { 
    super.onStartup(context); 

    String activeProfile = System.getProperty("your.profile.property"); 
    if (activeProfile == null) { 
     activeProfile = "prod"; // or whatever you want the default to be 
    } 

    context.setInitParameter("spring.profiles.active", activeProfile); 
    } 
} 

Теперь вы можете создать класс конфигурации, как следующий, и он будет работать нормально:

@Configuration 
@PropertySource(value = "classpath:application-${spring.profiles.active}.properties") 
public class MyAppBeans { 
    @Autowired 
    private Environment env; 

    @Bean 
    public Object coolBean() { 
    String initParam = this.env.getProperty("cool.bean.initParam"); 
    ... 
    return coolBean; 
    } 
} 

Конечно, вы должны установить «your.profile.property» через параметры VM (-Dyour.profile.property=dev) или свойства контейнера (например, свойства контейнера Tomcat).

Answer 2

Вместо

@PropertySource(value = "classpath:application-${spring.profiles.active}.properties") 

Вы также могли бы сделать

@PropertySource(value = "classpath:application.properties") 

И использовать некоторые Maven плагин, как свойства-Maven-плагин (*)

<build> 
     <plugin> 
     <groupId>org.codehaus.mojo</groupId> 
     <artifactId>properties-maven-plugin</artifactId> 
     <version>1.0-alpha-2</version> 
     <executions> 
      <execution> 
       <phase>generate-resources</phase> 
       <goals> 
        <goal>write-active-profile-properties</goal> 
       </goals> 
       <configuration> 
        <outputFile>src/main/resources/application.properties</outputFile> 
       </configuration> 
      </execution> 
     </executions> 
     </plugin> 
    </build> 
    <profiles> 
     <profile> 
     <id>production</id> 
     <properties> 
      <profiles>prod</profiles> 
      <propertyOne>...</propertyOne> 
      <propertyTwo>...</propertyTwo> 
     </properties> 
     </profile> 
     <profile> 
     <id>development</id> 
     <properties> 
      <profiles>dev</profiles> 
      <propertyOne>...</propertyOne> 
     </properties> 
     </profile> 
    </profiles> 

, а затем запустить

mvn <lifecycle> -P production 

Есть некоторая причина в пользу передачи активного профиля в системном свойстве вместо параметра maven?

При такой конфигурации this solution работал для меня:

@Configuration 
public class WebAppInitializer extends AbstractAnnotationConfigDispatcherServletInitializer 
    { 
    protected WebApplicationContext createRootApplicationContext() { 
     WebApplicationContext context = super.createRootApplicationContext(); 
     ((ConfigurableEnvironment) context.getEnvironment()).setActiveProfiles(profiles()); 
     return context; 
    } 
     public String[] profiles() { 
      InputStream input = getClass().getClassLoader() 
        .getResourceAsStream("application.properties"); 
      Properties properties = new Properties(); 
      try { 
       properties.load(input); 
      return properties.getProperty("profiles").split(",");; 
      } catch (IOException e) { 
       e.printStackTrace(); 
       String[] defaultProfiles = {"dev"}; 
       return defaultProfiles; 
       // I really think that here we shouldn't return a default profile 
      } 

     } 
} 

(*) Это старый плагин (дата выпуска 2009), так что, может быть, мы должны найти другие, что делать ту же работу, но идея плагина для писать свойства + профили maven.