Каталог статей

• • Роль конфигурационных файлов
  • Файл конфигурации YAML
  • Файл конфигурации свойств
  • Порядок загрузки файла конфигурации
  • Активируйте разные профили
  • Заполнитель для файла конфигурации
  • Свойства пользовательской конфигурации
  • Зашифруйте конфиденциальную информацию
  • Лучшие практики для файлов конфигурации
  • в заключение

🎉Добро пожаловать в рубрику архитектурного дизайна~Весна Файл конфигурации загрузки (YAML & Свойства) сводка

• ☆* o(≧▽≦)o *☆Привет~Я ОНО·Чэнь Хань🍹
• ✨Домашняя страница блога：IT·Блог Чен Хана
• 🎈Рубрика этой серии статей：Архитектурный дизайн
• 📜Другие столбцы：Маршрут изучения Java Советы по собеседованию на Java Практические проекты по Java AIGCИскусственный интеллект Изучение структуры данных
• 🍹У автора статьи ограничены навыки и уровень. Если в статье есть ошибки, надеюсь, вы их исправите🙏
• 📜 приветствую всехсосредоточиться на！ ❤️

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

Роль конфигурационных файлов

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

Файл конфигурации YAML

YAML (YAML не является языком разметки) — это удобочитаемый формат сериализации данных, который представляет иерархии данных с отступом. В Spring Boot файлы YAML часто используются для настройки сложных свойств.

Вот простой пример YAML-файла конфигурации:

server:
  port: 8080
  servlet:
    context-path: /myapp

spring:
  datasource:
    url: jdbc:mysql://localhost:3306/mydb
    username: root
    password: password

В этом примере,Мы определили порт сервера, путь контекста сервлета и свойства подключения к базе данных. Обратите внимание, что отступы файлов YAML указывают на иерархическую структуру.,Итак, подсвойство（нравитьсяport、context-path）Должен иметь отступ в два пробела, чтобы указать, что они являются дочерними свойствами родительского свойства.。

Файл конфигурации свойств

Файл свойств имеет форму пар ключ-значение, которые хранятся в Spring. Он также широко используется в Boot. Ниже приведен приведенный выше файл. конфигурации Эквивалентные свойства версии YAML:

server.port=8080
server.servlet.context-path=/myapp

spring.datasource.url=jdbc:mysql://localhost:3306/mydb
spring.datasource.username=root
spring.datasource.password=password

В файле свойств каждая строка содержит пару ключ-значение свойства. Ключи и значения разделяются знаком равенства (=).

Порядок загрузки файла конфигурации

Файлы конфигурации Spring Boot могут существовать в нескольких местах и ​​загружаются в определенном порядке. Вот последовательность загрузки:

1. в текущем каталоге/configпапка。
2. текущий каталог.
3. на пути к классам/configСумка。
4. Корневой каталог пути к классам.

Это означает, что если существует несколько файлов конфигурации, файл конфигурации, загруженный позже, перезапишет конфигурацию, загруженную ранее, что позволит нам использовать разные файлы конфигурации в разных средах.

Активируйте разные профили

Spring Bootиспользоватьspring.profiles.activeатрибуты приходят Активируйте разные профили。Можно найти вapplication.propertiesилиapplication.yamlУстановите это свойство в,Его также можно указать в командной строке или в переменной среды.

Например,существоватьapplication.propertiesустановить активацию в Конфигурация Файлdev：

spring.profiles.active=dev

Затем,Создайте файл с именемapplication-dev.propertiesилиapplication-dev.yamlиз Конфигурациядокумент,其中Сумка含与dev环境相关из Конфигурация。

Заполнитель для файла конфигурации

Spring Boot允许существовать Конфигурациядокумент中использовать占位符${...}来引用其他属性из值。这对于существовать不同Конфигурациядокумент之间共享属性值非常有用。

Вот пример использования заполнителей:

server.port=8080
app.name=myapp-${server.port}

В этом примере,app.name属性из值将被解析为myapp-8080。

Свойства пользовательской конфигурации

Помимо использования Spring В дополнение к атрибуту «Конфигурация» по умолчанию в Boot мы также можем определить наш собственный атрибут «Конфигурация». Определить свойства пользовательской конфигурации,Вы можете создать класс Java,并использовать@ConfigurationProperties注解来指定属性из前缀。Затем,Зарегистрируйте этот класс как компонент в контейнере Spring.

Ниже приводится Свойства пользовательской конфигурациииз示例：

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;

@Component
@ConfigurationProperties(prefix = "myapp")
public class MyAppProperties {

    private String greeting;

    public String getGreeting() {
        return greeting;
    }

    public void setGreeting(String greeting) {
        this.greeting = greeting;
    }
}

В приведенном выше примере,Мы определяем файл с именемmyapp.greetingиз属性,并существоватьMyAppProperties类中声明了一个相应из字段。现существовать,Мы можем установить значение этого свойства в файле конфигурации:

myapp:
  greeting: Hello, World!

Затем,Можно найти в应用程序中注入MyAppProperties类来获取该属性из值。

Зашифруйте конфиденциальную информацию

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

可以использоватьjasypt-spring-boot-starterПодождите, пока сторонняя библиотека внедрит шифрование атрибутов.。Ниже приводится示例：

Сначала добавьте зависимости:

<dependency>
    <groupId>com.github.ulisesbocchio</groupId>
    <artifactId>jasypt-spring-boot-starter</artifactId>
    <version>3.0.3</version>
</dependency>

Затем используйте зашифрованные конфиденциальные свойства в файле конфигурации:

myapp:
  password: ЭНК (зашифрованный текст)

В приведенном выше примере,ENC(...)Указывает, что значение атрибута было зашифровано.。Spring Boot автоматически расшифрует значение атрибута и внедрит его в приложение.

Лучшие практики для файлов конфигурации

Ниже приведены некоторые весенние BootЛучшие практики для файлов конфигурации：

1. Используйте файлы конфигурации в формате YAML для управления сложными свойствами.,Используйте файлы конфигурации в формате свойств для управления простыми свойствами.
2. использовать多个Конфигурациядокумент来支持不同из环境（нравитьсяapplication-dev.yaml、application-prod.yamlждать）。
3. Используйте заполнители для ссылки на значения других свойств, чтобы избежать жесткого кодирования.
4. Храните конфиденциальную информацию в зашифрованном виде и используйте сторонние библиотеки для реализации шифрования атрибутов.
5. использовать Свойства пользовательской Класс конфигурации для инкапсуляции и управления связанными свойствами.

в заключение

Spring Файлы конфигурации загрузки являются ключом к управлению конфигурацией приложения. Рационально используя файлы конфигурации формата YAML и Properties, мы можем легко управлять различными свойствами приложения, тем самым повышая гибкость и удобство обслуживания приложения. В то же время весна Boot также предоставляет богатые функции для поддержки свойств. пользовательской конфигурация и шифрование атрибутов для удовлетворения потребностей различных проектов. Надеюсь, эта статья поможет вам понять и использовать Spring. Файлы конфигурации загрузки помогают!