Springboot@PropertySource自定义配置文件的三种方法

demo的结构

配置结构
这样是为了引出配置bean的3种方法

1. 单一bean上加@Component直接注入
2. 一个核心配置类@Configuration + @Bean
3. 一个核心配置类@Configuration+一个非核心配置类+@Bean

自定义配置文件properties

可以是properties后缀，也可以是yml后缀，都可以解析

@PropertySource参数解析

• value = “classpath:users.properties” —— classpath:后跟resource路径下的全名
• ignoreResourceNotFound = false —— 开发中一般都是false，找不到资源会报错提醒
• encoding = “UTF-8” —— 解决中文乱码问题(同时可能需要设置idea的编码格式)

注意导入lombok包可能产生的问题

@Value Cannot find method ‘value‘(lombok冲突)

一：直接使用@Component+@PropertySource

导包，一定要加上springframework下的Value包，不然@Value会出问题

import lombok.Data;
import org.springframework.beans.factory.annotation.Value;

直接读取后注入

@Data//get set方法
@Component
@PropertySource(value = "classpath:users.properties",
        ignoreResourceNotFound = false,
		encoding = "UTF-8")
//@ConfigurationProperties(prefix = "user1.")
public class Managers {

    @Value("${user1.name}")
    private String name;
    @Value("${user1.sex}")
    private String sex;
    @Value("${user1.age}")
    private int age;
}

使用@ConfigurationProperties(prefix = “user1”)

使用了这个前缀绑定注解，就不能再使用spel表达式了

@Data//get set方法
@Component
@PropertySource(value = "classpath:users.properties",
        ignoreResourceNotFound = false,
encoding = "UTF-8")
@ConfigurationProperties(prefix = "user1")
public class Managers {

    private String name;
    private String sex;
    private int age;
}

测试

• 直接由Spring容器来getBean

• 本次测试没有使用id来getBean，而是直接通过字节码文件

    ConfigurableApplicationContext run = SpringApplication.run(BootAjaxtestApplication.class, args);
    
    System.out.println(run.getBean(Managers.class).getName());
    System.out.println(run.getBean(Managers.class).getAge());
  

二：使用一层配置类(解耦bean)

• bean层的Managers类是一个不带额外功能的javaBean
• BeanConfig类要@Configuration+@PropertySource+@Value+@Bean

JavaBean不进行注册

@Data//get set方法
public class Managers {

    private String name;
    private String sex;
    private int age;
}

BeanConfig类中完成绑定

@Configuration
@PropertySource(value = "classpath:users.properties",
        ignoreResourceNotFound = false,
        encoding = "UTF-8")
public class BeanConfig {

    @Value("${user1.name}")
    private String name;
    @Value("${user1.sex}")
    private String sex;
    @Value("${user1.age}")
    private int age;


    @Bean("user1")
    @Scope("singleton")
    public Managers getManager(){
        Managers managers = new Managers();
        managers.setAge(age);
        managers.setName(name);
        managers.setSex(sex);

        return managers;
    }
}

测试

		ConfigurableApplicationContext run = SpringApplication.run(BootAjaxtestApplication.class, args);
//因为bean已经在容器中了，所以这样getBean始终成立
		System.out.println(run.getBean(Managers.class).getName());
		System.out.println(run.getBean(Managers.class).getAge());
//获取 Spring上下文(该配置类容器)，从中getBean
		AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(BeanConfig.class);
		Managers user1 = ac.getBean("user1", Managers.class);
		System.out.println(user1.getName());
		System.out.println(user1.getAge());

三：使用两层配置类(解耦配置与绑定)

• BeanConfig是非核心配置类，不加@Configuration
• AllBeansConfig是核心配置类，要加@Configuration
• 配置@Value在非核心配置类中；而绑定配置文件@PropertySource在核心配置类中

JavaBean不进行注册

@Data//get set方法
public class Managers {

    private String name;
    private String sex;
    private int age;
}

BeanConfig非核心配置类：属性绑定

public class BeanConfig {

    @Value("${user1.name}")
    private String name;
    @Value("${user1.sex}")
    private String sex;
    @Value("${user1.age}")
    private int age;


    @Bean("user1")
    @Scope("singleton")
    public Managers getManager(){
        Managers managers = new Managers();
        managers.setAge(age);
        managers.setName(name);
        managers.setSex(sex);

        return managers;
    }
}

AllBeanConfig核心配置类：文件绑定

• 不光要绑定@PropertyResource
• 还要@Import({非核心配置类.class})

绑定文件+导入非核心配置类：

@Configuration
@Import(BeanConfig.class)
@PropertySource(value = "classpath:users.properties",
        ignoreResourceNotFound = false,
        encoding = "UTF-8")
public class AllBeansConfig {
}

测试

//获取 Spring上下文(该配置类容器)，从中getBean
		AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(AllBeansConfig.class);
		Managers user1 = ac.getBean("user1", Managers.class);
		System.out.println(user1.getName());
		System.out.println(user1.getAge());

@PropertySources和@PropertySource

@PropertySources注解表示：可以在该配置类中绑定多个配置文件，同时这也说明了为什么可以用两层or三层配置类来配置Bean：

每层配置都像一个集合，大集合包括小集合，在配置信息繁多的情况下可读性更强

补：@Value+spel表达式的两种方式

1.分开写

@Value("${user1.name}")
private String name;
@Value("${user1.sex}")
private String sex;
@Value("${user1.age}")
private int age;

2.形参中耦合

补：AnnotationConfigApplicationContext获得容器

Spring的配置由基于XML，逐渐演变为基于注解，常用的应用程序上下文也由ClassPathXmlApplicationContext转为AnnotationConfigApplicationContext但基本流程都是一样的。

• 一个应用上下文就是一个容器，每个容器有各自的Bean，但他们都能直接被Spring的容器直接获取
• @Configuration注解正是代替的xml配置中的<Beans>标签，因此每个@Configuration配置类都是一个容器

总结

• @PropertySource有4个参数value、 ignoreResourceNotFound 、encoding、name
• 1.在Bean类中直接 配置+注入，解耦了数据写死的情况
• 2.用@Configuration+@Bean配置，可以在一个配置类中注入多个同类型的Bean
• 3.非核心配置类+核心配置类，可以归类某几种类型相似的Bean
• @ConfigurationProperties(prefix = “user1”)使用后自动匹配属性，不能写spel表达式
• @PropertySource总是在最外层，@PropertySources多配置注解，解释了为何可以进行配置类分层