SCF: 简单配置门面
Simple Configuration Facade, 簡寫為?SCF。是?代碼?和?外部配置?(properties文件, 環(huán)境變量,系統(tǒng)/命令行參數(shù), yaml文件, 等等)之間的一層抽象. 命名上和另一個著名組件slf4j?(Simple Logging Facade for Java)相似, 在配置領(lǐng)域的地位也和slf4j (.NET可類比NLog)在日志領(lǐng)域的地位相同。
SCF使得代碼和外部配置分離。代碼使用一個配置項,無需關(guān)心配置項在哪里配置,如何配置。
用法
java: https://github.com/mydotey/scf/tree/master/java
dotnet: https://github.com/mydotey/scf/tree/master/dotnet
示例
https://github.com/mydotey/scf-best-practice
功能
強類型
核心抽象是強類型的Property<K, V>, Key和Value都是強類型。
安全的配置
可以通過1個value filter來自動檢查外部配置的正確性。
動態(tài)配置
配置可以是動態(tài)變化的。配置項的值自動更新。用戶也可添加Listener監(jiān)聽配置項的變化。
多配置源
多個配置源有不同的優(yōu)先級。配置項的值按配置源的優(yōu)先級自動計算。
可擴展
scf-core?里只定義了一組接口抽象和默認實現(xiàn)。所有核心概念都是可擴展的(配置管理器,配置源,配置項等等)。用戶可以自由地對默認實現(xiàn)進行擴展,或者編寫自己的實現(xiàn)。
一些常用擴展:
scf-simple
scf-labeled
scf-yaml
scf-apollo
輕量
無線程使用,只使用少量內(nèi)存來緩存配置項。
支持多線程并發(fā)
Manager/Property的方法都是線程安全的,可以多線程并發(fā)使用。時間復(fù)雜讀為O(1),和ConcurrentHashMap相同。
容易使用
scf-simple?對最簡單常用的Property<String, String>場景進行了實現(xiàn): properties file, memory Map, system properties, env variables.
參考:
用法
示例
核心概念
配置項(Property)
配置項是可以在代碼里獨立使用的配置單元,有1個唯一的Property Config和1個強類型值。
代碼可以監(jiān)聽配置項的動態(tài)變化。配置項的值由配置管理器(Configuration Manager)自動更新。
配置項配置(Property Config)
配置項配置具有以下組成部分:
Key: 在1個配置管理器里唯一標識1個配置項。最常見的類型是String,也可以是其它強類型的對象。
Value Type: 配置項的值的類型。
Default Value:?配置項的默認值。如果配置項在任何配置源里都沒有配,使用此默認配置。
Value Converter: 值轉(zhuǎn)換器。把1個類型的值轉(zhuǎn)換為另1個類型的值。比如1個配置源里有配置項<K, V1>,但代碼需要的配置是<K, V2>,值轉(zhuǎn)換器<V1, V2>可以自動地把V1的值轉(zhuǎn)為V2的值。
Value Filter: 值過濾器。主要用于檢查配置源里取到的值的有效性。
配置源(Configuration Source)
1個配置項可以以多種形式來進行配置。例如內(nèi)存字典、properties文件、環(huán)境變量、命令行參數(shù)、yaml文件等等。
多種配置方式可以一起使用。每種配置方式是1個配置源。配置源負責(zé)對配置項提供值。
有時1個配置源無法向某個配置項提供值,提供null(認為沒有配置此配置項)。
配置項的Key無法被配置源識別。如key是1個強類型的對象{ key: request.timeout, labels: { dc: aws-us-east1, app: 100000 } }, 但是配置源只接受String類型的key。
配置項在配置源里沒有配置。
配置項在配置源里的值是類型A,但代碼里需要類型B,PropertyConfig沒有值轉(zhuǎn)換器可以把類型A轉(zhuǎn)為類型B,配置源也無法自動把A轉(zhuǎn)換為B。
配置管理器(Configuration Manager)
配置管理器是代碼和外部配置間的門面。代碼從配置管理器獲取配置項,不關(guān)心配置項在哪里配置,如何配置。
1個程序里可以只使用1個配置管理器,也可以使用多個不同的管理器。不同的組件可以使用不同的配置管理器,配置管理器也可以在不同組件間共享/傳遞。
配置管理器提供2個Api:
<K, V> Property<K, V> getProperty(PropertyConfig<K, V> config): 用于具有?穩(wěn)定?的Key的?穩(wěn)定?的配置項,返回1個?唯一?的配置項。?配置管理器?保持這個配置項,自動更新配置值,通知配置監(jiān)聽器配置項的變化。?代碼?可以保持獲得的配置項,多次重復(fù)使用。
<V> V getPropertyValue(PropertyConfig<K, V> config): 用于具有?不穩(wěn)定?的Key的?不穩(wěn)定?的配置項。例如, 訪問者?IP?作為配置項Key的一部分, 不確定程序里有多少配置項,不確定哪個配置項會被配置,何時會被配置。
配置源和配置優(yōu)先級
1個配置管理器可以管理多個配置源,?不同的配置源具有不同的優(yōu)先級?。配置管理器按優(yōu)先級從配置源獲取配置值。
核心概念間的關(guān)系
核心邏輯
開發(fā)者
Qiang Zhao?koqizhao@outlook.com
原文地址:?https://www.cnblogs.com/koqizhao/p/9552395.html
.NET社區(qū)新聞,深度好文,歡迎訪問公眾號文章匯總 http://www.csharpkit.com
總結(jié)
以上是生活随笔為你收集整理的SCF: 简单配置门面的全部內(nèi)容,希望文章能夠幫你解決所遇到的問題。
- 上一篇: 微软MVP张善友告诉你,微服务选型要注意
- 下一篇: .net core实践系列之短信服务-为