OkHttp / RetrofitでHTTPリクエストを再試行する方法は？
AndroidプロジェクトでRetrofit/OkHttp（1.6）を使用しています。
どちらにもリクエスト再試行メカニズムが組み込まれていません。さらに検索すると、OkHttpがサイレントリトライを行っているようです。接続（HTTPまたはHTTPS）のいずれでも発生しません。 okclientで再試行を構成する方法は？
今のところ、私は例外をキャッチし、カウンター変数の維持を再試行しています。
Retrofit 1.xの場合;
Interceptors を使用できます。カスタムインターセプターを作成する
OkHttpClient client = new OkHttpClient();
client.setConnectTimeout(CONNECT_TIMEOUT_MILLIS, TimeUnit.MILLISECONDS);
client.setReadTimeout(READ_TIMEOUT_MILLIS, TimeUnit.MILLISECONDS);
client.interceptors().add(new Interceptor() {
@Override
public Response intercept(Chain chain) throws IOException {
Request request = chain.request();
// try the request
Response response = chain.proceed(request);
int tryCount = 0;
while (!response.isSuccessful() && tryCount < 3) {
Log.d("intercept", "Request is not successful - " + tryCount);
tryCount++;
// retry the request
response = chain.proceed(request);
}
// otherwise just pass the original response on
return response;
}
});
そして、RestAdapterの作成中に使用します。
new RestAdapter.Builder()
.setEndpoint(API_URL)
.setRequestInterceptor(requestInterceptor)
.setClient(new OkClient(client))
.build()
.create(Adapter.class);
Retrofit 2.xの場合;
Call.clone（） メソッドを使用して、リクエストを複製して実行できます。
これがオプションかどうかはわかりませんが、 RxJava をRetrofitとともに使用できます。
レトロフィットは、休憩時にオブザーバブルを返すことができます。 Oberservablesでは、retry(count)を呼び出すだけで、エラーが発生したときにObservableを再サブスクライブできます。
次のように、インターフェイスで呼び出しを定義する必要があります。
@GET("/data.json")
Observable<DataResponse> fetchSomeData();
次に、次のようにこのObservableにサブスクライブできます。
restApi.fetchSomeData()
.retry(5) // Retry the call 5 times if it errors
.subscribeOn(Schedulers.io()) // execute the call asynchronously
.observeOn(AndroidSchedulers.mainThread()) // handle the results in the ui thread
.subscribe(onComplete, onError);
// onComplete and onError are of type Action1<DataResponse>, Action1<Throwable>
// Here you can define what to do with the results
私はあなたと同じ問題を抱えていました。これが実際に私の解決策でした。 RxJavaは、Retrofitと組み合わせて使用するのに最適なライブラリです。再試行に加えて多くのクールなこともできます（例： composing and chaining calls ）。
Response.isSuccessful（）の問題は、SocketTimeoutExceptionなどの例外がある場合です。
元のコードを修正して修正しました。
OkHttpClient client = new OkHttpClient();
client.setConnectTimeout(CONNECT_TIMEOUT_MILLIS, TimeUnit.MILLISECONDS);
client.setReadTimeout(READ_TIMEOUT_MILLIS, TimeUnit.MILLISECONDS);
client.interceptors().add(new Interceptor() {
@Override
public Response intercept(Chain chain) throws IOException {
Request request = chain.request();
Response response = null;
boolean responseOK = false;
int tryCount = 0;
while (!responseOK && tryCount < 3) {
try {
response = chain.proceed(request);
responseOK = response.isSuccessful();
}catch (Exception e){
Log.d("intercept", "Request is not successful - " + tryCount);
}finally{
tryCount++;
}
}
// otherwise just pass the original response on
return response;
}
});
それが役に立てば幸い。よろしく。
私は、API処理（retrofit/okhttpによって行われます）と再試行を組み合わせてはいけないと考えています。再試行メカニズムはより直交的であり、他の多くのコンテキストでも使用できます。そのため、すべてのAPI呼び出しと要求/応答処理にRetrofit/OkHTTPを使用し、API呼び出しを再試行するために上記の別のレイヤーを導入します。
これまでのJavaの限られた経験では、jhlatermanのFailsafeライブラリ（github： jhalterman/failsafe ）は、多くの「再試行」状況をきれいに処理するための非常に用途の広いライブラリであることがわかりました。例として、認証用にインスタンス化されたmySimpleServiceを後付けで使用する方法を次に示します-
AuthenticationResponse authResp = Failsafe.with(
new RetryPolicy().retryOn(Arrays.asList(IOException.class, AssertionError.class))
.withBackoff(30, 500, TimeUnit.MILLISECONDS)
.withMaxRetries(3))
.onRetry((error) -> logger.warn("Retrying after error: " + error.getMessage()))
.get(() -> {
AuthenticationResponse r = mySimpleAPIService.authenticate(
new AuthenticationRequest(username,password))
.execute()
.body();
assert r != null;
return r;
});
上記のコードは、ソケットの例外、接続エラー、アサーションエラー、およびそれらの再試行を最大3回キャッチし、指数バックオフします。また、再試行時の動作をカスタマイズしたり、フォールバックを指定したりすることもできます。それは非常に設定可能であり、ほとんどの再試行状況に適応できます。
ライブラリのドキュメントを確認してください。再試行だけでなく、他にも多くの利点があります。
トップの答えへの礼儀、これは私のために働いたものです。接続に問題がある場合は、数秒待ってから再試行してください。
public class ErrorInterceptor implements Interceptor {
ICacheManager cacheManager;
Response response = null;
int tryCount = 0;
int maxLimit = 3;
int waitThreshold = 5000;
@Inject
public ErrorInterceptor() {
}
@Override
public Response intercept(Chain chain){
// String language = cacheManager.readPreference(PreferenceKeys.LANGUAGE_CODE);
Request request = chain.request();
response = sendReqeust(chain,request);
while (response ==null && tryCount < maxLimit) {
Log.d("intercept", "Request failed - " + tryCount);
tryCount++;
try {
Thread.sleep(waitThreshold); // force wait the network thread for 5 seconds
} catch (InterruptedException e) {
e.printStackTrace();
}
response = sendReqeust(chain,request);
}
return response;
}
private Response sendReqeust(Chain chain, Request request){
try {
response = chain.proceed(request);
if(!response.isSuccessful())
return null;
else
return response;
} catch (IOException e) {
return null;
}
}
}
Http接続が失敗すると、Sinan Kozakが提供する方法（OKHttpClientインターセプター）が機能しないことがわかりました。HTTP応答にはまだ何も関係ありません。
別の方法でObservableオブジェクトをフックし、.retryWhenを呼び出します。また、retryCount制限を追加しました。
import retrofit2.Call;
import retrofit2.CallAdapter;
import retrofit2.Retrofit;
import retrofit2.adapter.rxjava.HttpException;
import retrofit2.adapter.rxjava.RxJavaCallAdapterFactory;
import retrofit2.converter.jackson.JacksonConverterFactory;
import rx.Observable;
import Java.io.IOException;
import Java.lang.annotation.Annotation;
import Java.lang.reflect.Type;
それから
RxJavaCallAdapterFactory originCallAdaptorFactory = RxJavaCallAdapterFactory.create();
CallAdapter.Factory newCallAdaptorFactory = new CallAdapter.Factory() {
@Override
public CallAdapter<?> get(Type returnType, Annotation[] annotations, Retrofit retrofit) {
CallAdapter<?> ca = originCallAdaptorFactory.get(returnType, annotations, retrofit);
return new CallAdapter<Observable<?>>() {
@Override
public Type responseType() {
return ca.responseType();
}
int restRetryCount = 3;
@Override
public <R> Observable<?> adapt(Call<R> call) {
Observable<?> rx = (Observable<?>) ca.adapt(call);
return rx.retryWhen(errors -> errors.flatMap(error -> {
boolean needRetry = false;
if (restRetryCount >= 1) {
if (error instanceof IOException) {
needRetry = true;
} else if (error instanceof HttpException) {
if (((HttpException) error).code() != 200) {
needRetry = true;
}
}
}
if (needRetry) {
restRetryCount--;
return Observable.just(null);
} else {
return Observable.error(error);
}
}));
}
};
}
};
次に追加または置換
.addCallAdapterFactory(RxJavaCallAdapterFactory.create())
と
.addCallAdapterFactory(newCallAdaptorFactory)
例えば：
return new Retrofit
.Builder()
.baseUrl(baseUrl)
.client(okClient)
.addCallAdapterFactory(newCallAdaptorFactory)
.addConverterFactory(JacksonConverterFactory.create(objectMapper));
注：簡単にするため、HTTPコード> 404コードを再試行として扱います。自分で変更してください。
また、http応答が200の場合、上記のrx.retryWhenは呼び出されません。そのような応答をチェックする場合、.retryWhenの前にrx.subscribeOn(...throw error...を追加できます。
再試行の問題に対処するインターセプターを好む人のために-Sinanの答えに基づいて、ここに私のインターセプターが提案されていますキャンセル。 （IOExceptions（SocketTimeout、UnknownHostなど）のみを扱います）
builder.addInterceptor(new Interceptor() {
@Override
public Response intercept(Chain chain) throws IOException {
Request request = chain.request();
// try the request
Response response = null;
int tryCount = 1;
while (tryCount <= MAX_TRY_COUNT) {
try {
response = chain.proceed(request);
break;
} catch (Exception e) {
if (!NetworkUtils.isNetworkAvailable()) {
// if no internet, dont bother retrying request
throw e;
}
if ("Canceled".equalsIgnoreCase(e.getMessage())) {
// Request canceled, do not retry
throw e;
}
if (tryCount >= MAX_TRY_COUNT) {
// max retry count reached, giving up
throw e;
}
try {
// sleep delay * try count (e.g. 1st retry after 3000ms, 2nd after 6000ms, etc.)
Thread.sleep(RETRY_BACKOFF_DELAY * tryCount);
} catch (InterruptedException e1) {
throw new RuntimeException(e1);
}
tryCount++;
}
}
// otherwise just pass the original response on
return response;
}
});
バージョンを共有したいだけです。 rxJavaのretryWhenメソッドを使用します。私のバージョンでは、N = 15秒ごとに接続が再試行され、インターネット接続が回復すると、ほとんどすぐに再試行が行われます。
public class RetryWithDelayOrInternet implements Function<Flowable<? extends Throwable>, Flowable<?>> {
public static boolean isInternetUp;
private int retryCount;
@Override
public Flowable<?> apply(final Flowable<? extends Throwable> attempts) {
return Flowable.fromPublisher(s -> {
while (true) {
retryCount++;
try {
Thread.sleep(1000);
} catch (InterruptedException e) {
attempts.subscribe(s);
break;
}
if (isInternetUp || retryCount == 15) {
retryCount = 0;
s.onNext(new Object());
}
}
})
.subscribeOn(Schedulers.single());
}}
そして、次のように.subscribeの前に使用する必要があります。
.retryWhen(new RetryWithDelayOrInternet())
IsInternetUpフィールドを手動で変更する必要があります
public class InternetConnectionReceiver extends BroadcastReceiver {
@Override
public void onReceive(Context context, Intent intent) {
boolean networkAvailable = isNetworkAvailable(context);
RetryWithDelayOrInternet.isInternetUp = networkAvailable;
}
public static boolean isNetworkAvailable(Context context) {
ConnectivityManager connectivityManager = (ConnectivityManager) context.getSystemService(Context.CONNECTIVITY_SERVICE);
NetworkInfo activeNetworkInfo = connectivityManager.getActiveNetworkInfo();
return activeNetworkInfo != null && activeNetworkInfo.isConnected();
}}
OkHttp 3.9.1で私のために働いた解決策（この質問の他の答えを検討してください）：
@NonNull
@Override
public Response intercept(@NonNull Chain chain) throws IOException {
Request request = chain.request();
int retriesCount = 0;
Response response = null;
do {
try {
response = chain.proceed(request);
// Retry if no internet connection.
} catch (ConnectException e) {
Log.e(TAG, "intercept: ", e);
retriesCount++;
try {
Thread.sleep(RETRY_TIME);
} catch (InterruptedException e1) {
Log.e(TAG, "intercept: ", e1);
}
}
} while (response == null && retriesCount < MAX_RETRIES);
// If there was no internet connection, then response will be null.
// Need to initialize response anyway to avoid NullPointerException.
if (response == null) {
response = chain.proceed(newRequest);
}
return response;
}
API仕様のレトロフィット2.0に存在するようです： https://github.com/square/retrofit/issues/297 。現在、最良の方法は例外をキャッチして手動で再試行することです。
Retrofitリクエストを再試行するための最良の方法を見つけるために、この問題に多く取り組んでいます。私はRetrofit 2を使用しているので、私の解決策はRetrofit 2です。Retrofit1については、ここで受け入れられている回答のようにInterceptorを使用する必要があります。 @joluetの答えは正しいですが、彼は.subscribe（onComplete、onError）メソッドの前に再試行メソッドを呼び出す必要があることに言及しませんでした。これは非常に重要です。そうしないと、@ joluetの回答で言及されている@pocmoのようにリクエストが再試行されません。これが私の例です：
final Observable<List<NewsDatum>> newsDetailsObservable = apiService.getCandidateNewsItem(newsId).map((newsDetailsParseObject) -> {
return newsDetailsParseObject;
});
newsDetailsObservable.subscribeOn(Schedulers.io())
.observeOn(AndroidSchedulers.mainThread())
.retry((integer, throwable) -> {
//MAX_NUMBER_TRY is your maximum try number
if(integer <= MAX_NUMBER_TRY){
return true;//this will retry the observable (request)
}
return false;//this will not retry and it will go inside onError method
})
.subscribe(new Subscriber<List<NewsDatum>>() {
@Override
public void onCompleted() {
// do nothing
}
@Override
public void onError(Throwable e) {
//do something with the error
}
@Override
public void onNext(List<NewsDatum> apiNewsDatum) {
//do something with the parsed data
}
});
apiServiceは私のRetrofitServiceProviderオブジェクトです。
ところで：私はJava 8を使用しているので、多くのラムダ式がコード内にあります。
実用的なソリューション。
public int callAPI() {
return 1; //some method to be retried
}
public int retrylogic() throws InterruptedException, IOException{
int retry = 0;
int status = -1;
boolean delay = false;
do {
if (delay) {
Thread.sleep(2000);
}
try {
status = callAPI();
}
catch (Exception e) {
System.out.println("Error occured");
status = -1;
}
finally {
switch (status) {
case 200:
System.out.println(" **OK**");
return status;
default:
System.out.println(" **unknown response code**.");
break;
}
retry++;
System.out.println("Failed retry " + retry + "/" + 3);
delay = true;
}
}while (retry < 3);
System.out.println("Aborting download of dataset.");
return status;
}
docs で述べられているように、より良いのは、オーセンティケーターで焼いたものを使用することです。例えば、次のとおりです。
public void run() throws Exception {
client.setAuthenticator(new Authenticator() {
@Override public Request authenticate(Proxy proxy, Response response) {
System.out.println("Authenticating for response: " + response);
System.out.println("Challenges: " + response.challenges());
String credential = Credentials.basic("jesse", "password1");
return response.request().newBuilder()
.header("Authorization", credential)
.build();
}
@Override public Request authenticateProxy(Proxy proxy, Response response) {
return null; // Null indicates no attempt to authenticate.
}
});
Request request = new Request.Builder()
.url("http://publicobject.com/secrets/hellosecret.txt")
.build();
Response response = client.newCall(request).execute();
if (!response.isSuccessful()) throw new IOException("Unexpected code " + response);
System.out.println(response.body().string());
}