Spring⾼级之注解@PropertySource的原理
⽬录
定义/作⽤
使⽤⽅式
spring4.3之前
spring4.3及之后
读取XML⽂件
⾃定义PropertySourceFactory解析YAML⽂件
定义/作⽤
@PropertySource注解⽤于指定资源⽂件读取的位置，它不仅能读取properties⽂件，也能读取xml⽂件，并且通过YAML解析器，配合⾃定义PropertySourceFactory实现解析YAML⽂件。
源码：
//只能作⽤在类上
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Repeatable(PropertySources.class)
public @interface PropertySource {
/**
* 指定资源名称，如果为空，就根据基础资源的描述⽣成。
*/
String name() default "";
/**
* 指定资源路径。
* 可以是 classpath:/xxx/xxxx
* 也可以是 file:/xxx/xxx/xx
*/
String[] value();
/**
* 是否忽略资源不存在的情况，如果不忽略，当资源不存在时就报错。默认不忽略。
* 此属性时spring4.0以后出现的。
*/
boolean ignoreResourceNotFound() default false;
/**
* 指定资源⽂件的编码格式。如果不指定就使⽤⽂件默认的。
* 此注解是spring4.3以后出现的。
*/
String encoding() default "";
/**
* 指定资源⼯⼚，如果不指定，就使⽤默认的资源⼯⼚。
*/
Class<? extends PropertySourceFactory> factory() default PropertySourceFactory.class;
}
使⽤⽅式
此注解在spring4.3之前与spring4.3及之后使⽤的⽅式不⼀样。
错误demo：
//配置类
@Configuration
@ComponentScan(basePackages = "propertysourcedemo")
public class SpringConfig {
//通过SPEL表达式注⼊属性
@Value("${druid.driverClassName}")
private String driverClassName;
@Value("${druid.url}")
private String url;
@Value("${druid.username}")
private String username;
@Value("${druid.password}")
private String password;
//注册Druid数据源连接池
@Bean
public DruidDataSource druidDataSource(){
System.out.println("driverClassName====> " + driverClassName);
System.out.println("url====> " + url);
System.out.println("username====> " + username);
System.out.println("username====> " + username);
DruidDataSource druidDataSource = new DruidDataSource();
druidDataSource.setDriverClassName(driverClassName);
druidDataSource.setUrl(url);
druidDataSource.setUsername(username);
druidDataSource.setPassword(password);
return druidDataSource;
}
}
//测试类
public class PropertySourceDemoTest {
private AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext(SpringConfig.class);
@Test
public void PropertySourceDemoTest() throws SQLException {
//从容器中获取数据源
DruidDataSource druidDataSource = (DruidDataSource) Bean("druidDataSource");
//获取数据库连接
Connection connection = Connection();
System.out.println(druidDataSource);
System.out.println(connection);
connection.close();
}
}
⽂件：
结果：
原因：
因为没有指定资源配置⽂件，所以spring不知道去哪配置⽂件进⾏属性注⼊，不到，然后SPEL表达式就把属性的key直接解析成字⾯量。spring4.3之前
spring4.3之前，除了使⽤@PropertySource注解之外，还要⼿动注册⼀个资源⽂件解析器PropertySourcesPlaceholderConfigurer到IOC容器中。并且如果使⽤Bean注解注册资源⽂件解析器，⽅法要是static⽅法。
@Configuration
@ComponentScan(basePackages = "propertysourcedemo")
@PropertySource(value = "classpath:daoconfig/datasource-config.properties")
public class SpringConfig {
//通过SPEL表达式注⼊属性
@Value("${druid.driverClassName}")
private String driverClassName;
@Value("${druid.url}")
private String url;
@Value("${druid.username}")
private String username;
@Value("${druid.password}")
private String password;
//创建资源⽂件解析器，spring4.3之前必须要的，不要就⽆法解析。
@Bean
public static PropertySourcesPlaceholderConfigurer propertySourcesPlaceholderConfigurer(){
return new PropertySourcesPlaceholderConfigurer();
}
//注册Druid数据源连接池
@Bean
public DruidDataSource druidDataSource(){
System.out.println("driverClassName====> " + driverClassName);
System.out.println("url====> " + url);
System.out.println("username====> " + username);
System.out.println("username====> " + username);
DruidDataSource druidDataSource = new DruidDataSource();
druidDataSource.setDriverClassName(driverClassName);
druidDataSource.setUrl(url);
druidDataSource.setUsername(username);
druidDataSource.setPassword(password);
return druidDataSource;
}
}
/
/测试类不变
结果：
如果把资源解析器去掉：
没有效果。
spring4.3及之后
4.3之后，就可以直接使⽤，因为spring会使⽤默认的DefaultPropertySourceFactory解析。
@Configuration
@ComponentScan(basePackages = "propertysourcedemo")
//这次使⽤file协议的url路径来解析
@PropertySource(value = "file:///D:/spring-high-level-study/src/main/resources/daoconfig/datasource-config.properties") public class SpringConfig {
//通过SPEL表达式注⼊属性
@Value("${druid.driverClassName}")
private String driverClassName;
@Value("${druid.url}")
private String url;
@Value("${druid.username}")
private String username;
@Value("${druid.password}")
private String password;
//注册Druid数据源连接池
@Bean
public DruidDataSource druidDataSource(){
System.out.println("driverClassName====> " + driverClassName);
System.out.println("url====> " + url);
System.out.println("username====> " + username);
System.out.println("username====> " + username);
DruidDataSource druidDataSource = new DruidDataSource();
druidDataSource.setDriverClassName(driverClassName);
druidDataSource.setUrl(url);
druidDataSource.setUsername(username);
druidDataSource.setPassword(password);
return druidDataSource;
}
}
结果：
读取XML⽂件
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE properties SYSTEM "java.sun/dtd/properties.dtd">
<properties>
<entry key="druid.driverClassName"&sql.jdbc.Driver</entry>
<entry key="druid.url">jdbc:mysql://127.0.0.1/db1?useUnicode=true&characterEncoding=UTF-8</entry>
<entry key="druid.username">root</entry>
<entry key="druid.password">5201314..a</entry>
</properties>
把配置类的@PropertySource注解路径修改成xml⽂件，也可以解析。
boolean ignoreResourceNotFound() default false;
当资源不存在时，是否忽略，默认不忽略，也就是会报错。
设置为false时：
org.springframework.beans.factory.BeanDefinitionStoreException: Failed to parse configuration class [fig.SpringConfig]; nested exception is java.io.FileNotFoundException: D:\spring-high-level-study\src\main\resources\l (系统不到指定的⽂件。)设置为true忽略时：
与不配置该注解时⼀个样。因为不到指定资源⽂件后，spring也不知道去哪资源⽂件了。
⾃定义PropertySourceFactory解析YAML⽂件
PropertySourceFactory的默认实现DefaultPropertySourceFactory是解析不了yaml⽂件的，如果要解析，就要⾃定义实现。
我们就不⾃⼰解析Yaml，直接引⽤第三⽅jar包进⾏解析。
<dependency>
<groupId>org.yaml</groupId>
<artifactId>snakeyaml</artifactId>
<version>1.23</version>
spring怎么读取properties</dependency>
代码：
/**
* @author YeHaocong
* @decription ⾃定义Yaml解析⼯⼚
*/
public class YAMLPropertySourceFactory implements PropertySourceFactory {
@Override
public nv.PropertySource<?> createPropertySource(String name, EncodedResource encodedResource) throws IOException {
//创建⼀个YAML解析⼯⼚。
YamlPropertiesFactoryBean factory = new YamlPropertiesFactoryBean();
//设置资源。
factory.Resource());
//获取解析后的Properties对象
Properties properties = Object();
//返回。此时不能像默认⼯⼚那样返回ResourcePropertySource对象，要返回他的⽗类PropertiesPropertySource对象。
return name != null ? new PropertiesPropertySource(name, properties) :
new Resource().getFilename(),properties);
}
}
//配置类：
@Configuration
@ComponentScan(basePackages = "propertysourcedemo")
//使⽤⾃定义⼯⼚。
@PropertySource(value = "classpath:daoconfig/datasource-config.yaml",factory = YAMLPropertySourceFactory.class)
public class SpringConfig {
//通过SPEL表达式注⼊属性
@Value("${druid.driverClassName}")
private String driverClassName;
@Value("${druid.url}")
private String url;
@Value("${druid.username}")
private String username;
@Value("${druid.password}")
private String password;
//注册Druid数据源连接池
@Bean
public DruidDataSource druidDataSource(){
System.out.println("driverClassName====> " + driverClassName);
System.out.println("url====> " + url);
System.out.println("username====> " + username);
System.out.println("password====> " + password);
DruidDataSource druidDataSource = new DruidDataSource();
druidDataSource.setDriverClassName(driverClassName);
druidDataSource.setUrl(url);
druidDataSource.setUsername(username);
druidDataSource.setPassword(password);
return druidDataSource;
}
}
结果：
以上为个⼈经验，希望能给⼤家⼀个参考，也希望⼤家多多⽀持。
版权声明：本站内容均来自互联网，仅供演示用，请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198，我们将在24小时内删除。
发表评论