http/smart_dio library
Classes
- CachePlugin
- 缓存插件
- ConfigurableErrorLocalizer
- 可配置本地化器(支持部分覆盖)
- DefaultErrorLocalizer
- 默认本地化器(默认中文)
- ErrorKey
- 错误键,用于精确定位错误消息
-
FinishError<
T> - 请求失败结束结果
-
FinishResult<
T> - 请求结束结果(成功/失败)
-
FinishSuccess<
T> - 请求成功结束结果
- HeaderPlugin
- 固定头部插件
- LoggerPlugin
- 日志插件
- Middleware
- 中间件抽象接口
- MiddlewareChain
- 中间件执行链
- ParamsPlugin
- 固定参数插件
- RequestContext
- 请求上下文
- ResponseKeyMap
- 响应 key 映射配置
- ResponseParserPlugin
- 响应解析插件
- RetryPlugin
- 重试插件
- SmartClientManager
- SmartDio 客户端管理器
- SmartConfig
- SmartDio 全局配置(不可变)
- SmartDio
- SmartDio 门面 API
- SmartErrorLocalizer
- 错误消息本地化器接口
- SmartPlugin
- SmartDio 插件基类
-
SmartRequest<
T> - 请求 DTO
-
SmartResponse<
T> - 响应包装类
Enums
- HttpMethod
- HTTP 请求方法枚举
- LifecycleHook
- 生命周期钩子枚举
- TimeoutPhase
- 超时阶段枚举
Constants
- kDecodedDataKey → const String
- 解码后数据存储 key (decoded data from fromJson/fromBytes/fromResponse)
- kParsedCodeKey → const String
- 解析后 code 存储 key
- kParsedDataKey → const String
- 解析后数据存储 key (raw data from ResponseParserPlugin)
- kParsedMessageKey → const String
- 解析后 message 存储 key
- kResponseKeyMapKey → const String
- 响应 key 映射常量
Functions
-
listDecoder<
E> (E itemDecoder(Map< String, dynamic> ), {bool preFilter(dynamic raw)?, bool filter(E decoded)?}) → JsonDecoder<List< E> > - 构建列表解码器的辅助函数
-
staticMessage(
String message) → MessageTemplate - 创建简单的静态消息模板
-
template(
String pattern) → MessageTemplate - 创建字符串模板辅助函数
Typedefs
-
AsyncHeaderProvider
= Future<
Map< Function()String, String?> > - 异步 Header 提供器类型
-
AsyncHeaderValueProvider
= Future<
String?> Function() - 单个 Header 提供器类型
- BusinessSuccessChecker = bool Function(dynamic code)
- 业务成功判断器
-
BytesDecoder<
T> = T Function(Uint8List bytes) - 字节流解析器类型(用于 Protobuf 等二进制协议)
- ErrorMessageBuilder = String? Function(SmartError error)
- 错误消息构建器
-
JsonDecoder<
T> = T Function(dynamic json) - JSON 解析器类型
-
MessageTemplate
= String Function(SmartError error, Map<
String, Object?> context) - 消息模板函数类型
-
OnError
= FutureOr<
void> Function(RequestContext ctx, SmartError error) - 请求错误回调
-
OnFinish<
T> = FutureOr< void> Function(RequestContext ctx, FinishResult<T> result) - 请求结束回调(无论成功失败)
-
OnStart
= FutureOr<
void> Function(RequestContext ctx) - 请求开始回调
-
OnSuccess<
T> = FutureOr< void> Function(RequestContext ctx, SmartResponse<T> response) - 请求成功回调
-
RawResponseDecoder<
T> = T Function(Response response) - 原始响应解析器类型(完全自定义解析)
- ShouldRetry = bool Function(SmartError error)
- 重试判断函数类型
-
SuccessMessageBuilder<
T> = String? Function(SmartResponse< T> response) - 成功消息构建器
Exceptions / Errors
- BusinessError
- 业务逻辑错误
- CancelError
- 请求取消错误
- CertificateError
- SSL 证书错误
- NetworkError
- 网络连接错误
- ParseError
- 数据解析错误
- ResponseError
- HTTP 响应错误
- SmartError
- SmartDio 统一错误基类(sealed class)
- TimeoutError
- 超时错误
- UnknownError
- 未知错误