Angular2でPromiseを使って非同期にデータを取得

サービスを介してリモートサーバーからデータを取得する場合など、遅延が発生すると同期処理だと処理がブロックされてしまいます。Promiseを使って非同期にデータを取得する方法を確認し、サンプルを作成しました。
※Angular2の2.0.0版、TypeScriptを使って確認したものです。(デモはv4.4.3、v2.0.0で動作確認)

※目次をクリックすると目次の下部にコンテンツが表示されます。

Promiseの使用方法
1)プロミスを生成
 
●構文
new Promise(function(resolve, reject) { … });
 
・new Promiseコンストラクタで生成。
・2つの引数resolveとrejectを持つハンドラーをリターン。
・1番目の引数はプロミスが成功した場合、2番目の引数は失敗した場合に実行されるメソッド。
 
例)”tf”がtrueの場合、3秒後にresolveメソッドを実行し、”処理成功”というメッセージ、falseの場合、同様に”処理失敗の”メッセージを渡す。

var p = new Promise(function(resolve, reject) {
  if (tf) {
    setTimeout(()=>resolve("処理成功"), 3000);
  } else {
    setTimeout(()=>reject("処理失敗"), 3000);
  }

※即、解決されるPromiseを生成する場合は、Promise.resolve()メソッドを使用する。
 
2)Promiseがresolve、rejectされた時の処理内容を定義
 
①thenメソッド
 
●構文(pはPromiseオブジェクト)
p.then(function(value) {
// Promiseが成功したとき呼ばれる関数。resolveの引数の値が渡される。
}, function(reason) {
// Promiseが失敗したとき呼ばれる関数。rejectの引数の値が渡される。
});
 
②catchメソッド
 
●構文(pはPromiseオブジェクト)
p.catch(function(reason) {
// Promiseが失敗したとき呼ばれる関数。rejectの引数の値が渡される。
});
例)resolve、rejectされて渡された値をthis.msg変数に保持
p.then(val => this.msg = val)
.catch(err => this.msg = err);

HttpクライアントでPromiseを使用
Angular2のHTTPクライアントでは、Observableがリターンされますが、ObservableをPromiseに変換して、Promiseとして非同期処理を行うこともできます。
 
※Httpクライアントの使用方法はこちら

●Httpを処理するサービス

import {Injectable} from '@angular/core';
import {Http} from '@angular/http';
import {Observable} from 'rxjs/Observable';

@Injectable()
export class PromiseService {
  constructor (private _http: Http) {};
  get() {
    return this._http.get('/server.php').toPromise();
  }
};

 
●コンポーネント

  get() {
    this.msg = "処理中・・・";
    this._promiseService.get()
      .then(msg => this.msg = msg.json())
      .catch(err => this.msg = err);
  };

デモ
コンポーネントからサービスに対しメッセージ取得の処理を依頼し、実行できる状態(タイムアウト後)になってからサービスからメッセージを非同期で受け取り、表示するサンプルを作成しました。
 
Angular : 4.4.3(2.0.0でも動作確認済み)
Bootstrap : 3.x

Loading…

<html>
  <head>
    <title>Angular 2 Demo</title>
    <script src="https://npmcdn.com/core-js/client/shim.min.js"></script>
    <script src="https://unpkg.com/zone.js@0.7.4?main=browser"></script>
    <script src="https://npmcdn.com/systemjs@0.19.39/dist/system.src.js"></script>
    <script src="./js/systemjs.config.js"></script>
    <script>
      System.import('./ts/app.ts').catch(function(err){ console.error(err);  });    </script>
    <link rel="stylesheet" href="./css/bootstrap.min.css">
    <link rel="stylesheet" href="./css/styles.css">
  </head>
  <body>
    <div class="container">
      <my-app>Loading...</my-app>
    </div>
  </body>
</html>

(systemjs.config.js)
(function (global) {
  var ngVer = '@4.4.3';
  System.config({
    transpiler: 'ts',
    typescriptOptions: {
      "target": "es5",
      "module": "commonjs",
      "moduleResolution": "node",
      "sourceMap": true,
      "emitDecoratorMetadata": true,
      "experimentalDecorators": true,
      "lib": ["es2015", "dom"],
      "noImplicitAny": true,
      "suppressImplicitAnyIndexErrors": true,
      "strict": true
    },
    meta: {
      'typescript': {
        "exports": "ts"
      }
    },
    paths: {
      'npm:': 'https://unpkg.com/'
    },
    map: {
      'app': 'app',
      '@angular/animations': 'npm:@angular/animations' + ngVer + '/bundles/animations.umd.js',
      '@angular/animations/browser': 'npm:@angular/animations' + ngVer + '/bundles/animations-browser.umd.js',
      '@angular/core': 'npm:@angular/core' + ngVer + '/bundles/core.umd.js',
      '@angular/common': 'npm:@angular/common' + ngVer + '/bundles/common.umd.js',
      '@angular/common/http': 'npm:@angular/common' + ngVer + '/bundles/common-http.umd.js',
      '@angular/compiler': 'npm:@angular/compiler' + ngVer + '/bundles/compiler.umd.js',
      '@angular/platform-browser': 'npm:@angular/platform-browser' + ngVer + '/bundles/platform-browser.umd.js',
      '@angular/platform-browser/animations': 'npm:@angular/platform-browser' + ngVer + '/bundles/platform-browser-animations.umd.js',
      '@angular/platform-browser-dynamic': 'npm:@angular/platform-browser-dynamic' + ngVer + '/bundles/platform-browser-dynamic.umd.js',
      '@angular/http': 'npm:@angular/http' + ngVer + '/bundles/http.umd.js',
      '@angular/router': 'npm:@angular/router' + ngVer + '/bundles/router.umd.js',
      '@angular/router/upgrade': 'npm:@angular/router' + ngVer + '/bundles/router-upgrade.umd.js',
      '@angular/forms': 'npm:@angular/forms' + ngVer + '/bundles/forms.umd.js',
      '@angular/upgrade': 'npm:@angular/upgrade' + ngVer + '/bundles/upgrade.umd.js',
      '@angular/upgrade/static': 'npm:@angular/upgrade' + ngVer + '/bundles/upgrade-static.umd.js',

      // other libraries
      'rxjs':                      'npm:rxjs@5.0.1',
      'tslib':                     'npm:tslib/tslib.js',
      'angular-in-memory-web-api': 'npm:angular-in-memory-web-api/bundles/in-memory-web-api.umd.js',
      'ts':                        'npm:plugin-typescript@5.2.7/lib/plugin.js',
      'typescript':                'npm:typescript@2.3.2/lib/typescript.js',

    },
    // packages tells the System loader how to load when no filename and/or no extension
    packages: {
      app: {
        main: './main.ts',
        defaultExtension: 'ts',
        meta: {
          './*.ts': {
            loader: 'systemjs-angular-loader.js'
          }
        }
      },
      rxjs: {
        defaultExtension: 'js'
      }
    }
  });

})(this);

メインコンポーネント
import { platformBrowserDynamic } from '@angular/platform-browser-dynamic'; import { NgModule } from '@angular/core'; import { BrowserModule } from '@angular/platform-browser'; import { Component,Input } from '@angular/core'; import { HttpModule } from '@angular/http'; import { PromiseService } from './promise.service.ts'; import 'rxjs/add/observable/throw'; import 'rxjs/add/operator/catch'; import 'rxjs/add/operator/debounceTime'; import 'rxjs/add/operator/distinctUntilChanged'; import 'rxjs/add/operator/map'; import 'rxjs/add/operator/switchMap'; import 'rxjs/add/operator/toPromise'; @Component({ selector: 'my-app', template: ` <strong>Promiseデモ</strong><br /> <button (click)="get(true)">msg取得(成功)</button> <button (click)="get(false)">msg取得(失敗)</button><br /> {{msg}}<br /> <strong>HttpクライアントでPromise使用</strong><br /> <button (click)="get_http()">msg取得</button><br /> {{msg_http}} `, providers: [PromiseService] }) export class AppComponent { public msg: string = '初期値'; public msg_http: string = '初期値'; constructor(private _promiseService: PromiseService) { }; get(tf: boolean) { this.msg = "処理中・・・"; this._promiseService.get(tf) .then(msg => this.msg = msg) .catch(err => this.msg = err); }; get_http() { this.msg_http = "処理中・・・"; this._promiseService.get_http() .then(msg => this.msg_http = msg.text()) .catch(err => this.msg_http = err); }; } @NgModule({ imports: [ BrowserModule, HttpModule ], declarations: [ AppComponent ], bootstrap: [ AppComponent ] }) export class AppModule { } platformBrowserDynamic().bootstrapModule(AppModule); サービス
import {Injectable} from '@angular/core'; import {Http} from '@angular/http'; import {Observable} from 'rxjs/Observable'; @Injectable() export class PromiseService { constructor (private _http: Http) {}; get(tf: boolean) { ++this._totalCount; return new Promise<string>(function(resolve, reject) { if (tf) { setTimeout(()=>resolve("処理成功 全回数:" + ++totalCount), 3000); } else { setTimeout(()=>reject("処理失敗 全回数:" + ++totalCount), 3000); } }); } get_http() { return this._http.get('/wp/server.php').toPromise(); } }; var totalCount: number = 0;

関連記事の目次

コメントを残す

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です