org.aoju.bus.http

Class Client

java.lang.Object

org.aoju.bus.http.Client

All Implemented Interfaces:

Cloneable, Call.Factory, WebSocket.Factory

Direct Known Subclasses:

HttpClient

public class Client
extends Object
implements Cloneable, Call.Factory, WebSocket.Factory

Factory for calls, which can be used to send HTTP requests and read their responses.

Okclients should be shared

OkHttp performs best when you create a single client instance and reuse it for all of your HTTP calls. This is because each client holds its own connection pool and thread pools. Reusing connections and threads reduces latency and saves memory. Conversely, creating a client for each request wastes resources on idle pools.

Use new client() to create a shared instance with the default settings:

   

   // The singleton HTTP client.
   public final client client = new client();
 

Or use new client.Builder() to create a shared instance with custom settings:

   

   // The singleton HTTP client.
   public final client client = new client.Builder()
       .addInterceptor(new HttpLoggingInterceptor())
       .cache(new Cache(cacheDir, cacheSize))
       .build();
 

Customize your client with newBuilder()

You can customize a shared client instance with newBuilder(). This builds a client that shares the same connection pool, thread pools, and configuration. Use the builder methods to configure the derived client for a specific purpose.

This example shows a call with a short 500 millisecond timeout:

   

   client eagerClient = client.newBuilder()
       .readTimeout(500, TimeUnit.MILLISECONDS)
       .build();
   Response response = eagerClient.newCall(request).execute();
 

Shutdown isn't necessary

The threads and connections that are held will be released automatically if they remain idle. But if you are writing a application that needs to aggressively release unused resources you may do so.

Shutdown the dispatcher's executor service with shutdown(). This will also cause future calls to the client to be rejected.

   

     client.dispatcher().executorService().shutdown();
 

Clear the connection pool with evictAll(). Note that the connection pool's daemon thread may not exit immediately.

   

     client.connectionPool().evictAll();
 

If your client has a cache, call close(). Note that it is an error to create calls against a cache that is closed, and doing so will cause the call to crash.

   

     client.cache().close();
 

OkHttp also uses daemon threads for HTTP/2 connections. These will exit automatically if they remain idle.

Since:

JDK 1.8

Version:

3.6.5

Author:

Kimi Liu

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Client.Builder

Constructor Summary

Constructors

Constructor and Description
Client()

Method Summary

Modifier and Type	Method and Description
Authenticator	authenticator()
Cache	cache()
int	callTimeoutMillis()
CertificatePinner	certificatePinner()
ConnectionPool	connectionPool()
List<ConnectionSpec>	connectionSpecs()
int	connectTimeoutMillis()
CookieJar	cookieJar()
Dispatcher	dispatcher()
Dns	dns()
EventListener.Factory	eventListenerFactory()
boolean	followRedirects()
boolean	followSslRedirects()
HostnameVerifier	hostnameVerifier()
List<Interceptor>	interceptors()
List<Interceptor>	networkInterceptors()
Client.Builder	newBuilder()
Call	newCall(Request request)
WebSocket	newWebSocket(Request request, SocketListener listener)
int	pingIntervalMillis()
List<Protocol>	protocols()
Proxy	proxy()
Authenticator	proxyAuthenticator()
ProxySelector	proxySelector()
int	readTimeoutMillis()
boolean	retryOnConnectionFailure()
SocketFactory	socketFactory()
SSLSocketFactory	sslSocketFactory()
int	writeTimeoutMillis()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Client

public Client()

Method Detail

callTimeoutMillis

public int callTimeoutMillis()

connectTimeoutMillis

public int connectTimeoutMillis()

readTimeoutMillis

public int readTimeoutMillis()

writeTimeoutMillis

public int writeTimeoutMillis()

pingIntervalMillis

public int pingIntervalMillis()

proxy

public Proxy proxy()

proxySelector

public ProxySelector proxySelector()

cookieJar

public CookieJar cookieJar()

cache

public Cache cache()

dns

public Dns dns()

socketFactory

public SocketFactory socketFactory()

sslSocketFactory

public SSLSocketFactory sslSocketFactory()

hostnameVerifier

public HostnameVerifier hostnameVerifier()

certificatePinner

public CertificatePinner certificatePinner()

authenticator

public Authenticator authenticator()

proxyAuthenticator

public Authenticator proxyAuthenticator()

connectionPool

public ConnectionPool connectionPool()

followSslRedirects

public boolean followSslRedirects()

followRedirects

public boolean followRedirects()

retryOnConnectionFailure

public boolean retryOnConnectionFailure()

dispatcher

public Dispatcher dispatcher()

protocols

public List<Protocol> protocols()

connectionSpecs

public List<ConnectionSpec> connectionSpecs()

interceptors

public List<Interceptor> interceptors()

networkInterceptors

public List<Interceptor> networkInterceptors()

eventListenerFactory

public EventListener.Factory eventListenerFactory()

newCall

public Call newCall(Request request)

Specified by:

newCall in interface Call.Factory

newWebSocket

public WebSocket newWebSocket(Request request,
                              SocketListener listener)

Specified by:

newWebSocket in interface WebSocket.Factory

newBuilder

public Client.Builder newBuilder()