23 KiB

Raw Blame History

HTTP

In this tutorial, you'll add the following data persistence features with help from Angular's HttpClient.

The HeroService gets hero data with HTTP requests.
Users can add, edit, and delete heroes and save these changes over HTTP.
Users can search for heroes by name.

When you're done with this page, the app should look like this .

Enable HTTP services

HttpClient is Angular's mechanism for communicating with a remote server over HTTP.

To make HttpClient available everywhere in the app,

open the root AppModule,
import the HttpClientModule symbol from @angular/common/http,
add it to the @NgModule.imports array.

Simulate a data server

This tutorial sample mimics communication with a remote data server by using the In-memory Web API module.

After installing the module, the app will make requests to and receive responses from the HttpClient without knowing that the In-memory Web API is intercepting those requests, applying them to an in-memory data store, and returning simulated responses.

This facility is a great convenience for the tutorial. You won't have to set up a server to learn about HttpClient.

It may also be convenient in the early stages of your own app development when the server's web api is ill-defined or not yet implemented.

Important: the In-memory Web API module has nothing to do with HTTP in Angular.

If you're just reading this tutorial to learn about HttpClient, you can skip over this step. If you're coding along with this tutorial, stay here and add the In-memory Web API now.

Install the In-memory Web API package from npm

npm install angular-in-memory-web-api --save

Import the InMemoryWebApiModule and the InMemoryDataService class, which you will create in a moment.

Add the InMemoryWebApiModule to the @NgModule.imports array— after importing the HttpClient, —while configuring it with the InMemoryDataService.

The forRoot() configuration method takes an InMemoryDataService class that primes the in-memory database.

The Tour of Heroes sample creates such a class src/app/in-memory-data.service.ts which has the following content:

This file replaces mock-heroes.ts, which is now safe to delete.

When your server is ready, detach the In-memory Web API, and the app's requests will go through to the server.

Now back to the HttpClient story.

{@a import-heroes}

Heroes and HTTP

Import some HTTP symbols that you'll need:

Inject HttpClient into the constructor in a private property called http.

Keep injecting the MessageService. You'll call it so frequently that you'll wrap it in private log method.

Define the heroesUrl with the address of the heroes resource on the server.

Get heroes with HttpClient

The current HeroService.getHeroes() uses the RxJS of() function to return an array of mock heroes as an Observable<Hero[]>.

Convert that method to use HttpClient

Refresh the browser. The hero data should successfully load from the mock server.

You've swapped of for http.get and the app keeps working without any other changes because both functions return an Observable<Hero[]>.

Http methods return one value

All HttpClient methods return an RxJS Observable of something.

HTTP is a request/response protocol. You make a request, it returns a single response.

In general, an Observable can return multiple values over time. An Observable from HttpClient always emits a single value and then completes, never to emit again.

This particular HttpClient.get call returns an Observable<Hero[]>, literally "an observable of hero arrays". In practice, it will only return a single hero array.

HttpClient.get returns response data

HttpClient.get returns the body of the response as an untyped JSON object by default. Applying the optional type specifier, <Hero[]> , gives you a typed result object.

The shape of the JSON data is determined by the server's data API. The Tour of Heroes data API returns the hero data as an array.

Other APIs may bury the data that you want within an object. You might have to dig that data out by processing the Observable result with the RxJS map operator.

Although not discussed here, there's an example of map in the getHeroNo404() method included in the sample source code.

Error handling

Things go wrong, especially when you're getting data from a remote server. The HeroService.getHeroes() method should catch errors and do something appropriate.

To catch errors, you "pipe" the observable result from http.get() through an RxJS catchError() operator.

Import the catchError symbol from rxjs/operators, along with some other operators you'll need later.

Now extend the observable result with the .pipe() method and give it a catchError() operator.

The catchError() operator intercepts an Observable that failed. It passes the error an error handler that can do what it wants with the error.

The following handleError() method reports the error and then returns an innocuous result so that the application keeps working.

handleError

The following errorHandler() will be shared by many HeroService methods so it's generalized to meet their different needs.

Instead of handling the error directly, it returns an error handler function to catchError that it has configured with both the name of the operation that failed and a safe return value.

After reporting the error to console, the handler constructs a user friendly message and returns a safe value to the app so it can keep working.

Because each service method returns a different kind of Observable result, errorHandler() takes a type parameter so it can return the safe value as the type that the app expects.

Tap into the Observable

The HeroService methods will tap into the flow of observable values and send a message (via log()) to the message area at the bottom of the page.

They'll do that with the RxJS tap operator, which looks at the observable values, does something with those values, and passes them along. The tap call back doesn't touch the values themselves.

Here is the final version of getHeroes with the tap that logs the operation.

Get hero by id

Most web APIs support a get by id request in the form api/hero/:id (such as api/hero/11). Add a HeroService.getHero() method to make that request:

There are three significant differences from getHeroes().

it constructs a request URL with the desired hero's id.
the server should respond with a single hero rather than an array of heroes.
therefore, getHero returns an Observable<Hero> ("an observable of Hero objects") rather than an observable of hero arrays .

Update heroes

Editing a hero's name in the hero detail view. As you type, the hero name updates the heading at the top of the page. But when you click the "go back button", the changes are lost.

If you want changes to persist, you must write them back to the server.

At the end of the hero detail template, add a save button with a click event binding that invokes a new component method named save().

Add the following save() method, which persists hero name changes using the hero service updateHero() method and then navigates back to the previous view.

Add HeroService.updateHero()

The overall structure of the updateHero() method is similar to that of getHeroes(), but it uses http.put() to persist the changed hero on the server.

The HttpClient.put() method takes three parameters

the URL
the data to update (the modified hero in this case)
options

The URL is unchanged. The heroes web API knows which hero to update by looking at the hero's id.

The heroes web API expects a special header in HTTP save requests. That header is in the httpOption constant defined in the HeroService.

Refresh the browser, change a hero name, save your change, and click the "go back" button. The hero now appears in the list with the changed name.

Add a new hero

To add a hero, this app only needs the hero's name. You can use an input element paired with an add button.

Insert the following into the HeroesComponent template, just after the heading:

In response to a click event, call the component's click handler and then clear the input field so that it's ready for another name.

When the given name is non-blank, the handler creates a Hero-like object from the name (it's only missing the id) and passes it to the services addHero() method.

When addHero saves successfully, the subscribe callback receives the new hero and pushes it into to the heroes list for display.

You'll write HeroService.addHero in the next section.

Add HeroService.addHero()

Add the following addHero() method to the HeroService class.

HeroService.addHero() differs from updateHero in two ways.

it calls HttpClient.post() instead of put().
it expects the server to generates an id for the new hero, which it returns in the Observable<Hero> to the caller.

Refresh the browser and add some heroes.

Delete a hero

Each hero in the heroes list should have a delete button.

Add the following button element to the HeroesComponent template, after the hero name in the repeated <li> element.

The HTML for the list of heroes should look like this:

To position the delete button at the far right of the hero entry, add some CSS to the heroes.component.css. You'll find that CSS in the final review code below.

Add the delete() handler to the component.

Although the component delegates hero deletion to the HeroService, it remains responsible for updating its own list of heroes. The component's delete() method immediately removes the hero-to-delete from that list, anticipating that the HeroService will succeed on the server.

There's really nothing for the component to do with the Observable returned by heroService.delete(). It must subscribe anyway.

If you neglect to subscribe(), the service will not send the delete request to the server! As a rule, an Observable does nothing until something subscribes!

Confirm this for yourself by temporarily removing the subscribe(), clicking "Dashboard", then clicking "Heroes". You'll see the full list of heroes again.

Add HeroService.deleteHero()

Add a deleteHero() method to HeroService like this.

Note that

it calls HttpClient.delete.
the URL is the heroes resource URL plus the id of the hero to delete
you don't send data as you did with put and post.
you still send the httpOptions.

Refresh the browser and try the new delete functionality.

Search by name

In this last exercise, you learn to chain Observable operators together so you can minimize the number of similar HTTP requests and consume network bandwidth economically.

You will add a heroes search feature to the Dashboard. As the user types a name into a search box, you'll make repeated HTTP requests for heroes filtered by that name. Your goal is to issue only as many requests as necessary.

HeroService.searchHeroes

Start by adding a searchHeroes method to the HeroService.

The method returns immediately with an empty array if there is no search term. The rest of it closely resembles getHeroes(). The only significant difference is the URL, which includes a query string with the search term.

Add search to the Dashboard

Open the DashboardComponent template and Add the hero search element, <app-hero-search>, to the bottom of the DashboardComponent template.

This template looks a lot like the *ngFor repeater in the HeroesComponent template.

Unfortunately, adding this element breaks the app. Angular can't find a component with a selector that matches <app-hero-search>.

The HeroSearchComponent doesn't exist yet. Fix that.

Create HeroSearchComponent

Create a HeroSearchComponent with the CLI.

ng generate component hero-search

The CLI generates the three HeroSearchComponent and adds the component to the `AppModule' declarations

Replace the generated HeroSearchComponent template with a text box and a list of matching search results like this.

Add private CSS styles to hero-search.component.css as listed in the final code review below.

As the user types in the search box, a keyup event binding calls the component's search() method with the new search box value.

{@a asyncpipe}

AsyncPipe

As expected, the *ngFor repeats hero objects.

Look closely and you'll see that the *ngFor iterates over a list called heroes$, not heroes.

The $ is a convention that indicates heroes$ is an Observable, not an array.

The *ngFor can't do anything with an Observable. But there's also a pipe character (|) followed by async, which identifies Angular's AsyncPipe.

The AsyncPipe subscribes to an Observable automatically so you won't have to do so in the component class.

Fix the HeroSearchComponent class

Replace the generated HeroSearchComponent class and metadata as follows.

Notice the declaration of heroes$ as an Observable

You'll set it in ngOnInit(). Before you do, focus on the definition of searchTerms.

The searchTerms RxJS subject

The searchTerms property is declared as an RxJS Subject.

A Subject is both a source of observable values and an Observable itself. You can subscribe to a Subject as you would any Observable.

You can also push values into that Observable by calling its next(value) method as the search() method does.

The search() method is called via an event binding to the textbox's keystroke event.

Every time the user types in the textbox, the binding calls search() with the textbox value, a "search term". The searchTerms becomes an Observable emitting a steady stream of search terms.

{@a search-pipe}

Chaining RxJS operators

Passing a new search term directly to the searchHeroes() after every user keystroke would create an excessive amount of HTTP requests, taxing server resources and burning through the cellular network data plan.

Instead, the ngOnInit() method pipes the searchTerms observable through a sequence of RxJS operators that reduce the number of calls to the searchHeroes(), ultimately returning an observable of timely hero search results (each a Hero[]).

Here's the code.

debounceTime(300) waits until the flow of new string events pauses for 300 milliseconds before passing along the latest string. You'll never make requests more frequently than 300ms.
distinctUntilChanged ensures that a request is sent only if the filter text changed.
switchMap() calls the search service for each search term that makes it through debounce and distinctUntilChanged. It cancels and discards previous search observables, returning only the latest search service observable.

With the switchMap operator, every qualifying key event can trigger an HttpClient.get() method call. Even with a 300ms pause between requests, you could have multiple HTTP requests in flight and they may not return in the order sent.

switchMap() preserves the original request order while returning only the observable from the most recent HTTP method call. Results from prior calls are canceled and discarded.

Note that canceling a previous searchHeroes() Observable doesn't actually abort a pending HTTP request. Unwanted results are simply discarded before they reach your application code.

Remember that the component class does not subscribe to the heroes$ observable. That's the job of the AsyncPipe in the template.

Try it

Run the app again. In the Dashboard, enter some text in the search box. If you enter characters that match any existing hero names, you'll see something like this.

Final code review

Your app should look like this .

Here are the code files discussed on this page (all in the src/app/ folder).

{@a heroservice} {@a inmemorydataservice} {@a appmodule}

HeroService, InMemoryDataService, AppModule

{@a heroescomponent}

HeroesComponent

{@a herodetailcomponent}

HeroDetailComponent

{@a herosearchcomponent}

HeroSearchComponent

Summary

You're at the end of your journey, and you've accomplished a lot.

You added the necessary dependencies to use HTTP in the app.
You refactored HeroService to load heroes from a web API.
You extended HeroService to support post(), put(), and delete() methods.
You updated the components to allow adding, editing, and deleting of heroes.
You configured an in-memory web API.
You learned how to use Observables.

This concludes the "Tour of Heroes" tutorial. You're ready to learn more about Angular development in the fundamentals section, starting with the Architecture guide.

23 KiB Raw Blame History