作者：小傅哥
部落格：https://bugstack.cn
沉澱、分享、成長，讓自己和他人都能有所收穫！?
一、前言
忒複雜，沒等搞明白大促都過去了！
你經歷過618和雙11嗎？你加入過大促時候那麼多複雜的營銷活動賺幾毛錢嗎？你開發過連讀明白玩法都需要一週但只使用3天的大促需求嗎？有時候對於有些產品的需求真的是太複雜了，複雜到開發、測試都需要在整個過程中不斷的學習最後才可能讀懂產品為啥這樣的玩，要是一個長期的活動可能也就算了，培養使用者心智嗎！但這一整套拉新、助力、啟用、下單、投保、領券、消費、開紅包等等一連串的騷操作下來，如果線上上只用3天呢，或者是隻用1天，那TM連參與的使用者都沒弄明白呢，活動就結束了，最後能打來什麼樣好的資料呢？對於這樣流程複雜，估計連羊毛當都看不上！！！
以上只是舉個例子，大部分時候並不會搞的這麼噁心，評審也是過不去的！而同樣的道理用在程式設計開發和使用中也是一樣的，如果你把你的程式碼邏輯實現的過於分散，讓外部呼叫方在使用的時候，需要呼叫你的介面多個和多次，還沒有訊息觸達，只能定時自己輪訓你的介面檢視訂單狀態，每次還只能查10條，查多了你說不行，等等反人類的設計，都會給呼叫方帶來要幹你的體會。
所以，如果我們能在完成目的的情況下，都是希望儘可能流程簡單、模式清晰、自動服務。那這在Spring的框架中也是有所體現的，這個框架的普及使用程度和它所能帶來的方便性是分不開的，而我們如果能做到如此的方便，那肯定是一種好的設計和實現。
二、目標
其實到本章節我們已經把關於 IOC 和 AOP 全部核心內容都已經實現完成了，只不過在使用上還有點像早期的 Spring 版本，需要一個一個在 spring.xml 中進行配置。這與實際的目前使用的 Spring 框架還是有蠻大的差別，而這種差別其實都是在核心功能邏輯之上建設的在更少的配置下，做到更簡化的使用。
這其中就包括：包的掃描註冊、註解配置的使用、佔位符屬性的填充等等，而我們的目標就是在目前的核心邏輯上填充一些自動化的功能，讓大家可以學習到這部分的設計和實現，從中體會到一些關於程式碼邏輯的實現過程，總結一些編碼經驗。
三、方案
首先我們要考慮?，為了可以簡化 Bean 物件的配置，讓整個 Bean 物件的註冊都是自動掃描的，那麼基本需要的元素包括：掃描路徑入口、XML解析掃描資訊、給需要掃描的Bean物件做註解標記、掃描Class物件摘取Bean註冊的基本資訊，組裝註冊資訊、註冊成Bean物件。那麼在這些條件元素的支撐下，就可以實現出通過自定義註解和配置掃描路徑的情況下，完成 Bean 物件的註冊。除此之外再順帶解決一個配置中佔位符屬性的知識點，比如可以通過 ${token} 給 Bean 物件注入進去屬性資訊，那麼這個操作需要用到 BeanFactoryPostProcessor，因為它可以處理 在所有的 BeanDefinition 載入完成後，例項化 Bean 物件之前，提供修改 BeanDefinition 屬性的機制 而實現這部分內容是為了後續把此類內容結合到自動化配置處理中。整體設計結構如下圖：
結合bean的生命週期，包掃描只不過是掃描特定註解的類，提取類的相關資訊組裝成BeanDefinition註冊到容器中。
在XmlBeanDefinitionReader中解析<context:component-scan />標籤，掃描類組裝BeanDefinition然後註冊到容器中的操作在ClassPathBeanDefinitionScanner#doScan中實現。
- 自動掃描註冊主要是掃描新增了自定義註解的類，在xml載入過程中提取類的資訊，組裝 BeanDefinition 註冊到 Spring 容器中。
- 所以我們會用到
<context:component-scan />配置包路徑並在 XmlBeanDefinitionReader 解析並做相應的處理。這裡的處理會包括對類的掃描、獲取註解資訊等 - 最後還包括了一部分關於
BeanFactoryPostProcessor的使用，因為我們需要完成對佔位符配置資訊的載入，所以需要使用到 BeanFactoryPostProcessor 在所有的 BeanDefinition 載入完成後，例項化 Bean 物件之前，修改 BeanDefinition 的屬性資訊。這一部分的實現也為後續處理關於佔位符配置到註解上做準備
四、實現
1. 工程結構
small-spring-step-13
└── src
├── main
│ └── java
│ └── cn.bugstack.springframework
│ ├── aop
│ │ ├── aspectj
│ │ │ └── AspectJExpressionPointcut.java
│ │ │ └── AspectJExpressionPointcutAdvisor.java
│ │ ├── framework
│ │ │ ├── adapter
│ │ │ │ └── MethodBeforeAdviceInterceptor.java
│ │ │ ├── autoproxy
│ │ │ │ └── MethodBeforeAdviceInterceptor.java
│ │ │ ├── AopProxy.java
│ │ │ ├── Cglib2AopProxy.java
│ │ │ ├── JdkDynamicAopProxy.java
│ │ │ ├── ProxyFactory.java
│ │ │ └── ReflectiveMethodInvocation.java
│ │ ├── AdvisedSupport.java
│ │ ├── Advisor.java
│ │ ├── BeforeAdvice.java
│ │ ├── ClassFilter.java
│ │ ├── MethodBeforeAdvice.java
│ │ ├── MethodMatcher.java
│ │ ├── Pointcut.java
│ │ ├── PointcutAdvisor.java
│ │ └── TargetSource.java
│ ├── beans
│ │ ├── factory
│ │ │ ├── config
│ │ │ │ ├── AutowireCapableBeanFactory.java
│ │ │ │ ├── BeanDefinition.java
│ │ │ │ ├── BeanFactoryPostProcessor.java
│ │ │ │ ├── BeanPostProcessor.java
│ │ │ │ ├── BeanReference.java
│ │ │ │ ├── ConfigurableBeanFactory.java
│ │ │ │ ├── InstantiationAwareBeanPostProcessor.java
│ │ │ │ └── SingletonBeanRegistry.java
│ │ │ ├── support
│ │ │ │ ├── AbstractAutowireCapableBeanFactory.java
│ │ │ │ ├── AbstractBeanDefinitionReader.java
│ │ │ │ ├── AbstractBeanFactory.java
│ │ │ │ ├── BeanDefinitionReader.java
│ │ │ │ ├── BeanDefinitionRegistry.java
│ │ │ │ ├── CglibSubclassingInstantiationStrategy.java
│ │ │ │ ├── DefaultListableBeanFactory.java
│ │ │ │ ├── DefaultSingletonBeanRegistry.java
│ │ │ │ ├── DisposableBeanAdapter.java
│ │ │ │ ├── FactoryBeanRegistrySupport.java
│ │ │ │ ├── InstantiationStrategy.java
│ │ │ │ └── SimpleInstantiationStrategy.java
│ │ │ ├── support
│ │ │ │ └── XmlBeanDefinitionReader.java
│ │ │ ├── Aware.java
│ │ │ ├── BeanClassLoaderAware.java
│ │ │ ├── BeanFactory.java
│ │ │ ├── BeanFactoryAware.java
│ │ │ ├── BeanNameAware.java
│ │ │ ├── ConfigurableListableBeanFactory.java
│ │ │ ├── DisposableBean.java
│ │ │ ├── FactoryBean.java
│ │ │ ├── HierarchicalBeanFactory.java
│ │ │ ├── InitializingBean.java
│ │ │ ├── ListableBeanFactory.java
│ │ │ └── PropertyPlaceholderConfigurer.java
│ │ ├── BeansException.java
│ │ ├── PropertyValue.java
│ │ └── PropertyValues.java
│ ├── context
│ │ ├── annotation
│ │ │ ├── ClassPathBeanDefinitionScanner.java
│ │ │ ├── ClassPathScanningCandidateComponentProvider.java
│ │ │ └── Scope.java
│ │ ├── event
│ │ │ ├── AbstractApplicationEventMulticaster.java
│ │ │ ├── ApplicationContextEvent.java
│ │ │ ├── ApplicationEventMulticaster.java
│ │ │ ├── ContextClosedEvent.java
│ │ │ ├── ContextRefreshedEvent.java
│ │ │ └── SimpleApplicationEventMulticaster.java
│ │ ├── support
│ │ │ ├── AbstractApplicationContext.java
│ │ │ ├── AbstractRefreshableApplicationContext.java
│ │ │ ├── AbstractXmlApplicationContext.java
│ │ │ ├── ApplicationContextAwareProcessor.java
│ │ │ └── ClassPathXmlApplicationContext.java
│ │ ├── ApplicationContext.java
│ │ ├── ApplicationContextAware.java
│ │ ├── ApplicationEvent.java
│ │ ├── ApplicationEventPublisher.java
│ │ ├── ApplicationListener.java
│ │ └── ConfigurableApplicationContext.java
│ ├── core.io
│ │ ├── ClassPathResource.java
│ │ ├── DefaultResourceLoader.java
│ │ ├── FileSystemResource.java
│ │ ├── Resource.java
│ │ ├── ResourceLoader.java
│ │ └── UrlResource.java
│ ├── stereotype
│ │ └── Component.java
│ └── utils
│ └── ClassUtils.java
└── test
└── java
└── cn.bugstack.springframework.test
├── bean
│ ├── IUserService.java
│ └── UserService.java
└── ApiTest.java
工程原始碼：公眾號「bugstack蟲洞棧」，回覆：Spring 專欄，獲取完整原始碼
在Bean的生命週期中自動載入包掃描註冊Bean物件和設定佔位符屬性的類關係，如圖 14-2
- 整個類的關係結構來看，其實涉及的內容並不多，主要包括的就是 xml 解析類 XmlBeanDefinitionReader 對 ClassPathBeanDefinitionScanner#doScan 的使用。
- 在 doScan 方法中處理所有指定路徑下新增了註解的類，拆解出類的資訊：名稱、作用範圍等，進行建立 BeanDefinition 好用於 Bean 物件的註冊操作。
- PropertyPlaceholderConfigurer 目前看上去像一塊單獨的內容，後續會把這塊的內容與自動載入 Bean 物件進行整合，也就是可以在註解上使用佔位符配置一些在配置檔案裡的屬性資訊。
2. 處理佔位符配置
cn.bugstack.springframework.beans.factory.PropertyPlaceholderConfigurer
public class PropertyPlaceholderConfigurer implements BeanFactoryPostProcessor {
/**
* Default placeholder prefix: {@value}
*/
public static final String DEFAULT_PLACEHOLDER_PREFIX = "${";
/**
* Default placeholder suffix: {@value}
*/
public static final String DEFAULT_PLACEHOLDER_SUFFIX = "}";
private String location;
@Override
public void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory) throws BeansException {
// 載入屬性檔案
try {
DefaultResourceLoader resourceLoader = new DefaultResourceLoader();
Resource resource = resourceLoader.getResource(location);
Properties properties = new Properties();
properties.load(resource.getInputStream());
String[] beanDefinitionNames = beanFactory.getBeanDefinitionNames();
for (String beanName : beanDefinitionNames) {
BeanDefinition beanDefinition = beanFactory.getBeanDefinition(beanName);
PropertyValues propertyValues = beanDefinition.getPropertyValues();
for (PropertyValue propertyValue : propertyValues.getPropertyValues()) {
Object value = propertyValue.getValue();
if (!(value instanceof String)) continue;
String strVal = (String) value;
StringBuilder buffer = new StringBuilder(strVal);
int startIdx = strVal.indexOf(DEFAULT_PLACEHOLDER_PREFIX);
int stopIdx = strVal.indexOf(DEFAULT_PLACEHOLDER_SUFFIX);
if (startIdx != -1 && stopIdx != -1 && startIdx < stopIdx) {
String propKey = strVal.substring(startIdx + 2, stopIdx);
String propVal = properties.getProperty(propKey);
buffer.replace(startIdx, stopIdx + 1, propVal);
propertyValues.addPropertyValue(new PropertyValue(propertyValue.getName(), buffer.toString()));
}
}
}
} catch (IOException e) {
throw new BeansException("Could not load properties", e);
}
}
public void setLocation(String location) {
this.location = location;
}
}
- 依賴於 BeanFactoryPostProcessor 在 Bean 生命週期的屬性，可以在 Bean 物件例項化之前，改變屬性資訊。所以這裡通過實現 BeanFactoryPostProcessor 介面，完成對配置檔案的載入以及摘取佔位符中的在屬性檔案裡的配置。
- 這樣就可以把提取到的配置資訊放置到屬性配置中了，
buffer.replace(startIdx, stopIdx + 1, propVal); propertyValues.addPropertyValue
3. 定義攔截註解
cn.bugstack.springframework.context.annotation.Scope
@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Scope {
String value() default "singleton";
}
- 用於配置作用域的自定義註解，方便通過配置Bean物件註解的時候，拿到Bean物件的作用域。不過一般都使用預設的 singleton
cn.bugstack.springframework.stereotype.Component
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Component {
String value() default "";
}
- Component 自定義註解大家都非常熟悉了，用於配置到 Class 類上的。除此之外還有 Service、Controller，不過所有的處理方式基本一致，這裡就只展示一個 Component 即可。
4. 處理物件掃描裝配
cn.bugstack.springframework.context.annotation.ClassPathScanningCandidateComponentProvider
public class ClassPathScanningCandidateComponentProvider {
public Set<BeanDefinition> findCandidateComponents(String basePackage) {
Set<BeanDefinition> candidates = new LinkedHashSet<>();
Set<Class<?>> classes = ClassUtil.scanPackageByAnnotation(basePackage, Component.class);
for (Class<?> clazz : classes) {
candidates.add(new BeanDefinition(clazz));
}
return candidates;
}
}
- 這裡先要提供一個可以通過配置路徑
basePackage=cn.bugstack.springframework.test.bean，解析出 classes 資訊的工具方法 findCandidateComponents，通過這個方法就可以掃描到所有 @Component 註解的 Bean 物件了。
cn.bugstack.springframework.context.annotation.ClassPathBeanDefinitionScanner
public class ClassPathBeanDefinitionScanner extends ClassPathScanningCandidateComponentProvider {
private BeanDefinitionRegistry registry;
public ClassPathBeanDefinitionScanner(BeanDefinitionRegistry registry) {
this.registry = registry;
}
public void doScan(String... basePackages) {
for (String basePackage : basePackages) {
Set<BeanDefinition> candidates = findCandidateComponents(basePackage);
for (BeanDefinition beanDefinition : candidates) {
// 解析 Bean 的作用域 singleton、prototype
String beanScope = resolveBeanScope(beanDefinition);
if (StrUtil.isNotEmpty(beanScope)) {
beanDefinition.setScope(beanScope);
}
registry.registerBeanDefinition(determineBeanName(beanDefinition), beanDefinition);
}
}
}
private String resolveBeanScope(BeanDefinition beanDefinition) {
Class<?> beanClass = beanDefinition.getBeanClass();
Scope scope = beanClass.getAnnotation(Scope.class);
if (null != scope) return scope.value();
return StrUtil.EMPTY;
}
private String determineBeanName(BeanDefinition beanDefinition) {
Class<?> beanClass = beanDefinition.getBeanClass();
Component component = beanClass.getAnnotation(Component.class);
String value = component.value();
if (StrUtil.isEmpty(value)) {
value = StrUtil.lowerFirst(beanClass.getSimpleName());
}
return value;
}
}
- ClassPathBeanDefinitionScanner 是繼承自 ClassPathScanningCandidateComponentProvider 的具體掃描包處理的類，在 doScan 中除了獲取到掃描的類資訊以後，還需要獲取 Bean 的作用域和類名，如果不配置類名基本都是把首字母縮寫。
5. 解析xml中呼叫掃描
cn.bugstack.springframework.beans.factory.xml.XmlBeanDefinitionReader
public class XmlBeanDefinitionReader extends AbstractBeanDefinitionReader {
protected void doLoadBeanDefinitions(InputStream inputStream) throws ClassNotFoundException, DocumentException {
SAXReader reader = new SAXReader();
Document document = reader.read(inputStream);
Element root = document.getRootElement();
// 解析 context:component-scan 標籤，掃描包中的類並提取相關資訊，用於組裝 BeanDefinition
Element componentScan = root.element("component-scan");
if (null != componentScan) {
String scanPath = componentScan.attributeValue("base-package");
if (StrUtil.isEmpty(scanPath)) {
throw new BeansException("The value of base-package attribute can not be empty or null");
}
scanPackage(scanPath);
}
// ... 省略其他
// 註冊 BeanDefinition
getRegistry().registerBeanDefinition(beanName, beanDefinition);
}
private void scanPackage(String scanPath) {
String[] basePackages = StrUtil.splitToArray(scanPath, ',');
ClassPathBeanDefinitionScanner scanner = new ClassPathBeanDefinitionScanner(getRegistry());
scanner.doScan(basePackages);
}
}
- 關於 XmlBeanDefinitionReader 中主要是在載入配置檔案後，處理新增的自定義配置屬性
component-scan，解析後呼叫 scanPackage 方法，其實也就是我們在 ClassPathBeanDefinitionScanner#doScan 功能。 - 另外這裡需要注意，為了可以方便的載入和解析xml，XmlBeanDefinitionReader 已經全部替換為 dom4j 的方式進行解析處理。
五、測試
1. 事先準備
@Component("userService")
public class UserService implements IUserService {
private String token;
public String queryUserInfo() {
try {
Thread.sleep(new Random(1).nextInt(100));
} catch (InterruptedException e) {
e.printStackTrace();
}
return "小傅哥，100001，深圳";
}
public String register(String userName) {
try {
Thread.sleep(new Random(1).nextInt(100));
} catch (InterruptedException e) {
e.printStackTrace();
}
return "註冊使用者：" + userName + " success！";
}
@Override
public String toString() {
return "UserService#token = { " + token + " }";
}
public String getToken() {
return token;
}
public void setToken(String token) {
this.token = token;
}
}
- 給 UserService 類新增一個自定義註解
@Component("userService")和一個屬性資訊String token。這是為了分別測試包掃描和佔位符屬性。
2. 屬性配置檔案
token=RejDlI78hu223Opo983Ds
- 這裡配置一個 token 的屬性資訊，用於通過佔位符的方式進行獲取
3. spring.xml 配置物件
spring-property.xml
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:context="http://www.springframework.org/schema/context"
xsi:schemaLocation="http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans.xsd
http://www.springframework.org/schema/context">
<bean class="cn.bugstack.springframework.beans.factory.PropertyPlaceholderConfigurer">
<property name="location" value="classpath:token.properties"/>
</bean>
<bean id="userService" class="cn.bugstack.springframework.test.bean.UserService">
<property name="token" value="${token}"/>
</bean>
</beans>
- 載入
classpath:token.properties設定佔位符屬性值${token}
spring-scan.xml
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:context="http://www.springframework.org/schema/context"
xsi:schemaLocation="http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans.xsd
http://www.springframework.org/schema/context">
<context:component-scan base-package="cn.bugstack.springframework.test.bean"/>
</beans>
- 新增
component-scan屬性，設定包掃描根路徑
4. 單元測試(佔位符)
@Test
public void test_property() {
ClassPathXmlApplicationContext applicationContext = new ClassPathXmlApplicationContext("classpath:spring-property.xml");
IUserService userService = applicationContext.getBean("userService", IUserService.class);
System.out.println("測試結果：" + userService);
}
測試結果
測試結果：UserService#token = { RejDlI78hu223Opo983Ds }
Process finished with exit code 0
- 通過測試結果可以看到 UserService 中的 token 屬性已經通過佔位符的方式設定進去配置檔案裡的
token.properties的屬性值了。
5. 單元測試(包掃描)
@Test
public void test_scan() {
ClassPathXmlApplicationContext applicationContext = new ClassPathXmlApplicationContext("classpath:spring-scan.xml");
IUserService userService = applicationContext.getBean("userService", IUserService.class);
System.out.println("測試結果：" + userService.queryUserInfo());
}
測試結果
測試結果：小傅哥，100001，深圳
Process finished with exit code 0
- 通過這個測試結果可以看出來，現在使用註解的方式就可以讓 Class 註冊完成 Bean 物件了。
六、總結
- 通過整篇的內容實現可以看出來，目前的功能新增其實已經不復雜了，都是在 IOC 和 AOP 核心的基礎上來補全功能。這些補全的功能也是在完善 Bean 的生命週期，讓整個功能使用也越來越容易。
- 在你不斷的實現著 Spring 的各項功能時，也可以把自己在平常使用 Spring 的一些功能想法融入進來，比如像 Spring 是如何動態切換資料來源的，執行緒池是怎麼提供配置的，這些內容雖然不是最基礎的核心範圍，但也非常重要。
- 可能有些時候這些類實現的內容對新人來說比較多，可以一點點動手實現逐步理解，在把一些稍微較有難度的內容實現後，其實後面也就沒有那麼難理解了。