如何在商城前端实现Can Deactivate Route Guard？遇数组配置报错

一、完整实现步骤 #

1. 创建CanDeactivate守卫服务 #

创建守卫文件，核心是实现路由守卫接口，同时定义组件需实现的自定义接口，让守卫能调用组件内的判断逻辑：

import { Injectable } from '@angular/core';
import { CanDeactivate, ActivatedRouteSnapshot, RouterStateSnapshot } from '@angular/router';
import { Observable } from 'rxjs';

// 定义组件需实现的接口，统一判断逻辑的调用方式
export interface CanComponentDeactivate {
  canDeactivate: () => Observable<boolean> | Promise<boolean> | boolean;
}

@Injectable({ providedIn: 'root' })
export class CanDeactivateGuard implements CanDeactivate<CanComponentDeactivate> {
  canDeactivate(
    component: CanComponentDeactivate,
    currentRoute: ActivatedRouteSnapshot,
    currentState: RouterStateSnapshot,
    nextState?: RouterStateSnapshot
  ): Observable<boolean> | Promise<boolean> | boolean {
    // 委托组件自身判断是否允许跳转
    return component.canDeactivate();
  }
}

2. 在表单组件中实现判断逻辑 #

给需要守卫的表单组件实现CanComponentDeactivate接口，在方法内判断表单状态并弹出提示：

import { Component } from '@angular/core';
import { FormGroup, FormBuilder } from '@angular/forms';
import { CanComponentDeactivate } from './can-deactivate.guard';
import { Observable } from 'rxjs';

@Component({
  selector: 'app-checkout-form',
  templateUrl: './checkout-form.component.html'
})
export class CheckoutFormComponent implements CanComponentDeactivate {
  checkoutForm: FormGroup;

  constructor(private fb: FormBuilder) {
    this.checkoutForm = this.fb.group({
      name: [''],
      address: ['']
    });
  }

  canDeactivate(): Observable<boolean> | Promise<boolean> | boolean {
    // 判断表单是否已修改且未完成
    if (this.checkoutForm.dirty) {
      // 用原生弹窗处理异步确认，返回Promise确保守卫等待结果
      return new Promise(resolve => {
        const confirmLeave = window.confirm('表单未填写完成，确定要离开吗？');
        resolve(confirmLeave);
      });
    }
    // 表单未修改，允许跳转
    return true;
  }
}

3. 路由配置中注册守卫 #

在路由模块的对应路由里，将守卫加入canDeactivate数组：

import { NgModule } from '@angular/core';
import { Routes, RouterModule } from '@angular/router';
import { CheckoutFormComponent } from './checkout-form/checkout-form.component';
import { CanDeactivateGuard } from './can-deactivate.guard';

const routes: Routes = [
  {
    path: 'checkout',
    component: CheckoutFormComponent,
    // 配置守卫
    canDeactivate: [CanDeactivateGuard]
  }
];

@NgModule({
  imports: [RouterModule.forRoot(routes)],
  exports: [RouterModule]
})
export class AppRoutingModule { }

二、常见报错排查 #

如果配置后控制台报错，优先检查以下几点：

• 守卫接口实现错误：确保守卫类正确实现CanDeactivate接口，方法名是canDeactivate，返回值类型包含Observable<boolean> | Promise<boolean> | boolean。
• 组件未实现自定义接口：表单组件必须实现CanComponentDeactivate接口，否则守卫无法调用组件的判断方法，会报“不存在该方法”的错误。
• 守卫未注册：Angular 14以下版本需在@NgModule的providers数组中注册CanDeactivateGuard；14+版本用providedIn: 'root'自动注册，无需手动添加。
• 异步逻辑处理错误：如果用自定义弹窗（而非原生confirm），需确保返回Observable或Promise，不能直接返回boolean，否则异步确认逻辑会失效。

内容的提问来源于stack exchange，提问作者Don't Memorise Don't Forget