Как мне справиться с "Нет подключения к Интернету" с помощью Retrofit на Android

119

Я бы хотел справиться с ситуациями, когда нет подключения к Интернету. Обычно я бегал:

ConnectivityManager cm =
    (ConnectivityManager)context.getSystemService(Context.CONNECTIVITY_SERVICE);

NetworkInfo activeNetwork = cm.getActiveNetworkInfo();
boolean isConnected = activeNetwork != null &&
                  activeNetwork.isConnectedOrConnecting();

( отсюда ) перед отправкой запросов в сеть и уведомить пользователя, если нет подключения к Интернету.

Из того, что я видел, Retrofit специально не справляется с этой ситуацией. Если нет подключения к Интернету, я просто получу RetrofitErrorтайм-аут в качестве причины.

Если я хочу включить такую ​​проверку в каждый HTTP-запрос с помощью Retrofit, как мне это сделать? Или мне вообще стоит это делать.

Спасибо

Alex

AlexV
источник
Вы можете использовать блок try-catch, чтобы перехватить исключение тайм-аута для HTTP-соединения. Затем расскажите пользователям о состоянии подключения к Интернету. Не очень красивое, но альтернативное решение.
Тугрул
8
Да, но гораздо быстрее проверить с Android, есть ли у него интернет-соединение, вместо того, чтобы ждать тайм-аута соединения от сокета
AlexV
Android Query обрабатывает сообщение «Нет Интернета» и достаточно скоро возвращает соответствующий код ошибки. Может стоит заменить на aQuery? Другое решение - создать прослушиватель сетевых изменений, и таким образом приложение будет знать о доступности Интернета перед отправкой запроса.
Stan
для модернизации 2 см. github.com/square/retrofit/issues/1260
ghanbari

Ответы:

63

В итоге я создал настраиваемый клиент Retrofit, который проверяет подключение перед выполнением запроса и выдает исключение.

public class ConnectivityAwareUrlClient implements Client {

    Logger log = LoggerFactory.getLogger(ConnectivityAwareUrlClient.class);

    public ConnectivityAwareUrlClient(Client wrappedClient, NetworkConnectivityManager ncm) {
        this.wrappedClient = wrappedClient;
        this.ncm = ncm;
    }

    Client wrappedClient;
    private NetworkConnectivityManager ncm;

    @Override
    public Response execute(Request request) throws IOException {
        if (!ncm.isConnected()) {
            log.debug("No connectivity %s ", request);
            throw new NoConnectivityException("No connectivity");
        }
        return wrappedClient.execute(request);
    }
}

а затем использовать его при настройке RestAdapter

RestAdapter.Builder().setEndpoint(serverHost)
                     .setClient(new ConnectivityAwareUrlClient(new OkHttpClient(), ...))
AlexV
источник
1
Откуда ваш класс NetworkConnectivityManager? Пользовательские?
NPike 03
Да, обычай. В основном это код из вопроса
AlexV 07
2
OkHttpClient не работает, вместо этого используйте OKClient (). BDW хороший ответ. Спасибо.
Харшвардхан Триведи 03
Спасибо :-). Отредактировал свой ответ с правильным использованием OkHttp.
user1007522
1
@MominAlAziz, в зависимости от того, как вы определяете NoConnectivityException, вы можете либо расширить, IOExceptionлибо расширить егоRuntimeException
AlexV
45

После модернизации 1.8.0это устарело

retrofitError.isNetworkError()

ты должен использовать

if (retrofitError.getKind() == RetrofitError.Kind.NETWORK)
{

}

есть несколько типов ошибок, с которыми вы можете справиться:

NETWORK Во время связи с сервером возникла исключительная ситуация IOException, например тайм-аут, нет соединения и т. Д.

CONVERSION Возникло исключение при (де) сериализации тела.

HTTP От сервера был получен код состояния HTTP, отличный от 200, например 502, 503 и т. Д.

UNEXPECTEDПроизошла внутренняя ошибка при попытке выполнить запрос. Лучше всего повторно вызвать это исключение, чтобы ваше приложение аварийно завершило работу.

Мухаммад Альфаифи
источник
8
Избегайте использования дополнительных equalsпеременных, всегда используйте CONSTANT.equals(variable)вместо них, чтобы избежать возможного исключения NullPointerException. Или даже лучше в этом случае, enums accept == error.getKind() == RetrofitError.Kind.NETWORK
compare,
1
Замени Java на Kotlin, если вы устали от NPE и других синтаксических ограничений / боли
Луис CAD
42

В Retrofit 2 мы используем реализацию OkHttp Interceptor для проверки подключения к сети перед отправкой запроса. Если нет сети, сгенерируйте соответствующее исключение.

Это позволяет решать проблемы с сетевым подключением до того, как приступить к модернизации.

import java.io.IOException;

import okhttp3.Interceptor;
import okhttp3.Response;
import io.reactivex.Observable

public class ConnectivityInterceptor implements Interceptor {

    private boolean isNetworkActive;

    public ConnectivityInterceptor(Observable<Boolean> isNetworkActive) {
       isNetworkActive.subscribe(
               _isNetworkActive -> this.isNetworkActive = _isNetworkActive,
               _error -> Log.e("NetworkActive error " + _error.getMessage()));
    }

    @Override
    public Response intercept(Interceptor.Chain chain) throws IOException {
        if (!isNetworkActive) {
            throw new NoConnectivityException();
        }
        else {
            Response response = chain.proceed(chain.request());
            return response;
        }
    }
}

public class NoConnectivityException extends IOException {

    @Override
    public String getMessage() {
        return "No network available, please check your WiFi or Data connection";
    }
}
Kevin
источник
3
Это ошибочно, если вы включаете режим полета, а затем выключаете его, потому что вы устанавливаете var только один раз, делая наблюдаемое бесполезным.
Оливер Диксон,
3
Итак, вы делаете OkHttpClient.Builder.addInterceptor(new ConnectivityInterceptor(HERE))Что должно быть ЗДЕСЬ?
Rumid
3
Не могли бы вы включить этот код, чтобы люди получили полную картину?
Оливер Диксон
1
@Kevin, как я могу убедиться, что он обновится, когда соединение будет доступно?
Румид
3
это должен быть принятый ответ. еще один пример здесь: migapro.com/detect-offline-error-in-retrofit-2
j2emanue
35

@AlexV, вы уверены, что RetrofitError содержит тайм-аут как причину (SocketTimeOutException при вызове getCause ()) при отсутствии подключения к Интернету?

Насколько я знаю, когда нет подключения к Интернету, RetrofitError содержит исключение ConnectionException в качестве причины.

Если вы реализуете ErrorHandler, вы можете сделать что-то вроде этого:

public class RetrofitErrorHandler implements ErrorHandler {

    @Override
    public Throwable handleError(RetrofitError cause) {
        if (cause.isNetworkError()) {
            if (cause.getCause() instanceof SocketTimeoutException) {
                return new MyConnectionTimeoutException();
            } else {
                return new MyNoConnectionException();
            }
        } else {
            [... do whatever you want if it's not a network error ...]  
        }
    }

}
saguinav
источник
1
В источнике Retrofit есть предоставленный ErrorHandler, который вы можете использовать. Если вы не справитесь с ошибкой самостоятельно, Retrofit выдаст вам RetrofitError [java.net.UnknownHostException: невозможно разрешить хост «example.com»: адрес не связан с именем хоста]
Codeversed
1
@Codeversed, значит, isNetworkErrorизбавиться от ошибки хоста невозможно?
Вездесущий
2
как бы вы реализовали это в своем интерфейсе, клиент? Я имею в виду, к чему вы подключаете этот класс?
Пт
23
cause.isNetworkError () устарел : useerror.getKind() == RetrofitError.Kind.NETWORK
Хьюго Гресс,
6

Для модернизации 1

Когда вы получаете сообщение Throwableоб ошибке в HTTP-запросе, вы можете определить, является ли это сетевой ошибкой, с помощью следующего метода:

String getErrorMessage(Throwable e) {
    RetrofitError retrofitError;
    if (e instanceof RetrofitError) {
        retrofitError = ((RetrofitError) e);
        if (retrofitError.getKind() == RetrofitError.Kind.NETWORK) {
            return "Network is down!";
        }
    }
}
IgorGanapolsky
источник
5

просто сделайте это, вы будете уведомлены даже о таких проблемах, как

UnknownHostException

,

SocketTimeoutException

и другие.

 @Override public void onFailure(Call<List<BrokenGitHubRepo>> call, Throwable t) {  
if (t instanceof IOException) {
    Toast.makeText(ErrorHandlingActivity.this, "this is an actual network failure :( inform the user and possibly retry", Toast.LENGTH_SHORT).show();
    // logging probably not necessary
}
else {
    Toast.makeText(ErrorHandlingActivity.this, "conversion issue! big problems :(", Toast.LENGTH_SHORT).show();
    // todo log to some central bug tracking service
} }
Дипак Шарма
источник
2

вы можете использовать этот код

Response.java

import com.google.gson.annotations.SerializedName;

/**
 * Created by hackro on 19/01/17.
 */

public class Response {
    @SerializedName("status")
    public String status;

    public void setStatus(String status) {
        this.status = status;
    }

    public String getStatus() {
        return status;
    }

    @SuppressWarnings({"unused", "used by Retrofit"})
    public Response() {
    }

    public Response(String status) {
        this.status = status;
    }
}

NetworkError.java

import android.text.TextUtils;

import com.google.gson.Gson;

import java.io.IOException;
import java.util.List;
import java.util.Map;

import retrofit2.adapter.rxjava.HttpException;

import static java.net.HttpURLConnection.HTTP_UNAUTHORIZED;

/**
 * Created by hackro on 19/01/17.
 */

public class NetworkError extends Throwable {
    public static final String DEFAULT_ERROR_MESSAGE = "Please try again.";
    public static final String NETWORK_ERROR_MESSAGE = "No Internet Connection!";
    private static final String ERROR_MESSAGE_HEADER = "Error Message";
    private final Throwable error;

    public NetworkError(Throwable e) {
        super(e);
        this.error = e;
    }

    public String getMessage() {
        return error.getMessage();
    }

    public boolean isAuthFailure() {
        return error instanceof HttpException &&
                ((HttpException) error).code() == HTTP_UNAUTHORIZED;
    }

    public boolean isResponseNull() {
        return error instanceof HttpException && ((HttpException) error).response() == null;
    }

    public String getAppErrorMessage() {
        if (this.error instanceof IOException) return NETWORK_ERROR_MESSAGE;
        if (!(this.error instanceof HttpException)) return DEFAULT_ERROR_MESSAGE;
        retrofit2.Response<?> response = ((HttpException) this.error).response();
        if (response != null) {
            String status = getJsonStringFromResponse(response);
            if (!TextUtils.isEmpty(status)) return status;

            Map<String, List<String>> headers = response.headers().toMultimap();
            if (headers.containsKey(ERROR_MESSAGE_HEADER))
                return headers.get(ERROR_MESSAGE_HEADER).get(0);
        }

        return DEFAULT_ERROR_MESSAGE;
    }

    protected String getJsonStringFromResponse(final retrofit2.Response<?> response) {
        try {
            String jsonString = response.errorBody().string();
            Response errorResponse = new Gson().fromJson(jsonString, Response.class);
            return errorResponse.status;
        } catch (Exception e) {
            return null;
        }
    }

    public Throwable getError() {
        return error;
    }

    @Override
    public boolean equals(Object o) {
        if (this == o) return true;
        if (o == null || getClass() != o.getClass()) return false;

        NetworkError that = (NetworkError) o;

        return error != null ? error.equals(that.error) : that.error == null;

    }

    @Override
    public int hashCode() {
        return error != null ? error.hashCode() : 0;
    }
}

Реализация в ваших методах

        @Override
        public void onCompleted() {
            super.onCompleted();
        }

        @Override
        public void onError(Throwable e) {
            super.onError(e);
            networkError.setError(e);
            Log.e("Error:",networkError.getAppErrorMessage());
        }

        @Override
        public void onNext(Object obj) {   super.onNext(obj);        
    }
Дэвид Хакро
источник