跨平台开发 / 系统课时

用拦截器记录请求日志

用拦截器记录请求日志

接口联调过程中,开发者经常需要查看请求参数、响应内容和异常原因。Dio 拦截器可以在请求发送前、响应返回后以及发生错误时统一处理日志记录,帮助快速定位网络问题。

学习目标

  • 理解 Dio Interceptor 的执行时机
  • 学会实现基础请求日志拦截器
  • 掌握日志记录中的信息控制和安全边界

Interceptor 的作用位置

Dio 的拦截器位于请求流程中间,可以观察并修改网络请求生命周期中的关键阶段。

Dio 请求拦截器执行流程图

常见使用场景包括:

  • 输出接口调试日志
  • 自动添加认证信息
  • 统一处理错误响应
  • 统计请求耗时

添加日志拦截器

可以通过继承 Interceptor 创建自己的日志处理逻辑。

dart
import 'package:dio/dio.dart';

class LoggingInterceptor extends Interceptor {
  @override
  void onRequest(RequestOptions options, RequestInterceptorHandler handler) {
    print('请求地址: ${options.uri}');
    print('请求参数: ${options.data}');

    // 必须调用 handler,否则请求会停留在拦截阶段
    handler.next(options);
  }

  @override
  void onResponse(Response response, ResponseInterceptorHandler handler) {
    print('响应状态: ${response.statusCode}');
    handler.next(response);
  }

  @override
  void onError(DioException err, ErrorInterceptorHandler handler) {
    print('请求失败: ${err.message}');
    handler.next(err);
  }
}

void setupDio() {
  final dio = Dio();
  dio.interceptors.add(LoggingInterceptor());
}

预期输出

text
请求地址: https://api.example.com/users
请求参数: null
响应状态: 200

当接口失败时,错误阶段会输出对应异常信息,便于判断是网络连接问题还是服务端返回异常。

日志记录中的安全边界

请求日志很适合开发环境排查问题,但生产环境需要控制输出内容。以下信息不应该直接打印:

  • 用户密码
  • 完整 Token
  • 身份证等敏感字段
  • 大量业务数据响应内容

可以只记录必要信息,例如请求路径、状态码、耗时和错误类型。

拦截器使用注意事项

多个拦截器可以同时添加到 Dio 中,并按照添加顺序参与处理。修改请求时要保证继续调用对应的 handler 方法,否则请求链会被阻断。

开发阶段可以开启详细日志帮助联调,发布版本则应根据环境关闭敏感日志,避免调试信息泄露。

按自己的节奏,确认真正理解。

目录与阅读设置

阅读设置

17

记录一个想法

用拦截器记录请求日志

0 / 10000 · 笔记保存到账号。未提交的修改会在关闭、离开或刷新后丢失。

登录哪都通