聊聊@value注解和@ConfigurationProperties注解的使用

更新時(shí)間：2021年09月16日 14:34:21 作者：qq_29914229

這篇文章主要介紹了@value注解和@ConfigurationProperties注解的使用，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方，望不吝賜教

@value注解和@ConfigurationProperties注解

@value讀取默認(rèn)配置

yml文件內(nèi)容如下（裝了STS插件以后即可直接使用，改后綴就行了）

user:
  username: xiongda
  sex: man
  age: 20
school:
  name: xtu
  location: hunan

備注：一定要注意之間要留空格，發(fā)現(xiàn)顏色變綠色了才是正確的格式，這個(gè)坑我剛踩

package com.example.demo.service.impl; 
import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Service; 
import com.example.demo.service.ReadConfigService; 
@Service
public class ReadConfigServiceImpl implements ReadConfigService {    
    @Value(value="${user.username}")
    private String username;
    
    @Value(value="${user.sex}")
    private String sex;
    
    @Value(value="${user.age}")
    private String age;
    
    @Value(value="${school.name}")
    private String name;
    
    @Value(value="${school.location}")
    private String location;
    
    @Override
    public String getUserMessage() {
        return "user ="+username+" sex ="+sex+" age="+age;
    }
 
    @Override
    public String getAuthorMessage() {
        return "schoolname="+name+"location="+location;
    }    
}

@ConfigurationProperties讀取默認(rèn)配置

package com.example.demo.config; 
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component; 
@Component
@ConfigurationProperties(prefix="user")
public class HelloConfig {
    private String username;    
    private String sex;    
    private String age; 
    public String getUsername() {
        return username;
    }
 
    public void setUsername(String username) {
        this.username = username;
    }
 
    public String getSex() {
        return sex;
    }
 
    public void setSex(String sex) {
        this.sex = sex;
    }
 
    public String getAge() {
        return age;
    }
 
    public void setAge(String age) {
        this.age = age;
    }    
}

調(diào)用的controller層

package com.example.demo.web; 
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController; 
import com.example.demo.config.HelloConfig;
import com.example.demo.service.ReadConfigService;
 
@RestController
@RequestMapping("hello")
public class HelloController {
    
    @Autowired
    ReadConfigService readConfigService;
    
    @Autowired
    HelloConfig helloConfig;
    
    @RequestMapping("/user")
    public String say() {
       return "username "+helloConfig.getUsername()+" sex "+helloConfig.getSex()+" age "+helloConfig.getAge();
    }
    
    @RequestMapping("/school")
    public String school() {
       return readConfigService.getAuthorMessage();
    }
}

@ConfigurationProperties和@Value使用上的一點(diǎn)區(qū)別

@ConfigurationProperties和@Value的一個(gè)共同點(diǎn)就是從配置文件中讀取配置項(xiàng)。

發(fā)現(xiàn)有一點(diǎn)區(qū)別，我項(xiàng)目配置中并沒(méi)有配置hello.msg ，當(dāng)使用第一段代碼時(shí)，啟動(dòng)后讀取到msg為null，而第二段代碼則會(huì)拋出異常。

第二段代碼有個(gè)好處，就是防止我們配置項(xiàng)遺漏，當(dāng)遺漏時(shí)，啟動(dòng)程序肯定出錯(cuò)，這樣避免了一些因?yàn)檫z漏配置項(xiàng)導(dǎo)致的BUG.

第一段代碼

import org.springframework.boot.context.properties.ConfigurationProperties;
@ConfigurationProperties("hello")
public class HelloProperties {
    private String msg;
    public String getMsg() {
        return msg;
    }
    public void setMsg(String msg) {
        this.msg = msg;
    }
}

第二段代碼

import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;
@Component
public class Hello2Properties {
    @Value("${hello.msg}")
    private String msg;
    public String getMsg() {
        return msg;
    }
    public void setMsg(String msg) {
        this.msg = msg;
    }
}

以上為個(gè)人經(jīng)驗(yàn)，希望能給大家一個(gè)參考，也希望大家多多支持腳本之家。

您可能感興趣的文章: