4

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

我们开始遵循的规则之一是延迟控制器逻辑：

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

为什么？：当放置在服务中并通过函数公开时，逻辑可以被多个控制器重用。

为什么？：服务中的逻辑更容易在单元测试中被隔离，而控制器中的调用逻辑更容易被mock。

为什么？：从控制器中删除依赖项并隐藏实现细节。

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

现在我想让规则尽可能严格。理想情况下，如果配置的服务之一作为依赖项传递给控制器​​，我希望 Angular 抛出错误。它是可以在角度级别上解决的问题，还是我应该尝试单独解决它 - 例如，使用自定义ESlint规则静态地解决？

将不胜感激任何见解或提示。

特别是，以下控制器违反了规则，因为它直接使用$http服务：

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) {

            });
    };
}

另外，如果我对代码质量过度关注/疯狂，请告诉我:)

4

2 回答 2

4

UPD（2015 年 6 月）：具有将控制器逻辑延迟到服务或工厂的eslint-plugin-angular内置规则。ng_no_services

老答案。

这是限制函数的ESLint自定义规则，该函数的名称以Controlleror结尾Ctrl，可以传入任何配置的参数：

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

我可以想象有一些方法可以以这种特定规则不会发现违规的方式定义依赖关系，但是，如果您遵循样式指南中建议的建议，它应该对您有用（对我有用）。

于 2015-01-13T16:24:23.100 回答
2

我写了一种解决方法，但它非常棘手和肮脏，永远不能使用它：

<!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>

于 2015-01-06T21:55:56.260 回答