乐趣区

Android封装Retrofit2OkHttp3RxJava网络请求

现在 Android 市面上很火的当然是 Retrofit+RxJava + OkHttp, 功能强大,简单易用,因此选用这套方案来改造网络库。

简介:

Retrofit: Retrofit 是 Square 公司开发的一款正对 Android 网络请求的框架。底层基于 OkHttp 实现,OkHttp 已经得到了 google 官方的认可。Retrofit 官网

OkHttp: 也是 Square 开源的网络请求库

RxJava:RxJava 在 GitHub 主页上的自我介绍是 “a library for composing asynchronous and event-based programs using observable sequences for the Java VM”(一个在 Java VM 上使用可观测的序列来组成异步的、基于事件的程序的库)。这就是 RxJava,概括得非常精准。总之就是让异步操作变得非常简单。

各自的职责:Retrofit 负责请求的数据和请求的结果,使用接口的方式呈现,OkHttp 负责请求的过程,RxJava 负责异步,各种线程之间的切换。

RxJava + Retrofit + okHttp 已成为当前 Android 网络请求最流行的方式。

一、添加依赖库

    //RxJava
    compile 'io.reactivex:rxjava:1.1.3'
    //RxAndroid
    compile 'io.reactivex:rxandroid:1.1.0'
    //retrofit
    compile 'com.squareup.retrofit2:retrofit:2.0.0'
    //retrofit 依赖 Gson
    compile 'com.squareup.retrofit2:converter-gson:2.0.0'
    //OkHttp
    compile 'com.squareup.okhttp3:okhttp:3.2.0'
    //retrofit 依赖 RxJava
    compile 'com.squareup.retrofit2:adapter-rxjava:2.0.0'

二、生成接口实例的管理类

public class RetrofitServiceManager {
    private static final int DEFAULT_CONNECT_TIME = 10;
    private static final int DEFAULT_WRITE_TIME = 30;
    private static final int DEFAULT_READ_TIME = 30;
    private final OkHttpClient okHttpClient;
    private static final String REQUEST_PATH = "https://api.douban.com/v2/movie/";
    private final Retrofit retrofit;

    private RetrofitServiceManager() {okHttpClient = new OkHttpClient.Builder()
                .connectTimeout(DEFAULT_CONNECT_TIME, TimeUnit.SECONDS)// 连接超时时间
                .writeTimeout(DEFAULT_WRITE_TIME, TimeUnit.SECONDS)// 设置写操作超时时间
                .readTimeout(DEFAULT_READ_TIME, TimeUnit.SECONDS)// 设置读操作超时时间
                .build();

        retrofit = new Retrofit.Builder()
                .client(okHttpClient)// 设置使用 okhttp 网络请求
                .baseUrl(REQUEST_PATH)// 设置服务器路径
                .addConverterFactory(GsonConverterFactory.create())// 添加转化库,默认是 Gson
                .addCallAdapterFactory(RxJavaCallAdapterFactory.create())// 添加回调库,采用 RxJava
                .build();}

    private static class SingletonHolder {private static final RetrofitServiceManager INSTANCE = new RetrofitServiceManager();
    }

    /*
    * 获取 RetrofitServiceManager
    **/
    public static RetrofitServiceManager getInstance() {return SingletonHolder.INSTANCE;}

    public <T> T create(Class<T> service) {return retrofit.create(service);
    }
}

从 Retrofit 升级到 2.0 之后,就使用了 build 设计模式 (生产者模式),将一个复杂的构建与其表示相分离。
同样升级到 okhttp3 后,也使用 build 设计模式。

okhttp 参数说明:cookieJar(new CookiesManager()):设置一个自动管理 cookies 的管理器
    addInterceptor(new MyIntercepter()):添加拦截器
    addNetworkInterceptor(new
    CookiesInterceptor(MyApplication.getInstance().getApplicationContext())):添加网络连接器
    connectTimeout(30, TimeUnit.SECONDS): 请求超时时间 
    writeTimeout(30,TimeUnit.SECONDS): 写入超时时间 
    readTimeout(30, TimeUnit.SECONDS): 读取超时时间

三、创建接口类

public interface MovieService {
        // 获取豆瓣前 20 的榜单
        @GET("top250")
        Observable<movieTopReq> getMovicTop(@Query("start") int start, @Query("count") int count);
    }

接口已经创建出来了,Retrofit 是用注解来完成设置的,要访问的 url,请求方式,请求头。
常用的注解:
@GET GET 请求方式
@POST POST 请求方式
@Query GET 请求参数
@Header 用来添加 Header 请求头
@FormUrlEncoded post 请求头标示
其他注解请求方式:
@PUT 表示这是一个 PUT 请求
@DELETE 表示这是一个 DELETE 请求
@HEAD 表示这是一个 HEAD 请求
@OPTIONS 表示这是一个 OPTION 请求
@PATCH 表示这是一个 PAT 请求

四、创建实现接口来方便调用

public class HttpEngine {private static MovieService movieService = RetrofitServiceManager.getInstance().create(MovieService.class);

    /*
    * 获取豆瓣电影榜单
    * **/
    public static void getDuoBanTop(int start, int count, Observer<movieTopReq> observer) {setSubscribe(movieService.getMovicTop(start, count), observer);
    }

    private static <T> void setSubscribe(Observable<T> observable, Observer<T> observer) {observable.subscribeOn(Schedulers.io())
                .subscribeOn(Schedulers.newThread())// 子线程访问网络
                .observeOn(AndroidSchedulers.mainThread())// 回调到主线程
                .subscribe(observer);
    }
}

把网络接口统一放到一个接口类中,让 Retrofit 创建实现接口来方便调用。setSubscribe 方法其实就是插入观察者。

五、activity 调用

public class MainActivity extends AppCompatActivity {

    private RecyclerView recyclerView;

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

    private void initData() {
        // 调用封装好的 retrofit 请求方法
        HttpEngine.getDuoBanTop(0, 20, new Observer<movieTopReq>() {
            @Override
            public void onCompleted() {// 完成}

            @Override
            public void onError(Throwable e) {
                // 失败
                Log.i("retrofit==111=", "请求错误:"+e.getMessage());
            }

            @Override
            public void onNext(movieTopReq movieTopReq) {
                // 成功
                Log.i("retrofit==222=", movieTopReq.getTitle()+"---"+movieTopReq.getCount()
                        +"---"+movieTopReq.getStart()+"---"+movieTopReq.getTotal()+"---"+movieTopReq.getSubjects());
            }
        });
    }
}

需要 Demo 的童鞋公众号回复:”Retrofit” 即可获取


以下是个人公众号(longxuanzhigu),之后发布的文章会同步到该公众号,方便交流学习 Android 知识及分享个人爱好文章:

退出移动版