强制实施延迟控制器逻辑

Enforce deferring controller logic

本文关键字：控制器 延迟 施延迟      更新时间：2023-09-26

我们正在尝试应用John Papa的AngularJS风格指南中列出的准则。

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

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

为什么？：当逻辑放置在一个 服务并通过函数公开。

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

为什么？：删除依赖项并从 控制器。

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

现在我想让规则尽可能严格。理想情况下，如果其中一个配置的服务作为依赖项传递给控制器，我希望 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) {
            });
    };
}

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

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

旧答案。

以下是ESLint自定义规则，该规则限制名称以 Controller 或 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

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

我写了一种解决方法，但它是如此棘手和肮脏，以至于永远不能使用它：

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

相关文章：