詳解Spring Boot使用系統(tǒng)參數(shù)表提升系統(tǒng)的靈活性
更新時間：2021年06月30日 16:25:12 作者：阿拉伯1999
Spring Boot項目中常有一些相對穩(wěn)定的參數(shù)設(shè)置項，其作用范圍是系統(tǒng)級的或模塊級的，這些參數(shù)稱為系統(tǒng)參數(shù)。這些變量以參數(shù)形式進行配置，從而提高變動和擴展的靈活性，保持代碼的穩(wěn)定性
一、使用系統(tǒng)參數(shù)表的好處
以數(shù)據(jù)庫表形式存儲的系統(tǒng)參數(shù)表比配置文件（.properties文件或.yaml文件）要更靈活，因為無需重啟系統(tǒng)就可以動態(tài)更新。
系統(tǒng)參數(shù)表可用于存儲下列數(shù)據(jù)：
表字段枚舉值，如下列字段：
`question_type` TINYINT(4) NOT NULL DEFAULT 0 COMMENT '題型，1-單選題，2-多選題，3-問答題',
這個字段現(xiàn)在有3種取值，但是難保將來有擴展的可能，如：是非題、計算題、應(yīng)用題等。
因此將取值的枚舉值用系統(tǒng)參數(shù)表來配置，可以提高系統(tǒng)擴展靈活性。
另一方面，對于前端而言，就可以通過查詢系統(tǒng)參數(shù)表數(shù)據(jù)，用于UI呈現(xiàn)，而不必硬編碼。如前端需要用下拉框來顯示所有可能的”題型“，這個列表就可以查詢系統(tǒng)參數(shù)表來獲取。
因此可以將所有字段枚舉值納入系統(tǒng)參數(shù)表管理。
參數(shù)設(shè)置，如郵件參數(shù)，對接的第三方系統(tǒng)的URL等。
二、系統(tǒng)參數(shù)表的表結(jié)構(gòu)
系統(tǒng)參數(shù)表的表結(jié)構(gòu)如下：
DROP TABLE IF EXISTS `sys_parameters`; CREATE TABLE `sys_parameters` ( `class_id` INT(11) NOT NULL DEFAULT 0 COMMENT '參數(shù)大類id', `class_key` VARCHAR(60) NOT NULL DEFAULT '' COMMENT '參數(shù)大類key', `class_name` VARCHAR(60) NOT NULL DEFAULT '' COMMENT '參數(shù)大類名稱', `item_id` INT(11) NOT NULL DEFAULT 0 COMMENT '參數(shù)大類下子項id', `item_key` VARCHAR(200) NOT NULL DEFAULT '' COMMENT '子項key', `item_value` VARCHAR(200) NOT NULL DEFAULT '' COMMENT '子項值', `item_desc` VARCHAR(512) NOT NULL DEFAULT '' COMMENT '子項描述', -- 記錄操作信息 `login_name` VARCHAR(80) NOT NULL DEFAULT '' COMMENT '操作人賬號', `delete_flag` TINYINT(4) NOT NULL DEFAULT 0 COMMENT '記錄刪除標記，1-已刪除', `create_time` DATETIME NOT NULL DEFAULT NOW() COMMENT '創(chuàng)建時間', `update_time` DATETIME DEFAULT NULL ON UPDATE NOW() COMMENT '更新時間', PRIMARY KEY (`class_id`, `item_id`) ) ENGINE = InnoDB DEFAULT CHARSET = utf8 COMMENT '系統(tǒng)參數(shù)表';
說明：
class_id字段只要確保一個參數(shù)大類（如一個枚舉字段名）使用唯一值。使用class_key和item_key自動，便于提高記錄數(shù)據(jù)和代碼的可讀性。class_key一般可以取字段名，但如果發(fā)生同名時，需要修改，確保不同表的同名字段，使用不同的class_key。對于枚舉值類型，item_key可以取item_id相同的值，只是數(shù)據(jù)類型不同，此item_key轉(zhuǎn)換成整型數(shù)，就是對應(yīng)字段的值。
這個表的數(shù)據(jù)一般可以由開發(fā)人員提供，包括初始或變動的SQL腳本，由DBA執(zhí)行，項目無需為此開發(fā)界面來維護。
下面是初始腳本示例：
INSERT INTO sys_parameters(class_id, class_key, class_name, item_id, item_key, item_value, item_desc) VALUES (11, 'receive_flag', '短信接收標志', 0, '0', '未接收', ''); INSERT INTO sys_parameters(class_id, class_key, class_name, item_id, item_key, item_value, item_desc) VALUES (11, 'receive_flag', '短信接收標志', 1, '1', '已接收', ''); INSERT INTO sys_parameters(class_id, class_key, class_name, item_id, item_key, item_value, item_desc) VALUES (11, 'receive_flag', '短信接收標志', 2, '2', '發(fā)送失敗', ''); INSERT INTO sys_parameters(class_id, class_key, class_name, item_id, item_key, item_value, item_desc) VALUES (12, 'question_type', '題型', 1, '1', '單選題', ''); INSERT INTO sys_parameters(class_id, class_key, class_name, item_id, item_key, item_value, item_desc) VALUES (12, 'question_type', '題型', 2, '2', '多選題', ''); INSERT INTO sys_parameters(class_id, class_key, class_name, item_id, item_key, item_value, item_desc) VALUES (12, 'question_type', '題型', 3, '3', '問答題', ''); INSERT INTO sys_parameters(class_id, class_key, class_name, item_id, item_key, item_value, item_desc) VALUES (101, 'url_param', 'URL參數(shù)', 0, 'url_prefix', 'http://questinvest.abc.com:8880', 'url前綴部分'); INSERT INTO sys_parameters(class_id, class_key, class_name, item_id, item_key, item_value, item_desc) VALUES (101, 'url_param', 'URL參數(shù)', 1, 'url_action', '/questInvest/show', '請求接口方法');
三、系統(tǒng)參數(shù)表在項目中的使用
在Spring Boot項目中，系統(tǒng)參數(shù)表一般只需在應(yīng)用啟動時加載一次，并提供更新接口允許管理員來更新數(shù)據(jù)。下面詳細說明使用方法。
3.1、Entity類
先定義系統(tǒng)參數(shù)表的實體類，實體類為SysParameter，代碼如下：
package com.abc.questInvest.entity;
import javax.persistence.Column;
import lombok.Data;
/**
* @className : SysParameter
* @description : 系統(tǒng)參數(shù)信息對象類
*
*/
@Data
public class SysParameter {
//參數(shù)大類id
@Column(name = "class_id")
private Integer classId;
//參數(shù)大類key
@Column(name = "class_key")
private String classKey;
//參數(shù)大類名稱
@Column(name = "class_name")
private String className;
//子項id
@Column(name = "item_id")
private Integer itemId;
//子項key
@Column(name = "item_key")
private String itemKey;
//子項值
@Column(name = "item_value")
private String itemValue;
//子項描述
@Column(name = "item_desc")
private String itemDesc;
//========記錄操作信息================
// 操作人姓名
@Column(name = "login_name")
private String loginName;
// 記錄刪除標記，保留
@Column(name = "delete_flag")
private Byte deleteFlag;
// 創(chuàng)建時間
@Column(name = "create_time")
private Date createTime;
// 更新時間
@Column(name = "update_time")
private Date updateTime;
}
3.2、Dao類
數(shù)據(jù)訪問類為SysParameterDao，代碼如下：
package com.abc.questInvest.dao;
import java.util.List;
import org.apache.ibatis.annotations.Mapper;
import org.apache.ibatis.annotations.Select;
import com.abc.questInvest.entity.SysParameter;
/**
* @className : SysParameterDao
* @description : sys_parameters表數(shù)據(jù)訪問類
*
*/
@Mapper
public interface SysParameterDao {
//查詢所有系統(tǒng)參數(shù)，按class_id,item_id排序
@Select("SELECT class_id,class_key,class_name,item_id,item_key,item_value,item_desc"
+ " FROM sys_parameters WHERE delete_flag = 0"
+ " ORDER BY class_id,item_id")
List<SysParameter> selectAll();
}
SysParameterDao類，使用Mybatis，只需提供查詢接口就行了，因為修改在數(shù)據(jù)庫后臺執(zhí)行了。當然如果項目方認為有必要提供界面來維護該表，則可增加相應(yīng)CRUD的接口。
3.3、Service類
服務(wù)接口類為SysParameterService，代碼如下：
package com.abc.questInvest.service;
import java.util.List;
import com.abc.questInvest.entity.SysParameter;
/**
* @className : SysParameterService
* @description : 系統(tǒng)參數(shù)數(shù)據(jù)服務(wù)
*
*/
public interface SysParameterService {
/**
*
* @methodName : loadData
* @description : 加載數(shù)據(jù)庫中數(shù)據(jù)，允許重復調(diào)用
* @return : 成功返回true，否則返回false。
*
*/
public boolean loadData();
/**
*
* @methodName : getParameterClass
* @description : 獲取指定classKey的參數(shù)類別的子項列表
* @param classKey : 參數(shù)類別key
* @return : 指定classKey的參數(shù)類別的子項列表
*
*/
public List<SysParameter> getParameterClass(String classKey);
/**
*
* @methodName : getParameterItemByKey
* @description : 根據(jù)classKey和itemKey獲取參數(shù)子項
* @param classKey : 參數(shù)類別key
* @param itemKey : 子項key
* @return : SysParameter對象
*
*/
public SysParameter getParameterItemByKey(String classKey,String itemKey);
/**
*
* @methodName : getParameterItemByValue
* @description : 根據(jù)classKey和itemValue獲取參數(shù)子項
* @param classKey : 參數(shù)類別key
* @param itemValue : 子項值
* @return : SysParameter對象
*
*/
public SysParameter getParameterItemByValue(String classKey,String itemValue);
}
SysParameterService類定義了下列接口方法：
- loadData方法，用于初始加載數(shù)據(jù)和更新數(shù)據(jù)。
- getParameterClass方法，獲取指定classKey的類別的所有子項列表。此方法調(diào)用會非常頻繁。
- getParameterItemByKey方法，根據(jù)classKey和itemKey獲取參數(shù)子項，用于根據(jù)枚舉值顯示物理含義。此方法調(diào)用會非常頻繁。
- getParameterItemByValue方法，根據(jù)classKey和itemValue獲取參數(shù)子項，用于根據(jù)物理含義取得枚舉值。此方法調(diào)用會非常頻繁。
3.4、ServiceImpl類
服務(wù)實現(xiàn)類為SysParameterServiceImpl，代碼如下：
package com.abc.questInvest.service.impl;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
import com.abc.questInvest.dao.SysParameterDao;
import com.abc.questInvest.entity.SysParameter;
import com.abc.questInvest.service.SysParameterService;
import lombok.extern.slf4j.Slf4j;
/**
* @className : SysParameterServiceImpl
* @description : SysParameterService實現(xiàn)類
* @summary : 實現(xiàn)對系統(tǒng)參數(shù)的管理
*
*/
@Slf4j
@Service
public class SysParameterServiceImpl implements SysParameterService{
//sys_parameters表數(shù)據(jù)訪問對象
@Autowired
private SysParameterDao sysParameterDao;
//管理全部的SysParameter表記錄
private Map<String,Map<String,SysParameter>> sysParameterMap = new HashMap<String,Map<String,SysParameter>>();
/**
*
* @methodName : loadData
* @description : 加載數(shù)據(jù)庫中數(shù)據(jù)
* @return : 成功返回true，否則返回false。
*
*/
@Override
public boolean loadData() {
try
{
//查詢sys_parameters表，獲取全部數(shù)據(jù)
List<SysParameter> sysParameterList = sysParameterDao.selectAll();
synchronized(sysParameterMap) {
//先清空map，便于刷新調(diào)用
sysParameterMap.clear();
//將查詢結(jié)果放入map對象中，按每個類別組織
for(SysParameter item : sysParameterList) {
String classKey = item.getClassKey();
String itemKey = item.getItemKey();
Map<String,SysParameter> sysParameterClassMap = null;
if (sysParameterMap.containsKey(classKey)) {
//如果存在該類別，則獲取對象
sysParameterClassMap = sysParameterMap.get(classKey);
}else {
//如果不存在該類別，則創(chuàng)建
sysParameterClassMap = new HashMap<String,SysParameter>();
//加入map中
sysParameterMap.put(classKey, sysParameterClassMap);
}
sysParameterClassMap.put(itemKey,item);
}
}
}catch(Exception e) {
log.error(e.getMessage());
e.printStackTrace();
return false;
}
return true;
}
/**
*
* @methodName : getParameterClass
* @description : 獲取指定classKey的參數(shù)類別的子項列表
* @param classKey : 參數(shù)類別key
* @return : 指定classKey的參數(shù)類別的子項列表
*
*/
@Override
public List<SysParameter> getParameterClass(String classKey){
List<SysParameter> sysParameterList = new ArrayList<SysParameter>();
//獲取classKey對應(yīng)的子map，將所有子項加入列表中
if (sysParameterMap.containsKey(classKey)) {
Map<String,SysParameter> sysParameterClassMap = sysParameterMap.get(classKey);
for(SysParameter item : sysParameterClassMap.values()) {
sysParameterList.add(item);
}
}
return sysParameterList;
}
/**
*
* @methodName : getParameterItemByKey
* @description : 根據(jù)classKey和itemKey獲取參數(shù)子項
* @param classKey : 參數(shù)類別key
* @param itemKey : 子項key
* @return : SysParameter對象
*
*/
@Override
public SysParameter getParameterItemByKey(String classKey,String itemKey) {
SysParameter sysParameter = null;
if (sysParameterMap.containsKey(classKey)) {
//如果classKey存在
Map<String,SysParameter> sysParameterClassMap = sysParameterMap.get(classKey);
if (sysParameterClassMap.containsKey(itemKey)) {
//如果itemKey存在
sysParameter = sysParameterClassMap.get(itemKey);
}
}
return sysParameter;
}
/**
*
* @methodName : getParameterItemByValue
* @description : 根據(jù)classKey和itemValue獲取參數(shù)子項
* @param classKey : 參數(shù)類別key
* @param itemValue : 子項值
* @return : SysParameter對象
*
*/
@Override
public SysParameter getParameterItemByValue(String classKey,String itemValue) {
SysParameter sysParameter = null;
if (sysParameterMap.containsKey(classKey)) {
//如果classKey存在
Map<String,SysParameter> sysParameterClassMap = sysParameterMap.get(classKey);
//遍歷
for (Map.Entry<String,SysParameter> item : sysParameterClassMap.entrySet()) {
if(item.getValue().getItemValue().equals(itemValue)) {
//如果匹配值
sysParameter = item.getValue();
break;
}
}
}
return sysParameter;
}
}
SysParameterServiceImpl類使用了Map<String,Map<String,SysParameter>>類型的屬性變量sysParameterMap來管理全部的系統(tǒng)參數(shù)，外層Map管理classKey到Map<String,SysParameter>的映射關(guān)系，每一項為一個參數(shù)類別，而里層Map<String,SysParameter>，用于管理itemKey與SysParameter之間的映射關(guān)系，每一項為該類別下的一個子項。使用sysParameterMap屬性的目的，是將所有系統(tǒng)參數(shù)都加載到內(nèi)存中，從而無需頻繁訪問數(shù)據(jù)庫。
loadData方法，用于初始加載數(shù)據(jù)和更新時刷新數(shù)據(jù)，為了防止更新時臟讀數(shù)據(jù)，加了同步鎖。這個方法調(diào)用不頻繁。
3.5、全局配置服務(wù)類
全局配置服務(wù)類用于管理全局配置參數(shù)，包括系統(tǒng)參數(shù)、權(quán)限樹等。如果只有一種參數(shù)，可以不必有此類，因為這樣加了一層殼。
服務(wù)接口類為GlobalConfigService，代碼如下：
package com.abc.questInvest.service;
/**
* @className : GlobalConfigService
* @description : 全局變量管理類
*
*/
public interface GlobalConfigService {
/**
*
* @methodName : loadData
* @description : 加載數(shù)據(jù)
* @return : 成功返回true，否則返回false
*
*/
public boolean loadData();
//獲取SysParameterService對象
public SysParameterService getSysParameterService();
//獲取其它配置數(shù)據(jù)服務(wù)對象
//public FunctionTreeService getFunctionTreeService();
}
GlobalConfigService提供了下列接口方法：
- loadData方法，加載配置對象數(shù)據(jù)，確定多個配置對象的加載次序。
- getSysParameterService方法，獲取系統(tǒng)參數(shù)服務(wù)類對象。
- 獲取其它可能的配置服務(wù)對象的方法。
服務(wù)實現(xiàn)類為GlobalConfigServiceImpl，代碼如下：
package com.abc.questInvest.service.impl;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
import com.abc.questInvest.service.FunctionTreeService;
import com.abc.questInvest.service.GlobalConfigService;
import com.abc.questInvest.service.RoleFuncRightsService;
import com.abc.questInvest.service.SysParameterService;
import com.abc.questInvest.service.TableCodeConfigService;
/**
* @className : GlobalConfigServiceImpl
* @description : GlobalConfigService實現(xiàn)類
*
*/
@Service
public class GlobalConfigServiceImpl implements GlobalConfigService{
//系統(tǒng)參數(shù)表數(shù)據(jù)服務(wù)對象
@Autowired
private SysParameterService sysParameterService;
//其它配置數(shù)據(jù)服務(wù)對象
/**
*
* @methodName : loadData
* @description : 加載數(shù)據(jù)
* @return : 成功返回true，否則返回false
*
*/
@Override
public boolean loadData() {
boolean bRet = false;
//加載sys_parameters表記錄
bRet = sysParameterService.loadData();
if (!bRet) {
return bRet;
}
//加載其它配置數(shù)據(jù)
return bRet;
}
//獲取SysParameterService對象
@Override
public SysParameterService getSysParameterService() {
return sysParameterService;
}
//獲取其它配置數(shù)據(jù)服務(wù)對象方法
}
3.6、啟動時加載
全局配置服務(wù)類在應(yīng)用啟動時加載到Spring容器中，這樣可實現(xiàn)共享，減少對數(shù)據(jù)庫的訪問壓力。
實現(xiàn)一個ApplicationListener類，代碼如下：
package com.abc.questInvest;
import javax.servlet.ServletContext;
import org.springframework.context.ApplicationListener;
import org.springframework.context.event.ContextRefreshedEvent;
import org.springframework.stereotype.Component;
import org.springframework.web.context.WebApplicationContext;
import com.abc.questInvest.service.GlobalConfigService;
/**
* @className : ApplicationStartup
* @description : 應(yīng)用偵聽器
*
*/
@Component
public class ApplicationStartup implements ApplicationListener<ContextRefreshedEvent>{
//全局變量管理對象，此處不能自動注入
private GlobalConfigService globalConfigService = null;
@Override
public void onApplicationEvent(ContextRefreshedEvent contextRefreshedEvent) {
try {
if(contextRefreshedEvent.getApplicationContext().getParent() == null){
//root application context 沒有parent.
System.out.println("========定義全局變量==================");
// 將 ApplicationContext 轉(zhuǎn)化為 WebApplicationContext
WebApplicationContext webApplicationContext =
(WebApplicationContext)contextRefreshedEvent.getApplicationContext();
// 從 webApplicationContext 中獲取 servletContext
ServletContext servletContext = webApplicationContext.getServletContext();
//加載全局變量管理對象
globalConfigService = (GlobalConfigService)webApplicationContext.getBean(GlobalConfigService.class);
//加載數(shù)據(jù)
boolean bRet = globalConfigService.loadData();
if (false == bRet) {
System.out.println("加載全局變量失敗");
return;
}
//======================================================================
// servletContext設(shè)置值
servletContext.setAttribute("GLOBAL_CONFIG_SERVICE", globalConfigService);
}
} catch (Exception e) {
e.printStackTrace();
}
}
}
注意，globalConfigService不能自動注入，否則得到空指針。通過下列代碼來加載bean。
//加載全局變量管理對象 globalConfigService = (GlobalConfigService)webApplicationContext.getBean(GlobalConfigService.class);
代碼中，將globalConfigService對象作為全局變量加入ServletContext中，就可以實現(xiàn)共享了。
在啟動類中，加入該應(yīng)用偵聽器ApplicationStartup。
public static void main(String[] args) {
SpringApplication springApplication = new SpringApplication(QuestInvestApplication.class);
springApplication.addListeners(new ApplicationStartup());
springApplication.run(args);
}
3.7、在服務(wù)實現(xiàn)類中訪問系統(tǒng)參數(shù)
HttpServletRequest類型對象request在控制器方法中可以獲取，可作為參數(shù)傳入服務(wù)實現(xiàn)類的方法中。下面是服務(wù)實現(xiàn)類訪問系統(tǒng)參數(shù)的示例代碼：
//獲取ServletContext對象
ServletContext servletContext = request.getServletContext();
//獲取全部數(shù)據(jù)服務(wù)對象
GlobalConfigService globalConfigService = (GlobalConfigService)servletContext.getAttribute("GLOBAL_CONFIG_SERVICE");
//獲取系統(tǒng)參數(shù)url_prefix的值
String url_prefix = "";
SysParameter sysParameter = null;
sysParameter = globalConfigService.getSysParameterService().getParameterItemByKey("url_param", "url_prefix");
if (sysParameter != null) {
url_prefix = sysParameter.getItemValue();
}
以上就是詳解Spring Boot使用系統(tǒng)參數(shù)表提升系統(tǒng)的靈活性的詳細內(nèi)容，更多關(guān)于Spring Boot使用系統(tǒng)參數(shù)表提升系統(tǒng)的靈活性的資料請關(guān)注腳本之家其它相關(guān)文章！
相關(guān)文章
這篇文章主要介紹了Spring的IOC原理詳情，IOC是Inversion?of?Control的縮寫，多數(shù)書籍翻譯成“控制反轉(zhuǎn)”，還有些書籍翻譯成為控制反向或者控制倒置2022-07-07
這篇文章主要為大家詳細介紹了java文本處理之計算文本句子數(shù)，具有一定的參考價值，感興趣的小伙伴們可以參考一下2019-08-08
這篇文章主要介紹了Java中的ReadWriteLock讀寫鎖詳解,ReadWriteLock也是一個接口,提供了readLock和writeLock兩種鎖的操作機制,一個資源可以被多個線程同時讀,或者被一個線程寫,但是不能同時存在讀和寫線程,需要的朋友可以參考下2023-12-12
Spring Security 自定義資源服務(wù)器實踐過程
這篇文章主要介紹了Spring Security 自定義資源服務(wù)器實踐,我們通過自己搭建的授權(quán)服務(wù)器和資源服務(wù)器，完整體驗了OAuth2流程，需要的朋友可以參考下2022-08-08
Java GZip 基于磁盤實現(xiàn)壓縮和解壓的方法
這篇文章主要介紹了Java GZip 基于磁盤實現(xiàn)壓縮和解壓,本文通過實例代碼給大家介紹的非常詳細，對大家的學習或工作具有一定的參考需要的朋友可以參考下2020-08-08
這篇文章主要介紹了Java中數(shù)組判斷元素存在幾種方式比較，非常不錯，具有一定的參考借鑒價值，需要的朋友參考下吧2018-07-07
這篇文章主要介紹了JVM 中的StringTable,本文給大家介紹的非常詳細，對大家的學習或工作具有一定的參考借鑒價值，需要的朋友可以參考下2021-03-03
SpringBoot如何統(tǒng)一處理返回結(jié)果和異常情況
這篇文章主要介紹了SpringBoot如何統(tǒng)一處理返回結(jié)果和異常情況問題,具有很好的參考價值,希望對大家有所幫助,如有錯誤或未考慮完全的地方,望不吝賜教2024-05-05
淺談synchronized方法對非synchronized方法的影響
下面小編就為大家?guī)硪黄獪\談synchronized方法對非synchronized方法的影響。小編覺得挺不錯的，現(xiàn)在就分享給大家，也給大家做個參考。一起跟隨小編過來看看吧2017-10-10
java 過濾器模式(Filter/Criteria Pattern)詳細介紹
這篇文章主要介紹了java 過濾器模式(Filter/Criteria Pattern)詳細介紹的相關(guān)資料,需要的朋友可以參考下2016-10-10