springboot如何使用@ConfigurationProperties封裝配置文件

更新時(shí)間：2021年08月11日 10:26:20 作者：知識(shí)追求者

springboot如何使用@ConfigurationProperties封裝配置文件的操作，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方，望不吝賜教

使用@ConfigurationProperties封裝配置文件

業(yè)務(wù)場(chǎng)景：

把配置文件的信息，讀取并自動(dòng)封裝成實(shí)體類，可以使用@ConfigurationProperties，把同類的配置信息自動(dòng)封裝成實(shí)體類。

1、在pom.xml中添加依賴包

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

2、創(chuàng)建配置文件（application.properties）

wx.appid = wx111111
wx.redirectUri = https://www.baidu.com/
wx.templateId = 1
wx.first = 模板標(biāo)題
wx.remark = 模板備注
wx.color = #000000
sms.appid = 111111
sms.appkey = bd3bfba026f711eaac3b005056b84de4
sms.templateId = 1
sms.sign = Jeff

3、創(chuàng)建測(cè)試類1（WxSettings.java）

package com.jeff.config;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;
@Component
@ConfigurationProperties(prefix = "wx")
public class WxSettings {
	private String appid;
	private String redirectUri;
	private Integer templateId;
	private String first;
	private String remark;
	private String color;
	public String getAppid() {
		return appid;
	}
	public void setAppid(String appid) {
		this.appid = appid;
	}
	public String getRedirectUri() {
		return redirectUri;
	}
	public void setRedirectUri(String redirectUri) {
		this.redirectUri = redirectUri;
	}
	public Integer getTemplateId() {
		return templateId;
	}
	public void setTemplateId(Integer templateId) {
		this.templateId = templateId;
	}
	public String getFirst() {
		return first;
	}
	public void setFirst(String first) {
		this.first = first;
	}
	public String getRemark() {
		return remark;
	}
	public void setRemark(String remark) {
		this.remark = remark;
	}
	public String getColor() {
		return color;
	}
	public void setColor(String color) {
		this.color = color;
	}
	@Override
	public String toString() {
		return "WxSettings [appid=" + appid + ", redirectUri=" + redirectUri + ", templateId=" + templateId + ", first="
				+ first + ", remark=" + remark + ", color=" + color + "]";
	}
}

4、創(chuàng)建測(cè)試類2（SmsSettings.java）

package com.jeff.config;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;
@Component
@ConfigurationProperties(prefix = "sms")
public class SmsSettings {
	private String appid;
	private String appkey;
	private Integer templateId;
	private String sign;
	public String getAppid() {
		return appid;
	}
	public void setAppid(String appid) {
		this.appid = appid;
	}
	public String getAppkey() {
		return appkey;
	}
	public void setAppkey(String appkey) {
		this.appkey = appkey;
	}
	public Integer getTemplateId() {
		return templateId;
	}
	public void setTemplateId(Integer templateId) {
		this.templateId = templateId;
	}
	public String getSign() {
		return sign;
	}
	public void setSign(String sign) {
		this.sign = sign;
	}
	@Override
	public String toString() {
		return "SmsSettings [appid=" + appid + ", appkey=" + appkey + ", templateId=" + templateId + ", sign=" + sign
				+ "]";
	}
}

5、創(chuàng)建測(cè)試類（MyController.java）

package com.jeff.controller;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import com.jeff.config.SmsSettings;
import com.jeff.config.WxSettings;
@RestController
public class MyController {
	@Autowired
	private WxSettings wx;
	@Autowired
	private SmsSettings sms;
	@RequestMapping("myTest")
	public String myTest() {
		System.out.println(wx.toString());
		System.out.println(sms.toString());
		return "success";
	}
}