SpringBoot读取配置文件的四种方式

心已赠人 2022-12-20 05:43 286阅读 0赞

# SpringBoot读取配置文件的四种方式 #

> 本文以读取druid数据库连接池为例，展示四种SpringBoot读取配置文件的实例。

> 首先你得有一个springboot项目，如果没有，请按下方式创建一个。
> 
> [InteliJ-Idea\_快速创建SpringBoot项目][InteliJ-Idea_SpringBoot]
> 
> 我这边以web方式进行演示，不必跟我一样也行。

> druid依赖

<dependency>
                <groupId>com.alibaba</groupId>
                <artifactId>druid</artifactId>
                <version>1.1.5</version>
            </dependency>

> HelloController

@RestController
    public class HelloController {
        
    
        
        @Autowired
        private DataSource dataSource;
    
        //通过在下面方法打断点，浏览器进行访问，查看上面DataSource是否拿到连接数据。
        @GetMapping("show")
        public String test(){
        
            return "hello Spring Boot!";
        }
    }

> 第一种方式，传统Spring的注解读取数据

在`Resources/`下创建jdbc.properties

jdbc.driverClassName=com.mysql.jdbc.Driver
    jdbc.url=jdbc:mysql://127.0.0.1:3306/test
    jdbc.username=root
    jdbc.password=123

创建JdbcConfiguration类用来将DataSource注入Spring容器

@Configuration
    @PropertySource("classpath:jdbc.properties")
    public class JdbcConfiguration {
        
    
        @Value("${jdbc.url}")
        String url;
        @Value("${jdbc.driverClassName}")
        String driverClassName;
        @Value("${jdbc.username}")
        String username;
        @Value("${jdbc.password}")
        String password;
    
        @Bean
        public DataSource dataSource() {
        
            DruidDataSource dataSource = new DruidDataSource();
            dataSource.setUrl(url);
            dataSource.setDriverClassName(driverClassName);
            dataSource.setUsername(username);
            dataSource.setPassword(password);
            return dataSource;
        }
    }

解读：

*  `@Configuration`：约定大于配置，声明`JdbcConfiguration`是一个配置类。
 *  `@PropertySource`：指定要属性文件的路径:`classpath:jdbc.properties`
 *  通过`@Value`为属性注入值。
 *  通过`@Bean`将 `dataSource()`方法声明为一个注册Bean的方法，Spring会自动调用该方法，将方法的返回值加入Spring容器中。相当于以前的bean标签

此步完成即可在任意位置通过`@Autowired`注入DataSource了。

启动引导类，浏览器访问8080（默认），即可通过断点模式查看是否成功。

> 第二种方式，SpringBoot提供的读取配置类方式

在SpringBoot中，提供了一种新的属性注入方式，支持各种java基本数据类型及复杂类型的注入。

在SpringBoot的配置文件`application.properties`中配置属性信息，此步替代了传统方式的自建xxx.properties

在SpringBoot模式下，你所要配置的属性都可在`application.properties`中进行配置

#端口配置
    server.port=8088
    
    #数据源配置
    jdbc.driverClassName=com.mysql.jdbc.Driver
    jdbc.url=jdbc:mysql://127.0.0.1:3306/test
    jdbc.username=root
    jdbc.password=123

新建`JdbcProperties.java`，它将代表属性的封装（属性读取类），有了它就有了属性的一切。

@ConfigurationProperties(prefix = "jdbc")
    public class JdbcProperties {
        
        private String url;
        private String driverClassName;
        private String username;
        private String password;
    
    // 必须提供set & get ！ 此处省略...
    }

*  在类上通过@ConfigurationProperties注解声明当前类为属性读取类
 *  `prefix="jdbc"`读取`application.properties`属性文件中，前缀为jdbc的值。
 *  在类上定义各个属性，名称必须与属性文件中`jdbc.`后面部分一致，**并且必须具有getter和setter方法**

此时你就可以在属性配置类JdbcConfiguration中通过注入JdbcProperties获取一切你想要的属性了！

@Configuration
    //此处加@EnableConfigurationProperties是为了让JdbcProperties
    //中的@ConfigurationProperties(prefix = "jdbc")生效！记得JdbcProperties类并没有任何将之注入Spring容器的注解？而此处又有@Configuration
    @EnableConfigurationProperties(JdbcProperties.class)
    public class JdbcConfiguration {
        
    
        @Autowired
        private JdbcProperties jdbcProperties;
        
        @Bean //将dataSource注入spring容器
        public DataSource dataSource() {
        
            DruidDataSource dataSource = new DruidDataSource();
            dataSource.setUrl(jdbcProperties.getUrl());
            dataSource.setDriverClassName(jdbcProperties.getDriverClassName());
            dataSource.setUsername(jdbcProperties.getUsername());
            dataSource.setPassword(jdbcProperties.getPassword());
            return dataSource;
        }
    }

SpringBoot方式属性注入的优越性：

Relaxed binding：松散绑定

*  不严格要求属性文件中的属性名与成员变量名一致。支持驼峰，中划线，下划线等等自动转换，甚至支持对象引导。比如：user.friend.name：代表的是user对象中的friend属性中的name属性，显然friend也是对象。@value注解就难以完成这样的注入方式。
 *  meta-data support：元数据支持，帮助IDE生成属性提示（写开源框架会用到）

> 第三种方式 更优雅的注入

事实上，如果某一段属性（jdbc.xxx）只有一个Bean（DataSource）需要使用，我们无需将其注入到一个类（JdbcProperties）中。而是直接在需要的地方声明即可：

在属性配置类`JdbcConfiguration`中

@Configuration
    public class JdbcConfiguration {
        
        
        @Bean
        // 声明要注入的属性前缀，SpringBoot会自动把相关属性通过set方法注入到DataSource中
        @ConfigurationProperties(prefix = "jdbc")
        public DataSource dataSource() {
        
            DruidDataSource dataSource = new DruidDataSource();
            return dataSource;
        }
    }

此时我们就省去了JdbcProperties这个类的注入，而是由SpringBoot自动去读取配置文件中的属性，为我们的bean进行set赋值！

[InteliJ-Idea_SpringBoot]: https://blog.csdn.net/JunSIrhl/article/details/105748590