Every application starts out with what seems like a simple task: get data, transform them, and show them to users.
Getting data could be as simple as creating a local variable or as complex as streaming data over a WebSocket.
Once data arrive, you could push their raw toString values directly to the view,
but that rarely makes for a good user experience.
For example, in most use cases, users prefer to see a date in a simple format like
April 15, 1988 rather than the raw string format
Fri Apr 15 1988 00:00:00 GMT-0700 (Pacific Daylight Time).
Clearly, some values benefit from a bit of editing. You may notice that you
desire many of the same transformations repeatedly, both within and across many applications.
You can almost think of them as styles.
In fact, you might like to apply them in your HTML templates as you do styles.
通过引入Angular管道,我们可以把这种简单的“显示-值”转换器声明在HTML中。
Introducing Angular pipes, a way to write display-value transformations that you can declare in your HTML.
A pipe takes in data as input and transforms it to a desired output.
In this page, you'll use pipes to transform a component's birthday property into
a human-friendly date.
src/app/hero-birthday1.component.ts
import{Component}from'@angular/core';@Component({
selector:'hero-birthday',template:`<p>The hero's birthday is {{ birthday | date }}</p>`})exportclassHeroBirthdayComponent{
birthday =newDate(1988,3,15);// April 15, 1988}
重点看下组件的模板。
Focus on the component's template.
<p>The hero's birthday is {{ birthday | date }}</p>
Inside the interpolation expression, you flow the component's birthday value through the
pipe operator ( | ) to the Date pipe
function on the right. All pipes work this way.
The Date and Currency pipes need the ECMAScript Internationalization API.
Safari and other older browsers don't support it. You can add support with a polyfill.
Angular comes with a stock of pipes such as
DatePipe, UpperCasePipe, LowerCasePipe, CurrencyPipe, and PercentPipe.
They are all available for use in any template.
A pipe can accept any number of optional parameters to fine-tune its output.
To add parameters to a pipe, follow the pipe name with a colon ( : ) and then the parameter value
(such as currency:'EUR'). If the pipe accepts multiple parameters, separate the values with colons (such as slice:1:5)
The parameter value can be any valid template expression,
(see the Template expressions section of the
Template Syntax page)
such as a string literal or a component property.
In other words, you can control the format through a binding the same way you control the birthday value through a binding.
我们来写第二个组件,它把管道的格式参数绑定到该组件的format属性。这里是新组件的模板:
Write a second component that binds the pipe's format parameter
to the component's format property. Here's the template for that component:
You also added a button to the template and bound its click event to the component's toggleFormat() method.
That method toggles the component's format property between a short form
('shortDate') and a longer form ('fullDate').
src/app/hero-birthday2.component.ts (class)
exportclassHeroBirthday2Component{
birthday =newDate(1988,3,15);// April 15, 1988
toggle =true;// start with true == shortDateget format(){returnthis.toggle ?'shortDate':'fullDate';}
toggleFormat(){this.toggle =!this.toggle;}}
当我们点击按钮的时候,显示的日志会在“04/15/1988”和“Friday, April 15, 1988”之间切换。
As you click the button, the displayed date alternates between
"04/15/1988" and
"Friday, April 15, 1988".
You can chain pipes together in potentially useful combinations.
In the following example, to display the birthday in uppercase,
the birthday is chained to the DatePipe and on to the UpperCasePipe.
The birthday displays as APR 15, 1988.
The chained hero's birthday is
{{ birthday | date | uppercase}}
下面这个显示FRIDAY, APRIL 15, 1988的例子用同样的方式链接了这两个管道,而且同时还给date管道传进去一个参数。
This example—which displays FRIDAY, APRIL 15, 1988—chains
the same pipes as above, but passes in a parameter to date as well.
The chained hero's birthday is
{{ birthday | date:'fullDate' | uppercase}}
The pipe class implements the PipeTransform interface's transform method that
accepts an input value followed by optional parameters and returns the transformed value.
The @Pipe decorator allows you to define the
pipe name that you'll use within template expressions. It must be a valid JavaScript identifier.
Your pipe's name is exponentialStrength.
The transform method is essential to a pipe.
The PipeTransforminterface defines that method and guides both tooling and the compiler.
Technically, it's optional; Angular looks for and executes the transform method regardless.
You must manually register custom pipes.
If you don't, Angular reports an error.
In the previous example, you didn't list the DatePipe because all
Angular built-in pipes are pre-registered.
It's not much fun updating the template to test the custom pipe.
Upgrade the example to a "Power Boost Calculator" that combines
your pipe and two-way data binding with ngModel.
Angular looks for changes to data-bound values through a change detection process that runs after every DOM event:
every keystroke, mouse move, timer tick, and server response. This could be expensive.
Angular strives to lower the cost whenever possible and appropriate.
当我们使用管道时,Angular选用了一种简单、快速的变更检测算法。
Angular picks a simpler, faster change detection algorithm when you use a pipe.
In the next example, the component uses the default, aggressive change detection strategy to monitor and update
its display of every hero in the heroes array. Here's the template:
src/app/flying-heroes.component.html (v1)
New hero:
<inputtype="text" #box
(keyup.enter)="addHero(box.value); box.value=''"placeholder="hero name"><button (click)="reset()">Reset</button><div *ngFor="let hero of heroes">
{{hero.name}}
</div>
和模板相伴的组件类可以提供英雄数组,能把新的英雄添加到数组中,还能重置英雄数组。
The companion component class provides heroes, adds heroes into the array, and can reset the array.
You can add heroes and Angular updates the display when you do.
If you click the reset button, Angular replaces heroes with a new array of the original heroes and updates the display.
If you added the ability to remove or change a hero, Angular would detect those changes and update the display as well.
Although you're not getting the behavior you want, Angular isn't broken.
It's just using a different change-detection algorithm that ignores changes to the list or any of its items.
You add the hero into the heroes array. The reference to the array hasn't changed.
It's the same array. That's all Angular cares about. From its perspective, same array, no change, no display update.
To fix that, create an array with the new hero appended and assign that to heroes.
This time Angular detects that the array reference has changed.
It executes the pipe and updates the display with the new array, which includes the new flying hero.
If you mutate the array, no pipe is invoked and the display isn't updated;
if you replace the array, the pipe executes and the display is updated.
The Flying Heroes application extends the
code with checkbox switches and additional displays to help you experience these effects.
Replacing the array is an efficient way to signal Angular to update the display.
When do you replace the array? When the data change.
That's an easy rule to follow in this example
where the only way to change the data is by adding a hero.
More often, you don't know when the data have changed,
especially in applications that mutate data in many ways,
perhaps in application locations far away.
A component in such an application usually can't know about those changes.
Moreover, it's unwise to distort the component design to accommodate a pipe.
Strive to keep the component class independent of the HTML.
The component should be unaware of pipes.
为了过滤会飞的英雄,我们要使用非纯(impure)管道。
For filtering flying heroes, consider an impure pipe.
There are two categories of pipes: pure and impure.
Pipes are pure by default. Every pipe you've seen so far has been pure.
You make a pipe impure by setting its pure flag to false. You could make the FlyingHeroesPipe
impure like this:
@Pipe({
name:'flyingHeroesImpure',
pure:false})
在继续往下走之前,我们先理解一下纯和非纯之间的区别,从纯管道开始。
Before doing that, understand the difference between pure and impure, starting with a pure pipe.
Angular executes a pure pipe only when it detects a pure change to the input value.
A pure change is either a change to a primitive input value (String, Number, Boolean, Symbol)
or a changed object reference (Date, Array, Function, Object).
Angular ignores changes within (composite) objects.
It won't call a pure pipe if you change an input month, add to an input array, or update an input object property.
This may seem restrictive but it's also fast.
An object reference check is fast—much faster than a deep check for
differences—so Angular can quickly determine if it can skip both the
pipe execution and a view update.
因此,如果我们要和变更检测策略打交道,就会更喜欢用纯管道。
如果不能,我们就可以转回到非纯管道。
For this reason, a pure pipe is preferable when you can live with the change detection strategy.
When you can't, you can use the impure pipe.
Or you might not use a pipe at all.
It may be better to pursue the pipe's purpose with a property of the component,
a point that's discussed laterin this page.
Angular executes an impure pipe during every component change detection cycle.
An impure pipe is called often, as often as every keystroke or mouse-move.
要在脑子里绷着这根弦,我们必须小心翼翼的实现非纯管道。
一个昂贵、迟钝的管道将摧毁用户体验。
With that concern in mind, implement an impure pipe with great care.
An expensive, long-running pipe could destroy the user experience.
The only substantive change is the pipe in the template.
You can confirm in the live example / downloadable example that the flying heroes
display updates as you add heroes, even when you mutate the heroes array.
The Angular AsyncPipe is an interesting example of an impure pipe.
The AsyncPipe accepts a Promise or Observable as input
and subscribes to the input automatically, eventually returning the emitted values.
The AsyncPipe is also stateful.
The pipe maintains a subscription to the input Observable and
keeps delivering values from that Observable as they arrive.
The Async pipe saves boilerplate in the component code.
The component doesn't have to subscribe to the async data source,
extract the resolved values and expose them for binding,
and have to unsubscribe when it's destroyed
(a potent source of memory leaks).
一个非纯而且带缓存的管道
An impure caching pipe
我们来写更多的非纯管道:一个向服务器发起HTTP请求的管道。
Write one more impure pipe, a pipe that makes an HTTP request.
In the following code, the pipe only calls the server when the request URL changes and it caches the server response.
The code uses the Angular http client to retrieve data:
In the previous code sample, the second fetch pipe binding demonstrates more pipe chaining.
It displays the same hero data in JSON format by chaining through to the built-in JsonPipe.
A pure pipe uses pure functions.
Pure functions process inputs and return values without detectable side effects.
Given the same input, they should always return the same output.
The pipes discussed earlier in this page are implemented with pure functions.
The built-in DatePipe is a pure pipe with a pure function implementation.
So are the ExponentialStrengthPipe and FlyingHeroesPipe.
A few steps back, you reviewed the FlyingHeroesImpurePipe—an impure pipe with a pure function.
But always implement a pure pipe with a pure function.
Otherwise, you'll see many console errors regarding expressions that changed after they were checked.
Pipes are a great way to encapsulate and share common display-value
transformations. Use them like styles, dropping them
into your template's expressions to enrich the appeal and usability
of your views.
Angular doesn't provide pipes for filtering or sorting lists.
Developers familiar with AngularJS know these as filter and orderBy.
There are no equivalents in Angular.
This isn't an oversight. Angular doesn't offer such pipes because
they perform poorly and prevent aggressive minification.
Both filter and orderBy require parameters that reference object properties.
Earlier in this page, you learned that such pipes must be impure and that
Angular calls impure pipes in almost every change-detection cycle.
Filtering and especially sorting are expensive operations.
The user experience can degrade severely for even moderate-sized lists when Angular calls these pipe methods many times per second.
filter and orderBy have often been abused in AngularJS apps, leading to complaints that Angular itself is slow.
That charge is fair in the indirect sense that AngularJS prepared this performance trap
by offering filter and orderBy in the first place.
The minification hazard is also compelling, if less obvious. Imagine a sorting pipe applied to a list of heroes.
The list might be sorted by hero name and planet of origin properties in the following way:
<!-- NOT REAL CODE! --><div *ngFor="let hero of heroes | orderBy:'name,planet'"></div>
You identify the sort fields by text strings, expecting the pipe to reference a property value by indexing
(such as hero['name']).
Unfortunately, aggressive minification manipulates the Hero property names so that Hero.name and Hero.planet
become something like Hero.a and Hero.b. Clearly hero['name'] doesn't work.
While some may not care to minify this aggressively,
the Angular product shouldn't prevent anyone from minifying aggressively.
Therefore, the Angular team decided that everything Angular provides will minify safely.
The Angular team and many experienced Angular developers strongly recommend moving
filtering and sorting logic into the component itself.
The component can expose a filteredHeroes or sortedHeroes property and take control
over when and how often to execute the supporting logic.
Any capabilities that you would have put in a pipe and shared across the app can be
written in a filtering/sorting service and injected into the component.
If these performance and minification considerations don't apply to you, you can always create your own such pipes
(similar to the FlyingHeroesPipe) or find them in the community.