创建自定义的 Angular 管道

我们在上一篇文章中,了解了什么是 Angular 管道,以及如何使用 Angular 提供的一些常用管道。本文将进一步深入探讨如何创建一个 Angular 管道,实现对数据的自定义转换。

创建管道

我们可以使用 Angular CLI 的 generate 命令,创建一个管道:

ng generate pipe sort

输出结果:

CREATE src/app/sort.pipe.spec.ts (179 bytes)
CREATE src/app/sort.pipe.ts (213 bytes)
UPDATE src/app/app.module.ts (581 bytes)

Angular CLI 为我们创建了管道文件sort.pipe.ts及其单元测试文件ort.pipe.spec.ts. 还要注意到,Angular CLI 对 app.module.ts 文件进行了更新,把刚刚创建的管道,添加到主模块的 declarations 属性中,完成了注册。

…

@NgModule({
  declarations: [
    …
    SortPipe
  ],
  imports: [
    BrowserModule
  ],
  providers: [
  ],
  bootstrap: [AppComponent]
})
export class AppModule { }

一个管道就是一个装饰了 @Pipe 的 TypeScript 类,并实现了 PipeTransform 接口。@Pipename 属性是必需属性,用来设置管道的名称。实现 PipeTransform 接口的 transform 方法,完成对数据的转换工作。

src/app/sort.pipe.ts

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

@Pipe({
  name: ‘sort’
})
export class SortPipe implements PipeTransform {

  transform(value: unknown, ...args: unknown[]): unknown {
    return null;
  }

}

参数说明:

  • value,需要进行转换的数据
  • args,可选的参数列表,参数之间使用逗号分割

调整接口数据类型

因为我们创建的管道,需要对图书数组对象进行操作,所以,要对transform 方法中的一些数据的类型进行调整:

  1. 把参数 value 的数据类型改为 Book[].
  2. 把参数 args 的数据类型改为 string,并移除参数前面的三个点。
  3. 把返回值的数据类型改为 Book[].

调整后的 transform 方法如下所示:

  transform(value: Book[], args: string): Book[] {
    return null;
  }

实现排序逻辑

接下来,我们在 transform 方法中,对图书数组中的图书,按照 args 指定的属性进行排序。

  transform(value: Book[], args: string): Book[] {
    if (value) {
      return value.sort((a: Book, b: Book) => {
        if (a[args] < b[args]) {
          return -1;
        } else if (b[args] < a[args]) {
          return 1;
        }
        return 0;
      });
    }
    return [];
  }

按价格进行排序

我们把 ngForsort 管道进行结合,先把图书列表中的图书按价格进行排序,然后再把排序后的结果,显示到页面上。

<ul>
  <li *ngFor="let book of books | sort:'price'">{{book.name}}</li>
</ul>

页面效果

图书列表按价格排序

源代码

src/app/sort.pipe.ts

import { Pipe, PipeTransform } from '@angular/core’;
import { Book } from "./book/book”;

@Pipe({
  name: ‘sort’
})
export class SortPipe implements PipeTransform {

  transform(value: Book[], args: string): Book[] {
    if (value) {
      return value.sort((a: Book, b: Book) => {
        if (a[args] < b[args]) {
          return -1;
        } else if (b[args] < a[args]) {
          return 1;
        }
        return 0;
      });
    }
    return [];
  }

}

src/app/book/book.ts

export interface Book {
  id: number,
  name: string,
  price: number
}

src/app/app.component.ts

import { Component } from '@angular/core’;
import { Book } from "./book/book”;

@Component({
  selector: 'app-root’,
  templateUrl: './app.component.html’,
  styleUrls: ['./app.component.css’]
})
export class AppComponent {
  title = 'Hello Angular 10’;
  bookName = "《三体》”;
  books: Book[] = [
    {id: 1, name: '《三体》', price: 50.00},
    {id: 2, name: '《黑暗森林》', price: 40.00},
    {id: 3, name: '《死神永生》', price: 60.00},
    {id: 4, name: '《超新星纪元》', price: 35.00}
  ];
  specialBook = "《超新星纪元》”;

  onLike(event) {
    if (event) {
      window.alert(`我喜欢 ${this.bookName}。`);
    } else {
      window.alert(`我不再喜欢 ${this.bookName}。`);
    }
  }
}

src/app/app.component.html

<p>{{'hello angular 10' | uppercase}}</p>
<p>{{'HELLO ANGULAR 10' | lowercase}}</p>

<app-book [name]="bookName" (liked)="onLike($event)"></app-book>

<h4>更多图书</h4>

<ul>
  <li *ngFor="let book of books | sort:'price'">{{book.name}}</li>
</ul>

<h4>今日推荐</h4>

<div [ngSwitch]=“specialBook”>
  <p *ngSwitchCase="'《三体》'">{{specialBook}}</p>
  <p *ngSwitchCase="'《超新星纪元》'">{{specialBook}}</p>
  <p *ngSwitchCase="'《黑暗森林》'">{{specialBook}}</p>
  <p *ngSwitchDefault="'《死神永生》'">{{specialBook}}</p>
</div>
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,179评论 5 476
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,229评论 2 380
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,032评论 0 336
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,533评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,531评论 5 365
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,539评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,916评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,574评论 0 256
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,813评论 1 296
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,568评论 2 320
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,654评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,354评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,937评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,918评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,152评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,852评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,378评论 2 342

推荐阅读更多精彩内容