Flutter实战之自定义日志打印组件详解

在flutter中，如果我们需要打印日志，如果不进行自定义，我们只能使用自带的 print() 或者 debugprint() 方法进行打印，但是这两种打印，日志都是默认 info 层级的日志，很不友好，所以如果需要日志打印层级分明，我们就需要自定义一个日志打印组件，以下就来介绍如何自定义日志打印组件。

如何让输出的日志层级分明？

换种方式想，如果我们能在flutter代码中，能够调用到原始android中的log组件，岂不是就能解决日志打印问题？

如何进行关联

在flutter中，可以使用 methodchannel 进行关联，让flutter调用特定平台（如android、ios）的相关api，对于 methodchannel 的使用说明和相关介绍，可参考官方文档：。

这里简单说明下， flutter关于特定平台的api，主要是依赖其灵活的消息传递方式来执行的，而并非一套完整的代码生成的。啥意思呢？

• flutter可以通过平台通道向其宿主（android、ios）发送消息；
• 其宿主监听平台通道，接收发送过来的消息；
• 宿主平台通过接收到的消息执行宿主特有的api，然后将响应结果返回给客户端（也就是flutter部分）更新状态。

下面用代码简单说明：

step1 ：创建flutter平台客户端

import 'package:flutter/services.dart';

///一个日志打印工具类
class logutils {
 logutils._();

 //第一步：设置平台，并进行命名
 static const _platform = const methodchannel('com.yancy.flutter.plugins/log');

 //第二步，设置相关需要传递的方法
 //invokemethod方法接收的参数，第一个必选参数，设置的是方法的名称；后面的参数为可选的需要传递的参数
 static void i(string tag, string msg) {
 _platform.invokemethod('logi', {'tag': tag, 'msg': msg});
 }

 static void d(string tag, string msg) {
 _platform.invokemethod('logd', {'tag': tag, 'msg': msg});
 }

 static void v(string tag, string msg) {
 _platform.invokemethod('logv', {'tag': tag, 'msg': msg});
 }

 static void w(string tag, string msg) {
 _platform.invokemethod('logw', {'tag': tag, 'msg': msg});
 }

 static void e(string tag, string msg) {
 _platform.invokemethod('loge', {'tag': tag, 'msg': msg});
 }

}

step2 ：宿主端建立对应通道接收端

package com.yancy.flutter.host;

import android.content.context;
import android.util.log;
import android.widget.toast;

import io.flutter.plugin.common.binarymessenger;
import io.flutter.plugin.common.methodchannel;

/**
 * 说明：
 *
 * @author yancy
 * @date 2019/3/15
 */
public class customflutterplugins {
 
 //这里必选要跟flutter平台名称对应上，否则无法接收消息
 private static final string log_channel_name = "com.yancy.flutter.plugins/log";

 public static void registerlogger(binarymessenger messenger) {
  new methodchannel(messenger, log_channel_name).setmethodcallhandler((methodcall, result) -> {
   string tag = methodcall.argument("tag");
   string msg = methodcall.argument("msg");
   switch (methodcall.method) {
    case "logv":
     log.v(tag, msg);
     break;
    case "logd":
     log.d(tag, msg);
     break;
    case "logi":
     log.i(tag, msg);
     break;
    case "logw":
     log.w(tag, msg);
     break;
    case "loge":
     log.e(tag, msg);
     break;
    default:
     log.d(tag, msg);
     break;
   }
  });
 }
}

上面的 switch 里面的部分即对于flutter中 invokemethod 方法中的第一个参数名称。

step3 ：然后我们在宿主的m ainactivity 中进行调用注册即可完成通道的建立。

public class mainactivity extends flutteractivity {
 @override
 protected void oncreate(bundle savedinstancestate) {
 super.oncreate(savedinstancestate);
 generatedpluginregistrant.registerwith(this);

 customflutterplugins.registerlogger(getflutterview());
 }
}

step4 ：flutter中调用logutils相关方法，打印日志。

class myapp extends statelesswidget {

 @override
 widget build(buildcontext context) {
 print('print------');
 debugprint('debugprint-----');
 logutils.v('yancy', 'v-------');
 logutils.d('yancy', 'd-------');
 logutils.i('yancy', 'i-------');
 logutils.w('yancy', 'w-------');
 logutils.e('yancy', 'e-------');

 return materialapp(
  title: 'flutter demo',
  theme: themedata(
  primaryswatch: colors.blue,
  ),

  home: myhomepage(title: 'flutter demo home page'),
 );
 }
}

控制台输出的打印结果如下：

至此，一个简单的日志打印组建就开发完成啦。希望对大家的学习有所帮助，也希望大家多多支持。