141

我在 Retrofit API 中找不到用于记录完整请求/响应主体的相关方法。我期待 Profiler 提供一些帮助(但它只提供有关响应的元数据)。我尝试在 Builder 中设置日志级别,但这对我也没有帮助:

RestAdapter adapter = (new RestAdapter.Builder()).
                setEndpoint(baseUrl).
                setRequestInterceptor(interceptor).
                setProfiler(profiler).
                setClient(client).
                setExecutors(MyApplication.getWebServiceThreadPool()).
                setLogLevel(LogLevel.FULL).
                setLog(new RestAdapter.Log() {
                    @Override
                    public void log(String msg) {
                        Log.i(TAG, msg);
                    }
                }).
                build();

编辑:此代码现在正在运行。我不知道为什么它没有早点工作。可能是因为我使用了一些旧版本的改造。

4

13 回答 13

137

改造 2.0

更新:@by Marcus Pöhls

登录改造 2

Retrofit 2 完全依赖 OkHttp 进行任何网络操作。由于 OkHttp 是 Retrofit 2 的对等依赖项,因此一旦将 Retrofit 2 作为稳定版本发布,您就不需要添加额外的依赖项。

OkHttp 2.6.0 附带一个日志拦截器作为内部依赖项,您可以直接将它用于您的 Retrofit 客户端。Retrofit 2.0.0-beta2 仍然使用 OkHttp 2.5.0。未来的版本会将依赖关系提升到更高的 OkHttp 版本。这就是您需要手动导入日志拦截器的原因。将以下行添加到 build.gradle 文件中的 gradle 导入中,以获取日志记录拦截器依赖项。

compile 'com.squareup.okhttp3:logging-interceptor:3.9.0'

你也可以访问 Square 的 GitHub 页面来了解这个拦截器

将日志记录添加到 Retrofit 2

在开发应用程序和调试时,最好集成一个日志功能来显示请求和响应信息。由于 Retrofit 2 中默认不再集成日志记录,因此我们需要为 OkHttp 添加一个日志记录拦截器。幸运的是 OkHttp 已经附带了这个拦截器,你只需要为你的 OkHttpClient 激活它。

HttpLoggingInterceptor logging = new HttpLoggingInterceptor();  
// set your desired log level
logging.setLevel(HttpLoggingInterceptor.Level.BODY);
OkHttpClient.Builder httpClient = new OkHttpClient.Builder();   
// add your other interceptors …
// add logging as last interceptor
httpClient.addInterceptor(logging);  // <-- this is the important line!
Retrofit retrofit = new Retrofit.Builder()  
        .baseUrl(API_BASE_URL)
        .addConverterFactory(GsonConverterFactory.create())
        .client(httpClient.build())
        .build();

我们建议将日志记录添加为最后一个拦截器,因为这也会将您使用先前拦截器添加的信息记录到您的请求中。

日志级别

记录太多信息会炸毁你的 Android 监视器,这就是为什么 OkHttp 的日志拦截器有四个日志级别:NONE、BASIC、HEADERS、BODY。我们将引导您浏览每个日志级别并描述它们的输出。

更多信息请访问:Retrofit 2 — 日志请求和响应

旧答案:

不再登录 Retrofit 2。开发团队删除了日志记录功能。老实说,日志功能无论如何都不是那么可靠。Jake Wharton 明确指出,记录的消息或对象是假定值,无法证明它们是真实的。到达服务器的实际请求可能具有更改的请求正文或其他内容。

即使默认情况下没有集成日志记录,您也可以利用任何 Java 记录器并在自定义的 OkHttp 拦截器中使用它。

有关 Retrofit 2 的更多信息,请参阅: Retrofit — 入门和创建 Android 客户端

于 2015-10-25T10:16:04.413 回答
94

我用过setLogLevel(LogLevel.FULL).setLog(new AndroidLog("YOUR_LOG_TAG")),对我有帮助。
更新。
您也可以尝试用于调试目的retrofit.client.Response,用作响应模型

于 2014-03-26T08:29:04.350 回答
33

Retrofit 2.0.0-beta3 的更新

现在您必须将 okhttp3 与 builder 一起使用。旧的拦截器也不起作用。此响应是为 Android 量身定制的。

这是一个带有新内容的快速复制粘贴。

1.修改你的gradle文件为

  compile 'com.squareup.retrofit2:retrofit:2.0.0-beta3'
  compile "com.squareup.retrofit2:converter-gson:2.0.0-beta3"
  compile "com.squareup.retrofit2:adapter-rxjava:2.0.0-beta3"
  compile 'com.squareup.okhttp3:logging-interceptor:3.0.1'

2.检查此示例代码:

随着新的进口。如果你不使用它,你可以删除它,也可以删除你不使用的东西。

import okhttp3.OkHttpClient;
import okhttp3.logging.HttpLoggingInterceptor;
import retrofit2.GsonConverterFactory;
import retrofit2.Retrofit;
import retrofit2.RxJavaCallAdapterFactory;
import retrofit2.http.GET;
import retrofit2.http.Query;
import rx.Observable;

public interface APIService {

  String ENDPOINT = "http://api.openweathermap.org";
  String API_KEY = "2de143494c0b2xxxx0e0";

  @GET("/data/2.5/weather?appid=" + API_KEY) Observable<WeatherPojo> getWeatherForLatLon(@Query("lat") double lat, @Query("lng") double lng, @Query("units") String units);


  class Factory {

    public static APIService create(Context context) {

      OkHttpClient.Builder builder = new OkHttpClient().newBuilder();
      builder.readTimeout(10, TimeUnit.SECONDS);
      builder.connectTimeout(5, TimeUnit.SECONDS);

      if (BuildConfig.DEBUG) {
        HttpLoggingInterceptor interceptor = new HttpLoggingInterceptor();
        interceptor.setLevel(HttpLoggingInterceptor.Level.BASIC);
        builder.addInterceptor(interceptor);
      }

      //Extra Headers

      //builder.addNetworkInterceptor().add(chain -> {
      //  Request request = chain.request().newBuilder().addHeader("Authorization", authToken).build();
      //  return chain.proceed(request);
      //});

      builder.addInterceptor(new UnauthorisedInterceptor(context));
      OkHttpClient client = builder.build();

      Retrofit retrofit =
          new Retrofit.Builder().baseUrl(APIService.ENDPOINT).client(client).addConverterFactory(GsonConverterFactory.create()).addCallAdapterFactory(RxJavaCallAdapterFactory.create()).build();

      return retrofit.create(APIService.class);
    }
  }
}

奖金

我知道这是题外话,但我觉得很酷。

如果有未经授权的http错误代码,这里是一个拦截器。我使用事件总线来传输事件。

import android.content.Context;
import android.os.Handler;
import android.os.Looper;
import com.androidadvance.ultimateandroidtemplaterx.BaseApplication;
import com.androidadvance.ultimateandroidtemplaterx.events.AuthenticationErrorEvent;

import de.greenrobot.event.EventBus;
import java.io.IOException;
import javax.inject.Inject;
import okhttp3.Interceptor;
import okhttp3.Response;

public class UnauthorisedInterceptor implements Interceptor {

  @Inject EventBus eventBus;

  public UnauthorisedInterceptor(Context context) {
    BaseApplication.get(context).getApplicationComponent().inject(this);
  }

  @Override public Response intercept(Chain chain) throws IOException {
    Response response = chain.proceed(chain.request());
    if (response.code() == 401) {
      new Handler(Looper.getMainLooper()).post(() -> eventBus.post(new AuthenticationErrorEvent()));
    }
    return response;
  }
}

代码取自https://github.com/AndreiD/UltimateAndroidTemplateRx(我的项目)。

于 2016-01-19T11:32:30.210 回答
9

似乎没有办法做基本+正文,但你可以使用 FULL 并过滤你不想要的标题。

RestAdapter adapter = new RestAdapter.Builder()
                          .setEndpoint(syncServer)
                          .setErrorHandler(err)
                          .setConverter(new GsonConverter(gson))
                          .setLogLevel(logLevel)
                          .setLog(new RestAdapter.Log() {
                              @Override
                              public void log(String msg) {
                                  String[] blacklist = {"Access-Control", "Cache-Control", "Connection", "Content-Type", "Keep-Alive", "Pragma", "Server", "Vary", "X-Powered-By"};
                                  for (String bString : blacklist) {
                                      if (msg.startsWith(bString)) {
                                          return;
                                      }
                                  }
                                  Log.d("Retrofit", msg);
                              }
                          }).build();

似乎在覆盖日志时,正文以类似于以下的标记为前缀

[ 02-25 10:42:30.317 25645:26335 D/Retrofit ]

所以通过调整自定义过滤器应该很容易记录基本+正文。我使用的是黑名单,但也可以根据您的需要使用白名单。

于 2015-02-25T17:52:53.670 回答
6

下面的代码适用于带有标头和不带标头的打印日志请求和响应。注意:如果不使用标题,只需注释 .addHeader() 行。

HttpLoggingInterceptor interceptor = new HttpLoggingInterceptor();
        interceptor.setLevel(HttpLoggingInterceptor.Level.BODY);
        OkHttpClient client = new OkHttpClient.Builder()
                .addInterceptor(interceptor)
                //.addInterceptor(REWRITE_CACHE_CONTROL_INTERCEPTOR)
                .addNetworkInterceptor(new Interceptor() {

                    @Override

                    public okhttp3.Response intercept(Chain chain) throws IOException {
                        Request request = chain.request().newBuilder()
                                // .addHeader(Constant.Header, authToken)
                                   .build();
                        return chain.proceed(request);
                    }
                }).build();

        final Retrofit retrofit = new Retrofit.Builder()
                .baseUrl(Constant.baseUrl)
                .client(client) // This line is important
                .addConverterFactory(GsonConverterFactory.create())
                .build();
于 2016-09-26T13:39:02.503 回答
3

我希望这段代码能帮助你记录。
你只需要在你的Build.Gradlethen make中添加拦截器RetrofitClient

第一步

将此行添加到您的build.gradle

 implementation 'com.squareup.okhttp3:logging-interceptor:3.4.1' 

第二步

做你的改造客户


   public class RetrofitClient {

    private Retrofit retrofit;
    private static OkHttpClient.Builder httpClient =
            new OkHttpClient.Builder();
    private static RetrofitClient instance = null;
    private static ApiServices service = null;
    private static HttpLoggingInterceptor logging =
            new HttpLoggingInterceptor();

    private RetrofitClient(final Context context) {
        httpClient.interceptors().add(new Interceptor() {
            @Override
            public okhttp3.Response intercept(Interceptor.Chain chain) throws IOException {
                Request originalRequest = chain.request();
                Request.Builder builder = originalRequest.newBuilder().
                        method(originalRequest.method(), originalRequest.body());
                okhttp3.Response response = chain.proceed(builder.build());
                /*
                Do what you want
                 */
                return response;
            }
        });

        if (BuildConfig.DEBUG) {
            logging.setLevel(HttpLoggingInterceptor.Level.BODY);
            // add logging as last interceptor
            httpClient.addInterceptor(logging);
        }

        retrofit = new Retrofit.Builder().client(httpClient.build()).
                baseUrl(Constants.BASE_URL).
                addConverterFactory(GsonConverterFactory.create()).build();
        service = retrofit.create(ApiServices.class);
    }


    public static RetrofitClient getInstance(Context context) {
        if (instance == null) {
            instance = new RetrofitClient(context);
        }
        return instance;
    }

    public ApiServices getApiService() {
        return service;
    }
}

打电话

RetrofitClient.getInstance(context).getApiService().yourRequestCall(); 

于 2019-03-18T06:34:56.887 回答
3

理想情况下,如果您使用Timber会更好,因为您还可以在全局范围内对应用程序中的日志消息做任何您想做的事情,例如将它们保存到文件中。以下是使 Httplogginginterceptor 与木材一起工作的方法:

val loggingInterceptor = HttpLoggingInterceptor { message -> 
Timber.d(message) 
}.apply {
     level = HttpLoggingInterceptor.Level.BODY
}

val client = OkHttpClient.Builder()
            .addInterceptor(loggingInterceptor)
            .build()

return Retrofit.Builder()
            .baseUrl(baseUrl)
            .addConverterFactory(GsonConverterFactory.create())
            .client(client)
            .build()
            .create(RetrofitApiService::class.java)

您还可以通过这种方式创建自己的记录器拦截器实现:

class HttpLoggingInterceptor : Interceptor {
    override fun intercept(chain: Interceptor.Chain): Response {
        val request: Request = chain.request()

        val t1 = System.nanoTime()
        Timber.i(
            "Sending request %s on %s%n%s",
            request.url,
            chain.connection(),
            request.headers
        )
        Timber.v("REQUEST BODY BEGIN\n%s\nREQUEST BODY END", bodyToString(request))

        val response = chain.proceed(request)

        val responseBody: ResponseBody? = response.body
        val responseBodyString = response.body!!.string()

        val newResponse = response.newBuilder()
            .body(responseBodyString.toResponseBody(responseBody?.contentType()))
            .build()

        val t2 = System.nanoTime()
        Timber.i(
            "Received response for %s in %.1fms%n%s",
            response.request.url,
            (t2 - t1) / 1e6,
            response.headers
        )
        Timber.v("RESPONSE BODY BEGIN:\n%s\nRESPONSE BODY END", responseBodyString)

        return newResponse
    }

    private fun bodyToString(request: Request): String? {
        return try {
            val copy = request.newBuilder().build()
            val buffer = Buffer()
            copy.body!!.writeTo(buffer)
            buffer.readUtf8()
        } catch (e: Exception) {
            "did not work"
        }
    }
}
于 2021-08-13T13:28:07.613 回答
2

如果您使用的是 Retrofit2 和 okhttp3,那么您需要知道 Interceptor 是按队列工作的。所以在你的其他拦截器之后添加 loggingInterceptor:

HttpLoggingInterceptor loggingInterceptor = new HttpLoggingInterceptor();
        if (BuildConfig.DEBUG)
            loggingInterceptor.setLevel(HttpLoggingInterceptor.Level.HEADERS);

 new OkHttpClient.Builder()
                .connectTimeout(60, TimeUnit.SECONDS)
                .readTimeout(60, TimeUnit.SECONDS)
                .writeTimeout(60, TimeUnit.SECONDS)
                .addInterceptor(new CatalogInterceptor(context))
                .addInterceptor(new OAuthInterceptor(context))
                .authenticator(new BearerTokenAuthenticator(context))
                .addInterceptor(loggingInterceptor)//at the end
                .build();
于 2016-09-20T08:43:19.640 回答
2

ZoomX — Android Logger Interceptor是一款出色的拦截器,可以帮助您解决问题。

于 2019-08-31T13:54:02.617 回答
1
call.request().toString();

正在发送到服务器的屏幕截图请求: 在此处输入图像描述

于 2020-12-16T07:08:48.623 回答
0

对于 3.0 之前的 android studio(使用 android motinor)
https://futurestud.io/tutorials/retrofit-2-log-requests-and-responses
https://www.youtube.com/watch?v=vazLpzE5y9M

对于 3.0 及以上版本的 android studio(使用 android profiler 作为 android monitor 被 android profiler 取代)
https://futurestud.io/tutorials/retrofit-2-analyze-network-traffic-with-android-studio-profiler

于 2018-04-29T17:50:45.717 回答
0

不是最好的方法,上面有更好的答案。这只是使用 Android Logs 进行检查的另一种方法。把它们都放在这有助于捕获解析错误。

 call.enqueue(new Callback<JsonObject>() {
                    @Override
                    public void onResponse(Call<JsonObject> call,
                                           Response<JsonObject> response) {

    // Catching Responses From Retrofit
    Log.d("TAG", "onResponseisSuccessful: "+response.isSuccessful());
    Log.d("TAG", "onResponsebody: "+response.body());
    Log.d("TAG", "onResponseerrorBody: "+response.errorBody());
    Log.d("TAG", "onResponsemessage: "+response.message());
    Log.d("TAG", "onResponsecode: "+response.code());
    Log.d("TAG", "onResponseheaders: "+response.headers());
    Log.d("TAG", "onResponseraw: "+response.raw());
    Log.d("TAG", "onResponsetoString: "+response.toString());

                    }

                    @Override
                    public void onFailure(Call<JsonObject> call,
                                          Throwable t) {

Log.d("TAG", "onFailuregetLocalizedMessage: " +t.getLocalizedMessage());
Log.d("TAG", "onFailuregetMessage: " +t.getMessage());
Log.d("TAG", "onFailuretoString: " +t.toString());
Log.d("TAG", "onFailurefillInStackTrace: " +t.fillInStackTrace());
Log.d("TAG", "onFailuregetCause: " +t.getCause());
Log.d("TAG", "onFailuregetStackTrace: " + Arrays.toString(t.getStackTrace()));
Log.d("TAG", "getSuppressed: " + Arrays.toString(t.getSuppressed()));

                    }
                });
于 2021-01-14T01:45:58.573 回答
0

请在 okHttpClient 中添加拦截器,以便在改造 android 中调用 API 时获取请求和响应日志

 private static final OkHttpClient okHttpClient = new OkHttpClient.Builder()
        .readTimeout(180, TimeUnit.SECONDS)
        .writeTimeout(180, TimeUnit.SECONDS)
        .connectTimeout(180, TimeUnit.SECONDS)
        .addInterceptor(getLoggin())
        .build();




 public static HttpLoggingInterceptor getLoggin(){
    HttpLoggingInterceptor logging = new HttpLoggingInterceptor();
    logging.setLevel(HttpLoggingInterceptor.Level.BODY);
    return logging;
}
于 2021-03-24T12:39:32.430 回答