Angular directive 实例详解

摘要：方法三使用调用父作用域中的函数实例地址同样采用了缺省写法，运行之后，弹出窗口布尔值或者字符，默认值为这个配置选项可以让我们提取包含在指令那个元素里面的内容，再将它放置在指令模板的特定位置。

准备代码，会在实例中用到

var app = angular.module("app", []);

angular指令定义大致如下

app.directive("directiveName", function() {
  return {
    // config
  }
})

其中return返回的配置对象包含很多参数，如下一一说明。

值为字符串，可选参数，指明指令在DOM中以什么形式被声明

默认值为restrict: "EA"，表示可以在DOM里面可以用元素形式和属性形式被声明。一般来说，如果你想创建一个自己模板的组件时，则使用元素形式，但是仅仅是为已有元素添加功能的话，就使用属性名。

如果想要支持IE8，则最好使用属性和类形式来定义，另外从angular 1.3.X开始，已经放弃支持IE8了。

数字，可选参数，致命指令的优先级，若在单个DOM元素上有多个指令，则优先级高的先执行。

当然，设置指令的优先级不太常用，但是比较特殊的例子是，内置指令ng-repeat的优先级为1000，而ng-init的优先级为 450。

布尔型，可选参数，可以被设置为true或者false，若设置为true，则优先级低于此指令的其他指令则无效，不会被调用优先级相同任然会执行。

字符串或者函数，可选参数。

可以是一段html文本

app.directive("hello", function() {
  return {
    template: "
Hello, world!
"
  }
})

使用如下

渲染结果为

  

    
Hello, world!
  

也可以是一个函数，可接受两个参数Element与Attrs

其中Element是指使用此指令的元素，而Attrs则是实例的属性，它是由一个元素上所有属性组成的集合，形如

{
  title: "test",
  id: "testDiv",
  class: "demo",
  input: "text",
  ...
}

下面让我们看看template是一个函数时的情况

app.directive("hello", function() {
  return {
    template: function(element, attrs) {
      return "
"+ attrs.title +"
"
    }
  };
});

html代码

渲染结果

  
message

实例地址

布尔型，默认值为false，设置为true的时候，表示可以用模板内容替换自定义的元素标签。

在template的例子中，我们发现渲染结果中包含有自定义的元素，很显然，这并不是我们想要的渲染结果，因此将replace设置为true之后，hello标签将会消失

app.directive("hello", function() {
  return {
    replace: true,
    template: function(element, attrs) {
      return "
"+ attrs.title +"
"
    }
  };
});

渲染结果如下，hello标签消失不见

message

字符串或者函数，可选参数

可以使一个代表html文件路径的字符串，也可以是一个函数，大致意思与template一样。

在本地开发时，需要运行一个服务器，不然使用templateUrl会报错

Cross origin request script(cors)

由于加载html模板是通过异步加载，若加载大量的模板会拖慢网站的速度，这里有一个技巧，就是先缓存模板，你可以先在你的index页面加载好，将下列代码作为你页面的一部分包含在内

这里的id属性就是被设置在templateUrl上用的

另外一种方法缓存如下

app.run(function($templateCache) {
  $templateCache.put("template.html", "
template
");
})

布尔值或者对象，可选参数，默认值为false，表示继承父级作用域。

如果值为true，表示继承父作用域，并创建自己的作用域（子作用域）

如果为对象，{}，则表示创建一个全新的隔离作用域。

首先我们需要来了解一下scope的继承机制。我们使用ng-controller这个指令来举例。我们都知道ng-controller可以从父作用域中继承并创建一个新的子作用域。如下：

    parentNode: {{aaa}}
    
    

        childrenNode: {{aaa}}
    

angular.module("app", [])
.controller("demoController", function($scope) {
    $scope.aaa = "children";
})

实例地址

这时页面的显示结果为

parentNode: parent
childrenNode: children

当时当我们并没有在demoController的作用域中给aaa赋值，也就是在上例中删除这一句$scope.aaa = "children";，那么执行结果就为

parentNode: parent
childrenNode: parent

注意：如果一个元素上有多个指令都使用了隔离作用域，那么只有其中一个可以生效，只有指令模板中的根元素才能获得一个新的作用域，这时候，scope就被设置为true了。

    parentNode: {{aaa}}
    
    

        childrenNode: {{aaa}}
        
        

            lastNode: {{aaa}}
        
    

angular.module("app", [])
.controller("demoController01", function($scope) {
    $scope.aaa = "children";
})
.controller("demoController02", function($scope) {
    $scope.aaa = "last"
})

实例地址

接下来，我们通过一个简单明了的例子来说明scope取值的不同差别

    parent: {{ name }} 
    

    
    

angular.module("app", [])
.controller("mainController", function($scope) {
    $scope.name = "Jake";
})
.directive("myDirective", function() {
    return {
        restrict: "EA",
        scope: false,
        replace: true,
        template: "" +
            "
" +
                "childNode: {{ name }} " +
                "
" +
                "" +
            "
"
    }
})

实例地址

点击上面的实例地址，我们可以依次改变scope的值为false, true, {}，结果发现

false：儿子继承父亲的值，改变父亲的值，儿子的值也随着改变，反之亦然，这就是继承且不隔离

true：儿子继承父亲的值，改变父亲的值，儿子的值也随着改变，但是改变儿子的值，父亲的值并没有改变，这就是继承但是隔离

{}：没有继承父亲的值，所以儿子的值为空，改变任何一方的值都不会影响另一方，这就是不继承且隔离

当想要创建一个可重用的组件时，隔离作用域是一个很好的选择，通过隔离作用域，我们可以确保指令是独立的，并且可以轻松的插入到任何HTML APP中，并且这种做法防止了父作用域被污染。

隔离作用域可以通过绑定策略来访问父作用域的属性

我们来看一个例子

angular.module("app", [])
.controller("mainController", function($scope) {
})
.directive("helloWorld", function() {
    return {
        restrict: "EA",
        scope: false,
        replace: true,
        template: "
Hello world!
"
    }
})

运行上面的代码，我们在input中输入颜色值，比如red，那么hello world一行的背景就会变成红色。动手试试！

实例地址

但是，当我们将scope的值设置为{}时，再次运行代码就发现页面并不能成功的完整显示了.这是因为{}让helloWorld指令产生了隔离作用域，没办法从父级作用域中继承到color的值了。

所以在template中的{{color}}变成了依赖于自己的作用域，而不是依赖于父级作用域。因此我们需要一些办法来让隔离作用域能够读取父级作用域的属性，这个方法就是绑定策略。

下面我们来探索设置这种绑定策略的几种方法

方法一 使用@来进行单向文本（字符串）绑定

angular.module("app", [])
.controller("mainController", function($scope) {
})
.directive("helloWorld", function() {
    return {
        restrict: "EA",
        scope: {
            color: "@colorAttr"
        },
        replace: true,
        template: "
Hello world!
"
    }
})

实例地址

这种办法只能单向，通过在运行的指令DOM上设置color-attr属性，并且采用{{}}绑定某个模型值。当然，我们也可以直接在这里绑定字符串的颜色值，如color-attr="red"

因此当表达式的值发生变化时，属性color-attr的值也会发生变化，通过单向绑定该值，就可以改变隔离作用域中的属性color.

如果绑定的隔离作用域属性名与元素的属性名相同，则可以采用缺省写法
// html


// js
app.directive("helloWorld", function() {
   return {
       scope: { color: "@" },
       ...
   }
})

方法二、使用"="进行双向绑定

    
    

    {{ color }}
    
    

angular.module("app", [])
.controller("mainController", function($scope) {
    $scope.color = "red";
})
.directive("helloWorld", function() {
    return {
        restrict: "EA",
        scope: {
            color: "="
        },
        replace: true,
        template: "
" +
            "Hello world!" +
        "
" + 
        "
"
    }
})

实例地址

此处也采用了类似的缺省写法。

这里需要注意的是，我们要直接在指令元素设置属性时，是直接将实际的作用域模型复制给该属性

这样一个双向绑定被建立了，改变任何一个input值都会改变另外一个值。

方法三、使用"&"调用父作用域中的函数

    
    

    {{ name }}
    

angular.module("app", [])
.controller("mainController", function($scope) {
    $scope.name = "yangbo";
    $scope.say = function() {
        alert("hello!");
    }
})
.directive("helloWorld", function() {
    return {
        restrict: "EA",
        scope: {
            name: "@",
            say: "&"
        },
        replace: true,
        template: ""
    }
})

实例地址

同样采用了缺省写法，运行之后，弹出窗口！

布尔值或者字符element，默认值为false

这个配置选项可以让我们提取包含在指令那个元素里面的内容，再将它放置在指令模板的特定位置。当我们开启transclude之后，我们就可以使用ng-transclude来指明应该在什么地方放置transclude的内容

    

        
china
        
            {{name}}
        
    

angular.module("app", [])
.controller("mainController", function($scope) {
    $scope.name = "yangbo5207";
})
.directive("helloWorld", function() {
    return {
        restrict: "EA",
        scope: {},
        replace: true,
        transclude: true,
        template: "
你看不见我
"
    }
})

运行上面的代码，输出

china
yangbo5207

我们查看渲染出来的html，结果为

    

        
china
        

            

                yangbo5207
            
        
    

另外当开启transclude时，会创建一个新的transclude空间，并且继承父作用域（也就是scope设置的隔离作用域）

从上面例子我们知道，当transclude的值被设置为true时，嵌入的内容为{{name}}，但是如果将它的值设置为element呢，我们可以在上例的基础上进行一个简单的修改，发现，嵌入内容为整个元素

{{name}}

查看渲染结果

    

        
china
        

          

            
              yangbo5207
            
          
        
    

注意：在一个指令的模板中，只能声明一次ng-transclude

那么问题来了，如果我们想要把嵌入内容多次放入我们的模板中怎么办？

可以使用$transclude，后面会讲到！也可以使用complie函数中，里面的transcludeFn参数，后面会讲到！或者使用link连接函数

可以是一个字符串或者函数。

若为字符串，则将字符串当做控制器的名字，来查找注册在应用中的控制器的构造函数

angular.module("app", [])
.directive("myDirective", function() {
    return {
        restrict: "EA",
        replace: true,
        transclude: true,
        
        // 会查找模块中其他被名为targetController的控制器
        controller: "targetController"
    }
})
.controller("targetController", function($scope, $element, $attrs, $transclude) {
    // 控制器逻辑放在这里
})

当然，也可以直接在指令内部定义为匿名函数，同样可以注入任何服务

angular.module("app", [])
.directive("myDirective", function() {
    return {
        restrict: "EA",
        replace: true,
        transclude: true,
        controller: function($scope, $element, $attrs, $transclude) {
            // 控制器逻辑
        }
    }
})

另外还有一些特殊的服务可以注入，

$scope 与指令元素相关联的作用域

$element 当前指令对应的元素

$attrs 当前元素的属性组成的对象

$transclude 嵌入链接函数，实际被执行用来克隆元素和操作DOM中的函数（除非是用来定义一些可复用的行为，否则一般不推荐在这使用）

指令的控制器和link函数（后面会讲到）可以进行互换。区别在于，控制器主要用来提供可在指令间复用的行为，可对外提供与外部交互的接口，但是link链接只能在当前指令内部中定义行为，且无法在指令间复用。

    
外面的世界很精彩。

angular.module("app", [])
.directive("testDirective", function() {
    return {
        transclude: true,
        replace: true,
        controller: function($scope, $element, $attrs, $transclude, $log) {
            $transclude(function(clone) {
                var a = angular.element("");
                a.attr("href", $attrs.url);
                a.text(clone.text());
                $element.append(a);
            });
        }
    }
})

angular.module("app", [])
.directive("testDirective", function() {
    return {
        transclude: true,
        replace: true,
        controller: function($scope, $element, $attrs, $transclude, $log) {
            
            // 这里的$transclude就是嵌入的内容
            var a = $transclude();
            $element.append(a);
        }
    }
})

$scope.$parent

    

        炒美股，上老虎2
    

angular.module("app", [])
.controller("parentController", function($scope) {
    $scope.title = "PARENT TIGER";
})

.controller("sonController", function($scope) {
    $scope.title = "CHILDREN TIGER";
})

.directive("testDirective", function() {
    return {
        transclude: true,
        replace: true,
        controller: function($scope, $element, $attrs, $transclude, $log) {
            var a = $transclude();
            $element.append(a);
            $log.info($scope.title);
            $log.info($scope.$parent.title);
        }
    }
})

{{ demo.name }}

angular.module("app", [])
.controller("demoController", function() {
    this.name = "Jake";
})

app.directive("testDirective", function() {
    return {
        controller: function() {
            this.name = "Jake";
        }
    }
})

    
        
            {{expander.text}}
        
    

var expModule=angular.module("expanderModule",[])
expModule.directive("accordion", function() {
    return {
        restrict : "EA",
        replace : true,
        transclude : true,
        template : "
",
        controller : function() {
            var expanders = [];
            this.gotOpened = function(selectedExpander) {
                angular.forEach(expanders, function(expander) {
                    if (selectedExpander != expander) {
                        expander.showMe = false;
                    }
                });
            }
            this.addExpander = function(expander) {
                expanders.push(expander);
            }
        }
    }
});

expModule.directive("expander", function() {
    return {
        restrict : "EA",
        replace : true,
        transclude : true,
        require : "^?accordion",
        scope : {
            title : "=expanderTitle"
        },
        template : "
"
                   + "
{{title}}
"
                   + "
"
                   + "
",
        link : function(scope, element, attrs, accordionController) {
            scope.showMe = false;
            accordionController.addExpander(scope);
            scope.toggle = function toggle() {
                scope.showMe = !scope.showMe;
                accordionController.gotOpened(scope);
            }
        }
    }
});

expModule.controller("SomeController",function($scope) {
    $scope.expanders = [{
        title : "Click me to expand",
        text : "Hi there folks, I am the content that was hidden but is now shown."
    }, {
        title : "Click this",
        text : "I am even better text than you have seen previously"
    }, {
        title : "Test",
        text : "test"
    }];
});

此处的compile函数值什么指令中配置的，与上面说的$compile服务不一样

//compile函数的语法
compile:function compile(tElement,tAttrs,transclude){
      return{
        pre:function preLink(scope,iElement,iAttrs,controller){},
        post:function postLink(scope,iElement,iAttrs,controller){}
      }
    }

preLink函数会在编译阶段之后，指令链接到子元素之前执行，类似的，postLink会在指令链接到子元素之后执行。这意味着，为了不破坏绑定过程，如果你需要修改DOM结构，你应该在postLink函数中来做这件事情。

//link链接函数
link:function postLink(scope,iElement,iAttrs){}

许多内容都是从不同的网站上整理而来，每一个实例都是自己运行过后保存在codepen上，大家可以结合codepen的例子结合理解文章内容，本文属于收集文，非原创，但绝对干货！值！得!一!赞！与收藏。