springboot读取配置文件

当我们使用spring 初始化器构建完一个Spring Boot项目后,只需引入一个web启动器的依赖,它就变成一个web项目了,而且呢我们什么都没有配置就能通过localhost:8080进行访问了,那这是为什么呢?
那是因为Spring Boot在底层已经把配置信息都给我们自动配置好了。那我们怎么去修改默认配置信息?在使用Spring 初始化器创建一个Springboot项目的时候会在resources目录下自动生成一个文件 application.properties,这是一个空文件,它的作用是提供我们修改默认配置信息的入口。

配置端口号
以前是这样配置的


  8080

现在是这样配置的

server:
 port: 8080

简单的数据类型读取-@Value

在配置文件加上配置信息
创建一个Person实体类用来验证@Value 读取配置文件属性是否成功
创建一个PersonConfig 配置类读取属性
把属性set到Person注入到容器
单元测试拿到person实例打印它

修改默认配置文件

application.yml

person:
 userName: zhangsan
 age: 29
 salary: 220000
 sex: male

属性注入类

创建 Person javabean

public class Person {
    private String userName;
    private int age;
    private double salary;
    private String sex;
    public String getUserName() {
        return userName;
   }
    public void setUserName(String userName) {
        this.userName = userName;
   }
    public int getAge() {
        return age;
   }
    public void setAge(int age) {
        this.age = age;
   }
    public double getSalary() {
        return salary;
   }
    public void setSalary(double salary) {
        this.salary = salary;
   }
    public String getSex() {
        return sex;
   }
    public void setSex(String sex) {
        this.sex = sex;
   }
    @Override
    public String toString() {
        return "Person{" +
                "userName='" + userName + '\'' +
                ", age=" + age +
                ", salary=" + salary +
                ", sex='" + sex + '\'' +
                '}';
   }
}

声明配置类

创建 PersonConfig 配置类

@Configuration
public class PersonConfig {
    @Value("${person.userName}")
    private String userName;
    @Value("${person.age}")
    private int age;
    @Value("${person.salary}")
    private double salary;
    @Value("${person.sex}")
    private String sex;
    @Bean
    public Person getPerson(){
        Person person=new Person();
        person.setSex(sex);
        person.setAge(age);
        person.setUserName(userName);
        person.setSalary(salary);
        return person;
   }
}

单元测试

创建 SpringBootDemoApplicationTests Junit 单元测试

@RunWith(SpringRunner.class)
@SpringBootTest
public class SpringUtilDemoApplicationTests {
    @Autowired
    private Person person;
    @Test
    void contextLoads() {
   }
    @Test
    public void testPerson(){
        System.out.println(person.toString());
   }
}

解读
@Configuration :声明我们PersonConfig 是一个配置类
通过@Value 为属性注入值
通过@Bean Spring会自动调用该方法,将方法的返回值加入Spring容器中。




复杂的配置文件读取- @ConfigurationProperties

配置文件配置复杂的内容
创建映射实体
屏蔽PersonConfig 配置类的代码
修改 Person 实体类
打印person实体

修改配置文件置

application.yml

person:
 userName: zhangsan
 age: 29
 salary: 220000
 sex: male
 pets: cat,dog
 friend:
   userName: wangwu
   age: 27
 list:
   - value1
   - value2
 children:
   - name: ting
     weight: 2
   - name: hao
     weight: 5
 employee:
   name: lisi
   age: 21

注释 PersonConifg
创建 Employee

public class Employee {
    private String name;
    private String age;
    public String getName() {
        return name;
   }
    public void setName(String name) {
        this.name = name;
   }
    public String getAge() {
        return age;
   }
    public void setAge(String age) {
        this.age = age;
   }
    @Override
    public String toString() {
        return "Employee{" +
                "name='" + name + '\'' +
                ", age='" + age + '\'' +
                '}';
   }
}

修改 peson

@ConfigurationProperties(prefix = "person")
@Component
public class Person {
   private String userName;
   private int age;
   private double salary;
   private String sex;
   //array
   private String[] pets;
   //map
   private Map friend;
   //list
   private List list;
   //list嵌套对象或者map
   private List> children;
   //对象嵌套对象
   private Employee employee;
   public String getUserName() {
       return userName;
   }
   public void setUserName(String userName) {
       this.userName = userName;
   }
   public int getAge() {
       return age;
   }
   public void setAge(int age) {
       this.age = age;
   }
   public double getSalary() {
       return salary;
   }
   public void setSalary(double salary) {
       this.salary = salary;
   }
   public String getSex() {
       return sex;
   }
   public void setSex(String sex) {
       this.sex = sex;
   }
   public String[] getPets() {
       return pets;
   }
   public void setPets(String[] pets) {
       this.pets = pets;
   }
   public Map getFriend() {
       return friend;
   }
   public void setFriend(Map friend) {
       this.friend = friend;
   }
   public List getList() {
       return list;
   }
   public void setList(List list) {
       this.list = list;
   }
   public List> getChildren() {
       return children;
   }
   public void setChildren(List> children) {
       this.children = children;
   }
   public Employee getEmployee() {
       return employee;
   }
   public void setEmployee(Employee employee) {
       this.employee = employee;
   }
   @Override
   public String toString() {
       return "Person{" +
               "userName='" + userName + '\'' +
               ", age=" + age +
               ", salary=" + salary +
               ", sex='" + sex + '\'' +
               ", pets=" + Arrays.toString(pets) +
               ", friend=" + friend +
               ", list=" + list +
               ", children=" + children +
               ", employee=" + employee +
               '}';
   }
}

解读
@ConfigurationProperties 注解向Spring Boot声明该类中的所有属性和配置文件中相关的配置进行绑定。
prefix = "person":声明配置前戳,将该前戳下的所有属性进行映射。
@Component 将该组件加入Spring Boot容器,只有这个组件是容器中的组件,配置才生效。




静态工具类读取配置文件

在日常开发中经常会遇到这种情况,就是有一些方法经常用到但是呢又需要外部的一些静态常量(各个环境的值是不一样的)进行组装,所以呢我们会把这些方法抽出来统一放在一个工具类里面,大家也知道通常来说工具类里面都是一些静态的方法,后续在其它地方使用的时候直接工具类.方法就可以了。但是呢我们的方法改成静态方法后,里面用到的变量也同样要改成静态的变量,这里就涉及到了静态属性的注入问题了,如果我们还像上节课那样用 @Value 直接注入是注入不进来的。那么我们改怎么去改造呢?怎么才能把它注入到静态的变量呢?

加入配置文件信息
新增一个配置读取类:TokenSettings
新增静态工具类:JwtTokenUtil
创建一个代理工具类:StaticInitializerUtil
单元测试

配置文件信息

application.yml

#JWT 密钥
jwt:
  secretKey: xxxxxfdsfxxx
  issuer: yingxue.com

新增一个配置读取类 TokenSettings

@Configuration
@ConfigurationProperties(prefix = "jwt")
@Data
public class TokenSettings {
    private String secretKey;
    private String  issuer; 
}

创建一个 JwtTokenUtil

public class JwtTokenUtil {
    private static String secretKey;
    private static String  issuer;
    public static void setTokenSettings(TokenSettings tokenSettings){
        secretKey=tokenSettings.getSecretKey();
        issuer=tokenSettings.getIssuer();
   }
     public static String getSecretKey(){
        return secretKey;
   }
     public static String getIssuer(){
        return issuer;
   }
}

创建一个代理类 StaticInitializerUtil

@Component
public class StaticInitializerUtil {
   private TokenSettings tokenSettings;
    public StaticnitializerUtil(TokenSettingstokenSettings) {
         JwtTokenUtil.setTokenSettings(tokenSettings);
    }
}

单元测试

    @Test
    public void testStaticUtil(){
        System.out.println("secretKey="+JwtTokenUtil.getSecretKey());
        System.out.println("issuer="+JwtTokenUtil.getIssuer());
    }

你可能感兴趣的:(springboot读取配置文件)