springboot的多种属性注入方式

一、使用@PropertySource和@Value（Spring的注解）

jdbc.properties

jdbc.driver=com.mysql.cj.jdbc.Driver
jdbc.url=jdbc:mysql://localhost:3306/springboot?characterEncoding=UTF-8&useSSL=false&allowPublicKeyRetrieval=true&serverTimezone=UTC
jdbc.username=root
jdbc.password=123456

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

解读：

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

然后就可以在任意位置通过@Autowired注入DataSource了！

二、使用@ConfigurationProperties（SpringBoot的注解）

1、@ConfigurationProperties @Configuration + @EnableConfigurationProperties(JdbcProperties.class) 可以从IOC容器中获取配置对象
2、@ConfigurationProperties + @Conponent 也可以从IOC容器获取配置对象

1）使用@Value只能注入基本数据类型的数据，而@ConfigurationProperties既可以注入基本数据类型，也可以注入复杂类型数据。

@Configuration
@ConfigurationProperties(prefix = "jdbc")
public class JdbcProperties {

    private String driver;
    private String url;
    private String username;
    private String password;
	//getter and setter
}

• 在类上通过@ConfigurationProperties注解声明当前类为属性读取类
• prefix="jdbc"读取属性文件中，前缀为jdbc的值。
• 在类上定义各个属性，名称必须与属性文件中jdbc.后面部分一致，并且必须具有getter和setter方法
• 需要注意的是，这里我们并没有指定属性文件的地址，SpringBoot默认会读取文件名为application.properties的资源文件，所以我们把jdbc.properties名称改为application.properties

2）在JdbcConfiguration中使用这个属性：

• 通过@EnableConfigurationProperties(JdbcProperties.class)来声明要使用JdbcProperties这个类的对象
• 然后你可以通过以下方式在JdbcConfiguration类中注入JdbcProperties：
  1. @Autowired注入

@Configuration
@EnableConfigurationProperties(JdbcProperties.class)
public class JdbcConfiguration {

    @Autowired
    private JdbcProperties jdbcProperties;

    @Bean
    public DataSource dataSource(){
        DruidDataSource druidDataSource = new DruidDataSource();
        druidDataSource.setDriverClassName(jdbcProperties.getDriver());
        druidDataSource.setUrl(jdbcProperties.getUrl());
        druidDataSource.setUsername(jdbcProperties.getUsername());
        druidDataSource.setPassword(jdbcProperties.getPassword());
        return druidDataSource;
    }
}

以上两种注入方式的区别：

优势：

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

二.1@ConfigurationProperties还可以用在方法上。

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

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

我们直接把@ConfigurationProperties(prefix = “jdbc”)声明在需要使用的@Bean的方法上，然后SpringBoot就会自动调用这个Bean（此处是DataSource）的set方法，然后完成注入。使用的前提是：该类必须有对应属性的set方法！