本篇文章只做Retrofit导读,不做细节分析,先来一张Retrofit请求流程图:
总结下来就这几点:
1,Retrofit的创建
2,creat创建接口对象
3,调用接口方法生成Call或Observable对象
4,Call调用enqueue或excute方法进行异步或同步请求(Observable的请求是在数据发射源里进行的)
5,对返回结果进行处理
完整的调用流程
public interface MovieService {
@GET("top250")
Call<MovieEntity> getTopMovie(@Query("start") int start, @Query("count") int count);
@POST("/form")
@FormUrlEncoded
Call<ResponseBody> submit(@Field("username") String name, @Field("token") String token);
}
Retrofit retrofit = new Retrofit.Builder()
.baseUrl(baseUrl)
.addConverterFactory(GsonConverterFactory.create())
.build();
MovieService movieService = retrofit.create(MovieService.class);
Call<MovieEntity> call = movieService.getTopMovie(0, 10);
call.enqueue(new Callback<MovieEntity>() {
@Override
public void onResponse(Call<MovieEntity> call, Response<MovieEntity> response) {
resultTV.setText(response.body().toString());
}
@Override
public void onFailure(Call<MovieEntity> call, Throwable t) {
resultTV.setText(t.getMessage());
}
});
}
1,Retrofit的创建
先上菜,在看怎么吃
Retrofit retrofit = new Retrofit.Builder()
.baseUrl(baseUrl)
.addConverterFactory(GsonConverterFactory.create())
.build();
Retrofit.Builder构造方法
看源码
1.Platform.get() 会拿到一个适合Android平台的对象
2.converterFactories.add(new BuiltInConverters()),converterFactories默认会添加一个BuiltInConverters对象,BuiltInConverters是在添加GsonConverterFactory之前具体可以在后面看BuiltInConverters对数据处理的一些优化
Retrofit.Builder参数设置
参数的设置包含以下属性:
1.okhttp3.Call.Factory 生产网络请求器,用于创建OkHttp3.call对象的工厂类,默认实现类OkHttpClient
2.baseUrl 设置基本baseUrl,通过HttpUrl的parse方法生成符合OkHttp要求的HttpUrl对象(包含一些规则判断,杂物质过滤等)
3.List<Converter.Factory> converterFactories 数据转换工厂类集合,对回调结果进行格式转换
4.List<CallAdapter.Factory> adapterFactories 网络请求适配器工厂的集合
5.Executor callbackExecutor 结果回调器
6.validateEagerly 提前配置接口方法的标志位
Retrofit.Builder的build方法
Retrofit.Builder的build方法创建的Retrofit对象
build方法过程:
1.如果没有设置okhttp3.Call.Factory,默认创建OkHttpClient,OkHttpClient实现了okhttp3.Call.Factory接口
2.默认通过Platform.get()创建的platform对象的platform.defaultCallbackExecutor()方法创建默认的结果回调器
在Android(继承自Platform)的defaultCallbackExecutor()方法里返回的是MainThreadExecutor回调到主线程
3.通过类似copy的手段把设置的List<CallAdapter.Factory>集成赋值到另一个,以免后续改动影响。也会调用platform的defaultCallAdapterFactory添加一个默认ExecutorCallAdapterFactory(CallAdapter.Factory的实现类)对象
4.数据转换集成的copy
5.创建Retrofit实例
在附上一张Android平台的类源码图:
2.Retroti的create创建接口对象:
MovieService movieService = retrofit.create(MovieService.class) creat方法是利用动态代理创建接口对象
validateEagerly的作用就是在第一次创建接口对象时配置所有方法的ServiceMethod,通过Map缓存起来
3,调用接口方法生成Call或Observable对象
Call<MovieEntity> call = movieService.getTopMovie(0, 10);
调用getTopMovie方法之后会回调到如上图所示的InvocationHandler对象中的invoke方法,除了通过loadServiceMethod方法生成ServiceMethod对象,还会创建一个OkHttpCall对象,loadServiceMethod
ServiceMethod会调用通过Builder的构造方法传入Retrofit对象和方法method对象,在通过build方法提取所有Retrofit和Method(这里指接口中getTopMovie方法)中的属性,这其中包括对方法上和方法参数中注解的解析
附图两张
public ServiceMethod build() {
//创建一个CallAdapter对象最后会调用他的adapt方法创建Call或ObserVable
callAdapter = createCallAdapter();
responseType = callAdapter.responseType();
if (responseType == Response.class || responseType == okhttp3.Response.class) {
throw methodError("'"
+ Utils.getRawType(responseType).getName()
+ "' is not a valid response body type. Did you mean ResponseBody?");
}
responseConverter = createResponseConverter();
//解析所有的方法注解并赋值
for (Annotation annotation : methodAnnotations) {
parseMethodAnnotation(annotation);
}
//请求方法不能为空,比如GET,POST必须有一个
if (httpMethod == null) {
throw methodError("HTTP method annotation is required (e.g., @GET, @POST, etc.).");
}
//如果注解是@GET则@Multipart和@FormEncoded都不能存在
if (!hasBody) {
if (isMultipart) {
throw methodError(
"Multipart can only be specified on HTTP methods with request body (e.g., @POST).");
}
if (isFormEncoded) {
throw methodError("FormUrlEncoded can only be specified on HTTP methods with "
+ "request body (e.g., @POST).");
}
}
//下面是对参数注解的解析
int parameterCount = parameterAnnotationsArray.length;
parameterHandlers = new ParameterHandler<?>[parameterCount];
for (int p = 0; p < parameterCount; p++) {
Type parameterType = parameterTypes[p];
if (Utils.hasUnresolvableType(parameterType)) {
throw parameterError(p, "Parameter type must not include a type variable or wildcard: %s",
parameterType);
}
Annotation[] parameterAnnotations = parameterAnnotationsArray[p];
if (parameterAnnotations == null) {
throw parameterError(p, "No Retrofit annotation found.");
}
parameterHandlers[p] = parseParameter(p, parameterType, parameterAnnotations);
}
//没有设置url(在方法注解和参数注解都没有设置url)
if (relativeUrl == null && !gotUrl) {
throw methodError("Missing either @%s URL or @Url parameter.", httpMethod);
}
//@Body注解的必须同时存在@Multipart或@FormEncoded或POST放等其中一种
if (!isFormEncoded && !isMultipart && !hasBody && gotBody) {
throw methodError("Non-body HTTP method cannot contain @Body.");
}
//@FormEncoded注解至少要一个参数注解是@Field
if (isFormEncoded && !gotField) {
throw methodError("Form-encoded method must contain at least one @Field.");
}
//@Multipart注解至少要一个参数注解是@Part
if (isMultipart && !gotPart) {
throw methodError("Multipart method must contain at least one @Part.");
}
return new ServiceMethod<>(this);
}
serviceMethod.callAdapter.adapt(okHttpCall)中的 serviceMethod.callAdapter是在build方法中创建的,如果是默认的ExecutorCallAdapterFactory的get方法创建的callAdapter(ExecutorCallAdapterFactory 中的ExecutorCallbackCall)则调用adapt方法是会返回Call对象,如果是设置了RxJavaCallAdapterFactory则通过get方法创建的callAdapter对象调用adapt方法会返回Observable对象
4,发送网络请求
call.enqueue(new Callback<MovieEntity>() {
@Override
public void onResponse(Call<MovieEntity> call, Response<MovieEntity> response) {
resultTV.setText(response.body().toString());
}
@Override
public void onFailure(Call<MovieEntity> call, Throwable t) {
resultTV.setText(t.getMessage());
}
});
通过serviceMethod.callAdapter.adapt(okHttpCall)创建的Call对象调用enqueue或excute方法进行异步或同步请求,Call实则是OkHttpCall的代理类,调用的其实的OkHttpCall的enqueue或excute方法,OkHttpCall的excute方法会创建OkHttp的call对象进行网络请求,如图
Observable的网络请求实则是在数据发射源里进行的,具体看RxJavaCallAdapterFactory
5,回调结果的处理
CallAdapter(ExecutorCallbackCall实现类)中会通过callbackExecutor将结果发送到主线程
callbackExecutor的默认实现类是MainThreadExecutor,Rx可以自由切换线程
最后盗一张图