您的当前位置:首页正文

使用retrofit+okhttp实现无缝网络状态监测

来源:要发发知识网

译者注:我得去补补Application Interceptor和Network Interceptor

在依赖web服务的android app中,我们通常要在发送web请求前检查网络的状态。这样我们就可以弹出提示告诉用户问题而不是等待网络请求超时。网络状态通常需要调用ConnectivityManager。然而每个请求都要这样做有点繁琐,现在最流行的网络请求解决方案是使用Retrofit。当使用Retrofit时处理异步结果最简单的方式是用RxJava Observables。如果你正在使用Retrofit和RxJava 那么就有一种简单的方式来实现监测网络连接状态。让我们来看看吧!

首先我们创建一个监测网络接口,这样我们就可以使用依赖注入在测试的时候进行切换:

public interface NetworkMonitor {
    boolean isConnected();
}

然后实现这个接口并调用系统的ConnectivityManager。

public class LiveNetworkMonitor implements NetworkMonitor {

    private final Context applicationContext;

    public LiveNetworkMonitor(Context context) {
        applicationContext = context.getApplicationContext();
    }

    public boolean isConnected() {
        ConnectivityManager cm =
                (ConnectivityManager) applicationContext.getSystemService(Context.CONNECTIVITY_SERVICE);

        NetworkInfo activeNetwork = cm.getActiveNetworkInfo();
        return activeNetwork != null &&
                activeNetwork.isConnectedOrConnecting();
    }
}

假设你已经配置好了Retrofit,在我们这个例子中我们打算用github api获取public events,如下:

public interface GithubWebService {

    @GET("events")
    Observable<List<Event>> getPublicEvents();
}

然后在我们的activity中调用这个请求接口:

public class MainActivity extends AppCompatActivity {


    protected GithubWebService githubWebService = ...;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);

        githubWebService.getPublicEvents()
                .observeOn(AndroidSchedulers.mainThread())
                .subscribe(events -> {
                    // TODO onNext
                }, throwable -> {
                    // TODO onError
                });
    }
}

额 那我们在哪里调用这个方法NetworkMonitor.isConnected() 才能实现每次网络请求进行无缝网络检查呢?让我们看一下创建Retrofit对象的dagger module代码:

@Provides
@Singleton
GithubWebService provideWebService() {

    String baseUrl = 

    Retrofit.Builder builder = new Retrofit.Builder()
            .baseUrl(baseUrl)
            .addConverterFactory(GsonConverterFactory.create())
            .addCallAdapterFactory(RxJavaCallAdapterFactory
                                    .createWithScheduler(Schedulers.io()));

    OkHttpClient.Builder okHttpClientBuilder = new OkHttpClient.Builder();

    return builder.client(okHttpClientBuilder.build())
            .build()
            .create(GithubWebService.class);
}
@Provides
@Singleton
GithubWebService provideWebService(NetworkMonitor networkMonitor) {

    String baseUrl = 

    Retrofit.Builder builder = new Retrofit.Builder()
            .baseUrl(baseUrl)
            .addConverterFactory(GsonConverterFactory.create())
            .addCallAdapterFactory(RxJavaCallAdapterFactory.createWithScheduler(Schedulers.io()));

    OkHttpClient.Builder okHttpClientBuilder = new OkHttpClient.Builder();

    // 看这里 !!! 我们添加了一个网络监听拦截器
    okHttpClientBuilder.addInterceptor(chain -> {
        boolean connected = networkMonitor.isConnected();
        if (networkMonitor.isConnected()) {
            return chain.proceed(chain.request());
        } else {
            throw new NoNetworkException();
        }
    });

    return builder.client(okHttpClientBuilder.build())
            .build()
            .create(GithubWebService.class);
}

我们最后要做的事(并且不幸的是每个地方都要这样做)是在onError方法中捕获这个异常:

githubWebService.getPublicEvents()
        .subscribeOn(AndroidSchedulers.mainThread()
        .subscribe(events -> {
            // TODO onNext
        }, throwable -> {
            // on Error
            if (throwable instanceof NoNetworkException) {
                // TODO handle 'no network'
            } else {
                // TODO handle some other error
            }
        });

在这个例子中,我决定使用的是Application Interceptor.我会把这个决定留给你是使用Application Interceptor还是Network Interceptor。如果你要Network Interceptor你只需要用 addNetworkInterceptor 替换 addInterceptor。