从框架源码学设计模式-模板方法模式

2023-03-11 10:32:48

一、模板方法模式介绍

定义：在一个方法中定义一个算法的骨架，而将一些步骤延迟到子类中。模板方法使得子类可以在不改变算法结构的情况下，重新定义算法中的某些步骤。

二、结构和代码

package com.wjh.Mytest.templateMethod;

public class Parent {
	protected void template(){
		start();
		commonParts();
		end();
	}
	public void start(){

	}

	private void commonParts(){
		
	}

	public void end(){

	}
}

package com.wjh.Mytest.templateMethod;

public class Child extends Parent {

	@Override
	public void start() {
		//todo 添加子类的实现代码

	}

	@Override
	public void end() {
		//todo 添加子类的实现代码
	}
}

三、使用场景

1.有多个子类共有的方法，且逻辑相同。
2.流程固定，部分可自定义
3.重要的、复杂的方法，可以考虑作为模板方法。

四、源码中的应用

4.1 Spring XML读取bean源码中的应用

Spring在通过XML读取bean的源码中用到了DefaultBeanDefinitionDocumentReader这个类，这个类的作用是解析XMl后注册bean。在这个类中我们可以看到模板方法模式的身影。代码如下：

protected void doRegisterBeanDefinitions(Element root) {
		BeanDefinitionParserDelegate parent = this.delegate;
		this.delegate = createDelegate(getReaderContext(), root, parent);

		if (this.delegate.isDefaultNamespace(root)) {
			String profileSpec = root.getAttribute(PROFILE_ATTRIBUTE);
			if (StringUtils.hasText(profileSpec)) {
				String[] specifiedProfiles = StringUtils.tokenizeToStringArray(
						profileSpec, BeanDefinitionParserDelegate.MULTI_VALUE_ATTRIBUTE_DELIMITERS);
				// We cannot use Profiles.of(...) since profile expressions are not supported
				// in XML config. See SPR-12458 for details.
				if (!getReaderContext().getEnvironment().acceptsProfiles(specifiedProfiles)) {
					if (logger.isDebugEnabled()) {
						logger.debug("Skipped XML bean definition file due to specified profiles [" + profileSpec +
								"] not matching: " + getReaderContext().getResource());
					}
					return;
				}
			}
		}

                //解析前处理，留给子类实现
		preProcessXml(root);
		parseBeanDefinitions(root, this.delegate);//解析bean并注册
                //解析后处理，留给子类实现
		postProcessXml(root);

		this.delegate = parent;
	}

上面代码中preProcessXml(root)和postProcessXml(root)中的代码里面是空的，为什么？
在DefaultBeanDefinitionDocumentReader类中的方法定义执行过程，如果我们需要在bean解析前后做些什么事情的话，我们可以继承DefaultBeanDefinitionDocumentReader类并重写preProcessXml或者postProcessXml方法。

4.2 Spring IOC 容器初始化

在Spring IOC 容器初始化的时候，我们看一下抽象类AbstractApplicationContext中的refresh方法，它就是一个模板方法，里面调用了一系列方法，有已实现的具体方法，有未实现的抽象方法，也有空的钩子方法。我们在AbstractApplicationContext的实现类中如 GenericApplicationContext可以看到对这些抽象方法和钩子方法的重写。

@Override
	public void refresh() throws BeansException, IllegalStateException {
		synchronized (this.startupShutdownMonitor) {
			prepareRefresh();
                        //obtainFreshBeanFactory()方法内部调用了两个抽象方法refreshBeanFactory()和getBeanFactory()
                        //具体要用到哪一种beanFactory的控制权交给了子类
			ConfigurableListableBeanFactory beanFactory = obtainFreshBeanFactory();
			prepareBeanFactory(beanFactory);
			try {
                                //刷新后对beanFactory进行处理，留给子类实现
				postProcessBeanFactory(beanFactory);
				invokeBeanFactoryPostProcessors(beanFactory);
				registerBeanPostProcessors(beanFactory);
				initMessageSource();
				initApplicationEventMulticaster();
                                //空的钩子方法，可用于其他类的初始化，留给子类实现
				onRefresh();
				registerListeners();
				finishBeanFactoryInitialization(beanFactory);
				finishRefresh();
			}

			catch (BeansException ex) {
				if (logger.isWarnEnabled()) {
					logger.warn("Exception encountered during context initialization - " +
							"cancelling refresh attempt: " + ex);
				}
				destroyBeans();
				cancelRefresh(ex);
				throw ex;
			}

			finally {
				resetCommonCaches();
			}
		}
	}

GenericApplicationContext类中的一些方法重写

	@Override
	public final ConfigurableListableBeanFactory getBeanFactory() {
		return this.beanFactory;
	}
	@Override
	protected final void refreshBeanFactory() throws IllegalStateException {
		if (!this.refreshed.compareAndSet(false, true)) {
			throw new IllegalStateException(
					"GenericApplicationContext does not support multiple refresh attempts: just call 'refresh' once");
		}
		this.beanFactory.setSerializationId(getId());
	}

4.3 Servlet中的模板方法模式

4.4 Mybatis BaseExecutor接口中的模板方法模式

五、总结

1.父类中包含一个模板方法，方法中定义了一套执行过程
2.子类继承父类重写过程中的部分方法
3.为防止恶意操作，模板方法可以加上final关键词。
4.一个模板方法，里面可以调用了一系列方法，如已实现的具体方法，未实现的抽象方法，有空的钩子方法

六、参考

Spring源码深度解析（第2版）
runoob.com模板模式

码农公寓