让初学者把Rxjava+Retrofit先跑起来

这是一篇浅显的Rxjava+Retrofit文章，从初学者出发，感觉如果工作中没有充足发挥自学技能的项目，直接去看大佬们写的很深入的讲解，特别容易遗忘、懵甚至不理解，所以我决定写一篇浅显的使用Rxjava+Retrofit的文章。

所需依赖库：

  1. compile"io.reactivex.rxjava2:rxjava:2.1.1"
  2.  
  3. compile'io.reactivex.rxjava2:rxandroid:2.0.2'
  4.  
  5. compile'com.squareup.retrofit2:retrofit:2.3.0'
  6.  
  7. compile'com.squareup.retrofit2:converter-gson:2.3.0'
  8.  
  9. compile'com.squareup.retrofit2:adapter-rxjava2:2.3.0'

 

一、     retrofit的使用

首先我们要先了解一下retrofit，他是这个组合负责网络访问的部分，获取rxjava的被观察者。

1.    根据要访问的数据创建实体类，我访问的是“聚合数据”提供的新闻头条链接（“http://v.juhe.cn/toutiao/index?type=top&key=APPKEY”），获取的数据格式为：

 

根据数据创建实体类：

 

  1. public class NewsBeen<T> {
  2.     @SerializedName("reason")
  3.     private String reason;
  4.     @SerializedName("result")
  5.     private T result;
  6.     @SerializedName("error_code")
  7.     private int error_code;
  8.  
  9.     public String getReason() {
  10.      return reason;
  11.     }
  12.  
  13.     public void setReason(String reason) {
  14.      this.reason = reason;
  15.     }
  16.  
  17.     public T getResult() {
  18.      return result;
  19.     }
  20.  
  21.     public void setResult(T result) {
  22.      this.result = result;
  23.     }
  24.  
  25.     public int getError_code() {
  26.      return error_code;
  27.     }
  28.  
  29.     public void setError_code(int error_code) {
  30.      this.error_code = error_code;
  31.     }
  32. }

 

  1. public class ResultBean {
  2.     private String stat;
  3.     private List<DataBean> data;
  4.  
  5.     public String getStat() {
  6.      return stat;
  7.     }
  8.     public void setStat(String stat) {
  9.      this.stat = stat;
  10.     }
  11.     public List<DataBean> getData() {
  12.      return data;
  13.     }
  14.     public void setData(List<DataBean> data) {
  15.      this.data = data;
  16.     }
  17.  
  18. public static class DataBean {
  19. private String uniquekey;
  20. private String title;
  21. private String date;
  22. private String category;
  23. private String author_name;
  24. private String url;
  25. private String thumbnail_pic_s;
  26. private String thumbnail_pic_s02;
  27. private String thumbnail_pic_s03;
  28.  
  29. public String getUniquekey() {
  30. return uniquekey;
  31. }
  32.  
  33. public void setUniquekey(String uniquekey) {
  34. this.uniquekey = uniquekey;
  35. }
  36.  
  37. public String getTitle() {
  38. return title;
  39. }
  40.  
  41. public void setTitle(String title) {
  42. this.title = title;
  43. }
  44.  
  45. public String getDate() {
  46. return date;
  47. }
  48.  
  49. public void setDate(String date) {
  50. this.date = date;
  51. }
  52.  
  53. public String getCategory() {
  54. return category;
  55. }
  56.  
  57. public void setCategory(String category) {
  58. this.category = category;
  59. }
  60.  
  61. public String getAuthor_name() {
  62. return author_name;
  63. }
  64.  
  65. public void setAuthor_name(String author_name) {
  66. this.author_name = author_name;
  67. }
  68.  
  69. public String getUrl() {
  70. return url;
  71. }
  72.  
  73. public void setUrl(String url) {
  74. this.url = url;
  75. }
  76.  
  77. public String getThumbnail_pic_s() {
  78. return thumbnail_pic_s;
  79. }
  80.  
  81. public void setThumbnail_pic_s(String thumbnail_pic_s) {
  82. this.thumbnail_pic_s = thumbnail_pic_s;
  83. }
  84.  
  85. public String getThumbnail_pic_s02() {
  86. return thumbnail_pic_s02;
  87. }
  88.  
  89. public void setThumbnail_pic_s02(String thumbnail_pic_s02) {
  90. this.thumbnail_pic_s02 = thumbnail_pic_s02;
  91. }
  92.  
  93. public String getThumbnail_pic_s03() {
  94. return thumbnail_pic_s03;
  95. }
  96.  
  97. public void setThumbnail_pic_s03(String thumbnail_pic_s03) {
  98. this.thumbnail_pic_s03 = thumbnail_pic_s03;
  99. }
  100. }
  101. }

实体类创建没什么好说的，可以直接拿参数GsonFormat一下就好了。

2.    然后定义接口

  1. public interface NewsService {
  2.  
  3. @GET("index")
  4. Observable<NewsBeen<ResultBean>> getNews(@Query("type") String type, @Query("key") String ley);
  5.  
  6. @GET("index?type=top&key=28aa4ac2a689c881a4e6e51cf918d695")
  7. Observable<NewsBeen<ResultBean>> getNews();
  8. }

接口中两个方法效果一样，@后跟网络请求方法，一般为GET和POST，就是GET和POST请求，括号中为拼接的链接，比如这条链接：http://v.juhe.cn/toutiao/index?type=top&key=APPKEY，我们把“http://v.juhe.cn/toutiao/”当做BaseUrl，那请求后括号中的内容加方法参数中的内容拼接起来就是要访问的链接，这要注意以下几点：

1.    其中BaseUrl的结尾必须为“/”，不然请求链接时会报错。

2.    请求方法后括号可以通过（index/{id}）的写法，在方法参数中获取id，方法参数的处理为（@Path（”id”） int  id），比如传过来123，则此回调与baseurl拼接的链接就为“index/123”。

3.    如果链接为http://v.juhe.cn/toutiao/index?type=top&key=APPKEY，除了傻瓜式把后边全放到请求方法后，也可以像方法一中那样更加灵活的获取：(@Query("type")String type, @Query("key")String ley);

注：像@Paht和@Query这些注解的具体使用可以在走通整个网络框架后再去慢慢学习了解，如果当前正在处理一个项目，且所需要的网络连接比较特殊，也可以专门去搜一下这块。

3.接下来定义一个OkHttpClient，进行一些访问配置。

  1. OkHttpClient httpClient = new OkHttpClient.Builder()
  2. .addInterceptor(new Interceptor() {//添加网络访问Header
  3. @Override
  4. public Response intercept(Chain chain) throws IOException {
  5. Request.Builder builder = chain.request().newBuilder();
  6. builder.addHeader("token", "123");
  7. return chain.proceed(builder.build());
  8. }
  9. })
  10. .addInterceptor(new HttpLoggingInterceptor(new HttpLoggingInterceptor.Logger() {
  11. @Override
  12. public void log(String message) {
  13. //获取网络访问错误信息
  14. }
  15. }).setLevel(HttpLoggingInterceptor.Level.BASIC))
  16. .connectTimeout(TIMEOUT, TimeUnit.SECONDS)//链接超时
  17. .readTimeout(TIMEOUT,TimeUnit.SECONDS)//读取超时
  18. .build();

一般使用retrofit访问网络需要添加如上代码中的HttpLoggingInterceptor简化调试，需添加依赖：

compile 'com.squareup.okhttp3:logging-interceptor:3.9.0'

4.     获取接口类

  1. NewsService service = new Retrofit.Builder()
  2. .baseUrl(BASE_URL)
  3. .addConverterFactory(GsonConverterFactory.create(buildGson()))
  4. .addCallAdapterFactory(RxJava2CallAdapterFactory.create())
  5. .client(httpClient)
  6. .build()
  7. .create(NewsService.class);

.addConverterFactory(GsonConverterFactory.create(buildGson()))这句代码是通过gson解析网络获取的数据，不加应该是会报错的，其中Gson的定义：

  1. Gson buildGson() = GsonBuilder()
  2. .serializeNulls()
  3. .setFieldNamingPolicy(FieldNamingPolicy.IDENTITY)
  4. .create();

.addCallAdapterFactory(RxJava2CallAdapterFactory.create())这句代码是添加对Rxjava2的支持，注意是Rxjava2，如果集成的是Rxjava要对应修改这里。

5.  最后通过接口返回Rxjava的被观察者

Observable<NewsBeen<ResultBean>> observable = RetrofitFactory.getNews().getNews("top", "123456");
这样Retrofit的工作就完成了，接下来就看Rxjava部分，Rxjava同样是很优秀内容很多的框架，这次就先依着简单的实现效果看一下。
二、      Rxjava的使用

Rxjava主要分三部分，被观察者（Observable）、观察者（Observer）和链接二者的subscribe()，当被观察者（Observable）和观察者（Observer）被subscribe()链接起来的时候，如果被观察者（Observable）发生变化，被观察者（Observable）就能感知得到，这这篇文章中就是，当retrofit网络访问获取到数据的时候，被观察者（Observable）获取得到实例，观察者（Observer）观察者就能收到此消息，处理被观察中实例中获取的数据。
1.     刚才我们获取了被观察者（Observable），现在我们再来定义一个观察者
  1. public abstract class BaseObserver<T> implements Observer<NewsBeen<T>> {
  2.  
  3. @Override
  4. public void onSubscribe(@NonNull Disposable d) {
  5.  
  6. }
  7.  
  8. @Override
  9. public void onNext(@NonNull NewsBeen<T> tNewsBeen) {
  10. if (tNewsBeen.getError_code()==0) {
  11. T t = tNewsBeen.getResult();
  12. getDatas (t);
  13. }else {
  14. //在此可处理获取失败逻辑
  15. }
  16. }
  17.  
  18. @Override
  19. public void onError(@NonNull Throwable e) {
  20.  
  21. }
  22.  
  23. @Override
  24. public void onComplete() {
  25.  
  26. }
  27.  
  28. protected abstract void getDatas(T t);
  29. }
继承Observer接口，实现其中的方法，创建观察者基类，成功获取数据调用getDatas(T t)方法将数据传出去。

2.这样观察者和被观察者都有了，但要注意一点，网络访问为耗时操作，获取到数据很多要在主线程接收展示，所以要加上线程转换。
  1. public class RxSchedulers {
  2.  
  3. public static <T> ObservableTransformer<T,T> compose(){
  4. return new ObservableTransformer<T, T>() {
  5. @Override
  6. public ObservableSource<T> apply(@NonNull Observable<T> upstream) {
  7. return upstream
  8. .subscribeOn(Schedulers.io())
  9. .doOnSubscribe(new Consumer<Disposable>() {
  10. @Override
  11. public void accept(@NonNull Disposable disposable) throws Exception {
  12. //订阅开始前调用，可以在此做一些网络获取数据环境的判断
  13. }
  14. })
  15. .observeOn(AndroidSchedulers.mainThread());
  16. }
  17. };
  18. }
  19. }
3.最后把观察者和被观察者链接起来。
  1. observable.compose(RxSchedulers.<NewsBeen<ResultBean>>compose()).subscribe(new BaseObserver<ResultBean>(MainActivity.this) {
  2. @Override
  3. protected void getDatas (ResultBean resultBean) {
  4. //最终从自定义的观察者基类的抽象方法中获取到网络数据
  5. }
  6. });

 

经过以上代码就可以搭建一个最基本的Rxjava+Retrofit网络框架，诚然，我的水平相比播客中许多大佬的水平要相差甚远，网上随便一搜就有很多详细到源码，各种重写方法的高阶播客，感觉那些都不太适合初学者，我的学习方法就是找到一篇简单的使用播客，先把效果做出来，然后根据效果再去扩展着学习，希望我的这篇播客能帮助更多像我一样，独自一人向更高艰难前进的人，如果有幸被哪位大佬看见，也希望能获得指点一二。
posted @ 2018-07-04 17:56  天涯海角路  阅读(149)  评论(0)    收藏  举报