当前位置: 首页 > 编程笔记 >

用Flutter开发自定义Plugin的方法示例

花健
2023-03-14
本文向大家介绍用Flutter开发自定义Plugin的方法示例,包括了用Flutter开发自定义Plugin的方法示例的使用技巧和注意事项,需要的朋友参考一下

当你在开发flutter应用的时候,有时会需要调用native的api,往往遇到flutter并没有相应的package, 这时候flutter plugin就开始发挥作用了,这篇文章将会讲解开发一个简单flutter plugin的步骤和方法,好了,让我们开始动手吧。

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<String> 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<String> 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<String, dynamic> params = <String, dynamic>{
   '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<MyApp> {

 @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

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持小牛知识库。

 类似资料:
  • Web 第三方应用开发-后端开发 概述 工程框架 阿里云API网关(SDK) 编写服务 部署 Web 第三方应用开发-后端开发 更新时间:2018-07-03 22:06:11 概述 本章讲解:非托管应用如何创建自己的后端服务,以及如何通过 AppKey & AppSecret 调用平台服务与插件,本节以Nodejs Server为实例讲解,主要使用了:工程框架 Egg.js 和 阿里云API网关

  • 本章将会讨论如何在API设计中使用自定义方法。 自定义方法指的是五个标准方法之外的API方法。他们应当仅用于标准方法不易表达的功能。一般而言,API设计者应当尽可能优先考虑使用标准方法,而不是自定义方法。标准方法相对更简单,定义完善的语义,并且开发者也更加熟悉;这使标准方法更易用,并且使用者更难犯错。使用标准方法的另一个优势是API平台会有更好的支持,如计费、错误处理、日志、监控等等。 自定义方法

  • 需求分析 使用自定义组件进行场景搭建首先需要以下几点: 跟客户进行深入的讨论和研究,确定客户的需求。 通过手绘或者电脑绘制出大致的样式,继续跟客户确定是否可行。 通过美术组对之前绘制的图形进行美化、加工和配色。 拿到美术组绘制的图片后,确定下实施的方案。 确定数据格式。 ===> (非常重要,如果数据不对极易出现双方返工的现象) 通过 JavaScript 脚本来实现。 由于已经确定好客户的需求,

  • Web 第三方应用开发-资源发布 资源上线 发布成功 Web 第三方应用开发-资源发布 更新时间:2018-07-03 22:17:05 本章介绍如何把您的应用资源上线。 资源上线 点击“线上发布”按钮: 发布成功

  • 本文向大家介绍Android开发之在xml中设置自定义属性的方法,包括了Android开发之在xml中设置自定义属性的方法的使用技巧和注意事项,需要的朋友参考一下 xml中设置自定义属性 分三步: 1. 在项目中的values文件中创建attrs文件 以上这篇Android开发之在xml中设置自定义属性的方法就是小编分享给大家的全部内容了,希望能给大家一个参考,也希望大家多多支持呐喊教程。

  • 作者:陈希章 发表于 2018年3月12日 前言 我相信很多人都看过《三国演义》,里面有很多引人入胜的故事和栩栩如生的人物,对我而言,曹操手下的一员猛将典韦实在让我印象深刻。例如,书中有一段描写典韦的作战经历: 时西面又急,韦进当之,贼弓弩乱发,矢至如雨,韦不视,谓等人曰:“虏来十步,乃白之。”等人曰:“十步矣。”又曰:“五步乃白。”等人惧,疾言“虏至矣”!韦手持十余戟,大呼起,所抵无不应手倒者。