com.dtflys.forest.interceptor

Interface Interceptor<T>

All Superinterfaces:

OnError, OnLoadCookie, OnProgress, OnRedirection, OnRetry, OnSaveCookie, OnSuccess<T>

All Known Subinterfaces:

BaseAnnotationLifeCycle<A,I>, MethodAnnotationLifeCycle<A,I>, ParameterAnnotationLifeCycle<A,I>

All Known Implementing Classes:

AbstractBodyLifeCycle, AddressLifeCycle, BackendLifeCycle, BaseLogEnabledLifeCycle, BaseLogHandlerLifeCycle, BaseRequestLifeCycle, BasicAuthLifeCycle, BinaryBodyLifeCycle, BodyLifeCycle, BodyTypeLifeCycle, DataFileLifeCycle, DataObjectLifeCycle, DataParamLifeCycle, DecompressGzipLifeCycle, DeleteRequestLifeCycle, DownloadLifeCycle, FormBodyLifeCycle, GetRequestLifeCycle, HeaderLifeCycle, HeadersLifeCycle, HeadRequestLifeCycle, HTTPProxyLifeCycle, IgnoreAllInterceptorsLifeCycle, InterceptorChain, JSONBodyLifeCycle, JSONQueryLifeCycle, LogEnabledLifeCycle, LogHandlerLifeCycle, OAuth2LifeCycle, OptionsRequestLifeCycle, PatchRequestLifeCycle, PostRequestLifeCycle, ProtobufBodyLifeCycle, PutRequestLifeCycle, QueryLifeCycle, RedirectionLifeCycle, RequestLifeCycle, RetryerLifeCycle, RetryLifeCycle, ReturnTypeLifeCycle, SSLHostnameVerifierLifeCycle, SSLSocketFactoryBuilderLifeCycle, SuccessLifeCycle, TraceRequestLifeCycle, URLEncodeLifeCycle, VariableLifeCycle, XMLBodyLifeCycle

public interface Interceptor<T>
extends OnSuccess<T>, OnError, OnProgress, OnLoadCookie, OnSaveCookie, OnRetry, OnRedirection

Forest拦截器接口

拦截器在请求的初始化、发送请求前、发送成功、发送失败等生命周期中都会被调用

总的生命周期回调函数调用顺序如下:

 Forest接口方法调用 ->
  ¦ onInvokeMethod ->
  ¦ beforeExecute ->
     ¦ 如果返回 false -> 中断请求，直接返回
     ¦ 如果返回 true ->
        ¦ 发送请求 ->
          ¦ 发送请求失败 ->
              ¦ retryWhen ->
                 ¦ 返回 true 则触发请求重试
                 ¦ 返回 false 则跳转到 [onError]
              ¦ onError -> 跳转到 [afterExecute]
          ¦ 发送请求成功 ->
             ¦ 等待响应 ->
             ¦ 接受到响应 ->
             ¦ retryWhen ->
                 ¦ 返回 true 则触发请求重试
                 ¦ 返回 false 判断响应状态 ->
                     ¦ 响应失败 -> onError -> 跳转到 [afterExecute]
                     ¦ 响应成功 -> onSuccess -> 跳转到 [afterExecute]
  ¦ afterExecute -> 退出 Forest 接口方法，并返回数据
 

Since:

2016-06-26

Author:

gongjun[dt_flys@hotmail.com]

Method Summary

Modifier and Type	Method and Description
default void	addAttribute(ForestRequest request, String name, Object value) 添加请求在本拦截器中的 Attribute 属性
default void	afterExecute(ForestRequest request, ForestResponse response) 默认回调函数: 请求完成后(成功/失败后) 调用该方法
default boolean	beforeExecute(ForestRequest request) 默认回调函数: 请求执行前调用该方法
default Object	getAttribute(ForestRequest request, String name)
default <T> T	getAttribute(ForestRequest request, String name, Class<T> clazz)
default Double	getAttributeAsDouble(ForestRequest request, String name)
default Float	getAttributeAsFloat(ForestRequest request, String name)
default Integer	getAttributeAsInteger(ForestRequest request, String name)
default String	getAttributeAsString(ForestRequest request, String name)
default InterceptorAttributes	getAttributes(ForestRequest request) 获取请求在本拦截器中的 Attribute 属性
default void	onError(ForestRuntimeException ex, ForestRequest request, ForestResponse response) 默认回调函数: 请求失败后调用该方法
default void	onInvokeMethod(ForestRequest request, ForestMethod method, Object[] args) 默认回调函数: 接口方法执行时调用该方法
default void	onLoadCookie(ForestRequest request, ForestCookies cookies) 默认回调函数: 在发送请求加载Cookie时调用该方法
default void	onProgress(ForestProgress progress) 默认文件上传或下载监听传输进度时调用该方法
default void	onRedirection(ForestRequest<?> redirectReq, ForestRequest<?> prevReq, ForestResponse<?> prevRes) 默认回调函数:在请求重定向时触发
default void	onRetry(ForestRequest request, ForestResponse response) 默认回调函数: 在触发请求重试时执行
default void	onSaveCookie(ForestRequest request, ForestCookies cookies) 默认回调函数: 在请求响应成功后，需要保存Cookie时调用该方法
default void	onSuccess(T data, ForestRequest request, ForestResponse response) 默认回调函数: 请求成功后调用该方法

Method Detail

onInvokeMethod

default void onInvokeMethod(ForestRequest request,
                            ForestMethod method,
                            Object[] args)

默认回调函数: 接口方法执行时调用该方法

默认为什么都不做

Parameters:

request - Forest请求对象

method - Forest方法对象

args - 方法调用入参数组

beforeExecute

default boolean beforeExecute(ForestRequest request)

默认回调函数: 请求执行前调用该方法

其返回值为布尔类型，可以控制请求是否继续执行

默认为什么都不做

Parameters:

request - Forest请求对象

Returns:

true: 继续执行该请求, 否则中断请求

afterExecute

default void afterExecute(ForestRequest request,
                          ForestResponse response)

默认回调函数: 请求完成后(成功/失败后) 调用该方法

默认为什么都不做

Parameters:

request - Forest请求对象

response - Forest响应对象

onSuccess

default void onSuccess(T data,
                       ForestRequest request,
                       ForestResponse response)

默认回调函数: 请求成功后调用该方法

默认为什么都不做

Specified by:

onSuccess in interface OnSuccess<T>

Parameters:

data - 请求响应返回后经过序列化后的数据

request - Forest请求对象

response - Forest响应对象

onError

default void onError(ForestRuntimeException ex,
                     ForestRequest request,
                     ForestResponse response)

默认回调函数: 请求失败后调用该方法

默认为什么都不做

Specified by:

onError in interface OnError

Parameters:

ex - 请求失败的异常对象

request - Forest请求对象

response - Forest响应对象

onRetry

default void onRetry(ForestRequest request,
                     ForestResponse response)

默认回调函数: 在触发请求重试时执行

默认为什么都不做

Specified by:

onRetry in interface OnRetry

Parameters:

request - Forest请求对象

response - Forest响应对象

onProgress

default void onProgress(ForestProgress progress)

默认文件上传或下载监听传输进度时调用该方法

默认为什么都不做

Specified by:

onProgress in interface OnProgress

Parameters:

progress - Forest进度对象

onRedirection

default void onRedirection(ForestRequest<?> redirectReq,
                           ForestRequest<?> prevReq,
                           ForestResponse<?> prevRes)

默认回调函数:在请求重定向时触发

默认为什么都不做

Specified by:

onRedirection in interface OnRedirection

Parameters:

redirectReq - 进行重定向的新请求

prevReq - 上一个请求

prevRes - 上一个请求的响应

onLoadCookie

default void onLoadCookie(ForestRequest request,
                          ForestCookies cookies)

默认回调函数: 在发送请求加载Cookie时调用该方法

默认为什么都不做

Specified by:

onLoadCookie in interface OnLoadCookie

Parameters:

request - Forest请求对象

cookies - Cookie集合, 需要通过请求发送的Cookie都添加到该集合

onSaveCookie

default void onSaveCookie(ForestRequest request,
                          ForestCookies cookies)

默认回调函数: 在请求响应成功后，需要保存Cookie时调用该方法

默认为什么都不做

Specified by:

onSaveCookie in interface OnSaveCookie

Parameters:

request - Forest请求对象

cookies - Cookie集合，通过响应返回的Cookie都从该集合获取

getAttributes

default InterceptorAttributes getAttributes(ForestRequest request)

获取请求在本拦截器中的 Attribute 属性

Parameters:

request - Forest请求对象

Returns:

InterceptorAttributes 对象实例

addAttribute

default void addAttribute(ForestRequest request,
                          String name,
                          Object value)

添加请求在本拦截器中的 Attribute 属性

Parameters:

request - Forest请求对象

name - 属性名称

value - 属性值

getAttribute

default Object getAttribute(ForestRequest request,
                            String name)

getAttribute

default <T> T getAttribute(ForestRequest request,
                           String name,
                           Class<T> clazz)

getAttributeAsString

default String getAttributeAsString(ForestRequest request,
                                    String name)

getAttributeAsInteger

default Integer getAttributeAsInteger(ForestRequest request,
                                      String name)

getAttributeAsFloat

default Float getAttributeAsFloat(ForestRequest request,
                                  String name)

getAttributeAsDouble

default Double getAttributeAsDouble(ForestRequest request,
                                    String name)