java注解加载配置⽂件_SpringBoot读取配置⽂件的⼏种⽅式Spring Boot获取⽂件总的来说有三种⽅式，分别是@Value注解，@ConfigurationProperties注解和Environment接⼝。这三种注解可以配合着@PropertySource来使⽤，@PropertySource主要是⽤来指定具体的配置⽂件。
@PropertySource解析
潍坊邮编>唐嫣和邱泽图片@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Repeatable(PropertySources.class)
public @interface PropertySource {
String name() default "";
String[] value();
boolean ignoreResourceNotFound() default false;
String encoding() default "";
Class extends PropertySourceFactory> factory() default PropertySourceFactory.class;
}
value()：指定配置⽂件
encoding()：指定编码，因为properties⽂件的编码默认是ios8859-1，读取出来是乱码
factory()：⾃定义解析⽂件类型，因为该注解默认只会加载properties⽂件，如果想要指定yml等其他格式的⽂件需要⾃定义实现。
⼀、@Value注解读取⽂件
新建两个配置⽂件config.properties和configs.properties，分别写⼊如下内容：
新增⼀个类⽤来读取配置⽂件
@Configuration
@PropertySource(value = {"classpath:config.properties"},encoding="gbk")
public class GetProperties {
@Value("${fig.web-configs.name}")
private String name;
翟天临事件始末@Value("${fig.web-configs.age}")
private String age;
public String getConfig() {
return name+"-----"+age;
}
}
如果想要读取yml⽂件，则我们需要重写DefaultPropertySourceFactory，让其加载yml⽂件，然后在注解
@PropertySource上⾃定factory。代码如下：
public class YmlConfigFactory extends DefaultPropertySourceFactory {
@Override
赚q币public PropertySource> createPropertySource(String name, EncodedResource resource) throws IOException { String sourceName = name != null ? name : Resource().getFilename();
if (!Resource().exists()) {
return new PropertiesPropertySource(sourceName, new Properties());
} else if (dsWith(".yml") || dsWith(".yaml")) {
Properties propertiesFromYaml = loadYml(resource);
return new PropertiesPropertySource(sourceName, propertiesFromYaml);
} else {
atePropertySource(name, resource);
}
}
private Properties loadYml(EncodedResource resource) throws IOException {
YamlPropertiesFactoryBean factory = new YamlPropertiesFactoryBean();
factory.Resource());
factory.afterPropertiesSet();
Object();
}
}
@PropertySource(value = {"classpath:config.properties"},encoding="gbk",factory = YmlConfigFactory.class)⼆、Environment读取⽂件
配置⽂件我们继续⽤上⾯的两个，定义⼀个类去读取配置⽂件
@Configuration
@PropertySource(value = {"classpath:config.properties"},encoding="gbk")
public class GetProperties {
@Autowired
Environment environment;
public String getEnvConfig(){
String name = Property("fig.web-configs.name");
String age = Property("fig.web-configs.age");
return name+"-----"+age;
}
}
三、@ConfigurationProperties读取配置⽂件
@ConfigurationProperties可以将配置⽂件直接映射成⼀个实体类，然后我们可以直接操作实体类来获取配置⽂件相关数据。新建⼀个yml⽂件，当然properties⽂件也没问题
zhbin:
config:
web-configs:
name: Java旅途
age: 20
新建实体类⽤来映射该配置
@Component
@ConfigurationProperties(prefix = "fig")
@Data
public class StudentYml {
// webConfigs务必与配置⽂件相对应，写为驼峰命名⽅式
private WebConfigs webConfigs = new WebConfigs();
@Data
新年诗句public static class WebConfigs {
private String name;
private String age;
}
}
prefix = "fig"⽤来指定配置⽂件前缀
如果需要获取list集合，则做以下修改即可。
zhbin:
config:
web-configs:
- name: Java旅途
age: 20
- name: Java旅途2
age: 202
@Component
@ConfigurationProperties(prefix = "fig")
@Data
public class StudentYml {
private List webConfigs = new ArrayList<>();
@Data
public static class WebConfigs {
private String name;
private String age;
}
}
经验与坑
properties⽂件默认使⽤的是iso8859-1，并且不可修改
读取配置文件失败yml⽂件的加载顺序⾼于properties，但是读取配置信息的时候会读取后加载的@PropertySource注解默认只会加载properties⽂件
@PropertySource注解可以与任何⼀种⽅式联合使⽤
简单值推荐使⽤@Value，复杂对象推荐使⽤@ConfigurationProperties