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


118

我正在尝试为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中$ 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');

上面的代码应该放在哪里?

我想我的问题是执行此操作的正确方法是什么?

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


1
出于好奇,您在AuthService中使用的依赖项(如果有)是什么?我在http拦截器中使用request方法遇到循环依赖问题,这使我到了这里。我正在使用angularfire的$ firebaseAuth。当我从注入器中删除使用$ route的代码块时(第510行),一切开始正常工作。这里有一个问题但这是关于在拦截器中使用$ http的问题。关闭git!
Slamborne 2014年

嗯,对于它的价值而言,在我的案例中,AuthService取决于$ window,$ http,$ location,$ q
shaunlim 2014年

在某些情况下,我遇到了在拦截器中重试请求的情况,因此对的循环依赖甚至更短$http。我发现解决此问题的唯一方法是使用$injector.get,但很高兴知道是否存在一种结构良好的代码来避免这种情况的好方法。
Michal Charemza 2014年

1
看一下@rewrite的响应:github.com/angular/angular.js/issues/2367,它为我解决了类似的问题。他正在做什么,就像这样:$ http = $ http || $ injector.get(“ $ http”); 当然,您可以用自己要使用的服务替换$ http。
乔纳森·

Answers:


42

您在$ http和AuthService之间具有循环依赖关系。

您通过使用该$injector服务所做的事情是通过延迟AuthService上$ http的依赖关系来解决“鸡与蛋”问题。

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

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

  • 稍后注册拦截器(在一个run()块而不是一个config()块中这样做可能已经成功了)。但是您可以保证$ http尚未被调用吗?
  • 通过调用AuthService.setHttp()或其他方式注册拦截器时,将$ http手动“注入”到AuthService中。
  • ...

15
我没有看到这个答案是如何解决问题的?@shaunlim
Inanc Gumus 2014年

1
实际上它没有解决它,只是指出算法流程很糟糕。
Roman M. Koss

12
您不能在run()块中注册拦截器,因为您不能将$ httpProvider注入运行块。您只能在配置阶段执行此操作。
斯蒂芬·弗里德里希

2
好的要点是循环引用,但否则不应被接受。无论是要点使得任何意义
尼古拉

65

这就是我最终要做的

  .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中收到循环依赖项错误。


4
使用手动注入($ injector.get('Auth'))解决了问题。干得好!
罗伯特

为了避免循环依赖,我正在检查调用哪个URL。if(!config.url.includes('/ oauth / v2 / token')&& config.url.includes('/ api')){//调用OAuth服务}。因此,不再有循环依赖。至少对我自己来说有效;)。
Brieuc

完善。这正是我解决类似问题所需要的。谢谢@shaunlim!
马丁·钱伯林

我不太喜欢这种解决方案,因为那样的话该服务是匿名的,并且不容易进行测试。在运行时注入更好的解决方案。
kmanzana

那对我有用。基本上注入使用$ http的服务。
汤玛斯(Thomas)

15

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

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

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

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

2
我认为这是一个更优雅的解决方案,因为它没有任何依赖性,我们也可以在许多相关的地方收听此事件
Basav

这将无法满足我的需要,因为在调度事件后我无法获得返回值。
xabitrigo

13

错误的逻辑导致了这样的结果

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

在您的情况下,无论如何,Angular应用程序都会发送请求,您只需在此处检查授权,然后JavaScript将发送请求。

您问题的核心

myHttpInterceptor$httpProvider实例调用。您AuthService使用$http,或$resource,这里您具有依赖项递归或循环依赖项。如果您从中删除该依赖项AuthService,那么您将不会看到该错误。


就像@Pieter Herroelen指出的那样,您可以将此拦截器放置在模块中module.run,但这更像是一种hack,而不是解决方案。

如果您要编写干净且具有自我描述性的代码,则必须遵循一些SOLID原则。

在这种情况下,至少“单一责任”原则将对您有很大帮助。


5
我认为这个答案措辞不好,但我确实认为这是问题的根源。存储当前用户数据的身份验证服务登录方式(http请求)的问题在于,它负责件事。如果将其分为用于存储当前用户数据的一个服务和用于登录的另一服务,则http拦截器仅需要依赖“当前用户服务”,而不再创建循环依赖项。
尼克斯(Snixtor)'16

@Snixtor谢谢!为了更清楚,我需要学习更多英语。
罗曼·科斯

0

如果您只是在检查Auth状态(isAuthorized()),我建议您将该状态放在一个单独的模块中,例如说“ Auth”,它仅保存该状态并且不使用$ 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中设置此值)

By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.