Spring注解之@PropertySource详解
作者：我会努力变强的
这篇文章主要介绍了Spring注解之@PropertySource详解,@PropertySource注解用于指定资源文件读取的位置,它不仅能读取properties文件,也能读取xml文件,并且通过YAML解析器,配合自定义PropertySourceFactory实现解析YAML文件,需要的朋友可以参考下
@PropertySource注解
定义/作用
@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) context.getBean("druidDataSource");
//获取数据库连接
Connection connection = druidDataSource.getConnection();
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 "http://java.sun.com/dtd/properties.dtd">
<properties>
<entry key="druid.driverClassName">com.mysql.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 [propertysourcedemo.config.SpringConfig]; nested exception is java.io.FileNotFoundException: D:\spring-high-level-study\src\main\resources\daoconfig\datasource-config1.xml (系统找不到指定的文件。)
设置为true忽略时：
与不配置该注解时一个样。因为找不到指定资源文件后，spring也不知道去哪找资源文件了。
自定义PropertySourceFactory解析YAML文件：
PropertySourceFactory的默认实现DefaultPropertySourceFactory是解析不了yaml文件的，如果要解析，就要自定义实现。
我们就不自己解析Yaml，直接引用第三方jar包进行解析。
<dependency>
<groupId>org.yaml</groupId>
<artifactId>snakeyaml</artifactId>
<version>1.23</version>
</dependency>
代码：
/**
* @author YeHaocong
* @decription 自定义Yaml解析工厂
*/
public class YAMLPropertySourceFactory implements PropertySourceFactory {
@Override
public org.springframework.core.env.PropertySource<?> createPropertySource(String name, EncodedResource encodedResource) throws IOException {
//创建一个YAML解析工厂。
YamlPropertiesFactoryBean factory = new YamlPropertiesFactoryBean();
//设置资源。
factory.setResources(encodedResource.getResource());
//获取解析后的Properties对象
Properties properties = factory.getObject();
//返回。此时不能像默认工厂那样返回ResourcePropertySource对象 ，要返回他的父类PropertiesPropertySource对象。
return name != null ? new PropertiesPropertySource(name, properties) :
new PropertiesPropertySource(encodedResource.getResource().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;
}
}
结果：
到此这篇关于Spring注解之@PropertySource详解的文章就介绍到这了,更多相关@PropertySource详解内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！