Конфигурация в зависимости от режима запуска

Play может быть запущен в режиме разработки (через run), в производственном режиме (через start) или в тестовом режиме. Есть ли способ предоставить другой файл конфигурации (conf/application.conf) в зависимости от того, в каком режиме он запускается?

Источник

3 ответа

Решение

У меня обычно есть базовая конфигурация (application.conf) и три дополнительных конфига для каждой среды. В Play Framework 2.4 это можно сделать, расширив GuiceApplicationLoader и объединив базовый conf с вашей конкретной средой conf. Вы можете сделать один шаг вперед и предоставить различные модули guice для каждой среды.

Версия Scala:

class CustomApplicationLoader extends GuiceApplicationLoader {

    override protected def builder(context: Context): GuiceApplicationBuilder = {
        val builder = initialBuilder.in(context.environment).overrides(overrides(context): _*)
        context.environment.mode match {
            case Prod =>
                // start mode
                val prodConf = Configuration(ConfigFactory.load("prod.conf"))
                builder.loadConfig(prodConf ++ context.initialConfiguration).bindings(new ProdModule());
            case Dev =>
                // run mode
                val devConf = Configuration(ConfigFactory.load("dev.conf"))
                builder.loadConfig(devConf ++ context.initialConfiguration).bindings(new DevModule());
            case Test =>
                // test mode
                val testConf = Configuration(ConfigFactory.load("test.conf"))
                builder.loadConfig(testConf ++ context.initialConfiguration).bindings(new TestModule());
        }
    }
}

Версия Java:

public class CustomApplicationLoader extends GuiceApplicationLoader {

    @Override
    public GuiceApplicationBuilder builder(ApplicationLoader.Context context) {
        final Environment environment = context.environment();
        GuiceApplicationBuilder builder = initialBuilder.in(environment);
        Configuration config = context.initialConfiguration();
        if (environment.isTest()) {
            config = merge("test.conf", config);
            builder = builder.bindings(new TestModule());
        } else if (environment.isDev()) {
            config = merge("dev.conf", config);
            builder = builder.bindings(new DevModule());
        } else if (environment.isProd()) {
            config = merge("prod.conf", config);
            builder = builder.bindings(new DevModule());
        } else {
            throw new IllegalStateException("No such mode.");
        }
        return builder.in(environment).loadConfig(config);
    }

    private Configuration merge(String configName, Configuration currentConfig) {
        return new Configuration(currentConfig.getWrappedConfiguration().$plus$plus(new play.api.Configuration(ConfigFactory.load(configName))));
    }
}

Не забудьте включить play.application.loader = "modules.CustomApplicationLoader" на ваш application.conf,

В нижних версиях Play Нечто подобное можно достичь с помощью GlobalSettings класс и переопределение onLoadConfig, Разум GlobalSettings в Play 2.4 развращен.

Если вам не нравится в том числе test.conf а также test mocks от TestModule к вашей сборке вы можете filter файлы с SBT.

Источник

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

1 - Использование -Dconfig.resource

Он будет искать альтернативный файл конфигурации в пути к классам приложения (вы обычно предоставляете эти альтернативные файлы конфигурации в каталог приложения / conf перед упаковкой). Игра будет смотреть в conf /, поэтому вам не нужно добавлять conf /.

$ / path / to / bin / -Dconfig.resource = prod.conf

2 - Использование -Dconfig.file

Вы также можете указать другой локальный файл конфигурации, не упакованный в артефакты приложения:

$ / path / to / bin / -Dconfig.file = / opt / conf / prod.conf

3 - Использование -Dconfig.url

Вы также можете указать файл конфигурации для загрузки с любого URL:

$ / path / to / bin / -Dconfig.url = http://conf.mycompany.com/conf/prod.conf

Оформить заказ подробнее на:

https://www.playframework.com/documentation/2.3.x/ProductionConfiguration

Источник

Это можно сделать, загрузив файлы конфигурации в зависимости от среды, которая может быть предоставлена ​​через -Dmode=staging/dev/prodи для загрузки файлов я переопределить onLoadConfig GlobalSettings в Global.java.

Фрагмент кода Java

 @Override
 public Configuration onLoadConfig(Configuration config, File file,ClassLoader classLoader) {
 Configuration updatedConfig = config;
 String mode = config.getString("mode");
 if (StringUtils.isNotEmpty(mode)) {
   try {
     File modeFolder = FileUtils.getFile(file, "conf/" + mode);
     if (modeFolder.exists()) {
       play.api.Configuration modeConfig = config.getWrappedConfiguration();
       IOFileFilter fileFilter = new WildcardFileFilter("*.conf");
       Collection<File> fileList = FileUtils.listFiles(modeFolder, fileFilter, null);
       for (File confFile : fileList) {
         modeConfig = modeConfig
            .$plus$plus(new play.api.Configuration(ConfigFactory.parseFile(confFile)));

      }
       updatedConfig = new Configuration(modeConfig);
     }
   } catch (Exception e) {
     Logger.error("Exception while loading configuration for mode : " + mode, e);
   }
 } else {
   Logger.error("Please provide mode in which play application has to start (Ex. play -Dmode=<mode>) ");
 }

Для каждого режима создайте папку (имя совпадает с именем среды) и сохраните конфигурацию, специфичную для среды, в этой папке.

Источник
Другие вопросы по тегам