RetrofitMocker

解决的问题
  1. 在开发阶段,后台经常会发布,或者接口还未写好,但是格式已经定好,其实这时候完全可以自己先写一个json文件放在assets文件夹中,然后自己使用,不需要一直等待。后台经常时不时的发布,重启。前端只能一直等待。

  2. 我自己本身会使用rap来mock数据,但是在发布的时候必须要改回来,也就是需要改动代码。记得某一次,上线,发布。代码中有一处mock数据还是用的rap上的url。这就很操蛋了。这里可以统一配置。
    retrofit.createMocker(ServiceApi::class.java,BuildConfig.DEBUG)
    最后一个参数可以配置成BuildConfig.DEBUG 就再也不会出错了。

  3. 记得还有一种mock方式是直接在代码里面一个个创建对象,然后塞入不同数据,相对来说会比较麻烦,而且也是存在2的问题的。

如何使用
  1. 引入依赖
    Add it in your root build.gradle at the end of repositories:
allprojects {
        repositories {
            ...
            maven { url 'https://www.jitpack.io' }
        }
    }

Step 2. Add the dependency

    dependencies {
            implementation 'com.github.javalong:RetrofitMocker:1.0.0'
    }
  1. 定义接口时使用@MOCK注释
    //不使用MOCK注解
    @GET(" ")
    fun test1():Call<String>

    //使用MOCK注解,mock本地数据,指定assets文件夹中的test_1.json文件为mock数据
    @MOCK("test_1.json")
    @GET(" ")
    fun test2():Call<String>
  
    //使用MOCK注解,mock远程数据,重新指定url地址
    @MOCK("https://api.github.com/users")
    @GET(" ")
    fun test3():Call<String>

    //支持RxJava+Retrofit的方式
    @MOCK("test_1.json")
    @GET(" ")
    fun test4():Observable<String>

这里不管你使用Call,还是使用Observable,返回的是 String还是对象,都可以,这个框架不会对你的原来的使用造成任何影响。

  1. 使用createMocker来获取代理对象
 var retrofit = Retrofit.Builder()
                .baseUrl("https://api.github.com/")
                .addConverterFactory(ScalarsConverterFactory.create())
                .addCallAdapterFactory(RxJava2CallAdapterFactory.create())
                .build()

serviceApi = retrofit.createMocker(ServiceApi::class.java)
//建议这样写,发布就不会忘了开关 serviceApi = retrofit.createMocker(ServiceApi::class.java,BuildConfig.DEBUG)
//如果没有使用 kotlin 可以这么写 serviceApi = MockerHelper.createMocker(retrofit,ServiceApi::class.java,BuildConfig.DEBUG)
  

提供了2种方式获取代理对象

  1. 使用了kotlin,我在框架中添加了Retrofit对象的扩展方法,原本使用retrofit.create的地方替换为retrofit.createMocker即可。

  2. 不使用kotlin,直接调用MockerHelper.createMocker获取

注意:这里最后使用BuildConfig.DEBUG当作参数传入,作为是否启用mock数据的开关,防止发布时遗忘。
demo
  1. mock本地json文件
  //接口定义,需要mock数据的方法上添加MOCK注解,然后指定assets文件夹中的文件名
  @MOCK("test_1.json")
  @GET(" ")
  fun test2():Call<String>

  ....

   //使用的时候和以前的时候方法一致,不需要做任何改变
   val call = serviceApi.test2()
   call.enqueue(object :Callback<String>{
     override fun onResponse(call: Call<String>?, response: Response<String>?) {
          response.let {
            tvHttpContent.text = response!!.body()
            Log.e(TAG,response!!.body())
          }
        }

      override fun onFailure(call: Call<String>?, t: Throwable?) {
      }
  })

点击 MOCKER1按钮,即不添加MOCK注解的情况,调用github api获取数据如图

Screenshot_20180709-100714.jpg

点击MOCKER2按钮,即添加了MOCK注解,并指定为test_1.json,返回如图
Screenshot_20180709-100721.jpg

  1. mock远程url
    其实这种方式也是很常用的,比如我使用了rap来mock数据,就可以直接使用MOCK注解,然后指定远程的url。
  @MOCK("https://api.github.com/users")
  @GET(" ")
  fun test3():Call<String>

我这里是通过是否以http开头来判断是远程的mock还是本地的mock。
点击MOCKER3按钮,调用后,获取数据如图

Screenshot_20180709-101704.jpg

因为他把本身的https://api.github.com 请求地址替换成了https://api.github.com/users

实现的原理

大家都知道Retrofit的主要的一段代码就是

 public <T> T create(final Class<T> service) {
    Utils.validateServiceInterface(service);
    if (validateEagerly) {
      eagerlyValidateMethods(service);
    }
    return (T) Proxy.newProxyInstance(service.getClassLoader(), new Class<?>[] { service },
        new InvocationHandler() {
          private final Platform platform = Platform.get();

          @Override public Object invoke(Object proxy, Method method, Object... args)
              throws Throwable {
            // If the method is a method from Object then defer to normal invocation.
            if (method.getDeclaringClass() == Object.class) {
              return method.invoke(this, args);
            }
            if (platform.isDefaultMethod(method)) {
              return platform.invokeDefaultMethod(method, service, proxy, args);
            }
            ServiceMethod serviceMethod = loadServiceMethod(method);
            OkHttpCall okHttpCall = new OkHttpCall<>(serviceMethod, args);
            return serviceMethod.callAdapter.adapt(okHttpCall);
          }
        });
  }

使用了动态代理模式,当我们调用**Api方法时,其实就是进入了这里,然后它会进行解析。
为了不影响Retrofit之前的使用,我这里也决定采用动态代理的方式。也就是在这一层动态代理的外面再包一层动态代理。

既然使用到了动态代理,那么也会使用到反射。

当调用**Api里面的方法时,首先会进入我的动态代理,反射获取这个方法是否有@MOCK注释,有就自己进行处理,没有就传递给Retrofit的动态代理。

总结:使用到了反射动态代理

github

https://github.com/javalong/RetrofitMocker 有demo

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 204,921评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 87,635评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,393评论 0 338
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,836评论 1 277
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,833评论 5 368
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,685评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,043评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,694评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 42,671评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,670评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,779评论 1 332
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,424评论 4 321
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,027评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,984评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,214评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,108评论 2 351
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,517评论 2 343

推荐阅读更多精彩内容