Flutter中怎么自定义Plugin
创始人
2024-12-21 16:02:20
0次

1.在Android Studio 中创建一个Flutter Plugin 项目,如下图

上图中你能看到项目描述中写到,如果需要暴露Andorid或iOS的API给开发者时,选择"Plugin"项目类型。这个项目我们命名为:flutter_native_log_plugin, 当我们完成创建项目后,有两个文件我们需要看一看, 一个是位于android/src下的FlutterNativeLogPlugin.java, 这段代码是用来和本地设备交互,然后将交互结果返回供flutter前端调用, 如下所示:

package com.cube8.flutter_native_log_plugin;import io.flutter.plugin.common.MethodCall;import io.flutter.plugin.common.MethodChannel;import io.flutter.plugin.common.MethodChannel.MethodCallHandler;import io.flutter.plugin.common.MethodChannel.Result;import io.flutter.plugin.common.PluginRegistry.Registrar;/** FlutterNativeLogPlugin */public class FlutterNativeLogPlugin implements MethodCallHandler { /** Plugin registration. */ public static void registerWith(Registrar registrar) {  final MethodChannel channel = new MethodChannel(registrar.messenger(),     "flutter_native_log_plugin");  channel.setMethodCallHandler(new FlutterNativeLogPlugin()); } @Override public void onMethodCall(MethodCall call, Result result) {  if (call.method.equals("getPlatformVersion")) {   result.success("Android " + android.os.Build.VERSION.RELEASE);  } else {   result.notImplemented();  } }}

另一个 /lib/mian.dart文件,这段代码是主要用来和native代码交互, 如下所示:

import 'dart:async';import 'package:flutter/services.dart';class FlutterNativeLogPlugin { static const MethodChannel _channel =   const MethodChannel('flutter_native_log_plugin'); static Future get platformVersion async {  final String version = await _channel.invokeMethod('getPlatformVersion');  return version; }}

2.现在我们开始编写我们的Plugin.

在lib/flutter_native_log_plugin.dart 文件中,我们先创建一个新的方法,代码如下:

import 'dart:async';import 'package:flutter/material.dart';import 'package:flutter/services.dart';enum Log { DEBUG, WARNING, ERROR }class FlutterNativeLogPlugin { static const MethodChannel _channel =   const MethodChannel('flutter_native_log_plugin'); static Future printLog(   {Log logType, @required String tag, @required String msg}) async {  String log = "debug";  if (logType == Log.WARNING) {   log = "warning";  } else if (logType == Log.ERROR) {   log = "error";  } else {   log = "debug";  }  final Map params = {   'tag': tag,   'msg': msg,   'logType': log  };  final String result = await _channel.invokeMethod('printLog', params);  return result; }}

在Android端,我们将android/src下的FlutterNativePlugin.java改写如下:

package com.cube8.flutter_native_log_plugin;import android.util.Log;import io.flutter.plugin.common.MethodCall;import io.flutter.plugin.common.MethodChannel;import io.flutter.plugin.common.MethodChannel.MethodCallHandler;import io.flutter.plugin.common.MethodChannel.Result;import io.flutter.plugin.common.PluginRegistry.Registrar;/** * FlutterNativeLogPlugin */public class FlutterNativeLogPlugin implements MethodCallHandler {  /**   * Plugin registration.   */  public static void registerWith(Registrar registrar) {    final MethodChannel channel = new MethodChannel(registrar.messenger(), "flutter_native_log_plugin");    channel.setMethodCallHandler(new FlutterNativeLogPlugin());  }  @Override  public void onMethodCall(MethodCall call, Result result) {    if (call.method.equals("printLog")) {      String msg = call.argument("msg");      String tag = call.argument("tag");      String logType = call.argument("logType");      if (logType.equals("warning")) {        Log.w(tag, msg);      } else if (logType.equals("error")) {        Log.e(tag, msg);      } else {        Log.d(tag, msg);      }      result.success("Logged Successfully!");    } else {      result.notImplemented();    }  }}

3.测试plugin。当开发完了我们的plugin之后,我们需要测试这个新plugin是否可用,于是对example/lib的main.dart文件作如下修改:

import 'package:flutter/material.dart';import 'package:flutter_native_log_plugin/flutter_native_log_plugin.dart';void main() => runApp(MyApp());class MyApp extends StatefulWidget { @override _MyAppState createState() => _MyAppState();}class _MyAppState extends State { @override void initState() {  super.initState(); } void printLogs() async {  print(await FlutterNativeLogPlugin.printLog(    tag: "Debug", msg: "This is ordinary Log")); // default logType  print(await FlutterNativeLogPlugin.printLog(    tag: "Debug",    msg: "This is warning Log",    logType: Log.WARNING)); // logType = warning  print(await FlutterNativeLogPlugin.printLog(    tag: "Debug",    msg: "This is error Log",    logType: Log.ERROR)); // logType = error  print(await FlutterNativeLogPlugin.printLog(    tag: "Debug",    msg: "This is debug Log",    logType: Log.DEBUG)); // logType = debug } @override Widget build(BuildContext context) {  return MaterialApp(   home: Scaffold(    appBar: AppBar(     title: const Text('Plugin example app'),    ),    body: Center(     child: RaisedButton(      child: Text("PrintLogs"),      onPressed: printLogs,     ),    ),   ),  ); }}

点击app中的按钮,控制台将看到如下输出,说明plugin可以顺利运行了。

4.最后一步就是将我们开发的plugin发布到dart pub供以后直接调用。打开控制台,需要确认定位到plugin项目的根目录,然后输入如下命令:

flutter packages pub publish --dry-run

这段命令会做一个程序相关文件和信息的检查,确保待发布的plugin信息完整,根据控制台的提示完善信息后,与下图相似:

接着输入如下命令,正式将plugin发布到dart pub中:

flutter packages pub publish

相关内容

热门资讯

空调连续工作多久需要停机休息 空调连续工作的时间取决于多个因素,包括空调的型号、功率、使用环境和维护情况等。一般来说,空调可以连续...
空调哪个符号是除湿的 空调除湿功能通常用一个水滴形状的符号表示。不同品牌和型号的空调遥控器可能会有所差异,但一般来说,除湿...
格力空调多长时间加一次氟利昂 1、一般情况下,空调对氟利昂的使用量是非常小的,所以在空调使用了四年左右的时候再考虑加也没问题。2、...
空调用多长时间需要加氟一次 一般情况下是五年。当出现以下这几种情况时,空调才需要加氟。1、空调的室内机和室外机各有两个接口,当接...
格调生活·C标思享荟:卡萨帝在... 9月12日的郑州龙湖金融岛,夜风轻拂,灯光璀璨。“C标时刻共传奇——卡萨帝思享荟暨20周年品牌盛典郑...
品牌价值破千亿、高端份额持续领... 9月12日,“C标时刻共传奇——卡萨帝思享荟暨20周年品牌盛典郑州站”在郑州龙湖金融岛举办。2026...
空调主板坏了修800还是换新的 空调主板坏了是修还是换新,需要考虑多个因素,以下是一些建议:1. 维修成本:如果维修费用较低,比如 ...
空调开多久需要休息多长时间 问题:空调开多久需要休息多长时间回答:1、在使用空调的过程中,一般空调开7~8个小时左右需要休息2~...
中央空调多长时间清洗一次 1、一般空调开机前清洗一次即可,空调开机中间时段再清洗一次,空调关机时清洗一次,这样比较合理。2、空...
中央空调氟利昂多久加一次 看空调制热和制冷程度,很多人的观点认为氟利昂必须一年放一次,其实这个观点是错误的,理解上面有点偏差,...