CanActivate
类可以实现的接口,用于确定是否可以激活路由。如果所有守卫都返回了 true
,那么导航将继续。如果任何守卫返回 false
,则导航将被取消。如果任何守卫返回 UrlTree
,当前导航被取消,新的导航开始到守卫所返回的 UrlTree
。
Interface that a class can implement to be a guard deciding if a route can be activated. If all guards return true
, navigation continues. If any guard returns false
, navigation is cancelled. If any guard returns a UrlTree
, the current navigation is cancelled and a new navigation begins to the UrlTree
returned from the guard.
interface CanActivate {
canActivate(route: ActivatedRouteSnapshot, state: RouterStateSnapshot): Observable<boolean | UrlTree> | Promise<boolean | UrlTree> | boolean | UrlTree
}
说明
一个接口,某些类可以实现它以扮演一个守卫,来决定该路由能否激活。 如果所有守卫都返回 true
,就会继续导航。如果任何一个守卫返回了 false
,就会取消导航。 如果任何一个守卫返回了 UrlTree
,就会取消当前导航,并开始导航到这个守卫所返回的 UrlTree
。
The following example implements a CanActivate
function that checks whether the current user has permission to activate the requested route.
class UserToken {}
class Permissions {
canActivate(user: UserToken, id: string): boolean {
return true;
}
}
@Injectable()
class CanActivateTeam implements CanActivate {
constructor(private permissions: Permissions, private currentUser: UserToken) {}
canActivate(
route: ActivatedRouteSnapshot,
state: RouterStateSnapshot
): Observable<boolean|UrlTree>|Promise<boolean|UrlTree>|boolean|UrlTree {
return this.permissions.canActivate(this.currentUser, route.params.id);
}
}
Here, the defined guard function is provided as part of the Route
object in the router configuration:
@NgModule({
imports: [
RouterModule.forRoot([
{
path: 'team/:id',
component: TeamComponent,
canActivate: [CanActivateTeam]
}
])
],
providers: [CanActivateTeam, UserToken, Permissions]
})
class AppModule {}
你还可以转而实现一个带有 canActivate
签名的函数:
You can alternatively provide an in-line function with the canActivate
signature:
@NgModule({
imports: [
RouterModule.forRoot([
{
path: 'team/:id',
component: TeamComponent,
canActivate: ['canActivateTeam']
}
])
],
providers: [
{
provide: 'canActivateTeam',
useValue: (route: ActivatedRouteSnapshot, state: RouterStateSnapshot) => true
}
]
})
class AppModule {}
方法
参数
返回值
|