目录

RestClient.Builder

Class Info

public static final class Builder extends IRestClientBuilder

RestClient的构造器。

Public Constructor Summary

Constructor Name

public RestClient.Builder()

默认的构造方法。

Public Method Summary

Qualifier and Type

Method Name and Description

public @CheckReturnValue RestClient.Builder

addConverterFactory(Converter.Factory factory)

添加Body数据转换器。

public @CheckReturnValue RestClient.Builder

addSubmitAdapterFactory(SubmitAdapter.Factory factory)

添加Submit的适配工厂。

public @CheckReturnValue RestClient.Builder

baseUrl(String url)

配置注解API接口基础URL。

public @CheckReturnValue RestClient

build()

构造RestClient对象。

public @CheckReturnValue RestClient.Builder

callbackExecutor(Executor executor)

配置请求回调线程。

public @CheckReturnValue RestClient.Builder

httpClient(HttpClient client)

配置HttpClient实例。

public @CheckReturnValue RestClient.Builder

submitFactory(Submit.Factory factory)

配置Submit.Factory实例。

public @CheckReturnValue RestClient.Builder

validateEagerly(boolean flag)

配置是否需要提前创建注解接口代理实例。

Public Constructors

[h2]RestClient.Builder

Constructor

public RestClient.Builder()

默认构造方法,构造RestClient.Builder对象。

Public Methods

[h2]addConverterFactory

Method

public @CheckReturnValue RestClient.Builder addConverterFactory(Converter.Factory factory)

添加Body数据转换器。数据转换器,用于将输入的Object类型数据转换成二进制数据,以及将返回的二进制数据转换成Object类型数据。

Parameters

Name

Description

factory

Converter的工厂类实现。

Returns

Type

Description

RestClient.Builder

Request构造器。

[h2]addSubmitAdapterFactory

Method

public @CheckReturnValue RestClient.Builder addSubmitAdapterFactory(SubmitAdapter.Factory factory)

添加Submit的适配工厂。封装Submit适配其他SDK。

Parameters

Name

Description

factory

SubmitAdapter的工厂类实现。

Returns

Type

Description

RestClient.Builder

RestClient构造器。

[h2]baseUrl

Method

public @CheckReturnValue RestClient.Builder baseUrl(String url)

配置注解API接口基础URL。

Parameters

Name

Description

url

接口基础URL。例如,所要访问的URL为:”https://example.com/api/foo/file/”,则基础URL可为:“https://example.com/api/”。

Returns

Type

Description

RestClient.Builder

RestClient构造器。

[h2]build

Method

public @CheckReturnValue RestClient build()

构造RestClient对象。

Returns

Type

Description

RestClient

RestClient对象。

[h2]callbackExecutor

Method

public @CheckReturnValue RestClient.Builder callbackExecutor(Executor executor)

配置请求回调线程。

Parameters

Name

Description

executor

回调执行线程。

Returns

Type

Description

RestClient.Builder

RestClient构造器。

[h2]httpClient

Method

public @CheckReturnValue RestClient.Builder httpClient(HttpClient client)

配置HttpClient实例。

Parameters

Name

Description

client

HttpClient实例。

Returns

Type

Description

RestClient.Builder

RestClient构造器。

[h2]submitFactory

Method

public RestClient.Builder submitFactory(Submit.Factory factory)

配置Submit.Factory实例。

Parameters

Name

Description

factory

Submit.Factory实例。

Returns

Type

Description

RestClient.Builder

RestClient构造器。

[h2]validateEagerly

Method

public @CheckReturnValue RestClient.Builder validateEagerly(boolean flag)

配置是否需要提前创建注解接口代理实例,默认为false,不提前创建。

Parameters

Name

Description

flag

是否需要提前创建注解接口代理实例。

  • true:提前创建
  • false:调用接口时创建

Returns

Type

Description

RestClient.Builder

RestClient构造器。