Flutter實戰之自定義日誌列印元件

XuYanjun發表於2019-03-16
Flutter元件

前言

在Flutter中，如果我們需要列印日誌，如果不進行自定義，我們只能使用自帶的print()或者debugPrint()方法進行列印，但是這兩種列印，日誌都是預設Info層級的日誌，很不友好，所以如果需要日誌列印層級分明，我們就需要自定義一個日誌列印元件，以下就來介紹如何自定義日誌列印元件。

如何讓輸出的日誌層級分明？

換種方式想，如果我們能在Flutter程式碼中，能夠呼叫到原始Android中的Log元件，豈不是就能解決日誌列印問題？

Flutter實戰之自定義日誌列印元件

如何進行關聯

在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：然後我們在宿主的MainActivity中進行呼叫註冊即可完成通道的建立。
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'),
    );
  }
}
複製程式碼

控制檯輸出的列印結果如下：

Flutter實戰之自定義日誌列印元件

至此，一個簡單的日誌列印組建就開發完成啦。

結語

目前Flutter很多組建需要原始平臺API支援，我們完全可以利用好MethodChannel進行相關功能開發，例如Flutter中對於toast提示，目前自帶的是SnackBar元件，如果想要使用Android自帶的Toast，完全可以使用本文中類似的方法進行封裝。

Tips

關於Flutter日誌列印，評論區說到devtools關於日誌的列印，大家也可以看看這裡的說明devtools/logging。

相關文章