前言 在朋友的項目有個自定義配置文件user.yml，其內容如下 user: userId: 1 name: 張三 email: [email protected] 其映射實體內容為如下 @Data @AllArgsConstructor @NoArgsConstructor @Builder @Pro ...
前言
在朋友的項目有個自定義配置文件user.yml，其內容如下
user:
userId: 1
name: 張三
email: [email protected]
其映射實體內容為如下
@Data
@AllArgsConstructor
@NoArgsConstructor
@Builder
@PropertySource(value = "user.yml",encoding = "utf-8",factory = CustomYmlPropertySourceFactory.class)
@ConfigurationProperties(prefix = "user")
@Configuration
public class User {
private String name;
private Long userId;
private String email;
}
項目啟動後，輸出的user內容為
User(name=Administrator, userId=1, [email protected])
很明顯name的內容不是我們想要的
排查
從跟蹤的源碼可以發現有個systemProperties配置排在user.yml前面。systemProperties這是個啥東西，見名之意，這明顯就是系統屬性配置。而systemProperties裡面又有啥內容，我們繼續跟蹤下
從源碼可以看出systemProperties裡面有個key為user.name,value為Administrator。
從這邊我們可以看出我們控制台列印出來的內容其實是systemProperties的內容。由此我們可以推斷出當系統變數和自定義配置變數都有一樣的key時，將以系統變數的值為準。
看到這邊也許有朋友說你這是在胡說八道，就憑這個現象就得出這個結論。那好為了證明這個結論，我們不得繼續斷點排查下去。不過在斷點之前，我們去spring官網溜溜，看有沒有啥收穫。進官網我們可以看到有這麼一段話
這段話的意思是預設情況下，系統屬性優先於環境變數。 因此，如果在調用env.getProperty（“ my-property”）的過程中在兩個地方都同時設置了my-property屬性，則系統屬性值“ wins”並返回。 請註意，屬性值不會合併，而是會被前面的條目完全覆蓋。
看吧，官網它自己也這麼說
如果我們想要自定義的屬性優於系統屬性，要怎麼做
這段也是從官網截圖來的，其意思是整個機制是可配置的。 也許您具有要集成到此搜索中的自定義屬性源。 為此，實現並實例化您自己的PropertySource並將其添加到當前環境的PropertySources集中
ConfigurableApplicationContext ctx = new GenericApplicationContext();
MutablePropertySources sources = ctx.getEnvironment().getPropertySources();
sources.addFirst(new MyPropertySource());
這個是官方解法。
我這邊在提供2種解法。
- bean初始化之前，修改屬性文件載入順序
- 在bean初始化後，變更bean的屬性值
其實現代碼如下
ntBeanFactoryPostProcesser implements BeanFactoryPostProcessor, ApplicationContextAware, BeanPostProcessor {
private ApplicationContext applicationContext;
@Override
public Object postProcessAfterInitialization(Object bean, String beanName) throws BeansException {
//方法三：在bean初始化後，變更bean的屬性值
// if("user".equals(beanName)){
// User user = (User)bean;
// System.out.println("----------------before---------------------");
// System.out.println("user-->"+user);
// System.out.println("----------------after---------------------");
// String propertySourceName = "user.yml";
// PropertySource propertySource = getPropertySource(propertySourceName);
// if(!ObjectUtils.isEmpty(propertySource)){
// user.setName(String.valueOf(propertySource.getProperty("user.name")));
// }
// System.out.println("user-->"+user);
//
// }
return bean;
}
@Override
public void postProcessBeanFactory(ConfigurableListableBeanFactory configurableListableBeanFactory) throws BeansException {
printPropertySourceNames();
String propertySourceName = "user.yml";
PropertySource propertySource = getPropertySource(propertySourceName);
if(!ObjectUtils.isEmpty(propertySource)){
//方法一 bean初始化之前，修改屬性文件載入順序
getEnvironment().getPropertySources().remove(propertySourceName);
getEnvironment().getPropertySources().addFirst(propertySource);
}
// 方法二 新增一個PropertySource，並把他的載入順序置為第一位
// Map<String, Object> propertiesSource = new HashMap<>();
// propertiesSource.put("user.name", "張三");
// PropertySource newPropertySource = new MapPropertySource("newPropertySource", propertiesSource);
// getEnvironment().getPropertySources().addFirst(newPropertySource);
}
private PropertySource getPropertySource(String propertySourceName){
return getEnvironment().getPropertySources().get(propertySourceName);
}
private AbstractEnvironment getEnvironment(){
return (AbstractEnvironment)applicationContext.getEnvironment();
}
@Override
public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {
this.applicationContext = applicationContext;
}
private void printPropertySourceNames(){
getEnvironment().getPropertySources().stream().forEach(p-> System.out.println(p.getName()));
}
}
改完後，我們看下控制台此時輸出的內容為
User(name=張三, userId=1, [email protected])
總結
其實要想自定義文件屬性值不和系統變數的值產生衝突，最快捷的方法，就是讓自定義文件屬性的key和系統變數的key不一樣就好。能少寫代碼就儘量少寫
