类的使用
com.dtflys.forest.config.ForestConfiguration

使用ForestConfiguration的程序包

程序包	说明
com.dtflys.forest
com.dtflys.forest.backend
com.dtflys.forest.backend.httpclient.conn
com.dtflys.forest.backend.okhttp3.conn
com.dtflys.forest.config
com.dtflys.forest.converter.auto
com.dtflys.forest.converter.form
com.dtflys.forest.filter
com.dtflys.forest.http
com.dtflys.forest.mapping
com.dtflys.forest.pool
com.dtflys.forest.proxy
com.dtflys.forest.reflection
com.dtflys.forest.utils

com.dtflys.forest中ForestConfiguration的使用

返回ForestConfiguration的com.dtflys.forest中的方法

修饰符和类型	方法	说明
static ForestConfiguration	Forest.config()	获取或创建全局默认配置，即 ForestConfiguration 对象
static ForestConfiguration	Forest.config(String id)	根据配置ID获取或创建配置，即 ForestConfiguration 对象

com.dtflys.forest.backend中ForestConfiguration的使用

声明为ForestConfiguration的com.dtflys.forest.backend中的字段

修饰符和类型	字段	说明
protected final ForestConfiguration	AsyncHttpExecutor.configuration

参数类型为ForestConfiguration的com.dtflys.forest.backend中的方法

修饰符和类型	方法	说明
static int	AsyncHttpExecutor.getAsyncThreadSize(ForestConfiguration configuration)	获取异步线程池大小
static int	AsyncHttpExecutor.getMaxAsyncThreadSize(ForestConfiguration configuration)	获取最大异步线程数
void	AbstractHttpBackend.init(ForestConfiguration configuration)
void	ForestConnectionManager.init(ForestConfiguration configuration)
void	HttpBackend.init(ForestConfiguration configuration)	初始化后端框架
HttpBackend	HttpBackendSelector.select(ForestConfiguration configuration)	根据全局配置选择Forest后端框架

参数类型为ForestConfiguration的com.dtflys.forest.backend中的构造器

限定符	构造器	说明
	AsyncHttpExecutor(ForestConfiguration configuration, HttpExecutor syncExecutor, ResponseHandler responseHandler)

com.dtflys.forest.backend.httpclient.conn中ForestConfiguration的使用

参数类型为ForestConfiguration的com.dtflys.forest.backend.httpclient.conn中的方法

修饰符和类型	方法	说明
void	HttpclientConnectionManager.init(ForestConfiguration configuration)

com.dtflys.forest.backend.okhttp3.conn中ForestConfiguration的使用

参数类型为ForestConfiguration的com.dtflys.forest.backend.okhttp3.conn中的方法

修饰符和类型	方法	说明
void	OkHttp3ConnectionManager.init(ForestConfiguration configuration)

com.dtflys.forest.config中ForestConfiguration的使用

返回ForestConfiguration的com.dtflys.forest.config中的方法

修饰符和类型	方法	说明
ForestConfiguration	ForestConfiguration.addAllVariables(Map<String,Object> variables)	设置全局变量表
static ForestConfiguration	ForestConfiguration.configuration()	实例化ForestConfiguration对象，并初始化默认值
static ForestConfiguration	ForestConfiguration.configuration(String id)	实例化ForestConfiguration对象，并初始化默认值
static ForestConfiguration	ForestConfiguration.createConfiguration()
ForestConfiguration	VariableScope.getConfiguration()
static ForestConfiguration	ForestConfiguration.getDefaultConfiguration()
ForestConfiguration	ForestConfiguration.registerFilter(String name, Class filterClass)	注册全局过滤器
ForestConfiguration	ForestConfiguration.registerKeyStore(SSLKeyStore keyStore)	注册全局SSL的Key Store信息
ForestConfiguration	ForestConfiguration.setAsyncMode(ForestAsyncMode asyncMode)	设置异步模式
ForestConfiguration	ForestConfiguration.setAsyncRejectPolicyClass(Class<? extends RejectedExecutionHandler> asyncRejectPolicyClass)	设置异步线程池拒绝策略类型
ForestConfiguration	ForestConfiguration.setAutoRedirection(boolean autoRedirection)	/** 设置是否打开自动重定向
ForestConfiguration	ForestConfiguration.setBackend(HttpBackend backend)	设置HTTP后端
ForestConfiguration	ForestConfiguration.setBackendClientCacheExpireTime(Duration backendClientCacheExpireTime)	设置获取后端客户端对象缓存过期时间
ForestConfiguration	ForestConfiguration.setBackendClientCacheMaxSize(Integer backendClientCacheMaxSize)	设置后端客户端对象缓存最大空间大小
ForestConfiguration	ForestConfiguration.setBackendName(String backendName)	设置HTTP后端名称
ForestConfiguration	ForestConfiguration.setBaseAddress(ForestAddress baseAddress)	设置全局默认地址(主机名/域名/ip地址 + 端口号)
ForestConfiguration	ForestConfiguration.setBaseAddressHost(String host)	设置全局地址的 host
ForestConfiguration	ForestConfiguration.setBaseAddressPort(Integer port)	设置全局地址的 port
ForestConfiguration	ForestConfiguration.setBaseAddressScheme(String scheme)	设置全局地址的HTTP协议头
ForestConfiguration	ForestConfiguration.setBaseAddressSourceClass(Class<? extends AddressSource> baseAddressSourceClass)	设置全局默认的主机地址信息动态来源接口实现类
ForestConfiguration	ForestConfiguration.setCacheEnabled(boolean cacheEnabled)	设置是否缓存请求接口实例
ForestConfiguration	ForestConfiguration.setCharset(String charset)	设置全局的请求数据字符集
ForestConfiguration	ForestConfiguration.setConnectTimeout(int connectTimeout, TimeUnit timeUnit)	设置全局的请求连接超时时间
ForestConfiguration	ForestConfiguration.setConnectTimeout(Integer connectTimeout)	设置全局的请求连接超时时间，单位为毫秒
ForestConfiguration	ForestConfiguration.setConnectTimeout(Duration connectTimeout)	设置全局的请求连接超时时间
ForestConfiguration	ForestConfiguration.setConverterMap(Map<ForestDataType,ForestConverter> converterMap)	设置全局数据转换器表
ForestConfiguration	ForestConfiguration.setDefaultHeaders(List<RequestNameValue> defaultHeaders)	设置全局默认请求头信息列表
ForestConfiguration	ForestConfiguration.setDefaultParameters(List<RequestNameValue> defaultParameters)	设置全局默认请求参数列表
ForestConfiguration	ForestConfiguration.setForestObjectFactory(ForestObjectFactory forestObjectFactory)	设置Forest对象实例化工厂
ForestConfiguration	ForestConfiguration.setHttpBackendSelector(HttpBackendSelector httpBackendSelector)	设置HTTP后端选择器
ForestConfiguration	ForestConfiguration.setInterceptorFactory(InterceptorFactory interceptorFactory)	设置拦截器工厂
ForestConfiguration	ForestConfiguration.setInterceptors(List<Class<? extends Interceptor>> interceptors)	设置全局拦截器列表
ForestConfiguration	ForestConfiguration.setJsonConverter(ForestJsonConverter converter)	设置全局JSON数据转换器
ForestConfiguration	ForestConfiguration.setLogEnabled(boolean logEnabled)	设置是否允许打印请求日志
ForestConfiguration	ForestConfiguration.setLogHandler(ForestLogHandler logHandler)	设置日志处理器
ForestConfiguration	ForestConfiguration.setLogRequest(boolean logRequest)	设置是否允许打印请求/响应日志
ForestConfiguration	ForestConfiguration.setLogResponseContent(boolean logResponseContent)	设置是否允许打印响应日志
ForestConfiguration	ForestConfiguration.setLogResponseStatus(boolean logResponseStatus)	设置是否允许打印响应日志
ForestConfiguration	ForestConfiguration.setMaxAsyncQueueSize(Integer maxAsyncQueueSize)	设置最大异步线程池队列大小
ForestConfiguration	ForestConfiguration.setMaxAsyncThreadSize(Integer maxAsyncThreadSize)	设置最大异步线程池大小
ForestConfiguration	ForestConfiguration.setMaxConnections(Integer maxConnections)	设置全局的最大连接数
ForestConfiguration	ForestConfiguration.setMaxRequestQueueSize(Integer maxRequestQueueSize)	设置全局的最大请求等待队列大小
ForestConfiguration	ForestConfiguration.setMaxRetryCount(Integer maxRetryCount)	设置全局的最大请求失败重试次数
ForestConfiguration	ForestConfiguration.setMaxRetryInterval(long maxRetryInterval)	设置全局的最大请求重试之间的时间间隔，单位为毫秒
ForestConfiguration	ForestConfiguration.setMaxRouteConnections(Integer maxRouteConnections)	设置全局的最大请求路径连接数
ForestConfiguration	ForestConfiguration.setProperties(ForestProperties properties)	设置Properties配置属性
ForestConfiguration	ForestConfiguration.setProtobufConverter(ForestProtobufConverter converter)	设置全局XML数据转换器
ForestConfiguration	ForestConfiguration.setReadTimeout(int readTimeout, TimeUnit timeUnit)	设置全局的请求读取超时时间
ForestConfiguration	ForestConfiguration.setReadTimeout(Integer readTimeout)	设置全局的请求读取超时时间，单位为毫秒
ForestConfiguration	ForestConfiguration.setReadTimeout(Duration readTimeout)	设置全局的请求读取超时时间
ForestConfiguration	ForestConfiguration.setRetryCount(Integer retryCount)	已过时。
ForestConfiguration	ForestConfiguration.setRetryer(Class retryer)	设置全局的请求失败重试策略类
ForestConfiguration	ForestConfiguration.setRetryWhenClass(Class<? extends RetryWhen> retryWhenClass)	设置全局重试条件回调函数
ForestConfiguration	ForestConfiguration.setSslKeyStores(Map<String,SSLKeyStore> sslKeyStores)	设置全局SSL的Key Store表
ForestConfiguration	ForestConfiguration.setSslProtocol(String sslProtocol)	设置全局的单向HTTPS请求的SSL协议
ForestConfiguration	ForestConfiguration.setSuccessWhenClass(Class<? extends SuccessWhen> successWhenClass)	设置全局请求成功条件回调函数
ForestConfiguration	ForestConfiguration.setTimeout(Integer timeout)	已过时。
ForestConfiguration	ForestConfiguration.setToMergeConverterMap(Map<ForestDataType,ForestConverter> converterMap)	设置合并全局数据转换器表，但不会覆盖整个转换器表
ForestConfiguration	ForestConfiguration.setVariables(Map<String,Object> variables)	替换整个全局变量表
ForestConfiguration	ForestConfiguration.setVariableValue(String name, ForestVariableValue value)	设置全局变量
ForestConfiguration	ForestConfiguration.setVariableValue(String name, Object value)	设置全局变量
ForestConfiguration	ForestConfiguration.setXmlConverter(ForestXmlConverter converter)	设置全局XML数据转换器

返回变量类型为ForestConfiguration的类型的com.dtflys.forest.config中的方法

修饰符和类型	方法	说明
List<ForestConfiguration>	ForestConfiguration.allConfigurations()	获取所有定义过的 Forest 配置信息

参数类型为ForestConfiguration的com.dtflys.forest.config中的方法

修饰符和类型	方法	说明
static ThreadPoolExecutor	AsyncThreadPools.get(ForestConfiguration configuration)
static ThreadPoolExecutor	AsyncThreadPools.getOrCreate(ForestConfiguration configuration)

com.dtflys.forest.converter.auto中ForestConfiguration的使用

参数类型为ForestConfiguration的com.dtflys.forest.converter.auto中的构造器

限定符	构造器	说明
	DefaultAutoConverter(ForestConfiguration configuration)

com.dtflys.forest.converter.form中ForestConfiguration的使用

参数类型为ForestConfiguration的com.dtflys.forest.converter.form中的方法

修饰符和类型	方法	说明
protected void	DefaultFormConvertor.processFormArrayItem(List<RequestNameValue> newNameValueList, ForestConfiguration configuration, String name, Object array, int target)	处理Form表单中的数组项
protected void	DefaultFormConvertor.processFormCollectionItem(List<RequestNameValue> newNameValueList, ForestConfiguration configuration, String name, Collection collection, int target)	处理Form表单中的集合项
protected void	DefaultFormConvertor.processFormItem(List<RequestNameValue> newNameValueList, ForestConfiguration configuration, String name, Object value, int target)	处理Form表单中的项
protected void	DefaultFormConvertor.processFormMapItem(List<RequestNameValue> newNameValueList, ForestConfiguration configuration, String name, Map map, int target)	处理Form表单中的Map项
protected List<RequestNameValue>	DefaultFormConvertor.processFromNameValueList(ForestRequest request, List<RequestNameValue> nameValueList, ForestConfiguration configuration, ConvertOptions options)	处理Form表单中的键值对列表

参数类型为ForestConfiguration的com.dtflys.forest.converter.form中的构造器

限定符	构造器	说明
	DefaultFormConvertor(ForestConfiguration configuration)

com.dtflys.forest.filter中ForestConfiguration的使用

参数类型为ForestConfiguration的com.dtflys.forest.filter中的方法

修饰符和类型	方法	说明
Object	EncodeFilter.doFilter(ForestConfiguration configuration, Object data)
Object	EncodeFormFilter.doFilter(ForestConfiguration configuration, Object data)
Object	EncodePathFilter.doFilter(ForestConfiguration configuration, Object data)
Object	EncodeQueryFilter.doFilter(ForestConfiguration configuration, Object data)
Object	EncodeUserInfoFilter.doFilter(ForestConfiguration configuration, Object data)
Object	Filter.doFilter(ForestConfiguration configuration, Object data)
Object	FilterChain.doFilter(ForestConfiguration configuration, Object data)
Object	JSONFilter.doFilter(ForestConfiguration configuration, Object data)
Object	XmlFilter.doFilter(ForestConfiguration configuration, Object data)

com.dtflys.forest.http中ForestConfiguration的使用

返回ForestConfiguration的com.dtflys.forest.http中的方法

修饰符和类型	方法	说明
ForestConfiguration	ForestRequest.getConfiguration()	获取该请求的配置对象

参数类型为ForestConfiguration的com.dtflys.forest.http中的构造器

限定符	构造器	说明
	ForestRequest(ForestConfiguration configuration)
	ForestRequest(ForestConfiguration configuration, ForestMethod method)
	ForestRequest(ForestConfiguration configuration, ForestMethod method, ForestBody body, Object[] arguments)
	ForestRequest(ForestConfiguration configuration, ForestMethod method, Object[] arguments)
	ForestRequest(ForestConfiguration configuration, Object[] arguments)

com.dtflys.forest.mapping中ForestConfiguration的使用

返回ForestConfiguration的com.dtflys.forest.mapping中的方法

修饰符和类型	方法	说明
ForestConfiguration	SubVariableScope.getConfiguration()

com.dtflys.forest.pool中ForestConfiguration的使用

参数类型为ForestConfiguration的com.dtflys.forest.pool中的构造器

限定符	构造器	说明
	FixedRequestPool(ForestConfiguration configuration)

com.dtflys.forest.proxy中ForestConfiguration的使用

返回ForestConfiguration的com.dtflys.forest.proxy中的方法

修饰符和类型	方法	说明
ForestConfiguration	InterfaceProxyHandler.getConfiguration()

参数类型为ForestConfiguration的com.dtflys.forest.proxy中的构造器

限定符	构造器	说明
	InterfaceProxyHandler(ForestConfiguration configuration, ProxyFactory proxyFactory, Class<T> interfaceClass)
	ProxyFactory(ForestConfiguration configuration, Class<T> interfaceClass)

com.dtflys.forest.reflection中ForestConfiguration的使用

返回ForestConfiguration的com.dtflys.forest.reflection中的方法

修饰符和类型	方法	说明
ForestConfiguration	ForestMethod.getConfiguration()

参数类型为ForestConfiguration的com.dtflys.forest.reflection中的构造器

限定符	构造器	说明
	ForestMethod(InterfaceProxyHandler interfaceProxyHandler, ForestConfiguration configuration, Method method)

com.dtflys.forest.utils中ForestConfiguration的使用

参数类型为ForestConfiguration的com.dtflys.forest.utils中的方法

修饰符和类型	方法	说明
static Map	ReflectUtils.convertObjectToMap(Object srcObj, ForestConfiguration configuration)