repository·main·Indexed 13 days ago
https://github.com/lysine-dev/okhttpAn efficient, high-performance HTTP client for Java and Android supporting HTTP/2, TLS 1.3, and WebSockets. Includes MockWebServer for testing with JUnit 4 and 5 integrations, Brotli compression support, Kotlin coroutines for asynchronous calls, and DNS over HTTPS (DoH) implementation. Version 5.4.0.
The okhttp-idna-mapping-table module provides supporting tools specifically for the process of building the IDNA (Internationalized Domain Names in Applications) mapping table.
Note: This module is a build-time utility and is not required for performing IDN mappings at runtime.
OkHttp integrates with a wide ecosystem of libraries for debugging, image loading, networking, and testing. Key categories include:
curl logs.CookieJar.This module integrates OkHttp with java.net.Authenticator and java.net.CookieHandler.
Warning: This module is obsolete. For modern integration, prefer using okhttp-java-net-cookiejar instead.
CookieHandler within the java.net ecosystem. It provides the bridge necessary to integrate OkHttp's cookie management capabilities with standard Java networking components that rely on java.net.CookieHandler.OkHttpClient implements the Call.Factory interface. This abstraction makes it easier to write testable code. Instead of depending directly on a concrete OkHttpClient, your code should depend on the Call.Factory interface. This allows you to easily swap the real OkHttpClient with a mock or fake implementation during unit testing.While server.enqueue() works for a simple sequence of responses, a Dispatcher allows you to implement custom logic to decide which MockResponse to return based on the incoming RecordedRequest. This is useful for routing requests to different responses based on the URL path or other request properties.
To use a Dispatcher, extend the Dispatcher class and override the dispatch(RecordedRequest request) method, then register it with server.setDispatcher(dispatcher) (Java) or server.dispatcher = dispatcher (Kotlin).
final Dispatcher dispatcher = new Dispatcher() {
@Override
public MockResponse dispatch(RecordedRequest request) {
switch (request.getUrl().encodedPath()) {
case "/v1/login/auth/":
return new MockResponse.Builder().code(200).build();
case "/v1/check/version/":
return new MockResponse.Builder().body("version=9").build();
default:
return new MockResponse.Builder().code(404).build();
}
}
};
server.setDispatcher(dispatcher);When requesting a URL, OkHttp follows these steps:
OkHttpClient configuration to define the target webserver and static settings.Address in the ConnectionPool.Route (typically involving a DNS request to find IP addresses, proxy selection, and TLS version selection).Error Recovery: If a connection fails, OkHttp selects a different Route and retries. This allows recovery if certain IP addresses are unreachable or if a pooled connection is stale.
java.net.ProxySelector.To report upload progress (e.g., for large file uploads to services like Imgur), you can wrap a standard RequestBody with a custom implementation that uses a ProgressListener. This involves creating a ForwardingSink to intercept the write calls and track the number of bytes written against the total contentLength().
// Kotlin implementation pattern
fun interface ProgressListener {
fun update(bytesWritten: Long, contentLength: Long, done: Boolean)
}
private class ProgressRequestBody(
private val delegate: RequestBody,
private val progressListener: ProgressListener
) : RequestBody() {
// ... implementation using ForwardingSink to call progressListener.update() ...
}OkHttp provides different TLS configuration profiles to balance connectivity and security. Understanding these modes helps you choose the right security posture for your application:
Thread.interrupt() functionality. Before performing a blocking call, OkHttp checks if the thread has been interrupted. If an interruption is detected, OkHttp will throw an InterruptedIOException.OkHttp 3.14.0 introduced support for duplex calls, where request and response bodies are transmitted simultaneously. This is useful for interactive conversations (e.g., gRPC) within a single HTTP call.
To implement a duplex call, override RequestBody.isDuplex() to return true.
Important considerations for duplex calls:
writeTo(): The RequestBody.writeTo() method may retain a reference to the provided sink and hand it off to another thread to write to it after the method returns.EventListener may see requests and responses interleaved (e.g., responseHeadersStart() followed by requestBodyEnd() on the same call). These events may be triggered by different threads.RequestBody.isDuplex() and avoid accessing the request body when it is true.// Example pattern for a duplex request body
class MyDuplexBody : RequestBody() {
override fun contentType(): MediaType? = "application/octet-stream".toMediaType()
override fun isDuplex(): Boolean = true
override fun writeTo(sink: BufferedSink) {
// Implementation may hand off the sink to another thread
}
}