Spring高级注解@PropertySource详细解读

更新时间：2023年11月23日 09:40:17 作者：chaojunma

这篇文章主要介绍了Spring高级注解@PropertySource详细解读,@PropertySource注解用于指定资源文件读取的位置,它不仅能读取properties文件,也能读取xml文件,并且通过YAML解析器,配合自定义PropertySourceFactory实现解析yaml文件,需要的朋友可以参考下

Spring注解@PropertySource

@PropertySource注解用于指定资源文件读取的位置，它不仅能读取properties文件，也能读取xml文件，并且通过YAML解析器，配合自定义PropertySourceFactory实现解析yaml文件

读取properties文件

在resources资源目录下存在datasource-config.properties，要加载此文件中的配置，需要用到@PropertySource注解，具体如下：

datasource-config.properties文件

druid.driverClassName=com.mysql.jdbc.Driver
druid.url=jdbc:mysql://127.0.0.1/db1?useUnicode=true&amp;characterEncoding=UTF-8
druid.username=root
druid.password=123456

加载配置类

@Slf4j
@Setter
@Getter
@Configuration
@PropertySource(value = "classpath:datasource-config.properties")
@ConfigurationProperties(prefix = "druid")
public class SpringConfig {
 
    @Value("${druid.driverClassName}")
    private String driverClassName;
 
    @Value("${druid.url}")
    private String url;
 
    @Value("${druid.username}")
    private String username;
 
    @Value("${druid.password}")
    private String password;
 
 
    @Bean
    public void druidDataSource(){
        log.info("driverClassName:[{}], url:[{}], username:[{}], password:[{}]", driverClassName, url, username, password);
    }
}

读取xml文件

在resources资源目录下存在datasource-config.xml，要加载此文件中的配置，需要用到@PropertySource注解，具体如下：

加载配置类

@Slf4j
@Setter
@Getter
@Configuration
@PropertySource(value = "classpath:datasource-config.xml")
@ConfigurationProperties(prefix = "druid")
public class SpringConfig {
 
    @Value("${druid.driverClassName}")
    private String driverClassName;
 
    @Value("${druid.url}")
    private String url;
 
    @Value("${druid.username}")
    private String username;
 
    @Value("${druid.password}")
    private String password;
 
 
    @Bean
    public void druidDataSource(){
        log.info("driverClassName:[{}], url:[{}], username:[{}], password:[{}]", driverClassName, url, username, password);
    }
}

datasource-config.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&amp;characterEncoding=UTF-8</entry>
    <entry key="druid.username">root</entry>
    <entry key="druid.password">5201314..a</entry>
</properties>

读取yaml文件

如果想通过@PropertySorce注解加载yaml文件,需要配合自定义PropertySourceFactory实现。

添加依赖

<dependency>
    <groupId>org.yaml</groupId>
    <artifactId>snakeyaml</artifactId>
    <version>1.23</version>
</dependency>

自定义PropertySourceFactory

import org.springframework.beans.factory.config.YamlPropertiesFactoryBean;
import org.springframework.core.env.PropertiesPropertySource;
import org.springframework.core.env.PropertySource;
import org.springframework.core.io.support.EncodedResource;
import org.springframework.core.io.support.PropertySourceFactory;
import java.io.IOException;
import java.util.Properties;
 
public class YAMLPropertySourceFactory implements PropertySourceFactory {
 
    @Override
    public 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);
    }
}

datasource-config.yaml

druid:
  driverClassName: com.mysql.jdbc.Driver
  url: jdbc:mysql://127.0.0.1/db1?useUnicode=true&amp;characterEncoding=UTF-8
  username: root
  password: 123456

加载配置类

@Slf4j
@Setter
@Getter
@Configuration
@PropertySource(value = "classpath:datasource-config.yml", factory = YAMLPropertySourceFactory.class)
@ConfigurationProperties(prefix = "druid")
public class SpringConfig {
 
    @Value("${druid.driverClassName}")
    private String driverClassName;
 
    @Value("${druid.url}")
    private String url;
 
    @Value("${druid.username}")
    private String username;
 
    @Value("${druid.password}")
    private String password;
 
 
    @Bean
    public void druidDataSource(){
        log.info("driverClassName:[{}], url:[{}], username:[{}], password:[{}]", driverClassName, url, username, password);
    }
}

到此这篇关于Spring高级注解@PropertySource详细解读的文章就介绍到这了,更多相关Spring注解@PropertySource内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

Java中的几种读取properties配置文件的方式
这篇文章主要介绍了Java中的几种读取properties配置文件的方式，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧
2017-05-05
java.util.Date与java.sql.Date的区别
这篇文章主要介绍了java.util.Date与java.sql.Date的区别的相关资料,需要的朋友可以参考下
2015-07-07
spring cloud zuul 与 sentinel的结合使用操作
这篇文章主要介绍了spring cloud zuul 与 sentinel 的结合使用操作，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
2021-06-06
SpringBoot中web模版数据渲染展示的案例详解
凭借 Spring Framework 的模块、与你最喜欢的工具的大量集成以及插入你自己的功能的能力，Thymeleaf 是现代 HTML5 JVM Web 开发的理想选择——尽管它还有更多功能，本文重点给大家介绍SpringBoot中web模版数据渲染展示,需要的朋友可以参考下
2022-01-01
Springboot项目中运用vue+ElementUI+echarts前后端交互实现动态圆环图(推荐)
今天给大家带来一篇教程关于Springboot项目中运用vue+ElementUI+echarts前后端交互实现动态圆环图的技能，包括环境配置及圆环图前端后端实现代码，感兴趣的朋友一起看看吧
2021-06-06
浅谈Spring嵌套事务是怎么回滚的
本文主要介绍了Spring嵌套事务是怎么回滚的，文中通过示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2021-11-11
Java结构型设计模式之组合模式详解
组合模式，又叫部分整体模式，它创建了对象组的数据结构组合模式使得用户对单个对象和组合对象的访问具有一致性。本文将通过示例为大家详细介绍一下组合模式，需要的可以参考一下
2022-09-09
Java实现PDF转图片的三种方法
有些时候我们需要在项目中展示PDF,所以我们可以将PDF转为图片,然后已图片的方式展示,效果很好,Java使用各种技术将pdf转换成图片格式,并且内容不失帧,本文给大家介绍了三种方法实现PDF转图片的案例,需要的朋友可以参考下
2023-10-10
Spring实战之容器后处理器操作示例
这篇文章主要介绍了Spring实战之容器后处理器操作,结合实例形式分析了spring容器后处理器配置、使用操作技巧与相关注意事项,需要的朋友可以参考下
2019-12-12
史上最难的一道Java面试题
本文给大家分享一道史上最难的一道Java面试题，非常不错，具有参考借鉴价值，需要的朋友参考下吧
2018-03-03