square/okhttp (com.squareup.okhttp3:logging-interceptor)
2025年10月09日
-
Fix: Don't crash when calling Socket.shutdownOutput() or shutdownInput() on an SSLSocket
on Android API 21 through 23. This method throws an UnsupportedOperationException, so we now
catch that and close the underlying stream instead.
-
Upgrade: [Okio 3.16.1][okio_3_16_1].
2025年10月07日
-
New: Support [HTTP 101] responses with Response.socket. This mechanism is only supported on
HTTP/1.1. We also reimplemented our websocket client to use this new mechanism.
-
New: The okhttp-zstd module negotiates [Zstandard (zstd)][zstd] compression with servers that
support it. It integrates a new (unstable) [ZSTD-KMP] library, also from Square. Enable it like
this:
val client = OkHttpClient.Builder()
.addInterceptor(CompressionInterceptor(Zstd, Gzip))
.build()
-
New: Support the QUERY HTTP method. You will need to set the Request.cacheUrlOverride
property to cache calls made with this method. The RequestBody.sha256() may be helpful here;
use it to compose a cache URL from the query body.
-
New: Publish events when calls must wait to execute. EventListener.dispatcherQueueStart()
is invoked when a call starts waiting, and dispatcherQueueEnd() is invoked when it's done.
-
New: Request.toCurl() returns a copy-pasteable [curl] command consistent with Chrome’s and
Firefox’s ‘copy as cURL’ features.
-
New: Support [JPMS]. We replaced our Automatic-Module-Name metadata with proper
module-info.java files.
-
Fix: Recover gracefully when worker threads are interrupted. When we introduced fast fallback in
OkHttp 5.0, we started using background threads while connecting. Sadly that code didn't handle
interruptions well. This is now fixed.
-
Upgrade: [Kotlin 2.2.20][kotlin_2_2_20].
-
Upgrade: [Okio 3.16.0][okio_3_16_0].
2025年07月07日
-
New: Response.peekTrailers(). When we changed Response.trailers() to block instead of
throwing in 5.0.0, we inadvertently removed the ability for callers to peek the trailers
(by catching the IllegalStateException if they weren't available). This new API restores that
capability.
-
Fix: Don't crash on trailers() if the response doesn't have a body. We broke [Retrofit] users
who read the trailers on the raw() OkHttp response, after its body was decoded.
2025年07月02日
This is our first stable release of OkHttp since 2023. Here's the highlights if you're upgrading
from OkHttp 4.x:
OkHttp is now packaged as separate JVM and Android artifacts. This allows us to offer
platform-specific features and optimizations. If your build system handles [Gradle module metadata],
this change should be automatic.
MockWebServer has a new coordinate and package name. We didn’t like that our old artifact
depends on JUnit 4 so the new one doesn’t. It also has a better API built on immutable values. (We
intend to continue publishing the old okhttp3.mockwebserver artifact so there’s no urgency to
migrate.)
| Coordinate |
Package Name |
Description |
| com.squareup.okhttp3:mockwebserver3:5.0.0 |
mockwebserver3 |
Core module. No JUnit dependency! |
| com.squareup.okhttp3:mockwebserver3-junit4:5.0.0 |
mockwebserver3.junit4 |
Optional JUnit 4 integration. |
| com.squareup.okhttp3:mockwebserver3-junit5:5.0.0 |
mockwebserver3.junit5 |
Optional JUnit 5 integration. |
| com.squareup.okhttp3:mockwebserver:5.0.0 |
okhttp3.mockwebserver |
Obsolete. Depends on JUnit 4. |
OkHttp now supports Happy Eyeballs ([RFC 8305][rfc_8305]) for IPv4+IPv6 networks. It attempts
both IPv6 and IPv4 connections concurrently, keeping whichever connects first.
We’ve improved our Kotlin APIs. You can skip the builder:
val request = Request(
url = "https://cash.app/".toHttpUrl(),
)
OkHttp now supports [GraalVM].
Here’s what has changed since 5.0.0-alpha.17:
- Upgrade: [Okio 3.15.0][okio_3_15_0].
- Upgrade: [Kotlin 2.2.0][kotlin_2_2_0].
- Fix: Don't crash with a
NoSuchMethodError when using OkHttp with the Sentry SDK.
- Fix: Retain the query data in the old
okhttp3.mockwebserver.RecordedRequest.path property. We
inadvertently changed this behavior when we introduced the mockwebserver3 API.
2025年06月29日
This release stabilizes many APIs for the imminent OkHttp 5.0.0 release.
-
New: TrailersSource, a public API for HTTP trailers. Production callers shouldn't need this
as the API to read response trailers is unchanged. Testers may use this new stable API to
supply trailers for a Response.
-
New: Path.asRequestBody() is now a non-experimental API.
-
New: FileDescriptor.toRequestBody() is now a non-experimental API.
-
New: Stop using experimental coroutines APIs in our okhttp-coroutines artifact.
-
Breaking: Move gzip from RequestBody to Request.Builder. This new API handles both
compressing the request body and also adding the corresponding Content-Encoding header. Note
that this function is sensitive to when it is called: the response body must be supplied before
it can be compressed.
-
Breaking: Remove AddressPolicy, AsyncDns, and ConnectionListener from the public API. We
intend to ship a public API for these features, but we don't want to hold OkHttp 5.0.0 until
those APIs are stable.
-
Fix: Change MockWebServer.close() to cancel ongoing calls that are blocked on a delay.
-
Upgrade: [Okio 3.13.0][okio_3_13_0].
This release also stabilizes many APIs in the mockwebserver3 artifact that's new in 5.0.
-
Breaking: RecordedRequest.body is now nullable. Null is used when the request does not have a
body.
-
Breaking: RecordedRequest.chunkSizes is now nullable. Null is used when the request does not
use chunked encoding. This is different from an empty list - that indicates the request is
chunked but has no data.
-
Breaking: Replace SocketPolicy with a new type, SocketEffect. It splits triggers (request
start, response body, etc.) from effects (closing the socket, closing the stream, etc.).
-
Breaking: Rename RecordedRequest.sequenceNumber to exchangeIndex and introduce
connectionIndex on that type. These properties may be useful when testing features like
connection reuse.
-
Breaking: Replace our parameters-based JUnit 5 extension with a new annotation, @StartStop.
Put this annotation on a MockWebServer property and the extension will start it before your
test executes and stop it after it completes. No further configuration is required.
@​StartStop val server = MockWebServer()
-
Breaking: Don't automatically start MockWebServer after calls to accessors like port. Now
these accessors will throw an IllegalStateException if the service has not yet been started.
-
Breaking: Rename RecordedRequest.path to RecordedRequest.target. (This property is
sometimes a path, but it can also be a path and query, or a full URL.)
-
Breaking: Decompose the RecordedRequest.requestLine into three properties, method, target,
and version. This better suits HTTP/2 where the request line had to be synthesized from
component headers.
-
Breaking: Change RecordedRequest.body from a mutable Buffer to an immutable ByteString.
-
Breaking: Adopt Okio's new Socket interface for MockResponse.socketHandler.
Note that any Breaking changes above impact only APIs introduced in earlier 5.0.0-alpha releasees.
We don't break binary compatibility with non-alpha APIs.
2025年05月29日
- Fix: The previous release would crash when running on Robolectric. We didn't anticipate
running our Android artifact on the JVM platform!
2025年05月28日
This release introduces separate JVM and Android artifacts. Until now, we've distributed OkHttp
as a JVM library that detects Android capabilities at runtime, but that doesn't offer
Android-specific APIs. With this release we're starting to publish OkHttp as an AAR for Android
users in addition to our existing JAR for JVM users.
This first Android-specific artifact adopts Android's assets mechanism to embed the public suffix
data. We will build more Android integration in future releases.
The okhttp-android artifact first introduced in 5.0.0-alpha.7 is no longer available:
- The
AndroidAsyncDns class moved to the okhttp artifact.
- The
AndroidLogging class is no longer necessary. LoggingEventListener and
HttpLoggingInterceptor write to logcat by default.
The rest of this release is our highest-quality release yet. Though we continue to use the word
alpha in the version name, the only unstable thing in it is some non-final APIs tagged
@ExperimentalOkHttpApi. You can safely use this release in production.
-
Fix: Attempt to read the response even if sending the request failed. This makes it possible
to handle response statuses like HTTP/1.1 431 "Request Header Fields Too Large.
-
Fix: Handle multiple 1xx responses.
-
Fix: Address a performance bug in our internal task runner. We had a race condition that could
result in it OkHttp starting a thread for each queued task, even when a single thread could run
all of them.
-
Fix: Address a performance bug in MultipartReader. We were scanning the entire input stream
for a delimiter when we only needed to scan enough to return a result.
-
Fix: Don't double-compress the public suffix database. OkHttp is usually distributed in a
compressed file (like a JAR or APK), so compressing its internal data was redundant.
-
Fix: Call ProxySelector.connectFailed() when a connection's initial TCP handshake fails.
-
Fix: Change the signature of Dispatcher to accept a nullable ExecutorService. Changing this
parameter to be non-null was an unintended signature change in OkHttp 4.0.
-
New: EventListener.retryDecision() is called each time a request fails with an IOException.
It notifies your listener if OkHttp will retry.
-
New: EventListener.followUpDecision() is called each time a response is received. It notifies
your listener if OkHttp has decided to make a follow-up request. Some common follow-ups are
authentication challenges and redirects.
-
New: Handy constants for Headers.EMPTY, RequestBody.EMPTY, and ResponseBody.EMPTY.
-
New: OkHttp now calls StrictMode.noteSlowCall() when initializing TLS on Android. Use
StrictMode to detect if your OkHttpClient is being initialized on the main thread.
-
Upgrade: [Okio 3.12.0][okio_3_12_0].
-
Upgrade: [Kotlin 2.1.21][kotlin_2_1_21].
-
Upgrade: [kotlinx.coroutines 1.10.2][coroutines_1_10_2]. This is used by the optional
okhttp-coroutines artifact.
-
Upgrade: [AndroidX Startup 1.2.0][startup_1_2_0]. The Android variant of the okhttp artifact
now depends on this. This is a new dependency.
-
Upgrade: [AndroidX Annotation 1.9.1][annotation_1_9_1]. As above, the Android variant of the
okhttp artifact now depends on this. This is also a new dependency.
2024年04月17日
-
Breaking: Move coroutines extensions to okhttp3.coroutines. Previously this artifact shared the
okhttp3 package name with our core module, which is incompatible with the Java Platform Module
System.
-
Fix in okhttp-coroutines: Publish a valid artifact. The coroutines JAR file in 5.0.0-alpha.13
was corrupt and should not be used.
2024年04月16日
-
Breaking: Tag unstable new APIs as @ExperimentalOkHttpApi. We intend to release OkHttp 5.0
without stabilizing these new APIs first.
Do not use these experimental APIs in modules that may be executed using a version of OkHttp
different from the version that the module was compiled with. Do not use them in published
libraries. Do not use them if you aren't willing to track changes to them.
-
Breaking: Drop support for Kotlin Multiplatform.
We planned to support multiplatform in OkHttp 5.0, but after building it, we weren't happy with
the implementation trade-offs. We can't use our HTTP client engine on Kotlin/JS, and we weren't
prepared to build a TLS API for Kotlin/Native.
We'd prefer a multiplatform HTTP client API that's backed by OkHttp on Android and JVM, and
other engines on other platforms. [Ktor] does this pretty well today!
-
Breaking: Use kotlin.time.Duration in APIs like OkHttpClient.Builder.callTimeout(). This
update also drops support for the DurationUnit functions introduced in earlier alpha releases
of OkHttp 5.
-
Breaking: Reorder the parameters in the Cache constructor that was introduced in 5.0.0-alpha.3.
-
New: Request.Builder.cacheUrlOverride() customizes the cache key used for a request. This can
be used to make canonical URLs for the cache that omit insignificant query parameters or other
irrelevant data.
This feature may be used with POST requests to cache their responses. In such cases the
request body is not used to determine the cache key, so you must manually add cache-relevant
data to the override URL. For example, you could add a request-body-sha256 query parameter so
requests with the same POST data get the same cache entry.
-
New: HttpLoggingInterceptor.redactQueryParams() configures the query parameters to redact
in logs. For best security, don't put sensitive information in query parameters.
-
New: ConnectionPool.setPolicy() configures a minimum connection pool size for a target
address. Use this to proactively open HTTP connections.
Connections opened to fulfill this policy are subject to the connection pool's
keepAliveDuration but do not count against the pool-wide maxIdleConnections limit.
This feature increases the client's traffic and the load on the server. Talking to your server's
operators before adopting it.
-
New in okhttp-android: HttpLoggingInterceptor.androidLogging() and
LoggingEventListener.androidLogging() write HTTP calls or events to Logcat.
-
New: OkHttpClient.webSocketCloseTimeout configures how long a web socket connection will wait
for a graceful shutdown before it performs an abrupt shutdown.
-
Fix: Honor RequestBody.isOneShot() in MultipartBody
-
Fix in okhttp-coroutines: Don't leak response bodies in executeAsync(). We had a bug where
we didn't call Response.close() if the coroutine was canceled before its response was
returned.
-
Upgrade: [Okio 3.9.0][okio_3_9_0].
-
Upgrade: [Kotlin 1.9.23][kotlin_1_9_23].
-
Upgrade: [Unicode® IDNA 15.1.0][idna_15_1_0]
2023年12月17日
We took too long to cut this release and there's a lot of changes in it. We've been busy.
Although this release is labeled alpha, the only unstable thing in it is our new APIs. This
release has many critical bug fixes and is safe to run in production. We're eager to stabilize our
new APIs so we can get out of alpha.
-
New: Support Java 21's virtual threads (‘OpenJDK Project Loom’). We changed OkHttp's internals
to use Lock and Condition instead of synchronized for best resource utilization.
-
New: Switch our Internationalized Domain Name (IDN) implementation to [UTS #46 Nontransitional
Processing][uts46]. With this fix, the ß code point no longer maps to ss. OkHttp now embeds
its own IDN mapping table in the library.
-
New: Prefer the client's configured precedence order for TLS cipher suites. (OkHttp used to
prefer the JDK’s precedence order.) This change may cause your HTTP calls to negotiate a
different cipher suite than before! OkHttp's defaults cipher suites are selected for good
security and performance.
-
New: ConnectionListener publishes events for connects, disconnects, and use of pooled
connections.
-
Fix: Immediately update the connection's flow control window instead of waiting for the
receiving stream to process it.
This change may increase OkHttp's memory use for applications that make many concurrent HTTP
calls and that can receive data faster than they can process it. Previously, OkHttp limited
HTTP/2 to 16 MiB of unacknowledged data per connection. With this fix there is a limit of 16 MiB
of unacknowledged data per stream and no per-connection limit.
-
Fix: Don't close a Deflater while we're still using it to compress a web socket message. We
had a severe bug where web sockets were closed on the wrong thread, which caused
NullPointerException crashes in Deflater.
-
Fix: Don't crash after a web socket fails its connection upgrade. We incorrectly released
the web socket's connections back to the pool before their resources were cleaned up.
-
Fix: Don't infinite loop when a received web socket message has self-terminating compressed
data.
-
Fix: Don't fail the call when the response code is ‘HTTP 102 Processing’ or ‘HTTP 103 Early
Hints’.
-
Fix: Honor interceptors' changes to connect and read timeouts.
-
Fix: Recover gracefully when a cached response is corrupted on disk.
-
Fix: Don't leak file handles when a cache disk write fails.
-
Fix: Don't hang when the public suffix database cannot be loaded. We had a bug where a failure
reading the public suffix database would cause subsequent reads to hang when they should have
crashed.
-
Fix: Avoid InetAddress.getCanonicalHostName() in MockWebServer. This avoids problems if the
host machine's IP address has additional DNS registrations.
-
New: Create a JPMS-compatible artifact for JavaNetCookieJar. Previously, multiple OkHttp
artifacts defined classes in the okhttp3 package, but this is forbidden by the Java module
system. We've fixed this with a new package (okhttp3.java.net.cookiejar) and a new artifact,
com.squareup.okhttp3:okhttp-java-net-cookiehandler. (The original artifact now delegates to
this new one.)
implementation("com.squareup.okhttp3:okhttp-java-net-cookiehandler:5.0.0-alpha.12")
-
New: Cookie.sameSite determines whether cookies should be sent on cross-site requests. This
is used by servers to defend against Cross-Site Request Forgery (CSRF) attacks.
-
New: Log the total time of the HTTP call in HttpLoggingInterceptor.
-
New: OkHttpClient.Builder now has APIs that use kotlin.time.Duration.
-
New: mockwebserver3.SocketPolicy is now a sealed interface. This is one of several
backwards-incompatible API changes that may impact early adopters of this alpha API.
-
New: mockwebserver3.Stream for duplex streams.
-
New: mockwebserver3.MockResponseBody for streamed response bodies.
-
New: mockwebserver3.MockResponse is now immutable, with a Builder.
-
New: mockwebserver3.RecordedRequest.handshakeServerNames returns the SNI (Server Name
Indication) attribute from the TLS handshake.
-
Upgrade: [Kotlin 1.9.21][kotlin_1_9_21].
-
Upgrade: [Okio 3.7.0][okio_3_7_0].
2022年12月24日
- New: Enable fast fallback by default. It's our implementation of Happy Eyeballs,
[RFC 8305][rfc_8305]. Disable with OkHttpClient.Builder.fastFallback(false).
- Fix: Don't log response bodies for server-sent events.
- Fix: Skip early hints (status code 103) responses.
- Fix: Don't log sensitive headers in
Request.toString().
- Fix: Don't crash when the dispatcher's
ExecutorService is shutdown with many
calls still enqueued.
- Upgrade: [GraalVM 22][graalvm_22].
- Upgrade: [Kotlin 1.7.10][kotlin_1_7_10].
2022年06月26日
- Fix: Configure the multiplatform artifact (
com.squareup.okhttp3:okhttp:3.x.x) to depend on the
JVM artifact (com.squareup.okhttp3:okhttp-jvm:3.x.x) for Maven builds. This should work-around
an issue where Maven doesn't interpret Gradle metadata.
- Fix: Make another attempt at supporting Kotlin 1.5.31 at runtime. We were crashing on
DurationUnit which was a typealias in 1.5.x.
- Upgrade: [Okio 3.2.0][okio_3_2_0].
2022年06月16日
- New: Enforce label length limits in URLs.
HttpUrl now rejects URLs whose domains aren't valid.
This includes overly-long domain names (longer than 253 characters), overly-long labels (more
than 63 characters between dots), and empty labels.
- New: Don't include the
Content-Length header in multipart bodies. Servers must delimit
OkHttp's request bodies using the boundary only. (This change makes OkHttp more consistent with
browsers and other HTTP clients.)
- New: Drop the
tunnelProxy argument in MockWebServer.useHttps(). This change only impacts
the OkHttp 5.x API which uses the mockwebserver3 package.
- Fix: Don't call
toDuration() which isn't available in kotlin-stdlib 1.4.
2022年06月08日
-
Fix: Change how H2_PRIOR_KNOWLEDGE works with HTTP proxies. Previously OkHttp assumed the
proxy itself was a prior knowledge HTTP/2 server. With this update, OkHttp attempts a CONNECT
tunnel just as it would with HTTPS. For prior knowledge with proxies OkHttp's is now consistent
with these curl arguments:
curl \
--http2-prior-knowledge \
--proxy localhost:8888 \
--proxytunnel \
http://squareup.com/robots.txt
-
Fix: Support executing OkHttp on kotlin-stdlib versions as old as 1.4. The library still builds
on up-to-date Kotlin releases (1.6.21) but no longer needs that version as a runtime dependency.
This should make it easier to use OkHttp in Gradle plugins.
-
Fix: Don't start the clock on response timeouts until the request body is fully transmitted.
This is only relevant for duplex request bodies, because they are written concurrently when
reading the response body.
-
New: MockResponse.inTunnel() is a new mockwebserver3 API to configure responses that are
served while creating a proxy tunnel. This obsoletes both the tunnelProxy argument on
MockWebServer and the UPGRADE_TO_SSL_AT_END socket option. (Only APIs on mockwebserver3
are changed; the old okhttp3.mockwebserver APIs remain as they always have been.
2022年04月26日
This release introduces new Kotlin-friendly APIs. When we migrated OkHttp from Java to Kotlin in
OkHttp 4.0, we kept our Java-first APIs. With 5.0 we're continuing to support Java and adding
additional improvements for Kotlin users. In this alpha we're excited to skip-the-builder for
requests and remove a common source of non-null assertions (!!) on the response body.
The alpha releases in the 5.0.0 series have production-quality code and an unstable API. We expect
to make changes to the APIs introduced in 5.0.0-alpha.X. These releases are safe for production use
and 'alpha' strictly signals that we're still experimenting with some new APIs. If you're eager for
the fixes or features below, please upgrade.
-
New: Named and default parameters constructor for Request:
val request = Request(
url = "https://cash.app/".toHttpUrl(),
)
-
New: Response.body is now non-null. This was generally the case in OkHttp 4.x, but the Kotlin
type declaration was nullable to support rare cases like the body on Response.cacheResponse,
Response.networkResponse, and Response.priorResponse. In such cases the body is now
non-null, but attempts to read its content will fail.
-
New: Kotlin-specific APIs for request tags. Kotlin language users can lookup tags with a type
parameter only, like request.tag<MyTagClass>().
-
New: MockWebServer has improved support for HTTP/1xx responses. Once you've migrated to the new
mockwebserver3 package, there's a new field, MockResponse.informationalResponses.
-
Fix: Don't interpret trailers as headers after an HTTP/100 response. This was a bug only when
the HTTP response body itself is empty.
-
Fix: Don't crash when a fast fallback call has both a deferred connection and a held connection.
-
Fix: OkHttpClient no longer implements Cloneable. It never should have; the class is
immutable. This is left over from OkHttp 2.x (!) when that class was mutable. We're using the
5.x upgrade as an opportunity to remove very obsolete APIs.
-
Fix: Recover gracefully when Android's NativeCrypto crashes with "ssl == null". This occurs
when OkHttp retrieves ALPN state on a closed connection.
-
Upgrade: [Kotlin 1.6.21][kotlin_1_6_21].
-
Upgrade: [Okio 3.1.0][okio_3_1_0].
2022年03月14日
- Fix: Don't attempt to close pooled connections. We saw occasional fast fallback calls crash in
the previous alpha due to an unexpected race.
2022年02月21日
- Fix: Don't include [Assertk][assertk] in OkHttp's production dependencies. This regression was
introduced in the 5.0.0-alpha.4 release.
- Fix: Don't ask
Dns implementations to resolve strings that are already IP addresses.
- Fix: Change fast fallback to race TCP handshakes only. To avoid wasted work, OkHttp will not
attempt multiple TLS handshakes for the same call concurrently.
- Fix: Don't crash loading the public suffix database in GraalVM native images. The function
HttpUrl.topPrivateDomain() uses a resource file to identify private domains, but we didn't
include this file on GraalVM.
2022年02月01日
This release introduces fast fallback to better support mixed IPv4+IPv6 networks. Fast fallback
is what we're calling our implementation of Happy Eyeballs, [RFC 8305][rfc_8305]. With this
feature OkHttp will attempt both IPv6 and IPv4 connections concurrently, keeping whichever connects
first. Fast fallback gives IPv6 connections a 250 ms head start so IPv6 is preferred on networks
where it's available.
To opt-in, configure your OkHttpClient.Builder:
OkHttpClient client = new OkHttpClient.Builder()
.fastFallback(true)
.build();
- New: Change the build from Kotlin-JVM to Kotlin-multiplatform (which includes JVM). Both
native and JavaScript platforms are unstable preview releases and subject to
backwards-incompatible changes in forthcoming releases.
- Fix: Don't crash loading the public suffix database resource in obfuscated builds.
- Fix: Don't silently ignore calls to
EventSource.cancel() made from
EventSourceListener.onOpen().
- Fix: Enforce the max intermediates constraint when using pinned certificates with Conscrypt.
This impacts Conscrypt when the server's presented certificates form both a trusted-but-unpinned
chain and an untrusted-but-pinned chain.
- Upgrade: [Kotlin 1.6.10][kotlin_1_6_10].
2021年11月22日
- Fix: Change
Headers.toString() to redact authorization and cookie headers.
- Fix: Don't do DNS to get the hostname for
RecordedRequest.requestUrl. This was doing a DNS
lookup for the local hostname, but we really just wanted the Host header.
- Fix: Don't crash with a
InaccessibleObjectException when detecting the platform trust manager
on Java 17+.
- Fix: Don't crash if a cookie's value is a lone double quote character.
- Fix: Don't crash when canceling an event source created by
EventSources.processResponse().
- New:
Cache now has a public constructor that takes an [okio.FileSystem]. This should make it
possible to implement decorators for cache encryption or compression.
- New:
Cookie.newBuilder() to build upon an existing cookie.
- New: Use TLSv1.3 when running on JDK 8u261 or newer.
- New:
QueueDispatcher.clear() may be used to reset a MockWebServer instance.
- New:
FileDescriptor.toRequestBody() may be particularly useful for users of Android's Storage
Access Framework.
- Upgrade: [Kotlin 1.5.31][kotlin_1_5_31].
- Upgrade: [Okio 3.0.0][okio_3_0_0].
Uh oh!
There was an error while loading. Please reload this page.
This PR contains the following updates:
5.0.0-alpha.2->5.2.1Release Notes
square/okhttp (com.squareup.okhttp3:logging-interceptor)
v5.2.12025年10月09日
Fix: Don't crash when calling
Socket.shutdownOutput()orshutdownInput()on anSSLSocketon Android API 21 through 23. This method throws an
UnsupportedOperationException, so we nowcatch that and close the underlying stream instead.
Upgrade: [Okio 3.16.1][okio_3_16_1].
v5.2.02025年10月07日
New: Support [HTTP 101] responses with
Response.socket. This mechanism is only supported onHTTP/1.1. We also reimplemented our websocket client to use this new mechanism.
New: The
okhttp-zstdmodule negotiates [Zstandard (zstd)][zstd] compression with servers thatsupport it. It integrates a new (unstable) [ZSTD-KMP] library, also from Square. Enable it like
this:
New: Support the
QUERYHTTP method. You will need to set theRequest.cacheUrlOverrideproperty to cache calls made with this method. The
RequestBody.sha256()may be helpful here;use it to compose a cache URL from the query body.
New: Publish events when calls must wait to execute.
EventListener.dispatcherQueueStart()is invoked when a call starts waiting, and
dispatcherQueueEnd()is invoked when it's done.New:
Request.toCurl()returns a copy-pasteable [curl] command consistent with Chrome’s andFirefox’s ‘copy as cURL’ features.
New: Support [JPMS]. We replaced our
Automatic-Module-Namemetadata with propermodule-info.javafiles.Fix: Recover gracefully when worker threads are interrupted. When we introduced fast fallback in
OkHttp 5.0, we started using background threads while connecting. Sadly that code didn't handle
interruptions well. This is now fixed.
Upgrade: [Kotlin 2.2.20][kotlin_2_2_20].
Upgrade: [Okio 3.16.0][okio_3_16_0].
v5.1.02025年07月07日
New:
Response.peekTrailers(). When we changedResponse.trailers()to block instead ofthrowing in 5.0.0, we inadvertently removed the ability for callers to peek the trailers
(by catching the
IllegalStateExceptionif they weren't available). This new API restores thatcapability.
Fix: Don't crash on
trailers()if the response doesn't have a body. We broke [Retrofit] userswho read the trailers on the
raw()OkHttp response, after its body was decoded.v5.0.02025年07月02日
This is our first stable release of OkHttp since 2023. Here's the highlights if you're upgrading
from OkHttp 4.x:
OkHttp is now packaged as separate JVM and Android artifacts. This allows us to offer
platform-specific features and optimizations. If your build system handles [Gradle module metadata],
this change should be automatic.
MockWebServer has a new coordinate and package name. We didn’t like that our old artifact
depends on JUnit 4 so the new one doesn’t. It also has a better API built on immutable values. (We
intend to continue publishing the old
okhttp3.mockwebserverartifact so there’s no urgency tomigrate.)
OkHttp now supports Happy Eyeballs ([RFC 8305][rfc_8305]) for IPv4+IPv6 networks. It attempts
both IPv6 and IPv4 connections concurrently, keeping whichever connects first.
We’ve improved our Kotlin APIs. You can skip the builder:
OkHttp now supports [GraalVM].
Here’s what has changed since 5.0.0-alpha.17:
NoSuchMethodErrorwhen using OkHttp with the Sentry SDK.okhttp3.mockwebserver.RecordedRequest.pathproperty. Weinadvertently changed this behavior when we introduced the
mockwebserver3API.v5.0.0-alpha.172025年06月29日
This release stabilizes many APIs for the imminent OkHttp 5.0.0 release.
New:
TrailersSource, a public API for HTTP trailers. Production callers shouldn't need thisas the API to read response trailers is unchanged. Testers may use this new stable API to
supply trailers for a
Response.New:
Path.asRequestBody()is now a non-experimental API.New:
FileDescriptor.toRequestBody()is now a non-experimental API.New: Stop using experimental coroutines APIs in our
okhttp-coroutinesartifact.Breaking: Move
gzipfromRequestBodytoRequest.Builder. This new API handles bothcompressing the request body and also adding the corresponding
Content-Encodingheader. Notethat this function is sensitive to when it is called: the response body must be supplied before
it can be compressed.
Breaking: Remove
AddressPolicy,AsyncDns, andConnectionListenerfrom the public API. Weintend to ship a public API for these features, but we don't want to hold OkHttp 5.0.0 until
those APIs are stable.
Fix: Change
MockWebServer.close()to cancel ongoing calls that are blocked on a delay.Upgrade: [Okio 3.13.0][okio_3_13_0].
This release also stabilizes many APIs in the
mockwebserver3artifact that's new in 5.0.Breaking:
RecordedRequest.bodyis now nullable. Null is used when the request does not have abody.
Breaking:
RecordedRequest.chunkSizesis now nullable. Null is used when the request does notuse chunked encoding. This is different from an empty list - that indicates the request is
chunked but has no data.
Breaking: Replace
SocketPolicywith a new type,SocketEffect. It splits triggers (requeststart, response body, etc.) from effects (closing the socket, closing the stream, etc.).
Breaking: Rename
RecordedRequest.sequenceNumbertoexchangeIndexand introduceconnectionIndexon that type. These properties may be useful when testing features likeconnection reuse.
Breaking: Replace our parameters-based JUnit 5 extension with a new annotation,
@StartStop.Put this annotation on a
MockWebServerproperty and the extension will start it before yourtest executes and stop it after it completes. No further configuration is required.
Breaking: Don't automatically start
MockWebServerafter calls to accessors likeport. Nowthese accessors will throw an
IllegalStateExceptionif the service has not yet been started.Breaking: Rename
RecordedRequest.pathtoRecordedRequest.target. (This property issometimes a path, but it can also be a path and query, or a full URL.)
Breaking: Decompose the
RecordedRequest.requestLineinto three properties,method,target,and
version. This better suits HTTP/2 where the request line had to be synthesized fromcomponent headers.
Breaking: Change
RecordedRequest.bodyfrom a mutableBufferto an immutableByteString.Breaking: Adopt Okio's new
Socketinterface forMockResponse.socketHandler.Note that any Breaking changes above impact only APIs introduced in earlier 5.0.0-alpha releasees.
We don't break binary compatibility with non-alpha APIs.
v5.0.0-alpha.162025年05月29日
running our Android artifact on the JVM platform!
v5.0.0-alpha.152025年05月28日
This release introduces separate JVM and Android artifacts. Until now, we've distributed OkHttp
as a JVM library that detects Android capabilities at runtime, but that doesn't offer
Android-specific APIs. With this release we're starting to publish OkHttp as an AAR for Android
users in addition to our existing JAR for JVM users.
This first Android-specific artifact adopts Android's
assetsmechanism to embed the public suffixdata. We will build more Android integration in future releases.
The okhttp-android artifact first introduced in
5.0.0-alpha.7is no longer available:AndroidAsyncDnsclass moved to theokhttpartifact.AndroidLoggingclass is no longer necessary.LoggingEventListenerandHttpLoggingInterceptorwrite to logcat by default.The rest of this release is our highest-quality release yet. Though we continue to use the word
alpha in the version name, the only unstable thing in it is some non-final APIs tagged
@ExperimentalOkHttpApi. You can safely use this release in production.Fix: Attempt to read the response even if sending the request failed. This makes it possible
to handle response statuses like
HTTP/1.1 431 "Request Header Fields Too Large.Fix: Handle multiple 1xx responses.
Fix: Address a performance bug in our internal task runner. We had a race condition that could
result in it OkHttp starting a thread for each queued task, even when a single thread could run
all of them.
Fix: Address a performance bug in
MultipartReader. We were scanning the entire input streamfor a delimiter when we only needed to scan enough to return a result.
Fix: Don't double-compress the public suffix database. OkHttp is usually distributed in a
compressed file (like a JAR or APK), so compressing its internal data was redundant.
Fix: Call
ProxySelector.connectFailed()when a connection's initial TCP handshake fails.Fix: Change the signature of
Dispatcherto accept a nullableExecutorService. Changing thisparameter to be non-null was an unintended signature change in OkHttp 4.0.
New:
EventListener.retryDecision()is called each time a request fails with anIOException.It notifies your listener if OkHttp will retry.
New:
EventListener.followUpDecision()is called each time a response is received. It notifiesyour listener if OkHttp has decided to make a follow-up request. Some common follow-ups are
authentication challenges and redirects.
New: Handy constants for
Headers.EMPTY,RequestBody.EMPTY, andResponseBody.EMPTY.New: OkHttp now calls
StrictMode.noteSlowCall()when initializing TLS on Android. UseStrictModeto detect if yourOkHttpClientis being initialized on the main thread.Upgrade: [Okio 3.12.0][okio_3_12_0].
Upgrade: [Kotlin 2.1.21][kotlin_2_1_21].
Upgrade: [kotlinx.coroutines 1.10.2][coroutines_1_10_2]. This is used by the optional
okhttp-coroutinesartifact.Upgrade: [AndroidX Startup 1.2.0][startup_1_2_0]. The Android variant of the
okhttpartifactnow depends on this. This is a new dependency.
Upgrade: [AndroidX Annotation 1.9.1][annotation_1_9_1]. As above, the Android variant of the
okhttpartifact now depends on this. This is also a new dependency.v5.0.0-alpha.142024年04月17日
Breaking: Move coroutines extensions to okhttp3.coroutines. Previously this artifact shared the
okhttp3package name with our core module, which is incompatible with the Java Platform ModuleSystem.
Fix in okhttp-coroutines: Publish a valid artifact. The coroutines JAR file in 5.0.0-alpha.13
was corrupt and should not be used.
v5.0.0-alpha.132024年04月16日
Breaking: Tag unstable new APIs as
@ExperimentalOkHttpApi. We intend to release OkHttp 5.0without stabilizing these new APIs first.
Do not use these experimental APIs in modules that may be executed using a version of OkHttp
different from the version that the module was compiled with. Do not use them in published
libraries. Do not use them if you aren't willing to track changes to them.
Breaking: Drop support for Kotlin Multiplatform.
We planned to support multiplatform in OkHttp 5.0, but after building it, we weren't happy with
the implementation trade-offs. We can't use our HTTP client engine on Kotlin/JS, and we weren't
prepared to build a TLS API for Kotlin/Native.
We'd prefer a multiplatform HTTP client API that's backed by OkHttp on Android and JVM, and
other engines on other platforms. [Ktor] does this pretty well today!
Breaking: Use
kotlin.time.Durationin APIs likeOkHttpClient.Builder.callTimeout(). Thisupdate also drops support for the
DurationUnitfunctions introduced in earlier alpha releasesof OkHttp 5.
Breaking: Reorder the parameters in the Cache constructor that was introduced in 5.0.0-alpha.3.
New:
Request.Builder.cacheUrlOverride()customizes the cache key used for a request. This canbe used to make canonical URLs for the cache that omit insignificant query parameters or other
irrelevant data.
This feature may be used with
POSTrequests to cache their responses. In such cases therequest body is not used to determine the cache key, so you must manually add cache-relevant
data to the override URL. For example, you could add a
request-body-sha256query parameter sorequests with the same POST data get the same cache entry.
New:
HttpLoggingInterceptor.redactQueryParams()configures the query parameters to redactin logs. For best security, don't put sensitive information in query parameters.
New:
ConnectionPool.setPolicy()configures a minimum connection pool size for a targetaddress. Use this to proactively open HTTP connections.
Connections opened to fulfill this policy are subject to the connection pool's
keepAliveDurationbut do not count against the pool-widemaxIdleConnectionslimit.This feature increases the client's traffic and the load on the server. Talking to your server's
operators before adopting it.
New in okhttp-android:
HttpLoggingInterceptor.androidLogging()andLoggingEventListener.androidLogging()write HTTP calls or events to Logcat.New:
OkHttpClient.webSocketCloseTimeoutconfigures how long a web socket connection will waitfor a graceful shutdown before it performs an abrupt shutdown.
Fix: Honor
RequestBody.isOneShot()inMultipartBodyFix in
okhttp-coroutines: Don't leak response bodies inexecuteAsync(). We had a bug wherewe didn't call
Response.close()if the coroutine was canceled before its response wasreturned.
Upgrade: [Okio 3.9.0][okio_3_9_0].
Upgrade: [Kotlin 1.9.23][kotlin_1_9_23].
Upgrade: [Unicode® IDNA 15.1.0][idna_15_1_0]
v5.0.0-alpha.122023年12月17日
We took too long to cut this release and there's a lot of changes in it. We've been busy.
Although this release is labeled alpha, the only unstable thing in it is our new APIs. This
release has many critical bug fixes and is safe to run in production. We're eager to stabilize our
new APIs so we can get out of alpha.
New: Support Java 21's virtual threads (‘OpenJDK Project Loom’). We changed OkHttp's internals
to use
LockandConditioninstead ofsynchronizedfor best resource utilization.New: Switch our Internationalized Domain Name (IDN) implementation to [UTS #46 Nontransitional
Processing][uts46]. With this fix, the
ßcode point no longer maps toss. OkHttp now embedsits own IDN mapping table in the library.
New: Prefer the client's configured precedence order for TLS cipher suites. (OkHttp used to
prefer the JDK’s precedence order.) This change may cause your HTTP calls to negotiate a
different cipher suite than before! OkHttp's defaults cipher suites are selected for good
security and performance.
New:
ConnectionListenerpublishes events for connects, disconnects, and use of pooledconnections.
Fix: Immediately update the connection's flow control window instead of waiting for the
receiving stream to process it.
This change may increase OkHttp's memory use for applications that make many concurrent HTTP
calls and that can receive data faster than they can process it. Previously, OkHttp limited
HTTP/2 to 16 MiB of unacknowledged data per connection. With this fix there is a limit of 16 MiB
of unacknowledged data per stream and no per-connection limit.
Fix: Don't close a
Deflaterwhile we're still using it to compress a web socket message. Wehad a severe bug where web sockets were closed on the wrong thread, which caused
NullPointerExceptioncrashes inDeflater.Fix: Don't crash after a web socket fails its connection upgrade. We incorrectly released
the web socket's connections back to the pool before their resources were cleaned up.
Fix: Don't infinite loop when a received web socket message has self-terminating compressed
data.
Fix: Don't fail the call when the response code is ‘HTTP 102 Processing’ or ‘HTTP 103 Early
Hints’.
Fix: Honor interceptors' changes to connect and read timeouts.
Fix: Recover gracefully when a cached response is corrupted on disk.
Fix: Don't leak file handles when a cache disk write fails.
Fix: Don't hang when the public suffix database cannot be loaded. We had a bug where a failure
reading the public suffix database would cause subsequent reads to hang when they should have
crashed.
Fix: Avoid
InetAddress.getCanonicalHostName()in MockWebServer. This avoids problems if thehost machine's IP address has additional DNS registrations.
New: Create a JPMS-compatible artifact for
JavaNetCookieJar. Previously, multiple OkHttpartifacts defined classes in the
okhttp3package, but this is forbidden by the Java modulesystem. We've fixed this with a new package (
okhttp3.java.net.cookiejar) and a new artifact,com.squareup.okhttp3:okhttp-java-net-cookiehandler. (The original artifact now delegates tothis new one.)
implementation("com.squareup.okhttp3:okhttp-java-net-cookiehandler:5.0.0-alpha.12")New:
Cookie.sameSitedetermines whether cookies should be sent on cross-site requests. Thisis used by servers to defend against Cross-Site Request Forgery (CSRF) attacks.
New: Log the total time of the HTTP call in
HttpLoggingInterceptor.New:
OkHttpClient.Buildernow has APIs that usekotlin.time.Duration.New:
mockwebserver3.SocketPolicyis now a sealed interface. This is one of severalbackwards-incompatible API changes that may impact early adopters of this alpha API.
New:
mockwebserver3.Streamfor duplex streams.New:
mockwebserver3.MockResponseBodyfor streamed response bodies.New:
mockwebserver3.MockResponseis now immutable, with aBuilder.New:
mockwebserver3.RecordedRequest.handshakeServerNamesreturns the SNI (Server NameIndication) attribute from the TLS handshake.
Upgrade: [Kotlin 1.9.21][kotlin_1_9_21].
Upgrade: [Okio 3.7.0][okio_3_7_0].
v5.0.0-alpha.112022年12月24日
[RFC 8305][rfc_8305]. Disable with
OkHttpClient.Builder.fastFallback(false).Request.toString().ExecutorServiceis shutdown with manycalls still enqueued.
v5.0.0-alpha.102022年06月26日
com.squareup.okhttp3:okhttp:3.x.x) to depend on theJVM artifact (
com.squareup.okhttp3:okhttp-jvm:3.x.x) for Maven builds. This should work-aroundan issue where Maven doesn't interpret Gradle metadata.
DurationUnitwhich was a typealias in 1.5.x.v5.0.0-alpha.92022年06月16日
HttpUrlnow rejects URLs whose domains aren't valid.This includes overly-long domain names (longer than 253 characters), overly-long labels (more
than 63 characters between dots), and empty labels.
Content-Lengthheader in multipart bodies. Servers must delimitOkHttp's request bodies using the boundary only. (This change makes OkHttp more consistent with
browsers and other HTTP clients.)
tunnelProxyargument inMockWebServer.useHttps(). This change only impactsthe OkHttp 5.x API which uses the
mockwebserver3package.toDuration()which isn't available in kotlin-stdlib 1.4.v5.0.0-alpha.82022年06月08日
Fix: Change how
H2_PRIOR_KNOWLEDGEworks with HTTP proxies. Previously OkHttp assumed theproxy itself was a prior knowledge HTTP/2 server. With this update, OkHttp attempts a
CONNECTtunnel just as it would with HTTPS. For prior knowledge with proxies OkHttp's is now consistent
with these curl arguments:
Fix: Support executing OkHttp on kotlin-stdlib versions as old as 1.4. The library still builds
on up-to-date Kotlin releases (1.6.21) but no longer needs that version as a runtime dependency.
This should make it easier to use OkHttp in Gradle plugins.
Fix: Don't start the clock on response timeouts until the request body is fully transmitted.
This is only relevant for duplex request bodies, because they are written concurrently when
reading the response body.
New:
MockResponse.inTunnel()is a newmockwebserver3API to configure responses that areserved while creating a proxy tunnel. This obsoletes both the
tunnelProxyargument onMockWebServerand theUPGRADE_TO_SSL_AT_ENDsocket option. (Only APIs onmockwebserver3are changed; the old
okhttp3.mockwebserverAPIs remain as they always have been.v5.0.0-alpha.72022年04月26日
This release introduces new Kotlin-friendly APIs. When we migrated OkHttp from Java to Kotlin in
OkHttp 4.0, we kept our Java-first APIs. With 5.0 we're continuing to support Java and adding
additional improvements for Kotlin users. In this alpha we're excited to skip-the-builder for
requests and remove a common source of non-null assertions (
!!) on the response body.The alpha releases in the 5.0.0 series have production-quality code and an unstable API. We expect
to make changes to the APIs introduced in 5.0.0-alpha.X. These releases are safe for production use
and 'alpha' strictly signals that we're still experimenting with some new APIs. If you're eager for
the fixes or features below, please upgrade.
New: Named and default parameters constructor for
Request:New:
Response.bodyis now non-null. This was generally the case in OkHttp 4.x, but the Kotlintype declaration was nullable to support rare cases like the body on
Response.cacheResponse,Response.networkResponse, andResponse.priorResponse. In such cases the body is nownon-null, but attempts to read its content will fail.
New: Kotlin-specific APIs for request tags. Kotlin language users can lookup tags with a type
parameter only, like
request.tag<MyTagClass>().New: MockWebServer has improved support for HTTP/1xx responses. Once you've migrated to the new
mockwebserver3package, there's a new field,MockResponse.informationalResponses.Fix: Don't interpret trailers as headers after an HTTP/100 response. This was a bug only when
the HTTP response body itself is empty.
Fix: Don't crash when a fast fallback call has both a deferred connection and a held connection.
Fix:
OkHttpClientno longer implementsCloneable. It never should have; the class isimmutable. This is left over from OkHttp 2.x (!) when that class was mutable. We're using the
5.x upgrade as an opportunity to remove very obsolete APIs.
Fix: Recover gracefully when Android's
NativeCryptocrashes with"ssl == null". This occurswhen OkHttp retrieves ALPN state on a closed connection.
Upgrade: [Kotlin 1.6.21][kotlin_1_6_21].
Upgrade: [Okio 3.1.0][okio_3_1_0].
v5.0.0-alpha.62022年03月14日
the previous alpha due to an unexpected race.
v5.0.0-alpha.52022年02月21日
introduced in the 5.0.0-alpha.4 release.
Dnsimplementations to resolve strings that are already IP addresses.attempt multiple TLS handshakes for the same call concurrently.
HttpUrl.topPrivateDomain()uses a resource file to identify private domains, but we didn'tinclude this file on GraalVM.
v5.0.0-alpha.42022年02月01日
This release introduces fast fallback to better support mixed IPv4+IPv6 networks. Fast fallback
is what we're calling our implementation of Happy Eyeballs, [RFC 8305][rfc_8305]. With this
feature OkHttp will attempt both IPv6 and IPv4 connections concurrently, keeping whichever connects
first. Fast fallback gives IPv6 connections a 250 ms head start so IPv6 is preferred on networks
where it's available.
To opt-in, configure your
OkHttpClient.Builder:native and JavaScript platforms are unstable preview releases and subject to
backwards-incompatible changes in forthcoming releases.
EventSource.cancel()made fromEventSourceListener.onOpen().This impacts Conscrypt when the server's presented certificates form both a trusted-but-unpinned
chain and an untrusted-but-pinned chain.
v5.0.0-alpha.32021年11月22日
Headers.toString()to redact authorization and cookie headers.RecordedRequest.requestUrl. This was doing a DNSlookup for the local hostname, but we really just wanted the
Hostheader.InaccessibleObjectExceptionwhen detecting the platform trust manageron Java 17+.
EventSources.processResponse().Cachenow has a public constructor that takes an [okio.FileSystem]. This should make itpossible to implement decorators for cache encryption or compression.
Cookie.newBuilder()to build upon an existing cookie.QueueDispatcher.clear()may be used to reset a MockWebServer instance.FileDescriptor.toRequestBody()may be particularly useful for users of Android's StorageAccess Framework.
Configuration
📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).
🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.
♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.
🔕 Ignore: Close this PR and you won't be reminded about this update again.
This PR was generated by Mend Renovate. View the repository job log.