序文
今日はレトロフィットのソースコードを学びます。
1.レトロフィットの作成プロセス
Retrofitを使用してネットワークを要求するときは、最初に要求インターフェイスを作成する必要があります。
public interface IpService {
@GET("getIpInfo.php?ip=59.108.54.37")
Call<IpModel> getIpMsg();
次に、次のコードを呼び出してRetrofitを作成します。
Retrofit retrofit = new Retrofit.Builder()
.baseUrl(url)
.addConverterFactory(GsonConverterFactory.create())
.build();
レトロフィットはビルダーモードで構築されます。ビルダーメソッドの機能を見てみましょう。
public Builder() {
this(Platform.get());
}
非常に短いですが、以下に示すように、Platformのgetメソッドを見てください。
private static final Platform PLATFORM = findPlatform();
static Platform get() {
return PLATFORM;
}
private static Platform findPlatform() {
try {
Class.forName("android.os.Build");
if (Build.VERSION.SDK_INT != 0) {
return new Android();
}
} catch (ClassNotFoundException ignored) {
}
try {
Class.forName("java.util.Optional");
return new Java8();
} catch (ClassNotFoundException ignored) {
}
try {
Class.forName("org.robovm.apple.foundation.NSObject");
return new IOS();
} catch (ClassNotFoundException ignored) {
}
return new Platform();
}
プラットフォームのgetメソッドは、最終的にfindPlatformメソッドを呼び出します。このメソッドは、さまざまなオペレーティングプラットフォームに応じてさまざまなスレッドプールを提供します。次に、ビルドメソッドを見てください。コードを以下に示します。
public Retrofit build() {
if (baseUrl == null) {//1
throw new IllegalStateException("Base URL required.");
}
okhttp3.Call.Factory callFactory = this.callFactory;//2
if (callFactory == null) {
callFactory = new OkHttpClient();//3
}
Executor callbackExecutor = this.callbackExecutor;
if (callbackExecutor == null) {
callbackExecutor = platform.defaultCallbackExecutor();//4
}
List<CallAdapter.Factory> adapterFactories = new ArrayList<>(this.adapterFactories);//5
adapterFactories.add(platform.defaultCallAdapterFactory(callbackExecutor));
List<Converter.Factory> converterFactories = new ArrayList<>(this.converterFactories);//6
return new Retrofit(callFactory, baseUrl, converterFactories, adapterFactories,
callbackExecutor, validateEagerly);
}
注1から、baseUrlを指定する必要があることがわかります。注2デフォルトのcallFactoryはthis.callFactoryです。this.callFactoryは、以下に示すように、Retrofitを構築するときにcallFactoryメソッドを呼び出すことによって渡されます。
public Builder callFactory(okhttp3.Call.Factory factory) {
this.callFactory = checkNotNull(factory, "factory == null");
return this;
}
したがって、OkHttpClientを設定する必要がある場合は、OkHttpClientオブジェクトを作成してから、callFactoryメソッドを呼び出して設定されたOkHttpClientを渡すことができます。注3、callFactoryが設定されていない場合、OkHttpClientは直接作成されます。注4のcallbackExecutorは、コールバックをUIスレッドに渡すために使用されます。注5のadapterFactoriesは、主にCallを変換するオブジェクトを格納するために使用されます。これについては、後でCallの作成プロセスで再度説明します。注6のconverterFactoriesは、主に変換データオブジェクトを格納するために使用されます。これについては後で説明します。前の例で呼び出されたaddConverterFactory（GsonConverterFactory.create（））は、Gsonオブジェクトへの変換をサポートするように返されるデータを設定することです。最後に、構成されたRetrofitクラスが返されます。
2.呼び出し作成プロセス
次に、Retrofitのインスタンスを作成し、次のコードを呼び出して、インターフェイスの動的プロキシオブジェクトを生成します。
IpService ipService = retrofit.create(IpService.class);
次に、Retrofitのcreateメソッドが何をするかを見てください。コードを以下に示します。
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);//1
OkHttpCall okHttpCall = new OkHttpCall<>(serviceMethod, args);
return serviceMethod.callAdapter.adapt(okHttpCall);
}
});
}
createメソッドがProxy.newProxyInstance動的プロキシオブジェクトを返すことがわかります。IpServiceのgetIpMsgメソッドを呼び出すと、最終的にInvocationHandlerのinvokeメソッドが呼び出されます。3つのパラメーターがあり、最初のパラメーターはプロキシオブジェクトで、 2番目は呼び出されるメソッドです。3番目はメソッドパラメータです。注1のloadServiceMethod（method）のメソッドは、定義したgetIpMsgメソッドです。次に、loadServiceMethodメソッドで実行される内容を確認します。
private final Map<Method, ServiceMethod> serviceMethodCache = new LinkedHashMap<>();
ServiceMethod loadServiceMethod(Method method) {
ServiceMethod result;
synchronized (serviceMethodCache) {
result = serviceMethodCache.get(method);
if (result == null) {
result = new ServiceMethod.Builder(this, method).build();
serviceMethodCache.put(method, result);
}
}
return result;
}
まず、着信メソッドにserviceMethodCacheからのキャッシュがあるかどうかを照会します。ある場合は、キャッシュされたServiceMethodを使用し、ない場合は作成して、serviceMethodCacheをキャッシュに追加します。次に、ServiceMethodがどのように構築されるかを見てみましょう。コードを以下に示します。
public ServiceMethod build() {
callAdapter = createCallAdapter();//1
responseType = callAdapter.responseType();//2
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();//3
for (Annotation annotation : methodAnnotations) {
parseMethodAnnotation(annotation);//4
}
...
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];//5
if (parameterAnnotations == null) {
throw parameterError(p, "No Retrofit annotation found.");
}
parameterHandlers[p] = parseParameter(p, parameterType, parameterAnnotations);
}
...
return new ServiceMethod<>(this);
}
createCallAdapterメソッドは注1で呼び出され、Retrofitのビルド時にbuildメソッドを呼び出すと、adapterFactoriesによって追加されたオブジェクトのgetメソッドと、Retrofitのビルドメソッドのコードの一部を最終的に取得します。
List<CallAdapter.Factory> adapterFactories = new ArrayList<>(this.adapterFactories);
adapterFactories.add(platform.defaultCallAdapterFactory(callbackExecutor));
defaultCallAdapterFactoryはデフォルトでadapterFactoriesリストに追加されます。defaultCallAdapterFactoryはExecutorCallAdapterFactoryを参照します。ExecutorCallAdapterFactoryのgetメソッドを以下に示します。
public CallAdapter<Call<?>> get(Type returnType, Annotation[] annotations, Retrofit retrofit) {
if (getRawType(returnType) != Call.class) {
return null;
}
final Type responseType = Utils.getCallResponseType(returnType);
return new CallAdapter<Call<?>>() {
@Override public Type responseType() {
return responseType;
}
@Override public <R> Call<R> adapt(Call<R> call) {
return new ExecutorCallbackCall<>(callbackExecutor, call);
}
};
}
getメソッドはCallAdapterオブジェクトを取得し、そのresponseTypeメソッドはデータの実際のタイプをCall<IpModel>返します。たとえば 、IpModelを返します。Adaptメソッドは、呼び出しのコールバックをUIスレッドに転送するExecutorCallbackCallを作成します。
次に、ServiceMethodのビルドメソッドに戻り、注2でCallAdapterのresponseTypeを呼び出して、返されたデータのTrueTypeを取得します。
注3は、createResponseConverterメソッドを呼び出して、converterFactoriesリストに格納されているConverter.Factoryをトラバースし、オブジェクトを変換するための適切なConverterを返します。Retrofitを構築する前に、addConverterFactory（GsonConverterFactory.create（））を呼び出して、GsonConverterFactory（Converter.Factoryのサブクラス）をconverterFactoriesのリストに追加し、返されたデータがJsonオブジェクトへの変換をサポートしていることを示しました。
注4は、parseMethodAnnotationメソッドをトラバースして、要求メソッド（GET、POSTなど）と要求アドレスを分析します。メソッド内のパラメーターアノテーション（@ Query、@ Partなど）を解析するための注5。最後に、ServiceMethodクラスを作成して戻ります。
次に、Retrofitのcreateメソッドを振り返ります。loadServiceMethodメソッドを呼び出した後、OkHttpCallが作成され、OkHttpCallコンストラクターは単なる代入操作です。呼び出しの直後に、serviceMethod.callAdapter.adapt(okHttpCall)callAdapterのadaptメソッドが前述したように、ExecutorCallbackCallが作成され、ExecutorCallbackCallのコードの一部が以下に示されています。
ExecutorCallbackCall(Executor callbackExecutor, Call<T> delegate) {
this.callbackExecutor = callbackExecutor;
this.delegate = delegate;
}
@Override public void enqueue(final Callback<T> callback) {
if (callback == null) throw new NullPointerException("callback == null");
delegate.enqueue(new Callback<T>() {//1
@Override public void onResponse(Call<T> call, final Response<T> response) {
callbackExecutor.execute(new Runnable() {
@Override public void run() {
if (delegate.isCanceled()) {
callback.onFailure(ExecutorCallbackCall.this, new IOException("Canceled"));
} else {
callback.onResponse(ExecutorCallbackCall.this, response);
}
}
});
}
@Override public void onFailure(Call<T> call, final Throwable t) {
callbackExecutor.execute(new Runnable() {
@Override public void run() {
callback.onFailure(ExecutorCallbackCall.this, t);
}
});
}
});
}
ExecutorCallbackCallはCallのカプセル化であり、主にcallbackExecutorを介してUIスレッドにコールバックを追加していることがわかります。
Callオブジェクトを取得したら、そのエンキューメソッドを呼び出します。実際には、ExecutorCallbackCallのエンキューメソッドを呼び出します。注1から、ExecutorCallbackCallのエンキューメソッドが最終的にデリゲートのエンキューメソッドを呼び出すことがわかります。Retrofitのcreateメソッドのコードから、デリゲートは実際にはOkHttpCallであることがわかります。
3.呼び出しのエンキューメソッド
次に、OkHttpCallのenqueueメソッドを見てみましょう。コードを以下に示します。
public void enqueue(final Callback<T> callback) {
if (callback == null) throw new NullPointerException("callback == null");
okhttp3.Call call;
...
call.enqueue(new okhttp3.Callback() {//1
@Override public void onResponse(okhttp3.Call call, okhttp3.Response rawResponse)
throws IOException {
Response<T> response;
try {
response = parseResponse(rawResponse);//2
} catch (Throwable e) {
callFailure(e);
return;
}
callSuccess(response);
}
...
}
注1は、okhttp3.Callのenqueueメソッドを呼び出します。注2：parseResponseメソッドを呼び出します。
Response<T> parseResponse(okhttp3.Response rawResponse) throws IOException {
ResponseBody rawBody = rawResponse.body();
...
int code = rawResponse.code();
if (code < 200 || code >= 300) {
try {
ResponseBody bufferedBody = Utils.buffer(rawBody);
return Response.error(bufferedBody, rawResponse);
} finally {
rawBody.close();
}
}
if (code == 204 || code == 205) {
return Response.success(null, rawResponse);
}
ExceptionCatchingRequestBody catchingBody = new ExceptionCatchingRequestBody(rawBody);
try {
T body = serviceMethod.toResponse(catchingBody);//2
return Response.success(body, rawResponse);
} catch (RuntimeException e) {
catchingBody.throwIfCaught();
throw e;
}
}
返されたさまざまなステータスコードコード値に応じてさまざまな操作を実行します。うまくいけば、コメント2のコードが呼び出されます。次に、toResponseメソッドで何が行われるかを見てみましょう。
T toResponse(ResponseBody body) throws IOException {
return responseConverter.convert(body);
}
このresponseConverterは、ServiceMethodのbuildメソッドでcreateResponseConverterメソッドを呼び出すことによって返されるコンバーターです。前の例では、GsonConverterFactoryを渡したので、以下に示すように、GsonConverterFactoryのコードを表示できます。
public final class GsonConverterFactory extends Converter.Factory {
...
@Override
public Converter<ResponseBody, ?> responseBodyConverter(Type type, Annotation[] annotations,
Retrofit retrofit) {
TypeAdapter<?> adapter = gson.getAdapter(TypeToken.get(type));
return new GsonResponseBodyConverter<>(gson, adapter);
}
...
}
GsonConverterFactoryにはメソッドresponseBodyConverterがあり、最終的にGsonResponseBodyConverterを作成します。
final class GsonResponseBodyConverter<T> implements Converter<ResponseBody, T> {
private final Gson gson;
private final TypeAdapter<T> adapter;
GsonResponseBodyConverter(Gson gson, TypeAdapter<T> adapter) {
this.gson = gson;
this.adapter = adapter;
}
@Override public T convert(ResponseBody value) throws IOException {
JsonReader jsonReader = gson.newJsonReader(value.charStream());
try {
return adapter.read(jsonReader);
} finally {
value.close();
}
}
}
GsonResponseBodyConverterのconvertメソッドでは、コールバックデータがJson形式に変換されます。したがって、前の呼び出しresponseConverter.convertが特定のデータ形式に変換することであったこともわかっています。
Callのenqueueメソッドは、主にOKHttpを使用してネットワークを要求し、返された応答をUIスレッドに変換します。
これまでのところ、Retrofitのソースコードはここにあります。
この記事 は、オープンソースプロジェクトhttps://github.com/Android-Alvin/Android-LearningNotesに含まれています。このプロジェクトには、さまざまな方向への自己学習プログラミングルート、インタビューの質問/顔、および一連の技術記事が含まれています。リソースは継続的に更新されます…