RFR: 8267140: Support closing the HttpClient by making it auto-closable [v4]

Jaikiran Pai jpai at openjdk.org
Mon Mar 20 12:47:39 UTC 2023


On Mon, 20 Mar 2023 10:57:05 GMT, Daniel Fuchs <dfuchs at openjdk.org> wrote:

>> Please find here an RFE that makes the `java.net.HttpClient` auto-closeable.
>> 
>> The API has been modeled on `ExecutorService`.
>> 
>> HttpClient::close() is a graceful shutdown and will wait until all operations are terminated before returning.
>> If a request is in progress, and the caller doesn't pull the corresponding data (for instance, the request was sent with a BodyHandler.ofInputStream(), but the caller stopped reading the input stream) then close() may never return.
>> 
>> Therefore, additional methods similar to those present in `ExecutorService` are also proposed. In summary:
>> 
>> - `shutdown()`: initiate a graceful shutdown, but doesn't wait for termination. 
>> - `shutdownNow()`:  initiate an immediate shutdown, attempting to cancel all operations in progress. Doesn't wait for termination.
>> - `awaitTermination(Duration)`: await for termination within the given delay
>> - `isTerminated()` tells whether the client is terminated
>> 
>> New tests have been added to test the proposed behaviors.
>> 
>> HttpClient tests (new and old) are still stable.
>
> Daniel Fuchs has updated the pull request with a new target base due to a merge or a rebase. The incremental webrev excludes the unrelated changes brought in by the merge/rebase. The pull request contains 10 additional commits since the last revision:
> 
>  - Merge branch 'master' into HttpClient-close-8267140
>  - Update test/jdk/java/net/httpclient/HttpClientShutdown.java
>    
>    Co-authored-by: Andrey Turbanov <turbanoff at gmail.com>
>  - Update test/jdk/java/net/httpclient/ShutdownNow.java
>    
>    Co-authored-by: Andrey Turbanov <turbanoff at gmail.com>
>  - Update test/jdk/java/net/httpclient/HttpClientShutdown.java
>    
>    Co-authored-by: Andrey Turbanov <turbanoff at gmail.com>
>  - Update test/jdk/java/net/httpclient/AsyncShutdownNow.java
>    
>    Co-authored-by: Andrey Turbanov <turbanoff at gmail.com>
>  - Review feedback
>  - typo
>  - Merge branch 'master' into HttpClient-close-8267140
>  - Throw NPE if duration is null
>  - 8267140

src/java.net.http/share/classes/java/net/http/HttpClient.java line 142:

> 140:  * through the same client. In the JDK implementation, connection pools
> 141:  * are not shared between {@code HttpClient} instances. Creating a new client
> 142:  * for each operation, though possible, will prevent reusing such connections.

I think, the reason why this sentence about creating a new connection for each operation, is here is to discourage applications from doing that. However, I found it a bit odd to have it in the middle of a section named "closing". 
The existing javadoc of this `HttpClient` has this sentence:
> Once built, an {@code HttpClient} is immutable, and can be used to send multiple requests.

Perhaps we should add this sentence there and emphasise that creating a new client for each operation is discouraged since that prevents reuse of existing connections?

-------------

PR: https://git.openjdk.org/jdk/pull/13019


More information about the net-dev mailing list