如何在AngularJS中取消$ http请求?


189

在AngularJS中给出Ajax请求

$http.get("/backend/").success(callback);

如果启动另一个请求(相同的后端,例如不同的参数),取消该请求的最有效方法是什么?


8
以下所有答案均未真正取消请求本身。一旦HTTP请求离开浏览器,就无法取消它。下面所有的答案都以某种方式使听众陷入困境。HTTP请求仍然命中服务器,仍在处理中,服务器仍将发送响应,这只是客户端是否仍在响应该请求的一种情况。
利亚姆



@利亚姆我的问题不是在服务器上取消。具体取决于您的服务器技术/实现。我担心放弃回调
Sonic Soul

Answers:


325

此功能通过超时参数添加到1.1.5版本中

var canceler = $q.defer();
$http.get('/someUrl', {timeout: canceler.promise}).success(successCallback);
// later...
canceler.resolve();  // Aborts the $http request if it isn't finished.

13
如果我既需要超时又需要通过诺言手动取消,该怎么办?
拉曼·乔杜卡(RamanChodźka),

15
@RamanChodźka你们都可以承诺。您可以设置超时时间,以便在一定时间后通过JavaScript的本机setTimeout函数或Angular的$timeout服务取消承诺。
Quinn Strahl 2013年

9
canceler.resolve()将取消以后的请求。这是一个更好的解决方案:odetocode.com/blogs/scott/archive/2014/04/24/...
工具包

7
Ben Nadel提供的更完整解决方案的另一个很好的例子:bennadel.com/blog/…–
Pete

3
真的不行。您能提供工作样本吗?
爱德华·奥拉米桑

10

在Angular 1.3.15中,使用timeout属性取消Angular $ http Ajax无效。对于那些迫不及待要解决此问题的人,我共享一个Angular包装的jQuery Ajax解决方案。

该解决方案涉及两项服务:

  • HttpService(围绕jQuery Ajax函数的包装器);
  • PendingRequestsService(跟踪挂起/打开的Ajax请求)

这里是PendingRequestsService服务:

    (function (angular) {
    'use strict';
    var app = angular.module('app');
    app.service('PendingRequestsService', ["$log", function ($log) {            
        var $this = this;
        var pending = [];
        $this.add = function (request) {
            pending.push(request);
        };
        $this.remove = function (request) {
            pending = _.filter(pending, function (p) {
                return p.url !== request;
            });
        };
        $this.cancelAll = function () {
            angular.forEach(pending, function (p) {
                p.xhr.abort();
                p.deferred.reject();
            });
            pending.length = 0;
        };
    }]);})(window.angular);

HttpService服务:

     (function (angular) {
        'use strict';
        var app = angular.module('app');
        app.service('HttpService', ['$http', '$q', "$log", 'PendingRequestsService', function ($http, $q, $log, pendingRequests) {
            this.post = function (url, params) {
                var deferred = $q.defer();
                var xhr = $.ASI.callMethod({
                    url: url,
                    data: params,
                    error: function() {
                        $log.log("ajax error");
                    }
                });
                pendingRequests.add({
                    url: url,
                    xhr: xhr,
                    deferred: deferred
                });            
                xhr.done(function (data, textStatus, jqXhr) {                                    
                        deferred.resolve(data);
                    })
                    .fail(function (jqXhr, textStatus, errorThrown) {
                        deferred.reject(errorThrown);
                    }).always(function (dataOrjqXhr, textStatus, jqXhrErrorThrown) {
                        //Once a request has failed or succeeded, remove it from the pending list
                        pendingRequests.remove(url);
                    });
                return deferred.promise;
            }
        }]);
    })(window.angular);

稍后在服务中,当您加载数据时,将使用HttpService而不是$ http:

(function (angular) {

    angular.module('app').service('dataService', ["HttpService", function (httpService) {

        this.getResources = function (params) {

            return httpService.post('/serverMethod', { param: params });

        };
    }]);

})(window.angular);

在代码的后面,您想加载数据:

(function (angular) {

var app = angular.module('app');

app.controller('YourController', ["DataService", "PendingRequestsService", function (httpService, pendingRequestsService) {

    dataService
    .getResources(params)
    .then(function (data) {    
    // do stuff    
    });    

    ...

    // later that day cancel requests    
    pendingRequestsService.cancelAll();
}]);

})(window.angular);

9

$http当前版本的AngularJS不支持取消发出的请求。打开了一个拉取请求以添加此功能,但是尚未对此PR进行审查,因此尚不清楚是否要将其纳入AngularJS核心。


公关被拒绝,OP在这里提交了更新的更新github.com/angular/angular.js/pull/1836
Mark Nadig

而且也关闭了。
frapontillo 2013年

它的一个版本就是这样。仍在尝试找出使用最终版本的语法。希望PR附带使用样本!:)
SimplGy 2014年

“用法”中的角度文档页面docs.angularjs.org/api/ng/service/$http描述了超时设置,还提到了接受哪些对象(一个Promise)。
伊戈尔·利诺

6

如果要使用ui-router取消stateChangeStart上的待处理请求,可以使用以下方法:

//服务中

                var deferred = $q.defer();
                var scope = this;
                $http.get(URL, {timeout : deferred.promise, cancel : deferred}).success(function(data){
                    //do something
                    deferred.resolve(dataUsage);
                }).error(function(){
                    deferred.reject();
                });
                return deferred.promise;

//在UIrouter配置中

$rootScope.$on('$stateChangeStart', function (event, toState, toParams, fromState, fromParams) {
    //To cancel pending request when change state
       angular.forEach($http.pendingRequests, function(request) {
          if (request.cancel && request.timeout) {
             request.cancel.resolve();
          }
       });
    });

这对我
有用

为什么UI路由器配置需要知道是否request.timeout存在?
trysis

6

由于某种原因,config.timeout对我不起作用。我使用了这种方法:

let cancelRequest = $q.defer();
let cancelPromise = cancelRequest.promise;

let httpPromise = $http.get(...);

$q.race({ cancelPromise, httpPromise })
    .then(function (result) {
...
});

然后cancelRequest.resolve()取消。实际上,它不会取消请求,但至少不会收到不必要的响应。

希望这可以帮助。


您看到SyntaxError { cancelPromise, httpPromise }吗?
Mephiztopheles

这是ES6语法,您可以尝试{c:cancelPromise,h:httpPromise}
Aliaksandr Hmyrak,2016年

我知道了,对象shortinitializer
Mephiztopheles

3

通过使用以下中止方法装饰$ http服务,可以增强可接受的答案...

'use strict';
angular.module('admin')
  .config(["$provide", function ($provide) {

$provide.decorator('$http', ["$delegate", "$q", function ($delegate, $q) {
  var getFn = $delegate.get;
  var cancelerMap = {};

  function getCancelerKey(method, url) {
    var formattedMethod = method.toLowerCase();
    var formattedUrl = encodeURI(url).toLowerCase().split("?")[0];
    return formattedMethod + "~" + formattedUrl;
  }

  $delegate.get = function () {
    var cancelerKey, canceler, method;
    var args = [].slice.call(arguments);
    var url = args[0];
    var config = args[1] || {};
    if (config.timeout == null) {
      method = "GET";
      cancelerKey = getCancelerKey(method, url);
      canceler = $q.defer();
      cancelerMap[cancelerKey] = canceler;
      config.timeout = canceler.promise;
      args[1] = config;
    }
    return getFn.apply(null, args);
  };

  $delegate.abort = function (request) {
    console.log("aborting");
    var cancelerKey, canceler;
    cancelerKey = getCancelerKey(request.method, request.url);
    canceler = cancelerMap[cancelerKey];

    if (canceler != null) {
      console.log("aborting", cancelerKey);

      if (request.timeout != null && typeof request.timeout !== "number") {

        canceler.resolve();
        delete cancelerMap[cancelerKey];
      }
    }
  };

  return $delegate;
}]);
  }]);

此代码在做什么?

要取消请求,必须设置“承诺”超时。如果未在HTTP请求上设置超时,则代码将添加“承诺”超时。(如果已经设置了超时,则什么都不会改变)。

但是,要兑现承诺,我们需要处理“递延”。因此,我们使用地图,以便以后可以检索“延期”。当我们调用中止方法时,从映射中检索“ deferred”,然后我们调用resolve方法来取消http请求。

希望这对某人有帮助。

局限性

目前,这仅适用于$ http.get,但您可以为$ http.post添加代码,依此类推

如何使用 ...

然后,您可以在状态更改时使用它,如下所示...

rootScope.$on('$stateChangeStart', function (event, toState, toParams) {
  angular.forEach($http.pendingRequests, function (request) {
        $http.abort(request);
    });
  });

我正在制作一个可同时触发一些http请求的应用,我需要手动中止所有请求。我已经尝试过您的代码,但它只会中止最后一个请求。以前有没有发生过这种事?任何帮助,将不胜感激。
米格尔·特拉巴霍

1
此处的代码维护对延迟对象的引用的查找,以便稍后可以检索它们,因为需要延迟对象进行中止。查找的重要之处在于key:value对。该值为延迟对象。密钥是基于请求方法/ URL生成的字符串。我猜您正在中止对同一方法/ URL的多个请求。因此,所有键都是相同的,并且它们在映射中彼此覆盖。您需要调整密钥生成逻辑,以便即使url /方法相同,也可以生成唯一的密钥。
danday74

1
从上继续...这不是代码中的错误,代码可以处理中止多个请求...但是该代码绝不打算使用相同的http方法处理中止对同一URL的多个请求...但是如果您调整逻辑,则应该能够使其轻松工作。
danday74

1
非常感谢你!我对同一个url发出了多个请求,但使用了不同的参数,当您说完这句话后,我改变了这一行,它的工作就像一个魅力!
Miguel Trabajo

1

这是一个处理多个请求的版本,还检查回调中的取消状态以抑制错误块中的错误。(在打字稿中)

控制器级别:

    requests = new Map<string, ng.IDeferred<{}>>();

在我的http中获得:

    getSomething(): void {
        let url = '/api/someaction';
        this.cancel(url); // cancel if this url is in progress

        var req = this.$q.defer();
        this.requests.set(url, req);
        let config: ng.IRequestShortcutConfig = {
            params: { id: someId}
            , timeout: req.promise   // <--- promise to trigger cancellation
        };

        this.$http.post(url, this.getPayload(), config).then(
            promiseValue => this.updateEditor(promiseValue.data as IEditor),
            reason => {
                // if legitimate exception, show error in UI
                if (!this.isCancelled(req)) {
                    this.showError(url, reason)
                }
            },
        ).finally(() => { });
    }

辅助方法

    cancel(url: string) {
        this.requests.forEach((req,key) => {
            if (key == url)
                req.resolve('cancelled');
        });
        this.requests.delete(url);
    }

    isCancelled(req: ng.IDeferred<{}>) {
        var p = req.promise as any; // as any because typings are missing $$state
        return p.$$state && p.$$state.value == 'cancelled';
    }

现在查看“网络”选项卡,我发现它很好用。我调用了4次方法,只有最后一个方法通过了。

在此处输入图片说明


req.resolve('cancelled'); 对我不起作用,我使用的是1.7.2版本。即使我想取消通话,如果再次通话,并且第一个通话仍处于待处理状态。请帮忙。我总是希望通过取消所有待处理的API提供新叫做呼叫数据是相同的URL
苏达Kalebere

1

您可以$http使用“装饰器”将自定义函数添加到服务,该装饰器将添加abort()功能到您的Promise中。

这是一些工作代码:

app.config(function($provide) {
    $provide.decorator('$http', function $logDecorator($delegate, $q) {
        $delegate.with_abort = function(options) {
            let abort_defer = $q.defer();
            let new_options = angular.copy(options);
            new_options.timeout = abort_defer.promise;
            let do_throw_error = false;

            let http_promise = $delegate(new_options).then(
                response => response, 
                error => {
                    if(do_throw_error) return $q.reject(error);
                    return $q(() => null); // prevent promise chain propagation
                });

            let real_then = http_promise.then;
            let then_function = function () { 
                return mod_promise(real_then.apply(this, arguments)); 
            };

            function mod_promise(promise) {
                promise.then = then_function;
                promise.abort = (do_throw_error_param = false) => {
                    do_throw_error = do_throw_error_param;
                    abort_defer.resolve();
                };
                return promise;
            }

            return mod_promise(http_promise);
        }

        return $delegate;
    });
});

此代码使用angularjs的装饰器功能向服务添加with_abort()功能$http

with_abort()使用$http超时选项,该选项使您可以中止http请求。

返回的promise被修改为包括一个abort()函数。它还具有代码,abort()即使您连锁承诺,也可以确保这些作品有效。

这是一个如何使用它的示例:

// your original code
$http({ method: 'GET', url: '/names' }).then(names => {
    do_something(names));
});

// new code with ability to abort
var promise = $http.with_abort({ method: 'GET', url: '/names' }).then(
    function(names) {
        do_something(names));
    });

promise.abort(); // if you want to abort

默认情况下,当您调用abort()该请求时,该请求将被取消,并且任何promise处理程序都不会运行。

如果您希望调用错误处理程序,则将true传递给abort(true)

在错误处理程序中,您可以通过检查xhrStatus属性来检查“错误”是否归因于“中止” 。这是一个例子:

var promise = $http.with_abort({ method: 'GET', url: '/names' }).then(
    function(names) {
        do_something(names));
    }, 
    function(error) {
        if (er.xhrStatus === "abort") return;
    });
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.