在面向对象开发中,通常会遇到这样一个问题,我们知道一个算法所需的关键步骤,并确定了这些步骤的执行顺序,但是某些步骤的具体实现是未知的,或者说某些步骤的实现是会随着环境的变化而改变的,例如,执行程序的流程大致如下:
1.检查代码的正确性;
2.链接相关的类库;
3.编译相关的代码;
4.执行程序;
对于不同的程序设计语言,上述4个步骤是不一样的,但是,它们的执行流程是固定的,这类问题的解决方案就是模板方法模式。
模板方法模式的定义
定义一个操作中的算法的框架,而将这一些步骤延迟到子类中,使得子类可以不改变一个算法的结构即可重新定义该算法的某些步骤。
模板方法模式的使用场景
1.多个子类有公有的方法,并且逻辑基本相同时。
2.重要、复杂的算法,可以把核心算法设计为模板方法,周边的相关细节功能则由各个子类去实现。
3.重构时,模板方法模式是一个经常使用的模式,把相同的代码抽取到父类中,然后通过钩子函数约束其行为。
模板方法模式的UML图
模板方法实际上是封装了一个固定流程,就像是一套执行模板一样,第一步该做什么,第二步该做什么都已经在抽象类中定义好了。而子类可以有不同的算法实现,在框架不被修改的情况下实现某些步骤的算法替换。
模板设计模式简单Demo
package templete.gome.com.templetedemo;
import android.util.Log;
/**
* Created by ying.zhang on 2018/8/7.
* 抽象Computer
*/
public abstract class AbstractComputer {
protected static final String TAG = "zy";
protected void powerOn() {
Log.v(TAG, "开启电源");
}
protected void checkHardware() {
Log.v(TAG, "硬件检查");
}
protected void loadOS() {
Log.v(TAG, "载入操作系统");
}
protected void login() {
Log.v(TAG, "计算机无验证,直接进入系统");
}
/**
* 启动计算机方法、步骤固定为开启电源、系统检查、加载操作系统、用户登录
* 方法为final,防止算法框架被覆写
*/
public final void startUp() {
Log.v(TAG, "-----------开机 START--------------");
powerOn();
checkHardware();
loadOS();
login();
Log.v(TAG, "------------关机 END--------------");
}
}
package templete.gome.com.templetedemo;
import android.util.Log;
/**
* Created by ying.zhang on 2018/8/7.
*/
public class CoderComputer extends AbstractComputer {
@Override
protected void login() {
Log.v(TAG, "程序员只需要进行用户和密码登录验证就可以了");
}
}
package templete.gome.com.templetedemo;
import android.util.Log;
/**
* Created by ying.zhang on 2018/8/7.
*/
public class MilitaryComputer extends AbstractComputer {
@Override
protected void checkHardware() {
super.checkHardware();
Log.v(TAG, "检查硬件防火墙");
}
@Override
protected void login() {
Log.v(TAG,"进行指纹识别等复杂的用户验证");
}
}
public class MainActivity extends AppCompatActivity {
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
AbstractComputer comp = new CoderComputer();
comp.startUp();
comp = new MilitaryComputer();
comp.startUp();
}
}
Log分析:
V/zy: -----------开机 START--------------
V/zy: 开启电源
V/zy: 硬件检查
V/zy: 载入操作系统
V/zy: 程序员只需要进行用户和密码登录验证就可以了
V/zy: ------------关机 END--------------
V/zy: -----------开机 START--------------
V/zy: 开启电源
V/zy: 硬件检查
V/zy: 检查硬件防火墙
V/zy: 载入操作系统
V/zy: 进行指纹识别等复杂的用户验证
V/zy: ------------关机 END--------------
Android源码中的模板方法模式
在Android中,AsyncTask是比较常用的一种类型,这个类就使用了模板方法模式。这里只分析在该类中使用的模板方法模式。
在使用AsyncTask时,我们都知道把耗时方法放在doInBackground(Params... params) 中,在doInBackgroud之前,如果还想做一些类似初始化的操作,可以把方法写在onPreExecute 中,当doInBackground 执行完毕后,则会执行 onPostExecute 方法,而我们只需要构建AsyncTask对象,然后执行execute方法即可。
它的整个执行过程其实是一个框架,具体的是实现都需要在子类中完成,而且它执行的算法框架是固定,调用execute后会依次执行onPreExecute 、doInBackground 、doInBackground 方法,当然也可以通过onProgressUpdate 来更新进度。
public abstract class AsyncTask<Params, Progress, Result> {
}
#AsyncTask(Android 8.1)
@MainThread
public final AsyncTask<Params, Progress, Result> execute(Params... params) {
return executeOnExecutor(sDefaultExecutor, params);
}
#AsyncTask(Android 8.1)
public static final Executor SERIAL_EXECUTOR = new SerialExecutor();
private static volatile Executor sDefaultExecutor = SERIAL_EXECUTOR;
#AsyncTask(Android 8.1)
private static class SerialExecutor implements Executor {
final ArrayDeque<Runnable> mTasks = new ArrayDeque<Runnable>();
Runnable mActive;
public synchronized void execute(final Runnable r) {
mTasks.offer(new Runnable() {
public void run() {
try {
r.run();
} finally {
scheduleNext();
}
}
});
if (mActive == null) {
scheduleNext();
}
}
protected synchronized void scheduleNext() {
if ((mActive = mTasks.poll()) != null) {
THREAD_POOL_EXECUTOR.execute(mActive);
}
}
}
#AsyncTask(Android 8.1)
/**
* An {@link Executor} that can be used to execute tasks in parallel.
*/
public static final Executor THREAD_POOL_EXECUTOR;
static {
ThreadPoolExecutor threadPoolExecutor = new ThreadPoolExecutor(
CORE_POOL_SIZE, MAXIMUM_POOL_SIZE, KEEP_ALIVE_SECONDS, TimeUnit.SECONDS, sPoolWorkQueue, sThreadFactory);
threadPoolExecutor.allowCoreThreadTimeOut(true);
THREAD_POOL_EXECUTOR = threadPoolExecutor;
}
#AsyncTask(Android 8.1)
private static final int CPU_COUNT = Runtime.getRuntime().availableProcessors();
// We want at least 2 threads and at most 4 threads in the core pool,
// preferring to have 1 less than the CPU count to avoid saturating(饱和)
// the CPU with background work
private static final int CORE_POOL_SIZE = Math.max(2, Math.min(CPU_COUNT - 1, 4));
private static final int MAXIMUM_POOL_SIZE = CPU_COUNT * 2 + 1;
private static final int KEEP_ALIVE_SECONDS = 30;
private static final BlockingQueue<Runnable> sPoolWorkQueue =
new LinkedBlockingQueue<Runnable>(128);
#AsyncTask(Android 8.1)
@MainThread
public final AsyncTask<Params, Progress, Result> executeOnExecutor(Executor exec,
Params... params) {
if (mStatus != Status.PENDING) {
switch (mStatus) {
case RUNNING:
throw new IllegalStateException("Cannot execute task:"
+ " the task is already running.");
case FINISHED:
throw new IllegalStateException("Cannot execute task:"
+ " the task has already been executed "
+ "(a task can be executed only once)");
}
}
mStatus = Status.RUNNING;
onPreExecute();
mWorker.mParams = params;
exec.execute(mFuture);
return this;
}
/**
* Indicates the current status of the task. Each status will be set only once
* during the lifetime of a task.
*/
public enum Status {
/**
* Indicates that the task has not been executed yet.
*/
PENDING,
/**
* Indicates that the task is running.
*/
RUNNING,
/**
* Indicates that {@link AsyncTask#onPostExecute} has finished.
*/
FINISHED,
}
execute方法是一个final方法,它调用了executeOnExecutor方法,在该方法中会判断该任务的状态,如果不是PENDING状态则抛出异常,这也解释了为什么AsyncTask只能被执行一次,因为AsyncTask的RUNNING和FINISHED状态都会抛出异常,因此,每次使用AsyncTask时都需要重新创建一个对象。
因为在executeOnExecutor方法中首先执行了onPreExecute()方法,因为AsyncTask的要求是需要在UI线程调用execute方法,因此,onPreExecute方法也执行在UI线程,然后将params参数传递给mWorker对象的mParams字段,并且执行了exec.execute(mFuture)方法。
public abstract class AsyncTask<Params, Progress, Result> {
private final WorkerRunnable<Params, Result> mWorker;
private final FutureTask<Result> mFuture;
}
mWorker和mFuture又是什么呢?其实mWorker只是实现了Callable接口,并添加了一个参数数组字段。
#AsyncTask(Android 8.1)
private final AtomicBoolean mTaskInvoked = new AtomicBoolean();(线程安全)
/**
* Creates a new asynchronous task. This constructor must be invoked on the UI thread.
*
* @hide
*/
public AsyncTask(@Nullable Looper callbackLooper) {
mHandler = callbackLooper == null || callbackLooper == Looper.getMainLooper()
? getMainHandler()
: new Handler(callbackLooper);
//构建一个Worker对象
mWorker = new WorkerRunnable<Params, Result>() {
public Result call() throws Exception {
mTaskInvoked.set(true);
Result result = null;
try {
Process.setThreadPriority(Process.THREAD_PRIORITY_BACKGROUND);
//noinspection unchecked
//调用doInBackground方法,并且将结果传递出去。
result = doInBackground(mParams);
Binder.flushPendingCommands();
} catch (Throwable tr) {
mCancelled.set(true);
throw tr;
} finally {
//将结果传递出去
postResult(result);
}
return result;
}
};
mFuture = new FutureTask<Result>(mWorker) {
@Override
protected void done() {
try {
postResultIfNotInvoked(get());
} catch (InterruptedException e) {
android.util.Log.w(LOG_TAG, e);
} catch (ExecutionException e) {
throw new RuntimeException("An error occurred while executing doInBackground()",
e.getCause());
} catch (CancellationException e) {
postResultIfNotInvoked(null);
}
}
};
}
#AsyncTask(Android 8.1)
private void postResultIfNotInvoked(Result result) {
final boolean wasTaskInvoked = mTaskInvoked.get();
if (!wasTaskInvoked) {
postResult(result);
}
}
#AsyncTask(Android 8.1)
private static abstract class WorkerRunnable<Params, Result> implements Callable<Result> {
Params[] mParams;
}
D:\AndroidSdk\sources\android-26\java\util\concurrent\Callable.java
JDK中的Callable
package java.util.concurrent;
@FunctionalInterface
public interface Callable<V> {
V call() throws Exception;
}
#AsyncTask(Android 8.1)
private Result postResult(Result result) {
@SuppressWarnings("unchecked")
Message message = getHandler().obtainMessage(MESSAGE_POST_RESULT,
new AsyncTaskResult<Result>(this, result));//这边传入的this就是一个AsyncTask实例
message.sendToTarget();
return result;
}
简单地说就是mFuture包装了这个mWorker对象,在这个mFuture对象的run函数中又会调用mWorker对象的call方法,在call方法中又调用了doInBackgroud函数。因为mFuture提交给了线程池来执行,所以,使得doInBackgroud执行在非UI线程。得到doInBackgroud的结果后,最后通过postResult传递结果给UI线程,我们再看看postResult的实现。
#AsyncTask(Android 8.1)
private Result postResult(Result result) {
@SuppressWarnings("unchecked")
Message message = getHandler().obtainMessage(MESSAGE_POST_RESULT,
new AsyncTaskResult<Result>(this, result));
message.sendToTarget();
return result;
}
private Handler getHandler() {
return mHandler;
}
//实际执行的是 getMainHandler()。
private static Handler getMainHandler() {
synchronized (AsyncTask.class) {
if (sHandler == null) {
sHandler = new InternalHandler(Looper.getMainLooper());
}
return sHandler;
}
}
private static class InternalHandler extends Handler {
public InternalHandler(Looper looper) {
super(looper);
}
@SuppressWarnings({"unchecked", "RawUseOfParameterizedType"})
@Override
public void handleMessage(Message msg) {
AsyncTaskResult<?> result = (AsyncTaskResult<?>) msg.obj;
switch (msg.what) {
case MESSAGE_POST_RESULT:
// There is only one result
//调用AsyncTask的finish方法
result.mTask.finish(result.mData[0]);
break;
case MESSAGE_POST_PROGRESS:
result.mTask.onProgressUpdate(result.mData);
break;
}
}
}
@SuppressWarnings({"RawUseOfParameterizedType"})
private static class AsyncTaskResult<Data> {
final AsyncTask mTask;
final Data[] mData;
AsyncTaskResult(AsyncTask task, Data... data) {
mTask = task;
mData = data;
}
}
D:\AndroidSdk\sources\android-26\java\util\concurrent\FutureTask.java
public void run() {
if (state != NEW ||
!U.compareAndSwapObject(this, RUNNER, null, Thread.currentThread()))
return;
try {
Callable<V> c = callable;
if (c != null && state == NEW) {
V result;
boolean ran;
try {
result = c.call();
ran = true;
} catch (Throwable ex) {
result = null;
ran = false;
setException(ex);
}
if (ran)
set(result);
}
} finally {
// runner must be non-null until state is settled to
// prevent concurrent calls to run()
runner = null;
// state must be re-read after nulling runner to prevent
// leaked interrupts
int s = state;
if (s >= INTERRUPTING)
handlePossibleCancellationInterrupt(s);
}
}
D:\AndroidSdk\sources\android-26\java\util\concurrent\FutureTask.java
public FutureTask(Callable<V> callable) {
if (callable == null)
throw new NullPointerException();
this.callable = callable;
this.state = NEW; // ensure visibility of callable
}
private void finish(Result result) {
if (isCancelled()) {
onCancelled(result);
} else {
onPostExecute(result);
}
mStatus = Status.FINISHED;
}
从程序中可以看到,postResult就是把一个消息(msg.what == MESSAGE_POST_RESULT)发送给sHandler,sHandler为InternalHandler类型,当InternalHandler接收到MESSAGE_POST_RESULT类型的消息时就会调用 result.mTask.finish(result.mData[0]);方法。我们看到result为AsyncTaskResult类型。
@SuppressWarnings({"RawUseOfParameterizedType"})
private static class AsyncTaskResult<Data> {
final AsyncTask mTask;
final Data[] mData;
AsyncTaskResult(AsyncTask task, Data... data) {
mTask = task;
mData = data;
}
}
从上述程序可以看到mTask就是AsyncTask对象,调用AsyncTask对象的finish方法时又调用onPostExecute方法,整个执行过程就完成了。
总之,execute方法内部封装了onPreExecute、doInBackgroud、onPostExecute这个逻辑流程,用户可以根据需求再覆写这几个方法,使得用户可以很方便地使用异步任务来完成耗时操作以及更新UI,这其实是通过线程池来完成耗时任务,得到结果之后,通过Handler将结果传递给UI线程来执行。
参考《Android源码设计模式》