SpringBoot @ConfigurationProperties参数绑定详解-白红宇

SpringBoot @ConfigurationProperties参数绑定详解

阅读量：2393 次

发布时间：2019-05-10

本文共 3256 字，大约阅读时间需要 10 分钟。

1> 引入 spring-boot-configuration-processor 库

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-configuration-processor</artifactId>
    <optional>true</optional>
</dependency>

2> 在 application.yml 中要获取的数据

myprops: # 自定义的属性和值
  simple-prop: simplePropValue
  array-props: 1,2,3,4,5
  list-prop1:
    - name: abc
      value: abcValue
    - name: efg
      value: efgValue
  list-prop2:
    - config2Value1
    - config2Vavlue2
  map-props:
    key1: value1
    key2: value2

注 : 1> 注意命名规则，根节点不能采用驼峰命名法，否则将会导致识别失败这是在 2.0.1.RELEASE 出现的问题，最好全部小写，剩余的其他字段可以采用驼峰命名法，可以使用 - 方式来修改

2> 注意查看日志中的提示信息

3> 使用 @ConfigurationProperties 将数据绑定到对象上有两种方式

方式1> 在方法上引入 @ConfigurationProperties 注解

public class MyProps { 
    private String simpleProp;
    private String[] arrayProps;
    /** 接收prop1里面的属性值 */
    private List<Map<String, String>> listProp1 = new ArrayList<>();
    /** 接收prop2里面的属性值 */
    private List<String> listProp2 = new ArrayList<>();
    /** 接收prop1里面的属性值 */
    private Map<String, String> mapProps = new HashMap<>();
    public String getSimpleProp() { 
        return simpleProp;
    }
    /**
     * String类型的一定需要setter来接收属性值；maps, collections, 和 arrays 不需要
     * @param simpleProp
     */
    public void setSimpleProp(String simpleProp) { 
        this.simpleProp = simpleProp;
    }
    public String[] getArrayProps() { 
        return arrayProps;
    }
    public void setArrayProps(String[] arrayProps) { 
        this.arrayProps = arrayProps;
    }
    public List<Map<String, String>> getListProp1() { 
        return listProp1;
    }
    public void setListProp1(List<Map<String, String>> listProp1) { 
        this.listProp1 = listProp1;
    }
    public List<String> getListProp2() { 
        return listProp2;
    }
    public void setListProp2(List<String> listProp2) { 
        this.listProp2 = listProp2;
    }
    public Map<String, String> getMapProps() { 
        return mapProps;
    }
    public void setMapProps(Map<String, String> mapProps) { 
        this.mapProps = mapProps;
    }
}
# 使用在方法上
@Bean
@ConfigurationProperties(prefix = "myprops")
public MyProps myProps() { 
    return new MyProps();
}

方式2> 在类上使用 @ConfigurationProperties 注解

@Component
@ConfigurationProperties(prefix = "myprops")
public class MyProps { 
    private String simpleProp;
    private String[] arrayProps;
    /** 接收prop1里面的属性值 */
    private List<Map<String, String>> listProp1 = new ArrayList<>();
    /** 接收prop2里面的属性值 */
    private List<String> listProp2 = new ArrayList<>();
    /** 接收prop1里面的属性值 */
    private Map<String, String> mapProps = new HashMap<>();
    public String getSimpleProp() { 
        return simpleProp;
    }
   
/**
    * String类型的一定需要setter来接收属性值；maps, collections, 和 arrays 不需要
    *
    * @param simpleProp
    */
    public void setSimpleProp(String simpleProp) { 
        this.simpleProp = simpleProp;
    }
    public String[] getArrayProps() { 
        return arrayProps;
    }
    public void setArrayProps(String[] arrayProps) { 
        this.arrayProps = arrayProps;
    }
    public List<Map<String, String>> getListProp1() { 
        return listProp1;
    }
    public void setListProp1(List<Map<String, String>> listProp1) { 
        this.listProp1 = listProp1;
    }
    public List<String> getListProp2() { 
        return listProp2;
    }
    public void setListProp2(List<String> listProp2) { 
        this.listProp2 = listProp2;
    }
    public Map<String, String> getMapProps() { 
        return mapProps;
    }
    public void setMapProps(Map<String, String> mapProps) { 
        this.mapProps = mapProps;
    }
}

以上两种方法，任意一种均可，之后就可以直接使用

@Autowired
private MyProps myProps;

@Test
public void propsTest() { 
    System.out.println("simpleProp: " + myProps.getSimpleProp());
}

转载地址：http://zogab.baihongyu.com/

你可能感兴趣的文章

Java8新特性学习（一）- 开篇介绍

查看>>

Java8新特性学习（二）- Optional类

查看>>

Java8新特性学习（三）- Stream类

查看>>

ForkJoin框架使用和原理剖析

查看>>

比AtomicLong更高效的并发计数类LongAdder

查看>>

设计模式-观察者模式

查看>>

CacheLoader returned null for key分析和解决

实测win8下安装使用QT4.8+qt creator2.8.0

Warning: no newline at end of file .（转）

查看>>

verilog里的timescale以及国际单位制前缀

查看>>

区分RISC，CISC，Harvard architecture，Von_Neumann_architecture