Angular2のステートフルなパイプの使用方法

Angular2でAsyncPipeを使った非同期のパイプ、ステートフルなカスタムパイプの作成方法を確認してまとめました。
※Angular2の2.0.0版、TypeScriptを使って確認したものです。

(1)AsyncPipeを使ってステートフルなパイプ


 
1)AsyncPipe
 
・AsyncPipeは、入力としてPromiseまたはObservableを受け取り、解決されると自動で入力に設定された値を返す。
 
事前に定義した登録作業を保持し、登録作業の結果に応じて値がリターンされる。
 
・パイプで”async”キーワードを指定する。
 
2)サンプルコード
 
2秒間待機してからメッセージを表示するサンプルを作成
 

(テンプレート)
<button (click)="click1()">asyncパイプ</button>
<p>{{ result1 | async }}</p>
 
(コンポーネントクラス)
result1: Promise<string> = null;
click1() {
  this.result1 = new Promise<string>((resolve, reject) => { 
    setTimeout(function() {
      resolve("実行終了");
    }, 2000)
  });
}

(2)ステートフルなカスタムパイプ


 
1)カスタムパイプのpure属性
 
・パイプはデフォルトはステートレス。
・ステートフルにする場合は、@Pipeデコレーターのpure属性をfalseに設定する。
 
これによって、Angularの更新検知システムはその入力値の変更の如何に関わらず、各サイクルでパイプの出力をチェックするようになる。
 
2)サンプルコード
 
累乗計算を非同期に行うカスタムパイプのサンプルを作成
 
①カスタムパイプを定義 pow.pipe.ts

import {Pipe, PipeTransform} from '@angular/core';

@Pipe({
  name: 'pow',
  pure: false
})
export class PowPipe implements PipeTransform{
  private fetchedValue:number;
  private fetchPromise:Promise<number>;

  transform(value:number, args:string):number {
    if (!this.fetchPromise) {
      this.fetchPromise = new Promise<number>((resolve) => {
        let result = Math.pow(value, parseInt(args || '1', 10));
        setTimeout(()=>resolve(result), 2000);
      });
      this.fetchPromise.then((val:number) => this.fetchedValue = val);
    }
    return this.fetchedValue;
  }
}

②コンポーネントで上記カスタムパイプを使用

import {PowPipe} from './pow.pipe.ts';

@Component({
  selector: 'my-app',
  template: `
  <strong>ステートフルカスタムパイプ</strong><br />
  <p>11の2乗: {{11 | pow: 2 }}</p>
  <p>12の2乗: {{12 | pow: 2 }}</p>
  <p>13の2乗: {{13 | pow: 2 }}</p>
  `,
  pipes: [PowPipe]
})
export class MyApp {
}
bootstrap(MyApp);

 

(3)デモ


 
Angular : 2.0.0
Bootstrap : 3.2.0

Loading…

<html>
  <head>
    <title>Angular 2 Demo</title>
    <script src="https://npmcdn.com/core-js/client/shim.min.js"></script>
    <script src="https://npmcdn.com/zone.js@0.6.23?main=browser"></script>
    <script src="https://npmcdn.com/reflect-metadata@0.1.3"></script>
    <script src="https://npmcdn.com/systemjs@0.19.27/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 = '@2.0.0';
  var routerVer = '@3.0.0';
  var formsVer = '@2.0.0';
  var routerDeprecatedVer = '@2.0.0-rc.2';
  var map = {
    'app':                        'app',
    '@angular':                   'https://npmcdn.com/@angular',
    '@angular/router':            'https://npmcdn.com/@angular/router' + routerVer,
    '@angular/forms':             'https://npmcdn.com/@angular/forms' + formsVer,
    '@angular/router-deprecated': 'https://npmcdn.com/@angular/router-deprecated' + routerDeprecatedVer,
    'angular2-in-memory-web-api': 'https://npmcdn.com/angular2-in-memory-web-api',
    'rxjs':                       'https://npmcdn.com/rxjs@5.0.0-beta.12',
    'ts':                         'https://npmcdn.com/plugin-typescript@4.0.10/lib/plugin.js',
    'typescript':                 'https://npmcdn.com/typescript@1.9.0-dev.20160409/lib/typescript.js',
 };
  var packages = {
    'app':                        { main: 'main.ts',  defaultExtension: 'ts' },
    'rxjs':                       { defaultExtension: 'js' },
    'angular2-in-memory-web-api': { main: 'index.js', defaultExtension: 'js' },
  };

  var ngPackageNames = [
    'common',
    'compiler',
    'core',
    'http',
    'platform-browser',
    'platform-browser-dynamic',
    'upgrade',
  ];
  ngPackageNames.forEach(function(pkgName) {
    map['@angular/'+pkgName] = 'https://npmcdn.com/@angular/' + pkgName + ngVer;
  });
  ngPackageNames.concat(['forms', 'router', 'router-deprecated']).forEach(function(pkgName) {
    packages['@angular/'+pkgName] = { main: '/bundles/' + pkgName + '.umd.js', defaultExtension: 'js' };
  });

  var config = {
    transpiler: 'ts',
    meta: {
      'typescript': {
        "exports": "ts"
      }
    },
    map: map,
    packages: packages
  };

  System.config(config);

})(this);

メインコンポーネント
import { platformBrowserDynamic } from '@angular/platform-browser-dynamic'; import { NgModule } from '@angular/core'; import { BrowserModule } from '@angular/platform-browser'; import { Component } from '@angular/core'; import { PowPipe } from './pow.pipe.ts'; @Component({ selector: 'my-app', template: ` <strong>非同期パイプ</strong><br /> <button (click)="click1()">asyncパイプ</button> <p>{{ result1 | async }}</p> <button (click)="click2()">asyncパイプ未使用</button> <p>{{ result2 }}</p> <strong>ステートフルカスタムパイプ</strong><br /> <p>11の2乗: {{11 | pow: 2 }}</p> <p>12の2乗: {{12 | pow: 2 }}</p> <p>13の2乗: {{13 | pow: 2 }}</p> `, pipes: [PowPipe] }) export class AppComponent { result1: Promise<string> = null; result2: string = "初期値"; click1() { this.result1 = new Promise<string>((resolve, reject) => { setTimeout(function() { resolve("実行終了"); }, 2000) }); } click2() { setTimeout(function() { this.result2 = "実行終了"; console.log(result2); }, 2000) } } @NgModule({ imports: [ BrowserModule ], declarations: [ AppComponent, PowPipe ], bootstrap: [ AppComponent ] }) export class AppModule { } platformBrowserDynamic().bootstrapModule(AppModule); pow.pipe.ts
import {Pipe, PipeTransform} from '@angular/core'; @Pipe({ name: 'pow', pure: false }) export class PowPipe implements PipeTransform{ private fetchedValue:number; private fetchPromise:Promise<number>; transform(value:number, args:string):number { if (!this.fetchPromise) { this.fetchPromise = new Promise<number>((resolve) => { let result = Math.pow(value, parseInt(args || '1', 10)); setTimeout(()=>resolve(result), 2000); }); this.fetchPromise.then((val:number) => this.fetchedValue = val); } return this.fetchedValue; } }

関連記事の目次

コメントを残す

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