OkHttp: A Smarter HTTP Client for Your App

WHY IT EXISTS Modern applications exchange data and media over HTTP. Doing this efficiently makes your app feel faster and saves user bandwidth. OkHttp was created to be an HTTP client that is efficient, secure, and resilient by default, handling network complexities automatically.

THE MENTAL MODEL Think of OkHttp as a smart, well-behaved user agent (like a modern web browser) for your application's networking layer. It handles the complex, low-level details of making fast, reliable, and secure network requests so you don't have to.

HOW IT WORKS OkHttp improves performance and reliability through several built-in mechanisms. First, it supports HTTP/2, allowing multiple requests to the same host to share a single socket. If HTTP/2 isn't available, it uses connection pooling to reduce latency. Second, it transparently uses GZIP to shrink download sizes and caches responses to avoid unnecessary network calls for repeat requests. Third, it perseveres through network issues by silently recovering from common connection problems and trying alternate IP addresses if a service provides them. It also supports modern security features like TLS 1.3.

WHEN TO USE IT Use OkHttp in any Android (API 21+) or Java 8+ application that needs to make HTTP requests. It's a robust, general-purpose client suitable for fetching data from APIs, downloading files, and posting data to servers. Its fluent, immutable request/response API makes it easy to use for both synchronous blocking calls and asynchronous calls with callbacks.

WHEN NOT TO USE IT OkHttp is not the right tool if you need to violate HTTP specifications to communicate with a non-compliant server. For example, it strictly disallows sending a GET request with a body. If you require extensive customizability to send invalid requests, you'll need a different library. Also, the core library is not for very old Android (pre-5.0) or Java (pre-8.0) projects, though an older, unsupported branch exists.

ONE CANONICAL EXAMPLE To fetch data from a URL, you first create a single, shared instance of OkHttpClient. Then, you build a Request object using its fluent builder, specifying the URL. You use the client to create a newCall with your request and then execute it. This returns a Response object, from which you can access the response body, headers, and status code. The basic flow looks like: client.newCall(new Request.Builder().url(someUrl).build()).execute().