01-16-15 模板方法模式 - Activity生命周期的模板方法

01-16-15 模板方法模式 - Activity生命周期的模板方法模式定义模板方法模式Template Method Pattern属于行为型设计模式其核心思想是在父类中定义一个算法的骨架将某些步骤的具体实现延迟到子类。子类在不改变算法整体结构的前提下可以重新定义算法中的某些特定步骤。解决的问题当多个类拥有相似的执行流程但各步骤的具体实现存在差异时直接在每个类中重复编写流程控制逻辑会导致大量代码冗余。模板方法模式将公共流程提取到父类差异化的步骤声明为抽象方法或钩子方法由子类各自实现。类图说明┌─────────────────────────────┐ │ AbstractClass │ │─────────────────────────────│ │ templateMethod() [final] │ ← 定义算法骨架不可被覆写 │ # step1() [abstract]│ ← 抽象步骤子类必须实现 │ # step2() [abstract]│ │ # hook() [virtual] │ ← 钩子方法子类可选覆写 └──────────┬──────────────────┘ │ extends ┌─────┴──────┐ │ │ ┌────┴────┐ ┌───┴─────┐ │ConcreteA│ │ConcreteB│ │─────────│ │─────────│ │# step1()│ │# step1()│ │# step2()│ │# step2()│ │# hook() │ │ │ ← B 不覆写 hook使用默认行为 └─────────┘ └─────────┘模式中的三类方法模板方法定义算法骨架通常声明为final防止子类篡改流程抽象方法流程中的必要步骤子类必须提供实现钩子方法Hook提供默认实现通常为空子类可选择性覆写以扩展行为Android源码中的实现案例一Activity 生命周期的模板方法源码路径frameworks/base/core/java/android/app/Activity.javaActivity 的生命周期管理是模板方法模式最经典的应用。Activity类通过performXxx()系列方法定义了生命周期的执行流程而onXxx()系列方法则作为模板步骤交由子类实现。// frameworks/base/core/java/android/app/Activity.javapublicclassActivityextendsContextThemeWrapperimplementsLayoutInflater.Factory2,Window.Callback,KeyEvent.Callback,View.OnCreateContextMenuListener,ComponentCallbacks2{// ---- 模板方法performCreate ----// 由 Instrumentation 调用定义了 create 阶段的完整流程// 声明为 final子类无法改变执行顺序finalvoidperformCreate(Bundleicicle){performCreate(icicle,null);}finalvoidperformCreate(Bundleicicle,PersistableBundlepersistentState){// 1. 分发 pre-create 回调给已注册的 ActivityLifecycleCallbacksdispatchActivityPreCreated(icicle);// 2. 恢复之前保存的状态如 Fragment 状态restoreHasCurrentPermissionRequest(icicle);// 3. 调用子类实现的 onCreate —— 这是留给子类的抽象步骤if(persistentState!null){onCreate(icicle,persistentState);}else{onCreate(icicle);}// 4. 将 Activity 的写回状态标记为已完成mActivityTransitionState.readState(icicle);// 5. 执行 Fragment 的 performCreatemFragments.dispatchActivityCreated();// 6. 分发 post-create 回调dispatchActivityPostCreated(icicle);}// ---- 子类实现的步骤 ----// onCreate 并非严格意义上的 abstract因为 Activity 不是 abstract 类// 但其设计意图与抽象方法一致子类几乎必须覆写此方法protectedvoidonCreate(NullableBundlesavedInstanceState){// 默认实现恢复 Loader、Fragment 等框架级状态if(mLastNonConfigurationInstances!null){mFragments.restoreLoaderNonConfig(mLastNonConfigurationInstances.loaders);}// ...省略部分代码mFragments.dispatchCreate();dispatchActivityCreated(savedInstanceState);// ...}// ---- 模板方法performResume ----finalvoidperformResume(booleanfollowedByPause,Stringreason){dispatchActivityPreResumed();// 1. 先执行 performRestart内含 onRestart 的调用performRestart(true/* start */,reason);// 2. Fragment 的 dispatchResumemFragments.execPendingActions();// 3. 调用子类的 onResumemInstrumentation.callActivityOnResume(this);// 4. 分发 post-resume 回调dispatchActivityPostResumed();}// 子类覆写的 onResumeprotectedvoidonResume(){// 默认实现通知 Application 层的 ActivityLifecycleCallbacksdispatchActivityResumed();mActivityTransitionState.onResume(this);notifyContentCaptureManagerIfNeeded(CONTENT_CAPTURE_RESUME);mCalledtrue;}}关键设计分析performCreate()/performResume()声明为final确保子类无法跳过 Fragment 分发、Lifecycle 回调等框架逻辑onCreate()/onResume()是开放给子类的步骤方法子类通过super.onXxx()保留父类默认行为再添加自定义逻辑mCalled标志位用于检测子类是否调用了super.onXxx()未调用则抛出SuperNotCalledException这是模板方法模式中一种防御性编程技巧案例二View.draw() 的绘制模板源码路径frameworks/base/core/java/android/view/View.javaView.draw(Canvas)方法定义了 View 绘制的完整流程包含固定的绘制步骤和可由子类覆写的钩子方法。// frameworks/base/core/java/android/view/View.javapublicclassViewimplementsDrawable.Callback,KeyEvent.Callback,AccessibilityEventSource{// 模板方法定义绘制流程的六个步骤publicvoiddraw(Canvascanvas){finalintprivateFlagsmPrivateFlags;mPrivateFlags(privateFlags~PFLAG_DIRTY_MASK)|PFLAG_DRAWN;/* * 绘制流程按以下顺序执行 * * 1. 绘制背景 * 2. 如有必要保存 canvas 的 layer 以备 fading 效果 * 3. 绘制 View 自身内容onDraw * 4. 绘制子 ViewdispatchDraw * 5. 如有必要绘制 fading edge 并恢复 layer * 6. 绘制装饰前景、滚动条等 */// Step 1绘制背景 —— 框架固定步骤intsaveCount;drawBackground(canvas);// Step 2 和 Step 5 通常可以跳过finalintviewFlagsmViewFlags;booleanhorizontalEdges(viewFlagsFADING_EDGE_HORIZONTAL)!0;booleanverticalEdges(viewFlagsFADING_EDGE_VERTICAL)!0;if(!verticalEdges!horizontalEdges){// Step 3绘制内容 —— 子类覆写的钩子方法onDraw(canvas);// Step 4绘制子 View —— ViewGroup 覆写此方法dispatchDraw(canvas);// Step 6绘制前景和装饰drawAutofilledHighlight(canvas);if(mOverlay!null!mOverlay.isEmpty()){mOverlay.getOverlayDrawable().draw(canvas);}onDrawForeground(canvas);drawDefaultFocusHighlight(canvas);return;}// ... 有 fading edge 时的完整绘制路径此处省略}// 钩子方法子类覆写以绘制自身内容// View 基类提供空实现protectedvoidonDraw(Canvascanvas){}// 钩子方法默认空实现ViewGroup 覆写以绘制子 ViewprotectedvoiddispatchDraw(Canvascanvas){}// 框架固定步骤绘制背景不允许子类覆写privatevoiddrawBackground(Canvascanvas){finalDrawablebackgroundmBackground;if(backgroundnull){return;}setBackgroundBounds();// ... 绘制背景 drawablebackground.draw(canvas);}}关键设计分析draw()方法是模板方法定义了六个绘制步骤的固定顺序onDraw()和dispatchDraw()是钩子方法子类如TextView、ImageView通过覆写onDraw()绘制各自的内容drawBackground()声明为private子类完全无法介入背景绘制流程这体现了模板方法对流程控制权的严格把控ViewGroup覆写dispatchDraw()以遍历并绘制所有子 View而叶子 View 保持默认的空实现案例三AsyncTask 的异步任务模板源码路径frameworks/base/core/java/android/os/AsyncTask.java已在 API 30 标记为 Deprecated// frameworks/base/core/java/android/os/AsyncTask.javapublicabstractclassAsyncTaskParams,Progress,Result{// 模板方法执行异步任务的完整流程// 此方法由 execute() 间接触发不可被子类直接调用privateResultdoInBackgroundInternal(Params...params){// 1. 在主线程回调 onPreExecute —— 钩子方法// 实际在 execute 中先调用此处简化表示流程// 2. 在后台线程执行核心任务 —— 抽象方法子类必须实现ResultresultdoInBackground(params);returnresult;}// 工作线程中的回调处理privatevoidfinish(Resultresult){if(isCancelled()){// 3a. 如果任务被取消回调 onCancelled —— 钩子方法onCancelled(result);}else{// 3b. 任务完成在主线程回调 onPostExecute —— 钩子方法onPostExecute(result);}mStatusStatus.FINISHED;}// 抽象方法子类必须实现在工作线程执行WorkerThreadprotectedabstractResultdoInBackground(Params...params);// 钩子方法任务执行前在主线程调用默认空实现MainThreadprotectedvoidonPreExecute(){}// 钩子方法任务完成后在主线程调用MainThreadprotectedvoidonPostExecute(Resultresult){}// 钩子方法进度更新时在主线程调用MainThreadprotectedvoidonProgressUpdate(Progress...values){}// 钩子方法任务取消时在主线程调用MainThreadprotectedvoidonCancelled(Resultresult){onCancelled();}}关键设计分析doInBackground()是唯一的抽象方法子类必须实现核心业务逻辑onPreExecute()、onPostExecute()、onProgressUpdate()都是钩子方法提供空的默认实现线程切换逻辑完全封装在框架内部通过InternalHandler在主线程分发结果子类无需关心线程调度这种设计使得开发者只需关注做什么doInBackground而怎么调度线程切换、状态管理由模板方法统一处理源码设计分析为什么 Android 选择模板方法模式Activity 生命周期场景Android 系统需要在生命周期方法的前后插入大量框架逻辑Fragment 调度、Lifecycle 回调分发、ContentCapture 通知等。如果将这些逻辑暴露给开发者不仅增加使用复杂度还可能因遗漏某个步骤导致系统异常。模板方法模式通过final的performXxx()锁定流程保证框架逻辑的执行完整性。View 绘制场景View 的绘制必须遵循严格的层次顺序背景 - 内容 - 子 View - 前景任何顺序变动都会导致渲染错误。模板方法将顺序控制权保留在View.draw()中子类只能在onDraw()中填充自身内容无法打乱绘制流程。优缺点权衡优点流程可控父类牢牢掌握算法执行顺序防止子类破坏关键流程代码复用公共逻辑只在父类编写一次所有子类自动继承扩展性好新增子类只需实现差异化步骤符合开闭原则防御性设计mCalled机制保证子类不会遗漏对super的调用缺点继承耦合子类与父类之间存在强耦合关系父类的修改可能影响所有子类类爆炸风险每个变体都需要一个新的子类在变体众多时会产生大量类调试困难算法流程分散在父类和子类中跟踪完整执行路径需要在类层级中上下跳转实战应用场景一BaseActivity 数据加载模板在实际项目中几乎所有 Activity 都遵循初始化布局 - 初始化视图 - 配置数据观察 - 加载数据的流程。将此流程抽取为模板方法可以统一管理并减少遗漏。/** * 所有 Activity 的基类定义了标准的初始化流程。 * 子类通过实现抽象方法来填充各步骤的具体内容。 */abstractclassBaseActivity:AppCompatActivity(){// 模板方法定义初始化流程子类不可覆写finaloverridefunonCreate(savedInstanceState:Bundle?){super.onCreate(savedInstanceState)setContentView(layoutResId())// Step 1初始化 Toolbar、状态栏等通用 UI 配置setupCommonUI()// Step 2子类初始化各自的 ViewinitViews(savedInstanceState)// Step 3子类配置 ViewModel 的 LiveData 观察observeData()// Step 4子类触发首次数据加载if(savedInstanceStatenull){loadInitialData()}}// 抽象方法子类必须提供布局资源 IDLayoutResprotectedabstractfunlayoutResId():Int// 抽象方法初始化视图绑定和事件监听protectedabstractfuninitViews(savedInstanceState:Bundle?)// 抽象方法配置数据观察protectedabstractfunobserveData()// 钩子方法首次加载数据默认空实现protectedopenfunloadInitialData(){}// 框架固定步骤配置通用 UI 元素privatefunsetupCommonUI(){supportActionBar?.setDisplayHomeAsUpEnabled(showBackButton())window.statusBarColorstatusBarColor()}// 钩子方法是否显示返回按钮默认显示protectedopenfunshowBackButton():Booleantrue// 钩子方法状态栏颜色默认使用主题色ColorIntprotectedopenfunstatusBarColor():IntgetColor(R.color.colorPrimaryDark)}/** * 具体子类设备列表页面 */classDeviceListActivity:BaseActivity(){privatelateinitvarbinding:ActivityDeviceListBindingprivatevalviewModel:DeviceListViewModelbyviewModels()overridefunlayoutResId()R.layout.activity_device_listoverridefuninitViews(savedInstanceState:Bundle?){bindingActivityDeviceListBinding.bind(findViewById(R.id.root_layout))binding.recyclerView.apply{layoutManagerLinearLayoutManager(thisDeviceListActivity)adapterDeviceAdapter{device-openDetail(device)}}binding.swipeRefresh.setOnRefreshListener{viewModel.refresh()}}overridefunobserveData(){viewModel.devices.observe(this){devices-(binding.recyclerView.adapterasDeviceAdapter).submitList(devices)}viewModel.loading.observe(this){isLoading-binding.swipeRefresh.isRefreshingisLoading}}overridefunloadInitialData(){viewModel.loadDevices()}overridefunshowBackButton()false// 主页不显示返回按钮privatefunopenDetail(device:Device){startActivity(DeviceDetailActivity.newIntent(this,device.id))}}场景二RecyclerView.Adapter 的 ViewHolder 绑定模板/** * 通用的 RecyclerView Adapter 基类。 * 将 ViewHolder 创建和数据绑定的模板流程固定在基类中 * 子类只需实现具体的绑定逻辑。 */abstractclassBaseAdapterT,VH:RecyclerView.ViewHolder(privatevaldiffer:AsyncListDifferT):RecyclerView.AdapterVH(){// 模板方法绑定数据到 ViewHolderfinaloverridefunonBindViewHolder(holder:VH,position:Int){valitemdiffer.currentList[position]// Step 1重置 ViewHolder 状态防止复用导致的脏数据resetHolder(holder)// Step 2绑定数据子类实现bindData(holder,item,position)// Step 3绑定点击事件holder.itemView.setOnClickListener{onItemClick?.invoke(item,position)}}// 框架固定步骤重置 ViewHolderprivatefunresetHolder(holder:VH){holder.itemView.alpha1fholder.itemView.translationX0f}// 抽象方法子类实现具体的数据绑定protectedabstractfunbindData(holder:VH,item:T,position:Int)// 钩子外部设置点击回调varonItemClick:((T,Int)-Unit)?nulloverridefungetItemCount()differ.currentList.sizefunsubmitList(list:ListT){differ.submitList(list)}}与其他模式的对比模板方法 vs 策略模式维度模板方法模式策略模式关系类型继承is-a组合has-a扩展方式创建新子类传入不同策略对象算法控制父类控制整体流程子类填充步骤调用者选择完整的算法实现粒度算法的某些步骤可变整个算法可替换运行时切换不支持编译期确定支持运行时替换策略Android 典型案例Activity.performCreate()Animation.setInterpolator()模板方法 vs 工厂方法工厂方法模式可以看作模板方法模式的一种特殊形式模板方法中的某个步骤专门负责创建对象。例如Activity.onCreate()中调用setContentView()来创建页面的视图层级这一步骤同时具备工厂方法的特征。模板方法 vs 建造者模式建造者模式关注的是构建过程的灵活组合可以跳过某些步骤、改变步骤顺序而模板方法关注的是固定流程中个别步骤的差异化实现。AlertDialog.Builder是建造者模式调用者可以自由组合setTitle()、setMessage()、setPositiveButton()等步骤而View.draw()是模板方法绘制步骤的顺序不可变更。总结与最佳实践模板方法模式的核心价值在于将不变的流程骨架与可变的具体步骤分离。Android 框架大量依赖此模式来保证系统行为的一致性同时为开发者保留足够的扩展空间。最佳实践模板方法声明为 final防止子类覆写整体流程。Android 中performCreate()等方法均为final这是保证框架完整性的关键手段区分抽象方法和钩子方法必须由子类实现的步骤声明为abstract可选扩展点提供空的默认实现并声明为open。这样可以降低子类的实现负担使用 super 调用检查机制Android 通过mCalled标志位检测子类是否调用了super.onXxx()。在自定义模板中也可以采用类似机制确保子类不会意外跳过父类逻辑控制模板方法的步骤数量步骤过多会导致子类实现负担沉重。通常控制在 3-5 个步骤为宜超过时应考虑将部分步骤合并或改用组合模式优先考虑组合替代继承当算法变体较多且需要运行时切换时应优先使用策略模式组合方式。模板方法适用于算法骨架稳定、仅个别步骤存在差异的场景命名规范模板方法即控制流程的方法与步骤方法子类覆写的方法应有清晰的命名区分。Android 中采用performXxx()作为模板方法、onXxx()作为子类步骤的命名约定值得借鉴