Flutter之Log处理 2024-06-20 周四

简介

虽然有断点,虽然有可以单步调试,但是log还是必不可少的。

网络的log

比如Dio的log,可以直接用Dio自带的LogInterceptor,也可以用三方插件pretty_dio_logger。一般情况,这两个已经够用了。至于自己写拦截器,看具体需要。

1. print

Flutter提供了全局的print方法,很好用。但是这个方法不区分模式,release版本也会输出log,存在安全隐患。

void print(Object? object) {
  String line = "$object";
  var toZone = printToZone;
  if (toZone == null) {
    printToConsole(line);
  } else {
    toZone(line);
  }
}

所以,最好在外面包一层,加一个判断就好:

class LogUtil {
  /// 调试模式打印
  static void doPrint(Object? object) {
    if (kDebugMode) {
      print(object);
    }
  }
}

2. debugPrint

Flutter提供了全局的debugPrint方法。不知道这个方法还好,用print完全足够了。第一次知道这个方法的时候,还以为是Debug模式下的打印,害得我全局替换了print。后来,才知道,完全不是这么回事。真不知道是哪个缺心眼的脑残给出的设计,真是害人不浅。

DebugPrintCallback debugPrint = debugPrintThrottled;

void debugPrintThrottled(String? message, { int? wrapWidth }) {
  final List<String> messageLines = message?.split('\n') ?? <String>['null'];
  if (wrapWidth != null) {
    _debugPrintBuffer.addAll(messageLines.expand<String>((String line) => debugWordWrap(line, wrapWidth)));
  } else {
    _debugPrintBuffer.addAll(messageLines);
  }
  if (!_debugPrintScheduled) {
    _debugPrintTask();
  }
}

真不知道这东西有什么用,纯粹是拿出来害人用的;为了避免其副作用,也可以在外面包一层。

class LogUtil {
  /// 调试模式打印
  static void doPrint(Object? object) {
    if (kDebugMode) {
      print(object);
    }
  }

  /// 调试模式打印
  static void doDebugPrint(Object? object) {
    if (kDebugMode) {
      debugPrint(object?.toString());
    }
  }
}
  1. 三方插件Logger
    在Pub上的好评比较夸张,所以可以试着用一下,看看效果。
    评价
  • 全局变量的使用感觉不是很好,所以打算封装成一个单例,对外提供一个静态方法。

  • Log等级的概念比较好,直接用它的定义,会导致在使用的时候导入这个三方插件,这样就失去了封装一层的意义。所以,可以抄作业,再定义一个等级。

enum LogLevel {
  trace(1000),
  debug(2000),
  info(3000),
  warning(4000),
  error(5000),
  fatal(6000),
  off(10000);

  final int value;

  const LogLevel(this.value);
}
  • 输出过滤是修改静态变量,所以可以提供一个静态方法来实现;虽然作用不大,不过在log很多,有洁癖的时候,会有点用。
  static void changeDisplayLevel(LogLevel level) {
    switch (level) {
      case LogLevel.trace:
        Logger.level = Level.trace;
      case LogLevel.debug:
        Logger.level = Level.debug;
      case LogLevel.info:
        Logger.level = Level.info;
      case LogLevel.warning:
        Logger.level = Level.warning;
      case LogLevel.error:
        Logger.level = Level.error;
      case LogLevel.fatal:
        Logger.level = Level.fatal;
      case LogLevel.off:
        Logger.level = Level.fatal;
    }
  }
  • 对外接口,设计一个相对通用的,方便以后换实现。
  /// 自定义的打印
  static void log(
    Object? object, {
    LogLevel level = LogLevel.trace,
  }) {
    switch (level) {
      case LogLevel.trace:
        _instance._logger.t(object);
      case LogLevel.debug:
        _instance._logger.d(object);
      case LogLevel.info:
        _instance._logger.i(object);
      case LogLevel.warning:
        _instance._logger.w(object);
      case LogLevel.error:
        _instance._logger.e(object);
      case LogLevel.fatal:
        _instance._logger.f(object);
      case LogLevel.off:
      // 什么也不做
    }
  }
  • 现在用的是Android Studio,可以装一个颜色插件,可以让log有颜色,这就是亲儿子,比VSCode有优势的地方。


    Console颜色插件
  • PrettyPrinter参数中colors的默认参数是true,这会导致出现乱码,所以应该设置为false;时间还是有点用的,所以printTime可以给true

  /// 单例模式
  late Logger _logger;
  static final LogUtil _instance = LogUtil._internal();

  factory LogUtil() => _instance;

  LogUtil._internal() {
    _logger = Logger(
      printer: PrefixPrinter(PrettyPrinter(colors: false, printTime: true)),
    );
  }
}
  • 最后的效果,warning等级是黄色的,比较醒目,对找问题应该有帮助。
    /// 测试log
    LogUtil.log("测试log", level: LogLevel.warning);
    LogUtil.doPrint("测试print");
    LogUtil.doDebugPrint("测试debugPrint");
效果对比
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容