AngularJS의 지시문 연습 가이드(1) 지시문의 범위를 분리하는 방법을 소개합니다. 두 번째 부분에서는 이전 기사의 소개를 이어갑니다. 먼저 격리된 범위를 사용할 때 지시문 내에서 상위 범위의 속성에 액세스하는 방법을 살펴보겠습니다. 다음으로 컨트롤러 기능 및 포함을 기반으로 명령어의 올바른 범위를 선택하는 방법에 대해 설명합니다. 이 기사는 완전한 메모장 응용 프로그램을 통해 명령 사용을 연습하는 것으로 끝납니다.
범위와 상위 범위 간의 데이터 바인딩 분리
일반적으로 지침의 범위를 분리하면 특히 여러 범위 모델을 작동하려는 경우 많은 편의성을 얻을 수 있습니다. 그러나 코드가 올바르게 작동하려면 지시문 내에서 상위 범위의 속성에 액세스해야 하는 경우도 있습니다. 좋은 소식은 Angular가 바인딩을 통해 상위 범위의 속성을 선택적으로 전달할 수 있는 충분한 유연성을 제공한다는 것입니다. 사용자가 입력 상자에 입력한 색상 이름에 따라 배경색이 변경되는 helloWorld 지시어를 검토해 보겠습니다. 이 지시어에 대해 격리된 범위를 사용했을 때 작동하지 않았던 것을 기억하시나요? 이제 정상으로 되돌려 보겠습니다.
app 변수가 가리키는 Angular 모듈을 초기화했다고 가정합니다. 그런 다음 helloWorld 명령은 다음 코드와 같습니다.
app.directive('helloWorld', function() { return { scope: {}, restrict: 'AE', replace: true, template: '<p style="background-color:{{color}}">Hello World</p>', link: function(scope, elem, attrs) { elem.bind('click', function() { elem.css('background-color','white'); scope.$apply(function() { scope.color = "white"; }); }); elem.bind('mouseover', function() { elem.css('cursor', 'pointer'); }); } }; });
이 지시문을 사용하는 HTML 태그는 다음과 같습니다.
<body ng-controller="MainCtrl"> <input type="text" ng-model="color" placeholder="Enter a color"/> <hello-world/> </body>
위 코드는 현재 작동하지 않습니다. 격리된 범위를 사용하기 때문에 지시문 내부의 {{color}} 표현식은 지시문 내부 범위(상위 범위가 아님)에서 격리됩니다. 그러나 외부 입력 상자 요소의 ng-model 지시문은 상위 범위의 색상 속성을 가리킵니다. 따라서 격리된 범위와 상위 범위에서 이 두 매개 변수를 바인딩하는 방법이 필요합니다. Angular에서는 지시어가 있는 HTML 요소에 속성을 추가하고 지시어 정의 객체에서 해당 범위 속성을 구성하여 이 데이터 바인딩을 수행할 수 있습니다. 데이터 바인딩을 설정하는 여러 가지 방법을 자세히 살펴보겠습니다.
옵션 1: @를 사용하여 단방향 텍스트 바인딩 구현
다음 지시어 정의에서는 격리 범위의 color 속성이 지시어가 있는 HTML 요소의 colorAttr 매개변수에 바인딩되도록 지정합니다. HTML 마크업에서 color-attr 매개변수에 {{color}} 표현식이 할당된 것을 볼 수 있습니다. 표현식의 값이 변경되면 color-attr 매개변수도 변경됩니다. 격리된 범위의 색상 속성 값도 이에 따라 변경됩니다.
app.directive('helloWorld', function() { return { scope: { color: '@colorAttr' }, .... // the rest of the configurations }; });
업데이트된 HTML 마크업 코드는 다음과 같습니다.
<body ng-controller="MainCtrl"> <input type="text" ng-model="color" placeholder="Enter a color"/> <hello-world color-attr="{{color}}"/> </body>
이 방법에서는 문자열({{}} 표현식 사용)만 매개변수에 전달할 수 있으므로 이 방법을 단일 항목 바인딩이라고 부릅니다. 상위 범위의 속성이 변경되면 격리된 범위 모델의 속성 값도 그에 따라 변경됩니다. 지시어 내에서 이 범위 속성의 변경 사항을 모니터링하고 일부 작업을 트리거할 수도 있습니다. 그러나 역방향 패스는 작동하지 않습니다. 격리된 범위의 속성을 조작하여 상위 범위의 값을 변경할 수 없습니다.
참고:
격리된 범위 속성의 이름이 지시문 요소 매개변수와 동일한 경우 더 간단한 방법으로 범위 바인딩을 설정할 수 있습니다.
app.directive('helloWorld', function() { return { scope: { color: '@' }, .... // the rest of the configurations }; });
해당 사용 지침의 HTML 코드는 다음과 같습니다.
<hello-world color="{{color}}"/>
옵션 2: =를 사용하여 양방향 바인딩 구현
지시문의 정의를 다음과 같이 변경해 보겠습니다.
app.directive('helloWorld', function() { return { scope: { color: '=' }, .... // the rest of the configurations }; });
해당 HTML 수정은 다음과 같습니다.
<body ng-controller="MainCtrl"> <input type="text" ng-model="color" placeholder="Enter a color"/> <hello-world color="color"/> </body>
@과 달리 이 방법을 사용하면 단순한 문자열이 아닌 속성에 대한 실제 범위 데이터 모델을 지정할 수 있습니다. 이 방법으로 간단한 문자열, 배열 또는 복잡한 개체를 격리된 범위에 전달할 수 있습니다. 동시에 양방향 바인딩도 지원됩니다. 상위 범위의 속성이 변경될 때마다 해당 격리된 범위의 속성도 변경되며 그 반대의 경우도 마찬가지입니다. 이전과 마찬가지로 이 범위 속성에 대한 변경 사항도 모니터링할 수 있습니다.
옵션 3: &를 사용하여 상위 범위에서 함수 실행
때로는 격리된 범위에서 상위 범위에 정의된 함수를 호출해야 하는 경우가 있습니다. 외부 범위에 정의된 함수에 액세스하려면 &를 사용합니다. 예를 들어 지시어 내부에서 sayHello() 메서드를 호출하려고 합니다. 아래 코드는 수행할 작업을 알려줍니다.
app.directive('sayHello', function() { return { scope: { sayHelloIsolated: '&' }, .... // the rest of the configurations }; });
해당 HTML 코드는 다음과 같습니다.
<body ng-controller="MainCtrl"> <input type="text" ng-model="color" placeholder="Enter a color"/> <say-hello sayHelloIsolated="sayHello()"/> </body>
这个 Plunker 例子对上面的概念做了很好的诠释。
父scope、子scope以及隔离scope的区别
作为一个Angular的新手,你可能会在选择正确的指令scope的时候感到困惑。默认情况下,指令不会创建一个新的scope,而是沿用父scope。但是在很多情况下,这并不是我们想要的。如果你的指令重度地使用父scope的属性、甚至创建新的属性,会污染父scope。让所有的指令都使用同一个父scope不会是一个好主意,因为任何人都可能修改这个scope中的属性。因此,下面的这个原则也许可以帮助你为你的指令选择正确的scope。
1.父scope(scope: false) – 这是默认情况。如果你的指令不操作父scoe的属性,你就不需要一个新的scope。这种情况下是可以使用父scope的。
2.子scope(scope: true) – 这会为指令创建一个新的scope,并且原型继承自父scope。如果你的指令scope中的属性和方法与其他的指令以及父scope都没有关系的时候,你应该创建一个新scope。在这种方式下,你同样拥有父scope中所定义的属性和方法。
3.隔离scope(scope:{}) – 这就像一个沙箱!当你创建的指令是自包含的并且可重用的,你就需要使用这种scope。你在指令中会创建很多scope属性和方法,它们仅在指令内部使用,永远不会被外部的世界所知晓。如果是这样的话,隔离的scope是更好的选择。隔离的scope不会继承父scope。
Transclusion(嵌入)
Transclusion是让我们的指令包含任意内容的方法。我们可以延时提取并在正确的scope下编译这些嵌入的内容,最终将它们放入指令模板中指定的位置。 如果你在指令定义中设置 transclude:true,一个新的嵌入的scope会被创建,它原型继承子父scope。 如果你想要你的指令使用隔离的scope,但是它所包含的内容能够在父scope中执行,transclusion也可以帮忙。
假设我们注册一个如下的指令:
app.directive('outputText', function() { return { transclude: true, scope: {}, template: '<div ng-transclude></div>' }; });
它使用如下:
<div output-text> <p>Hello {{name}}</p> </div>
ng-transclude 指明在哪里放置被嵌入的内容。在这个例子中DOM内容
Hello {{name}}
被提取和放置到 内部。有一个很重要的点需要注意的是,表达式{{name}}所对应的属性是在父scope中被定义的,而非子scope。你可以在这个Plunker例子中做一些实验。如果你想要学习更多关于scope的知识,可以阅读这篇文章。transclude:'element' 和 transclude:true的区别
有时候我我们要嵌入指令元素本身,而不仅仅是它的内容。在这种情况下,我们需要使用 transclude:'element'。它和 transclude:true 不同,它将标记了 ng-transclude 指令的元素一起包含到了指令模板中。使用transclusion,你的link函数会获得一个名叫 transclude 的链接函数,这个函数绑定了正确的指令scope,并且传入了另一个拥有被嵌入DOM元素拷贝的函数。你可以在这个 transclude 函数中执行比如修改元素拷贝或者将它添加到DOM上等操作。 类似 ng-repeat 这样的指令使用这种方式来重复DOM元素。仔细研究一下这个Plunker,它使用这种方式复制了DOM元素,并且改变了第二个实例的背景色。
同样需要注意的是,在使用 transclude:'element'的时候,指令所在的元素会被转换成HTML注释。所以,如果你结合使用 transclude:'element' 和 replace:false,那么指令模板本质上是被添加到了注释的innerHTML中——也就是说其实什么都没有发生!相反,如果你选择使用 replace:true,指令模板会替换HTML注释,那么一切就会如果所愿的工作。使用 replade:false 和 transclue:'element'有时候也是有用的,比如当你需要重复DOM元素但是并不想保留第一个元素实例(它会被转换成注释)的情况下。对这块还有疑惑的同学可以阅读stackoverflow上的这篇讨论,介绍的比较清晰。
controller 函数和 require
如果你想要允许其他的指令和你的指令发生交互时,你需要使用 controller 函数。比如有些情况下,你需要通过组合两个指令来实现一个UI组件。那么你可以通过如下的方式来给指令添加一个 controller 函数。
app.directive('outerDirective', function() { return { scope: {}, restrict: 'AE', controller: function($scope, $compile, $http) { // $scope is the appropriate scope for the directive this.addChild = function(nestedDirective) { // this refers to the controller console.log('Got the message from nested directive:' + nestedDirective.message); }; } }; });
这个代码为指令添加了一个名叫 outerDirective 的controller。当另一个指令想要交互时,它需要声明它对你的指令 controller 实例的引用(require)。可以通过如下的方式实现:
app.directive('innerDirective', function() { return { scope: {}, restrict: 'AE', require: '^outerDirective', link: function(scope, elem, attrs, controllerInstance) { //the fourth argument is the controller instance you require scope.message = "Hi, Parent directive"; controllerInstance.addChild(scope); } }; });
相应的HTML代码如下:
<outer-directive> <inner-directive></inner-directive> </outer-directive>
require: ‘^outerDirective' 告诉Angular在元素以及它的父元素中搜索controller。这样被找到的 controller 实例会作为第四个参数被传入到 link 函数中。在我们的例子中,我们将嵌入的指令的scope发送给父亲指令。如果你想尝试这个代码的话,请在开启浏览器控制台的情况下打开这个Plunker。同时,这篇Angular官方文档上的最后部分给了一个非常好的关于指令交互的例子,是非常值得一读的。
一个记事本应用
这一部分,我们使用Angular指令创建一个简单的记事本应用。我们会使用HTML5的 localStorage 来存储笔记。最终的产品在这里,你可以先睹为快。
我们会创建一个展现记事本的指令。用户可以查看他/她创建过的笔记记录。当他点击 add new 按钮的时候,记事本会进入可编辑状态,并且允许创建新的笔记。当点击 back 按钮的时候,新的笔记会被自动保存。笔记的保存使用了一个名叫 noteFactory 的工厂类,它使用了 localStorage。工厂类中的代码是非常直接和可理解的。所以我们就集中讨论指令的代码。
第一步
我们从注册 notepad 指令开始。
app.directive('notepad', function(notesFactory) { return { restrict: 'AE', scope: {}, link: function(scope, elem, attrs) { }, templateUrl: 'templateurl.html' }; });
这里有几点需要注意的:
因为我们想让指令可重用,所以选择使用隔离的scope。这个指令可以拥有很多与外界没有关联的属性和方法。
这个指令可以以属性或者元素的方式被使用,这个被定义在 restrict 属性中。
现在的link函数是空的这个指令从 templateurl.html 中获取指令模板
第二步
下面的HTML组成了指令的模板。
<div class="note-area" ng-show="!editMode"> <ul> <li ng-repeat="note in notes|orderBy:'id'"> <a href="#" ng-click="openEditor(note.id)">{{note.title}}</a> </li> </ul> </div> <div id="editor" ng-show="editMode" class="note-area" contenteditable="true" ng-bind="noteText"></div> <span><a href="#" ng-click="save()" ng-show="editMode">Back</a></span> <span><a href="#" ng-click="openEditor()" ng-show="!editMode">Add Note</a></span>
几个重要的注意点:
note 对象中封装了 title,id 和 content。
ng-repeat 用来遍历 notes 中所有的笔记,并且按照自动生成的 id 属性进行升序排序。
我们使用一个叫 editMode 的属性来指明我们现在在哪种模式下。在编辑模式下,这个属性的值为 true 并且可编辑的 div 节点会显示。用户在这里输入自己的笔记。
如果 editMode 为 false,我们就在查看模式,显示所有的 notes。
两个按钮也是基于 editMode 的值而显示和隐藏。
ng-click 指令用来响应按钮的点击事件。这些方法将和 editMode 一起添加到scope中。
可编辑的 div 框与 noteText 相绑定,存放了用户输入的文本。如果你想编辑一个已存在的笔记,那么这个模型会用它的文本内容初始化这个 div 框。
第三步
我们在scope中创建一个名叫 restore() 的新函数,它用来初始化我们应用中的各种控制器。 它会在 link 函数执行的时候被调用,也会在 save 按钮被点击的时候调用。
scope.restore = function() { scope.editMode = false; scope.index = -1; scope.noteText = ''; };
我们在 link 函数的内部创建这个函数。 editMode 和 noteText 之前已经解释过了。 index 用来跟踪当前正在编辑的笔记。 当我们在创建一个新的笔记的时候,index 的值会设成 -1. 我们在编辑一个已存在的笔记的时候,它包含了那个 note 对象的 id 值。
第四步
现在我们要创建两个scope函数来处理编辑和保存操作。
scope.openEditor = function(index) { scope.editMode = true; if (index !== undefined) { scope.noteText = notesFactory.get(index).content; scope.index = index; } else { scope.noteText = undefined; } }; scope.save = function() { if (scope.noteText !== '') { var note = {}; note.title = scope.noteText.length > 10 ? scope.noteText.substring(0, 10) + '. . .' : scope.noteText; note.content = scope.noteText; note.id = scope.index != -1 ? scope.index : localStorage.length; scope.notes = notesFactory.put(note); } scope.restore(); };
这两个函数有几点需要注意:
openEditor 为编辑器做准备工作。如果我们在编辑一个笔记,它会获取当前笔记的内容并且通过使用 ng-bind 将内容更新到可编辑的 div 中。
如果我们在创建一个新的笔记,我们会将 noteText 设置成 undefined,以便当我们在保存笔记的时候,触发相应的监听器。
如果 index 参数是 undefined,它表明用户正在创建一个新的笔记。
save 函数通过使用 notesFactory 来存储笔记。在保存完成后,它会刷新 notes 数组,从而监听器能够监测到笔记列表的变化,来及时更新。
save 函数调用在重置 controllers 之后调用restore(),从而可以从编辑模式进入查看模式。
第五步
在 link 函数执行时,我们初始化 notes 数组,并且为可编辑的 div 框绑定一个 keydown 事件,从而保证我们的 nodeText 模型与 div 中的内容保持同步。我们使用这个 noteText 来保存我们的笔记内容。
var editor = elem.find('#editor'); scope.restore(); // initialize our app controls scope.notes = notesFactory.getAll(); // load notes editor.bind('keyup keydown', function() { scope.noteText = editor.text().trim(); });
第六步
最后,我们在HTML如同使用其他的HTML元素一样使用我们的指令,然后开始做笔记吧。
<h1 class="title">The Note Making App</h1> <notepad/>
总结
一个很重要的点需要注意的是,任何使用jQuery能做的事情,我们都能用Angular指令来做到,并且使用更少的代码。所以,在使用jQuery之前,请考虑一下我们能否在不进行DOM操作的情况下以更好的方式来完成任务。试着使用Angular来最小化jQuery的使用吧。
再来看一下我们的笔记本应用,删除笔记的功能被故意漏掉了。鼓励读者们自己实验和实现这个功能。 你可以从GitHub上下到这个Demo的源代码。