Angular2でAsyncPipeを使った非同期のパイプ、ステートフルなカスタムパイプの作成方法を確認してまとめました。
※Angular2の2.0.0版、TypeScriptを使って確認したものです。（デモはv4.4.3、v2.0.0で動作確認）
※目次をクリックすると目次の下部にコンテンツが表示されます。
AsyncPipeを使ってステートフルなパイプ
１）AsyncPipe
・AsyncPipeは、入力としてPromiseまたはObservableを受け取り、解決されると自動で入力に設定された値を返す。
事前に定義した登録作業を保持し、登録作業の結果に応じて値がリターンされる。
・パイプで”async”キーワードを指定する。
２）サンプルコード
２秒間待機してからメッセージを表示するサンプルを作成
・AsyncPipeは、入力としてPromiseまたはObservableを受け取り、解決されると自動で入力に設定された値を返す。
事前に定義した登録作業を保持し、登録作業の結果に応じて値がリターンされる。
・パイプで”async”キーワードを指定する。
２）サンプルコード
２秒間待機してからメッセージを表示するサンプルを作成
（テンプレート）
<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)
});
}
ステートフルなカスタムパイプ
１）カスタムパイプのpure属性
・パイプはデフォルトはステートレス。
・ステートフルにする場合は、@Pipeデコレーターのpure属性をfalseに設定する。
これによって、Angularの更新検知システムはその入力値の変更の如何に関わらず、各サイクルでパイプの出力をチェックするようになる。
２）サンプルコード
累乗計算を非同期に行うカスタムパイプのサンプルを作成
①カスタムパイプを定義 pow.pipe.ts
・パイプはデフォルトはステートレス。
・ステートフルにする場合は、@Pipeデコレーターのpure属性をfalseに設定する。
これによって、Angularの更新検知システムはその入力値の変更の如何に関わらず、各サイクルでパイプの出力をチェックするようになる。
２）サンプルコード
累乗計算を非同期に行うカスタムパイプのサンプルを作成
①カスタムパイプを定義 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);
デモ
Angular : 4.4.3（2.0.0でも動作確認済み）
Bootstrap : 3.x
関連記事の目次
Bootstrap : 3.x
<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 } 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; } }