web-dev-qa-db-ja.com

$ resourceリクエストをキャンセルする方法

$ resourceのタイムアウトプロパティを使用して、保留中のリクエストを動的にキャンセルする方法を理解しようとしています。理想的には、（送信されたparamsに基づいて）特定の属性を持つリクエストをキャンセルできるようにしたいのですが、これは可能ではないようです。それまでは、保留中のすべてのリクエストをキャンセルし、タイムアウトの約束をリセットして新しいリクエストを許可しようとしています。

問題は、$ resource構成がタイムアウト値に対して単一の静的な約束のみを許可することです。タイムアウトの新しいプロミスを渡すだけでよいので、個別の$ http呼び出しを行っている場合、これを行う方法は理にかなっていますが、これは$ resourceに対してどのように機能しますか？ここにサンプルのプランカーを設定しました： http://plnkr.co/edit/PP2tqDYXh1NAOU3yqCwP?p=preview

これが私のコントローラーコードです：

app.controller('MainCtrl', function($scope, $timeout, $q, $resource) {
  $scope.canceller = $q.defer();
  $scope.pending = 0;
  $scope.actions = [];
  var API = $resource(
    'index.html', {}, {
      get: {
        method: 'GET',
        timeout: $scope.canceller.promise
      }
    }
  )

  $scope.fetchData = function() {
    if ($scope.pending) {
      $scope.abortPending();
    }
    $scope.pending = 1;
    $scope.actions.Push('request');
    API.get({}, function() {
      $scope.actions.Push('completed');
      $scope.pending = 0;
    }, function() {
      $scope.actions.Push('aborted');
    });
  }

  $scope.abortPending = function() {
    $scope.canceller.resolve();
    $scope.canceller = $q.defer();
  }
});

現時点では、保留中のリクエストがある場合にキャンセラーは機能しますが、リセットできないようです。1つのリクエストが中止されると、以降のすべてのリクエストも中止されます。

保留中のリクエストをキャンセルできることは、ほとんどのWebアプリケーション（少なくとも私が構築したもの）の非常に重要な機能のように思えるため、何かが欠けていると確信しています。

ありがとう

angularjsangular-resource
27
Greg Michalec

Gecko IT による回答は有効ですが、次のことを行うためにいくつかの変更を加える必要がありました。

  • リソースを再作成する必要なく、リソースのajax呼び出しを複数回キャンセルできるようにします
  • リソースに下位互換性を持たせる-これは、リソースファクトリ以外のアプリケーション（コントローラ）コードを変更する必要がないことを意味します
  • コードをJSLintに準拠させる

これは完全なサービスファクトリの実装です（適切なモジュール名を指定する必要があるだけです）。

'use strict';

/**
 * ResourceFactory creates cancelable resources.
 * Work based on: https://stackoverflow.com/a/25448672/1677187
 * which is based on: https://developer.rackspace.com/blog/cancelling-ajax-requests-in-angularjs-applications/
 */
/* global array */
angular.module('module_name').factory('ResourceFactory', ['$q', '$resource',
    function($q, $resource) {

        function abortablePromiseWrap(promise, deferred, outstanding) {
            promise.then(function() {
                deferred.resolve.apply(deferred, arguments);
            });

            promise.catch(function() {
                deferred.reject.apply(deferred, arguments);
            });

            /**
             * Remove from the outstanding array
             * on abort when deferred is rejected
             * and/or promise is resolved/rejected.
             */
            deferred.promise.finally(function() {
                array.remove(outstanding, deferred);
            });
            outstanding.Push(deferred);
        }

        function createResource(url, options, actions) {
            var resource;
            var outstanding = [];
            actions = actions || {};

            Object.keys(actions).forEach(function(action) {
                var canceller = $q.defer();
                actions[action].timeout = canceller.promise;
                actions[action].Canceller = canceller;
            });

            resource = $resource(url, options, actions);

            Object.keys(actions).forEach(function(action) {
                var method = resource[action];

                resource[action] = function() {
                    var deferred = $q.defer(),
                    promise = method.apply(null, arguments).$promise;

                    abortablePromiseWrap(promise, deferred, outstanding);

                    return {
                        $promise: deferred.promise,

                        abort: function() {
                            deferred.reject('Aborted');
                        },
                        cancel: function() {
                            actions[action].Canceller.resolve('Call cancelled');

                            // Recreate canceler so that request can be executed again
                            var canceller = $q.defer();
                            actions[action].timeout = canceller.promise;
                            actions[action].Canceller = canceller;
                        }
                    };
                };
            });

            /**
             * Abort all the outstanding requests on
             * this $resource. Calls promise.reject() on outstanding [].
             */
            resource.abortAll = function() {
                for (var i = 0; i < outstanding.length; i++) {
                    outstanding[i].reject('Aborted all');
                }
                outstanding = [];
            };

            return resource;
        }

        return {
            createResource: function (url, options, actions) {
                return createResource(url, options, actions);
            }
        };
    }
]);

使い方はGecko ITの例と同じです。サービス工場：

'use strict';

angular.module('module_name').factory('YourResourceServiceName', ['ResourceFactory', function(ResourceFactory) {
    return ResourceFactory.createResource('some/api/path/:id', { id: '@id' }, {
        create: {
            method: 'POST'
        },
        update: {
            method: 'PUT'
        }
    });
}]);

コントローラーでの使用（後方互換）：

var result = YourResourceServiceName.create(data);
result.$promise.then(function success(data, responseHeaders) {
    // Successfully obtained data
}, function error(httpResponse) {
    if (httpResponse.status === 0 && httpResponse.data === null) { 
        // Request has been canceled
    } else { 
        // Server error 
    }
});
result.cancel(); // Cancels XHR request

代替アプローチ：

var result = YourResourceServiceName.create(data);
result.$promise.then(function success(data, responseHeaders) {       
    // Successfully obtained data
}).catch(function (httpResponse) {
    if (httpResponse.status === 0 && httpResponse.data === null) { 
        // Request has been canceled
    } else { 
        // Server error 
    }
});
result.cancel(); // Cancels XHR request

さらなる改善：

  • リクエストがキャンセルされたかどうかを確認したくない。より良いアプローチは、リクエストがキャンセルされたときに属性httpResponse.isCanceledをアタッチすることです。中止の場合も同様です。
10
Nikola M.

（Angular 1.2.28+）こんにちは、私はそれを理解しやすくしたいと思っただけで、その問題をどのように処理したかは次のとおりです：

ここでタイムアウトパラメータを宣言します

_$scope.stopRequestGetAllQuestions=$q.defer();
_

それから私はそれを次のように使用します

_return $resource(urlToGet, {}, {get:{ timeout: stopRequestGetAllQuestions.promise }});
_

以前の$ resource呼び出しを停止したい場合は、このstopRequestGetAllQuestionsオブジェクトをすべて解決します。

_stopRequestGetAllQuestions.resolve();
_

しかし、以前のものを停止して新しい$ resource呼び出しを開始する場合は、stopRequestGetAllQuestions.resolve();の後にこれを実行します。

_stopRequestGetAllQuestions = $q.defer(); 
_
2
katmanco

現在、非常に多くの例があります。次の2つは非常に有益であることがわかりました。

これは、$ resourceリクエストと$ httpリクエストの両方を処理する方法の例を示しています。 https://developer.rackspace.com/blog/cancelling-ajax-requests-in-angularjs-applications/

そして

これはより単純で、$ http専用です： http://odetocode.com/blogs/scott/archive/2014/04/24/canceling-http-requests-in-angularjs.aspx

1
Tsonev

こんにちは https：//developer.rackspace.com/blog/... に基づいてカスタムハンドラーを作成しました

.factory('ResourceFactory', ["$q", "$resource", function($q, $resource) {
    function createResource(url, options, actions) {
        var actions = actions || {},
        resource,
        outstanding = [];

        Object.keys(actions).forEach(function (action) {
            console.log(actions[action]);
            var canceller = $q.defer();
            actions[action].timeout = canceller.promise;
            actions[action].Canceller = canceller;
        });

        resource = $resource(url, options, actions);

        Object.keys(actions).forEach(function (action) {
            var method = resource[action];

            resource[action] = function () {
                var deferred = $q.defer(),
                promise = method.apply(null, arguments).$promise;

                abortablePromiseWrap(promise, deferred, outstanding);

                return {
                    promise: deferred.promise,

                    abort: function () {
                        deferred.reject('Aborted');
                    },
                    cancel: function () {
                        console.log(actions[action]);
                        actions[action].Canceller.resolve("Call cancelled");
                    }
                };
            };
        });

        /**
        * Abort all the outstanding requests on
        * this $resource. Calls promise.reject() on outstanding [].
        */
        resource.abortAll = function () {
            for (var i = 0; i < outstanding.length; i++) {
                outstanding[i].reject('Aborted all');
            }
            outstanding = [];
        };

        return resource;
    }

    return {
        createResource: function (url, options, actions) {
            return createResource(url, options, actions);
        }
    }
}])

function abortablePromiseWrap(promise, deferred, outstanding) {
    promise.then(function () {
        deferred.resolve.apply(deferred, arguments);
    });

    promise.catch(function () {
        deferred.reject.apply(deferred, arguments);
    });
    /**
    * Remove from the outstanding array
    * on abort when deferred is rejected
    * and/or promise is resolved/rejected.
    */
    deferred.promise.finally(function () {
        array.remove(outstanding, deferred);
    });
    outstanding.Push(deferred);
}


//Usage SERVICE
factory("ServiceFactory", ["apiBasePath", "$resource", "ResourceFactory", function (apiBasePath, $resource, QiteResourceFactory) {
    return ResourceFactory.createResource(apiBasePath + "service/:id", { id: '@id' }, null);
}])

//Usage Controller
var result = ServiceFactory.get();
console.log(result);
result.promise.then(function (data) {       
    $scope.services = data;
}).catch(function (a) {
    console.log("catch", a);
})
//Actually cancels xhr request
result.cancel();
1
Gecko IT

1つの解決策は、必要になるたびにリソースを再作成することです。

// for canceling an ajax request
$scope.canceler = $q.defer();

// create a resource
// (we have to re-craete it every time because this is the only
// way to renew the promise)
function getAPI(promise) {
    return $resource(
        'index.html', {}, {
            get: {
                method: 'GET',
                timeout: promise
            }
        }
    );
}

$scope.fetchData = function() {

    // abort previous requests if they are still running
    $scope.canceler.resolve();

    // create a new canceler
    $scope.canceler = $q.defer();

    // instead of using "API.get" we use "getAPI().get"
    getAPI( $scope.canceler.promise ).get({}, function() {
        $scope.actions.Push('completed');
        $scope.pending = 0;
    }, function() {
        $scope.actions.Push('aborted');
    });

}
0
Hendrik Jan

この課題を解決するために、次の解決策を得ました。

<!DOCTYPE html>
<html>
<head>
  <meta charset="utf-8" />
  <title>Cancel resource</title>
  <script src="//ajax.googleapis.com/ajax/libs/angularjs/1.3.9/angular.js"></script>
  <script src="//ajax.googleapis.com/ajax/libs/angularjs/1.3.9/angular-resource.js"></script>
  <script>
angular.module("app", ["ngResource"]).
factory(
  "services",
  ["$resource", function($resource)
  {
    function resolveAction(resolve)
    {
      if (this.params)
      {
        this.timeout = this.params.timeout;
        this.params.timeout = null;
      }

      this.then = null;
      resolve(this);
    }

    return $resource(
      "http://md5.jsontest.com/",
      {},
      {
        MD5:
        {
          method: "GET",
          params: { text: null },
          then: resolveAction
        },
      });
  }]).
controller(
  "Test",
  ["services", "$q", "$timeout", function(services, $q, $timeout)
  {
    this.value = "Sample text";
    this.requestTimeout = 100;

    this.call = function()
    {
      var self = this;

      self.result = services.MD5(
      {
        text: self.value,
        timeout: $q(function(resolve)
        {
          $timeout(resolve, self.requestTimeout);
        })
      });
    }
  }]);
  </script>
</head>
<body ng-app="app" ng-controller="Test as test">
  <label>Text: <input type="text" ng-model="test.value" /></label><br/>
  <label>Timeout: <input type="text" ng-model="test.requestTimeout" /></label><br/>
  <input type="button" value="call" ng-click="test.call()"/>
  <div ng-bind="test.result.md5"></div>
</body>
</html>

使い方

  1. $ resourceは、アクション定義、要求パラメーター、およびデータをマージして、$ http要求の構成パラメーターを作成します。
  2. $ httpリクエストに渡された設定パラメーターはpromiseのようなオブジェクトとして扱われるため、configを初期化する関数が含まれる場合があります。
  3. アクションのthen関数は、paramsからconfigにタイムアウトプロミスを渡すことができます。

詳細については、「 Angularjsリソースリクエストのキャンセル 」を参照してください。

0
Vladimir Nesterovsky