Ведення журналу за допомогою модернізації 2


308

Я намагаюся отримати точний JSON, який надсилається у запиті. Ось мій код:

OkHttpClient client = new OkHttpClient();
client.interceptors().add(new Interceptor(){
   @Override public com.squareup.okhttp.Response intercept(Chain chain) throws IOException {
      Request request = chain.request();
      Log.e(String.format("\nrequest:\n%s\nheaders:\n%s",
                          request.body().toString(), request.headers()));
      com.squareup.okhttp.Response response = chain.proceed(request);
      return response;
   }
});
Retrofit retrofit = new Retrofit.Builder()
   .baseUrl(API_URL)
   .addConverterFactory(GsonConverterFactory.create())
   .client(client).build();

Але це я бачу лише в журналах:

request:
com.squareup.okhttp.RequestBody$1@3ff4074d
headers:
Content-Type: application/vnd.ll.event.list+json

Як я повинен робити належний журнал даних, враховуючи видалення setLog()та setLogLevel()який ми використовували разом із Retrofit 1?

Відповіді:


697

У Retrofit 2 слід використовувати HttpLoggingInterceptor .

Додати залежність до build.gradle. Остання версія на жовтень 2019 року:

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

Створіть Retrofitоб’єкт на зразок наступного:

HttpLoggingInterceptor interceptor = new HttpLoggingInterceptor();
interceptor.setLevel(HttpLoggingInterceptor.Level.BODY);
OkHttpClient client = new OkHttpClient.Builder().addInterceptor(interceptor).build();

Retrofit retrofit = new Retrofit.Builder()
        .baseUrl("https://backend.example.com")
        .client(client)
        .addConverterFactory(GsonConverterFactory.create())
        .build();

return retrofit.create(ApiClient.class);

У разі попередження про депресію просто перейдіть setLevelна:

interceptor.level(HttpLoggingInterceptor.Level.BODY);

Наведене вище рішення дає вам повідомлення з logcat, дуже схожі на старі, встановлені

setLogLevel(RestAdapter.LogLevel.FULL)

У разіjava.lang.ClassNotFoundException :

Старіша версія модифікації може потребувати старішої logging-interceptorверсії. Ознайомтеся з розділами коментарів для детальної інформації.


30
Це було додано до OkHttp лише через 15 днів після мого запитання, приємно, що громада потребує такого швидкого впливу!
Габор

1
і вам більше не потрібно додавати сховище знімків сонатипу у свій build.gradle
Джеймс Гудвін

13
модернізуйте 2.1.0 використовуйте цей компілятор 'com.squareup.okhttp3: реєстрація-перехоплювач: 3.3.1'
jayellos

2
@jayellos Дякуємо за це. Якщо ви використовуєте версію, нижчу за версію 3.3.1, ви не отримаєте такого винятку з методу.
guydemossyrock

2
Я отримую: Не знайшов у класу "okhttp3.internal.Platform" жодної ідеї?
corlaez

35

Я познайомився з вами, як ви, і я спробував попросити автора книги Retrofit: Люблю працювати з API на Android (ось посилання ) (ні! Я не роблю для них рекламу .... але вони справді приємні хлопці :) І автор відповів мені дуже скоро, як з методом Log на Retrofit 1.9, так і з Retrofit 2.0-beta.

А ось код Retrofit 2.0-beta:

HttpLoggingInterceptor logging = new HttpLoggingInterceptor();  
// set your desired log level
logging.setLevel(Level.BODY);

OkHttpClient httpClient = new OkHttpClient();  
// add your other interceptors …

// add logging as last interceptor
httpClient.interceptors().add(logging);  // <-- this is the important line!

Retrofit retrofit = new Retrofit.Builder()  
   .baseUrl(API_BASE_URL)
   .addConverterFactory(GsonConverterFactory.create())
   .client(httpClient)
   .build();

Ось як додати метод ведення журналу за допомогою HttpLoggingInterceptor . Крім того, якщо ви читач тієї книги, про яку я згадував вище, ви можете виявити, що в ній сказано, що метод журналу із Retrofit 2.0 вже не існує - що, я попросив автора, невірно, і вони оновлять книгу наступного року, розмовляючи про це.

// Якщо ви не настільки знайомі з методом Log у Retrofit, я хотів би поділитися чимось більше.

Також слід зауважити, що ви можете вибрати деякі рівні реєстрації. Я використовую Level.BODY більшу частину часу, що дасть щось таке:

введіть тут опис зображення

Ви можете знайти майже весь персонал http всередині зображення: заголовок, вміст та відповідь тощо.

І іноді вам дійсно не потрібні всі гості для відвідування вашої вечірки: я просто хочу знати, чи успішно він підключений, що інтернет-дзвінок успішно здійснюється в рамках моєї програми Activiy & Fragmetn. Тоді ви можете скористатися Level.BASIC , який поверне щось подібне:

введіть тут опис зображення

Чи можете ви знайти код статусу 200 ОК всередині? Це все :)

Також є ще один, Level.HEADERS , який поверне лише заголовок мережі. Я звичайно інша картина тут:

введіть тут опис зображення

Ось і все з фокусом ведення журналів;)

І я хотів би поділитися тобою з підручником, про який я там багато чого навчився . У них є чудова публікація, яка розповідає про майже все, що стосується Retrofit, і вони продовжують оновлювати публікацію, в той же час приходить Retrofit 2.0. Погляньте, будь ласка, на ті роботи, які, на мою думку, заощадять вам багато часу.


Звідки походить HttpLoggingInterceptor?
Раду

5
Також для мене це не працює. httpClient.interceptors.add хоче com.squareup.okhttp.Interceptor, а не okhttp3.logging.HttpLoggingInterceptor
Раду

@Radu На якій версії Retrofit ви працюєте? У вашому градусі має бути щось подібне: compile 'com.squareup.retrofit2: retrofit: 2.0.0-beta4'
peitek

Це не буде працювати для реєстрації заголовків запитів, оскільки потрібно додати перехоплювач, як мережевий перехоплювач! Див: stackoverflow.com/a/36847027/2557258
Yazon2006

12

Ось Interceptorщо реєструє як запити, так і органи відповіді (використовуючи Timber, спираючись на приклад документів OkHttp та деяких інших відповідей SO):

public class TimberLoggingInterceptor implements Interceptor {
    @Override
    public Response intercept(Chain chain) throws IOException {
        Request request = chain.request();

        long 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));

        Response response = chain.proceed(request);

        ResponseBody responseBody = response.body();
        String responseBodyString = response.body().string();

        // now we have extracted the response body but in the process
        // we have consumed the original reponse and can't read it again
        // so we need to build a new one to return from this method

        Response newResponse = response.newBuilder().body(ResponseBody.create(responseBody.contentType(), responseBodyString.getBytes())).build();

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

        return newResponse;
    }

    private static String bodyToString(final Request request){

        try {
            final Request copy = request.newBuilder().build();
            final Buffer buffer = new Buffer();
            copy.body().writeTo(buffer);
            return buffer.readUtf8();
        } catch (final IOException e) {
            return "did not work";
        }
    }
}

6

Спробуйте це:

Request request = chain.request();
Buffer buffer = new Buffer();
request.body().writeTo(buffer);
String body = buffer.readUtf8();

Після цього в bodyJSON вас цікавить.


1
як можна роздрукувати відповідь тіла?
Гілберто Ібарра

3
@GilbertoIbarra використання String bodyString = response.body().string(); log(bodyString); response = response.newBuilder().body(ResponseBody.create(response.body().contentType(), bodyString)).build(); (Ви не можете прочитати тіло відповіді не один раз, тому вам доведеться створити нову відповідь із будівельником)
Антон Рябих,

Це милиця, яка нам більше не потрібна. Ось приклад робочих лісозаготівель: stackoverflow.com/a/36847027/2557258
Yazon2006

6

Основна проблема, з якою я зіткнувся, - це динамічне додавання заголовків та введення їх у logcat налагодження. Я намагався додати два перехоплювача. Один для входу в систему та один для додавання заголовків у ході (авторизація маркера). Проблема полягала в тому, що ми можемо .addInterceptor або .addNetworkInterceptor. Як сказав мені Джейк Уортон: "Мережеві перехоплювачі завжди йдуть після перехоплювачів додатків. Див. Https://github.com/square/okhttp/wiki/Interceptors ". Отже, ось приклад роботи з заголовками та журналами:

OkHttpClient httpClient = new OkHttpClient.Builder()
            //here we can add Interceptor for dynamical adding headers
            .addNetworkInterceptor(new Interceptor() {
                @Override
                public Response intercept(Chain chain) throws IOException {
                    Request request = chain.request().newBuilder().addHeader("test", "test").build();
                    return chain.proceed(request);
                }
            })
            //here we adding Interceptor for full level logging
            .addNetworkInterceptor(new HttpLoggingInterceptor().setLevel(HttpLoggingInterceptor.Level.BODY))
            .build();

    Retrofit retrofit = new Retrofit.Builder()
            .addConverterFactory(GsonConverterFactory.create(gsonBuilder.create()))
            .addCallAdapterFactory(RxJavaCallAdapterFactory.create())
            .client(httpClient)
            .baseUrl(AppConstants.SERVER_ADDRESS)
            .build();

5

Я не знаю, чи повернеться setLogLevel () у остаточній версії Retrofit 2.0, але поки ви можете використовувати перехоплювач для ведення журналу.

Хороший приклад можна знайти у вікі OkHttp: https://github.com/square/okhttp/wiki/Interceptors

OkHttpClient client = new OkHttpClient();
client.interceptors().add(new LoggingInterceptor());

Retrofit retrofit = new Retrofit.Builder()
        .baseUrl("http://www.yourjsonapi.com")
        .addConverterFactory(GsonConverterFactory.create())
        .client(client)
        .build();

ви або не прочитали мого запитання, або не прочитали сторінку, на яку ви посилаєтесь ... тому що LoggingInterceptor не намагається реєструвати тіло запиту (і так не вирішує мою проблему)
Gabor

Я отримую '
UnsupportedOperationException

5

Якщо ви використовуєте 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))//first
                .addInterceptor(new OAuthInterceptor(context))//second
                .authenticator(new BearerTokenAuthenticator(context))
                .addInterceptor(loggingInterceptor)//third, log at the end
                .build();

4

Для тих, хто потребує входу в Retrofit високого рівня, використовуйте такий перехоплювач

public static class LoggingInterceptor implements Interceptor {
    @Override public Response intercept(Chain chain) throws IOException {
        Request request = chain.request();
        long t1 = System.nanoTime();
        String requestLog = String.format("Sending request %s on %s%n%s",
                request.url(), chain.connection(), request.headers());
        //YLog.d(String.format("Sending request %s on %s%n%s",
        //        request.url(), chain.connection(), request.headers()));
        if(request.method().compareToIgnoreCase("post")==0){
            requestLog ="\n"+requestLog+"\n"+bodyToString(request);
        }
        Log.d("TAG","request"+"\n"+requestLog);

        Response response = chain.proceed(request);
        long t2 = System.nanoTime();

        String responseLog = String.format("Received response for %s in %.1fms%n%s",
                response.request().url(), (t2 - t1) / 1e6d, response.headers());

        String bodyString = response.body().string();

        Log.d("TAG","response"+"\n"+responseLog+"\n"+bodyString);

        return response.newBuilder()
                .body(ResponseBody.create(response.body().contentType(), bodyString))
                .build();
        //return response;
    }
}

public static String bodyToString(final Request request) {
    try {
        final Request copy = request.newBuilder().build();
        final Buffer buffer = new Buffer();
        copy.body().writeTo(buffer);
        return buffer.readUtf8();
    } catch (final IOException e) {
        return "did not work";
    }
}`

Люб’язно : https://github.com/square/retrofit/isissue/1072#


ви повинні були згадати, що ви скопіювали з github.com/square/retrofit/isissue/1072# (щоб дати кредит своєму джерелу)
Габор

Це милиця, яка нам більше не потрібна. Ось приклад робочих лісозаготівель: stackoverflow.com/a/36847027/2557258
Yazon2006

4

Котлінський кодекс

        val interceptor = HttpLoggingInterceptor()
        interceptor.level = HttpLoggingInterceptor.Level.BODY
        val client = OkHttpClient.Builder().addInterceptor(interceptor).build()
        val retrofit = Retrofit.Builder()
                .baseUrl(BASE_URL)
                .client(client)
                .addConverterFactory(GsonConverterFactory.create())
                .build()

        return retrofit.create(PointApi::class.java)

2

Ви також можете додати Stetho в Facebook і подивитися на мережеві сліди в Chrome: http://facebook.github.io/stetho/

final OkHttpClient.Builder builder = new OkHttpClient.Builder();
if (BuildConfig.DEBUG) {
    builder.networkInterceptors().add(new StethoInterceptor());
}

Потім відкрийте "chrome: // inspect" у Chrome ...


2

це створить об'єкт модернізації за допомогою журналу реєстрації. без створення окремих об’єктів.

 private static final Retrofit retrofit = new Retrofit.Builder()
            .baseUrl(BASE_URL)
            .client(new OkHttpClient().newBuilder()
                    .addInterceptor(new HttpLoggingInterceptor().setLevel(HttpLoggingInterceptor.Level.BODY))
                    .readTimeout(READ_TIMEOUT_SECONDS, TimeUnit.SECONDS)
                    .writeTimeout(WRITE_TIMEOUT_SECONDS, TimeUnit.SECONDS)
                    .connectTimeout(CONNECTION_TIMEOUT_SECONDS, TimeUnit.SECONDS)
                    .build())
            .addConverterFactory(GsonConverterFactory.create())
            .build();

2

Спочатку додайте залежність до build.gradle:

реалізація 'com.squareup.okhttp3: реєстрація-перехоплювач: 3.12.1'

Під час використання Kotlin ви можете додати протокол перехоплення таким чином:

companion object {
    val okHttpClient = OkHttpClient().newBuilder()
            .addInterceptor(HttpLoggingInterceptor().apply {
                level = HttpLoggingInterceptor.Level.BODY
            })
            .build()


    fun getRetrofitInstance(): Retrofit {
        val retrofit = Retrofit.Builder()
                .client(okHttpClient)
                .baseUrl(ScanNShopConstants.BASE_URL)
                .addCallAdapterFactory(RxJava2CallAdapterFactory.create())
                .addConverterFactory(GsonConverterFactory.create())
                .build()

        return retrofit
    }
}

2

Наступний набір коду для мене працює без проблем

Градле

// Retrofit
implementation 'com.squareup.retrofit2:retrofit:2.5.0'
implementation 'com.squareup.retrofit2:converter-gson:2.5.0'
implementation 'com.squareup.okhttp3:logging-interceptor:3.12.1'

RetrofitClient

HttpLoggingInterceptor logging = new HttpLoggingInterceptor();
logging.setLevel(HttpLoggingInterceptor.Level.BODY);

OkHttpClient client = new OkHttpClient.Builder()
        .addInterceptor(logging)
        .build();

retrofit = new Retrofit.Builder()
        .baseUrl(BASE_URL)
        .addConverterFactory(GsonConverterFactory.create())
        .client(client)
        .build();

Ви також можете перевірити результати, перейшовши на вкладку Profiler внизу Android Studio, натиснувши + підписати, щоб почати новий сеанс, а потім виберіть потрібний шип у "Мережі". Там можна дістати все, але це громіздко і повільно. Будь ласка, дивіться зображення нижче.

введіть тут опис зображення


1

Найкращий спосіб зробити це правильно в Retrofit 2 - додати перехоплювач реєстратора як мережу. Інтерцептор, це виведе друк мережевих заголовків і ваших власних заголовків. Важливо - пам’ятати, що перехоплювач працює як стек, і будьте впевнені, додайте реєстратор наприкінці всіх.

OkHttpClient.Builder builder = new OkHttpClient.Builder();
builder.addInterceptor(new MyCustomInterceptor());
builder.connectTimeout(60, TimeUnit.SECONDS);
builder.readTimeout(60, TimeUnit.SECONDS);
builder.writeTimeout(60, TimeUnit.SECONDS);
// important line here
builder.addNetworkInterceptor(LoggerInterceptor());

1

Більшість відповідей тут стосується майже всього, крім цього інструменту, одного із найкрутіших способів побачити журнал.

Це Стето Facebook . Це чудовий інструмент для контролю / реєстрації мережевого трафіку вашого додатка на Google Chrome . Ви також можете знайти тут, на Github.

введіть тут опис зображення


1

для Retrofit 2.0.2 код схожий

   **HttpLoggingInterceptor logging = new HttpLoggingInterceptor();
        logging.setLevel(HttpLoggingInterceptor.Level.BODY);
        OkHttpClient.Builder httpClient=new OkHttpClient.Builder();
        httpClient.addInterceptor(logging);**


        if (retrofit == null) {
            retrofit = new Retrofit.Builder()
                    .baseUrl(BASE_URL)
                    .addConverterFactory(GsonConverterFactory.create())
                    **.client(httpClient.build())**
                    .build();
        }

1

Ось простий спосіб відфільтрувати параметри запиту / відповіді з журналів, використовуючи HttpLoggingInterceptor:

// Request patterns to filter
private static final String[] REQUEST_PATTERNS = {
    "Content-Type",
};
// Response patterns to filter
private static final String[] RESPONSE_PATTERNS = {"Server", "server", "X-Powered-By", "Set-Cookie", "Expires", "Cache-Control", "Pragma", "Content-Length", "access-control-allow-origin"};

// Log requests and response
HttpLoggingInterceptor interceptor = new HttpLoggingInterceptor(new HttpLoggingInterceptor.Logger() {
    @Override
    public void log(String message) {

        // Blacklist the elements not required
        for (String pattern: REQUEST_PATTERNS) {
            if (message.startsWith(pattern)) {
                return;
            }
        }
        // Any response patterns as well...
        for (String pattern: RESPONSE_PATTERNS) {
            if (message.startsWith(pattern)) {
                return;
            }
        }
        Log.d("RETROFIT", message);
    }
});
interceptor.setLevel(HttpLoggingInterceptor.Level.BODY);

Ось повна суть:

https://gist.github.com/mankum93/179c2d5378f27e95742c3f2434de7168


1

Я також застряг у подібній ситуації, setLevel()метод не прийшов, коли я намагався викликати це примірником HttpLoggingInterceptor, як це:

HttpLoggingInterceptor loggingInterceptor = new HttpLoggingInterceptor();
loggingInterceptor.setLevel(HttpLoggingInterceptor.Level.BODY);

Ось як я це вирішив, щоб створити журнал для Retrofit2,

Я думаю, ви додали залежність,

implementation "com.squareup.okhttp3:logging-interceptor:4.7.2"

Для останньої версії, яку ви можете перевірити, перейдіть за цим посиланням:

https://github.com/square/okhttp/tree/master/okhttp-logging-interceptor )

Тут вони також пояснили, як додати.

Я створив клас з ім'ям AddLoggingInterceptor, ось мій код,

public class AddLoggingInterceptor {

    public static OkHttpClient setLogging(){
        HttpLoggingInterceptor loggingInterceptor = new HttpLoggingInterceptor();
        loggingInterceptor.setLevel(HttpLoggingInterceptor.Level.BODY);

        OkHttpClient okHttpClient = new OkHttpClient.Builder()
                .addInterceptor(loggingInterceptor)
                .build();

        return okHttpClient;
    }
}

Тоді, де ми створюємо свою модернізацію,

 public static Retrofit getRetrofitInstance() {
    if (retrofit == null) {
        retrofit = new retrofit2.Retrofit.Builder()
                .baseUrl(BASE_URL)
                .addConverterFactory(GsonConverterFactory.create())
                .client(AddLoggingInterceptor.setLogging()) // here the method is called inside client() method, with the name of class, since it is a static method.
                .build();
    }
    return retrofit;
}

Тепер ви можете бачити журнал, сформований у вашій Android Studio, можливо, вам потрібно буде шукати okHttpпроцес фільтрації. Це працювало для мене. Якщо є якісь проблеми, ви можете мені надіслати тут текст.


0

Я знайшов спосіб для друку увійти Retrofit

OkHttpClient okHttpClient = new OkHttpClient.Builder()
            .addInterceptor(new Interceptor() {
                @Override
                public Response intercept(Chain chain) throws IOException {
                    Request request = chain.request();
                    if (BuildConfig.DEBUG) {
                        Log.e(getClass().getName(), request.method() + " " + request.url());
                        Log.e(getClass().getName(), "" + request.header("Cookie"));
                        RequestBody rb = request.body();
                        Buffer buffer = new Buffer();
                        if (rb != null)
                            rb.writeTo(buffer);
                        LogUtils.LOGE(getClass().getName(), "Payload- " + buffer.readUtf8());
                    }
                    return chain.proceed(request);
                }
            })
            .readTimeout(60, TimeUnit.SECONDS)
            .connectTimeout(60, TimeUnit.SECONDS)
            .build();

            iServices = new Retrofit.Builder()
                    .baseUrl("Your Base URL")
                    .client(okHttpClient)
                    .addConverterFactory(GsonConverterFactory.create())
                    .build()
                    .create(Your Service Interface .class);

Працює для мене.


0

Перехоплювач Retrofit - це відмінна функція, яка дозволяє вам працювати з http-запитами. Їх існує два типи: прикладні та мережеві перехоплювачі.

Я б рекомендував використовувати, Charles Web Debugging Proxy Applicationякщо вам потрібно реєструвати ваші запити / відповіді. Вихід дуже схожий на Stetho, але це більш потужний інструмент, який вам не потрібно додавати як залежність до програми


-11

ей, хлопці, я вже знаходжу рішення:

  public static <T> T createApi(Context context, Class<T> clazz, String host, boolean debug) {
    if (singleton == null) {
        synchronized (RetrofitUtils.class) {
            if (singleton == null) {
                RestAdapter.Builder builder = new RestAdapter.Builder();
                builder
                        .setEndpoint(host)
                        .setClient(new OkClient(OkHttpUtils.getInstance(context)))
                        .setRequestInterceptor(RequestIntercepts.newInstance())
                        .setConverter(new GsonConverter(GsonUtils.newInstance()))
                        .setErrorHandler(new ErrorHandlers())
                        .setLogLevel(debug ? RestAdapter.LogLevel.FULL : RestAdapter.LogLevel.NONE)/*LogLevel.BASIC will cause response.getBody().in() close*/
                        .setLog(new RestAdapter.Log() {
                            @Override
                            public void log(String message) {
                                if (message.startsWith("{") || message.startsWith("["))
                                    Logger.json(message);
                                else {
                                    Logger.i(message);
                                }
                            }
                        });
                singleton = builder.build();
            }
        }
    }
    return singleton.create(clazz);
}

Набір зворотних дзвінків setLog може вводити кожен журнал
Vihuela Yao,

1
для цього використовується оновлення v1, а не v2
Габор
Використовуючи наш веб-сайт, ви визнаєте, що прочитали та зрозуміли наші Політику щодо файлів cookie та Політику конфіденційності.
Licensed under cc by-sa 3.0 with attribution required.