### 歡迎訪問我的GitHub
> 這裡分類和彙總了欣宸的全部原創(含配套原始碼)：[https://github.com/zq2599/blog_demos](https://github.com/zq2599/blog_demos)

- 本章是學習spring4.1.8初始化原始碼的第二篇，前一章[《spring4.1.8初始化原始碼學習三部曲之一：AbstractApplicationContext構造方法》](http://blog.itpub.net/70017844/viewspace-2899029/)對AbstractApplicationContext的初始化做了分析，本章我們聚焦ClassPathXmlApplicationContext.setConfigLocations方法；

### 整體概括
- 本章會涉及到多個類的細節，所以先從整體上概括AbstractRefreshableConfigApplicationContext.setConfigLocations方法的主要功能，後面的細節都是基於這些總結展開的：
1. setConfigLocations主要工作有兩個：建立環境物件ConfigurableEnvironment 、處理ClassPathXmlApplicationContext傳入的字串中的佔位符；
2. 環境物件ConfigurableEnvironment中包含了當前JVM的profile配置資訊、環境變數、 Java程式變數；
3. 處理佔位符的關鍵是ConfigurableEnvironment、PropertyResolver、PropertyPlaceholderHelper之間的配合：

| 名稱 | 作用 |
| :-------- | :----|
| ConfigurableEnvironment| 1.建立PropertyResolver； 2.向PropertyResolver提供環境變數、 Java程式變數 |
| PropertyResolver| 1.建立PropertyPlaceholderHelper； 2.定義佔位符的字首和字尾(placeholderPrefix、placeholderSuffix)； 3.提供getPropertyAsRawString方法給PropertyPlaceholderHelper呼叫，用來獲取指定key對應的環境變數； |
| PropertyPlaceholderHelper| 1.找到字串中的佔位符; 2.呼叫PropertyResolver.getPropertyAsRawString方法，從環境變數中取出佔位符對應的值 3.用環境變數的值替換佔位符； |

- 用思維導圖來輔助：
![這裡寫圖片描述](https://typora-pictures-1253575040.cos.ap-guangzhou.myqcloud.com/70-20220606195430293.jpeg)

- 對佔位符的處理實戰，請參考文章[《windows下修改、編譯、構建spring-framework4.1.8.RELEASE原始碼》](http://blog.itpub.net/70017844/viewspace-2898815/)，這裡面用demo展示了佔位符的替換；

### 展開詳情
- 接下來去閱讀setConfigLocations方法內部的細節程式碼：

- 跟蹤該方法，找到是在類AbstractRefreshableConfigApplicationContext中實現的：
```java
public void setConfigLocations(String... locations) {
	if (locations != null) {
		Assert.noNullElements(locations, "Config locations must not be null");
		this.configLocations = new String[locations.length];
		for (int i = 0; i < locations.length; i++) {
			this.configLocations[i] = resolvePath(locations[i]).trim();
		}
	}
	else {
		this.configLocations = null;
	}
}
```

- 從上述程式碼可以發現，本章我們要重點學習的是resolvePath(locations[i])，結合上一章demo中的入參，此處應該是方法**resolvePath("classpath:applicationContext.xml")**；
- 跟蹤到AbstractRefreshableConfigApplicationContext類，這個方法的目的是替換掉path字串中的佔位符${XXX}這樣的內容：

```java
protected String resolvePath(String path) {
	return getEnironment().resolveRequiredPlaceholders(path);
}
```

- 先看getEnvironment()方法：
```java
@Override
public ConfigurableEnvironment getEnvironment() {
	if (this.environment == null) {
		this.environment = createEnvironment();
	}
	return this.environment;
}
```

- 關於ConfigurableEnvironment介面，我們先來看看他的宣告方法以及繼承關係：

![這裡寫圖片描述](https://img-blog.csdn.net/20180708205250680?watermark/2/text/aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2JvbGluZ19jYXZhbHJ5/font/5a6L5L2T/fontsize/400/fill/I0JBQkFCMA==/dissolve/70)
從上圖可見，ConfigurableEnvironment介面有兩個重要部分組成：Profile和Property；
Profile是對測試、生產等不同環境下的bean配置，這裡我們沒有特別設定，所以用到的profile是AbstractEnvironment的defaultProfiles；
接下來關於Property資源是如何產生的；

- 順著呼叫一路看過去，發現最終會呼叫AbstractEnvironment類的構造方法：

```java
public AbstractEnvironment() {
	customizePropertySources(this.propertySources);
	if (this.logger.isDebugEnabled()) {
		this.logger.debug(format(
				"Initialized %s with PropertySources %s", getClass().getSimpleName(), this.propertySources));
	}
}
```
- 上面的customizePropertySources是在StandardEnvironment類中實現的，如下：
```java
@Override
protected void customizePropertySources(MutablePropertySources propertySources) {
	propertySources.addLast(new MapPropertySource(SYSTEM_PROPERTIES_PROPERTY_SOURCE_NAME, getSystemProperties()));
	propertySources.addLast(new SystemEnvironmentPropertySource(SYSTEM_ENVIRONMENT_PROPERTY_SOURCE_NAME, getSystemEnvironment()));
}
```
- 上述程式碼中，可以將propertySources物件理解成一個容器(其物件內部核心成員propertySourceList是個CopyOnWriteArrayList例項)；
- 首先向propertySources新增一組屬性，來自Java程式變數(getSystemProperties()內是System.getProperties()方法)；
- 接著向propertySources再新增一組屬性，來自系統環境變數(getSystemEnvironment()內是System.getenv()方法)；
- getSystemProperties和getSystemEnvironment方法中有個相同的細節需要注意，在獲取程式變數或者系統環境變數的時候，都有可能因為安全限制丟擲異常，這時候就返回一個ReadOnlySystemAttributesMap的實現類，外部呼叫get方法的時候，再去嘗試獲取程式變數或者系統環境變數對應的值，取不到則返回null，程式碼如下：

```java
public Map<string object=""> getSystemProperties() {
	try {
		return (Map) System.getProperties();
	}
	catch (AccessControlException ex) {
		return (Map) new ReadOnlySystemAttributesMap() {
			@Override
			protected String getSystemAttribute(String attributeName) {
				try {
					return System.getProperty(attributeName);
				}
				catch (AccessControlException ex) {
					if (logger.isInfoEnabled()) {
						logger.info(format("Caught AccessControlException when accessing system " +
								"property [%s]; its value will be returned [null]. Reason: %s",
								attributeName, ex.getMessage()));
					}
					return null;
				}
			}
		};
	}
}
```

- StandardEnvironment物件建立成功後，接著看它的resolveRequiredPlaceholders方法：
```java
@Override
public String resolveRequiredPlaceholders(String text) throws IllegalArgumentException {
	return this.propertyResolver.resolveRequiredPlaceholders(text);
}
```
- 上面的propertyResolver從何而來？以下程式碼可見，這個final型的成員變數在宣告時就建立了，前面準備好的propertySources集合透過構造方法傳給了它，所有它已經獲得了所有系統環境變數和程式環境變數：
```java
private final ConfigurablePropertyResolver propertyResolver =
			new PropertySourcesPropertyResolver(this.propertySources);
```

- 跟蹤PropertySourcesPropertyResolver.resolveRequiredPlaceholders，發現真正處理佔位符的邏輯是在PropertyPlaceholderHelper.doResolvePlaceholders方法：

```java
private String doResolvePlaceholders(String text, PropertyPlaceholderHelper helper) {
		return helper.replacePlaceholders(text, new PropertyPlaceholderHelper.PlaceholderResolver() {
			@Override
			public String resolvePlaceholder(String placeholderName) {
				return getPropertyAsRawString(placeholderName);
			}
		});
	}
```

- getPropertyAsRawString的具體實現在PropertySourcesPropertyResolver類中：
```java
@Override
protected String getPropertyAsRawString(String key) {
	return getProperty(key, String.class, false);
}
```

- 繼續跟蹤helper.replacePlaceholders()，到了PropertyPlaceholderHelper.parseStringValue方法，這裡面逐一找出每個佔位符去做替換：
```java
public String replacePlaceholders(String value, PlaceholderResolver placeholderResolver) {
	Assert.notNull(value, "'value' must not be null");
	return parseStringValue(value, placeholderResolver, new HashSet<string>());
}
```

- parseStringValue方法中，找到了佔位符後，會呼叫入參placeholderResolver的resolvePlaceholder(placeholder)方法，也就是步驟9中匿名類的getPropertyAsRawString方法（實際上就是PropertySourcesPropertyResolver.getPropertyAsRawString方法），最終會在PropertySourcesPropertyResolver.getProperty方法中找出所有的屬性來匹配佔位符：

```java
protected String parseStringValue(
			String strVal, PlaceholderResolver placeholderResolver, Set<string> visitedPlaceholders) {

printTrack("start parseStringValue");
		logger.info("before parse : [" + strVal + "]");

StringBuilder result = new StringBuilder(strVal);

int startIndex = strVal.indexOf(this.placeholderPrefix);
		while (startIndex != -1) {
			int endIndex = findPlaceholderEndIndex(result, startIndex);
			if (endIndex != -1) {
				String placeholder = result.substring(startIndex + this.placeholderPrefix.length(), endIndex);
				String originalPlaceholder = placeholder;
				if (!visitedPlaceholders.add(originalPlaceholder)) {
					throw new IllegalArgumentException(
							"Circular placeholder reference '" + originalPlaceholder + "' in property definitions");
				}
				// Recursive invocation, parsing placeholders contained in the placeholder key.
				//這裡有迭代操作，確保處理完字串中所有的佔位符
				placeholder = parseStringValue(placeholder, placeholderResolver, visitedPlaceholders);
				// 這裡實際上會呼叫PropertySourcesPropertyResolver.getPropertyAsRawString方法，propVal的值就是從環境變數中取得的值
				String propVal = placeholderResolver.resolvePlaceholder(placeholder);
				...
```

- 至此，Spring環境的初始化準備工作已經完成，下一章一起去看refresh()方法，那裡聚集了Spring初始化的核心操作：《spring4.1.8初始化原始碼學習三部曲之三：AbstractApplicationContext.refresh方法》

### 歡迎關注ITpub：程式設計師欣宸
> [學習路上，你不孤單，欣宸原創一路相伴...](http://blog.itpub.net/70017844/)</string></string></string>

spring4.1.8初始化原始碼學習三部曲之二：setConfigLocations方法

相關文章