Как SpringBoot элегантно читает файлы конфигурации за 10 минут?

Java

Эта статья, включенная в springboot-guide (не только SpringBoot, но и важные моменты знаний Spring), адрес:GitHub.com/snail Climb/…. Облегчает вам изучение Spring! Если вы думаете, что это хорошо, добро пожаловать на заказ звезды!

Во многих случаях нам необходимо поместить в файл конфигурации некоторую часто используемую информацию о конфигурации, такую ​​как конфигурация операционной системы Alibaba Cloud, конфигурация связанной информации для отправки SMS и т. д.

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

application.ymlСодержание следующее:

wuhan2020: 2020年初武汉爆发了新型冠状病毒，疫情严重，但是，我相信一切都会过去！武汉加油！中国加油！

my-profile:
  name: Guide哥
  email: koushuangbwcx@163.com

library:
  location: 湖北武汉加油中国加油
  books:
    - name: 天才基本法
      description: 二十二岁的林朝夕在父亲确诊阿尔茨海默病这天，得知自己暗恋多年的校园男神裴之即将出国深造的消息——对方考取的学校，恰是父亲当年为她放弃的那所。
    - name: 时间的秩序
      description: 为什么我们记得过去，而非未来？时间“流逝”意味着什么？是我们存在于时间之内，还是时间存在于我们之中？卡洛·罗韦利用诗意的文字，邀请我们思考这一亘古难题——时间的本质。
    - name: 了不起的我
      description: 如何养成一个新习惯？如何让心智变得更成熟？如何拥有高质量的关系？ 如何走出人生的艰难时刻？

1. Пройти@valueЧитать относительно простую информацию о конфигурации

использовать@Value("${property}")Прочтите относительно простую информацию о конфигурации:

@Value("${wuhan2020}")
String wuhan2020;

должен быть в курсе@valueЭтот подход не рекомендуется, Spring относительно предлагает несколько способов чтения информации о конфигурации ниже.

2. Пройти@ConfigurationPropertiesпрочитать и привязать к бину

LibraryPropertiesдобавлен в класс@ComponentAnnotation, мы можем внедрить его в класс и использовать как обычный bean-компонент.


import lombok.Getter;
import lombok.Setter;
import lombok.ToString;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.Configuration;
import org.springframework.stereotype.Component;

import java.util.List;

@Component
@ConfigurationProperties(prefix = "library")
@Setter
@Getter
@ToString
class LibraryProperties {
    private String location;
    private List<Book> books;

    @Setter
    @Getter
    @ToString
    static class Book {
        String name;
        String description;
    }
}

На этом этапе вы можете внедрить его в класс, как обычный bean-компонент, и использовать его:

package cn.javaguide.readconfigproperties;

import org.springframework.beans.factory.InitializingBean;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

/**
 * @author shuang.kou
 */
@SpringBootApplication
public class ReadConfigPropertiesApplication implements InitializingBean {

    private final LibraryProperties library;

    public ReadConfigPropertiesApplication(LibraryProperties library) {
        this.library = library;
    }

    public static void main(String[] args) {
        SpringApplication.run(ReadConfigPropertiesApplication.class, args);
    }

    @Override
    public void afterPropertiesSet() {
        System.out.println(library.getLocation());
        System.out.println(library.getBooks());    }
}

Вывод консоли:

湖北武汉加油中国加油
[LibraryProperties.Book(name=天才基本法, description........]

3. Пройти@ConfigurationPropertiesчитать и проверять

Мы сначалаapplication.ymlИзмените его на следующее, очевидно, что это неправильный формат электронной почты:

my-profile:
  name: Guide哥
  email: koushuangbwcx@

ProfilePropertiesкласс не добавлен@Componentаннотация. мы собираемся использоватьProfilePropertiesгде использовать@EnableConfigurationPropertiesПодпишитесь на наш конфигурационный компонент:

import lombok.Getter;
import lombok.Setter;
import lombok.ToString;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;
import org.springframework.validation.annotation.Validated;

import javax.validation.constraints.Email;
import javax.validation.constraints.NotEmpty;

/**
* @author shuang.kou
*/
@Getter
@Setter
@ToString
@ConfigurationProperties("my-profile")
@Validated
public class ProfileProperties {
   @NotEmpty
   private String name;

   @Email
   @NotEmpty
   private String email;

   //配置文件中没有读取到的话就用默认值
   private Boolean handsome = Boolean.TRUE;

}

Особое использование:

package cn.javaguide.readconfigproperties;

import org.springframework.beans.factory.InitializingBean;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.context.properties.EnableConfigurationProperties;

/**
 * @author shuang.kou
 */
@SpringBootApplication
@EnableConfigurationProperties(ProfileProperties.class)
public class ReadConfigPropertiesApplication implements InitializingBean {
    private final ProfileProperties profileProperties;

    public ReadConfigPropertiesApplication(ProfileProperties profileProperties) {
        this.profileProperties = profileProperties;
    }

    public static void main(String[] args) {
        SpringApplication.run(ReadConfigPropertiesApplication.class, args);
    }

    @Override
    public void afterPropertiesSet() {
        System.out.println(profileProperties.toString());
    }
}

Поскольку наш формат почтового ящика неверен, программа сообщит об ошибке при запуске и не запустится вообще, обеспечивая безопасность типа данных:

Binding to target org.springframework.boot.context.properties.bind.BindException: Failed to bind properties under 'my-profile' to cn.javaguide.readconfigproperties.ProfileProperties failed:

    Property: my-profile.email
    Value: koushuangbwcx@
    Origin: class path resource [application.yml]:5:10
    Reason: must be a well-formed email address

Мы меняем тест почтового ящика на правильный и затем запускаем его, консоль может успешно распечатать прочитанную информацию:

ProfileProperties(name=Guide哥, email=koushuangbwcx@163.com, handsome=true)

4.@PropertySourceПрочитать указанный файл свойств

import lombok.Getter;
import lombok.Setter;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.PropertySource;
import org.springframework.stereotype.Component;

@Component
@PropertySource("classpath:website.properties")
@Getter
@Setter
class WebSite {
    @Value("${url}")
    private String url;
}

использовать:

@Autowired
private WebSite webSite;

System.out.println(webSite.getUrl());//https://javaguide.cn/

5. Не по теме: Приоритет загрузки конфигурационных файлов Spring

Spring читает конфигурационный файл тоже в приоритете, прямо на карте:

Для получения дополнительной информации, пожалуйста, проверьте официальную документацию:docs.spring.IO/весенняя загрузка…

Исходный код этой статьи:GitHub.com/snail Climb/…

Рекомендация проекта с открытым исходным кодом

Другие рекомендации автора по проектам с открытым исходным кодом:

  1. JavaGuide: [Изучение Java + интервью] Обложка, которая охватывает основные знания, которые необходимо освоить большинству Java-программистов.
  2. springboot-guide: Учебники по загрузке Spring, которые подходят для новичков и опытных разработчиков (в свободное время обслуживание, добро пожаловать в поддержку).
  3. programmer-advancement: Я думаю, некоторые хорошие привычки, которые должны быть у техников!
  4. spring-security-jwt-guide:Начинать с нуля! Spring Security с JWT (включая проверку авторизации) бэкэнд-часть кода.

публика

Категории