Android 探讨一下Retrofit封装的最佳姿势
2017-06-27 08:39
281 查看
在上一篇文章《Android Retrofit + RxJava使用详解》中,我们学习了Retrofit的一些基本用法,但在实际的项目使用中,还是会出现一些问题,今天就让我们一起来探讨一下如何对Retrofit进行封装吧!
如果你对Retrofit还不太了解,可以>戳这里<学习一下。
如果你使用的是MVP,这篇文章可能不太适合你,请移步《Android 谈谈我所理解的MVP》。
首先定义请求参数接口,返回泛型为PostInfo的Call对象,接着初始化Retrofit,创建RetrofitService对象,调用RetrofitService中的getPostInfo方法返回Call对象,最后调用call.enqueue进行网络请求,这样一个简单的Retrofit网络请求就完成了。
But,如果网络接口很多的话,那我们岂不是要写很多重复的逻辑代码,比如:
这显然不是我的风格,我希望的结构是这样的:
定义两个管理类SendMessageManager和ReceiveMessageManager,分别负责消息的发送和接收,而具体的发送和接收逻辑交由HttpChannel处理,当然也可以定义其他的消息通道进行管理(比如TCP),UI层不关心具体的消息执行逻辑,只负责发送消息和处理接收到的消息。
这样做可以使代码的逻辑更加清晰,比如我需要修改一个接口,直接打开SendMessageManager搜索就能马上找到要修改的接口信息,也可以避免重复代码的编写,提升工作效率,接下来看下具体的实现逻辑。
RetrofitService的结构保持不变,PostInfo继承于Bean基类BaseBean:
HttpChannel
看下Http核心处理类:
使用了单例模式,在构造方法中初始化Retrofit和RetrofitService,提供getRetrofitService方法来获取RetrofitService对象,定义sendMessage方法,接收observable和urlOrigin参数,其中observable为被观察者对象,泛型为BaseBean或BaseBean的子类,urlOrigin为接口地址(同@GET(“query”)中的query),在onNext方法中调用ReceiveMessageManager的dispatchMessage方法进行消息的分发。
SendMessageManager
也是使用了单例模式,在构造方法中初始化HttpChannel,获取RetrofitService对象,定义getPostInfo方法,在getPostInfo中获取被观察者对象,调用HttpChannel的sendMessage方法进行消息发送。
ReceiveMessageManager
啊,还是单例模式,定义dispatchMessage方法,判断接口请求地址进行消息分发,这里使用了EventBus通知Activity的方式,也可以替换成其他的事件订阅框架。
MainActivity
终于到了UI层:
调用SendMessageManager的getPostInfo方法请求接口,在onMessageEvent方法中接收请求结果并进行处理,清晰明了。
GitHub传送门
点击下载源码
欢迎同学们吐槽评论,如果你觉得本篇博客对你有用,那么就留个言或者顶一下吧(^-^)
如果你对Retrofit还不太了解,可以>戳这里<学习一下。
如果你使用的是MVP,这篇文章可能不太适合你,请移步《Android 谈谈我所理解的MVP》。
1.背景介绍
首先来回顾一下Retrofit的基本使用流程,直接上代码:/** * 定义请求参数接口 */ public interface RetrofitService { /** * 获取快递信息 * * @param type 快递类型 * @param postid 快递单号 * @return Call<PostInfo> */ @GET("query") Call<PostInfo> getPostInfo(@Query("type") String type, @Query("postid") String postid); } // 网络请求 Retrofit retrofit = new Retrofit.Builder() .baseUrl("http://www.kuaidi100.com/") .addConverterFactory(GsonConverterFactory.create()) .build(); RetrofitService service = retrofit.create(RetrofitService.class); Call<PostInfo> call = service.getPostInfo("yuantong", "11111111111"); call.enqueue(new Callback<PostInfo>() { @Override public void onResponse(Call<PostInfo> call, Response<PostInfo> response) { Log.i("http返回:", response.body().toString() + ""); } @Override public void onFailure(Call<PostInfo> call, Throwable t) { } });
首先定义请求参数接口,返回泛型为PostInfo的Call对象,接着初始化Retrofit,创建RetrofitService对象,调用RetrofitService中的getPostInfo方法返回Call对象,最后调用call.enqueue进行网络请求,这样一个简单的Retrofit网络请求就完成了。
But,如果网络接口很多的话,那我们岂不是要写很多重复的逻辑代码,比如:
Call<PostInfo> call = service.getPostInfo("yuantong", "11111111111"); call.enqueue(new Callback<PostInfo>() { @Override public void onResponse(Call<PostInfo> call, Response<PostInfo> response) { Log.i("http返回:", response.body().toString() + ""); } @Override public void onFailure(Call<PostInfo> call, Throwable t) { } });
这显然不是我的风格,我希望的结构是这样的:
定义两个管理类SendMessageManager和ReceiveMessageManager,分别负责消息的发送和接收,而具体的发送和接收逻辑交由HttpChannel处理,当然也可以定义其他的消息通道进行管理(比如TCP),UI层不关心具体的消息执行逻辑,只负责发送消息和处理接收到的消息。
这样做可以使代码的逻辑更加清晰,比如我需要修改一个接口,直接打开SendMessageManager搜索就能马上找到要修改的接口信息,也可以避免重复代码的编写,提升工作效率,接下来看下具体的实现逻辑。
2.实现逻辑
RetrofitServiceRetrofitService的结构保持不变,PostInfo继承于Bean基类BaseBean:
public interface RetrofitService { /** * 获取快递信息 * Rx方式 * * @param type 快递类型 * @param postid 快递单号 * @return Observable<PostInfo> */ @GET("query") Observable<PostInfo> getPostInfoRx(@Query("type") String type, @Query("postid") String postid); }
HttpChannel
看下Http核心处理类:
public class HttpChannel { private static HttpChannel httpChannel; private RetrofitService retrofitService; public static HttpChannel getInstance() { return httpChannel == null ? httpChannel = new HttpChannel() : httpChannel; } private HttpChannel() { // 初始化Retrofit Retrofit retrofit = new Retrofit.Builder() .baseUrl("http://www.kuaidi100.com/") .addConverterFactory(GsonConverterFactory.create()) // json解析 .addCallAdapterFactory(RxJavaCallAdapterFactory.create()) // 支持RxJava .client(RetrofitUtils.getOkHttpClient()) // 打印请求参数 .build(); retrofitService = retrofit.create(RetrofitService.class); } /** * 发送消息 * * @param observable Observable<? extends BaseBean> * @param urlOrigin 请求地址 */ public void sendMessage(Observable<? extends BaseBean> observable, final String urlOrigin) { observable.subscribeOn(Schedulers.io()) .observeOn(AndroidSchedulers.mainThread()) .subscribe(new Observer<BaseBean>() { @Override public void onCompleted() { } @Override public void onError(Throwable e) { } @Override public void onNext(BaseBean baseBean) { Log.i("http返回:", baseBean.toString() + ""); ReceiveMessageManager.getInstance().dispatchMessage(baseBean, urlOrigin); } }); } public RetrofitService getRetrofitService() { return retrofitService; } }
使用了单例模式,在构造方法中初始化Retrofit和RetrofitService,提供getRetrofitService方法来获取RetrofitService对象,定义sendMessage方法,接收observable和urlOrigin参数,其中observable为被观察者对象,泛型为BaseBean或BaseBean的子类,urlOrigin为接口地址(同@GET(“query”)中的query),在onNext方法中调用ReceiveMessageManager的dispatchMessage方法进行消息的分发。
SendMessageManager
public class SendMessageManager { private static SendMessageManager manager; private HttpChannel httpChannel; private RetrofitService retrofitService; public static SendMessageManager getInstance() { return manager == null ? manager = new SendMessageManager() : manager; } private SendMessageManager() { httpChannel = HttpChannel.getInstance(); retrofitService = httpChannel.getRetrofitService(); } /** * 获取快递信息 * * @param type 快递类型 * @param postid 快递单号 */ public void getPostInfo(String type, String postid) { Observable<PostInfo> observable = retrofitService.getPostInfoRx(type, postid); httpChannel.sendMessage(observable, Constant.UrlOrigin.get_post_info); } }
也是使用了单例模式,在构造方法中初始化HttpChannel,获取RetrofitService对象,定义getPostInfo方法,在getPostInfo中获取被观察者对象,调用HttpChannel的sendMessage方法进行消息发送。
ReceiveMessageManager
public class ReceiveMessageManager { private static ReceiveMessageManager manager; public static ReceiveMessageManager getInstance() { return manager == null ? manager = new ReceiveMessageManager() : manager; } private ReceiveMessageManager() { } /** * 分发消息 * * @param baseBean Bean基类 * @param url 请求地址 */ public void dispatchMessage(BaseBean baseBean, String url) { switch (url) { case Constant.UrlOrigin.get_post_info: PostInfo postInfo = (PostInfo) baseBean; EventBus.getDefault().post(postInfo); break; default: break; } } }
啊,还是单例模式,定义dispatchMessage方法,判断接口请求地址进行消息分发,这里使用了EventBus通知Activity的方式,也可以替换成其他的事件订阅框架。
MainActivity
终于到了UI层:
public class MainActivity extends AppCompatActivity { private SendMessageManager sendMessageManager; @Override protected void onCreate(Bundle savedInstanceState) { super.onCreate(savedInstanceState); setContentView(R.layout.activity_main); ButterKnife.bind(this); sendMessageManager = SendMessageManager.getInstance(); } @Override public void onStart() { super.onStart(); EventBus.getDefault().register(this); } @OnClick({R.id.btn_encap_request}) public void onViewClicked(View view) { switch (view.getId()) { case R.id.btn_encap_request: // 封装使用 encapRequest(); break; default: break; } } /** * 封装使用 */ private void encapRequest() { sendMessageManager.getPostInfo("yuantong", "11111111111"); } @Subscribe(threadMode = ThreadMode.MAIN) public void onMessageEvent(PostInfo postInfo) { Log.i("接收消息:", postInfo.toString()); Toast.makeText(MainActivity.this, postInfo.toString(), Toast.LENGTH_SHORT).show(); } @Override public void onStop() { super.onStop(); EventBus.getDefault().unregister(this); } }
调用SendMessageManager的getPostInfo方法请求接口,在onMessageEvent方法中接收请求结果并进行处理,清晰明了。
3.写在最后
源码已托管到GitHub上,欢迎Fork,觉得还不错就Start一下吧!GitHub传送门
点击下载源码
欢迎同学们吐槽评论,如果你觉得本篇博客对你有用,那么就留个言或者顶一下吧(^-^)
相关文章推荐
- Retrofit – Java(Android) 的REST 接口封装类库
- 【开源项目12】Retrofit – Java(Android) 的REST 接口封装类库
- Retrofit – Java(Android) 的REST 接口封装类库
- RxAndroid结合Retrofit,看看谁才是最佳拍档!
- RxAndroid结合Retrofit,看看谁才是最佳拍档!
- 探讨一下Android平台的视频类应用开发的技术研究点
- Android网络开源库-Retrofit(五)简易封装
- Android基于Retrofit2.0 +RxJava 封装的超好用的RetrofitClient工具类(六)
- android的技术分解以及Retrofit源码分析以及MVP框架封装使用
- Retrofit – Java(Android) 的REST 接口封装类库
- android httpclient封装,可以参考一下
- Android网络开发框架Retrofit(三:进阶篇,接口实体类封装)
- 【开源项目12】Retrofit – Java(Android) 的REST 接口封装类库
- Android基于Retrofit2.0 +RxJava 封装的超好用的RetrofitClient工具类(六)
- Android 网络框架 Retrofit2.0介绍、使用和封装
- Retrofit – Java(Android) 的REST 接口封装类库
- Retrofit – Java(Android) 的REST 接口封装类库
- Retrofit2.0结合RxAndroid实现二次封装
- Android基于Retrofit2.0 封装的超好用的RetrofitClient工具类(完美结合RxJava)
- 【Android】Retrofit的使用(3)-对Retrofit进行简单的封装