attribute-directives.
按照[开发环境](setup.html)的说明，创建一个名叫attribute-directives的项目文件夹。
Create the following source file in the indicated folder:
+makeExample('src/app/highlight.directive.1.ts')
:marked
The `import` statement specifies symbols from the Angular `core`:
`import`语句指定了从 Angular 的`core`库导入的一些符号。
1. `Directive` provides the functionality of the `@Directive` decorator.
`Directive`提供`@Directive`装饰器功能。
1. `ElementRef` [injects](dependency-injection.html) into the directive's constructor
so the code can access the DOM element.
`ElementRef`[注入](dependency-injection.html)到指令构造函数中。这样代码就可以访问 DOM 元素了。
1. `Input` allows data to flow from the binding expression into the directive.
`Input`将数据从绑定表达式传达到指令中。
Next, the `@Directive` decorator function contains the directive metadata in a configuration object
as an argument.
然后，`@Directive`装饰器函数以配置对象参数的形式，包含了指令的元数据。
:marked
`@Directive` requires a CSS selector to identify
the HTML in the template that is associated with the directive.
`@Directive`装饰器需要一个 CSS 选择器，以便从模板中识别出关联到这个指令的 HTML。
The [CSS selector for an attribute](https://developer.mozilla.org/en-US/docs/Web/CSS/Attribute_selectors)
is the attribute name in square brackets.
Here, the directive's selector is `[myHighlight]`.
Angular locates all elements in the template that have an attribute named `myHighlight`.[用于 attribute 的 CSS 选择器](https://developer.mozilla.org/en-US/docs/Web/CSS/Attribute_selectors)就是属性名称加方括号。
这里，指令的选择器是`[myHighlight]`，Angular 将会在模板中找到所有带`myHighlight`属性的元素。
.l-sub-section
:marked
### Why not call it "highlight"?
### 为什么不直接叫做 "highlight"？
Though *highlight* is a more concise name than *myHighlight* and would work,
a best practice is to prefix selector names to ensure
they don't conflict with standard HTML attributes.
This also reduces the risk of colliding with third-party directive names.
尽管*highlight* 是一个比 *myHighlight* 更简洁的名字，而且它确实也能工作。
但是最佳实践是在选择器名字前面添加前缀，以确保它们不会与标准 HTML 属性冲突。
它同时减少了与第三方指令名字发生冲突的危险。
Make sure you do **not** prefix the `highlight` directive name with **`ng`** because
that prefix is reserved for Angular and using it could cause bugs that are difficult to diagnose.
For a simple demo, the short prefix, `my`, helps distinguish your custom directive.
确认你**没有**给`highlight`指令添加**`ng`**前缀。
那个前缀属于 Angular，使用它可能导致难以诊断的 bug。例如，这个简短的前缀`my`可以帮助你区分自定义指令。
:marked
After the `@Directive` metadata comes the directive's controller class,
called `HighlightDirective`, which contains the logic for the directive.
Exporting `HighlightDirective` makes it accessible to other components.
`@Directive`元数据之后就是该指令的控制器类，名叫`HighlightDirective`，它包含该指令的逻辑。
然后导出`HighlightDirective`，以便让它能从其它组件中访问到。
Angular creates a new instance of the directive's controller class for
each matching element, injecting an Angular `ElementRef`
into the constructor.
`ElementRef` is a service that grants direct access to the DOM element
through its `nativeElement` property.
Angular 会为每个匹配的元素创建一个指令控制器类的实例，并把 Angular 的`ElementRef`和`Renderer`注入进构造函数。
`ElementRef`是一个服务，它赋予我们通过它的`nativeElement`属性直接访问 DOM 元素的能力。
`Renderer`服务允许通过代码设置元素的样式。
.l-main-section#apply-directive
:marked
## Apply the attribute directive
## 使用属性型指令
To use the new `HighlightDirective`, create a template that
applies the directive as an attribute to a paragraph (``) element. In Angular terms, the `
` element is the attribute **host**. 要使用这个新的`HighlightDirective`，创建一个模板，把这个指令作为属性应用到一个段落(`p`)元素上。 用 Angular 的话说，`
`元素就是这个属性型指令的**宿主**。
Put the template in its own app.component.html
file that looks like this:
我们把这个模板放到它的app.component.html文件中，就像这样：
+makeExample('src/app/app.component.1.html')
:marked
Now reference this template in the `AppComponent`:
现在，在`AppComponent`中引用这个模板：
+makeExample('src/app/app.component.ts')
:marked
Next, add an `import` statement to fetch the `Highlight` directive and
add that class to the `declarations` NgModule metadata. This way Angular
recognizes the directive when it encounters `myHighlight` in the template.
接下来，添加了一个`import`语句来获得`Highlight`指令类，并把这个类添加到 NgModule 元数据的`declarations`数组中。
这样，当 Angular 在模板中遇到`myHighlight`时，就能认出这是指令了。
+makeExample('src/app/app.module.ts')
:marked
Now when the app runs, the `myHighlight` directive highlights the paragraph text.
运行应用，就会看到我们的指令确实高亮了段落中的文本。
figure.image-display
img(src="/resources/images/devguide/attribute-directives/first-highlight.png" alt="First Highlight")
.l-sub-section
:marked
### Your directive isn't working?
### 你的指令没生效？
Did you remember to add the directive to the `declarations` attribute of `@NgModule`?
It is easy to forget!
你记着设置`@NgModule`的`declarations`数组了吗？它很容易被忘掉。
Open the console in the browser tools and look for an error like this:
打开浏览器调试工具的控制台，会看到像这样的错误信息：
code-example(format="nocode").
EXCEPTION: Template parse errors:
Can't bind to 'myHighlight' since it isn't a known property of 'p'.
:marked
Angular detects that you're trying to bind to *something* but it can't find this directive
in the module's `declarations` array.
After specifying `HighlightDirective` in the `declarations` array,
Angular knows it can apply the directive to components declared in this module.
Angular 检测到你正在尝试绑定到*某些东西*，但它不认识。所以它在`declarations`元数据数组中查找。
把`HighlightDirective`列在元数据的这个数组中，Angular 就会检查对应的导入语句，从而找到`highlight.directive.ts`，并了解`myHightlight`的功能。
:marked
To summarize, Angular found the `myHighlight` attribute on the `
` element. It created an instance of the `HighlightDirective` class and injected a reference to the `
` element into the directive's constructor which sets the `
` element's background style to yellow. 总结：Angular 在`
`元素上发现了一个`myHighlight`属性。 然后它创建了一个`HighlightDirective`类的实例，并把所在元素的引用注入到了指令的构造函数中。 在构造函数中，我们把`
`元素的背景设置为了黄色。 .l-main-section#respond-to-user :marked ## Respond to user-initiated events ## 响应用户引发的事件 Currently, `myHighlight` simply sets an element color. The directive could be more dynamic. It could detect when the user mouses into or out of the element and respond by setting or clearing the highlight color. 当前，`myHighlight`只是简单的设置元素的颜色。 这个指令应该在用户鼠标悬浮一个元素时，设置它的颜色。 Begin by adding `HostListener` to the list of imported symbols; add the `Input` symbol as well because you'll need it soon. 先把`HostListener`加进导入列表中，同时再添加`Input`符号，因为我们很快就要用到它。 +makeExcerpt('src/app/highlight.directive.ts', 'imports', '') :marked Then add two eventhandlers that respond when the mouse enters or leaves, each adorned by the `HostListener` decorator. 然后使用`HostListener`装饰器添加两个事件处理器，它们会在鼠标进入或离开时进行响应。 +makeExcerpt('src/app/highlight.directive.2.ts','mouse-methods', '') :marked The `@HostListener` decorator lets you subscribe to events of the DOM element that hosts an attribute directive, the `
` in this case. `@HostListener`装饰器引用属性型指令的宿主元素，在这个例子中就是`
`。 .l-sub-section :marked Of course you could reach into the DOM with standard JavaScript and and attach event listeners manually. There are at least three problems with _that_ approach: 当然，你可以通过标准的JavaScript方式手动给宿主 DOM 元素附加一个事件监听器。 但这种方法至少有三个问题： 1. You have to write the listeners correctly. 必须正确的书写事件监听器。 1. The code must *detach* the listener when the directive is destroyed to avoid memory leaks. 当指令被销毁的时候，必须*拆卸*事件监听器，否则会导致内存泄露。 1. Talking to DOM API directly isn't a best practice. 必须直接和 DOM API 打交道，应该避免这样做。 :marked The handlers delegate to a helper method that sets the color on the DOM element, `el`, which you declare and initialize in the constructor. 这些处理器委托给了一个辅助方法，它用于为DOM元素设置颜色，`#{_priv}el`就是你在构造器中声明和初始化过的。 +makeExcerpt('src/app/highlight.directive.2.ts (constructor)', 'ctor') :marked Here's the updated directive in full: 下面是修改后的指令代码： +makeExample('src/app/highlight.directive.2.ts') :marked Run the app and confirm that the background color appears when the mouse hovers over the `p` and disappears as it moves out.We run the app and confirm that the background color appears as we move the mouse over the `p` and disappears as we move out. 运行本应用并确认：当把鼠标移到`p`上的时候，背景色就出现了，而移开的时候，它消失了。 figure.image-display img(src="/resources/images/devguide/attribute-directives/highlight-directive-anim.gif" alt="Second Highlight") .l-main-section#bindings :marked ## Pass values into the directive with an _@Input_ data binding ## 使用数据绑定向指令传递值 Currently the highlight color is hard-coded _within_ the directive. That's inflexible. In this section, you give the developer the power to set the highlight color while applying the directive. 现在的高亮颜色是硬编码在指令中的，这不够灵活。 我们应该让指令的使用者可以在模板中通过绑定来设置颜色。 Start by adding a `highlightColor` property to the directive class like this: 我们先把`highlightColor`属性添加到指令类中，就像这样： +makeExcerpt('src/app/highlight.directive.2.ts (highlightColor)','color') a#input :marked ### Binding to an _@Input_ property ### 绑定到_@Input_属性 Notice the `@Input` decorator. It adds metadata to the class that makes the directive's `highlightColor` property available for binding. 注意看`@Input`装饰器。它往类上添加了一些元数据，从而让该指令的`highlightColor`能用于绑定。 It's called an *input* property because data flows from the binding expression _into_ the directive. Without that input metadata, Angular rejects the binding; see [below](#why-input "Why add @Input?") for more about that. 它之所以称为*输入*属性，是因为数据流是从绑定表达式流向指令内部的。 如果没有这个元数据，Angular就会拒绝绑定，参见[稍后](#why-input "为什么要添加@Input?")了解更多。 Try it by adding the following directive binding variations to the `AppComponent` template: 试试把下列指令绑定变量添加到`AppComponent`的模板中： +makeExcerpt('src/app/app.component.1.html (excerpt)', 'color-1') :marked Add a `color` property to the `AppComponent`. 把`color`属性添加到`AppComponent`中： +makeExcerpt('src/app/app.component.1.ts (class)') :marked Let it control the highlight color with a property binding. 让它通过属性绑定来控制高亮颜色。 +makeExcerpt('src/app/app.component.1.html (excerpt)', 'color-2') :marked That's good, but it would be nice to _simultaneously_ apply the directive and set the color _in the same attribute_ like this. 很不错，但还可以更好。我们可以在应用该指令时在同一个属性中设置颜色，就像这样： +makeExcerpt('src/app/app.component.html', 'color', '') :marked The `[myHighlight]` attribute binding both applies the highlighting directive to the `
` element and sets the directive's highlight color with a property binding. You're re-using the directive's attribute selector (`[myHighlight]`) to do both jobs. That's a crisp, compact syntax. `[myHighlight]`属性同时做了两件事：把这个高亮指令应用到了`
`元素上，并且通过属性绑定设置了该指令的高亮颜色。
我们复用了该指令的属性选择器`[myHighlight]`来同时完成它们。
这是清爽、简约的语法。
You'll have to rename the directive's `highlightColor` property to `myHighlight` because that's now the color property binding name.
我们还要把该指令的`highlightColor`改名为`myHighlight`，因为它是颜色属性目前的绑定名。
+makeExcerpt('src/app/highlight.directive.2.ts (renamed to match directive selector)', 'color-2')
:marked
This is disagreeable. The word, `myHighlight`, is a terrible property name and it doesn't convey the property's intent.
这可不好。因为`myHighlight`是一个糟糕的属性名，而且不能反映该属性的意图。
a#input-alias
:marked
### Bind to an _@Input_ alias
### 绑定到_@Input_别名
Fortunately you can name the directive property whatever you want _and_ **_alias it_** for binding purposes.
幸运的是，我们可以随意命名该指令的属性，并且**给它指定一个用于绑定的别名**。
Restore the original property name and specify the selector as the alias in the argument to `@Input`. 恢复原始属性名，并在`@Input`的参数中把选择器`myHighlight`指定为别名。
+makeExcerpt('src/app/highlight.directive.ts (color property with alias)', 'color')
:marked
_Inside_ the directive the property is known as `highlightColor`.
_Outside_ the directive, where you bind to it, it's known as `myHighlight`.
在指令内部，该属性叫`highlightColor`，在外部，当我们绑定到它时，它叫`myHighlight`。
You get the best of both worlds: the property name you want and the binding syntax you want:
这是最好的结果：理想的内部属性名，理想的绑定语法：
+makeExcerpt('src/app/app.component.html', 'color', '')
:marked
Now that you're binding to `highlightColor`, modify the `onMouseEnter()` method to use it.
If someone neglects to bind to `highlightColor`, highlight in red:
现在，我们绑定到了`highlightColor`属性，并修改`onMouseEnter()`方法来使用它。
如果有人忘了绑定到`highlightColor`，那就用红色进行高亮。
+makeExcerpt('src/app/highlight.directive.3.ts (mouse enter)', 'mouse-enter')
:marked
Here's the latest version of the directive class.
这是最终版本的指令类。
+makeExcerpt('src/app/highlight.directive.3.ts')
:marked
## Write a harness to try it
## 写个测试程序试验下
:marked
It may be difficult to imagine how this directive actually works.
In this section, you'll turn `AppComponent` into a harness that
lets you pick the highlight color with a radio button and bind your color choice to the directive.
凭空想象该指令如何工作可不容易。
在本节，我们将把`AppComponent`改成一个测试程序，它让你可以通过单选按钮来选取高亮颜色，并且把你选取的颜色绑定到指令中。
Update app.component.html as follows:把`app.component.html`修改成这样：
+makeExcerpt('src/app/app.component.html', 'v2', '')
:marked
Revise the `AppComponent.color` so that it has no initial value.
修改`AppComponent.color`，让它不再有初始值。+makeExcerpt('src/app/app.component.ts', 'class', '')
:marked
Here are the harness and directive in action.下面是测试程序和指令的动图。
figure.image-display
img(src="/resources/images/devguide/attribute-directives/highlight-directive-v2-anim.gif" alt="Highlight v.2")
.l-main-section#second-property
:marked
## Bind to a second property
## 绑定到第二个属性
This highlight directive has a single customizable property. In a real app, it may need more.
本例的指令只有一个可定制属性，真实的应用通常需要更多。
At the moment, the default color—the color that prevails until
the user picks a highlight color—is hard-coded as "red".
Let the template developer set the default color.
目前，默认颜色（它在用户选取了高亮颜色之前一直有效）被硬编码为红色。我们要让模板的开发者也可以设置默认颜色。
Add a second **input** property to `HighlightDirective` called `defaultColor`:
把第二个名叫`defaultColor`的**输入**属性添加到`HighlightDirective`中：+makeExcerpt('src/app/highlight.directive.ts(defaultColor)')
:marked
Revise the directive's `onMouseEnter` so that it first tries to highlight with the `highlightColor`,
then with the `defaultColor`, and falls back to "red" if both properties are undefined.
修改该指令的`onMouseEnter`，让它首先尝试使用`highlightColor`进行高亮，然后用`defaultColor`，如果它们都没有指定，那就用红色作为后备。
+makeExcerpt('src/app/highlight.directive.ts', 'mouse-enter', '')
:marked
How do you bind to a second property when you're already binding to the `myHighlight` attribute name?
当已经绑定过`myHighlight`属性时，要如何绑定到第二个属性呢？
As with components, you can add as many directive property bindings as you need by stringing them along in the template.
The developer should be able to write the following template HTML to both bind to the `AppComponent.color`
and fall back to "violet" as the default color.
像组件一样，你也可以绑定到指令的很多属性，只要把它们依次写在模板中就行了。
开发者可以绑定到`AppComponent.color`，并且用紫罗兰色作为默认颜色，代码如下：
+makeExcerpt('src/app/app.component.html', 'defaultColor', '')
:marked
Angular knows that the `defaultColor` binding belongs to the `HighlightDirective`
because you made it _public_ with the `@Input` decorator.
Angular之所以知道`defaultColor`绑定属于`HighlightDirective`，是因为我们已经通过`@Input`装饰器把它设置成了*公共*属性。
Here's how the harness should work when you're done coding.
当这些代码完成时，测试程序工作时的动图如下：
figure.image-display
img(src="/resources/images/devguide/attribute-directives/highlight-directive-final-anim.gif" alt="Final Highlight")
.l-main-section
:marked
## Summary
## 总结
This page covered how to:
本章介绍了如何：
* [Build an **attribute directive**](#write-directive) that modifies the behavior of an element.
[构建一个**属性型指令**](#write-directive)，它用于修改一个元素的行为。
* [Apply the directive](#apply-directive) to an element in a template.
[把一个指令应用到](#apply-directive)模板中的某个元素上。
* [Respond to **events**](#respond-to-user) that change the directive's behavior.
[响应**事件**](#respond-to-user)以改变指令的行为。
* [**Bind** values to the directive](#bindings).
[把值**绑定**到指令中](#bindings)。
The final source code follows:
最终的源码如下：
+makeTabs(
`attribute-directives/ts/src/app/app.component.ts,
attribute-directives/ts/src/app/app.component.html,
attribute-directives/ts/src/app/highlight.directive.ts,
attribute-directives/ts/src/app/app.module.ts,
attribute-directives/ts/src/main.ts,
attribute-directives/ts/src/index.html
`,
'',
`app/app.component.ts,
app/app.component.html,
app/highlight.directive.ts,
app/app.module.ts,
main.ts,
index.html
`)
:marked
You can also experience and download the