{ "id": "tutorial/toh-pt4", "title": "Add services", "contents": "\n\n\n
The Tour of Heroes HeroesComponent
is currently getting and displaying fake data.
After the refactoring in this tutorial, HeroesComponent
will be lean and focused on supporting the view.\nIt will also be easier to unit-test with a mock service.
For the sample application that this page describes, see the
Components shouldn't fetch or save data directly and they certainly shouldn't knowingly present fake data.\nThey should focus on presenting data and delegate data access to a service.
\nIn this tutorial, you'll create a HeroService
that all application classes can use to get heroes.\nInstead of creating that service with the new
keyword,\nyou'll rely on Angular dependency injection\nto inject it into the HeroesComponent
constructor.
Services are a great way to share information among classes that don't know each other.\nYou'll create a MessageService
and inject it in two places.
HeroService
linkUsing the Angular CLI, create a service called hero
.
The command generates a skeleton HeroService
class in src/app/hero.service.ts
as follows:
@Injectable()
serviceslinkNotice that the new service imports the Angular Injectable
symbol and annotates\nthe class with the @Injectable()
decorator. This marks the class as one that participates in the dependency injection system. The HeroService
class is going to provide an injectable service, and it can also have its own injected dependencies.\nIt doesn't have any dependencies yet, but it will soon.
The @Injectable()
decorator accepts a metadata object for the service, the same way the @Component()
decorator did for your component classes.
The HeroService
could get hero data from anywhere—a web service, local storage, or a mock data source.
Removing data access from components means you can change your mind about the implementation anytime, without touching any components.\nThey don't know how the service works.
\nThe implementation in this tutorial will continue to deliver mock heroes.
\nImport the Hero
and HEROES
.
Add a getHeroes
method to return the mock heroes.
HeroService
linkYou must make the HeroService
available to the dependency injection system\nbefore Angular can inject it into the HeroesComponent
by registering a provider. A provider is something that can create or deliver a service; in this case, it instantiates the HeroService
class to provide the service.
To make sure that the HeroService
can provide this service, register it\nwith the injector, which is the object that is responsible for choosing\nand injecting the provider where the application requires it.
By default, the Angular CLI command ng generate service
registers a provider with the root injector for your service by including provider metadata, that is providedIn: 'root'
in the @Injectable()
decorator.
When you provide the service at the root level, Angular creates a single, shared instance of HeroService
and injects into any class that asks for it.\nRegistering the provider in the @Injectable
metadata also allows Angular to optimize an application by removing the service if it turns out not to be used after all.
To learn more about providers, see the Providers section.\nTo learn more about injectors, see the Dependency Injection guide.
\nThe HeroService
is now ready to plug into the HeroesComponent
.
This is an interim code sample that will allow you to provide and use the HeroService
. At this point, the code will differ from the HeroService
in the \"final code review\".
HeroesComponent
linkOpen the HeroesComponent
class file.
Delete the HEROES
import, because you won't need that anymore.\nImport the HeroService
instead.
Replace the definition of the heroes
property with a declaration.
HeroService
linkAdd a private heroService
parameter of type HeroService
to the constructor.
The parameter simultaneously defines a private heroService
property and identifies it as a HeroService
injection site.
When Angular creates a HeroesComponent
, the Dependency Injection system\nsets the heroService
parameter to the singleton instance of HeroService
.
getHeroes()
linkCreate a method to retrieve the heroes from the service.
\nngOnInit()
linkWhile you could call getHeroes()
in the constructor, that's not the best practice.
Reserve the constructor for minimal initialization such as wiring constructor parameters to properties.\nThe constructor shouldn't do anything.\nIt certainly shouldn't call a function that makes HTTP requests to a remote server as a real data service would.
\nInstead, call getHeroes()
inside the ngOnInit lifecycle hook and\nlet Angular call ngOnInit()
at an appropriate time after constructing a HeroesComponent
instance.
After the browser refreshes, the application should run as before,\nshowing a list of heroes and a hero detail view when you click on a hero name.
\nThe HeroService.getHeroes()
method has a synchronous signature,\nwhich implies that the HeroService
can fetch heroes synchronously.\nThe HeroesComponent
consumes the getHeroes()
result\nas if heroes could be fetched synchronously.
This will not work in a real app.\nYou're getting away with it now because the service currently returns mock heroes.\nBut soon the application will fetch heroes from a remote server,\nwhich is an inherently asynchronous operation.
\nThe HeroService
must wait for the server to respond,\ngetHeroes()
cannot return immediately with hero data,\nand the browser will not block while the service waits.
HeroService.getHeroes()
must have an asynchronous signature of some kind.
In this tutorial, HeroService.getHeroes()
will return an Observable
\nbecause it will eventually use the Angular HttpClient.get
method to fetch the heroes\nand HttpClient.get()
returns an Observable
.
HeroService
linkObservable
is one of the key classes in the RxJS library.
In a later tutorial on HTTP, you'll learn that Angular's HttpClient
methods return RxJS Observable
s.\nIn this tutorial, you'll simulate getting data from the server with the RxJS of()
function.
Open the HeroService
file and import the Observable
and of
symbols from RxJS.
Replace the getHeroes()
method with the following:
of(HEROES)
returns an Observable<Hero[]>
that emits a single value, the array of mock heroes.
In the HTTP tutorial, you'll call HttpClient.get<Hero[]>()
which also returns an Observable<Hero[]>
that emits a single value, an array of heroes from the body of the HTTP response.
HeroesComponent
linkThe HeroService.getHeroes
method used to return a Hero[]
.\nNow it returns an Observable<Hero[]>
.
You'll have to adjust to that difference in HeroesComponent
.
Find the getHeroes
method and replace it with the following code\n(shown side-by-side with the previous version for comparison)
Observable.subscribe()
is the critical difference.
The previous version assigns an array of heroes to the component's heroes
property.\nThe assignment occurs synchronously, as if the server could return heroes instantly\nor the browser could freeze the UI while it waited for the server's response.
That won't work when the HeroService
is actually making requests of a remote server.
The new version waits for the Observable
to emit the array of heroes—which\ncould happen now or several minutes from now.\nThe subscribe()
method passes the emitted array to the callback,\nwhich sets the component's heroes
property.
This asynchronous approach will work when\nthe HeroService
requests heroes from the server.
This section guides you through the following:
\nMessagesComponent
that displays application messages at the bottom of the screenMessageService
for sending messages to be displayedMessageService
into the HeroService
HeroService
fetches heroes successfullyMessagesComponent
linkUse the CLI to create the MessagesComponent
.
The CLI creates the component files in the src/app/messages
folder and declares the MessagesComponent
in AppModule
.
Modify the AppComponent
template to display the generated MessagesComponent
.
You should see the default paragraph from MessagesComponent
at the bottom of the page.
MessageService
linkUse the CLI to create the MessageService
in src/app
.
Open MessageService
and replace its contents with the following.
The service exposes its cache of messages
and two methods: one to add()
a message to the cache and another to clear()
the cache.
HeroService
linkIn HeroService
, import the MessageService
.
Modify the constructor with a parameter that declares a private messageService
property.\nAngular will inject the singleton MessageService
into that property\nwhen it creates the HeroService
.
This is a typical \"service-in-service\" scenario:\nyou inject the MessageService
into the HeroService
which is injected into the HeroesComponent
.
HeroService
linkModify the getHeroes()
method to send a message when the heroes are fetched.
HeroService
linkThe MessagesComponent
should display all messages,\nincluding the message sent by the HeroService
when it fetches heroes.
Open MessagesComponent
and import the MessageService
.
Modify the constructor with a parameter that declares a public messageService
property.\nAngular will inject the singleton MessageService
into that property\nwhen it creates the MessagesComponent
.
The messageService
property must be public because you're going to bind to it in the template.
Angular only binds to public component properties.
\nMessageService
linkReplace the CLI-generated MessagesComponent
template with the following.
This template binds directly to the component's messageService
.
*ngIf
only displays the messages area if there are messages to show.*ngFor
presents the list of messages in repeated <div>
elements.MessageService.clear()
.The messages will look better when you add the private CSS styles to messages.component.css
\nas listed in one of the \"final code review\" tabs below.
The following example shows how to send and display a message each time the user clicks on\na hero, showing a history of the user's selections. This will be helpful when you get to the\nnext section on Routing.
\nRefresh the browser to see the list of heroes, and scroll to the bottom to see the\nmessages from the HeroService. Each time you click a hero, a new message appears to record\nthe selection. Use the Clear messages button to clear the message history.
\n\nHere are the code files discussed on this page.
\nHeroService
class.HeroService
as the provider of its service at the root level so that it can be injected anywhere in the app.HeroService
get data method an asynchronous signature.Observable
and the RxJS Observable library.of()
to return an observable of mock heroes (Observable<Hero[]>
).ngOnInit
lifecycle hook calls the HeroService
method, not the constructor.MessageService
for loosely-coupled communication between classes.HeroService
injected into a component is created with another injected service,\nMessageService
.