spring boot 是怎样加载配值文件的

2. public SpringApplication(ResourceLoader resourceLoader, Class<?>... primarySources) {
3.         this.sources = new LinkedHashSet();
4.         this.bannerMode = Mode.CONSOLE;
5.         this.logStartupInfo = true;
6.         this.addCommandLineProperties = true;
7.         this.addConversionService = true;
8.         this.headless = true;
10.         this.registerShutdownHook = true;
11.         this.additionalProfiles = Collections.emptySet();
12.         this.isCustomEnvironment = false;
13.         this.lazyInitialization = false;
14.         this.applicationContextFactory = ApplicationContextFactory.DEFAULT;
15.         this.applicationStartup = ApplicationStartup.DEFAULT;
17.         this.resourceLoader = resourceLoader;
18.         Assert.notNull(primarySources, "PrimarySources must not be null");
19.         this.primarySources = new LinkedHashSet(Arrays.asList(primarySources));
20.         //1.推测web应用类型（NONE   REACTIVE   SERVLET）
21.         this.webApplicationType = WebApplicationType.deduceFromClasspath();
23.          //2.从spring.factories中获取BootstrapRegistryInitializer对象
24.         this.bootstrapRegistryInitializers =            
25.        this.getBootstrapRegistryInitializersFromSpringFactories();
26.         
27. //3.从spring.factories中获取ApplicationContextInitializer对象
28. this.setInitializers(this.getSpringFactoriesInstances(ApplicationContextInitializer.class));
29.          //4.从spring.factories中获取ApplicationListener对象
30.         this.setListeners(this.getSpringFactoriesInstances(ApplicationListener.class));
31.         //5.推测出Main类 (main()方法所在的类)
32.         this.mainApplicationClass = this.deduceMainApplicationClass();
33.     }

复制代码

2. public ConfigurableApplicationContext run(String... args) {
3.         StopWatch stopWatch = new StopWatch();
4.         stopWatch.start();
5.         DefaultBootstrapContext bootstrapContext = this.createBootstrapContext();
6.         ConfigurableApplicationContext context = null;
7.         this.configureHeadlessProperty();
8.            /**从spring.factories中获取SpringApplicationRunListeners 对象
9.             * 默认会拿到一个EventPublishingRunListener ，他会启动过程的各个阶段发布对应的事件
10.             **/
11.         SpringApplicationRunListeners listeners = this.getRunListeners(args);
12.         listeners.starting(bootstrapContext, this.mainApplicationClass);
14.         try {
15.             //将run()的参数封装为DefaultApplicationArguments对象
16.             ApplicationArguments applicationArguments = new DefaultApplicationArguments(args);
17.                 //配置文件的入口
18.             ConfigurableEnvironment environment = this.prepareEnvironment(listeners, bootstrapContext, applicationArguments);
19.             this.configureIgnoreBeanInfo(environment);
20.             Banner printedBanner = this.printBanner(environment);
21.             //根据应用类型创建Spring容器
22.             context = this.createApplicationContext();
23.             context.setApplicationStartup(this.applicationStartup);
24.             this.prepareContext(bootstrapContext, context, environment, listeners, applicationArguments, printedBanner);
25.                //刷新Spring容器， 会解析配置类  扫描  启动Webserver
26.             this.refreshContext(context);
27.             this.afterRefresh(context, applicationArguments);
28.             stopWatch.stop();
29.             if (this.logStartupInfo) {
30.                 (new StartupInfoLogger(this.mainApplicationClass)).logStarted(this.getApplicationLog(), stopWatch);
31.             }
33.             listeners.started(context);
35.             //调用applicationArguments 和CommandLineRunner
36.             this.callRunners(context, applicationArguments);
37.         } catch (Throwable var10) {
38.             this.handleRunFailure(context, var10, listeners);
39.             throw new IllegalStateException(var10);
40.         }
42.         try {
43.             listeners.running(context);
44.             return context;
45.         } catch (Throwable var9) {
46.             this.handleRunFailure(context, var9, (SpringApplicationRunListeners)null);
47.             throw new IllegalStateException(var9);
48.         }
49.     }

复制代码

Spring Boot 加载设置文件的机制是其核心功能之一，它通过一系列源码实现从差别泉源加载设置，并支持机动的设置管理。以下是 Spring Boot 加载设置文件的源码分析及着实现原理的具体阐明。（上述两段是加载设置文件的源码片断）

---

1. Spring Boot 加载设置文件的团体流程

Spring Boot 加载设置文件的流程可以分为以下几个步调：

•         初始化 Environment：在应用启动时，创建并初始化 Environment 对象。
  
•         加载默认设置文件：从 application.properties 或 application.yml 加载设置。
  
•         加载 Profile 特定的设置文件：根据激活的 Profile 加载 application-{profile}.properties 或 application-{profile}.yml。
  
•         加载外部化设置：从下令行参数、情况变量、JNDI 等外部泉源加载设置。
  
•         归并设置：将全部设置泉源归并到 Environment 中，供应用步伐利用。
  

---

2. 源码分析

以下是 Spring Boot 加载设置文件的核心源码分析。
2.1 SpringApplication.run()

Spring Boot 应用的启动入口是 SpringApplication.run() 方法。在这个方法中，会初始化 Environment 并加载设置文件。
源码位置：org.springframework.boot.SpringApplication

2. public ConfigurableApplicationContext run(String... args) {
3.    // ...
4.    ConfigurableEnvironment environment = prepareEnvironment(listeners, applicationArguments);
5.    // ...
6. }

复制代码

阐明：

•         prepareEnvironment() 方法负责创建和设置 Environment 对象。
  

---

2.2 prepareEnvironment()

prepareEnvironment() 方法会调用 configureEnvironment() 来加载设置文件。
源码位置：org.springframework.boot.SpringApplication

2. private ConfigurableEnvironment prepareEnvironment(SpringApplicationRunListeners listeners, ApplicationArguments applicationArguments) {
3.    // 创建 Environment 对象
4.    ConfigurableEnvironment environment = getOrCreateEnvironment();
5.    // 配置 Environment，加载配置文件
6.    configureEnvironment(environment, applicationArguments.getSourceArgs());
7.    // 触发环境准备事件
8.    listeners.environmentPrepared(environment);
9.    // 将 Environment 绑定到 SpringApplication
10.    bindToSpringApplication(environment);
11.    return environment;
12. }

复制代码

阐明：

•         getOrCreateEnvironment()：根据应用范例（Web 或非 Web）创建 StandardEnvironment 或 StandardServletEnvironment。
  
•         configureEnvironment()：加载设置文件和其他外部化设置。
  

---

2.3 configureEnvironment()

configureEnvironment() 方法会调用 configurePropertySources() 和 configureProfiles() 来加载设置文件和激活 Profile。
源码位置：org.springframework.boot.SpringApplication

2. protected void configureEnvironment(ConfigurableEnvironment environment, String[] args) {
3.    configurePropertySources(environment, args);
4.    configureProfiles(environment, args);
5. }

复制代码

阐明：

•         configurePropertySources()：加载下令行参数、默认设置文件等。
  
•         configureProfiles()：设置激活的 Profile。
  

---

2.4 ConfigFileApplicationListener

ConfigFileApplicationListener 是 Spring Boot 加载设置文件的核心类。它监听 ApplicationEnvironmentPreparedEvent 变乱，并加载 application.properties 或 application.yml 文件。
源码位置：org.springframework.boot.context.config.ConfigFileApplicationListener

2. public void onApplicationEvent(ApplicationEvent event) {
3.    if (event instanceof ApplicationEnvironmentPreparedEvent) {
4.        onApplicationEnvironmentPreparedEvent((ApplicationEnvironmentPreparedEvent) event);
5.    }
6. }

复制代码

阐明：

•         onApplicationEnvironmentPreparedEvent()：在情况准备完成后触发，加载设置文件。
  

---

2.5 Loader.load()

Loader 是 ConfigFileApplicationListener 的内部类，负责现实加载设置文件。
源码位置：org.springframework.boot.context.config.ConfigFileApplicationListener.Loader

2. void load() {
3.    for (String location : getSearchLocations()) {
4.        for (String name : getSearchNames()) {
5.            load(location, name);
6.        }
7.    }
8. }

复制代码

阐明：

•         getSearchLocations()：获取设置文件的搜索路径（如 classpath:/、file:./config/ 等）。
  
•         getSearchNames()：获取设置文件的名称（如 application）。
  
•         load(location, name)：从指定路径加载设置文件。
  

---

2.6 PropertySourcesLoader

PropertySourcesLoader 负责将设置文件内容加载到 PropertySource 中。
源码位置：org.springframework.boot.env.PropertySourcesLoader

2. public PropertySource<?> load(Resource resource) throws IOException {
3.    if (resource.getFilename().endsWith(".yml")) {
4.        return loadYaml(resource);
5.    } else {
6.        return loadProperties(resource);
7.    }
8. }

复制代码

阐明：

•         loadYaml()：加载 YAML 格式的设置文件。
  
•         loadProperties()：加载 Properties 格式的设置文件。
  

---

2.7 Profile 的加载

Spring Boot 支持通过 Profile 加载差别的设置文件。Profiles 和 ProfilePropertySource 负责处理处罚 Profile 相干的设置。
源码位置：org.springframework.core.env.Profiles

2. public static Profiles of(String... profiles) {
3.    return new Profiles() {
4.        @Override
5.        public boolean matches(Predicate<String> predicate) {
6.            // ...
7.        }
8.    };
9. }

复制代码

阐明：

•         Profiles：管理 Profile 的激活状态。
  
•         ProfilePropertySource：根据激活的 Profile 加载特定的设置文件。
  

---

3. Spring Boot 加载设置文件的实现原理

Spring Boot 加载设置文件的实现原理可以总结为以下几点：

•         多泉源加载：
  
  
  
  •                 支持从类路径、外部目次、情况变量、下令行参数等多种泉源加载设置。
    
         
  
•         优先级机制：
  
  
  
  •                 后加载的设置会覆盖先加载的设置，下令行参数的优先级最高。
    
         
  
•         Profile 支持：
  
  
  
  •                 通过 spring.profiles.active 指定激活的 Profile，加载对应的设置文件。
    
         
  
•         外部化设置：
  
  
  
  •                 支持从外部文件、情况变量、JNDI 等加载设置，实用于云原生和容器化摆设。
    
         
  

---

4. 示例：Spring Boot 加载设置文件的流程

以下是一个完备的示例，展示 Spring Boot 怎样加载设置文件。
4.1 默认设置文件

application.properties：

2. server.port=8080
3. spring.profiles.active=dev

复制代码

4.2 Profile 特定的设置文件

application-dev.properties：

2. server.port=8081

复制代码

4.3 Java 代码

2. @RestController
3. public class MyController {
4. ​
5.    @Value("${server.port}")
6.    private String port;
7. ​
8.    @GetMapping("/port")
9.    public String getPort() {
10.        return "Server port: " + port;
11.    }
12. }

复制代码

4.4 运行效果

•         如果激活的 Profile 是 dev，则 server.port 的值为 8081。
  
•         如果没有激活 Profile，则 server.port 的值为 8080。
  

---

5. 总结

Spring Boot 加载设置文件的机制非常机动，支持多泉源、多格式的设置加载。通过 Environment、PropertySource、ConfigFileApplicationListener 等核心类和组件，Spring Boot 实现了设置文件的加载、归并和优先级管理。明白这些源码和机制，可以资助我们更好地利用和扩展 Spring Boot 的设置功能。


免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。

继续阅读请点击广告