Bootstrap yml что это

Spring Configuration Bootstrap и свойства приложения

Spring Boot — это самоуверенная структура. Несмотря на это, обычно мы переопределяем автоматически настроенные свойства в файле конфигурации приложения, таком как application.properties .

Однако в приложении Spring Cloud мы часто используем другой файл конфигурации с именем bootstrap.properties .

В этом кратком руководстве мы объясним различия между bootstrap.properties и application.properties .

2. Когда используется файл конфигурации приложения?​

Мы используем application.yml или application.properties для настройки контекста приложения .

Когда приложение Spring Boot запускается, оно создает контекст приложения, который не нужно настраивать явно — он уже настроен автоматически. Однако Spring Boot предлагает различные способы переопределения этих свойств .

Мы можем переопределить их в коде, аргументах командной строки, параметрах инициализации ServletConfig , параметрах инициализации ServletContext , системных свойствах Java, переменных операционной системы и файле свойств приложения.

Важно помнить, что эти файлы свойств приложения имеют самый низкий приоритет по сравнению с другими формами переопределения свойств контекста приложения.

Мы склонны группировать свойства, которые мы можем переопределить в контексте приложения:

• Основные свойства (свойства регистрации, свойства потока)
• Свойства интеграции (свойства RabbitMQ , свойства ActiveMQ )
• Веб-свойства (свойства HTTP , свойства MVC )
• Свойства безопасности (свойства LDAP , свойства OAuth2 )

3. Когда используется файл конфигурации Bootstrap?​

Мы используем bootstrap.yml или bootstrap.properties для настройки контекста начальной загрузки . Таким образом, мы сохраняем внешнюю конфигурацию для начальной загрузки и основного контекста четко разделенными.

Контекст начальной загрузки отвечает за загрузку свойств конфигурации из внешних источников и за расшифровку свойств в локальных внешних файлах конфигурации.

Когда приложение Spring Cloud запускается, оно создает контекст начальной загрузки . Первое, что нужно помнить, это то, что контекст начальной загрузки является родительским контекстом для основного приложения.

Еще один важный момент, о котором следует помнить, заключается в том, что эти два контекста совместно используют среду Environment , которая является источником внешних свойств для любого приложения Spring . В отличие от контекста приложения, контекст начальной загрузки использует другое соглашение для поиска внешней конфигурации.

Источником файлов конфигурации может быть, например, файловая система или даже репозиторий git. Службы используют свою зависимость spring-cloud-config-client для доступа к серверу конфигурации.

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

4. Быстрый пример​

В этом примере файл конфигурации контекста начальной загрузки настраивает зависимость spring-cloud-config-client для загрузки нужных файлов свойств приложения.

Давайте посмотрим на пример файла bootstrap.properties :

spring.application.name=config-client spring.profiles.active=development spring.cloud.config.uri=http://localhost:8888 spring.cloud.config.username=root spring.cloud.config.password=s3cr3t spring.cloud.config.fail-fast=true management.security.enabled=false 

5. Вывод​

В отличие от приложения Spring Boot, приложение Spring Cloud имеет контекст начальной загрузки, который является родителем контекста приложения. Хотя оба они используют одну и ту же среду Environment , у них разные соглашения о расположении внешних файлов конфигурации.

Контекст начальной загрузки ищет файл bootstrap.properties или bootstrap.yaml, тогда как контекст приложения ищет файл application.properties или application.yaml . «

И, конечно же, свойства конфигурации контекста начальной загрузки загружаются до свойств конфигурации контекста приложения.

• 1. Обзор
• 2. Когда используется файл конфигурации приложения?
• 3. Когда используется файл конфигурации Bootstrap?
• 4. Быстрый пример
• 5. Вывод

Bootstrap yml что это

Данная статья является частью статей об использование Spring Cloud #Про Spring Cloud.

Немного теории

Проект Spring Cloud Config предназначен для управления конфигурациями в облачном решении. Проект предлагает централизованное хранилище конфигураций приложений, которое легко может масштабироваться горизонтально. В качестве источника конфигураций используется файловая система, GIT, SVN, Hashicorp Vault, JDBC Backend. Также можно использовать композитные источники данных. В данной статье мы будем использовать файловую систему.

По умолчанию Spring Cloud Config отдает файлы, соответствующие имени запрашивающего Spring приложения. Также могут учитываться активные Spring profiles и свойства label проекта (параметр spring.cloud.config.label в конфигурации проекта).

Имя приложения указывает в параметре spring.application.name. Как правило, в проектах указывается одно имя приложения в этом параметре. НО, запрета на использования нескольких имен для данного параметра нет и Spring Cloud Config Server умеет работать с несколькими именами, записанными через запятую (например, spring.application.name = a,b,c). Данную возможность можно использовать для подгрузки конфигурации из нескольких файлов одновременно. Аналогично данное утверждение применимо для профайлов (параметр spring.profiles.active)

Для конфигурирования приложения могут использоваться файлы: .properties, .yml, .yaml. Порядок формирования конфигурации (по увеличению приоритета параметров):

Встраивание Spring Cloud Config в любое приложение можно разделить на два основных подхода: Config First Bootstrap или Discovery First Bootstrap. В первом случае инициализация идет через сервер управления конфигурациями, таким образом приложению необходимо знать где расположен Spring Cloud Config Server (параметр spring.cloud.config.url, по умолчанию поиск идет по адресу http://config:8888) и данные для аутентификации, если они применяются. Во втором случае доступ к Spring Cloud Config Server осуществляется через Service Discovery, который имеет данные о местоположении сервиса конфигурации. Им может выступать Eureka Service Discovery или Hashicorp Consul. Для защиты точек доступа Spring Cloud Config Server может применяться Spring Security, поэтому мы не ограничены в механизме защиты точек доступа.

В реальной жизни при старте микросервисной инфраструктуры Spring Cloud Config Server может быть запущен позже других сервисов, поэтому рекомендуется настроить механизм повтора запроса конфигурации в случае неуспешного первого обращения. Для этого необходимо подключить две зависимости spring-retry и spring-boot-starter-aop и установить параметр spring.cloud.config.fail-fast=true. Настройки механизма повтора находятся в разделе spring.cloud.config.retry.*

Создание сервера конфигурации

Первым шагом необходимо создать новый модуль в gradle в директории ./backend с именем config-server

Настроим содержимое файла gradle.build следующим образом. Напоминаю, что переменные версий (такие как bootGradlePlugin или springCloudConfig) вынесены в базовый build.gradle в директории ./backend

buildscript  repositories  mavenCentral() > dependencies  classpath("org.springframework.boot:spring-boot-gradle-plugin:$") > > apply plugin: 'java' apply plugin: 'org.springframework.boot' apply plugin: 'io.spring.dependency-management' dependencyManagement  imports  mavenBom "org.springframework.cloud:spring-cloud-config:$" > > bootJar  baseName = 'ac-config-server' > dependencies  compile 'org.springframework.cloud:spring-cloud-config-server' > 

Также необходимо создать базовый класс ConfigServerApplication.java для запуска Spring Boot приложения. Для создания встроенного (embedded) Config Server необходиом добавить аннотацию @EnableConfigServer

package com.balynsky.ac.config.server; import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; import org.springframework.cloud.config.server.EnableConfigServer; @SpringBootApplication @EnableConfigServer public class ConfigServerApplication  public static void main(String[] args)  SpringApplication.run(ConfigServerApplication.class, args); > > 

Так же необходимо настроить параметры приложение, указав активный профайд “native”, чтобы поиск конфигурации осуществлялся в файловой системе (по умолчанию источником конфигураций используется GIT репозиторий). Для этого в каталоге resources необходимо создать файл bootstrap.yml следующего содержимого:

spring: cloud: config: server: bootstrap: true profiles: include: native application: name: config-server 

Мы задали параметр spring.cloud.config.bootstrap = true, чтобы Config Server также инициировал свои настройки из конфигурационного хранилища (в нашем случае — файловой системе)

Чтобы указать где расположено конфигурационное хранилище, используется параметр spring.cloud.config.native.searchLocations. Если параметр не задан, поиск осуществляется в дефолтных: classpath:/, classpath:/config/, file:./, file:./config/

В реальных проектах не рекомендуется помещать конфигурации внутрь jar приложения, но для тестового стенда, в нашем случае мы поместим конфигурации в classpath:/config/. Для этого в каталоге resources проекта config-server создадим каталог config, в котором создадим следующие файлы:

• application.yml
• config-server.yml
• backup-service.yml
• storage-service.yml
• user-service.yml

При запуске проекта мы имеем ошибку java.lang.IllegalStateException: You need to configure a uri for the git repository из за включенного параметра bootstrap = true, которая описана в Issue. Поэтому временно применим обходное решение из данного тикета (используем профайл composite), для этого изменим bootstrap.yml

spring: cloud: config: server: composite: - type: native bootstrap: true profiles: include: composite application: name: config-server 

В файле настройки config-server.yml укажем порт, на котором должен запуститься сервис (по умолчанию идет запуск на 8080):

server: port: 8888 

Подключение к Spring Config Server

Опишем подключение к конфигурационному серверу для проекта storage-service, остальные проекты подключаются аналогичным образом. Само подключение конфигурации начнем с добавления необходимых зависимостей:

dependencies  // . compile("org.springframework.retry:spring-retry:$") compile("org.springframework.boot:spring-boot-starter-aop") compile 'org.springframework.cloud:spring-cloud-starter-config' // . > 

Как описывалось ранее зависимости spring-retry и spring-boot-starter-aop необходимы для обеспечения механизма повтора запроса конфигурации с сервера, если при первом обращении была получена ошибка (например, сервер не был инициирован)

Следующий шаг, мы переносим содержимое файла backup-service/…/resources/application.yml в файл backup-service.yml в проекте config-server. Вместо него необходимо создать файл bootstrap.yml, в котором укажем данные для подключения к конфигурационному серверу. Содержимое файла bootstrap.yml:

spring: cloud: config: fail-fast: true uri: http://localhost:8888 application: name: backup-service 

После запуска приложения в логах можно увидеть записи подключения к конфигурационному серверу и получения конфигурации:

c.c.c.ConfigServicePropertySourceLocator : Fetching config from server at : http://localhost:8888 c.c.c.ConfigServicePropertySourceLocator : Located environment: name=backup-service, profiles=[default], label=null, version=null, state=null b.c.PropertySourceBootstrapConfiguration : Located property source: CompositePropertySource ]> 

Аналогичным образом изменяем два оставшихся приложения: storage-service и user-service.

Итоги:

В рамках этой статьи, мы научили наши приложения получать конфигурацию с внешнего источника (Spring Config Server),и у нас получилась следующая архитектура нашего проекта:

Related Posts

• Feign, Ribbon для коммуникации между сервисами
• Написание рабочего прототипа Altered Carbon Backup без использования Spring Cloud
• Построение каркаса приложения Altered Carbon Backup
• Spring Cloud для построения проекта с микросервисной архитектурой

Разница между размещением свойства в application.yml и bootstrap.yml в Spring Boot

Когда речь заходит о Spring Boot, два файла могут вызвать некоторую путаницу — это application.yml и bootstrap.yml . В обоих этих файлах можно определить свойства, которые будут использоваться в приложении. Однако они отличаются в том, когда и как эти свойства загружаются и используются.

Файл bootstrap.yml используется для указания свойств, которые необходимы на старте приложения. Это свойства, которые в первую очередь необходимы для подключения к внешним системам или службам, таким как конфигурационный сервер. Данный файл загружается до того, как Spring Boot начнет свой процесс автоконфигурации.

Примером такого свойства может быть spring.cloud.config.uri , которое указывает URL конфигурационного сервера.

spring: cloud: config: uri: http://localhost:8888

С другой стороны, application.yml является местом, где определяются все остальные свойства приложения. Эти свойства будут загружены во время процесса автоконфигурации Spring Boot.

Вот пример свойства, которое можно указать в application.yml :

server: port: 8080

Также стоит отметить, что если одно и то же свойство определено и в bootstrap.yml , и в application.yml , то значение из bootstrap.yml будет иметь приоритет.

Особое внимание стоит уделить свойству logging.config . Если его разместить в bootstrap.yml , то конфигурация логирования будет применена на раннем этапе загрузки приложения, что позволит регистрировать события на старте приложения. Если же разместить его в application.yml , то конфигурация логирования будет применена позже, и некоторые события на старте могут быть упущены.

В заключение, выбор между application.yml и bootstrap.yml зависит от того, когда и как должны быть загружены и использованы свойства.

1. Spring Cloud Context: Application Context Services

Spring Boot has an opinionated view of how to build an application with Spring. For instance, it has conventional locations for common configuration files and has endpoints for common management and monitoring tasks. Spring Cloud builds on top of that and adds a few features that probably all components in a system would use or occasionally need.

1.1 The Bootstrap Application Context

A Spring Cloud application operates by creating a “ bootstrap ” context, which is a parent context for the main application. It is responsible for loading configuration properties from the external sources and for decrypting properties in the local external configuration files. The two contexts share an Environment , which is the source of external properties for any Spring application. By default, bootstrap properties (not bootstrap.properties but properties that are loaded during the bootstrap phase) are added with high precedence, so they cannot be overridden by local configuration.

The bootstrap context uses a different convention for locating external configuration than the main application context. Instead of application.yml (or .properties ), you can use bootstrap.yml , keeping the external configuration for bootstrap and main context nicely separate. The following listing shows an example:

bootstrap.yml.

spring: application: name: foo cloud: config: uri: $

If your application needs any application-specific configuration from the server, it is a good idea to set the spring.application.name (in bootstrap.yml or application.yml ).

You can disable the bootstrap process completely by setting spring.cloud.bootstrap.enabled=false (for example, in system properties).

1.2 Application Context Hierarchies

If you build an application context from SpringApplication or SpringApplicationBuilder , then the Bootstrap context is added as a parent to that context. It is a feature of Spring that child contexts inherit property sources and profiles from their parent, so the “ main ” application context contains additional property sources, compared to building the same context without Spring Cloud Config. The additional property sources are:

• “ bootstrap ” : If any PropertySourceLocators are found in the Bootstrap context and if they have non-empty properties, an optional CompositePropertySource appears with high priority. An example would be properties from the Spring Cloud Config Server. See “ Section 1.6, “Customizing the Bootstrap Property Sources” ” for instructions on how to customize the contents of this property source.
• “ applicationConfig: [classpath:bootstrap.yml] ” (and related files if Spring profiles are active): If you have a bootstrap.yml (or .properties ), those properties are used to configure the Bootstrap context. Then they get added to the child context when its parent is set. They have lower precedence than the application.yml (or .properties ) and any other property sources that are added to the child as a normal part of the process of creating a Spring Boot application. See “ Section 1.3, “Changing the Location of Bootstrap Properties” ” for instructions on how to customize the contents of these property sources.

Because of the ordering rules of property sources, the “ bootstrap ” entries take precedence. However, note that these do not contain any data from bootstrap.yml , which has very low precedence but can be used to set defaults.

You can extend the context hierarchy by setting the parent context of any ApplicationContext you create — for example, by using its own interface or with the SpringApplicationBuilder convenience methods ( parent() , child() and sibling() ). The bootstrap context is the parent of the most senior ancestor that you create yourself. Every context in the hierarchy has its own “ bootstrap ” (possibly empty) property source to avoid promoting values inadvertently from parents down to their descendants. If there is a Config Server, every context in the hierarchy can also (in principle) have a different spring.application.name and, hence, a different remote property source. Normal Spring application context behavior rules apply to property resolution: properties from a child context override those in the parent, by name and also by property source name. (If the child has a property source with the same name as the parent, the value from the parent is not included in the child).

Note that the SpringApplicationBuilder lets you share an Environment amongst the whole hierarchy, but that is not the default. Thus, sibling contexts, in particular, do not need to have the same profiles or property sources, even though they may share common values with their parent.

1.3 Changing the Location of Bootstrap Properties

The bootstrap.yml (or .properties ) location can be specified by setting spring.cloud.bootstrap.name (default: bootstrap ) or spring.cloud.bootstrap.location (default: empty) — for example, in System properties. Those properties behave like the spring.config.* variants with the same name. In fact, they are used to set up the bootstrap ApplicationContext by setting those properties in its Environment . If there is an active profile (from spring.profiles.active or through the Environment API in the context you are building), properties in that profile get loaded as well, the same as in a regular Spring Boot app — for example, from bootstrap-development.properties for a development profile.

1.4 Overriding the Values of Remote Properties

The property sources that are added to your application by the bootstrap context are often “ remote ” (from example, from Spring Cloud Config Server). By default, they cannot be overridden locally. If you want to let your applications override the remote properties with their own System properties or config files, the remote property source has to grant it permission by setting spring.cloud.config.allowOverride=true (it does not work to set this locally). Once that flag is set, two finer-grained settings control the location of the remote properties in relation to system properties and the application’s local configuration:

• spring.cloud.config.overrideNone=true : Override from any local property source.
• spring.cloud.config.overrideSystemProperties=false : Only system properties, command line arguments, and environment variables (but not the local config files) should override the remote settings.

1.5 Customizing the Bootstrap Configuration

The bootstrap context can be set to do anything you like by adding entries to /META-INF/spring.factories under a key named org.springframework.cloud.bootstrap.BootstrapConfiguration . This holds a comma-separated list of Spring @Configuration classes that are used to create the context. Any beans that you want to be available to the main application context for autowiring can be created here. There is a special contract for @Beans of type ApplicationContextInitializer . If you want to control the startup sequence, classes can be marked with an @Order annotation (the default order is last ).

When adding custom BootstrapConfiguration , be careful that the classes you add are not @ComponentScanned by mistake into your “ main ” application context, where they might not be needed. Use a separate package name for boot configuration classes and make sure that name is not already covered by your @ComponentScan or @SpringBootApplication annotated configuration classes.

The bootstrap process ends by injecting initializers into the main SpringApplication instance (which is the normal Spring Boot startup sequence, whether it is running as a standalone application or deployed in an application server). First, a bootstrap context is created from the classes found in spring.factories . Then, all @Beans of type ApplicationContextInitializer are added to the main SpringApplication before it is started.

1.6 Customizing the Bootstrap Property Sources

The default property source for external configuration added by the bootstrap process is the Spring Cloud Config Server, but you can add additional sources by adding beans of type PropertySourceLocator to the bootstrap context (through spring.factories ). For instance, you can insert additional properties from a different server or from a database.

As an example, consider the following custom locator:

@Configuration public class CustomPropertySourceLocator implements PropertySourceLocator < @Override public PropertySource locate(Environment environment) < return new MapPropertySource("customProperty", Collections.singletonMap("property.from.sample.custom.source", "worked as intended")); > >

The Environment that is passed in is the one for the ApplicationContext about to be created — in other words, the one for which we supply additional property sources for. It already has its normal Spring Boot-provided property sources, so you can use those to locate a property source specific to this Environment (for example, by keying it on spring.application.name , as is done in the default Spring Cloud Config Server property source locator).

If you create a jar with this class in it and then add a META-INF/spring.factories containing the following, the customProperty PropertySource appears in any application that includes that jar on its classpath:

org.springframework.cloud.bootstrap.BootstrapConfiguration=sample.custom.CustomPropertySourceLocator

1.7 Logging Configuration

If you are going to use Spring Boot to configure log settings than you should place this configuration in `bootstrap.[yml | properties] if you would like it to apply to all events.

For Spring Cloud to initialize logging configuration properly you cannot use a custom prefix. For example, using custom.loggin.logpath will not be recognized by Spring Cloud when initializing the logging system.

1.8 Environment Changes

The application listens for an EnvironmentChangeEvent and reacts to the change in a couple of standard ways (additional ApplicationListeners can be added as @Beans by the user in the normal way). When an EnvironmentChangeEvent is observed, it has a list of key values that have changed, and the application uses those to:

• Re-bind any @ConfigurationProperties beans in the context
• Set the logger levels for any properties in logging.level.*

Note that the Config Client does not, by default, poll for changes in the Environment . Generally, we would not recommend that approach for detecting changes (although you could set it up with a @Scheduled annotation). If you have a scaled-out client application, it is better to broadcast the EnvironmentChangeEvent to all the instances instead of having them polling for changes (for example, by using the Spring Cloud Bus).

The EnvironmentChangeEvent covers a large class of refresh use cases, as long as you can actually make a change to the Environment and publish the event. Note that those APIs are public and part of core Spring). You can verify that the changes are bound to @ConfigurationProperties beans by visiting the /configprops endpoint (a normal Spring Boot Actuator feature). For instance, a DataSource can have its maxPoolSize changed at runtime (the default DataSource created by Spring Boot is an @ConfigurationProperties bean) and grow capacity dynamically. Re-binding @ConfigurationProperties does not cover another large class of use cases, where you need more control over the refresh and where you need a change to be atomic over the whole ApplicationContext . To address those concerns, we have @RefreshScope .

1.9 Refresh Scope

When there is a configuration change, a Spring @Bean that is marked as @RefreshScope gets special treatment. This feature addresses the problem of stateful beans that only get their configuration injected when they are initialized. For instance, if a DataSource has open connections when the database URL is changed via the Environment , you probably want the holders of those connections to be able to complete what they are doing. Then, the next time something borrows a connection from the pool, it gets one with the new URL.

Sometimes, it might even be mandatory to apply the @RefreshScope annotation on some beans which can be only initialized once. If a bean is «immutable», you will have to either annotate the bean with @RefreshScope or specify the classname under the property key spring.cloud.refresh.extra-refreshable .

If you create a DataSource bean yourself and the implementation is a HikariDataSource , return the most specific type, in this case HikariDataSource . Otherwise, you will need to set spring.cloud.refresh.extra-refreshable=javax.sql.DataSource .

Refresh scope beans are lazy proxies that initialize when they are used (that is, when a method is called), and the scope acts as a cache of initialized values. To force a bean to re-initialize on the next method call, you must invalidate its cache entry.

The RefreshScope is a bean in the context and has a public refreshAll() method to refresh all beans in the scope by clearing the target cache. The /refresh endpoint exposes this functionality (over HTTP or JMX). To refresh an individual bean by name, there is also a refresh(String) method.

To expose the /refresh endpoint, you need to add following configuration to your application:

management: endpoints: web: exposure: include: refresh

@RefreshScope works (technically) on an @Configuration class, but it might lead to surprising behavior. For example, it does not mean that all the @Beans defined in that class are themselves in @RefreshScope . Specifically, anything that depends on those beans cannot rely on them being updated when a refresh is initiated, unless it is itself in @RefreshScope . In that case, it is rebuilt on a refresh and its dependencies are re-injected. At that point, they are re-initialized from the refreshed @Configuration ).

1.10 Encryption and Decryption

Spring Cloud has an Environment pre-processor for decrypting property values locally. It follows the same rules as the Config Server and has the same external configuration through encrypt.* . Thus, you can use encrypted values in the form of * and, as long as there is a valid key, they are decrypted before the main application context gets the Environment settings. To use the encryption features in an application, you need to include Spring Security RSA in your classpath (Maven co-ordinates: «org.springframework.security:spring-security-rsa»), and you also need the full strength JCE extensions in your JVM.

If you get an exception due to «Illegal key size» and you use Sun’s JDK, you need to install the Java Cryptography Extension (JCE) Unlimited Strength Jurisdiction Policy Files. See the following links for more information:

Extract the files into the JDK/jre/lib/security folder for whichever version of JRE/JDK x64/x86 you use.

1.11 Endpoints

For a Spring Boot Actuator application, some additional management endpoints are available. You can use:

• POST to /actuator/env to update the Environment and rebind @ConfigurationProperties and log levels.
• /actuator/refresh to re-load the boot strap context and refresh the @RefreshScope beans.
• /actuator/restart to close the ApplicationContext and restart it (disabled by default).
• /actuator/pause and /actuator/resume for calling the Lifecycle methods ( stop() and start() on the ApplicationContext ).

If you disable the /actuator/restart endpoint then the /actuator/pause and /actuator/resume endpoints will also be disabled since they are just a special case of /actuator/restart .

Prev	Next
Home	2. Spring Cloud Commons: Common Abstractions