AngularJSでAjaxリクエストが与えられた
$http.get("/backend/").success(callback);
別のリクエストが起動された場合にそのリクエストをキャンセルする最も効果的な方法は何ですか(同じバックエンド、異なるパラメータなど)。
AngularJSでAjaxリクエストが与えられた
$http.get("/backend/").success(callback);
別のリクエストが起動された場合にそのリクエストをキャンセルする最も効果的な方法は何ですか(同じバックエンド、異なるパラメータなど)。
この機能は、タイムアウトパラメータを介して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.
Angular1.3.15ではtimeoutプロパティを使用してAngular$httpAjaxをキャンセルしても機能しません。これが修正されるのを待つことができない人のために、私はAngularでラップされたjQueryAjaxソリューションを共有しています。
このソリューションには、次の2つのサービスが含まれます。
これが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);
後でデータをロードするときに、$httpの代わりにHttpServiceを使用します。
(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);
で発行されたリクエストのキャンセルは$http
、現在のバージョンのAngularJSではサポートされていません。この機能を追加するために開かれたプルリクエストがありますが、このPRはまだレビューされていないため、AngularJSコアに組み込まれるかどうかは明確ではありません。
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();
}
});
});
何らかの理由でconfig.timeoutが機能しません。私はこのアプローチを使用しました:
let cancelRequest = $q.defer();
let cancelPromise = cancelRequest.promise;
let httpPromise = $http.get(...);
$q.race({ cancelPromise, httpPromise })
.then(function (result) {
...
});
そしてcancelRequest.resolve()でキャンセルします。実際にはリクエストをキャンセルしませんが、少なくとも不要な応答はありません。
お役に立てれば。
これは、次のように$ httpサービスをabortメソッドで装飾することにより、受け入れられた回答を強化します...
'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;
}]);
}]);
このコードは何をしているのですか?
リクエストをキャンセルするには、「promise」タイムアウトを設定する必要があります。HTTPリクエストにタイムアウトが設定されていない場合、コードは「promise」タイムアウトを追加します。(タイムアウトがすでに設定されている場合は、何も変更されません)。
ただし、約束を解決するには、「延期」のハンドルが必要です。したがって、後で「延期」を取得できるようにマップを使用します。abortメソッドを呼び出すと、「deferred」がマップから取得され、resolveメソッドを呼び出してhttpリクエストをキャンセルします。
これが誰かを助けることを願っています。
制限
現在、これは$ http.getでのみ機能しますが、$http.postなどのコードを追加できます。
使い方 ...
次に、たとえば、次のように状態変更時に使用できます...
rootScope.$on('$stateChangeStart', function (event, toState, toParams) {
angular.forEach($http.pendingRequests, function (request) {
$http.abort(request);
});
});
これは複数のリクエストを処理するバージョンであり、エラーブロックのエラーを抑制するためにコールバックでキャンセルされたステータスもチェックします。(Typescriptで)
コントローラーレベル:
requests = new Map<string, ng.IDeferred<{}>>();
私のhttpgetで:
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回呼び出しましたが、最後の1つだけが実行されました。
$http
関数をpromiseに追加する「デコレータ」を使用して、カスタム関数をサービスに追加できabort()
ます。
いくつかの実用的なコードは次のとおりです。
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()
また、 promiseをチェーンしても機能することを確認するためのコードもあります。
使用方法の例を次に示します。
// 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;
});