Flutter平台源码生成插件platforms_source_gen的使用

Flutter平台源码生成插件platforms_source_gen的使用

概览

platforms_source_gen 是一个用于自动生成平台源代码的Flutter插件，支持Android、iOS等平台。当你在Android、iOS或其他平台上构建Flutter模块时，你可能需要编写一些相同的函数代码。这个工具可以让你只写Dart代码，并自动为其他平台生成代码。

示例：路由路径

当你从一个Android页面跳转到Flutter页面，再跳转回Android页面时，你可以使用像flutter_boost这样的包来实现跳转：

在Android中

public class Route {
    public static final String android_page1 = "/android/page1";
    public static final String android_page2 = "/android/page2";
    //.......
    public static final String flutter_page1 = "/flutter/page1";
    public static final String flutter_page2 = "/flutter/page2";
    //.......
}

在Flutter中

class Route {
  static const String android_page1 = "/android/page1";
  static const String android_page2 = "/android/page2";
  //.......
  static const String flutter_page1 = "/flutter/page1";
  static const String flutter_page2 = "/flutter/page2";
  //.......
}

在iOS中

@interface MQQFlutterGen_Route : NSObject

@property (nonatomic, strong) NSString *main_page;
@property (nonatomic, strong) NSString *mine_main;
@property (nonatomic, assign) int int_value;

@end

这个工具可以让你只写Dart代码，并自动生成其他平台的代码。

快速开始

第一步

在你的pubspec.yaml文件中添加platforms_source_gen依赖，并使用dart pub get下载该包：

dev_dependencies:
  platforms_source_gen: ^版本号

更多安装信息，可以参考这里。

第二步

在Flutter项目的路径下编写你的Dart类文件并格式化它，例如：./lib/example：

class InnerClass {
  String a;
  int b;
}

class Route {
  static const String main_page = "/main/page"; // 主页
  static const String mine_main = "/mine/main"; // 我的主页
  static const int int_value = 123;
}

更多示例类，可以从GitHub获取。

第三步

在./test/any.dart中编写一个主函数并运行：

import 'package:platforms_source_gen/platforms_source_gen.dart';

void main() async {
  List<GenClassBean> genClassBeans = await platforms_source_gen_init(
    "./lib/example", // 你的Dart文件路径
  );
  
  platforms_source_gent_start(
      "com.siyehua.example", // Java包名
      "./Android_gen", // Android保存路径
      genClassBeans,
      nullSafe: true);
      
  platforms_source_start_gen_objc(
      "MQQFlutterGen_", // iOS前缀
      "./iOS_gen", // iOS保存路径
      genClassBeans,
      nullSafe: true);
}

更多关于Flutter平台源码生成插件platforms_source_gen的使用的实战教程也可以访问 https://www.itying.com/category-92-b0.html

1 回复

更多关于Flutter平台源码生成插件platforms_source_gen的使用的实战系列教程也可以访问 https://www.itying.com/category-92-b0.html


platforms_source_gen 是一个用于 Flutter 的代码生成插件，它可以帮助开发者自动生成与平台相关的代码，特别是在需要与原生平台（如 Android 和 iOS）进行交互时。这个插件可以简化跨平台开发的流程，减少手动编写平台特定代码的工作量。

安装和使用 platforms_source_gen

1. 添加依赖

首先，你需要在 pubspec.yaml 文件中添加 platforms_source_gen 和 build_runner 作为开发依赖。

dev_dependencies:
  platforms_source_gen: ^latest_version
  build_runner: ^latest_version

运行 flutter pub get 来获取依赖。

2. 创建平台接口

接下来，你需要定义一个抽象类来表示你希望在平台之间共享的接口。这个接口将包含你希望在不同平台上实现的方法。

import 'package:platforms_source_gen/platforms_source_gen.dart';

[@PlatformInterface](/user/PlatformInterface)()
abstract class MyPlatformInterface {
  Future<String> getPlatformVersion();
}

3. 生成平台实现代码

使用 build_runner 来生成平台特定的实现代码。在终端中运行以下命令：

flutter pub run build_runner build

这将生成与平台相关的代码，包括 Android 和 iOS 的实现。

4. 使用生成的代码

生成的代码将包含平台特定的实现类。你可以在你的 Flutter 应用中使用这些类来调用平台特定的功能。

import 'package:my_app/my_platform_interface.dart';
import 'package:my_app/my_platform_interface.android.dart';
import 'package:my_app/my_platform_interface.ios.dart';

void main() async {
  MyPlatformInterface platformInterface;

  if (Platform.isAndroid) {
    platformInterface = MyPlatformInterfaceAndroid();
  } else if (Platform.isIOS) {
    platformInterface = MyPlatformInterfaceIOS();
  } else {
    throw UnsupportedError('Platform not supported');
  }

  String platformVersion = await platformInterface.getPlatformVersion();
  print('Platform version: $platformVersion');
}

自定义生成的代码

platforms_source_gen 允许你通过注解来自定义生成的代码。你可以使用 [@PlatformInterface](/user/PlatformInterface) 注解来指定接口的名称、包的名称等信息。

[@PlatformInterface](/user/PlatformInterface)(
  name: 'CustomPlatformInterface',
  package: 'com.example.custom_platform_interface',
)
abstract class MyPlatformInterface {
  Future<String> getPlatformVersion();
}
回到顶部