Reputation: 5391
What is the difference between canLoad
and canActivate
?
export interface Route {
path?: string;
pathMatch?: string;
matcher?: UrlMatcher;
component?: Type<any>;
redirectTo?: string;
outlet?: string;
canActivate?: any[];
canActivateChild?: any[];
canDeactivate?: any[];
canLoad?: any[];
data?: Data;
resolve?: ResolveData;
children?: Routes;
loadChildren?: LoadChildren;
}
When I should which one of them?
Upvotes: 161
Views: 113230
Reputation: 2414
A big difference no one mentioned here, is that canLoad only works with loadChildren
.
To prevent a component
from being loaded, only canActivate
will get triggered.
See Why does route guard canLoad not fire, but canActivate does for more detail.
Upvotes: 4
Reputation: 1547
The CanLoad Guard prevents the loading of the Lazy Loaded Module. We generally use this guard when we do not want to unauthorized user to navigate to any of the routes of the module and also stop then even see the source code of the module.
The Angular provides canActivate Guard, which prevents unauthorized user from accessing the route. But it does not stop the module from being downloaded. The user can use the chrome developer console to see the source code. The CanLoad Guard prevents the module from being downloaded.
Actually,CanLoad protects a module to be loaded but once module is loaded then CanLoad guard will do nothing. Suppose we have protected a module loading using CanLoad guard for unauthenticated user. When user is logged-in then that module will be applicable to be loaded and we will be able to navigate children paths configured by that module. But when user is logged-out, still user will be able to navigate those children paths because module is already loaded. In this case if we want to protect children paths from unauthorized users, we also need to use CanActivate guard.
Use CanLoad before loading AdminModule:
{
path: 'admin',
loadChildren: 'app/admin/admin.module#AdminModule',
canLoad: [ AuthGuardService ]
},
After loading AdminModule, in AdminRouting module we can use CanActivate to protect childs from unauthorized users like bellow:
{
path: '',
component: AdminComponent,
children: [
{
path: 'person-list',
component: PersonListComponent,
canActivate: [ AuthGuardService ]
}
]
}
Upvotes: 54
Reputation: 3714
Following are the cases that I have found while using canLoad and canActivete with lazy routes:
A) If canLoad or canActivate is used:
1. When module is not downloaded already:
canLoad:
true: module will be downloaded
false: module will not be downloaded
canActivate:
true: module will be downloaded and user will be granted to access particular route
false: module will be downloaded and user will be prevented to access particular route
2. When module is downloaded already
canLoad: It does not do anything. Like its not there in code.
canActivate:
true: user will be granted to access particular route
false: user will be prevented to access particular route
B) If both canLoad and canActivate is used:
1. When module is not downloaded already:
canLoad:
true: module will be downloaded and passed control to check canActivate
false: Neither module will be downloaded nor canActivate will be called
canActivate:
true: user will be granted to access particular route
false: user will be prevented to access particular route
2. When module is downloaded already
canLoad:
It does not do anything. Like its not there.
canActivate:
true: user will be granted to access particular route
false: user will be prevented to access particular route
So I prefer using both canLoad and canActivate for lazy modules and canActivate for component based route
Upvotes: 11
Reputation: 51
Important to notice that canLoad won't stop someone from getting your source code. The .js won't be downloaded by browser unless user is authorized, but you can force a manual download by issuing a import('./xxxxx.js') on browser console.
Module name can be easly found on you main.js on your routes definition.
Upvotes: 5
Reputation: 348
canActivate if unauthorized user enters still load that module . you need canLoad to achieve judgment whether it needs be loaded .
Upvotes: 0
Reputation: 1675
This is a test i made on both guards with a feature module that is lazy loaded:
1. CanActivate Guard Test
you will notice at the bottom of Network page that it made 24 requests with size of 9.5 MB transferred finishing in 3.34 seconds and fully loaded in 3.47 seconds.
1. CanLoad Guard Test
here you will see the big difference when we used CanLoad Guard as browser made only 18 requests with size of 9.2 MB transferred finishing in 2.64 seconds and fully loaded 2.59 seconds.
CanLoad Guard never load the module data if user not authorized and that gives you more performance as the load time decreased almost 1 second and that is huge time in loading web pages, no doubt it depends on the module size.
Tip: if you want to make the test on your project make sure that
Disable Cache
checkbox in network tab is checked, it's marked in first image
Upvotes: 60
Reputation: 1119
canActivate is used to prevent an unauthorized user
canLoad is used to prevent the entire module of app
Example of canActivate:
{ path: 'product',canActivate:[RouteGaurd], component : ProductComponent }
Example of canLoad:
{ path: 'user' , canLoad: [AuthenticGuard], loadChildren : './user/user.module#UserModule' }
Upvotes: 20
Reputation: 6083
Regarding to question from comments in other post "If I use canActivate in above scenario, what will be the difference ?"
Actually for user there will be no difference, he won't get any access to the page in both cases.
Although there is one hidden difference. If you press F12 and move to Sources (in Chrome) where are download files.
Then you can see that in case with canActive file with code has been downloaded (chunk.js). Even if you have no access to the page.
But in case with canLoad there will be no chunk.js file with source code.
So as you can see this have really big impact for security.
And of course don't forget that canLoad can be used only for LazyLoaded Modules.
Upvotes: 21
Reputation: 8186
canActivate is used to prevent unauthorized users from accessing certain routes. See docs for more info.
canLoad is used to prevent the application from loading entire modules lazily if the user is not authorized to do so.
See docs and example below for more info.
{
path: 'admin',
loadChildren: 'app/admin/admin.module#AdminModule',
canLoad: [AuthGuard]
},
With this code, the code for the AdminModule will only be loaded into the application if AuthGuard returns true
.
If the user is not authorized to access this route, and we'd only used a canActivate
guard, the AdminModule
would be loaded, even though the user would not be able to access that route.
Upvotes: 158