這期內(nèi)容當(dāng)中小編將會(huì)給大家?guī)碛嘘P(guān) Apollo客戶端設(shè)計(jì)原理的源碼解析是怎樣的,文章內(nèi)容豐富且以專業(yè)的角度為大家分析和敘述,閱讀完這篇文章希望大家可以有所收獲。
成都創(chuàng)新互聯(lián)專注于中大型企業(yè)的成都網(wǎng)站設(shè)計(jì)、成都網(wǎng)站建設(shè)和網(wǎng)站改版、網(wǎng)站營銷服務(wù),追求商業(yè)策劃與數(shù)據(jù)分析、創(chuàng)意藝術(shù)與技術(shù)開發(fā)的融合,累計(jì)客戶上千家,服務(wù)滿意度達(dá)97%。幫助廣大客戶順利對(duì)接上互聯(lián)網(wǎng)浪潮,準(zhǔn)確優(yōu)選出符合自己需要的互聯(lián)網(wǎng)運(yùn)用,我們將一直專注成都品牌網(wǎng)站建設(shè)和互聯(lián)網(wǎng)程序開發(fā),在前進(jìn)的路上,與客戶一起成長!
圖 1 簡要描述了 Apollo 客戶端的實(shí)現(xiàn)原理。
客戶端和服務(wù)端保持了一個(gè)長連接,編譯配置的實(shí)時(shí)更新推送。
定時(shí)拉取配置是客戶端本地的一個(gè)定時(shí)任務(wù),默認(rèn)為每 5 分鐘拉取一次,也可以通過在運(yùn)行時(shí)指定 System Property:apollo.refreshInterval 來覆蓋,單位是分鐘,推送+定時(shí)拉取=雙保險(xiǎn)。
客戶端從 Apollo 配置中心服務(wù)端獲取到應(yīng)用的最新配置后,會(huì)保存在內(nèi)存中。
客戶端會(huì)把從服務(wù)端獲取到的配置在本地文件系統(tǒng)緩存一份,當(dāng)服務(wù)或者網(wǎng)絡(luò)不可用時(shí),可以使用本地的配置,也就是我們的本地開發(fā)模式 env=Local。
Apollo 除了支持 API 方式獲取配置,也支持和 Spring/Spring Boot 集成,集成后可以直接通過 @Value 獲取配置,我們來分析下集成的原理。
Spring 從 3.1 版本開始增加了 ConfigurableEnvironment 和 PropertySource:
ConfigurableEnvironment 實(shí)現(xiàn)了 Environment 接口,并且包含了多個(gè) Property-Source。
PropertySource 可以理解為很多個(gè) Key-Value 的屬性配置,在運(yùn)行時(shí)的結(jié)構(gòu)形如圖 2 所示。
需要注意的是,PropertySource 之間是有優(yōu)先級(jí)順序的,如果有一個(gè) Key 在多個(gè) property source 中都存在,那么位于前面的 property source 優(yōu)先。
集成的原理就是在應(yīng)用啟動(dòng)階段,Apollo 從遠(yuǎn)端獲取配置,然后組裝成 PropertySource 并插入到第一個(gè)即可,如圖 3 所示。
客戶端集成 Spring 的代碼分析,我們也采取簡化的方式進(jìn)行講解。
首先我們來分析,在項(xiàng)目啟動(dòng)的時(shí)候從 Apollo 拉取配置,是怎么集成到 Spring 中的。創(chuàng)建一個(gè) PropertySourcesProcessor 類,用于初始化配置到 Spring PropertySource 中。具體代碼如下所示。
@Componentpublic class PropertySourcesProcessor implements BeanFactoryPostProcessor, EnvironmentAware { String APOLLO_PROPERTY_SOURCE_NAME = "ApolloPropertySources";private ConfigurableEnvironment environment;@Overridepublic void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory) throws BeansException {// 啟動(dòng)時(shí)初始化配置到Spring PropertySourceConfig config = new Config(); ConfigPropertySource configPropertySource = new ConfigPropertySource("ap-plication", config); CompositePropertySource composite = new CompositePropertySource(APOLLO_PROPERTY_SOURCE_NAME); composite.addPropertySource(configPropertySource); environment.getPropertySources().addFirst(composite); }@Overridepublic void setEnvironment(Environment environment) {this.environment = (ConfigurableEnvironment) environment; } }
實(shí)現(xiàn) EnvironmentAware 接口是為了獲取 Environment 對(duì)象。實(shí)現(xiàn) BeanFactory-Post-Processor 接口,我們可以在容器實(shí)例化 bean 之前讀取 bean 的信息并修改它。
Config 在 Apollo 中是一個(gè)接口,定義了很多讀取配置的方法,比如 getProperty:getIntProperty 等。通過子類去實(shí)現(xiàn)這些方法,在這里我們就簡化下,直接定義成一個(gè)類,提供兩個(gè)必要的方法,具體代碼如下所示。
public class Config {public String getProperty(String key, String defaultValue) {if (key.equals("bianchengName")) {return "C語言中文網(wǎng)"; }return null; }public SetgetPropertyNames() { Set names = new HashSet<>(); names.add("bianchengName");return names; } }
Config 就是配置類,配置拉取之后會(huì)存儲(chǔ)在類中,所有配置的讀取都必須經(jīng)過它,我們?cè)谶@里就平格定義需要讀取的 key 為 bianchengName。
然后需要將 Config 封裝成 PropertySource 才能插入到 Spring Environment 中。
定義一個(gè) ConfigPropertySource 用于將 Config 封裝成 PropertySource,ConfigProperty-Source 繼承了 EnumerablePropertySource,EnumerablePropertySource 繼承了 PropertySource。具體代碼如下所示。
public class ConfigPropertySource extends EnumerablePropertySource{private static final String[] EMPTY_ARRAY = new String[0]; ConfigPropertySource(String name, Config source) {super(name, source); }@Overridepublic String[] getPropertyNames() { Set propertyNames = this.source.getPropertyNames();if (propertyNames.isEmpty()) {return EMPTY_ARRAY; }return propertyNames.toArray(new String[propertyNames.size()]); }@Overridepublic Object getProperty(String name) {return this.source.getProperty(name, null); } }
需要做的操作還是重寫 getPropertyNames 和 getProperty 這兩個(gè)方法。當(dāng)調(diào)用這兩個(gè)方法時(shí),返回的就是 Config 中的內(nèi)容。
最后將 ConfigPropertySource 添加到 CompositePropertySource 中,并且加入到 Confi-gu-rable-Environment 即可。
定義一個(gè)接口用來測(cè)試有沒有效果,具體代碼如下所示。
@RestControllerpublic class ConfigController {@Value("${bianchengName:zhangsan}")private String name;@GetMapping("/get")private String bianchengUrl;@GetMapping("/get")public String get() {return name + bianchengUrl; } }
在配置文件中增加對(duì)應(yīng)的配置:
bianchengName=xxx bianchengUrl=http://minglisoft.cn/cloud
在沒有增加上面講的代碼之前,訪問 /get 接口返回的是 xxxhttp://c.biancheng.net。加上上面講解的代碼之后,返回的內(nèi)容就變成了猿天地 http://c.biancheng.net。
這是因?yàn)槲覀冊(cè)?Config 中對(duì)應(yīng) bianchengName 這個(gè) key 的返回值是猿天地,也間接證明了在啟動(dòng)的時(shí)候可以通過這種方式來覆蓋本地的值。這就是 Apollo 與 Spring 集成的原理。
在這一節(jié)中,我們來講解下在項(xiàng)目運(yùn)行過程中,配置發(fā)生修改之后推送給了客戶端,那么這個(gè)值如何去更新 Spring 當(dāng)中的值呢?
原理就是把這些配置都存儲(chǔ)起來,當(dāng)配置發(fā)生變化的時(shí)候進(jìn)行修改就可以。Apollo 中定義了一個(gè) SpringValueProcessor 類,用來處理 Spring 中值的修改。下面只貼出一部分代碼,如下所示。
@Componentpublic class SpringValueProcessor implements BeanPostProcessor, BeanFactoryAware {private PlaceholderHelper placeholderHelper = new PlaceholderHelper();private BeanFactory beanFactory;public SpringValueRegistry springValueRegistry = new SpringValueRegistry();@Overridepublic Object postProcessBeforeInitialization(Object bean, String beanName) throws BeansException { Class clazz = bean.getClass();for (Field field : findAllField(clazz)) { processField(bean, beanName, field); }return bean; }private void processField(Object bean, String beanName, Field field) {// register @Value on fieldValue value = field.getAnnotation(Value.class);if (value == null) {return; } Setkeys = placeholderHelper.extractPlaceholderKeys(value.value());if (keys.isEmpty()) {return; }for (String key : keys) { SpringValue springValue = new SpringValue(key, value.value(), bean, beanName, field, false); springValueRegistry.register(beanFactory, key, springValue); } } }
通過實(shí)現(xiàn) BeanPostProcessor 來處理每個(gè) bean 中的值,然后將這個(gè)配置信息封裝成一個(gè) SpringValue 存儲(chǔ)到 springValueRegistry 中。
SpringValue 代碼如下所示。
public class SpringValue {private MethodParameter methodParameter;private Field field;private Object bean;private String beanName;private String key;private String placeholder;private Class> targetType;private Type genericType;private boolean isJson; }
SpringValueRegistry 就是利用 Map 來存儲(chǔ),代碼如下所示。
public class SpringValueRegistry {private final Map> registry = Maps.newConcurrentMap();private final Object LOCK = new Object();public void register(BeanFactory beanFactory, String key, SpringValue springValue) {if (!registry.containsKey(beanFactory)) { synchronized (LOCK) {if (!registry.containsKey(beanFactory)) { registry.put(beanFactory, LinkedListMultimap. create()); } } } registry.get(beanFactory).put(key, springValue); }public Collection get(BeanFactory beanFactory, String key) { Multimap beanFactorySpringValues = registry.get(beanFactory);if (beanFactorySpringValues == null) {return null; }return beanFactorySpringValues.get(key); } }
寫個(gè)接口用于模擬配置修改,具體代碼如下所示。
@RestControllerpublic class ConfigController {@Autowiredprivate SpringValueProcessor springValueProcessor;@Autowiredprivate ConfigurableBeanFactory beanFactory;@GetMapping("/update")public String update(String value) { CollectiontargetValues = springValueProcessor.springValueRegistry.get(beanFactory,"bianchengName");for (SpringValue val : targetValues) {try {val.update(value); } catch (IllegalAccessException | InvocationTargetException e) { e.printStackTrace(); } }return name; } }
當(dāng)我們調(diào)用 /update接口后,在前面的 /get 接口可以看到猿天地的值改成了你傳入的那個(gè)值,這就是動(dòng)態(tài)修改。
通過閱讀 Apollo 的源碼,可以學(xué)到很多的東西。
Apollo 用的是 MySQL。Apollo 是多個(gè)庫,通過庫來區(qū)分不同環(huán)境下的配置。
Apollo 基于 Http 長連接實(shí)現(xiàn)推送,還有容災(zāi)的定時(shí)拉取邏輯。
Apollo 也有自己的原生獲取值的對(duì)象,同時(shí)還集成到了 Spring 中,可以兼容老項(xiàng)目的使用方式。
Apollo 中可以直接使用注解來進(jìn)行監(jiān)聽,非常方便。
上述就是小編為大家分享的 Apollo客戶端設(shè)計(jì)原理的源碼解析是怎樣的了,如果剛好有類似的疑惑,不妨參照上述分析進(jìn)行理解。如果想知道更多相關(guān)知識(shí),歡迎關(guān)注創(chuàng)新互聯(lián)行業(yè)資訊頻道。