原文地址: 關於TornadoFx和Android的全局配置工具類封裝實現及思路解析 - Stars-One的雜貨小窩 目前個人開發軟體存在設置頁面,可以讓用戶自定義些設置,但我發現,存儲數據的代碼邏輯實在是有些繁瑣(保存及APP打開的設置初始化) 於是便是花了些精力研究了些,封裝了個簡單的工具類, ...
原文地址: 關於TornadoFx和Android的全局配置工具類封裝實現及思路解析 - Stars-One的雜貨小窩
目前個人開發軟體存在設置頁面,可以讓用戶自定義些設置,但我發現,存儲數據的代碼邏輯實在是有些繁瑣(保存及APP打開的設置初始化)
於是便是花了些精力研究了些,封裝了個簡單的工具類,可以快捷實現存儲數據的保存及初始化
目標
首先,我們知道,設置的選項值需要存放在本地,之後重新進入APP的時候,需要先從本地讀取,若是本地讀取不到,才賦予一個預設值
所以,確認下我們要達到的理想目標:
對於設置的某項數據,可以使用一個欄位進行對應,而不用關心存儲保存本地的更新操作和APP初始化讀取數值的
實現步驟
先提及下思路,我們將數值保存的本地方法,其實無非就是使用File對象創建個文件,之後將數據寫入文件介面實現配置
在TornadoFx中,提供了config
對象供我們快速使用,而無需編寫過多的關於文件流的操作的代碼
PS:TornadoFx中,除了config,還有個Preference對象,但Preference是寫入註冊表的,所以這裡我們不採用這種方式,詳情可以看上一篇TornadoFx設置保存功能(config和preference使用) - Stars-One的雜貨小窩
而在Android中,也是存在有個SharePreference
的對象,可以存儲寫簡單的數據
TornadoFx和Android的方法大同小異,我們以Android的方法為例講解,後面會附有相關的源碼,複製即可使用
1.實現本地存儲數值
這裡,由於是Android,使用了SharePreference對象來存儲,由於SharePreference的使用需要Context參數,為了方便封裝,用了個開源庫,封裝好了可以直接使用
以一個開關設置項為例(boolean數值),寫個簡單的類:
class GlobalDataConfig(val key:String) {
var flag = false
fun setValue(newVal: Boolean) {
flag = newVal
updateLocalStorage(newVal)
}
/**
*更新本地存儲
*
* @param newVal
*/
private fun updateLocalStorage(newVal: Boolean) {
SPUtils.getInstance().put(key, newVal)
}
}
上面這樣寫,調用的時候,我們需要新建個類,然後設置去的初始值,之後更新統一走setValue()
方法,裡面已經包含了數據存儲在本地的邏輯
PS:
SPUtils
是AndroidUtilCode庫的工具類,用於快速設置SharePreference
如果按照上面的來的話,每個設置項都得新建個類,使用極其不優雅,我們接下來進行優化
2.任意數值(泛型)
首先,我們需要可以自定義任意類型的(雖然說是任意類型,其實最終還是得看SharePreference支持存儲上面數據),一般我們用基本數據類型存儲即可(存儲對象的話就會十分麻煩)
那這個時候有個問題擺在眼前,我們如何獲取用戶傳遞的數值類型?
這個時候,泛型就派上用場了
我們可以這樣寫:
class GlobalDataConfig<T>(val key:String,var currentValue:T) {
fun setValue(newVal: T) {
currentValue = newVal
updateLocalStorage(currentValue)
}
/**
*更新本地存儲
*
* @param newVal
*/
private fun updateLocalStorage(value: T) {
//各種類型的存儲
if (value is Boolean) {
SPUtils.getInstance().put(key, value)
}
if (value is Float) {
SPUtils.getInstance().put(key, value)
}
if (value is String) {
SPUtils.getInstance().put(key, value)
}
if (value is Int) {
SPUtils.getInstance().put(key, value)
}
if (value is Long) {
SPUtils.getInstance().put(key, value)
}
}
}
這樣,我們就可以通過構造函數來生成不同對象.來代表不同的數值項了
3.初始值
到了這步,我們還可以想到,進入APP的時候,配置項要進行初始化,這個時候應該是先從本地存儲讀取,若是讀取不同,則是設置預設值
最初的想法是,使用個函數,用作初始化的數值讀取,同時加個變數用來存儲預設值(之後可以重置為預設值)
class GlobalDataConfig<T>(
val key:String,
var currentValue:T,
var defaultValue:T,
val lbd:((GlobalDataConfig<T>)->Unit)
) {
init{
lbd.invoke(this)
}
fun setValue(newVal: T) {
currentValue = newVal
updateLocalStorage(currentValue)
}
/**
*更新本地存儲
*
* @param newVal
*/
private fun updateLocalStorage(value: T) {
if (value is Boolean) {
SPUtils.getInstance().put(key, value)
}
if (value is Float) {
SPUtils.getInstance().put(key, value)
}
if (value is String) {
SPUtils.getInstance().put(key, value)
}
if (value is Int) {
SPUtils.getInstance().put(key, value)
}
if (value is Long) {
SPUtils.getInstance().put(key, value)
}
}
}
使用:
GlobalDataConfig("mykey",false,false){
it.currentValue = SPUtils.getInstance().getBoolean(key, it.defalutValue)
}
這樣使用一看,發現,我們連最初的currentValue
都不用設置了
所以構造參數還能再精簡下,讓currentValue
預設等於defaultValue
(這樣設置起始沒有毛病,因為之後每次都是會走初始化的步驟,從本地存儲中讀取數據的)
class GlobalDataConfig(
val key: String,
val defaultValue: T,
var currentValue: T = defaultValue,
val initLbd: (GlobalDataConfig) -> Unit
) {
init{
lbd.invoke(this)
}
fun setValue(newVal: T) {
currentValue = newVal
updateLocalStorage(currentValue)
}
/**
*更新本地存儲
*
* @param newVal
*/
private fun updateLocalStorage(value: T) {
if (value is Boolean) {
SPUtils.getInstance().put(key, value)
}
if (value is Float) {
SPUtils.getInstance().put(key, value)
}
if (value is String) {
SPUtils.getInstance().put(key, value)
}
if (value is Int) {
SPUtils.getInstance().put(key, value)
}
if (value is Long) {
SPUtils.getInstance().put(key, value)
}
}
}
然後用起來就變成了這樣:
GlobalDataConfig("mykey",false){
it.currentValue = SPUtils.getInstance().getBoolean(key, it.defalutValue)
}
但是,看起來還是有些繁瑣,中間初始化的過程能否再優化呢?
剛開始我是沒有思路的,因為currentValue
在類裡面是T類型,而我們通過getBoolean
等方法,獲得的都是Boolean
,String
等類型,與T類型不對應,IDE里會提示我們語法不對
然後,突然靈光一閃,我們可以強轉類型嘛,如將GlobalDataConfig<T>
轉為GlobalDataConfig<Boolean>
代碼最終即可以改為下麵的樣子
class GlobalDataConfig<T>(
val key: String,
val defaultValue: T,
var currentValue: T = defaultValue
) {
init {
when{
defaultValue is Boolean -> {
val item = this as GlobalDataConfig<Boolean>
item.setValue(SPUtils.getInstance().getBoolean(key,defaultValue))
}
defaultValue is String -> {
val item = this as GlobalDataConfig<String>
item.setValue(SPUtils.getInstance().getString(key,defaultValue))
}
defaultValue is Int -> {
val item = this as GlobalDataConfig<Int>
item.setValue(SPUtils.getInstance().getInt(key,defaultValue))
}
defaultValue is Double -> {
//SPUtils裡面的似乎沒有提供獲取Double方法...
}
else -> kotlin.error("不支持的數據類型!!目前只支持string,boolean,intdouble四種類型")
}
}
/**
* 重置當前值為預設值
*/
fun resetValue() {
setValue(defaultValue)
}
/**
* 更改數值
*/
fun setValue(value: T) {
//更新記憶體的
currentValue = value
//更新本地存儲的數據
updateLocalStorage(value)
}
/**
* 更新本地存儲
*/
private fun updateLocalStorage(value: T) {
if (value is Boolean) {
SPUtils.getInstance().put(key, value)
}
if (value is Float) {
SPUtils.getInstance().put(key, value)
}
if (value is String) {
SPUtils.getInstance().put(key, value)
}
if (value is Int) {
SPUtils.getInstance().put(key, value)
}
if (value is Long) {
SPUtils.getInstance().put(key, value)
}
}
}
使用上也很方便:
val openAutoRead =GlobalDataConfig("mykey",true)
使用
稍微補充下使用說明吧
1.新建全局配置類
這裡為了方便管理,是建了個Constants
常量池
class GlobalData {
companion object {
//是否為VIP(預設不是)
val userStatus = GlobalDataConfig(Constants.SP_USER_STATUS, false)
}
}
2.讀取數值
在你需要用的地方,獲取數值
val result = GlobalData.userStatus.currentValue
2.更新數值
GlobalData.userStatus.setValue(true)
3.重置數值
GlobalData.userStatus.resetValue()
源碼-Android工具類
PS:這裡其實還可以做個擴展,比如說加個回調方法列表,每次setValue方法後,執行所有回調方法,實現類似監聽數值變動
限於實際情況,我就沒有擴展了(各位可以參考下TornadoFx中的GlobalDataConfig的實現)
class GlobalDataConfig<T>(
val key: String,
val defaultValue: T,
var currentValue: T = defaultValue
) {
init {
when{
defaultValue is Boolean -> {
val item = this as GlobalDataConfig<Boolean>
item.setValue(SPUtils.getInstance().getBoolean(key,defaultValue))
}
defaultValue is String -> {
val item = this as GlobalDataConfig<String>
item.setValue(SPUtils.getInstance().getString(key,defaultValue))
}
defaultValue is Int -> {
val item = this as GlobalDataConfig<Int>
item.setValue(SPUtils.getInstance().getInt(key,defaultValue))
}
defaultValue is Double -> {
//SPUtils裡面的似乎沒有提供獲取Double方法...
}
else -> kotlin.error("不支持的數據類型!!目前只支持string,boolean,intdouble四種類型")
}
}
/**
* 重置當前值為預設值
*/
fun resetValue() {
setValue(defaultValue)
}
/**
* 更改數值
*/
fun setValue(value: T) {
//更新記憶體的
currentValue = value
//更新本地存儲的數據
updateLocalStorage(value)
}
/**
* 更新本地存儲
*/
private fun updateLocalStorage(value: T) {
if (value is Boolean) {
SPUtils.getInstance().put(key, value)
}
if (value is Float) {
SPUtils.getInstance().put(key, value)
}
if (value is String) {
SPUtils.getInstance().put(key, value)
}
if (value is Int) {
SPUtils.getInstance().put(key, value)
}
if (value is Long) {
SPUtils.getInstance().put(key, value)
}
}
}
源碼-TornadoFx工具類
TornadoFx這邊源碼稍微有點多,就不放出來了,詳情可以去我的Github庫common-controls查閱,裡面也含有詳細的使用說明(文檔的第7節)
TornadoFx這邊有些特殊,是結合了JavaFx中提供的可觀察對象一起連用,使用上與Android的有所區別
提問之前,請先看提問須知 點擊右側圖標發起提問


