基于Retrofit+RxJava的Android分层网络请求框架

目前已经有不少Android客户端在使用Retrofit+RxJava实现网络请求了,相比于xUtils,Volley等网络访问框架,其具有网络访问效率高(基于OkHttp)、内存占用少、代码量小以及数据传输安全性高等特点。

Retrofit源码更是经典的设计模式教程,笔者已在之前的文章中分享过自己的一些体会,有兴趣的话可点击以下链接了解:《Retrofit源码设计模式解析(上)》、《Retrofit源码设计模式解析(下)

但在具体业务场景下,比如涉及到多种网络请求(GET/PUT/POST/DELETE等),多种请求方式(异步/同步)时,按照Retrofit官方文档实现网络请求仍然会显得比较繁琐,本文主要介绍笔者基于Retrofit+RxJava封装的Android分层网络请求框架,适用于下图所示的业务场景:Android移动端通过移动网关调用接口平台发布的业务服务

上述业务架构可能是目前移动应用中使用的比较广的,其具有以下优点:

  • 由于移动网关系统和统一服务发布平台的存在,移动端不需要直接调用业务系统的服务,避免了移动端同时对接多个业务系统,降低移动端系统的复杂性;
  • 移动网关会对移动端的请求进行鉴权,屏蔽外部恶意访问,有效提高内部业务系统的安全性;
  • 统一服务发布平台集成所有的业务接口,对外提供格式统一的接口服务,这对于内部系统的可维护性和可扩展性是至关重要的。
  • 业务系统只需要按照格式将其服务在接口平台上发布即可,无需关心具体的调用者。

因此,本文分享的分层网络请求框架的前提是:Android移动端直接对接移动网关。主要有以下内容:

  1. 网关请求封装。移动网关的请求格式(参数、字段、通信方式等)应该是固定的,并且对业务是透明的,不触碰具体业务数据。负责直接对接客户端的请求,包括请求的鉴权,客户端与后台的数据格式的转换等。
  2. 基础业务请求。基础业务请求涉及到正式/测试环境的切换,网关返回业务数据的统一解析,以及添加业务相关的网关默认字段等;
  3. 业务Module统一网络请求管理。业务Module负责统一管理一个业务模块中所有的网络请求,接收鉴别请求对应的字段,包含服务名、服务分组名、请求方法以及请求参数等;
  4. Model层网络请求。Model层的网络请求是按服务划分的,一个应用Module通常会对应多个服务,并且接收Activity的参数,组装请求bean;
  5. Activity层的网络访问。Activity直接调用Model层的方法,传入界面相关的参数,回调响应结果。
  6. 文件上下传及其它网络访问。通过Retrofit+RxJava还可以实现文件上下传以及软件更新等其它网络访问,本文也会一并简要介绍。

一、网关请求封装

通过Retrofit注解定义移动网关接口,比如请求方式,参数格式,字段等。以POST请求为例,参数格式为表单数据,字段包含服务名、服务分组名、方法名、参数、请求头Map以及其他参数等。

@FormUrlEncoded
@POST("./")
Observable<WGResponseBean> postRequest (
        @FieldMap("param") String param,
        @HeaderMap Map<String, String> headMap);

Retrofit的FieldMap不支持字段值为null,如参数中有null值,需要使用Field。

如上所述,@POST表示该请求是一个POST方法,常用的POST提交数据的方式有:

  • application/x-www-form-urlencoded
  • multipart/form-data
  • application/json
  • text/xml

application/x-www-form-urlencoded对应表单数据,在Retrofit中,通过@FormUrlEncoded标注的参数将以表单形式进行提交。multipart/form-data一般用于文件上传的时候,这个在后面会提到。application/json通过JSON方式与服务端进行数据交换,text/xml使用XML数据格式。

定义了网关请求之后,需要创建对应的Service,而Service的使用方式并不确定,这里通过一个抽象类对其进行封装。

public abstract class WgReqService<T> {

    // 网关网络请求
    protected WGApi wgApi;

    // 省略代码
    public WgReqService(String baseUrl) {
        wgApi = new NetWork.Builder(baseUrl).build().getApi(WGApi.class);
    }

    public abstract T wgReq(WGRequestBean wgRequest, Map<String, String> headMap);
}

以同步/异步网络请求为例,分别继承自WgReqService,实现对应的wgReq方法即可。

public class WgReqAsync<T> extends WgReqService<Observable<T>> {
    // 省略代码
    @Override
    public Observable<T> wgReq(WGRequestBean wgRequest, Map<String, String> headMap) {
        // 省略代码
    }
}
public class WgReqSync extends WgReqService<WGResponseBean> {
    // 省略代码
    @Override
    public WGResponseBean wgReq(WGRequestBean wgRequest, Map<String, String> headMap) {
        // 省略代码
    }
}

由于采用了RxJava,因此在异步实现中,泛型参数为Observable<T>,而同步请求时直接返回网关的出参Bean。另外,需要说明的是WgReqAsync包含域Func1<WGResponseBean, T>,Func1为RxJava支持的接口,这里表示将网关返回的业务数据进行统一解析的方法。

二、基础业务请求

通过上述的分析可知,业务请求可以有同步/异步等多种实现方式,同时涉及到正式/测试环境的切换,网关返回业务数据的统一解析,以及添加业务相关的网关默认字段等,这里以异步请求为例:

public class BaseWgRequest implements Func1<WGResponseBean, BusinessBean> {

    // 网关请求Helper类
    private WgReqAsync<BusinessBean> wgReqAsync;

    // 服务名
    protected String service;
    // 服务组名
    protected String alias;
    // 解析类
    protected Class<? extends BusinessBean> rClazz;

    // 省略代码
}

BaseWgRequest持有WgReqAsync<BusinessBean>引用,并通过其完成网关访问,service、alias等域指定相应的服务,Class<? extends BusinessBean>表示对业务返回值进行解析的类。

return JSON.parseObject(wgResponse.getData(), rClazz != null ? rClazz : BusinessBean.class);

异步请求中,通过上述域及业务相关的网关默认字段封装请求体,同时获取请求head。

// 请求
return wgReqAsync.wgReq(ParamUtil.getWGRequestBean(service, alias, method, param),
            BaseConstants.getHeaderMap());

三、业务Module

首先申明,对整个项目进行多工程划分(业务工程和库工程独立,便于库工程独立维护),同时业务工程中分为多个功能Module(便于功能模块插件化、热加载),这种方式在比较大型的项目中应用效果可能比较好,在小型项目中并不推荐。这里的业务Module是以功能模块进行划分的,对一个功能模块中的所有网络请求进行统一管理,能有效的单元测试,提高整体开发效率。

如上所述,业务Module的主要职责是接收鉴别请求对应的字段,包含服务名、服务分组名、请求方法以及请求参数等,并继承自上述 BaseWgRequest实现。

public class WelNetwork extends BaseWgRequest {}

业务Module包含了一个功能模块中的所有网络请求方法,以登录为例:

public Observable<BusinessBean> userLoginWork(SysUsersReqDto sysUsersReqDto) {
    return wgRequest(service, alias, BusinessConstants.userLoginWork, ParamUtil.getJsonParam(sysUsersReqDto));
}

这里重点说明下登录方法的入参,BaseWgRequest关注的是与网关接口相关的参数,由于业务Module继承自BaseWgRequest,这一层的方法不再关注网关相关内容,重点是业务相关的请求入参。换句话说,业务Module的入参直接对应业务接口的入参,具有访问形式的无关性。考虑清楚每一个层次的关注重点,是搭建软件架构的基础。

四、Model层网络请求

在本系统中,按照服务名对Model进行了划分,需要申明的是,由于每个公司的具体情况不一样,这种划分方式不一定适用于你的系统。不过这种分层方式仍有借鉴之处。

由于Model中方法的访问可能不止一处,因此对外(Activity)提供单实例对象。这里提供一种最简单饿汉模式的单实例:

private static LoginModel loginModel = new LoginModel();

public static LoginModel getInstance() {
    return loginModel;
}

同时,在其构造器中初始化业务Module访问类。

private LoginModel() {
        super();
        welNetwork = new WelNetwork.Builder().service(BusinessConstants.SysLogin).alias(BaseConstants.getALIAS())
                .rClazz(SysUsersResDto.class).build();
}

上面提到,业务Module关注的是业务接口的入参,那么这个入参就是有Model提供的。一个功能模块可能对应多个服务,那么这些服务需要持有业务Module的引用,并通过业务Module的方法实现自身的方法。还是以登录为例:

public Observable<BusinessBean> userLoginWork(String username, String password) {
        return welNetwork.userLoginWork(new SysUsersReqDto.Builder(username).userPwd(password)
                .devType("1").devIp(DeviceUtils.getClientIpAddress()).build());
}

Model负责连接Activity和业务Module,对上直接对接Activity,Activity关注的是用户输入的用户名和密码,并不知道业务接口需要的数据格式,而业务Module关注的是业务接口的入参格式。因此,Model层对这两种数据进行适配,常见的就是对请求bean的组装,比如上述登录方法接收用户名和密码,组装成业务Module所需的SysUsersReqDto。

五、Activity层的网络访问

通过上述分层封装,在Activity中的网络访问就非常简单了。直接上示例代码:

LoginModel.getInstance().userLoginWork(usernameStr, passwordStr)
    .subscribe(new RxObserver<BusinessBean>(this) {
    @Override
    public void onSuccess(BusinessBean businessBean) {
          handleLoginResult(businessBean);
    }
});

需要说明的是RxObserver,RxObserver<T>继承自Subscriber<T>,Subscriber是RxJava的回调类,RxObserver包含抽象方法onSuccess,并在onNext实现中进行调用。

public abstract class RxObserver<T> extends Subscriber<T> {
    // 省略代码
    @Override
    public void onNext(T t) {
        onSuccess(t);
    }

    public abstract void onSuccess(T t);
}

从Activity的角度来讲,其负责用户交互,因此只关注用户输入和接口返回具体数据,并对数据进行处理。而至于网关的实现,业务接口的入参格式,网络请求的方式等底层实现,则对Activity完全闭合。

上述简要介绍了题目所讲到的基于Retrofit+RxJava的Android分层网络请求框架,由于涉及具体业务,只能开放部分代码样例。至于对架构的观点,可参考《什么是架构?》

  1. 根据要解决的问题,对目标系统的边界进行界定。
  2. 并对目标系统按某个原则的进行切分。切分的原则,要便于不同的角色,对切分出来的部分,并行或串行开展工作,一般并行才能减少时间。
  3. 并对这些切分出来的部分,设立沟通机制。
  4. 根据3,使得这些部分之间能够进行有机的联系,合并组装成为一个整体,完成目标系统的所有工作。

界定-切分-沟通-系统,是架构设计的基本步骤。

本系统界定为基于Retrofit+RxJava实现Android分层网络请求,然后将整个系统进行切分五个层次,每个层次的关注点相异,但又相互联系,这五个层次通过抽象(抽象类或接口)、继承、复合等方法进行沟通,形成一个统一系统,完成Android中的网络请求。

六、文件上下传及其它网络访问

除上述网关请求外,Android中还经常涉及文件上下传、软件更新等与网络相关的操作,这里也对其进行简要的介绍。

如上所述,文件上传需要采用multipart/form-data数据提交方式,因此在Retrofit中定义方法时,需要采用@Multipart注解。

@Multipart
@POST("./")
Observable<UploadFileResponseBean> uploadFile(@Part MultipartBody.Part file,
                                                   @PartMap Map<String, RequestBody> params,
                                                   @HeaderMap Map<String, String> headMap);

同时,其入参类型为@Part,或@PartMap。需要注意的是,传入该方法的参数为MultipartBody.Part。

// 根据文件路径生成文件
File file = new File(requestBean.getFilePath());
// 根据文件创建请求体
RequestBody requestFile = RequestBody.create(MediaType.parse("multipart/form-data"), file);
// 创建实际请求用的MultipartBody
MultipartBody.Part body = MultipartBody.Part.createFormData("file", file.getName(), requestFile);

其他封装形式与上述网关请求类似,这里不再赘述。

对于文件的下载,笔者尝试了《Retrofit 2 — How to Download Files from Server》的方法,但由于其涉及下载进度的监听以及下载完成的操作等,对后续系统的封装并不好,这里就不详细介绍了。

针对文件下载这种场景,如果自定义实现,需要处理OOM、多线程等问题。DownloadManager是Android2.3以后引入的系统自带类库,通过getSystemService(Context.DOWNLOAD_SERVICE)就能获取并使用,系统服务已经完成网络访问控制、文件读写控制、通知栏进度显示、大文件续传等一系列文件下载可能遇到的问题。因此,推荐系统自带实现,这个列出简要参考代码,详细情况请参考《DownloadManager官方文档》

DownloadManager downloadManager = (DownloadManager) getSystemService(Context.DOWNLOAD_SERVICE);
DownloadManager.Request request = new DownloadManager.Request(Uri.parse(apkUrl));
// 设置目标文件路径
request.setDestinationInExternalPublicDir(dir, fileName);
// 仅在WIFI网络下载
request.setAllowedNetworkTypes(DownloadManager.Request.NETWORK_WIFI);
// 设置标题及描述
request.setTitle(getString(R.string.app_name));
// 发送请求
downloadManager.enqueue(request);

最后,举个GET请求的栗子,查询软件是否有更新一般会采用GET请求,比如请求参数包括系统、包名、版本号等入参的请求格式为:

@GET("./")
Observable<ApkUpdateResponseBean> apkUpdate(
        @Query("os") String os,
        @Query("packageName") String packageName,
        @Query("version") String version);

@Query表示请求字段。

时间: 2024-10-01 22:09:47

基于Retrofit+RxJava的Android分层网络请求框架的相关文章

Github 上Top1的Android 异步网络请求框架

今天给大家分享一个github上Top1的Android异步网络请求框架的使用方法,我给大家分享一个它的基本用法. 先来一个简单的get请求 AsyncHttpClient client = new AsyncHttpClient(); client.get("http://www.google.com", new AsyncHttpResponseHandler() { @Override public void onStart() { // called before reques

Retrofit2.0+RxJava+RxAndroid——强强联合的网络请求框架

最近看了很多关于Retrofit和Rxjava的文档介绍.终于在弄清Rxjava后顺利的弄懂了Retrofit. 网上有很多人都介绍了它们的联合使用,但是我看过之后理解不是太好.可能我太笨. 不过,今天写这篇博客的目的就是想来说说它们之间如何使用以及使用的时候遇到的坑. 这两者的关系并不大,但是联合在一起使用是非常简便的.Rxjava的响应式编程加上Retrofit的注解式请求用起来是非常爽的. 并且Retrofit内置的是Okhttp,所以这更加的让Retrofit变得强大. 如果在看这篇博客

带你一步步剖析Retrofit 源码解析:一款基于 OkHttp 实现的网络请求框架

OkHttp与Retrofit 的区别与联系是怎样的? 参考答案:OkHttp和Retrofit都是目前流行网络开源框架 封装不同:Retrofit封装了具体的请求,线程切换以及数据转换.retrofit通过使用代理,外观,策略模式对okhttp进行了封装OkHttp 是基于Http协议封装的一套请求客户端 职责不同:Retrofit主要负责应用层面的封装,面向开发者,方便使用,比如请求参数,响应数据的处理,错误处理等等.OkHttp主要负责socket部分的优化与封装,比如网络访问,多路复用,

Android网络请求框架AsyncHttpClient实例详解(配合JSON解析调用接口)

最近做项目要求使用到网络,想来想去选择了AsyncHttpClient框架开进行APP开发.在这里把我工作期间遇到的问题以及对AsyncHttpClient的使用经验做出相应总结,希望能对您的学习有所帮助. 首先按照惯例先来简单了解一些AsyncHttpClient网络框架的一些知识. 1.简介 Android中网络请求一般使用Apache HTTP Client或者采用HttpURLConnect,但是直接使用这两个类库需要写大量的代码才能完成网络post和get请求,而使用android-a

Android之封装好的异步网络请求框架

1.简介 Android中网络请求一般使用Apache HTTP Client或者采用HttpURLConnection,但是直接使用这两个类库需要写大量的代码才能完成网络post和get请求,而使用这个MyHttpUtils库可以大大的简化操作,它是基于HttpURLConnection,所有的请求都是独立在UI主线程之外,没有通过CommCallback回调方法处理请求结果, 没有了子线程.没有了handle,链式的变成使得代码更加清晰 . 2.特性 支持get.post请求,文件下载,上传

基于AFNetWorking搭建APP的网络请求框架[iOS]

自从AFNetWorking(下文简称AFN)更新2.0版本之后,AFN的许多的问题得到的有效的解决,写法也得到了完善.前期主流的第三方网络类库 ASI作者宣布不再维护,国内大多数的主流APP都逐步接受并开始采用AFN.出于各自公司项目的不同需要,大家都会在AFN的基础上加一层不尽相同的封 装.很多新APP在选择方式时也会非常纠结.如何封装才可以让AFN更有效率更方便的应用于项目呢,对于这个问题,各人有各人的看法.基于做过以及读过的 几个项目,也来谈一下如何搭建一个APP的网络请求框架.由于本人

android 设置网络请求超时

UI界面更新必须在ui线程中 不能在ruanable线程中操作ui 可以发送消息利用handler来更新ui    private void load() {        LoadDate load = new LoadDate();        load.execute("http://h.hiphotos.baidu.com/image/w%3D310/sign=1bc9c0da38292df597c3aa148c305ce2/c83d70cf3bc79f3d77fbe1c5b8a1cd

【Java&amp;Android开源库代码剖析】のandroid-async-http(如何设计一个优雅的Android网络请求框架,同时支持同步和异步请求)开篇

在<[Java&Android开源库代码剖析]のandroid-smart-image-view>一文中我们提到了android-async-http这个开源库,本文正式开篇来详细介绍这个库的实现,同时结合源码探讨如何设计一个优雅的Android网络请求框架.做过一段时间Android开发的同学应该对这个库不陌生,因为它对Apache的HttpClient API的封装使得开发者可以简洁优雅的实现网络请求和响应,并且同时支持同步和异步请求. 网络请求框架一般至少需要具备如下几个组件:1

网络请求框架---Volley

去年的Google I/O大会为android开发者带来了一个网络请求框架,它的名字叫做Volley.Volley诞生的使命就是让Android的网络请求更快,更健壮,而且它的网络通信的实现是基于HttpURLConnection的.前几天我整理了两个网络请求工具类,应付日常工作的开发需求还是没问题的,自己分别在HttpURLConnection和HttpClient的基础上进行进一层的封装,保证了API的足够简洁友好.有兴趣的同学可以回头去翻翻,源码在Github上,搜索AndroidHttp