强制推迟控制器逻辑

时间:2015-01-06 20:39:26

标签: javascript angularjs angularjs-service angularjs-controller eslint

我们正在尝试应用John Papa AngularJS Style Guide中列出的指南。

我们开始遵循的一条规则是Defer Controller Logic

  

通过委托服务和工厂来推迟控制器中的逻辑。

     

为什么?:多个控制器放置在一个控制器中时,可以重复使用逻辑   服务并通过功能公开。

     

为什么?:在单元测试中,服务中的逻辑可以更容易被隔离,   而控制器中的调用逻辑很容易被模拟。

     

为什么?:删除依赖项并隐藏实现细节   控制器。

这是我们过去通过将数据检索逻辑放入控制器而不是在服务中隔离它而违反的。

现在我想尽可能严格地制定规则。理想情况下,如果其中一个配置的服务作为依赖项传递给控制器​​,我希望angular引发错误。它是否可以在角度级别上解决,或者我应该尝试单独解决它 - 例如,静态地使用自定义ESlint规则?

非常感谢任何见解或提示。


特别是,以下控制器违反了该规则,因为它直接使用$http service

function OrderController($http, $q, config, userInfo) {
    var vm = this;
    vm.checkCredit = checkCredit;
    vm.isCreditOk;

    function checkCredit() {
        var settings = {};

        return $http.get(settings)
            .then(function(data) {
               vm.isCreditOk = vm.total <= maxRemainingAmount;
            })
            .catch(function(error) {

            });
    };
}

另外,如果我对代码质量过于担心/疯狂,请告诉我们。)

2 个答案:

答案 0 :(得分:4)

UPD(2015年6月):eslint-plugin-angular内置ng_no_services规则,强制推迟控制器逻辑到服务或工厂。


老回答。

以下ESLint custom rule限制一个函数,该名称以ControllerCtrl结尾,以传入任何已配置的参数:

module.exports = function (context) {

    "use strict";

    var restrictedParams = context.options[0] || [];

    var check = function (node) {
        var name = node.id && node.id.name;

        if (/(Controller|Ctrl)$/.test(name) && node.params) {
            var params = node.params.map(
                function (param) {
                    return param.name;
                }
            );

            restrictedParams.filter(function (n) {
                if (params.indexOf(n) != -1) {
                    context.report(node, "This controller function uses a restricted dependency {{param}}.", {
                        param: n
                    });
                }
            });

        }
    };

    return {
        "FunctionDeclaration": check,
        "FunctionExpression": check
    }
};

示例配置(eslint.json):

{
  "env": {
    "browser": true,
    "node": true,
    "jasmine": true
  },
  "globals": {
    "angular": true,
    "browser": true,
    "element": true,
    "by": false,
    "inject": false
  },
  "plugins": [
    "angularjs"
  ],
  "rules": {
    "ctrl-logic": [2, ["$http"]]
  }
}

现在,想象一下我定义了以下控制器(违反规则):

angular
    .module("app")
    .controller("AppController", AppController);


AppController.$inject = ["$scope", "ConnectionService", "ConfigService", "StatusService", "$http"];

function AppController($scope, ConnectionService, ConfigService, StatusService, $http) {
    ...
}

如果我运行eslint检查它会报告错误:

$ grunt lint
Running "eslint:target" (eslint) task

app/app-controller.js
  8:0  error  This controller function uses a restricted dependency $http  ctrl-logic

✖ 1 problem

我可以想象有一些方法可以通过这种特定规则不会发现违规的方式来定义依赖关系,但是,如果您遵循样式指南中建议的建议,它应该适合您(适合我)。

答案 1 :(得分:2)

我已经写了一种解决方法,但它非常棘手和肮脏,绝对不能使用它:

&#13;
&#13;
<!doctype html>
<html>
    <head>
        <script src="https://ajax.googleapis.com/ajax/libs/angularjs/1.3.3/angular.js"></script>
    </head>
    <body ng-app="plunker" ng-controller="MainCtrl">
        <div ng-repeat="violation in codestyleViolations">
            {{violation}}
        </div>
    </body>
    <script>
    var app = angular.module('plunker', []).config(function($controllerProvider) { 
        $controllerProvider.$get[0] = 'trickyInjector';
    }).factory('trickyInjector', ['$injector', '$rootScope', function($injector, $rootScope) {
        $rootScope.codestyleViolations = [];
        var originalFunc = $injector.invoke;
        $injector.invoke = function(fn, self, locals, serviceName) {
            if (locals && locals.$scope && fn.indexOf('$http') !== -1) {
                $rootScope.codestyleViolations.push('ALYARM! ' + serviceName + ' uses $http');
            }
            return originalFunc.apply(this, arguments);
        };
        return $injector;
    }]).controller('MainCtrl', ['$scope', '$http', function($scope, $http) {

    }]);
    </script>
</html>
&#13;
&#13;
&#13;