1. 配置文件1.1 外部加载顺序
命令行参数
java -jar spring-boot-02-config-02.0.0.1-SNAPSHOT.jar --server.port=8087 java -jar spring-boot-02-config-02.0.0.1-SNAPSHOT.jar --spring.profiles.active=prod来自java:comp/env的NDI属性
Java系统属性(System.getProperties() )
操作系统环境变量
RandomValuePropertySource配置的random.*属性值
jar包外部的
application-{profile}.properties或application.yml（带spring.profile）配置文件-hello |- a.jar |- application.yml将打好的jar包放在一个目录下，比如叫做 hello的文件夹，然后再该文件夹下新建一个名为application.yml的文件，其中指定port为8088
，访问路径为/boot ,然后命令行直接启动项目。java -jar a.jar
浏览器通过 localhost:8088/boot/hello 可以正常访问，表示同级目录下的配置文件生效了。jar包内部的application-{profile}.properties或application.yml(带spring.profile)配置文件
jar包外部的application.properties或application.yml(不带spring.profile)配置文件
jar包外部的application.properties或application.yml(不带spring.profile)配置文件
jar包内部的application.properties或application.yml(不带spring.profile)配置文件
@Configuration注解类上的propertySource
通过SpringApplication.setDefaultProperties指定的默认属性。
1.2 springboot内部加载顺序
- 配置文件可以放在下面四个地方(优先级依次)
file:./config：项目根目录中config下file:./：项目根目录下classpath:./config：项目的resources目录中config下classpath:./：项目的resources目录下
当使用的项目是module级别的时候，必须使用级别是project级别才能扫描到
file:下面的文件
- 同目录下
.properties的优先级比.yml高， - 如果同一个配置属性，多个文件都配置了，默认使用第一次读取到的，后续不覆盖
- 高优先级会覆盖低优先级
1.3 改变默认的配置文件位置
**项目打包好以后，我们可以使用命令行参数的形式，启动项目的时候来指定配置文件的新位置；指定默认加载的这些配置文件共同起作用形成互补配置
**
在 G盘目录下，创建一个application.properties文件(yml也可以)，定义端口为8085
打包项目，启动命令行：
java -jar spring-boot-02-config-02.0.0.1-SNAPSHOT.jar --spring.config.location=G:/application.properties回车运行。
浏览器访问： http:localhost:8005/boot02/hello ,显然外部指定的配置文件生效了，并且与之前的主配置文件形成了互补配置
1.4 使用profile配置和加载配置文件1.4.1 使用.properties文件
假如有开发、测试、生产三个不同的环境，需要定义三个不同环境下的配置
application.propertiesapplicaiton-dev.propertiesapplictiong-test.propertiesapplicaiton-prod.properties在application.properties文件中指定当前使用的环境:
server.port=8001# 激活哪个配置文件spring.profiles.active=dev#spring.profiles.active=dev,prod,testspring.profiles.include=prod1.4.2 使用.yml文件
因为在yml文件中，---表示文档分隔符，每个文档独立，所以此时只需要一个.yml文件
spring: profiles: active: prod---spring: profiles: devserver: 8080---spring: profiles: testserver: 8081---spring.profiles: prodspring.profiles.include: - proddb - prodmqserver: 8082---spring: profiles: proddbdb: name: mysql---spring: profiles: prodmqmq: address: localhost此时读取的就是prod的配置，prod包含proddb,prodmq，此时可以读取proddb,prodmq下的配置
也可以同时激活三个配置spring.profiles.active: prod,proddb,prodmq
1.4.3 使用Java中的@Profile注解
@Profile注解只能配合@Configuration和@Component使用
@Configuration@Profile("prod")public class ProductionConfiguration { // ...}1.5 读取自定义配置文件1.5.1 利用 @PropertiesSource 注解来实现
@PropertiesSource 可以用来加载指定的配置文件,默认只能加载 *.properties 文件, 不能加载 yml 等文件
相关属性
- value: 指明加载配置文件的路径
- ignoreResourceNotFound：指定的配置文件不存在是否报错，默认是false。当设置为 true 时，若该文件不存在，程序不会报错。实际项目开发中，最好设置
ignoreResourceNotFound 为 false。 - encoding：指定读取属性文件所使用的编码，我们通常使用的是UTF-8。
示例
import lombok.AllArgsConstructor;import lombok.Builder;import lombok.Data;import lombok.NoArgsConstructor;import org.springframework.boot.context.properties.ConfigurationProperties;import org.springframework.context.annotation.Configuration;import org.springframework.context.annotation.PropertySource;@Data@AllArgsConstructor@NoArgsConstructor@Builder@Configuration@PropertySource(value = {"classpath:common.properties"}, ignoreResourceNotFound = false, encoding = "UTF-8")@ConfigurationProperties(prefix = "author")// 这个注解的作用是指明配置文件中需要注入信息的前缀public class Author { private Stirng name; private String job; private String sex;}当需要用 yml作为配置文件时此时我们可以通过实现PropertySourceFactory接口，重写createPropertySource方法，就能实现用@PropertySource也能加载yaml等类型文件。
import org.springframework.beans.factory.config.YamlPropertiesFactoryBean;import org.springframework.context.annotation.PropertySource;import org.springframework.core.env.PropertiesPropertySource;import org.springframework.core.io.support.EncodedResource;import org.springframework.core.io.support.PropertySourceFactory;import org.springframework.util.StringUtils;import java.io.FileNotFoundException;import java.util.Properties;public class YamlPropertiesSourceFactory implements PropertySourceFactory { @Override public PropertySource createPropertySource(String sourceName, EncodedResource resource) throws IOException { Properties propertiesFromYaml = loadYaml(resource); if (StringUtils.isBlank(sourceName)) { sourceName = resource.getResource().getFilename(); } return new PropertiesPropertySource(sourceName, propertiesFromYaml); } private Properties loadYaml(EncodedResource resource) throws FileNotFoundException { try { YamlPropertiesFactoryBean factory = new YamlPropertiesFactoryBean(); factory.setResources(resource.getResource()); factory.afterPropertiesSet(); return factory.getObject(); } catch (IllegalStateException e) { Throwable cause = e.getCause(); if (cause instanceof FileNotFoundException) { throw (FileNotFoundException) cause; } throw e; } }}import lombok.AllArgsConstructor;import lombok.Builder;import lombok.Data;import lombok.NoArgsConstructor;import org.springframework.boot.context.properties.ConfigurationProperties;import org.springframework.context.annotation.Configuration;import org.springframework.context.annotation.PropertySource;@Data@AllArgsConstructor@NoArgsConstructor@Builder@Configuration// 指明上面写好的工厂类@PropertySource(factory = YamlPropertySourceFactory.class, value = {"classpath:user.yml"}, ignoreResourceNotFound = false, encoding = "UTF-8")@ConfigurationProperties(prefix = "author")// 这个注解的作用是指明配置文件中需要注入信息的前缀public class Author { private Stirng name; private String job; private String sex;}1.5.2 使用 EnvironmentPostProcessor 加载自定义配置文件
实现流程
- 实现EnvironmentPostProcessor接口,重写postProcessEnvironment方法
public class MyEnvironmentPostProcessor implements EnvironmentPostProcessor { @Override public void postProcessEnvironment(ConfigurableEnvironment environment, SpringApplication application) { String[] profiles = {"config/test.properties", "config/custom.properties", "config/blog.yml"}; for (String profile : profiles) { Resource resource = new ClassPathResource(profile); environment.getPropertySources().addLast(loadProfiles(resource)); } } private PropertySource loadProfiles(Resource resource) { if (!resource.exists()) { throw new IllegalArgumentException("资源不存在"); } if (resource.getFilename().endsWith("yml")) { return loadYaml(resource); } else { return loadProperty(resource); } } private PropertySource loadProperty(Resource resource) { try { Properties properties = new Properties(); properties.load(resource.getInputStream()); return new PropertiesPropertySource(resource.getFilename(), properties); } catch (Exception e) { throw new IllegalStateException("加载Property配置文件失败", e); } } private PropertySource loadYaml(Resource resource) { try { YamlPropertiesFactoryBean factoryBean = new YamlPropertiesFactoryBean(); factoryBean.setResources(resource); Properties properties = factoryBean.getObject(); return new PropertiesPropertySource(resource.getFilename(), properties); } catch (Exception e) { throw new IllegalStateException("加载Yaml配置文件失败", e); } }}- 在META-INF下创建spring.factories
# spring.factories 文件内容如下：# 启用自定义环境处理类org.springframework.boot.env.EnvironmentPostProcessor=com.zhangyu.config.MyEnvironmentPostProcessor1.6 SpringBoot使用通配符加载配置文件
还可以使用通配符加载自定义配置文件，貌似是spring的实现方式
@Configurationpublic class PropertyConfig { @Bean public PropertySourcesPlaceholderConfigurer getPropertySourcesPlaceholderConfigurer() throws IOException { PropertySourcesPlaceholderConfigurer configurer = new PropertySourcesPlaceholderConfigurer(); configurer.setLocations(new PathMatchingResourcePatternResolver().getResources("classpath:properties/*.properties")); return configurer; }}
classpath*:和classpath:的区别是
classpath:: 只会到你的class路径中查找找文件。
classpath*:: 不仅包含class路径，还包括jar文件中（class路径）进行查找。