Spring Boot 之注解@Component @ConfigurationProperties(prefix = "sms") 使用@ConfigurationProperties读取yml配置

从spring-boot开始，已经支持yml文件形式的配置，@ConfigurationProperties的大致作用就是通过它可以把properties或者yml配置直接转成对象

@Component注解表明是组件，可被自动发现，@ConfigurationProperties注解之前是location属性表明配置文件位置，prefix表示读取的配置信息的前缀，但新版本中废除了location属性（网上说是1.5.2之后），故只写前缀，默认读取application.yml中数据。重点！！一定要在这个类中写getter和setter，否则配置中的属性值无法自动注入

例如：

配置文件:
sms.url=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
sms.appkey=XXXXXXXXXXXXXXXXXXXXXXXXXXXXX
sms.secret=XXXXXXXXXXXXXXXXXXXXXXXXXXXXX
sms.signName=XXXXXXXXXXXXXXXXXXXXXXXXXXX
sms.tplCode=XXXXXXXXXXXXXXXXXXXXXXXXXXXX
sms.type=normal

JAVA代码：
@Component
@ConfigurationProperties(prefix = "sms")
public class SmsSettings {
    
    private  String url ="";
    private  String appkey ="";
    private  String secret ="";
    private  String signName ="";
    private  String tplCode ="";
    private  String type ="";
    private  String open ="";
    private  String tplCode2 ="";
    
    public String getUrl() {
        return url;
    }
    public void setUrl(String url) {
        this.url = url;
    }
    public String getAppkey() {
        return appkey;
    }
    public void setAppkey(String appkey) {
        this.appkey = appkey;
    }
    public String getSecret() {
        return secret;
    }
    public void setSecret(String secret) {
        this.secret = secret;
    }
    public String getSignName() {
        return signName;
    }
    public void setSignName(String signName) {
        this.signName = signName;
    }
    public String getTplCode() {
        return tplCode;
    }
    public void setTplCode(String tplCode) {
        this.tplCode = tplCode;
    }
    public String getType() {
        return type;
    }
    public void setType(String type) {
        this.type = type;
    }
    public String getOpen() {
        return open;
    }
    public void setOpen(String open) {
        this.open = open;
    }
    public String getTplCode2() {
        return tplCode2;
    }
    public void setTplCode2(String tplCode2) {
        this.tplCode2 = tplCode2;
    }
    
}

通过注解@ConfigurationProperties来配置redis

@Configuration    
@EnableAutoConfiguration  
public class RedisConfig {  
      
    @Bean    
    @ConfigurationProperties(prefix="spring.redis.poolConfig")    
    public JedisPoolConfig getRedisConfig(){    
        JedisPoolConfig config = new JedisPoolConfig();  
        return config;    
    }    
        
    @Bean    
    @ConfigurationProperties(prefix="spring.redis")    
    public JedisConnectionFactory getConnectionFactory(){    
        JedisConnectionFactory factory = new JedisConnectionFactory();    
        factory.setUsePool(true);  
        JedisPoolConfig config = getRedisConfig();    
        factory.setPoolConfig(config);    
        return factory;    
    }    
        
        
    @Bean    
    public RedisTemplate<?, ?> getRedisTemplate(){    
        RedisTemplate<?,?> template = new StringRedisTemplate(getConnectionFactory());    
        return template;    
    }    
      
}

1.添加pom依赖

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

2.application.yml文件中添加需要配置的属性，注意缩进

Myyml:
  username: cs
  password: 123456
  url: jdbc:mysql://localhost:3306/test
  driver: com.mysql.jdbc.Driver

3.新建一个类，@Component注解表明是组件，可被自动发现，@ConfigurationProperties注解之前是location属性表明配置文件位置，prefix表示读取的配置信息的前缀，但新版本中废除了location属性（网上说是1.5.2之后），故只写前缀，默认读取application.yml中数据。重点！！一定要在这个类中写getter和setter，否则配置中的属性值无法自动注入

package com.cs.background.util;
 
 
import lombok.ToString;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.PropertySource;
import org.springframework.stereotype.Component;
 
 
@Component
@ConfigurationProperties(prefix = "Myyml")
public class User{
    //数据库连接相关
    private String url;
    private String driver;
    private String username;
    private String password;
 
    public String getUrl() {
        return url;
    }
 
    public void setUrl(String url) {
        this.url = url;
    }
 
    public String getDriver() {
        return driver;
    }
 
    public void setDriver(String driver) {
        this.driver = driver;
    }
 
    public String getUsername() {
        return username;
    }
 
    public void setUsername(String username) {
        this.username = username;
    }
 
    public String getPassword() {
        return password;
    }
 
    public void setPassword(String password) {
        this.password = password;
    }
}

4.Controller类中执行自动注入，获取属性

//自动注入   
@Autowired
private User user;<br>
//方法体内获取属性值
String url=user.getUrl();<br>System.out.print(url);

5.启动springboot入口类，调用对应controller对应的方法，控制台打印获取的值。

posted @ 2019-04-17 09:42 panchanggui 阅读(4615) 评论(0) 收藏举报

刷新页面返回顶部

panchanggui

Spring Boot 之注解@Component @ConfigurationProperties(prefix = "sms") 使用@ConfigurationProperties读取yml配置

公告