angular-cn/aio/content/tutorial/toh-pt6.md

@title HTTP

@intro Convert the service and components to use Angular's HTTP service.

@description

In this page, you'll make the following improvements.

• Get the hero data from a server.
• Let users add, edit, and delete hero names.
• Save the changes to the server.

You'll teach the app to make corresponding HTTP calls to a remote server's web API.

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

Where you left off

In the previous page, you learned to navigate between the dashboard and the fixed heroes list, editing a selected hero along the way. That's the starting point for this page.

Keep the app transpiling and running

Enter the following command in the terminal window:

npm start

This command runs the TypeScript compiler in "watch mode", recompiling automatically when the code changes. The command simultaneously launches the app in a browser and refreshes the browser when the code changes.

You can keep building the Tour of Heroes without pausing to recompile or refresh the browser.

Providing HTTP Services

The HttpModule is not a core Angular module. HttpModule is Angular's optional approach to web access. It exists as a separate add-on module called @angular/http and is shipped in a separate script file as part of the Angular npm package.

You're ready to import from @angular/http because systemjs.config configured SystemJS to load that library when you need it.

Register for HTTP services

The app will depend on the Angular http service, which itself depends on other supporting services. The HttpModule from the @angular/http library holds providers for a complete set of HTTP services.

To allow access to these services from anywhere in the app, add HttpModule to the imports list of the AppModule.

Notice that you also supply HttpModule as part of the imports array in root NgModule AppModule.

Simulate the web API

We recommend registering app-wide services in the root AppModule providers.

Until you have a web server that can handle requests for hero data, the HTTP client will fetch and save data from a mock service, the in-memory web API.

Update src/app/app.module.ts with this version, which uses the mock service:

Rather than require a real API server, this example simulates communication with the remote server by adding the InMemoryWebApiModule to the module imports, effectively replacing the Http client's XHR backend service with an in-memory alternative.

The forRoot() configuration method takes an InMemoryDataService class that primes the in-memory database. Add the file in-memory-data.service.ts in app with the following content:

This file replaces mock-heroes.ts, which is now safe to delete. Added hero "Zero" to confirm that the data service can handle a hero with id==0.

The in-memory web API is only useful in the early stages of development and for demonstrations such as this Tour of Heroes. Don't worry about the details of this backend substitution; you can skip it when you have a real web API server.

Read more about the in-memory web API in the Appendix: Tour of Heroes in-memory web api section of the HTTP Client page.

Heroes and HTTP

In the current HeroService implementation, a Promise resolved with mock heroes is returned.

This was implemented in anticipation of ultimately fetching heroes with an HTTP client, which must be an asynchronous operation.

Now convert getHeroes() to use HTTP.

Update the import statements as follows:

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

HTTP Promise

The Angular http.get returns an RxJS Observable. Observables are a powerful way to manage asynchronous data flows. You'll read about Observables later in this page.

For now, you've converted the Observable to a Promise using the toPromise operator.

The Angular Observable doesn't have a toPromise operator out of the box.

There are many operators like toPromise that extend Observable with useful capabilities. To use those capabilities, you have to add the operators themselves. That's as easy as importing them from the RxJS library like this:

You'll add more operators, and learn why you must do so, later in this tutorial.

Extracting the data in the then callback

In the Promise's then() callback, you call the json method of the HTTP Response to extract the data within the response.

The response JSON has a single data property, which holds the array of heroes that the caller wants. So you grab that array and return it as the resolved Promise value.

Note the shape of the data that the server returns. This particular in-memory web API example returns an object with a data property. Your API might return something else. Adjust the code to match your web API.

The caller is unaware that you fetched the heroes from the (mock) server. It receives a Promise of heroes just as it did before.

Error Handling

At the end of getHeroes(), you catch server failures and pass them to an error handler.

This is a critical step. You must anticipate HTTP failures, as they happen frequently for reasons beyond your control.

This demo service logs the error to the console; in real life, you would handle the error in code. For a demo, this works.

The code also includes an error to the caller in a rejected promise, so that the caller can display a proper error message to the user.

Get hero by id

When the HeroDetailComponent asks the HeroService to fetch a hero, the HeroService currently fetches all heroes and filters for the one with the matching id. That's fine for a simulation, but it's wasteful to ask a real server for all heroes when you only want one. Most web APIs support a get-by-id request in the form api/hero/:id (such as api/hero/11).

Update the HeroService.getHero() method to make a get-by-id request:

This request is almost the same as getHeroes(). The hero id in the URL identifies which hero the server should update.

Also, the data in the response is a single hero object rather than an array.

Unchanged getHeroes API

Although you made significant internal changes to getHeroes() and getHero(), the public signatures didn't change. You still return a Promise from both methods. You won't have to update any of the components that call them.

Now it's time to add the ability to create and delete heroes.

Updating hero details

Try editing a hero's name in the hero detail view. As you type, the hero name is updated in the view heading. But if you click the Back button, the changes are lost.

Updates weren't lost before. What changed? When the app used a list of mock heroes, updates were applied directly to the hero objects within the single, app-wide, shared list. Now that you're fetching data from a server, if you want changes to persist, you must write them back to the server.

Add the ability to save hero details

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 update() method and then navigates back to the previous view.

Add a hero service update() method

The overall structure of the update() method is similar to that of getHeroes(), but it uses an HTTP put() to persist server-side changes.

To identify which hero the server should update, the hero id is encoded in the URL. The put() body is the JSON string encoding of the hero, obtained by calling JSON.stringify. The body content type (application/json) is identified in the request header.

Refresh the browser, change a hero name, save your change, and click the browser Back button. Changes should now persist.

Add the ability to add heroes

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

Insert the following into the heroes component HTML, 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 delegates creation of the named hero to the hero service, and then adds the new hero to the array.

Implement the create() method in the HeroService class.

Refresh the browser and create some heroes.

Add the ability to delete a hero

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

Add the following button element to the heroes component HTML, after the hero name in the repeated <li> element.

The <li> element should now look like this:

In addition to calling the component's delete() method, the delete button's click handler code stops the propagation of the click event—you don't want the <li> click handler to be triggered because doing so would select the hero that the user will delete.

The logic of the delete() handler is a bit trickier:

Of course you delegate hero deletion to the hero service, but the component is still responsible for updating the display: it removes the deleted hero from the array and resets the selected hero, if necessary.

To place the delete button at the far right of the hero entry, add this CSS:

Hero service delete() method

Add the hero service's delete() method, which uses the delete() HTTP method to remove the hero from the server:

Refresh the browser and try the new delete functionality.

Observables

Each Http service method returns an Observable of HTTP Response objects.

The HeroService converts that Observable into a Promise and returns the promise to the caller. This section shows you how, when, and why to return the Observable directly.

Background

An Observable is a stream of events that you can process with array-like operators.

Angular core has basic support for observables. Developers augment that support with operators and extensions from the RxJS library. You'll see how shortly.

Recall that the HeroService chained the toPromise operator to the Observable result of http.get(). That operator converted the Observable into a Promise and you passed that promise back to the caller.

Converting to a Promise is often a good choice. You typically ask http.get() to fetch a single chunk of data. When you receive the data, you're done. The calling component can easily consume a single result in the form of a Promise.

But requests aren't always done only once. You may start one request, cancel it, and make a different request before the server has responded to the first request.

A request-cancel-new-request sequence is difficult to implement with Promises, but easy with Observables.

Add the ability to search by name

You're going to add a hero search feature to the Tour of Heroes. As the user types a name into a search box, you'll make repeated HTTP requests for heroes filtered by that name.

Start by creating HeroSearchService that sends search queries to the server's web API.

The http.get() call in HeroSearchService is similar to the one in the HeroService, although the URL now has a query string.

More importantly, you no longer call toPromise(). Instead you return the Observable from the the http.get(), after chaining it to another RxJS operator, map(), to extract heroes from the response data. RxJS operator chaining makes response processing easy and readable. See the discussion below about operators.

HeroSearchComponent

Create a HeroSearchComponent that calls the new HeroSearchService.

The component template is simple—just a text box and a list of matching search results.

Also, add styles for the new component.

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

As expected, the *ngFor repeats hero objects from the component's heroes property.

But as you'll soon see, the heroes property is now an Observable of hero arrays, rather than just a hero array. The *ngFor can't do anything with an Observable until you route it through the async pipe (AsyncPipe). The async pipe subscribes to the Observable and produces the array of heroes to *ngFor.

Create the HeroSearchComponent class and metadata.

Search terms

Focus on the searchTerms:

A Subject is a producer of an observable event stream; searchTerms produces an Observable of strings, the filter criteria for the name search.

Each call to search() puts a new string into this subject's observable stream by calling next().

{@a ngoninit}

Initialize the heroes property (ngOnInit)

A Subject is also an Observable. You can turn the stream of search terms into a stream of Hero arrays and assign the result to the heroes property.

Passing every user keystroke directly to the HeroSearchService would create an excessive amount of HTTP requests, taxing server resources and burning through the cellular network data plan.

Instead, you can chain Observable operators that reduce the request flow to the string Observable. You'll make fewer calls to the HeroSearchService and still get timely results. Here's how:

• 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 (formerly known as flatMapLatest), every qualifying key event can trigger an http() 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.

If the search text is empty, the http() method call is also short circuited and an observable containing an empty array is returned.

Note that until the service supports that feature, canceling the HeroSearchService Observable doesn't actually abort a pending HTTP request. For now, unwanted results are discarded.

• catch intercepts a failed observable. The simple example prints the error to the console; a real life app would do better. Then to clear the search result, you return an observable containing an empty array.

{@a rxjs-imports}

Import RxJS operators

Most RxJS operators are not included in Angular's base Observable implementation. The base implementation includes only what Angular itself requires.

When you need more RxJS features, extend Observable by importing the libraries in which they are defined. Here are all the RxJS imports that this component needs:

The import 'rxjs/add/...' syntax may be unfamiliar. It's missing the usual list of symbols between the braces: {...}.

You don't need the operator symbols themselves. In each case, the mere act of importing the library loads and executes the library's script file which, in turn, adds the operator to the Observable class.

Add the search component to the dashboard

Add the hero search HTML element to the bottom of the DashboardComponent template.

Finally, import HeroSearchComponent from hero-search.component.ts and add it to the declarations array.

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.

App structure and code

Review the sample source code in the for this page. Verify that you have the following structure:

angular-tour-of-heroes

<div class='file'>
  src
</div>

<div class='children'>

  <div class='file'>
    app
  </div>

  <div class='children'>

    <div class='file'>
      app.component.ts
    </div>

    <div class='file'>
      app.component.css
    </div>

    <div class='file'>
      app.module.ts
    </div>

    <div class='file'>
      app-routing.module.ts
    </div>

    <div class='file'>
      dashboard.component.css
    </div>

    <div class='file'>
      dashboard.component.html
    </div>

    <div class='file'>
      dashboard.component.ts
    </div>

    <div class='file'>
      hero.ts
    </div>

    <div class='file'>
      hero-detail.component.css
    </div>

    <div class='file'>
      hero-detail.component.html
    </div>

    <div class='file'>
      hero-detail.component.ts
    </div>

    <div class='file'>
      hero-search.component.html (new)
    </div>

    <div class='file'>
      hero-search.component.css (new)
    </div>

    <div class='file'>
      hero-search.component.ts (new)
    </div>

    <div class='file'>
      hero-search.service.ts (new)
    </div>

    <div class='file'>
      hero.service.ts
    </div>

    <div class='file'>
      heroes.component.css
    </div>

    <div class='file'>
      heroes.component.html
    </div>

    <div class='file'>
      heroes.component.ts
    </div>

    <div class='file'>
      in-memory-data.service.ts (new)
    </div>

  </div>

  <div class='file'>
    main.ts
  </div>

  <div class='file'>
    index.html
  </div>

  <div class='file'>
    styles.css
  </div>

  <div class='file'>
    systemjs.config.js
  </div>

  <div class='file'>
    tsconfig.json
  </div>

</div>

<div class='file'>
  node_modules ...
</div>

<div class='file'>
  package.json
</div>

Home Stretch

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.

Here are the files you added or changed in this page.

Next step

Return to the learning path, where you can read more about the concepts and practices found in this tutorial.