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：而後咱們在宿主的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不少組建須要原始平臺API支持，咱們徹底能夠利用好MethodChannel進行相關功能開發，例如Flutter中對於toast提示，目前自帶的是SnackBar組件，若是想要使用Android自帶的Toast，徹底可使用本文中相似的方法進行封裝。

Tips

關於Flutter日誌打印，評論區說到devtools關於日誌的打印，你們也能夠看看這裏的說明devtools/logging。