Add support of logging in object level

retrofit-logger/README.md

@@ -0,0 +1,13 @@
+Retrofit Logger
+===================
+
+Retrofit ships with support for object level logging to increase readability for case like response is binary so we can't log in OkHttp layer.
+
+To use, supply an instance of your desired logger when building your `Retrofit` instance.
+
+```java
+Retrofit retrofit = new Retrofit.Builder()
+    .baseUrl("https://api.example.com")
+    .setObjectLogger(GsonLogger.create())
+    .build();
+```

retrofit-logger/gson/.gitignore

@@ -0,0 +1 @@
+/build

retrofit-logger/gson/build.gradle

@@ -0,0 +1,6 @@
+apply plugin: 'java-library'
+
+dependencies {
+    implementation project(':retrofit')
+    api deps.gson
+}

retrofit-logger/gson/src/main/java/retrofit2/logger/gson/GsonLogger.java

@@ -0,0 +1,31 @@
+package retrofit2.logger.gson;
+
+import com.google.gson.Gson;
+import okhttp3.Request;
+import retrofit2.ObjectLogger;
+
+public class GsonLogger implements ObjectLogger {
+  private final Gson gson;
+
+  public static GsonLogger create() {
+    return create(new Gson());
+  }
+
+  @SuppressWarnings("ConstantConditions") // Guarding public API nullability.
+  public static GsonLogger create(Gson gson) {
+    if (gson == null) throw new NullPointerException("gson == null");
+    return new GsonLogger(gson);
+  }
+
+  private GsonLogger(Gson gson) {
+    this.gson = gson;
+  }
+
+  @Override
+  public void log(Request request, Object obj) {
+    System.out.println("Request = ");
+    System.out.println(request.url().toString());
+    System.out.println("Response = ");
+    System.out.println(gson.toJson(obj));
+  }
+}

retrofit-logger/gson/src/main/java/retrofit2/logger/gson/package-info.java

@@ -0,0 +1,2 @@
+@retrofit2.internal.EverythingIsNonNull
+package retrofit.logger;

retrofit/src/main/java/retrofit2/EmptyLogger.java

@@ -0,0 +1,9 @@
+package retrofit2;
+
+import okhttp3.Request;
+
+public class EmptyLogger implements ObjectLogger {
+
+  @Override
+  public void log(Request request, Object obj) {}
+}

retrofit/src/main/java/retrofit2/HttpServiceMethod.java

@@ -83,18 +83,19 @@ static <ResponseT, ReturnT> HttpServiceMethod<ResponseT, ReturnT> parseAnnotatio
 
     Converter<ResponseBody, ResponseT> responseConverter =
         createResponseConverter(retrofit, method, responseType);
-
+    ObjectLogger logger = retrofit.logger;
     okhttp3.Call.Factory callFactory = retrofit.callFactory;
     if (!isKotlinSuspendFunction) {
-      return new CallAdapted<>(requestFactory, callFactory, responseConverter, callAdapter);
+      return new CallAdapted<>(requestFactory, callFactory, responseConverter, callAdapter, logger);
     } else if (continuationWantsResponse) {
       //noinspection unchecked Kotlin compiler guarantees ReturnT to be Object.
       return (HttpServiceMethod<ResponseT, ReturnT>)
           new SuspendForResponse<>(
               requestFactory,
               callFactory,
               responseConverter,
-              (CallAdapter<ResponseT, Call<ResponseT>>) callAdapter);
+              (CallAdapter<ResponseT, Call<ResponseT>>) callAdapter,
+              logger);
     } else {
       //noinspection unchecked Kotlin compiler guarantees ReturnT to be Object.
       return (HttpServiceMethod<ResponseT, ReturnT>)
@@ -103,6 +104,7 @@ static <ResponseT, ReturnT> HttpServiceMethod<ResponseT, ReturnT> parseAnnotatio
               callFactory,
               responseConverter,
               (CallAdapter<ResponseT, Call<ResponseT>>) callAdapter,
+              logger,
               continuationBodyNullable);
     }
   }
@@ -130,20 +132,25 @@ private static <ResponseT> Converter<ResponseBody, ResponseT> createResponseConv
   private final RequestFactory requestFactory;
   private final okhttp3.Call.Factory callFactory;
   private final Converter<ResponseBody, ResponseT> responseConverter;
+  private final ObjectLogger logger;
 
   HttpServiceMethod(
       RequestFactory requestFactory,
       okhttp3.Call.Factory callFactory,
-      Converter<ResponseBody, ResponseT> responseConverter) {
+      Converter<ResponseBody, ResponseT> responseConverter,
+      ObjectLogger logger) {
     this.requestFactory = requestFactory;
     this.callFactory = callFactory;
     this.responseConverter = responseConverter;
+    this.logger = logger;
   }
 
   @Override
   final @Nullable ReturnT invoke(Object[] args) {
-    Call<ResponseT> call = new OkHttpCall<>(requestFactory, args, callFactory, responseConverter);
-    return adapt(call, args);
+    Call<ResponseT> call =
+        new OkHttpCall<>(requestFactory, args, callFactory, responseConverter, logger);
+    ReturnT result = adapt(call, args);
+    return result;
   }
 
   protected abstract @Nullable ReturnT adapt(Call<ResponseT> call, Object[] args);
@@ -155,8 +162,9 @@ static final class CallAdapted<ResponseT, ReturnT> extends HttpServiceMethod<Res
         RequestFactory requestFactory,
         okhttp3.Call.Factory callFactory,
         Converter<ResponseBody, ResponseT> responseConverter,
-        CallAdapter<ResponseT, ReturnT> callAdapter) {
-      super(requestFactory, callFactory, responseConverter);
+        CallAdapter<ResponseT, ReturnT> callAdapter,
+        ObjectLogger logger) {
+      super(requestFactory, callFactory, responseConverter, logger);
       this.callAdapter = callAdapter;
     }
 
@@ -173,8 +181,9 @@ static final class SuspendForResponse<ResponseT> extends HttpServiceMethod<Respo
         RequestFactory requestFactory,
         okhttp3.Call.Factory callFactory,
         Converter<ResponseBody, ResponseT> responseConverter,
-        CallAdapter<ResponseT, Call<ResponseT>> callAdapter) {
-      super(requestFactory, callFactory, responseConverter);
+        CallAdapter<ResponseT, Call<ResponseT>> callAdapter,
+        ObjectLogger logger) {
+      super(requestFactory, callFactory, responseConverter, logger);
       this.callAdapter = callAdapter;
     }
 
@@ -204,8 +213,9 @@ static final class SuspendForBody<ResponseT> extends HttpServiceMethod<ResponseT
         okhttp3.Call.Factory callFactory,
         Converter<ResponseBody, ResponseT> responseConverter,
         CallAdapter<ResponseT, Call<ResponseT>> callAdapter,
+        ObjectLogger logger,
         boolean isNullable) {
-      super(requestFactory, callFactory, responseConverter);
+      super(requestFactory, callFactory, responseConverter, logger);
       this.callAdapter = callAdapter;
       this.isNullable = isNullable;
     }

retrofit/src/main/java/retrofit2/ObjectLogger.java

@@ -0,0 +1,8 @@
+package retrofit2;
+
+import okhttp3.Request;
+
+public interface ObjectLogger {
+
+  void log(Request request, Object obj);
+}

retrofit/src/main/java/retrofit2/OkHttpCall.java

@@ -35,6 +35,7 @@ final class OkHttpCall<T> implements Call<T> {
   private final Object[] args;
   private final okhttp3.Call.Factory callFactory;
   private final Converter<ResponseBody, T> responseConverter;
+  private final ObjectLogger logger;
 
   private volatile boolean canceled;
 
@@ -51,17 +52,19 @@ final class OkHttpCall<T> implements Call<T> {
       RequestFactory requestFactory,
       Object[] args,
       okhttp3.Call.Factory callFactory,
-      Converter<ResponseBody, T> responseConverter) {
+      Converter<ResponseBody, T> responseConverter,
+      ObjectLogger logger) {
     this.requestFactory = requestFactory;
     this.args = args;
     this.callFactory = callFactory;
     this.responseConverter = responseConverter;
+    this.logger = logger;
   }
 
   @SuppressWarnings("CloneDoesntCallSuperClone") // We are a final type & this saves clearing state.
   @Override
   public OkHttpCall<T> clone() {
-    return new OkHttpCall<>(requestFactory, args, callFactory, responseConverter);
+    return new OkHttpCall<>(requestFactory, args, callFactory, responseConverter, logger);
   }
 
   @Override
@@ -151,6 +154,9 @@ public void onResponse(okhttp3.Call call, okhttp3.Response rawResponse) {
             Response<T> response;
             try {
               response = parseResponse(rawResponse);
+              if (response.body() != null) {
+                logger.log(call.request(), response.body());
+              }
             } catch (Throwable e) {
               throwIfFatal(e);
               callFailure(e);
@@ -201,7 +207,11 @@ public Response<T> execute() throws IOException {
       call.cancel();
     }
 
-    return parseResponse(call.execute());
+    Response<T> response = parseResponse(call.execute());
+    if (response.body() != null) {
+      logger.log(call.request(), response.body());
+    }
+    return response;
   }
 
   private okhttp3.Call createRawCall() throws IOException {

retrofit/src/main/java/retrofit2/Retrofit.java

@@ -72,19 +72,22 @@ public final class Retrofit {
   final List<CallAdapter.Factory> callAdapterFactories;
   final @Nullable Executor callbackExecutor;
   final boolean validateEagerly;
+  final ObjectLogger logger;
 
   Retrofit(
       okhttp3.Call.Factory callFactory,
       HttpUrl baseUrl,
       List<Converter.Factory> converterFactories,
       List<CallAdapter.Factory> callAdapterFactories,
       @Nullable Executor callbackExecutor,
+      ObjectLogger logger,
       boolean validateEagerly) {
     this.callFactory = callFactory;
     this.baseUrl = baseUrl;
     this.converterFactories = converterFactories; // Copy+unmodifiable at call site.
     this.callAdapterFactories = callAdapterFactories; // Copy+unmodifiable at call site.
     this.callbackExecutor = callbackExecutor;
+    this.logger = logger;
     this.validateEagerly = validateEagerly;
   }
 
@@ -431,6 +434,7 @@ public static final class Builder {
     private final List<Converter.Factory> converterFactories = new ArrayList<>();
     private final List<CallAdapter.Factory> callAdapterFactories = new ArrayList<>();
     private @Nullable Executor callbackExecutor;
+    private @Nullable ObjectLogger logger;
     private boolean validateEagerly;
 
     Builder(Platform platform) {
@@ -581,6 +585,11 @@ public Builder addCallAdapterFactory(CallAdapter.Factory factory) {
       return this;
     }
 
+    public Builder setObjectLogger(ObjectLogger logger) {
+      this.logger = logger;
+      return this;
+    }
+
     /**
      * The executor on which {@link Callback} methods are invoked when returning {@link Call} from
      * your service method.
@@ -648,12 +657,18 @@ public Retrofit build() {
       converterFactories.addAll(this.converterFactories);
       converterFactories.addAll(platform.defaultConverterFactories());
 
+      ObjectLogger logger = this.logger;
+      if (logger == null) {
+        logger = new EmptyLogger();
+      }
+
       return new Retrofit(
           callFactory,
           baseUrl,
           unmodifiableList(converterFactories),
           unmodifiableList(callAdapterFactories),
           callbackExecutor,
+          logger,
           validateEagerly);
     }
   }

samples/build.gradle

@@ -7,6 +7,7 @@ dependencies {
   implementation project(':retrofit-converters:gson')
   implementation project(':retrofit-converters:simplexml')
   implementation project(':retrofit-adapters:rxjava')
+  implementation project(':retrofit-logger:gson')
   implementation deps.mockwebserver
   implementation deps.guava
   implementation deps.jsoup

samples/src/main/java/com/example/retrofit/SimpleService.java

@@ -22,6 +22,7 @@
 import retrofit2.converter.gson.GsonConverterFactory;
 import retrofit2.http.GET;
 import retrofit2.http.Path;
+import retrofit2.logger.gson.GsonLogger;
 
 public final class SimpleService {
   public static final String API_URL = "https://api.github.com";
@@ -46,6 +47,7 @@ public static void main(String... args) throws IOException {
     Retrofit retrofit =
         new Retrofit.Builder()
             .baseUrl(API_URL)
+            .setObjectLogger(GsonLogger.create())
             .addConverterFactory(GsonConverterFactory.create())
             .build();
 

settings.gradle

@@ -23,4 +23,7 @@ include ':retrofit-converters:scalars'
 include ':retrofit-converters:simplexml'
 include ':retrofit-converters:wire'
 
+include ':retrofit-logger:gson'
+
 include ':samples'
+