When to call response.body().close()

Question

I have an Android SDK that uses OkHttp. In my sample app that uses my SDK everything works fine. One of my users however, when StrictMode is turned on, is getting the following java.lang.Throwable: Explicit termination method 'close' not called. I have tried replicating this in my own app with StrictMode on and don't get this error.

I understand that I should be calling response.body().close() but I'm still a little confused about why this isn't happening in my app. The stack trace that he sent me only has my classes in it so it doesn't seem like anything in his code is causing it.

Also of note is that only one of the request my SDK makes actually has the response read. But that is not the request my user says is causing the exception.

Is there anything else that could be causing this?

When should I call .close()? Would calling it immediately after calling execute() be advisable? Would closing the body prevent it from being read in the future?

ordonezalex · Answer 1 · 2020-11-06T18:00:21.890

24

You should always call close(). From OkHttp's source:

The caller may read the response body with the response's Response.body() method. To facilitate connection recycling, callers should always close the response body.

You should probably call close() as soon as you're done getting what you need from the response. Store it in a variable, then close the ResponseBody.

edited Nov 06 '20 at 18:00

answered Aug 18 '15 at 19:20

ordonezalex

2,645
1
20
33

7

Almost always - `string()` and `bytes()` close themselves – Itai Hanski Jul 12 '16 at 11:00
1

@ItaiHanski, are you sure? I found no evidence of it in the code. – Aleksandar Stojadinovic Sep 09 '16 at 13:57
2

@AleksandarStojadinovic Yeah. Check out the documentation on [`ResponseBody`](https://github.com/square/okhttp/blob/master/okhttp/src/main/java/okhttp3/ResponseBody.java#L51). Every method is required to call `close()` except for `string()` and `bytes()` – Itai Hanski Sep 13 '16 at 09:57
@ItaiHanski, You are right, sorry. Who knows which code was I looking... – Aleksandar Stojadinovic Sep 13 '16 at 10:08
4

QUESTION If the okhttp interface were running async, does the `close()`method also end the thread? – Jupiter Jun 01 '17 at 23:27

When to call response.body().close()

1 Answers1