AngularJS 'agnostic' 和 'component' 指令

AngularJS 'agnostic' and 'component' directives

最近和同事就AngularJS中指令最灵活的使用方式发生了暴力争执。经过漫长而疲惫的讨论,我们同意请社区来评判我们的争吵。请帮助我们:)

如果简单地说一下,我坚信要使某些东西变得真正灵活,应该遵循主要的 MVC 原则 - 严格地将逻辑与表示分离,无论是哪种 'scope' 我们有。 这是使用任何 MVC 框架的首选方式。我的同事不同意我的观点,并且坚信 AngularJS 中的指令对于 AngularJS 非常 'special' 并且只有当它在 'board' 中包含所有内容时才有效,例如模板 + 'own' 控制器。他还声称在指令范围内使用 DOM 进行直接操作非常好,所有 'directives' 都应该以这种方式工作......

我们有一个实现 'just in place' 实体编辑功能的想法。它应该以下列方式工作 - 用户只需单击某些 'text' 并且应该可以更改它的值。

我建议采用以下方法:

模板(文本-editor.html):

<label class="title">{{title}}</label>
<span class="value" ng-show="!editor.edited[name]" ng-click="editor.activateEditing(name)">{{editor.entity[name]}}</span>
<input ng-show="editor.edited[name]" ng-model="editor.entity[name]" ng-change="editor.validate(name)"></input> 

控制器:

function editorController ($scope, $controller) {
    function copy (source) {
      var result = {};
      for (var prop in source) {
        if (source.hasOwnProperty(prop) && prop.charAt(0) !== '_') {
          result[prop] = source[prop];
        }
      }

      return result;
    }

    $scope.edited = {};

    $scope.activateEditing = function (name) {
      var entity = $scope.entity;

      $scope.edited[name] = true;

      if (!entity._backup) {
        entity._backup = copy(entity);
      }
    };

    $scope.cancelEditing = function () {
      var entity = $scope.entity, backup = entity._backup;
      for (var prop in backup) {
        if (backup.hasOwnProperty(prop)) {
          entity[prop] = backup[prop];
        }
      }

      delete entity._backup;
      $scope.edited = {};
    };

    $scope.saveEditing = function () {
      var entity = $scope.entity, backup = entity._backup;
      $scope.$emit('saveEntity', entity, backup);

      delete entity._backup; 
      $scope.edited = {};
    };

    $scope.deleteEntity = function () {
      var entity = $scope.entity;
      $scope.$emit('deleteEntity', entity);

      delete entity._backup; 
      $scope.edited = {};
    };

    $scope.$on('trackEntity', function (event, entity) {
      $scope.entity = entity;
      $scope.edited = {};
    });
  }

  editorController.$inject = ['$scope', '$controller'];
  app.controller('EditorCtrl', editorController);

指令:

function textEditor() {
    return {
      scope: {
        title: '=',
        name: '=',
        editor: '='
      },
      templateUrl: 'partials/text-editor.html',
    };
  }

  app.directive('textEditor', textEditor);

用法:

<div ng-controller="EditorCtrl">
  <div class="stack-item" ng-if="show">
    <div class="stack-item-header" ng-include="'partials/section-header.html'"></div>

    <div class="details-menu">
      <div class="details-actions">
        <div class="details-edit-actions">
          <a ng-click="saveEditing()"><span class="icon-save"></span>Save</a>
          <a ng-click="cancelEditing()"><span class="icon-cancel"></span>Cancel</a>
        </div>
      </div>
    </div>

    <div class="details">
      <fieldset>
        <legend>Medication</legend>
        <div text-editor title="'Drug Name'" name="'drugName'" editor="this"></div>
        <div text-editor title="'Dosage'" name="'dosage'" editor="this"></div>
      </fieldset>
    </div>
  </div>
</div>

验证函数超出了我们的讨论范围,它以某种方式在范围内定义...

所以你可以看到我的指令是完全不可知的——它只用于模板,为模板提供一些额外的参数。

我的同事建议其他解决方案:

使用示例:

<div content-link>
  <a link ng-bind="case.info.caseName"></a>
  <input content ng-model="case.info.caseName" />
</div>

指令:

(function () {
    'use strict';

    angular
        .module('xx')
        .directive('contentLink', contentLink)

    contentLink.$inject = ['$compile'];
    function contentLink($compile) {
        var directive = {
            restrict: 'A',
            transclude: true,
            scope: {
                contentActive: '=?'
            },
            link: link,
            controller: ContentLinkController,
            controllerAs: 'contentLink',
            template: '<div class="cl-link" ng-hide="contentLink.contentActive" ng-click="contentLink.toggleContent()"></div>' +
                      '<div class="cl-content" ng-show="contentLink.contentActive" outside-click="contentLink.toggleContent()" outside-if="contentLink.contentActive" ' +
                            'ignore-element-selectors="{{ contentLink.otherContentElements }}">' +
                      '</div>'
        };

        return directive;

        function link(scope, element, attrs, controller, transclude) {
            angular.extend(scope.contentLink, {
                toggleContent: toggleContent
            });

            element.removeAttr('content-link').addClass('content-link');

            transclude(scope.$parent, function (clone, innerScope) {
                clone.filter('[link]').removeAttr('link').appendTo(element.find('.cl-link'));
                clone.filter('[content]').removeAttr('content').appendTo(element.find('.cl-content'));
            });

            var deregisterScopeDestroyListener = scope.$on('$destroy', cleanup);

            function toggleContent() {
                scope.contentActive = scope.contentLink.contentActive = !scope.contentLink.contentActive;

                element.toggleClass('content-active', scope.contentLink.contentActive);
            }

            function cleanup() {
                scope.contentLink = null;
                deregisterScopeDestroyListener();
            }
        }
    }

    ContentLinkController.$inject = ['$scope', '$element', '$attrs'];
    function ContentLinkController($scope, $element, $attrs) {
        var vm = this;

        angular.extend(vm, {
            contentActive: $scope.contentActive || false,
            otherContentElements: $attrs.otherContentElements
        });
    }
})();

所以好像并没有解决取消编辑的问题,只是我的同事指出没有必要-可以在'different'层上通过某种方式完成。

所以我们想在大型应用程序的范围内创建一些 'reusable' 东西 - 从您的角度来看,哪种解决方案似乎更合理?

我会选择第一种方法。

我对第二种方法的问题是它违背了 angular 方法论的原则。第二种方法更接近于 "component" 风格,这是在其他框架(如 ExtJs 中捆绑了整个组件)中有效且推荐的风格。我认为不应将样式导入 Angular。

在更简单的世界观下——第一种方式我一眼就看懂了,而第二种方式我就直接放弃了。务实的开发还意味着我们在团队中工作,可维护性和易更改性胜过其他深刻的哲学问题。

另外-请不要进行激烈的讨论:)