SpringCloud?@RefreshScope刷新機制源碼分析

今天小編給大家分享一下SpringCloud @RefreshScope刷新機制源碼分析的相關知識點，內容詳細，邏輯清晰，相信大部分人都還太了解這方面的知識，所以分享這篇文章給大家參考一下，希望大家閱讀完這篇文章后有所收獲，下面我們一起來了解一下吧。

一、前言

用過Spring Cloud的同學都知道在使用動態配置刷新的我們要配置一個@RefreshScope 在類上才可以實現對象屬性的的動態更新，本著知其所以然的態度，晚上沒事兒又把這個點回顧了一下，下面就來簡單的說下自己的理解。

總覽下，實現@RefreshScope 動態刷新的就需要以下幾個：

• @ Scope

• @RefreshScope

• RefreshScope

• GenericScope

• Scope

• ContextRefresher

二、@Scope

一句話，@RefreshScope 能實現動態刷新全仰仗著@Scope 這個注解，這是為什么呢？

@Scope 代表了Bean的作用域，我們來看下其中的屬性：

@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Scope {
	/**
	 * Alias for {@link #scopeName}.
	 * @see #scopeName
	 */
	@AliasFor("scopeName")
	String value() default "";
	/**
	 *  singleton  表示該bean是單例的。(默認)
     *  prototype    表示該bean是多例的，即每次使用該bean時都會新建一個對象。
     *  request        在一次http請求中，一個bean對應一個實例。
     *  session        在一個httpSession中，一個bean對應一個實例
	 */
	@AliasFor("value")
	String scopeName() default "";
	/**
    *   DEFAULT			不使用代理。(默認)
	* 	NO				不使用代理，等價于DEFAULT。
	* 	INTERFACES		使用基于接口的代理(jdk dynamic proxy)。
	* 	TARGET_CLASS	使用基于類的代理(cglib)。
    */
	ScopedProxyMode proxyMode() default ScopedProxyMode.DEFAULT;
}

通過代碼我們可以清晰的看到兩個主要屬性value 和 proxyMode，value就不多說了，大家平時經常用看看注解就可以。proxyMode 這個就有意思了，而這個就是@RefreshScope 實現的本質了。

我們需要關心的就是ScopedProxyMode.TARGET_CLASS 這個屬性，當ScopedProxyMode 為TARGET_CLASS 的時候會給當前創建的bean 生成一個代理對象，會通過代理對象來訪問，每次訪問都會創建一個新的對象。

理解起來可能比較晦澀，那先來看下實現再回頭來看這句話。

三、RefreshScope 的實現原理

先來看下@RefreshScope

@Target({ ElementType.TYPE, ElementType.METHOD })
@Retention(RetentionPolicy.RUNTIME)
@Scope("refresh")
@Documented
public @interface RefreshScope {
	/**
	 * @see Scope#proxyMode()
	 */
	ScopedProxyMode proxyMode() default ScopedProxyMode.TARGET_CLASS;
}

2. 可以看出，它使用就是 @Scope ，其內部就一個屬性默認 ScopedProxyMode.TARGET_CLASS。知道了是通過Spring Scope 來實現的那就簡單了，我們來看下Scope 這個接口

public interface Scope {
	/**
	 * Return the object with the given name from the underlying scope,
	 * {@link org.springframework.beans.factory.ObjectFactory#getObject() creating it}
	 * if not found in the underlying storage mechanism.
	 * <p>This is the central operation of a Scope, and the only operation
	 * that is absolutely required.
	 * @param name the name of the object to retrieve
	 * @param objectFactory the {@link ObjectFactory} to use to create the scoped
	 * object if it is not present in the underlying storage mechanism
	 * @return the desired object (never {@code null})
	 * @throws IllegalStateException if the underlying scope is not currently active
	 */
	Object get(String name, ObjectFactory<?> objectFactory);
	@Nullable
	Object remove(String name);
	void registerDestructionCallback(String name, Runnable callback);
	@Nullable
	Object resolveContextualObject(String key);
	@Nullable
	String getConversationId();
}

看下接口，我們只看Object get(String name, ObjectFactory<?> objectFactory); 這個方法幫助我們來創建一個新的bean ，也就是說，@RefreshScope 在調用 刷新的時候會使用此方法來給我們創建新的對象，這樣就可以通過spring 的裝配機制將屬性重新注入了，也就實現了所謂的動態刷新。

那它究竟是怎么處理老的對象，又怎么除法創建新的對象呢？

在開頭我提過幾個重要的類，而其中 RefreshScope extends GenericScope, GenericScope implements Scope。

所以通過查看代碼，是GenericScope 實現了 Scope 最重要的 get(String name, ObjectFactory<?> objectFactory) 方法，在GenericScope 里面 包裝了一個內部類 BeanLifecycleWrapperCache 來對加了 @RefreshScope 從而創建的對象進行緩存，使其在不刷新時獲取的都是同一個對象。（這里你可以把 BeanLifecycleWrapperCache 想象成為一個大Map 緩存了所有@RefreshScope 標注的對象）

知道了對象是緩存的，所以在進行動態刷新的時候，只需要清除緩存，重新創建就好了。

來看代碼，眼見為實，只留下關鍵方法：

// ContextRefresher 外面使用它來進行方法調用 ============================== 我是分割線
	public synchronized Set<String> refresh() {
		Set<String> keys = refreshEnvironment();
		this.scope.refreshAll();
		return keys;
	}
// RefreshScope 內部代碼  ============================== 我是分割線
	@ManagedOperation(description = "Dispose of the current instance of all beans in this scope and force a refresh on next method execution.")
	public void refreshAll() {
		super.destroy();
		this.context.publishEvent(new RefreshScopeRefreshedEvent());
	}
// GenericScope 里的方法 ============================== 我是分割線
	//進行對象獲取，如果沒有就創建并放入緩存
	@Override
	public Object get(String name, ObjectFactory<?> objectFactory) {
		BeanLifecycleWrapper value = this.cache.put(name,
				new BeanLifecycleWrapper(name, objectFactory));
		locks.putIfAbsent(name, new ReentrantReadWriteLock());
		try {
			return value.getBean();
		}
		catch (RuntimeException e) {
			this.errors.put(name, e);
			throw e;
		}
	}
	//進行緩存的數據清理
	@Override
	public void destroy() {
		List<Throwable> errors = new ArrayList<Throwable>();
		Collection<BeanLifecycleWrapper> wrappers = this.cache.clear();
		for (BeanLifecycleWrapper wrapper : wrappers) {
			try {
				Lock lock = locks.get(wrapper.getName()).writeLock();
				lock.lock();
				try {
					wrapper.destroy();
				}
				finally {
					lock.unlock();
				}
			}
			catch (RuntimeException e) {
				errors.add(e);
			}
		}
		if (!errors.isEmpty()) {
			throw wrapIfNecessary(errors.get(0));
		}
		this.errors.clear();
	}

通過觀看源代碼我們得知，我們截取了三個片段所得之，ContextRefresher 就是外層調用方法用的，GenericScope 里面的 get 方法負責對象的創建和緩存，destroy 方法負責再刷新時緩存的清理工作。

以上就是“SpringCloud @RefreshScope刷新機制源碼分析”這篇文章的所有內容，感謝各位的閱讀！相信大家閱讀完這篇文章都有很大的收獲，小編每天都會為大家更新不同的知識，如果還想學習更多的知識，請關注億速云行業資訊頻道。