Flutter项目中Android、iOS与Dart之间的常量共享方案问询

当然有可行方案，完全可以通过单一数据源同步三个平台的常量，避免重复编写。以下是几种实用的实现方式：

1. 官方推荐：使用Pigeon工具 #

Pigeon是Flutter官方提供的Platform Channels代码生成工具，它允许你用Dart定义API接口，自动生成匹配的Kotlin/Swift代码，同时内置了通道名、方法名的常量定义，彻底消除手动同步的麻烦。

举个简单例子：

1. 创建pigeon.dart定义API：

import 'package:pigeon/pigeon.dart';

@ConfigurePigeon(PigeonOptions(
  dartOut: 'lib/channel_api.dart',
  kotlinOut: 'android/app/src/main/kotlin/com/example/ChannelApi.kt',
  kotlinOptions: KotlinOptions(package: 'com.example'),
  swiftOut: 'ios/Runner/ChannelApi.swift',
))
class UserData {
  String? id;
  String? name;
}

@HostApi()
abstract class UserApi {
  UserData fetchUserData(String userId);
}

2. 运行生成命令：

flutter pub run pigeon --input pigeon.dart

生成的代码会自动包含通道名、方法名的常量，三个平台直接使用生成的类即可，不需要手动维护任何常量文件。

2. 配置文件+代码生成脚本 #

用JSON/YAML作为单一常量源，通过脚本生成三个平台的常量文件，适合已有项目的快速改造。

1. 创建channel_constants.yaml统一存放常量：

channels:
  main_channel: "com.example/main_channel"
methods:
  fetch_user: "fetchUser"
params:
  user_id: "userId"

2. 编写Python/Dart脚本读取该文件，生成对应平台的代码：
   • Dart端生成channel_constants.dart：

class ChannelConstants {
  static const mainChannel = "com.example/main_channel";
  static const fetchUser = "fetchUser";
  static const userId = "userId";
}

- Kotlin端生成`ChannelConstants.kt`：

object ChannelConstants {
    const val MAIN_CHANNEL = "com.example/main_channel"
    const val FETCH_USER = "fetchUser"
    const val USER_ID = "userId"
}

- Swift端生成`ChannelConstants.swift`：

struct ChannelConstants {
    static let mainChannel = "com.example/main_channel"
    static let fetchUser = "fetchUser"
    static let userId = "userId"
}

修改常量后只需运行脚本，即可同步所有平台的常量定义。

3. 以Dart常量为源生成原生代码 #

直接在Dart中定义共享常量，通过build_runner插件生成Kotlin/Swift的对应代码，适合习惯以Dart为核心的开发流程。

1. 在Dart中定义常量：

class ChannelConstants {
  static const String mainChannel = "com.example/main_channel";
  static const String fetchUser = "fetchUser";
  static const String userId = "userId";
}

2. 使用自定义build_runner builder解析该Dart文件，自动生成原生平台的常量文件，无需手动编写重复代码。

以上方案都能有效解决多平台常量重复维护的问题，其中Pigeon作为官方工具，不仅能共享常量，还能统一数据模型和方法签名，是最推荐的方案。

内容的提问来源于stack exchange，提问作者Vignesh Hendrix