使用Flutter创建插件详解并发布到Pub库

创建Flutter插件可以使得我们在Flutter项目中直接调用原生功能,这大大扩展了我们的应用程序的能力。下面是详细的创建Flutter插件并发布到Pub库的步骤:

1. 创建Flutter插件项目

首先,在任何目录中打开终端并键入以下命令:

flutter create --template=package flutter_plugin

这将创建一个Flutter插件项目模板,命名为“flutter_plugin”。此模板包含插件所需的基本文件结构。

2. 添加插件代码

现在可以向“flutter_plugin”插件项目添加原生代码。我们可以使用Objective-C、Swift、Java或Kotlin将原生代码集成到插件中。

在这里,我们以iOS平台为例,创建Objective-C代码实现。在Flutter插件项目的ios文件夹中创建一个FlutterTestPlugin.hFlutterTestPlugin.m文件。FlutterTestPlugin.h文件用于声明类和方法,而FlutterTestPlugin.m文件实现方法。

// FlutterTestPlugin.h文件

#import <Flutter/Flutter.h>

@interface FlutterTestPlugin : NSObject<FlutterPlugin>

@end
// FlutterTestPlugin.m文件

#import "FlutterTestPlugin.h"

@implementation FlutterTestPlugin

+ (void)registerWithRegistrar:(NSObject<FlutterPluginRegistrar>*)registrar {
    FlutterMethodChannel* channel = [FlutterMethodChannel
                                       methodChannelWithName:@"flutter_test"
                                             binaryMessenger:[registrar messenger]];
    FlutterTestPlugin* instance = [[FlutterTestPlugin alloc] init];
    [registrar addMethodCallDelegate:instance channel:channel];
}

- (void)handleMethodCall:(FlutterMethodCall*)call result:(FlutterResult)result {
    if ([@"getBatteryLevel" isEqualToString:call.method]) {
        int batteryLevel = [self getBatteryLevel];
        if (batteryLevel == -1) {
            result([FlutterError errorWithCode:@"UNAVAILABLE"
                                       message:@"Battery level not available."
                                       details:nil]);
        } else {
            result(@(batteryLevel));
        }
    } else {
        result(FlutterMethodNotImplemented);
    }
}

- (int)getBatteryLevel {
    UIDevice *device = UIDevice.currentDevice;
    device.batteryMonitoringEnabled = YES;
    if (device.batteryState == UIDeviceBatteryStateUnknown) {
        return -1;
    } else {
        return (int)(device.batteryLevel * 100);
    }
}

@end

上述代码负责将原生方法(getBatteryLevel)公开给Flutter。getBatteryLevel方法将获取iOS设备的电池水平并将其以整数形式返回。

3. Dart部分的实现

接下来,我们将使用Dart在Flutter中实现对原生代码的调用。打开flutter_plugin/lib/flutter_plugin.dart文件,声明Flutter插件及其方法。

import 'dart:async';
import 'package:flutter/services.dart';

class FlutterTest {
  static const MethodChannel _channel =
      const MethodChannel('flutter_test');

  static Future<int> getBatteryLevel() async {
    try {
      final int result = await _channel.invokeMethod('getBatteryLevel');
      return result;
    } on PlatformException catch (e) {
      print("Error: '${e.message}'.");
      return -1;
    }
  }
}

我们已经声明了一个静态函数,该函数将通过在指定的Flutter承载平台上呈现实现,从而公开一个异步函数,使您可以获取设备电池电量(如果正在运行)。

接下来,打开Flutter应用程序,并将其添加到flutter_plugin依赖项列表中。在Flutter应用程序主目录下的pubspec.yaml文件中添加以下代码:

dependencies:
  flutter:
    sdk: flutter

  flutter_plugin:
    path: ../flutter_plugin

在完成之后,运行flutter packages get以检索依赖项。

现在就可以在Flutter中使用插件了。例如,在Flutter代码中调用getBatteryLevel方法:

import 'package:flutter/material.dart';
import 'package:flutter_plugin/flutter_plugin.dart';

void main() => runApp(MyApp());

class MyApp extends StatefulWidget {
  @override
  _MyAppState createState() => _MyAppState();
}

class _MyAppState extends State<MyApp> {
  int _batteryLevel;

  @override
  void initState() {
    super.initState();
    getBatteryLevel();
  }

  Future<void> getBatteryLevel() async {
    final int result = await FlutterTest.getBatteryLevel();

    setState(() {
      _batteryLevel = result;
    });
  }

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        body: Center(
          child: Text('Battery level: $_batteryLevel'),
        ),
      ),
    );
  }
}

4. 发布到pub.dev

当您完成了您的Flutter插件之后,您可以发布它到pub.dev以供其他用户使用。发布到Pub.dev需要一些额外的步骤:

4.1 创建Pubspec.yaml文件

在项目的根目录下,创建一个名为pubspec.yaml的文件。该文件描述了整个Flutter插件的元数据。以下是示例:

name: flutter_test
description: A Flutter plugin.
version: 0.0.1
author: Your Name
homepage: https://github.com/your/repository
repository: https://github.com/your/repository
dependencies:
  flutter:
    sdk: flutter

确保将name字段更改为您自己的插件名。

4.2 撰写README.md文件

创建一个名为README.md的文件,描述您的Flutter插件以及如何使用它。这个markdown文件将显示在Pub.dev的插件页面下。

4.3 打标签

确保在发布插件之前打上标签,类似以下命令:

git tag <version>

这将在pub.dev中显示您的发布版本。

4.4 发布

终端中导航到Flutter插件项目根目录,运行以下命令:

flutter packages pub publish

如果您尚未关联您的pub.dev帐户,并且没有收到关于如何完成此操作的提示,终端将向您提供插件包的链接URL。按照步骤完成即可。

总结

本教程详细介绍了如何创建Flutter插件并将其发布到Pub.dev上,有了这个技能,您可以扩展您的应用程序,并充分利用原生功能。不过,发布Flutter插件只是一部分,开发人员需要了解如何使他们的插件使用方便,适用广泛才能获得更多的关注。

©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容