RetrofitMocker
解决的问题
-
在开发阶段，后台经常会发布，或者接口还未写好，但是格式已经定好，其实这时候完全可以自己先写一个json文件放在assets文件夹中，然后自己使用，不需要一直等待。后台经常时不时的发布，重启。前端只能一直等待。
-
我自己本身会使用rap来mock数据，但是在发布的时候必须要改回来，也就是需要改动代码。记得某一次，上线，发布。代码中有一处mock数据还是用的rap上的url。这就很操蛋了。这里可以统一配置。
retrofit.createMocker(ServiceApi::class.java,BuildConfig.DEBUG)
最后一个参数可以配置成BuildConfig.DEBUG就再也不会出错了。 -
记得还有一种mock方式是直接在代码里面一个个创建对象，然后塞入不同数据，相对来说会比较麻烦，而且也是存在
2的问题的。
如何使用
- 引入依赖
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'
}
- 定义接口时使用@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还是对象，都可以，这个框架不会对你的原来的使用造成任何影响。
- 使用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种方式获取代理对象
-
使用了kotlin，我在框架中添加了
Retrofit对象的扩展方法，原本使用retrofit.create的地方替换为retrofit.createMocker即可。 -
不使用kotlin，直接调用
MockerHelper.createMocker获取
注意：这里最后使用BuildConfig.DEBUG当作参数传入，作为是否启用mock数据的开关，防止发布时遗忘。
demo
- 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
- 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的动态代理。
总结：使用到了反射，动态代理。
