AngularJS:将服务注入HTTP拦截器(循环依赖)

时间:2013-12-18 00:29:34

标签: javascript angularjs

我正在尝试为我的AngularJS应用编写HTTP拦截器来处理身份验证。

此代码有效,但我担心手动注入服务,因为我认为Angular应该自动处理:

    app.config(['$httpProvider', function ($httpProvider) {
    $httpProvider.interceptors.push(function ($location, $injector) {
        return {
            'request': function (config) {
                //injected manually to get around circular dependency problem.
                var AuthService = $injector.get('AuthService');
                console.log(AuthService);
                console.log('in request interceptor');
                if (!AuthService.isAuthenticated() && $location.path != '/login') {
                    console.log('user is not logged in.');
                    $location.path('/login');
                }
                return config;
            }
        };
    })
}]);

我开始做的事情,但遇到循环依赖问题:

    app.config(function ($provide, $httpProvider) {
    $provide.factory('HttpInterceptor', function ($q, $location, AuthService) {
        return {
            'request': function (config) {
                console.log('in request interceptor.');
                if (!AuthService.isAuthenticated() && $location.path != '/login') {
                    console.log('user is not logged in.');
                    $location.path('/login');
                }
                return config;
            }
        };
    });

    $httpProvider.interceptors.push('HttpInterceptor');
});

我担心的另一个原因是Angular Docs中的section on $http似乎显示了一种方法,可以将“常规方式”注入Http拦截器。请参阅“拦截器”下的代码段:

// register the interceptor as a service
$provide.factory('myHttpInterceptor', function($q, dependency1, dependency2) {
  return {
    // optional method
    'request': function(config) {
      // do something on success
      return config || $q.when(config);
    },

    // optional method
   'requestError': function(rejection) {
      // do something on error
      if (canRecover(rejection)) {
        return responseOrNewPromise
      }
      return $q.reject(rejection);
    },



    // optional method
    'response': function(response) {
      // do something on success
      return response || $q.when(response);
    },

    // optional method
   'responseError': function(rejection) {
      // do something on error
      if (canRecover(rejection)) {
        return responseOrNewPromise
      }
      return $q.reject(rejection);
    };
  }
});

$httpProvider.interceptors.push('myHttpInterceptor');

上述代码应该放在哪里?

我想我的问题是这样做的正确方法是什么?

谢谢,我希望我的问题很清楚。

5 个答案:

答案 0 :(得分:62)

这就是我最终做的事情

  .config(['$httpProvider', function ($httpProvider) {
        //enable cors
        $httpProvider.defaults.useXDomain = true;

        $httpProvider.interceptors.push(['$location', '$injector', '$q', function ($location, $injector, $q) {
            return {
                'request': function (config) {

                    //injected manually to get around circular dependency problem.
                    var AuthService = $injector.get('Auth');

                    if (!AuthService.isAuthenticated()) {
                        $location.path('/login');
                    } else {
                        //add session_id as a bearer token in header of all outgoing HTTP requests.
                        var currentUser = AuthService.getCurrentUser();
                        if (currentUser !== null) {
                            var sessionId = AuthService.getCurrentUser().sessionId;
                            if (sessionId) {
                                config.headers.Authorization = 'Bearer ' + sessionId;
                            }
                        }
                    }

                    //add headers
                    return config;
                },
                'responseError': function (rejection) {
                    if (rejection.status === 401) {

                        //injected manually to get around circular dependency problem.
                        var AuthService = $injector.get('Auth');

                        //if server returns 401 despite user being authenticated on app side, it means session timed out on server
                        if (AuthService.isAuthenticated()) {
                            AuthService.appLogOut();
                        }
                        $location.path('/login');
                        return $q.reject(rejection);
                    }
                }
            };
        }]);
    }]);

注意:$injector.get调用应该在拦截器的方法内,如果你试图在别处使用它们,你将继续在JS中获得循环依赖性错误。

答案 1 :(得分:41)

$ http与您的AuthService之间存在循环依赖关系。

使用$injector服务正在做的是通过延迟$ http对AuthService的依赖来解决鸡与蛋的问题。

我相信你所做的实际上是最简单的方法。

您也可以通过以下方式执行此操作:

  • 稍后注册拦截器(在run()块而不是config()块中执行此操作可能已经成功了)。但是你能保证还没有调用$ http吗?
  • 当您通过调用AuthService.setHttp()或其他内容注册拦截器时,将“http”手动注入到AuthService中。
  • ...

答案 2 :(得分:13)

糟糕的逻辑造成了这样的结果

实际上在Http Interceptor中没有寻求用户创作的点。我建议将所有HTTP请求包装成单个.service(或.factory,或.provider),并将其用于所有请求。每次调用函数时,都可以检查用户是否登录。如果一切正常,请允许发送请求。

在您的情况下,Angular应用程序将在任何情况下发送请求,您只需在那里检查授权,然后JavaScript将发送请求。

您的问题的核心

myHttpInterceptor实例下调用

$httpProvider。您的AuthService使用$http$resource,此处您有依赖项递归或循环依赖项。如果您从AuthService删除该依赖项,则不会发现该错误。


同样@Pieter Herroelen指出,你可以将这个拦截器放在你的模块module.run中,但这更像是一个黑客,而不是解决方案。

如果您需要执行干净且自我描述的代码,则必须遵循一些SOLID原则。

至少单一责任原则会在这种情况下为你提供很多帮助。

答案 3 :(得分:13)

我认为直接使用$ injector是一个反模式。

打破循环依赖的一种方法是使用一个事件: 而不是注入$ state,注入$ rootScope。 不要直接重定向,而是

this.$rootScope.$emit("unauthorized");

angular
    .module('foo')
    .run(function($rootScope, $state) {
        $rootScope.$on('unauthorized', () => {
            $state.transitionTo('login');
        });
    });

答案 4 :(得分:0)

如果您只是检查Auth状态(isAuthorized()),我建议将该状态放在一个单独的模块中,例如" Auth",它只保存状态并且没有&# 39; t使用$ http本身。

app.config(['$httpProvider', function ($httpProvider) {
  $httpProvider.interceptors.push(function ($location, Auth) {
    return {
      'request': function (config) {
        if (!Auth.isAuthenticated() && $location.path != '/login') {
          console.log('user is not logged in.');
          $location.path('/login');
        }
        return config;
      }
    }
  })
}])

验证模块:

angular
  .module('app')
  .factory('Auth', Auth)

function Auth() {
  var $scope = {}
  $scope.sessionId = localStorage.getItem('sessionId')
  $scope.authorized = $scope.sessionId !== null
  //... other auth relevant data

  $scope.isAuthorized = function() {
    return $scope.authorized
  }

  return $scope
}

(我在这里使用localStorage将sessionId存储在客户端,但你也可以在$ http调用之后在你的AuthService中设置它)