快捷導(dǎo)航

基于springboot+enum配置化的方法

更新時(shí)間：2024年09月18日 16:17:52 作者：一葉飛舟

本文主要介紹利用Springboot結(jié)合枚舉類(lèi)enum進(jìn)行自定義參數(shù)的初始化和應(yīng)用,通過(guò)@Value注解實(shí)現(xiàn)參數(shù)的動(dòng)態(tài)注入,以實(shí)現(xiàn)靈活可維護(hù)的配置管理,具有一定的參考價(jià)值,感興趣的可以了解一下

前言

Springboot/Springcloud作為微服務(wù)開(kāi)發(fā)的經(jīng)典框架，我想任何一個(gè)developer不會(huì)排斥。同時(shí)，市場(chǎng)越來(lái)越多的業(yè)務(wù)開(kāi)發(fā)均圍繞Springboot/Springcloud而展開(kāi)，也讓它成為Java開(kāi)發(fā)的“硬通貨”。

基于Spring，諸多低代碼的平臺(tái)的活躍，進(jìn)一步促進(jìn)了微服務(wù)領(lǐng)域技術(shù)的蓬勃發(fā)展，也減少了每個(gè)developer抽象的煩惱。正如spring宣傳的口號(hào)：

Spring makes Java simpleSpring makes Java modernSpring makes Java productiveSpring makes Java reactive

它讓Java變的“簡(jiǎn)單、先進(jìn)、富有成效而又靈活”了。

在這里插入圖片描述

今日，博主通過(guò)springboot+enum實(shí)現(xiàn)自定義參數(shù)的初始化和應(yīng)用。

一. 自定義參數(shù)并創(chuàng)建一個(gè)enum

在springboot project中，我們通常會(huì)get一個(gè)yml文件，一般名為：bootstrap.yml。文件的大致內(nèi)容是對(duì)當(dāng)前service的定義和運(yùn)行的描述，形如：

# Tomcat
server:
  port: 8080

# Spring
spring: 
  application:
    # 應(yīng)用名稱(chēng)
    name: myapp

該文件指定了當(dāng)前service 的端口號(hào)和名稱(chēng)，當(dāng)然還可以添加更多你認(rèn)為重要的參數(shù)。接下來(lái)，博主帶這各位看看如何使用springboot+enum實(shí)現(xiàn)配置參數(shù)的獲取和使用。

1. 自定義參數(shù)

首先定義一些參數(shù)，比如我們可以在bootstrap.yml中，添加以下參數(shù)：

api:
  url: https://testapi.com
  key: 123
  secret: 123456

2. 自定義enum

再來(lái)定義一個(gè)枚舉類(lèi)MyEnum：

public class MyEnum {

    public enum api {

        // 定義一個(gè)枚舉，默認(rèn)提供實(shí)際值，下一步通過(guò)配置參數(shù)替換
    	token("token","https://testapi.com/api/token"),
		;
		
    	private String code;
    	private String url;
		
		//定義構(gòu)造器
		api(String code, String url){
    		this.code = code;
    		this.url = url;
    	}
    	
    	public String getCode() {
			return code;
		}

		public void setCode(String code) {
			this.code = code;
		}

		public String getUrl() {
			return url;
		}

		public void setUrl(String url) {
			this.url = url;
		}
    }
}

這里博主內(nèi)置了一個(gè)token api的完整URL，顯然不便于未來(lái)的維護(hù)。完成以上準(zhǔn)備后，我們看看下一步如何使用自定義參數(shù)來(lái)改造它。

二. 在enum或bean中使用參數(shù)

1. @Value簡(jiǎn)介

我們知道基于springboot，有多種參數(shù)的加載（load）方式。這里博主以@Value為例進(jìn)行說(shuō)明。

@Value注解可以用來(lái)將外部的值動(dòng)態(tài)注入到 Bean 中，通常用于屬性的注入。可以用在字段或者方法上，但是不能直接用于static或者final修飾的字段上。使用該方式時(shí)，必須滿(mǎn)足spring依賴(lài)注入的要求，否則無(wú)法生效。

2. 創(chuàng)建Java bean并注入?yún)?shù)

通過(guò)在指定的屬性上，添加@Value("${XXX}")，實(shí)現(xiàn)參數(shù)注入。

@Component
@Data
public class ApiBean implements Serializable
{
    private static final long serialVersionUID = 1L;

    //key
    @Value("${api.key}")
    private String key;
    
    //secret
    @Value("${api.secret}")
    private String secret;
   
}

提示：該Bean必須添加@Component注解，否則無(wú)效。

3. 修改enum類(lèi)并注入?yún)?shù)

public class MyEnum {

    //使用參數(shù)值
	static String apiUrl = MyEnum.api.MyEnumInit.urlRoot;

    public enum api {

        // 替換為參數(shù)提供的值
    	token("token",apiUrl+"/api/token"),
		;
		
    	private String code;
    	private String url;
		
		//定義構(gòu)造器
		api(String code, String url){
    		this.code = code;
    		this.url = url;
    	}
    	
    	public String getCode() {
			return code;
		}

		public void setCode(String code) {
			this.code = code;
		}

		public String getUrl() {
			return url;
		}

		public void setUrl(String url) {
			this.url = url;
		}
		// 看這里，新增內(nèi)部類(lèi)，支持注入
		@Component
        static class MyEnumInit{
			private static String urlRoot;
			@Value("${api.url}")
        	public void getUrl(String url) {
        		MyEnumInit.urlRoot = url;
        	}
        }
    }
}

提示：內(nèi)部類(lèi)必須添加@Component注解，否則無(wú)效。

關(guān)鍵的實(shí)現(xiàn)是enum中內(nèi)部類(lèi)的定義：MyEnumInit。通過(guò)內(nèi)部類(lèi)實(shí)現(xiàn)依賴(lài)注入，完成url配置參數(shù)的獲取。這是“曲線(xiàn)救國(guó)”的典型實(shí)踐。